OnBase 15 - Document Composition MRG

Document Composition
Version 15
C OPYRIGHT
Information in this document is subject to change without notice. The OnBase Information
Management System software (the "Software") described in this document is furnished only under a
separate license agreement and may be used or copied only according to the terms of such
agreement. It is against the law to copy the Software except as specifically allowed in the license
agreement. This document or accompanying materials contains certain information which is
confidential information of Hyland Software, Inc. and which is subject to the confidentiality provisions
agreed to by you.
All data, names, and formats used in this documents examples are fictitious unless noted otherwise.
Complying with all applicable copyright laws is the responsibility of the user. Without limiting the
rights under copyright law, no part of this document may be reproduced, stored in or introduced into
a retrieval system, or transmitted in any form or by any means (electronic, mechanical,
photocopying, recording, or otherwise), or for any purpose, without the express written permission of
Hyland Software, Inc.
2015 Hyland Software, Inc. All rights reserved.

Depending on the modules licensed, the OnBase Information Management System software may
include software developed and copyrighted by third parties, including but not limited to the
following:
A2iA CheckReader by A2iA Corp;
Adobe PDF Library by Adobe Systems Incorporated;
dtSearch Text Retrieval Engine by dtSearch Corp.;
software or other content adapted from Smart Client Composite UI Application Block by Microsoft
Corporation 2005 Microsoft Corporation;
software or other content adapted from Microsoft patterns & practices ObjectBuilder 2006 Microsoft
Corporation;
Nuance OCR 1994-2012 Nuance Communications;
portions of imaging code owned and copyrighted by Pegasus Imaging Corporation, Tampa, FL;
Imaging Technology copyrighted by Snowbound Software Corporation, Snowbound.com;
CD-R technology by Sonic Solutions, Inc.;
full-text indexing technology by Autonomy;
IDSMail 2005 by Intuitive Data Solutions;
jLex Copyright 1996-2003 by Elliot Joel Berk and C. Scott Ananian;
Rumba by NetManage;
AutoVue by Oracle America, Inc.
All rights reserved.
Further information regarding third-party software included in the OnBase Information Management
System software can be found in the About box within the Software.
Hyland Software, OnBase, Application Enabler, and Where Your Information Finds You are
registered or unregistered trademarks of Hyland Software, Inc. A2iA CheckReader is a trademark of
A2iA Corporation. Adobe PDF Library is a trademark of Adobe Systems Incorporated.
All other trademarks, service marks, trade names and products of other companies are the property
of their respective owners.
Document Name .................................................................. Document Composition

Department/Group .......................................................................... Documentation
Revision Number ............................................................................................. 15
2015 Hyland Software, Inc.

ii
2015

iii
2015

iv
USING THIS MODULE REFERENCE GUIDE (PDF)

In the following module reference guide (MRG), we provide a great deal of information. If
you are unfamiliar with our MRGs, take a few moments to review the content below so you
can more quickly and efficiently locate the information you need.
Note: The content in this MRG is considered module-specific. Therefore, you may be
referred to another MRG if a referenced function is not specific to this module.
What is in the MRG?

The MRG is a PDF document containing all available instructions for a module. It includes
the following chapters, which contain task-oriented sections:
Exposure - Provides introductory information and license requirements.
Usage - Provides instructions on user-facing functionality.
Configuration - Provides instructions on administrative tasks and functions.
Installation - Provides instructions on installation procedures and information on
system requirements.
Tip: It is considered a best practice to read through an entire stepped process before
attempting to complete any of its steps. Pay close attention to notes, tips, and cautions,
which can help you better understand the entire process and discover any prerequisites you
may not have completed.
How to Navigate the MRG

When using the MRG, consider the following:
You can jump to any chapter or section contained in the MRG by clicking its entry
in the Table of Contents.
The title bars of dialog boxes and the names of options in the software are
displayed as bold text in the documentation. If you are searching for information
on a named option or dialog box, search for that text in the documentation.
The following search instructions pertain to viewing an MRG in Adobe Reader or Adobe
Acrobat. Some of the information may not apply to other PDF readers.
Basic search: Press Ctrl + F. Enter the word or phrase you are looking for in the search box
and press Enter to locate each instance.
Advanced search: Press Ctrl + Shift + F. From the Search dialog box, enter the word or
phrase you are looking for and select one of the following options:
In the current document - Searches the document you are viewing.

All PDF Documents in - Searches a selected folder or directory. If you are unsure of
which MRG to search, try searching the folder your MRGs are located in to display
all results for the word or phrase.
2015

v
Advanced search results are displayed in a list, along with some context (e.g., page
numbers and some of the text surrounding each instance).
Cross-references: Cross-references are links to related information or additional instructions
you may need to complete a task. Though they appear the same as normal text, they jump
to referenced sections when clicked. A page or step number typically indicates a crossreference.
Example of a cross-reference: What is in the MRG? on page v.

Tip: To return to the page you were viewing before following a cross-reference, press Alt +
Left Arrow until the desired page is displayed.
2015

vi
Table of Contents
USING THIS MODULE REFERENCE GUIDE (PDF)

What is in the MRG?......................................................................................... v
How to Navigate the MRG ................................................................................ v
EXPOSURE
Overview .........................................................................................................1
Applications .....................................................................................................1
Licensing .........................................................................................................1
USAGE - ONBASE CLIENT

Creating a Document .......................................................................................3
USAGE - ONBASE WEB CLIENT

Creating a Document .......................................................................................7
USAGE - ONBASE UNITY CLIENT

Creating a Document .....................................................................................11
CONFIGURATION
Before You Begin ...........................................................................................15
Application Server Overview..................................................................................... 16
Defining the Application Server ........................................................................... 16
User Group Privileges .............................................................................................. 17
Installation ....................................................................................................17
Template Groups and Templates....................................................................18
Creating Template Groups .......................................................................................
Editing Template Groups..........................................................................................
Deleting Template Groups........................................................................................
Creating a Template................................................................................................
Viewing and Editing a Template ................................................................................
Saving a Template Locked by Another User ..........................................................
Copying a Template ................................................................................................
Moving a Template .................................................................................................
Deleting a Template ................................................................................................
Configuring Template Options...................................................................................
General Settings ...............................................................................................
File Format Settings ..........................................................................................
Email Settings ..................................................................................................
Scripting Settings .............................................................................................

vii
19
23
24
25
27
27
28
28
29
30
33
34
36
38
Table of Contents
Security Settings .............................................................................................. 39
Placeholders ..................................................................................................40
Creating Placeholders ..............................................................................................
Configuring Style Correction ...............................................................................
Configuring Mask Formatting .........................................................................
Configuring Case Correction ...............................................................................
Configuring Keyword Mapping ............................................................................
Configuring Keygroup Mapping ...........................................................................
Configuring Conditions ......................................................................................
Creating User Prompts ............................................................................................
Configuring a User Prompt .................................................................................
Configuring an HTML Form Prompt ......................................................................
Creating Document Fragments .................................................................................
Editing Document Fragments ..............................................................................
Deleting Document Fragments ............................................................................
Creating Database Queries.......................................................................................
Parameterized Queries ......................................................................................
Inserting Existing Placeholders .................................................................................
Editing Placeholders ................................................................................................
Deleting Placeholders ..............................................................................................
40
49
53
53
54
56
58
62
63
64
66
67
67
67
70
71
72
74
Testing Templates .........................................................................................75

Enterprise Document Composition Configuration...........................................78
Configuring Templates for Use with Enterprise Document Composition ...........................
Configure the Document Composition Windows Service................................................
Starting the Service ................................................................................................
Making Enterprise Document Composition Requests ....................................................
Maintenance ....................................................................................................
78
79
80
81
81
System Interaction ........................................................................................82

Agenda Management...............................................................................................
Creating an Agenda or Minutes Template .............................................................
Creating an Agenda Item Template .....................................................................
Application Enabler .................................................................................................
Diagnostics Service and Diagnostics Console ..............................................................
Workflow ...............................................................................................................
Compose Document Action .................................................................................
WorkView ..............................................................................................................
82
82
86
88
89
89
89
91
INSTALLATION
Requirements ................................................................................................93
Operating System Requirements .........................................................................
Client Retrieval Workstation Hardware Requirements...................................................
Web Client Supported Operating Systems ..................................................................
Web Client Hardware and Browser Requirements ........................................................
Internet Explorer Browser Support ......................................................................

viii
93
94
94
95
96
Table of Contents
Firefox Browser Support .................................................................................... 96

Safari Browser Support ...................................................................................... 96
Unity Client Supported Operating Systems ................................................................. 96
Unity Client Hardware and Browser Requirements ....................................................... 97
.NET Framework ..................................................................................................... 98
Databases Supported .............................................................................................. 98
Microsoft SQL Server ......................................................................................... 99
Oracle ............................................................................................................. 99
Sybase SQL Anywhere ......................................................................................100
Database Client / Server Version Compatibility ..........................................................100
Database/File Servers ......................................................................................101
Third-Party Software Support ..................................................................................101
About Virtual Environments.....................................................................................101
64-Bit Support Statement .......................................................................................102
Windows User Account Control Statement .................................................................102
Modifying Configuration Files .............................................................................102
Third-Party Software Requirements ..........................................................................103
Microsoft Office 2010 Support Statement ..................................................................103
Microsoft Office 2013 Support Statement ..................................................................104
Licensing ..............................................................................................................104
Load Balancing ......................................................................................................104
Limitations ......................................................................................................105
Pre-Installation ...........................................................................................105
Enterprise Document Composition............................................................................105
Installing Document Composition ................................................................105

Installer Overview..................................................................................................105
Installer Prerequisites.............................................................................................107
Installer User Permissions .......................................................................................107
Installer .NET Framework Requirements ...................................................................108
Running the Document Composition v2.0 Installer .....................................................108
Change, Repair, or Remove an Installation ................................................................109
Running the Installer from the Command Line ...........................................................109
Feature Names ................................................................................................109
Properties .......................................................................................................110
Installing the Template Builder ...................................................................110

Installing Enterprise Document Composition ...............................................110
Command Line Switches and INI Settings ...................................................110
INI File.................................................................................................................110
Previous File Location/File Name ........................................................................110
Location .........................................................................................................111
INI Considerations in a Citrix and Microsoft Windows Remote Desktop Environment ..111
Editing the INI File ...........................................................................................111
Troubleshooting ..........................................................................................112

ix
Table of Contents
CONFIGURING THE DISTRIBUTION SERVICE

Overview .....................................................................................................115
Installation ..................................................................................................115
Installing the Distribution Service Manually ...............................................................116
Uninstalling the Distribution Service .........................................................................118
Running a Command ........................................................................................118
Stopping the Service and Removing Files ............................................................118
Upgrading the Distribution Service ...........................................................................119
Using the Distribution Service with Document Distribution .....................................119
Configuration...............................................................................................119
Configuring a Service Account .................................................................................119
Enabling the Distribution Service .............................................................................122
Users Configuration Requirements ...........................................................................123
Encrypting the Service Account Credentials ...............................................................123
Changing Configuration File Settings ........................................................................125
Adding Support for Multiple Data Sources .................................................................125
Sending Notifications to Global Distribution Lists ........................................................126
Displaying the User Who Triggered the Notification as the Sender ................................126
Supporting Non-ASCII Characters in Attachment File Names .......................................126
Configuring the Distribution Service to Save Notifications as Text Files..........................127
Sending Unity Forms ..............................................................................................127
Configuring a Temporary File Cache .........................................................................127
Associating a Temporary File Cache with the Distribution Service ...........................130
Configuring Retry Settings ......................................................................................130
Troubleshooting ..........................................................................................131
Logging Information to the Diagnostics Console .........................................................131
Access to the path...is denied ..................................................................................132
Error Loading Document: Attachments Are Not Sent...................................................132
Messages Are Not Sent...........................................................................................133
Workstation Registration Not Found ...................................................................133
Cannot Create a Session Pool ............................................................................133
"No Count" Is On .............................................................................................133
Version Mismatch ............................................................................................134
Message Content and Attachments Are Reversed .......................................................134
Unity Forms Limitations ..........................................................................................135
Windows User Account Control Statement .................................................................135
DOCUMENT COMPOSITION BEST PRACTICES

Enterprise Document Composition Configuration.........................................137
Configuring Templates for Use with Enterprise Document Composition ..........................137
Installation ..................................................................................................137
Installing Enterprise Document Composition ..............................................................137

x
Table of Contents
DOCUMENT COMPOSITION TEMPLATE CONVERTER

Before You Begin .........................................................................................139
Known Limitations .................................................................................................139
Installation and Usage.................................................................................140

Post-Conversion ..........................................................................................140

xi
Table of Contents

xii
EXPOSURE
Overview
The Document Composition module allows organizations to generate and manage
complex documents that are customized, error-free, and high-volume, all within
OnBase. Users can automate the dynamic generation of documents based on
configurable templates. These templates are the basis of documents. They can
aggregate information from multiple sources, including user or database input, scripts,
WorkView attributes, E-Form data, images, Keyword Values, or other values stored in
OnBase. Templates are created directly in Microsoft Word.
Once configured, templates can be used to create new documents based on information
already stored in OnBase. Users can preview or edit these documents after creation.
Documents can be stored in OnBase or e-mailed to recipients.
VBScripts or Workflow can be used to automate the document creation process.
Enterprise Document Composition functionality can automatically compose and store
documents in OnBase. A server runs a Document Composition Windows Service that
processes requests and stores the documents.
Applications
Organizations are looking to improve efficiency surrounding documents they regularly
create. They need the ability to standardize the creation and storage of dynamically
generated documents based on OnBase data. Document Composition provides control
over document creation by centralizing document templates in OnBase, dynamically
merging information from disparate data sources, and specifying edit, save, and e-mail
options on final documents.
For example, an insurance company has a department that handles car accident claims
for individual customers. When a claim is made, forms are created, using information
from records that have already been stored in OnBase. Information may include
customer name, Social Security number, make and model of the car, license plate
number, and the site of the accident.
Forms must be generated using this information. The same information is used
repeatedly. These forms include the following: Acknowledgement letter, Rental Rights
letter, Auto Appraiser Assigned letter, Delay letter, Status letter, Approval letter, and
Denial letter.
By creating templates with Document Composition, users working in this department can
automatically generate documents for the specific types of letters based on the
Placeholders that were configured in the template.
Licensing
A Document Composition license is required to manually generate documents. A valid
Client license is also required.

1
OnBase 15
An Enterprise Document Composition license is required for Enterprise Document

Composition. A Document Composition license is included with the Enterprise Document
Composition license.
Exposure
Check your current licensing status by selecting Utils | Product Licenses in the
Configuration module.

2
USAGE - ONBASE CLIENT

Creating a Document
A document is created from a template configured with Placeholders that pull in
necessary information from OnBase.
Documents can be created based on source documents that already exist in OnBase.
When a new document is created based upon a source document, Placeholders that are
configured to pull values from the source will automatically populate the new document.
In some instances, you may want to create a document that is not based on a source
document. Depending on how the template is configured, this may be possible. If the
template is configured to pull information from a source document and you create a
document that is not based on a source document, the values that are dependent on a
source document will be left blank. Before creating a document using this method,
ensure that the template contains all of the necessary information without the use of a
source document.
To create a document:
1. If you are creating a document that is based on a source document, retrieve the
document in OnBase.
If you are creating a document that is not based on a source document, skip to
step 2.
2. Select Document | Document Composition | Compose Document.
3. If prompted, enter your login credentials.
4. The Select Template Options dialog box is displayed:
5. Select a template group from the Template Group drop-down list, or type the
name of a template group. Selecting a template group is helpful when you have
access to many templates.
6. Select a template from the Template drop-down list, or type the name of a
template. If you selected a template group, only the templates that belong to the
selected template group are displayed.

3
OnBase 15
Usage - OnBase Client
7. Depending upon your configuration, you may or may not be able to select from
the following check boxes in the Select Template Options dialog box:
Option
Description
Preview/Edit
Document
Select to view and/or edit the document before importing it into

OnBase.
Email Document
Select to create an email notification after the document has been

created and archived in OnBase.
If the template being used to generate the document is configured
to automatically send an email notification after a document is
generated, you do not need to select this check box. The email
notification will be sent according to the template configuration. If
the template is configured to automatically send an email
notification, selecting this check box allows you to send an
additional email notification.
Note: The Email Document check box is only available to users
that are able to send External Mail in OnBase.
8. Select OK to begin creating the document, or Cancel to exit.

9. You may be required to enter information in a prompt or an E-Form. If so, type in
the provided field and click Accept or Submit .
10. If Preview/Edit Document was not selected, skip to step 13.
If Preview/Edit Document was selected, the document is displayed. Depending on
your configuration, the template may be displayed as read-only.
11. Modify the document if necessary.
Note: If you modify Keyword Values Document Composition scraped from the line-of-
business application that appear in the document, only the original scraped Keyword
Values will be used when uploading the document.
12. Select from the following buttons on the Document Composition tab:
Button
Description
Accept
Saves the document.
Redo
Starts the document creation process over from the beginning.
Cancel
Discards the document.
Print
Prints the document.

4
OnBase 15
13. After clicking Accept, the Upload dialog box is displayed:
The Keyword Values Document Composition scraped from the line-of-business

application are displayed. Specify additional Keyword Values if necessary, and
supply any other necessary values to index the document.
Note: The Upload dialog box may display multiple instances of the same Keyword Value.
However, continuing to upload the document saves only one instance of the value.
14. Click Upload. The document is uploaded to OnBase.

5
OnBase 15
15. If you selected Email Document, the Email dialog box is displayed:
16. Specify the following on the Compose tab:

Field
Description
Sender
Type the email address of the sender.
Recipients
Type the email address of the recipient. Separate multiple recipients with semicolons.
Subject
Type the subject of the email.
Body
Type the body text of the email.
17. Click OK to email the document.

6
USAGE - ONBASE WEB CLIENT

Creating a Document
Note: In the HTML-only Web Client, documents can only be created either Workflow or
scripting and Automated Document Composition.
Documents are created from templates configured with Placeholders to pull in necessary
information from OnBase.
1. Retrieve a source document or WorkView object from which you will create a
document. Documents can be retrieved using Document Retrieval or from the
Folders window.
2. Right-click on the document and select Compose Document, or click the WorkView
objects Compose Document button:
3. If prompted, enter your login credentials.


7
OnBase 15
Usage - OnBase Web Client
Option
Description
Preview/Edit
Document

OnBase.
Email Document


Button
Description
Accept
Saves the document.
Redo
Cancel
Print

8
OnBase 15


9
OnBase 15

Field
Description
Sender
Recipients
Subject
Body

10
USAGE - ONBASE UNITY CLIENT

Creating a Document
Documents are created from templates configured with Placeholders to pull in necessary
information from OnBase.
1. Retrieve a source document, WorkView object, or WorkView filter from which you
will create a document. Documents can be retrieved using Document Retrieval or
from the Folders window.
2. For a document, click Compose Document from the Documents tab. You can also
right-click on the document and select Compose Document.
For an open WorkView object, click Compose from the objects main tab.
For one or more WorkView objects in a filter, select the desired object(s). Click
Compose Document from the Filter tab.
Option
Description
Preview/Edit
Document

OnBase.

11
Usage - OnBase Unity Client
OnBase 15
Option
Description
Email Document


Button
Description
Accept
Saves the document.
Redo
Cancel
Print

12
OnBase 15


13
OnBase 15

Field
Description
Sender
Recipients
Subject
Body

14
CONFIGURATION
Before You Begin
In order to ensure that the templates you create for documents are as thorough as
possible, and contain all necessary information, consider the OnBase elements you may
need to configure before creating templates:
What is the purpose of this template?
Who will be creating a document from it?
Who is best suited to create this template?
For example, should one user create the letter portion of the template, then
allow another user to create and configure Placeholders and Template Options?
What existing information must be pulled in from OnBase?
For example:
Keyword Values
HTML Forms
VBScripts
WorkView Attributes
Does new information have to be created in OnBase before beginning to
configure a template?
How will the layout and design of information look?
Where will the document be saved after it has been completed?
Should the document be saved in one or multiple file formats?
Should VBScripts be used to automate the document creation process?
Answering these questions before beginning template group and template creation
allows for organized ease-of-use when creating, managing, and configuring
Placeholders.
Also:
Ensure that the Application Server Path is configured if you plan on using
Document Composition within the OnBase Client. See Application Server
Overview on page 16 for more information.
Ensure that the proper User Group privileges are configured. See User Group
Privileges on page 17 for more information.

15
OnBase 15
If you want to allow tracking of changes to a template document, you must be

licensed for the EDM Services module. The SYS Document Template Document
Type, where Document Composition templates are stored, must be configured
as revisable. For more information about configuring revisable Document
Types, see the EDM Services documentation.
Configuration
Note: If the SYS Document Template Document Type is not revisable, a new copy of the
template will be saved to the SYS Document Template Document Type each time a
template is saved.
Application Server Overview

The Application Server is required to allow certain modules to communicate with
OnBase. This is required to ensure consistent functionality across all interfaces so that
there is no difference when accessing OnBase using the OnBase Client, Web Client, or
Desktop.
Note: You do not need a separate license in order to use the Application Server.
Defining the Application Server

Certain modules and functionalities found within the OnBase Client and Configuration
module require the use of the Application Server. To use these modules and
functionalities within OnBase Client and Configuration module, you must define the
Application Server.
To configure the Application Server:
1. In the Configuration module, select Utils | Application Server. The Application
Server Configuration dialog box is displayed.
2. Enter the Application Server Path.

For a typical installation, the path will be like the following: http://hostname/
AppServer/Service.asmx. The path can be up to 255 characters.

16
OnBase 15
3. Enter the appropriate Datasource name that the Application Server will use.
4. Click Save.
Caution: When the Application Server is reset, all currently running Clients on a single
workstation that is connected to the Application Server must be reset. If the Clients are not
reset, any further attempted connections made to the Application Server will fail.
In order to configure templates, a user must belong to a User Group that has the
Document Composition Administration privilege.
In order to create documents, a user must belong to a User Group that has the Word
Document Composition privilege.
Both of these privileges are assigned in the Configuration module. Select User | User
Groups / Rights . Choose the appropriate User Group and click Privileges.
Installation
The Template Builder, which is the Document Composition configuration component, is
installed by deploying the installation package to your machine using the URL or UNC
path provided to you.
Note: When the installation package is modified by your system administrator, you are
prompted to install a new version of the Template Builder after opening Microsoft Word.
1. Launch the deployment package by opening the URL or UNC path to the
DocumentCompositionConfiguration<package>.vsto file, where <package> is the
name of your specific deployment package.
2. If the Publisher cannot be verified dialog box is displayed, confirm that the Name is
Hyland.Office[year].DocumentComposition.Config and the From matches the path
and file name you were provided.
3. Click Install.
4. After installation, the The Microsoft Office customization was successfully installed
dialog box is displayed.
5. Click Close.
6. To confirm that the installation was successful, launch Microsoft Word.

17
Configuration
User Group Privileges
OnBase 15
Configuration
7. The Template Builder tab is available if the installation was successful:
Template Groups and Templates

Note: Before creating and configuring template groups and templates, ensure that you
have reviewed the information in Before You Begin on page 15. To use, create, or modify
a template, users must have rights to the template group and the template.
Before you can create documents with the Document Composition module, you must
create and configure template groups and templates.

18
OnBase 15
Template group and template creation and configuration is done in Microsoft Word, on
the Template Builder tab:
Configuration
Creating Template Groups

To create a new template group:
1. Click Control Panel.
2. If prompted, login to OnBase.

19
OnBase 15
Configuration
3. The Control Panel dialog box is displayed:
4. Click New Template Group:

20
OnBase 15
5. The New Template Group Settings dialog box is displayed:
Configuration
6. Type a name in the Template Group Name field.

Note: This name is limited to 100 characters and must be unique.
7. Click Continue.

21
OnBase 15
Configuration
8. The Template Group Security dialog box is displayed:
9. Select User Groups in the Available User Groups list and click Add to add them to
the Selected User Groups list.
Remove User Groups from the Selected User Groups list by clicking Remove to
move them to the Available User Groups list.
Note: By default, the MANAGER User Group can access and has rights to all Template
Groups, regardless of whether it is displayed in the Selected User Groups list.

22
OnBase 15
10. The Template Group Rights options are displayed:
Configuration
11. Select the check box(es) that apply to the rights that should be assigned to the
User Group:
Modify Template Group Settings - Select to allow a User Group to edit template
group configuration.
Add Templates to this Group - Select to allow a User Group to create and copy
templates for the template group.
Note: You must assign at least one User Group Modify rights.
12. Click Finish .
Editing Template Groups

Template groups can be edited by a member of a User Group that has been assigned the
Modify Template Group Settings right in the Template Group Rights dialog box.
To edit a template group:
2. Select a template group from the Templates tab.

23
OnBase 15
3. Click Edit Template Group:
Configuration
4. Follow steps 6 to 12 in Creating Template Groups on page 19 to edit the template

group settings. You can click Finish at any point to save changes to the template
group.
Deleting Template Groups

Template groups can be deleted by a member of a User Group that has been assigned
the Modify Template Group Settings right in the Template group Rights dialog box.
Caution: When you delete a template group, you delete the template group and all
templates contained in the template group.

To delete a template group:

2. Select a template group from the Templates tab.
3. Click Delete :
4. You are prompted to confirm that you want to delete the template group.
5. Click Delete to delete the template group or click Cancel to retain the template
group.
6. If you clicked Delete, you are prompted to confirm that you want to delete the
template group by the Confirm Delete dialog box:
7. Select the Check this box to continue. check box and click Delete to delete the
template group, or click Cancel to retain the template group.

24
OnBase 15
Creating a Template
Once a template group is created, templates can be created and stored within that
template group.
Caution: Using Microsoft Words Compatibility Mode when creating and saving templates will
result in template data being lost. You are working in Microsoft Words Compatibility Mode
when [Compatibility Mode] is displayed next to the file name in Microsoft Words title bar.
1. Open Word.
2. Click the Template Builder tab:
A new Document Composition template is displayed.

25
Configuration
To create a template:
OnBase 15
Configuration
3. Click Save Template.

4. In the Save Template dialog box, select the template group that the template
should reside in:
5. Type a name for the template in the Name field.

Caution: Template names must be unique, even across template groups.
6. Click Save to save the template.

Saved templates are stored in the SYS - Document Template Document Type. The
Keyword Type Description is assigned by default to this Document Type. This
Keyword Type has a maximum value of 50 characters. By default, each template
is given the Description Keyword Value of COMPOSITION TEMPLATE - [TEMPLATE
NAME]. Only the first 27 characters of the name you typed in the Name field are
displayed, due to the 50 character limit.
Caution: Templates that are deleted from the SYS - Document Template Document Type are
still available for selection in the Template Builder. For this reason, templates should be
deleted using the Template Builder. See Deleting a Template on page 29 for more
information.
Your User Group(s) is automatically assigned Compose Documents from this

Template and Modify this Template rights to the template you created.

26
OnBase 15
Viewing and Editing a Template

Depending on your rights, you can view and edit existing templates.
To view and edit a template:
1. Click Open Template.
The Open Template dialog box is displayed.
Configuration
2. Expand the Template Group containing the template you would like to view or
edit.
3. Select the template.
4. Click OK.
The template is opened and displayed.
5. Edit the document as desired.
6. Click Save Template to save your changes.
Saving a Template Locked by Another User

A document lock is placed on a template when a user opens it, so only that user can edit
the template. You cannot save changes to a template locked by another user. When
attempting to save changes to a locked template, you are notified the template is locked
and prompted to create a new a template instead.
To save your changes to the template, either the other user must close the template, or
the document lock must be removed from within OnBase.

27
OnBase 15
Copying a Template
Once a template has been created, the template can be copied. This can save time when
configuring many similar templates.
Configuration
To copy a configured template:

1.
2.
3.
4.
Click Control Panel.

On the Templates tab, expand a template group.
Select a template.
Click Copy Template:
The Copy Template dialog box is displayed.
5. The name of the template you are copying is displayed in the Name field.
6. Edit the Name field to be the new name for the copied template.
7. Click OK.
The duplicate template is created and saved to the same template group.
Moving a Template
Templates can be moved between template groups.
To move a template:
2. On the Templates tab, expand a template group.
3. Select a template.

28
OnBase 15
4. Click Move Template:
The Move Template dialog box is displayed.
Configuration
5. Select the template group that the template should be moved to.
6. Click OK to move the template or click Cancel to keep the template in its original
template group.
Deleting a Template
To delete a template:
2. On the Templates tab, expand a template group.
3. Select a template.

29
OnBase 15
4. Click Delete :
Configuration
You are prompted to confirm whether you want to delete the template.
If the template is being referenced by another template (e.g., in a Document
Fragment placeholder), the affected template names are listed.
5. Click Delete to delete the template or click Cancel to keep the template.
Configuring Template Options

Once a template is created, there are additional options in the Template Options pane to
configure. These settings are enforced when a document is created using the template.

30
OnBase 15
To configure template options:

1. Click Template Options.
2. The Template Options pane is displayed:
Configuration

31
OnBase 15
3. Select the edit hyperlink in one of the following areas of the Template Options
pane:
Area
Description
General
Click to edit general template settings.
Configuration
See General Settings on page 33 for more information.

File Format
Click to edit file format settings.

See File Format Settings on page 34 for more information.
Email
Click to edit e-mail settings.

See Email Settings on page 36 for more information.
Scripting
Click to edit scripting settings.

See Scripting Settings on page 38 for more information.
Security
Click to edit security settings.

See Security Settings on page 39 for more information.
4. After you have finished configuring template options, click Save Template to save
the configured Template Options .

32
OnBase 15
General Settings
Configuration
General Settings
Description
Template Name
Displays the name of the template.

Modify the template name if necessary.
Document Type for

Composed
Documents
Select a Document Type from the drop-down list to enforce a default

Document Type into which the composed document will be imported.
Always Show Preview

before archiving
This option should be selected if the person creating a document

must view the document before storing it into OnBase.
Inherit Keywords
from Source
Document when
possible
Select to inherit Keyword Values from the source document.

33
Configuration
OnBase 15
General Settings
Description
Disable the Import

Dialog
This option is enabled when Inherit Keywords from Source

Document when possible and a Document Type for Composed
Documents are selected. This option disables the Import dialog box
or Upload pane and automatically stores the template into the
Document Type specified in the Document Type for Composed
Documents drop-down list.
Caution: Currency and Specific Currency Keyword Types are not
inherited when the Import dialog box is disabled. This is a known
limitation.
File Format Settings
You can select one or multiple File Format Settings:

Description
Word Document
(*.docx)
Select to save the composed document as a Word document (.docx).
Adobe PDF
Select to save the composed document as an Adobe PDF.

34
OnBase 15
Description
TIFF Image
Select to save the composed document as a TIFF image.

Select one of the following image quality settings from the
corresponding drop-down list:
Black and White, 100 DPI - Select to save the composed
document as a black and white (CCITT4 compression) 100 DPI
TIFF.

TIFF.
Greyscale, 100 DPI - Select to save the composed document as
a greyscale 100 DPI TIFF.
Color, 100 DPI - Select to save the composed document as a
color (LZW compression) 100 DPI TIFF.
When composing a document using a template configured to use multiple file formats:
The document must be stored in a Document Type configured to allow multiple
renditions. For information on configuring renditions, see the System
Administration documentation.
Documents are stored to OnBase in the following order:
.docx
PDF
TIFF
If the user previews and edits the template in Word, any modifications are
included in the PDF or TIFF.

35
Configuration

TIFF.
OnBase 15
Configuration
Email Settings
Email Settings
Description
Automatically Send
all Documents
created from this
Template via Email
Select to send an email notification via the Hyland Distribution

Service when a document is generated with this template. This
notification is sent after the document is archived in OnBase.

36
OnBase 15
Click Email Settings to configure the email message in the Email Options dialog box:
Configuration
Option
Description
Sender
Recipients
Subject
Body

To apply formatting, select the text and click the Bold, Italic, or Underline
buttons. HTML tags signify that formatting has been applied. For example,
<b>Sincerely</b> appears as Sincerely in the email message that will be sent.
To add a hyperlink to the email, click the Insert Hyperlink button. In the Insert
Hyperlink dialog box, type the text that should appear in the email message
body in the Text field. Type the URL of the hyperlink in the URL field. Click OK
to add the hyperlink to the email message.
Select the Preview tab to preview what your email notification will look like.
Click Save to save the email notification.

37
OnBase 15
Configuration
Scripting Settings
Select one of the following:

VB Script
Unity Script
If you clicked the VB Script button, select the desired VB Script from the Select VB Script
to run drop-down list.
Note: For more information creating VB Scripts, see the System Administration module
reference guide or help file.
If you clicked the Unity Script button, select the desired Unity Script from the Select Unity
Script to run drop-down list.
Note: For more information creating Unity Scripts, contact your first line of support.
When <Do not run a Script on this Template> is selected, no scripts will run.

38
OnBase 15
Security Settings
Configuration
Select User Group names in the Available User Groups list and click Add to add them to
the Selected User Groups list on the right.
Remove User Group names from the Selected User Groups list by clicking Remove to move
the user names to the Available User Groups list.
When each Selected User Group is selected, the following Template Rights are available:
Security
Description
Compose Documents from

this Template
Allows the User Group to create a document from a configured

template.
Manually Edit the

Document Preview
Allows the User Group to edit the composed document during

preview prior to importing it into OnBase. If this right is not
given to the User Group, users are not be able to edit the
previewed document prior to import into OnBase.

39
OnBase 15
Security
Description
Modify this Template
Allows the User Group to modify Template Options.
Configuration
Note: There must be at least one User Group configured with

this template right.
Placeholders
Placeholders pull values from OnBase into the document template. Placeholders can be
placed in the body of a Microsoft Word document. Placeholders can also be placed in
other areas, such as headers and footers.
Creating Placeholders
To create Placeholders:
1. Click Create New Placeholder.
2. The New Placeholder pane is displayed:

40
OnBase 15
Select one of the following from the New Placeholder pane:

Placeholder
Source
Placeholder
Type
Agenda
Management
Description
An Agenda Management license is required to use this

Placeholder source. For more information on this
Placeholder source, see Agenda Management on page
82.
Metadata
Select this source if the Placeholder value will be

imported from metadata on a source document or
WorkView object.
Keyword
Inserts a Keyword Value from the source document or

an Application Enabler scrape event.
Select a Document Type from the Filter by Document
Type drop-down list.
Select a Keyword Type from the Keyword Type dropdown list.
Note: Multiple Keyword Values for a Keyword Type are
not supported.
Note: For more information on using Application
Enabler to create documents with Document
Composition, see the Application Enabler
documentation.
E-Form Value
Inserts the specified non-keyword field of an E-Form

stored in OnBase. When the document is created, the
value in the specified E-Form field will be used.
Type the E-Form field name in the Enter the E-Form
field name field.
Note: The Enter the E-Form field name field is limited
to 40 characters and must be formatted like the EForm field name. It is case sensitive.
Because E-Form Value is designed to pull nonkeyword fields from an E-Form, OnBase input types
such as OBKey_101_1 cannot be used. See the EForms documentation for more information on E-Form
field formats.

41
Configuration
Select this source if the Placeholder value represents

the location of an agenda template. This Placeholder
will be replaced with a series of Placeholders to
represent the outline format of the agenda document.
Placeholder
Type
Description
WorkView
Inserts either a value from a WorkView object or data

from a WorkView filter. After you have selected
WorkView, do one of the following:
Note: You must be licensed for WorkView in order to
access attributes and filters. The WorkView database
tables must have also been created. See the
WorkView | Case Manager module reference guide
for more information.
Configuration
Placeholder
Source
OnBase 15
Click the WorkView Attribute button to insert a

value from a WorkView object.
Use the tree to navigate to the appropriate
attribute. Expand an application. Within each
application are classes. Expand a class. The
attributes within the class are available for
selection. Select the desired attribute.
Note: The Document and Formatted Text WorkView
attribute data types are not supported for use with
Document Composition.
Click the WorkView Filter button to insert data
from a WorkView filter into a table.
Use the tree to navigate to the appropriate filter.
Expand an application. Within each application are
classes. Expand a class. The filters within the
class are available for selection. Select the desired
filter.
Select the Use column names as headers option
to use the column names of the filter as the table
headers of the table created with the placeholder.
Select the Constrain to parent option to limit
filter results to return only objects sharing an
attribute, property, or relationship with the source
object. When this option is not selected, all results
from the filter are returned.
Note: See the WorkView | Case Manager module
reference guide or help file for information on
configuring attributes and filters.
Document
Property
Inserts the specified Document Property from the

source document.
Select Document Handle or Document Date from the
Document Properties drop-down list.

42
OnBase 15
Placeholder
Source
Placeholder
Type
User Prompt
Description
Select this source if the Placeholder value will be
provided by the user when the document is
composed.
Prompt
Inserts a prompt for a single value specified in a User

Prompt.
See Creating User Prompts on page 62 for more
information.
HTML Prompt
Inserts a specified value (or multiple values) from an

HTML Form. The user will be required to enter values
on the specified HTML Form. The values will then be
pulled into the document.
See Creating User Prompts on page 62 for more
information.
Date/Time
Inserts the current date/time the document is

composed.
Select the date/time format from the Format dropdown list. For a complete list of available date/time
formats, see Configuring Style Correction on page 49.
Select <Custom> to configure a new date/time
format.

43
Configuration
Note: User Prompt Placeholders are ignored when

configured on templates used for Enterprise
Document Composition. This is because User Prompt
Placeholders require user interaction, which does not
take place in Enterprise Document Composition.
Placeholder
Source
OnBase 15
Placeholder
Type
Document
Fragment
Description
Inserts an existing template or fragment in the
current template.
Select a pre-configured template or fragment from all
available template groups and fragments.
Configuration
Note: Fragments can come from the same template,

or other templates.
Select the Match destination style check box if the
text in the fragment should match the font, size, and
color of the text that is used in the composed
document. When the document is composed, the text
in the fragment will inherit the characteristics of the
character immediately before the Placeholder. If there
is not a character immediately before the Placeholder,
the text in the fragment will inherit the characteristics
of the character immediately following the
Placeholder.
If the Placeholder is inserted in a templates header, it
will inherit the default document style. If the
templates default style is not the style used in the
rest of the template, select the Placeholder and
configure it to match the style used in the rest of the
template.
If the Placeholder is inserted at the beginning of the
document, it will inherit the default document style. If
the templates default style is not the style used in
the rest of the template, select the Placeholder and
the space immediately following it and configure it to
match the style used in the rest of the template.
See Creating Document Fragments on page 66 for
more information.
External Data
Source
Select this source if the Placeholder value will come

from an external data source.

44
OnBase 15
Placeholder
Source
Placeholder
Type
Description
Database
Query
Inserts a single value (or a set of values formatted in

a table) using a SQL query to collect data from a
third-party database.
2. Click Continue.
3. Select one of the following options to determine
how the results of your query should be
displayed:
Insert the first result of a single Column - Select
to insert the first result of a single column on the
document. Type the name of the column in the
Enter Column Name field.
Insert the results as an image - Select to insert
the results of the query as an image. The results
of the query must be a binary large object (BLOB)
column, and must be an image format that can be
inserted into a Word document. Type the name of
the column in the Enter Column Name field.
Insert all values as a Table - Select to insert all
the values retrieved by the SQL query as a table
embedded on the document. Instances of this
Placeholder appear on the document as an empty
table. Any column headers entered in the top row
of this table are preserved when the values are
filled in. Table styles are also preserved.
4. If you selected Insert the first result of a single
Column, proceed to step 10 below. Otherwise,
proceed to step 16 below.

45
Configuration
1. Select a pre-configured database query from the

Choose a Query pane, or click New Query to
create a new database query. Continue to step 4
in Creating Database Queries on page 67 for
further information on creating database queries.
Placeholder
Source
OnBase 15
Placeholder
Type
Description
XML Path
Inserts a text or image value from an XML string. Use

XML to pass in values through the OnBase API.
1. Type the XML Path in the Enter XPath field. For
example, /data/listdata or /data/rowdata.
Configuration
2. Click Continue.
3. Select one of the following options to determine
how the results of your query should be
displayed:
Insert the first value returned by the XPath
query - Select to insert the first value returned by
the XPath query on the document.
Insert the results as an image - Select to insert
the results of the query as an image. The results
of the query must be encoded using Base64
encoding, and must be an image format that can
be inserted into a Word document.
Insert the results as a list - Select to insert the
results of the query as a list. All content from the
top level nodes returned by the XPath query is
inserted as a list embedded on the document. This
Placeholder appears on the document like other
Placeholders. Any list formatting that is applied to
the Placeholder is used after the document is
created and the values are inserted in the list. If
the XPath query result includes a delimiter, type
this delimiter in the Delimiter (Optional) field.
For example, if the delimiter is a comma, the XML
should be structured as follows:
<data><listdata>rowdata1,rowdata2,rowdat
a3</listdata></data>
If the XPath query result does not include a
delimiter, row data must be supplied as individual
elements. For example:
<data><listdata>rowdata1</
listdata><listdata>rowdata2</
listdata><listdata>rowdata3</listdata></
data>
Note: Outline formatting is not supported.

46
OnBase 15
Placeholder
Source
Placeholder
Type
Description
<data><rowdata><column1>data1</
column1><column2>data2</
column2><column3>data3</column3></
rowdata></data>
When inserting values as a table, elements that
are not included in the columns specified in the
Column Names field are ignored. If a column is
not found in a particular row, an empty cell is
inserted. If necessary, columns can also be
reordered.
4. If you selected Insert the first value returned
by the XPath query, proceed to step 10 below.
If you selected Insert the results as a table,
proceed to step Configuring Keygroup Mapping
on page 56.
Otherwise, proceed to step 16 below.
None
Unconfigured
Inserts an Unconfigured Placeholder. Unconfigured

Placeholders are default values that will be placed on
every document that uses the specified template.
Type the default value in the Default Text field.
Unconfigured Placeholders can also be added to a
template by clicking Insert Blank Placeholder.
Unconfigured Placeholders with a Default Text value
should only be used for testing.

47
Configuration
Insert the results as a table - Select to insert all

the values retrieved by the XPath query as a table
embedded on the document. Instances of this
Placeholder appear on the document as an empty
table. Any column headers entered in the top row
of this table are preserved when the values are
filled in. Table styles are also preserved. In the
Column Names field, specify column names as a
comma delimited list. These columns should be
child elements to row elements. For example,
column1,column2,column3. In this example, the
XML would be structured as follows:
OnBase 15
Configuration
5. The Placeholder Settings pane is displayed:
6. Click Setup or the Setup Wizard hyperlink.

7. If prompted, login to OnBase.
8. Type a name for the Placeholder in the Placeholder Name dialog box:
Note: You cannot create two Placeholders with the same name within the same template.
Note: The following characters should not be used in a Placeholder name if you plan on
using the Placeholder in a SQL query: & (ampersand), " " (quotation marks), (single
quotes), < > (carats). When a Placeholder name contains any of these characters and is
used in a SQL query, no data is returned for that query.

48
OnBase 15
Configuring Style Correction

Placeholder values can be customized to display a certain way. For example, a Date
Keyword Type may be formatted to display as Day/Month/Year. When configuring a
Keyword Placeholder, you can configure the Keyword Types formatting to display as
Month, Day, Year. In this example, the date is input as Day/Month/Year and output as
Month, Day, Year. The ability to configure the output format allows for greater
consistency in generated documents.

49
Configuration
9. Select a Placeholder Type.

10. Click Continue.
11. Configure any Style Correction settings. See Configuring Style Correction on page
49.
12. Click Continue.
13. Configure any Case Correction settings. See Configuring Case Correction on page
53.
14. Click Continue.
15. Configure the Keyword Mapping settings. See Configuring Keyword Mapping on
page 54.
16. Click Finish .
17. The Placeholder is configured and can now be inserted into the template. For
information on inserting existing Placeholders, see Inserting Existing Placeholders
on page 71.
18. If necessary, configure Conditions. See Configuring Conditions on page 58.
OnBase 15
Configuration
The following options are available from the Style Correction dialog box:
Option
None
Forma
t
Description
Select if you do not wish to apply any formatting to the Placeholder.

50
OnBase 15
Option
Forma
t
Date
Description
Select to apply a date/time format to the Placeholder.
The following date/time formats are available:
Short Date - The date in MM/DD/YYYY format. For example, 11/
20/2009.
Time - The time in HH:MM AM/PM format. For example, 10:15 AM.
General Date/Time - The date and time in MM/DD/YYYY HH:MM
AM/PM format. For example, 11/20/2009 10:15 AM.
Full Date/Time - The date and time in Day, Month DD, YYYY
HH:MM AM/PM format. For example, Friday, November 20, 2009
10:15 AM.
Month and Day - The date in Month DD format. For example,
November 20.
Month and Year - The date in Month, YYYY format. For example,
November, 2009.
Format
Click Please Select a Date Format to select the date/time format that
should appear in the generated template from the Format drop-down
list.
Select <Custom> to specify a new date/time format by selecting any of
the following options:
Note: Two characters must be entered for any <Custom> format.

Custom date formats use standard date and time strings. For more
information, see http://msdn.microsoft.com/en-us/library/
az4se3k1.aspx.
Click OK to save and use the <Custom> configuration.
You can delete a custom date format by selecting the corresponding
Remove button:

51
Configuration
Long Date - The date in Day, Month DD, YYYY format. For example,
Friday, November 20, 2009.
Option
OnBase 15
Forma
t
Description
Input
Click the Set Input Format hyperlink to select the date/time format that
will be entered in the generated template from the Input drop-down list.
Select <None> if users will enter varied date/time formats. OnBase will
interpret the format.
Configuration
Tip: Unless a specific date/time format is going to be input each time,

selecting <None> is recommended. The formatting will fail if the date/
time is not entered in the specified format.
Select <Custom> to specify a new date/time format by selecting any of
the following options:
Note: Two characters must be entered for any <Custom> format.

Click OK to save and use the <Custom> configuration.
You can delete a custom date format by selecting the corresponding
Remove button:
Note: If the date/time format is coming from a Keyword Value, select

the date/time format of the Keyword Value.
Currency
Select to apply a Currency format to the Placeholder.

Format
Click Please Select a Currency Format to select the currency format

that should appear in the generated template from the Output dropdown list.
Note: For more information on creating and configuring currency
formats, see the System Administration help file or module reference
guide.

52
OnBase 15
Option
Custom
Mask
Forma
t
Description
Select to apply a Custom Mask format to the Placeholder.
Format
Click Please Select a Mask Format to select the mask format that
should appear in the generated template from the Output drop-down
list.
You can delete a custom mask format by selecting the corresponding

Remove button:
Configuring Mask Formatting

To create or edit a custom mask:
1. Select Custom Mask from the Style Correction dialog box.
2. Click the Please Select a Mask Format drop-down list.
3. Do one of the following:
To create a new mask format, select <Create New Mask> .
To edit an existing mask, select the appropriate mask and click Edit Mask:
4. Type a name in the Name field, or edit the existing name.

5. Type a mask in the Mask field, or edit the existing mask.
To add an alphanumeric character to the mask, press the space bar.
Alphanumeric characters are represented as a lower case gray X.
To add a static character to the mask, type the actual character. For example, a
hyphen.
6. Click OK to save changes, or click Cancel to cancel changes.
7. If you created a new mask, the mask is now available from the Please Select a
Mask Format drop-down list.
Configuring Case Correction

Templates pull data from many different data sources, which may not store data
consistently with regard to text case. To ensure consistency and readability, text case
formatting options are available.

53
Configuration
Select <Create New Mask> to create a new mask format or edit an

existing mask format. See Configuring Mask Formatting on page 53 for
more information.
OnBase 15
Configuration
The following options are available from the Case Correction dialog box:
Select one of the following options:

Option
Description
(no correction)
No case correction will be applied.
Proper Noun
Proper nouns will be capitalized.
lowercase
All text will be in all lower case letters.
UPPERCASE
All text will be in all upper case letters.
Configuring Keyword Mapping

The Placeholder value can be used as a Keyword Value on documents composed from
this template by using Keyword Mapping.

54
OnBase 15
You can map Keyword Types from the Keyword Mapping dialog box:
Configuration
Select one of the following options:

Option
Description
Enable
Click to assign the Placeholder value as a Keyword Value on the composed

document.
Select a Document Type from the Filter by Document Type drop-down list.
Select a Keyword Type from the Keyword Type drop-down list.
Disable
Click if you do not want to assign the Placeholder value as a Keyword Value on the
composed document.

55
OnBase 15
Configuration
Caution: It is strongly recommended you do not map a value to a Keyword Type that is part
of a Multi-Instance Keyword Type Group, especially when the import dialog is disabled for
the template you are configuring. When mapping a value to a Keyword Type that is part of
a Multi-Instance Keyword Type Group, and that Multi-Instance Keyword Type Group is
contained in the Document Type used to archive composed documents, a separate instance
of the Multi-Instance Keyword Type Group is created to contain the value when a document
is composed (i.e., the value is not included as part of the initial Multi-Instance Keyword
Type Group on the document).
Note: Multiple instances of a single Keyword Type will be displayed in the Import dialog
box or Upload pane. If these are duplicate instances, then only a single instance will be
saved on the composed document. If the instances differ, both instances will be saved. If
a template is configured to Inherit Keywords from Source Document when possible , and
another Keyword Value is mapped to the same Keyword Type, both Keyword Values will
be displayed in the Import dialog box or Upload pane.
Configuring Keygroup Mapping

Values from XML Path Placeholders configured to Insert the results as a table can be
mapped to keywords in a Keyword Type Group or Multi-Instance Keyword Type Group.

56
OnBase 15
You can map column names to keywords in a Keyword Type Group or Multi-Instance
Keyword Type Group using the Keygroup Mapping dialog box:
Configuration
1. From the Select a keygroup drop-down list, select a Keyword Type Group or MultiInstance Keyword Type Group.
2. The Keyword Types in the Keyword Type Group or Multi-Instance Keyword Type
Group are displayed in the Keyword Type column:

57
OnBase 15
Configuration
3. For each Keyword Type, select the column that will provide this value from the
corresponding drop-down list.
4. Click Finish .
Configuring Conditions
You can set up a condition to determine the Placeholder that will be inserted on the
document.
For example, a Loans Department handles documents that contain a Status Keyword
Type. The two available Keyword Values are Denied or Accepted. When this Keyword
Value is indexed, a Keyword Placeholder can be configured to pull the Keyword Values
from the source document. You can configure conditions for the Keyword Placeholder
based on the Keyword Values. This allows for a value to be inserted into the document,
depending on which Keyword Value is found. Templates can also be inserted into the
document. You could configure the condition so that when a document contains the
Accepted Keyword Value, a congratulatory template would be inserted upon document
creation.

58
OnBase 15
To configure a condition in the Placeholder Settings pane:

1. Click Conditions.
2. The Conditions dialog box is displayed:
Configuration
3. Click New Condition.

59
OnBase 15
Configuration
4. The Condition dialog box is displayed:
5. Select one of the following options:

Option
Description
Equal to
Select if the Placeholder value will be equal to a value.

Click the Value hyperlink to specify a value in the Equal to screen.
Note: If you are configuring a date condition, the date format of the
Equal to value must match the date format of the Placeholder.
Blank
Select if the Placeholder value will be blank.
Not equal to any

other condition
Select if the Placeholder value will not be equal to any other

condition.
6. Click Continue.

60
OnBase 15
7. The Action dialog box is displayed:
Configuration
8. Select one of the following options:

Option
Description
Insert a Fragment
Select to insert a fragment.

Click the Fragment hyperlink to select a fragment.
Insert another
Placeholders Value
Select to insert another Placeholders value.
Insert Text
Select to insert text.
Click the Placeholder hyperlink to select a Placeholder.
Click the Text hyperlink to specify the text to insert.

Do not insert anything
Select to insert nothing.
9. If you selected the Insert another Placeholders Value or Insert Text options, the
Assign this Value to a Keyword check box is available. Select this check box to
assign the inserted Placeholder or text to a keyword. Click the Keyword hyperlink
to select a Keyword Type using the Filter by Document Type and/or Keyword Type
drop-down lists.
10. Click Finish .

61
OnBase 15
11. The condition is added to the Conditions dialog box.

12. Repeat steps 3 through 11 to create additional conditions for the Placeholder.
To edit a condition, select the condition and click Edit Condition.
To delete a condition, select the condition and click Delete Condition.
Configuration
Creating User Prompts

Users can be prompted to submit information when they choose to create a document.
Two types of user prompts are available:
User Prompt . A User Prompt alerts the user to enter required information that
will fill in the User Prompt Placeholder on the template when creating a
document. For more information on configuring a user prompt, see Configuring
a User Prompt on page 63.
HTML Prompt . HTML Forms allow end-users to enter information into an HTML
Form that will then be transferred into a document, and fill in the HTML Prompt
Placeholder on the template. For more information on configuring an HTML
Form prompt, see Configuring an HTML Form Prompt on page 64.

62
OnBase 15
Configuring a User Prompt

To configure a User Prompt:
1. From the Placeholder Input dialog box, select Prompt .
Configuration
2. Type the prompt text in the field provided.

Note: This prompt is limited to 255 characters.
3. Click Continue.
49.
5. Click Continue.
53.
7. Click Continue.
page 54.
9. Click Finish .

63
OnBase 15
10. Configure Conditions if necessary. See Configuring Conditions on page 58 for more
information.
Configuring an HTML Form Prompt

Before configuring an HTML form prompt, ensure:
Configuration
The HTML form template that the HTML form prompt is to reference has been
created.
Each field on the HTML form template specifies a name attribute in its tag.
When assigning field name attributes, it is considered a best practice to use an
intuitive naming convention. This makes it is easier to select the correct field
name when configuring the HTML form prompt. For example, you might assign
a field name attribute called TimeOff_StartDate , where TimeOff references the
HTML form template, and StartDate references the display name of the field.
Caution: Document Composition HTML form prompts do not support OnBase E-Form
constructs, such as the use of AutoFill Keyword Set buttons (i.e., OBBtn_KS### or
OBBtn_ExpandKS### ).
The HTML form template was imported into OnBase using the SYS HTML Forms
Document Type.

64
OnBase 15
To configure an HTML form prompt:

1. From the Placeholder Input dialog box, select HTML Prompt :
Configuration
2. From the Choose an E-Form drop-down list, select a pre-configured HTML form.
Note: If there are multiple HTML forms with the same name, the Document Handle will
display next to the HTML form name in parenthesis.
3. From the Enter the Field name drop-down list, select the HTML form field name
from the pre-configured HTML form that will be used for this Placeholder. You can
also type the HTML form field name in this field.
4. Click Continue .
Note: HTML forms should not be configured to use embedded scripting that utilizes XML
template groups. Instead, gather the needed data from the HTML form, then use a script
Placeholder within Document Composition to submit the request.
49.
6. Click Continue.

65
OnBase 15
Configuration
53.
8. Click Continue.
page 54.
10. Click Finish .
11. Configure Conditions if necessary. See Configuring Conditions on page 58 for more
information.
Creating Document Fragments

Fragments can be created and inserted into document templates. Fragments can be
composed of existing text and/or Microsoft Word objects, such as tables, images,
bulleted lists, or numbered lists. Empty fragments can also be created. After fragments
are saved to OnBase, they can be inserted into other templates by creating new
Document Fragment Placeholders.
To create a new fragment, select existing text and/or a Microsoft Word object if
necessary:
1. Click Create Fragment.
2. The New Fragment dialog box is displayed:
3. Type a name for the fragment and click OK.

Note: Fragment names must be unique, and are limited to 64 characters.
4. The fragment is displayed on the Word document:
5. If you chose to create an empty fragment, type inside the space to create the
fragment. If you created a fragment out of existing text or a Microsoft Word
object, this text or object is displayed inside the fragment.
6. Edit the fragment if necessary, ensuring that the fragment is defined on a
separate line.

66
OnBase 15
Editing Document Fragments

Fragments that have been created and saved can be edited.
To edit a fragment:
1. Open the template containing the fragment that you want to edit.
2. Click the fragment.
3. The Fragment Settings pane is displayed:
Configuration
4. Click Change to modify the fragments name in the Fragment Name dialog box.
5. Select the fragment and modify the content of the fragment.
Deleting Document Fragments

Fragments that have been created and saved can be deleted.
To delete a fragment:
1. Open the template containing the fragment that you want to delete.
2. Select the fragment on the template.
3. Click the fragments tab:
4. Press the Delete key.

5. The fragment is deleted from the template and from OnBase.
Creating Database Queries

You can place results from a specified database query into a template, so that an enduser can include this information into a document. You can create a database query
while you are creating a database query Placeholder, or before you create a database
query Placeholder. For instructions on creating a database query while you are
configuring Placeholders, see Creating Placeholders on page 40.

67
OnBase 15
To create a database query before you configure a database query Placeholder:
Configuration

2. Select the Queries tab:
3. Click New Query :

68
OnBase 15
4. The New Database Query dialog box is displayed.
Configuration
5. Enter the appropriate information in the fields provided. The fields are detailed in
the following table.
Option
Description
Name
Assign a name for the query.

Note: This field is limited to 40 characters.
Text Box
Type the SQL Query that will pull information from the database you
are connecting to.
DataSource
Type the datasource name.
Username
Type the user name that will be used to access the datasource.
Note: This field is limited to 74 characters when using a database
that supports ANSI characters. When using a database that supports
Unicode characters, this field is limited to 37 characters.
Password
Type the password, if applicable, that corresponds to the user name

you specified.
Note: This field is limited to 143 characters when using a database
that supports ANSI characters. When using a database that supports
Unicode characters, this field is limited to 71 characters.

69
OnBase 15
Configuration
6. Click Done .
7. The query you created is displayed:
To edit a query, select the query and click Edit Query :
To delete a query, select the query and click Delete Query :
To show configured queries as a list, right-click and select Show as List. To show
configured queries as a tree view, right-click and select Show as Tree.
Parameterized Queries
Parameterized Queries allow data gathered from an ODBC connection to be more
dynamic. Within a SQL query, you can use the values of other Placeholders in the
template as part of your query.

70
OnBase 15
For example:
SELECT column1 FROM table WHERE column2 = &PlaceholderName
In this example, &PlaceholderName will be replaced by the value of the field named
'PlaceholderName' before the query is executed.
Note: Ensure the syntax used for the SQL query is valid. The 'PlaceholderName' that is
contained in the SQL query cannot contain any spaces.
Existing Placeholders can be inserted into a template.

To insert an existing Placeholder into a template:
1. Place the cursor where the Placeholder should be inserted.
2. Click Insert Existing Placeholder.
3. The Insert Placeholder dialog box is displayed:
4. Click a Placeholder.
5. The Placeholder is added to the template as:
{Placeholder}
Placeholder is the name you gave the Placeholder in the New Placeholder dialog
box.

71
Configuration
Inserting Existing Placeholders
OnBase 15
Configuration
6. Apply a font or style to the Placeholder, if necessary, using the Microsoft Word
toolbar. Any fonts or styles used for the Placeholder will be used for the value that
is inserted in the composed document. If no fonts or styles are applied to the
Placeholder, the font and style will be inherited from the character prior to the
Placeholder. If there are no characters prior to the Placeholder, the font and style
will be inherited from the character following the Placeholder.
Editing Placeholders
Placeholders that have been created and configured can be edited.
To edit a Placeholder:
1. If the Placeholder has already been added to the template, click the Placeholder.
Skip to step 7.
2. If the Placeholder has not yet been added to the template, click Edit Placeholders .
3. The Edit Placeholders pane is displayed:
This pane displays all configured Placeholders for the selected template.
4. Click the name of the Placeholder that you want to edit.

72
OnBase 15
5. The Placeholder Settings pane is displayed:
Configuration
6. To change the name of the Placeholder, click Change and type a new name in the
Placeholder Name dialog box.
7. Click the appropriate hyperlink in the Settings portion of the Placeholder Settings
pane to edit that following settings:

73
OnBase 15
Hyperlink
Description
Type
Click to edit the Placeholders type.

See Creating Placeholders on page 40 for more information on Placeholder
types.
Configuration
Value
Click to edit the Placeholders value.

See Creating Placeholders on page 40 for more information on Placeholder
values.
Formatting
Click to edit the Placeholders formatting.

See Configuring Style Correction on page 49 for more information on
Placeholder formatting.
Case
Click to edit the Placeholders case.

See Configuring Case Correction on page 53 for more information on
Placeholder case.
Output
Click to edit the Placeholders output.

See Configuring Keyword Mapping on page 54 for more information on
Placeholder output.
Query
Click to edit the Placeholders database query.

See Creating Placeholders on page 40 for more information on Database Query
Placeholders. See also Creating Database Queries on page 67.
Style
Click to edit the way the Placeholders database query results will be displayed.
See Creating Placeholders on page 40 for more information on how Database
Query Placeholders results will be displayed.
Note: The available hyperlinks depend on the type of Placeholder being edited.
8. Click Conditions to edit any configured conditions, or create a new condition. See
Configuring Conditions on page 58 for more information on configuring
conditions.
Deleting Placeholders
Placeholder that have been created and configured can be deleted.

74
OnBase 15
To delete a Placeholder:
1. Click Edit Placeholders.
2. The Edit Placeholders pane is displayed:
Note: Deleting a Placeholder removes all instances of this Placeholder from the template,
whether or not this Placeholder has been added to the template.

Testing Templates
Once a template has been created, configured, and saved, you can test it to verify that
document creation functions correctly. When you test a template, all configuration
settings, including User Prompts, are tested.
To test a template:
1. Open the template.
2. Click Composition Preview.

75
Configuration
This pane displays all configured Placeholders for the selected template.
3. Click the X next to the Placeholder that you want to delete.
4. Click Delete to confirm that you want to delete this Placeholder. Click Cancel to
retain the Placeholder.
OnBase 15
Configuration
3. The Test this Template dialog box is displayed:
This dialog box allows you to select the source document that should be used to
compose the template you created.
4. If you want to select a new source document, or have not previously tested this
template, click the Use a Source Document hyperlink.
If you have previously tested this template, the Test this Template dialog box
contains the Auto-Name String of the source document that you used to
previously test the template. If you want to use this same source document to
test the template, skip to step 9. Click Change to change the source document
that you will use to test the template.

76
OnBase 15
5. The Select Source Document dialog box is displayed:
Configuration
6. Retrieve a document to use to test document creation.

7. Double-click the document.

77
OnBase 15
Configuration
8. The documents Auto-Name String is displayed in the Test this Template dialog
box:
9. Click the Change hyperlink to select a different document, or the Remove

hyperlink to remove the selected document. Click Cancel to cancel the testing
process.
10. Click Compose.
11. The composed document is displayed.
Enterprise Document Composition Configuration

Enterprise Document Composition automatically composes and stores documents in
OnBase. A server runs a Document Composition Windows Service that processes
requests and stores the documents. Document Composition uses VBScripts or Workflow
to automate the document creation process.
Configuring Templates for Use with Enterprise Document

Composition
When configuring a template for use with Enterprise Document Composition:
Avoid gathering critical data through anything that requires user interaction,
such as a User Prompt Placeholder. If the template has User Prompt Placeholders
on it, they will be removed from the document and ignored during Enterprise

78
OnBase 15
Use Keyword Mapping, either by applying the Inherit Keywords from Source
Document when possible template option or by configuring Keyword Mapping on
individual Placeholders.
For Enterprise Document Composition to successfully process and store documents, the
template must be configured with the Document Type for Composed Documents setting
enabled. If the template is configured without this setting enabled, the Document Type
must be supplied by the calling script or Workflow action.
Note: Before you configure the Document Composition Windows Service, ensure you
have a Service Account configured to run the Windows Service. For more information
about configuring a Service Account, please see the System Administration Module
Reference Guide or Help files.
To configure the Document Composition Windows Service, complete the following steps:
1. Navigate to the directory where the Document Composition Windows Service was
installed. If it was installed in the default directory, it will be in the following
location: C:\Program Files\Hyland\Services\Document Composition (32-bit
operating systems) or C:\Program Files(x86)\Hyland\Services\Document
Composition (64-bit operating systems).
2. Open the Hyland.Office.DocumentComposition.NTService.exe.config file.
3. Type the user account that is configured as a Service Account that will be used to
process Document Composition requests in the following elements value:
<add key="ServiceAccount" value="[Name of Service Account]" />
4. Type the corresponding password in the following elements value:
<add key="ServicePasswd" value="[Password]" />
5. Type the datasource that will be used to store documents in the following
elements value:
<add key="DataSource" value="[ODBC Source]" />
6. Specify any of the following options:
Option
Description
WorkerSleepTime
Each thread will sleep for a certain number of seconds after it runs
out of work. The default is 15 seconds. This setting must be between
0 and 600. If an invalid entry is found, 15 will be used.
WorkBatchSize
When the Service completes its work, it requests a new group of

documents to create. Reducing the size of the group will make it less
likely that one server will not get any work, but slightly increase the
load on the database. This setting should not be changed unless
multiple instances of the Document Composition Service are being
run.
CompositionPoolSize
The Service is multithreaded. This setting dictates how many threads

should be used to create documents. The optimal number will depend
on the specific hardware being used.

79
Configuration
Configure the Document Composition Windows Service
Configuration
OnBase 15
Option
Description
ArchivalPoolSize
The Service is multithreaded. This setting dictates how many threads

should be used to archive documents. The optimal number will
depend on the specific hardware being used.
SessionPoolSize
Each composition thread and each archival thread need to use a

session part of the time. A session pool is available to more efficiently
use the sessions that are created. It should range from
ArchivalPoolSize + 1 to ArchivalPoolSize + CompositionPoolSize.
Starting the Service

To start the Document Composition Windows Service:
1. Select Run from the Windows Start menu.
2. Type services.msc in the Run dialog box and click OK .
3. The Services dialog box is displayed:
4. Right-click the Hyland Document Composition Service icon and select Start.

80
OnBase 15
Making Enterprise Document Composition Requests

Enterprise Document Composition requests are made through Workflows Compose
Document action, scripting, or the Unity API. Requests can be synchronous or
asynchronous. Asynchronous requests are queued in the database, which is polled by
the Document Composition Service. Synchronous requests are processed immediately. It
then sends the composed document back to the Application Server, which archives the
document into OnBase.
through the Unity API or scripting, contact your first line of support.
Although synchronous and asynchronous requests are processed in the same manner,
there are distinct differences between the two:
Synchronous requests are processed immediately after they are received.
Requests are not returned until the document has been created and archived.
Synchronous requests are intended for processes in which the user is required
to view or modify the document or metadata before continuing. Synchronous
requests are queued in the order they are received. If too many synchronous
requests exist in the queue, the service call may time out and the Client may
not receive the response.
The Document Composition Windows Service records the request and returns it
immediately. The response only indicates whether or not the request was
successfully recorded. Any errors in the actual processing are recorded in the
Enterprise Document Composition error log. Asynchronous requests are
intended for less interactive processes, such as a nightly batch process. There
is no limit to the number of asynchronous requests that can be queued for
processing.
Maintenance
Performance counters for Document Composition are available in Windows Performance
Monitor on the workstation that is running the Document Composition Windows Service.
Note: At least one document must be processed for performance counters to be added to
the Windows Performance Monitor. These counters are listed under Document
Composition .
The following counters are available:

Counter
Description
DocumentsPerSecond
The current throughput of the Document Composition Windows

Service.
TotalDocumentsProcessed
The count of documents successfully processed since the

Document Composition Windows Service started.
TotalDocumentsCreated
The count of documents successfully created by the Document

Composition Windows Service.

81
Configuration
Note: For more information on making Enterprise Document Composition requests
Configuration
OnBase 15
Counter
Description
TotalDocumentsArchived
The count of documents successfully archived by the Document

Composition Windows Service.
TotalRequestsFailed
The count of document requests that were not successfully

processed by the Document Composition Windows Service.
System Interaction
Agenda Management
To create an agenda management Placeholder:
Creating an Agenda or Minutes Template

1. Select the Agenda Management Placeholder source.
2. Specify a name for the placeholder.
3. Click Setup. The Agenda Management Template Type page is displayed:
4. Select Agenda/Minutes.

82
OnBase 15
5. Click Continue. The Agenda Management Meeting Type page is displayed:
Configuration
6. From the drop-down list, select a meeting type.

7. Click Continue. The following page is displayed:

83
OnBase 15
8. Select one of the following:

Meeting Object
Description
Meeting Property
Select to insert one of the following meeting properties from the

Meeting Property drop-down list:
Meeting Name
Configuration
Meeting Date
Meeting Time
Meeting Date and Time
Meeting Location
Meeting Type
Meeting Organizer
Meeting Attendance
After selecting a meeting property, you can optionally configure
additional settings. To do so:
1. Click Continue.
2. Select the desired Style Correction option.
3. Click Continue.
4. Select the desired Case Correction option.
5. Click Continue.
6. Enable or disable the Keyword Mapping option.
Meeting Tree
Select to insert a meeting tree or subtree. Select an agenda section

from the corresponding list or <All> to insert the entire meeting tree.
You can configure the style and formatting of each individual Agenda
Item. The following fragment sections may be available:
Default - this fragment displays the Agenda Item Type.
Item Number - this fragment displays the Agenda Items Item
Number.
Section Number - this fragment displays the section number.
Default - this fragment displays the section name.
SectionChildren - this fragment displays the Agenda Items and sub
sections.
Motion Type - this fragment displays the Motion Type.
Description - this fragment displays the description of the motion.
Vote Result - this fragment displays the voting result for the
motion.
7. Click Finish . The Placeholder is inserted on your template.

84
OnBase 15
After inserting the Placeholder, you can adjust the Placeholders settings using the
Fragment Settings pane:
Configuration
To change the name of the Placeholder, click Change.

If you inserted an agenda item, you can insert one of the following fragments on your
template by clicking the corresponding button:
Button
Description
ItemName
Click to insert the agenda item name.
ItemNumber
Click to insert the agenda item number.
Title
Click to insert the agenda item title.
Status
Click to insert the agenda item status.
Submitter
Click to insert the agenda item submitter.
Minutes
Click to insert the minutes for the selected agenda item.
Motions
Click to insert the motions for the selected agenda item.
Item Field
Click to insert the agenda item field.

Select one or multiple agenda item fields on the Insert Fields screen and click
OK.
If you inserted an agenda section, you can insert one of the following fragments on your
template by clicking the corresponding button:
Button
Description
SectionName
Click to insert the agenda section name.

85
OnBase 15
Button
Description
SectionNumber
Click to insert the agenda section number.
Section Field
Click to insert the agenda section field.
Configuration
Select one or multiple agenda section fields on the Insert Fields screen
and click OK.
Section Children
Click to insert the agenda sections children.
Minutes
Click to insert the minutes for the selected agenda section.
The following buttons are available from the Template Builder tabs Agenda Manager
ribbon group:
Agenda Manager
Description
Add Section Style
Click to create a new fragment to configure the style of a specific

Agenda Management meeting section.
In the Add Section Style dialog box, select a meeting section and
click OK. To create a custom style, click <Custom> and enter a
name for the style in the Custom Section Style dialog box.
After clicking OK, the following is inserted in your template:
SectionNumber[Name of meeting section or custom style]
SectionText
SectionChildren
Add Agenda Item Style
Click to create a new fragment to configure the style of a specific

Agenda Management agenda item type.
In the Add Section Style dialog box, select an agenda item type
and click OK. To create a custom style, click <Custom> and enter
a name for the style in the Custom Section Style dialog box.
After clicking OK, the following is inserted in your template:
[Name of agenda item or custom style]
ItemNumberTitle
Status
Submitter
ItemText
Creating an Agenda Item Template

1. Select the Agenda Management Placeholder source.
2. Specify a name for the placeholder.

86
OnBase 15
3. Click Setup. The Agenda Management Template Type page is displayed:
Configuration
4. Select Agenda Item .

5. Click Continue. The Agenda Management Item Type page is displayed:
6. Select an available Item Type.

87
OnBase 15
Configuration
7. Click Continue. The Agenda Management Content page is displayed:
8. Select one of the following:

Meeting Object
Description
Item Property
Select to insert the value of the specified property of the Agenda Item:
After selecting a property, you can optionally configure additional
settings. To do so:
1. Click Continue.
3. Click Continue.
5. Click Continue.
Item Field
Select to insert the value of the specified field from the Agenda Item.
After selecting an item field, you can optionally configure additional
settings. To do so:
1. Click Continue.
3. Click Continue.
5. Click Continue.
7. Click Finish . The Placeholder is inserted on your template.
Application Enabler
Application Enabler can be used to create documents with Document Composition in the
Unity Client. For more information, see the Application Enabler documentation.

88
OnBase 15
Diagnostics Service and Diagnostics Console

The Diagnostics Console can log information from the Document Composition Windows
Service. To enable logging, open the
Hyland.Office.DocumentComposition.NTService.exe.config file and modify the settings
between <Logs> and </Logs>. For information on these settings, see the Diagnostics
Service and Diagnostics Console documentation.
The document creation process can be automated by the Workflow Compose Document
action. Users requiring high throughput should contact their OnBase solution provider
for details on the Enterprise Document Composition license.
Additionally, when you import a Workflow and any associated Document Composition
templates, the templates are imported in to OnBase without a User Group assigned. The
MANAGER User Group always has rights to modify Document Composition templates.
Note: If one or more Keywords are created in the system as a result of importing a
template with Workflow, reset the cache in the Configuration module so that the
Keywords are available on the imported template.
Note: For more information on actions, see the Workflow module reference guide or help
file.
Compose Document Action

Note: This action requires a Document Composition license.
Note: This action is supported only in the Core-based OnBase Client, Web Client, and
Unity interfaces. This action is only supported in the Desktop interface when it is not
configured to require user interaction.
Creates a document from the specified template.
Note: This action can be executed on a WorkView object.
Option: Document Composition Template

Choose one of the following options to determine what template is used:
To use a specific template, select the appropriate template from the Use
Specified Template drop-down select list.
To prompt the user to select a template when the action is executed, select
Select Template at Runtime .
Note: Select Template at Runtime cannot be used when Use Automated Document
Generation is configured because this option requires user interaction.

89
Configuration
Workflow
OnBase 15
Select Template from Keyword to select a template from a Keyword Value. The
Keyword Value must contain a template name or template ID. From the dropdown select list, select the Keyword in which the template ID is stored.
Select Template from Property to select a template from a property value. The
property value must contain a template name or template ID. Enter the
property name in which the template ID is stored.
Configuration
Option: Use All Settings Configured for Template

You can choose to adhere to the configured settings of the template by selecting Use All
Settings Configured for Template .
Option: Override Template Settings

You can override the configured settings of the template by selecting Override Template
Settings with the Following: and configure settings at the action level. Manual settings will
override template settings.
Note: In order to enable the Storage Options, the Override Template Settings with the
Following: option must be selected. In order to enable Disable Import Dialog, both Inherit
Keywords From Fields and Force Document Type must be checked.
For more information on settings, see the section on general settings in the Document
Composition module reference guide or help file.
You can copy all of the settings of the current template to the override settings by
clicking Copy All Options from Template .
Configuring the Action to Not Prompt for Template Selection
If you want the action to be initiated without prompting the user to select the template
that should be used, you must configure the action settings (when Override Template
Settings with the Following is selected) or the templates settings in the following way:
Force Preview must be deselected.
Force Document Type must be selected and a Document Type must be selected
from the drop-down select list.
Inherit Keywords From Fields must be selected.
Disable Import Dialog must be selected.
Note: If the template selected in the Document Composition Template drop-down select
list has a Document Type configured, the Force Document Type drop-down list will have
the <Document Type from Template> option. When this option is selected, the action will
use the Document Type configured for the template.
Option: Use Automated Document Generation

If you have a Composition Server installed and configured and you want to use
Automated Document Generation, check the Use Automated Document Generation option
to allow composition processing to be sent to a Composition Server and not require any
user interaction. Once selected, Asynchronous Processing and Synchronous Processing
options are available. Select either Asynchronous Processing or Synchronous Processing
depending on your processing needs related to the action. See the Document
Composition documentation for more information regarding Asynchronous and
Synchronous requests.

90
OnBase 15
In order to successfully use the Use Automated Document Generation option, you must
select a Document Composition Template and a Force Document Type from the drop-down
select list. When the Use Automated Document Generation option is selected, the following
options are automatically selected and cannot be modified: Override Template Settings
with the Following , Inherit Keywords From Fields , Force Document Type , and Disable Import
Dialog .
Option: Agenda Manager Settings

The Compose Document action can be used to create documents for use by the Agenda
Manager module. When this action is executed inside Life Cycles that have been
configured to contain Agenda Item objects, the created document will be added as a
supporting document for the selected agenda item.
When this action is executed inside Life Cycles that have been configured to contain
Meeting objects, the created document will be added as an agenda document or a
minutes document. To configure the type of document that will be assigned to
documents created using this action, navigate to the Agenda Settings tab.
Note: The Agenda Settings tab is only available for Life Cycles that have been configured
to contain Meeting objects.
Select the Meeting Agenda Document option to mark any documents generated using this
action as Agenda documents. Select the Meeting Minutes Document option to mark the
documents generated using this action as Minutes documents.
WorkView
In the Web Client, the document creation process can be initiated by clicking Compose
Document in the WorkView module. For more information, see Creating a Document on
page 7.
In the Unity Client, the document creation process can be initiated from an open object
by clicking Compose from the objects main tab. The document creation process can also
be initiated from one or more selected objects in a filter by clicking Compose Document
from the Filter tab. For more information, see Creating a Document on page 11.
You can create Placeholders from WorkView objects and WorkView filters. For more
information, see Creating Placeholders on page 40.
For more information about WorkView functionality, see the WorkView documentation.

91
Configuration
Note: If the Use Automated Document Generation option is not selected and the action is
not properly configured for Automated Document Generation, this action is not
supported in System work or Timer work.
OnBase 15
Configuration

92
INSTALLATION
Requirements
Windows Vista SP2 or later service pack
Windows Server 2008 SP2 or later service pack
Windows Server 2008 R2 SP1 or later service pack
Windows 7 SP1 or later service pack
Windows 8
Windows 8.1
Windows Server 2012
Windows Server 2012 R2
Note: As of OnBase 14, the Windows XP and Windows Server 2003 operating systems are
no longer supported. These operating systems do not support Microsoft .NET Framework
4.5.1, which is a requirement as of OnBase 14. If you are using either the Windows XP
or Windows Server 2003 operating system, you should not upgrade to OnBase 14 until
you have upgraded to a Windows operating system supported by OnBase. For a
complete list of operating systems that are no longer supported, see the table below.
Operating System
No Longer Supported As Of:
Windows NT 4.0
OnBase 7.2
Windows 98
OnBase 7.2
Windows 2000
OnBase 10.0.0
Windows XP
OnBase 14
Windows Server 2003
OnBase 14
Operating System Requirements

The above Client module supported operating systems require both:
Microsoft .NET Framework 4.5.1
Microsoft Visual C++ 2013 Redistributable Package (x86)
Note: The Microsoft Visual C++ 2013 Redistributable Package (x86) is installed using the
vcredist_x86.exe delivered with OnBase.

93
OnBase 15
Installation
Client Retrieval Workstation Hardware Requirements

Hardware
Minimum
Recommended
CPU
1 GHz
2 GHz or faster
Memory (RAM)
1 GB
2 GB
Free Hard Disk

Space (total for
installation itself
and post-installation
files)
2 GB
2 GB or greater
Screen Resolution
1024 x 768 (1280 x 800)
1280 x 1024 (1440 x 900 widescreen)
Note: Using a lower

resolution may result in a
loss of functionality.
Web Client Supported Operating Systems

For Web Client workstations, the following operating systems are supported.
Apple Mac OS X version 10.6 or laterSupported only by the HTML Web
Client.
Windows 8
Windows 8.1
Windows Server 2012
Operating System
Windows NT 4.0
OnBase 7.2
Windows 98
OnBase 7.2

94
OnBase 15
Operating System
Windows 2000
OnBase 10.0.0
Windows XP
OnBase 14
Windows Server 2003
OnBase 14
Web Client Component
Minimum
CPU
1 GHz
Memory (RAM)
1 GB
Free Hard Disk Space

(for installing and
running the Web Client)
200 MB
Screen Resolution
1024 x 768 (1280 x 800)
Recommended
2 GB or greater
1280 x 1024 (1440 x

900 widescreen)
Note: Using a lower resolution may

result in a loss of functionality.
Web Browser
Active X Web Client:

Internet Explorer 9.0, 10.0, or
11.0
See Internet Explorer Browser
Support on page 96 for additional
information.
HTML Web Client (Macintosh OS):
Firefox
See Firefox Browser Support on
page 96.
Safari 5.1 update 10, 6.0 update 5,
6.2.0, 7.1.0, or 8.0.0
See Safari Browser Support on
page 96 for additional information.
HTML Web Client (Windows OS):
Firefox
See Firefox Browser Support on
page 96.
Internet Explorer 9.0, 10.0, or
11.0
See Internet Explorer Browser
Support on page 96 for additional
information.

95
Because some versions

of Internet Explorer are
not supported on all
operating systems
supported by OnBase,
the following versions
of IE are recommended
for the listed operating
systems:
Windows Vista: IE 9
Windows 7: IE 11
Windows 8: IE 10
Windows 8.1: IE 11
Installation
Web Client Hardware and Browser Requirements
OnBase 15
Web Client Component
Minimum
Email Platform
MAPI 1.1 Compliant Email Client

connection and supporting Active
Messaging DLLs
Recommended
Installation
Internet Explorer Browser Support

As of OnBase 15, the ActiveX and HTML Web Clients are supported on the versions of
Internet Explorer listed in the previous table. However, note that the following
limitations also apply:
When using Internet Explorer 10 on Windows 8 or Internet Explorer 11 or
Windows 8.1, the Web Client is only supported in Desktop Mode.
When using Internet Explorer 11, Enterprise Mode is not supported. Enterprise
Mode allows websites that are not fully compatible with IE 11 to be viewed in a
compatibility mode. The Web Client is natively compatible with IE 11, therefore
Enterprise Mode should not be used.
When using Internet Explorer 9, the Web Client is supported on the 32-bit
version of Internet Explorer, not the 64-bit version.
Firefox Browser Support

As of OnBase 15, the HTML Web Client is supported on Mozilla Firefox version 31
Extended Support Release (ESR).
Going forward, the HTML Web Client will be supported on the latest Firefox ESR version
available when OnBase is released. When a new ESR becomes available, it will be tested
for compatibility with the HTML Web Client. Once testing has passed, the HTML Web
Client will support the current ESR version and one version prior. With each subsequent
OnBase release, HTML Web Client support will be dropped for ESRs no longer supported
by Mozilla.
The HTML Web Client will not be supported on Firefox versions released between ESRs.
Users attempting to log on with an unsupported version of Firefox will be presented with
the following message:
This version of Firefox is not supported. Please use Firefox [#] ESR. If you feel
you have reached this message in error, please contact your system
administrator for assistance.
To obtain the latest ESR installer, visit
http://www.mozilla.org/en-US/firefox/organizations/all.html.
Safari Browser Support

As of OnBase 15, the HTML Web Client is supported on the versions of Safari listed in the
previous table. However, note that the following limitations also apply:
The Web Client is not supported in Safaris full screen mode.
The Web Client is not supported in Safari Reader.
Unity Client Supported Operating Systems


96
OnBase 15

Windows 8
Windows 8.1
Windows Server 2012
Operating System
Windows NT 4.0
OnBase 7.2
Windows 98
OnBase 7.2
Windows 2000
OnBase 10.0.0
Windows XP
OnBase 14
Windows Server 2003
OnBase 14
Unity Client Hardware and Browser Requirements

Component
Minimum
Recommended
CPU
1.6 GHz dual-core
2.4 GHz dual-core
Memory (RAM)
2 GB
4 GB
Free Hard Disk Space (for

installing and running the
Unity Client)
450 MB
Screen Resolution
1024 x 768 (1280 x 800)
1280 x 1024 (1440 x 900

widescreen)
Note: Using a lower

resolution may result in a
loss of functionality.
Graphics Card
128 MB

97
256 MB with hardware

acceleration support
Installation
Component
Installation
Web Browser
Email Platform
OnBase 15
Minimum
Recommended
Note: As long as you are

using a supported
operating system, there
are no further Web
browser requirements.
Lotus Notes 8.0.2 or 8.5
IBM Notes 9
Microsoft Outlook 2007,
2010, or 2013
Novell GroupWise 8 or 12
Note: When sending
messages with Novell
GroupWise, Plain Text is
the only format available.
Media Player
Windows Media Player 10
.NET Framework
Microsoft .NET Framework 4.5.1 is required on all workstations using and configuring
Document Composition, including the server that will be used to manage Enterprise
Document Composition requests.
Microsoft .NET Framework can be obtained from the Microsoft Download Center at http:/
/www.microsoft.com/downloads.
Databases Supported
The following tables list the databases supported.

98
OnBase 15
Microsoft SQL Server

Additional Information
Microsoft SQL
Server 2005 (SP2 or
later recommended)
Microsoft SQL Server 2005 must be running in compatibility mode 7

or greater. Running in compatibility mode 6.5 or lower will result in
errors during the upgrade process.

2008 (RTM, SP1, SP2;
SP2 recommended)
SQL Server 2005 drivers must be upgraded to the Feature Pack for
Microsoft SQL Server 2005 - December 2008 or a later feature pack.

2008 R2 (RTM, SP1;
SP1 recommended)
Note: On January 11, 2011, Microsoft discontinued technical support

for Microsoft SQL Server 7.0. As of release 11.0.0, Hyland Software
no longer supports SQL Server 7.0.

2012
2014
Note: On April 9, 2013, Microsoft discontinued technical support for

Microsoft SQL Server 2000. As of release 13, Hyland Software no
longer supports SQL Server 2000.
Note: You must ensure that your SQL Server database client
software version matches or exceeds the database server version.
For example, if your database server is SQL Server 2008, verify that
the database client is SQL Server 2008 (or later). Running a previous
client version, such as SQL Server 2005, will result in system
instability and memory issues. For instructions on determining your
server and client versions, see Database Client / Server Version
Compatibility on page 100.
Oracle
Note: If you are using an Oracle database, it is strongly recommended that you have a
certified Oracle Database Administrator on staff.
Oracle
Oracle v 8.0.5.0 or
later
Oracle version 8.0.5.0 can be used, but it is not recommended due

to potential memory leaks. If Oracle 8.0.5.0 is used, a third-party
ODBC driver is recommended.
Oracle 8i: 8.1.7.7 or

later
ODBC drivers should be 8.1.7 or later. 8.1.6.x drivers have known

issues and are not supported.

99
Installation
OnBase 15
Oracle
Oracle 9i: Release 1

and Release 2 (9.2)
Oracle driver version 10.2.0.3 is recommended.
Installation
Oracle 10g: Release 1

and Release 2
An issue has been observed with the Oracle ODBC drivers where
Unicode characters (e.g., Japanese characters) retrieved from a
CLOB data type will be truncated, and could potentially cause errors
in OnBase. The data remains intact in the database; however the
results when retrieving the data will be truncated. This has
specifically been observed in two areas of OnBase that use the CLOB
data type to store large amounts of data: VBScripts and License
Certificates. This behavior may apply to other areas of the software
that use this data type as well.
To ensure that Unicode characters retrieved from a CLOB data type
are not truncated, the Oracle 10g R2 ODBC drivers (which are
backward compatible) should be installed, as well as the latest
patchset (version 10.2.0.3) for these drivers.
Oracle 11g: Release 1

and Release 2
All Oracle 11g drivers can be used.
Oracle 12c
All Oracle 12c drivers can be used.
Sybase SQL Anywhere

Sybase SQL
Anywhere
Sybase SQL
As of OnBase 14, Sybase SQL Anywhere versions 11.x and lower

are no longer supported. Sybases engineering support for SQL
Anywhere versions 11.x and lower has been retired (Sybase End of
Life Page).
Anywhere
12
SAP Sybase SQL

Anywhere 16
Database Client / Server Version Compatibility

Due to critical issues that have been reported to Hyland Software, Hyland Software
strongly recommends that:
your database client software version matches or exceeds the database server
version and
you are running the most recent version of the database client.
This will help to reduce compatibility issues and minimize troubleshooting time when
issues do occur.
Your database administrator can determine the database server version and identify the
most-recent version of the database client software. The ODBC driver number indicates
which version of the database client software you are using. For example, if your
database server software is Oracle 10 Release 2, verify that the Oracle Client software is
Oracle 10 Release 2 (or later). The same is true of SQL databases. For example, if your
database server is SQL Server 2005, verify that the database client is SQL Server 2005
(or later).

100
OnBase 15
To check your database client version, perform the following steps from the workstation
or server where the ODBC connection is configured:
1. Open your ODBC Data Source Administrator, and click on the Drivers tab.
2. Select the driver you are using to connect to your OnBase database.
If your database server software is Oracle 10 Release 2, the version number
should appear as 10.2.[#.#.#] (or later), where 10.2 is the version number and
[#.#.#] represents the service pack.
The above descriptions are examples of two commonly used database version schemes.
Ensure that the supported database you use adheres to the database client/server
recommendation. In general, Hyland Software recommends that you use the most
current drivers that correspond to your system.
Database/File Servers
Server requirements are site-specific. Database/file servers should be dedicated purpose
servers; i.e., not used as a domain controller, email server, print server, proxy server,
etc. Network and disk I/O hardware should be optimized for performance and
redundancy. Multiple network interface cards on servers are often required to minimize
network bottlenecks.
Third-Party Software Support

OnBase is used in conjunction with a variety of third-party software products. The
specific versions of third-party software that are supported are documented in the
requirements sections of this manual, which reflect the versions that were required at
the time this manual was published.
For up-to-date information, click on the following link: https://www.onbase.com/
community/technical_communities/third_party_software_updates/default.aspx.
About Virtual Environments

Hyland Software develops, tests, and supports the OnBase suite of products on specific
Operating Systems, not specific hardware configurations. When OnBase is operated in a
virtual environment (such as Citrix, VMware, Hyper-V, or Windows Remote Desktop)
there may be limitations or subtle differences imposed by the environment. The
customer and the virtual environment vendor are responsible for any interactions or
issues that arise at the Hardware or Operating System layer as a result of their use of a
virtual environment.
When it appears that a performance-related issue in OnBase is either caused by (or is
unique to) the virtual environment, organizations may be asked to validate that the
issue occurs in a non-virtual environment. Hyland Software will make this request if
there is reason to believe that the virtual environment is a contributing factor to the
issue.

101
Installation
If your database server software is any version of Microsoft SQL Server, select
Microsoft ODBC Driver 11.
OnBase 15
Installation
Each OnBase site is unique. Hyland Software depends on the customers who deploy
OnBase in virtual environments to do so only after careful design and adequate planning
(that takes into account the workloads of your organization), and in accordance with
recommendations provided by the virtual environments vendor. As with any
implementation, Hyland Software strongly recommends that any customer deploying the
OnBase solution in a virtual environment thoroughly test the solution before putting it
into production.
For information about using OnBase in a Citrix and Microsoft Windows Remote Desktop
environment, please see the Citrix and Microsoft Windows Remote Desktop Environment
Deployment Guide , available from your solution provider.
64-Bit Support Statement

The OnBase suite of products is tested on 64-bit systems and is capable of being
deployed on 64-bit systems using the Windows 32-bit on Windows 64-bit Emulator
(WOW64) layer. However, OnBase modules that integrate with third-party applications
may not be able to be used with the 64-bit versions of these applications. For these
modules, only the 32-bit versions of these third-party applications are currently
supported by the OnBase integrations. Consult the module-specific requirements section
in each module reference guide for complete requirements details.
Supported database versions that are deployed on a 64-bit database server are also
supported. For more information, contact your solution provider.
Windows User Account Control Statement

Hyland Software is dedicated to ensuring that OnBase is compatible with Windows User
Account Control (UAC). UAC is a feature of Windows operating systems that was
introduced with Windows Vista. It limits the ability of standard users to make global
system changes to a workstation and prevents malicious software from making
unauthorized changes to protected areas.
For details on UAC, refer to your Microsoft support information or see http://
technet.microsoft.com/en-us/library/cc709691(WS.10).aspx.
You may encounter UAC in OnBase when:
Installing or uninstalling OnBase, OnBase modules, or OnBase ActiveX controls.
Copying, moving, or saving files to the Program Files directory, Windows
directory, or another protected location.
Modifying system-wide settings, such as the registry.
If Windows UAC is enabled, the above operations may prompt for administrator
privileges or credentials, even if an administrator is currently logged on.
Modifying Configuration Files

When UAC is enabled, administrators may be unable to modify Web.config or other
*.config files. To address this issue, the administrator should open a text editor (such as
Notepad) by right-clicking it and selecting Run as administrator. The administrator can
then open the *.config file from within the text editor. Because the text editor is running
with administrator privileges, the configuration file can be modified and saved using that
application.

102
OnBase 15
Third-Party Software Requirements

Microsoft Word 2007, 2010, or 2013 must be installed on workstations that will be
configuring Document Composition and/or generating documents with the OnBase
Client, Web Client, and Unity Client.
Note: Additional Microsoft components must be installed on workstations configuring
Document Composition. For more information on these components, see Pre-Installation
on page 105.
OnBase supports the 32-bit version of Microsoft Office 2010 and Hyland Software
recommends that customers only install the 32-bit version of Microsoft Office 2010. For
most users, the 64-bit version of Microsoft Office 2010 does not provide additional
performance benefits. Microsoft provides the following guide to assist with choosing the
correct version of Microsoft Office 2010 for your organization (http://
technet.microsoft.com/en-us/library/ee681792.aspx).
Separate versions of the Office Business Application for 2010 and Integration for
Microsoft Outlook 2010 modules are available that support the 64-bit version of
Microsoft Office 2010. The 64-bit versions of these modules have limited functionality,
though, due to some components which are not 64-bit compatible.
The following are limitations when using the 64-bit versions of the Office Business
Application for 2010 and Integration for Microsoft Outlook 2010 modules:
The embedded Unity Document Viewer cannot display Microsoft Office
documents. The Office Business Application for 2010 will be used to open all
Microsoft Office documents. The Office Business Application for 2010 is required
to view Microsoft Office documents from the Integration for Microsoft Outlook
2010.
Topaz signature pad functionality, which is part of the Signature Pad Interface
module, is not available.
Document printing, scanning, and acquisition is not available.
The Document Composition preview window, which may be displayed after
composing a new document using the Document Composition module, is not
available.
Send To | Mail Recipient functionality using the Novell GroupWise e-mail client is
not available.
Caution: OnBase does not support mixed 32-bit and 64-bit Microsoft Office installations with
the Office Business Application for 2010 and Integration for Microsoft Outlook 2010
modules.

103
Installation
Microsoft Office 2010 Support Statement
OnBase 15
Microsoft Office 2013 Support Statement
Installation
OnBase supports the 32-bit version of Microsoft Office 2013 and Hyland Software
recommends that customers only install the 32-bit version of Microsoft Office 2013. For
most users, the 64-bit version of Microsoft Office 2013 does not provide additional
performance benefits. Microsoft provides the following guide to assist with choosing the
correct version of Microsoft Office 2013 for your organization (http://
technet.microsoft.com/en-us/library/ee681792(v=office.15).aspx).
Separate versions of the Office Business Application for 2013 and Integration for
Microsoft Outlook 2013 modules are available that support the 64-bit version of
Microsoft Office 2013. The 64-bit versions of these modules have limited functionality,
though, due to some components which are not 64-bit compatible.
The following are limitations when using the 64-bit versions of the Office Business
Application for 2013 and Integration for Microsoft Outlook 2013 modules:
The embedded Unity Document Viewer cannot display Microsoft Office
documents. The Office Business Application for 2013 will be used to open all
Microsoft Office documents. The Office Business Application for 2013 is required
to view Microsoft Office documents from the Integration for Microsoft Outlook
2013.
Topaz signature pad functionality, which is part of the Signature Pad Interface
module, is not available.
Document printing, scanning, and acquisition is not available.
The Document Composition preview window, which may be displayed after
composing a new document using the Document Composition module, is not
available.
Send To | Mail Recipient functionality using the Novell GroupWise e-mail client is
not available.
Caution: OnBase does not support mixed 32-bit and 64-bit Microsoft Office installations with
the Office Business Application for 2013 and Integration for Microsoft Outlook 2013
modules.
Licensing
See Licensing on page 1 for licensing requirements.
Load Balancing
Document Composition supports load balancing across multiple Web Servers and
Application Servers. Load balancers must support either IP-based or cookie-based load
balancing (also referred to as layer-3, layer-4, and layer-7 load balancing). Load
balancers also must be configured to use persistent session (or sticky session) load
balancing. For information about configuring your load balancer, refer to its
documentation. For information about configuring OnBase modules for load balancing,
refer to the Web Server module reference guide.

104
OnBase 15
Limitations
When using cookie-based load balancing, the HttpOnly attribute in cookies must be set
to false.
Pre-Installation
The following items must be installed on client machines prior to deployment:
Microsoft Visual Studio 2010 Tools for Office Runtime (x86) SP1 , which can be
obtained from the Microsoft Download Center at http://www.microsoft.com/
downloads.
Note: The Microsoft Visual Studio 2010 Tools for Office Runtime (x86) SP1 package can also
be installed by the Hyland Office Integration Dependencies installer for ClickOnce
deployments, or by using setup.exe to run the Hyland Office 2007/2010/2013 Integration
MSI installers.
2007 Microsoft Office System Primary Interop Assemblies (PIA) redistributables,

which can be obtained from the Microsoft Download Center at http://
www.microsoft.com/downloads.
Note: The 2007 Microsoft Office System Primary Interop Assemblies (PIA)
redistributables are only required if you are using Microsoft Office 2007.
Enterprise Document Composition

In order to successfully install Enterprise Document Composition, you must have Core
Services installed on the server that will be used to manage Enterprise Document
Composition requests.
Installing Document Composition

The OnBase Client and Unity Client do not require any installation steps to use
Document Composition components for the OnBase Web Client are installed using the
Hyland Document Composition v2.0 installer. For more information on this installer, see
the following sections.
Installer Overview
Standard (EXE or MSI) Installers There are two methods for running OnBase
installers: Interactive and silent. An interactive installation requires user interaction with
dialog boxes during the installation process. A silent installation does not require user
interaction during the installation process.

105
Installation
Microsoft .NET Framework 4.5.1 , which can be obtained from the Microsoft
Download Center at http://www.microsoft.com/downloads.
OnBase 15
Installation
OnBase installers may consist of both an executable file (.exe) and a Windows Installer
Package file ( .msi). When performing an interactive installation, and both an executable
file and MSI are available, use the executable file to ensure a complete installation. The
executable validates that all prerequisites are met before proceeding with the
installation. If any missing prerequisites are identified, the installer alerts the user. Most
missing prerequisites can be installed directly from the installer before continuing the
installation process.
Note: The Microsoft .NET Framework prerequisite must always be installed separately
before running either the EXE or MSI installer. The .NET Framework installer is available
from the Microsoft Download Center at http://www.microsoft.com/downloads.
When performing a silent installation, and both an executable file and MSI are available,
use the MSI. Since the MSI package does not validate prerequisites, you must ensure
that Windows Installer 3.0 or greater is installed on each workstation and that all other
prerequisites are met before running the MSI. If any prerequisites are not met, a silent
installation from the MSI will fail without alerting the user.
For more information about configuring a silent installation, see http://
msdn.microsoft.com/en-us/library/aa367988.aspx.
ClickOnce Installers Some OnBase modules are installed for deployment using
ClickOnce. ClickOnce is a Microsoft technology that installs a deployment package to a
central server. This package can then be accessed by users to install the application on
their local workstations. The application is installed entirely under the users profile,
ensuring that it cannot interfere with other applications installed on the workstation.
ClickOnce deployments also have the following advantages:
Previously installed versions of the module can be easily and automatically
updated to the latest version with little or no user interaction, as long as the
deployment server and deployment instance name are not changed.
The module is installed on a per-user basis and does not require administrator
privileges for local installation.
There can be multiple instances of the module deployed, allowing for different
versions of the module to be installed on a per-user basis, to match the version
requirements of the workstation it is being installed to.
For more information on Microsofts ClickOnce technology see
http://msdn.microsoft.com/en-us/library/142dbbz4(VS.80).aspx.
Note: ClickOnce-deployed applications are not supported by Microsoft within a Remote
Desktop environment.
OnBase modules that are deployed using ClickOnce should either take advantage of the
ClickOnce deployment method as an alternative to a Remote Desktop deployment, or the
module should be installed using a standard installer and deployed using the Remote
Desktop methodology.
Note: Not all OnBase modules that support ClickOnce have a standard installer available.
Contact your first line of support if you are unsure how to install and deploy a specific
module.

106
OnBase 15
For more information on Microsoft ClickOnce technology in a Remote Desktop

environment, see http://support.microsoft.com/kb/2020945.
For more information on Microsoft ClickOnce technology in a Citrix environment, refer to
the Citrix help files or support provided by Citrix.
Silent Installation Using setup.exe If you are running setup.exe silently from the
command line you must use the /q switch and the /CompleteCommandArgs switch,
followed by the required command-line arguments.
The q switch specifies quiet mode and is required to suppress the GUI. The
CompleteCommandArgs switch must be followed by the command-line parameters
required to configure and install the desired components.
The complete string of command-line parameters must be included in double quotes
after the CompleteCommandArgs switch. If a parameter in the string also requires double
quotes, those quotes must be escaped using \. For example: setup.exe /q /
CompleteCommandArgs "INSTALL_PROPERTY=\"my value\" INSTALL_PROPERTY_2=\"my
value 2\"".
Note: You should check the return value of the setup.exe process. A return value of 0
(zero) indicates success. Any other value returned may indicate that an error was
encountered and the installation failed.
Installer Prerequisites
The installer must be run on operating systems that support the Windows Installer
3.0+ architecture.
The installer setup executable (setup.exe ) detects most of the prerequisites for the
module that are also required for installation and installs them, if necessary. If the
installer fails to run, install all of the requirements for the module separately before
relaunching the installer. Module requirements can be found in the installation chapters
of the corresponding module reference guides.
Note: If installation is being performed using the installer MSI file, the requirements for
the module must be installed before launching the installer.
Installer User Permissions

You must be logged on to the installation machine with administrator privileges in order
to run the installer.

107
Installation
User Account Control (UAC) If Windows User Account Control (UAC) is enabled,
the installer must be run with elevated administrator privileges, even if an administrator
is currently logged on. This can be accomplished by right clicking on the installer
executable and selecting Run as Administrator from the right-click menu. MSI files cannot
be run using the Run as Administrator option. Instead, you must launch the MSI package
using the command line. For more information on installing files through the command
line, refer to your Microsoft support information or see http://technet.microsoft.com/enus/library/cc759262(WS.10).aspx.
OnBase 15
If installing under Windows operating systems with UAC enabled, the installer must be
run with elevated administrator privileges, even if the user currently logged in is an
administrator.
Installer .NET Framework Requirements
Installation
The installer must be run on a machine that meets the .NET Framework requirements of
the module being installed. Module requirements can be found in the installation
chapters of the corresponding module reference guides.
The required version of the .NET Framework must be installed before launching the
installer; it is not installed if it is missing. The .NET Framework can be obtained from the
Microsoft Download Center at http://www.microsoft.com/downloads.
Running the Document Composition v2.0 Installer

Note: The build versions of Document Composition and the Office Business Application,
including the Template Builder, must match. When upgrading, both Document
Composition and the Office Business Application must be upgraded at the same time.
Launch the Document Composition v2.0 installer by executing Hyland Document
Composition v2.0.msi . The MSI is usually located in the \install\Document
Composition\v2\ folder of your source installation files.
Note: If the installer is being copied from the source location to be run from a different
location, the entire \Document Composition\v2\ folder and its contents must be copied to
the new location.
The Hyland Document Composition v2.0 installation welcome dialog is displayed.

1. Click Next. The Ready to install dialog is displayed.
2. Click Install to continue with the installation, or click Cancel to cancel the
installation.
3. When the installation is complete, click Finish.
Note: In order to ensure that the required system settings take effect, it is a best
practice to restart the installing machine once the installer has finished.

108
OnBase 15
Change, Repair, or Remove an Installation

After initial installation, the setup program can be used to change, repair, or remove
components from a previous installation. After launching setup.exe or the *.msi
installation package, and clicking Next at the welcome dialog, the Change, repair, or
remove installation dialog box is displayed.
Select the option for the actions you wish to perform:
Description
Change
Add or remove components using the Custom Setup dialog.

Note: This option is not available if the installer has no independently
selectable features.
The steps for adding selected components are the same as those under the
Component Selection section of the installation instructions, if applicable to
the installer.
Note: Change does not allow you to alter configuration options originally set
during a previous installation of components contained in the installer.
Repair
Repair errors in the most recent installation of the component, such as

missing and corrupt files, shortcuts, and registry entries.
Note: This option is not available from all installers. Repair does not include
errors made in the configuration options set by the user during installation.
For specific troubleshooting information regarding an installed component,
see the module reference guide for that component.
Remove
Removes all previously installed components.
Running the Installer from the Command Line

You can control the installation of components from the command line by passing its
feature name to the installer using the ADDLOCAL property. The values of the
configuration options available in the graphical installation wizard are passed to the
installer using the property names associated with the installer options.
This section describes the feature names and properties associated with this installer.
Note: Feature and Property names are case sensitive.
Feature Names
To install Image and Word Composition, the value of the ADDLOCAL property is
DocumentComposition_v2 .
The ADDLOCAL property is added to the installation command line, as shown here:

109
Installation
Option
OnBase 15
msiexec /i "Hyland Document Composition v2.0.msi" ADDLOCAL=DocumentComposition_v2
Properties
The Hyland Document Composition v2.0 installer does not have any additional properties
that can be set.
Installation
Installing the Template Builder

Caution: Before installing the Template Builder, ensure that the additional Microsoft
components in Pre-Installation on page 105 have been installed.
The Template Builder, which is the Document Composition configuration component, is

installed using the Office Products Installer. For instructions on how to install the
Template Builder using the Office Products Installer, see the Office Products Installer
chapter in the Core Enterprise Installers module reference guide.
Installing Enterprise Document Composition

In order to install Enterprise Document Composition, you must install the Document
Composition Windows Service. The Document Composition Windows Service is installed
using the Hyland Server Side Components Installer. For more information, see the Core
Enterprise Installers Module Reference Guide.
Command Line Switches and INI Settings

INI File
INI files (initialization files) are plain-text files that contain configuration information.
These files are used by Windows and Windows-based applications to save and access
information about your preferences and operating environment. OnBase uses an
initialization file named onbase32.ini. If a user does not have rights to access the
onbase32.ini file, that user will be unable to use the Client or Configuration modules.
The onbase32.ini file is primarily used to store settings specified in the Client or
Configuration module. For example, when a user selects a default data source in the
OnBase Clients Workstation Options dialog box, this selection is saved to the
onbase32.ini file. The onbase32.ini file is also used to make modifications to OnBase
modules that cannot be made through the modules interface.
Previous File Location/File Name

Every version of the OnBase Client prior to 8.2.0 used an INI file named OnBase.ini. In
OnBase 8.2.0 and subsequent versions, the INI file was moved to a new location to be
consistent with changes Microsoft has made to Windows. Since the location has
changed, the name of the file has also been changed to alleviate some confusion
between the needs of OnBase 8.2.0 and installations of older executables. The new file
name is onbase32.ini.

110
OnBase 15
Location
For all currently supported operating systems (i.e., Windows Vista SP2 or later), the
default location of the onbase32.ini file is C:\ProgramData\Hyland Software. For previous
versions of OnBase running on older operating systems, the default location of the
onbase32.ini file may have been different (e.g., C:\Documents and Settings\All
Users\Application Data\Hyland Software ).
Your onbase32.ini file may reside in a different location, if that location is specified by
the following command line switch on the OnBase Client shortcut target:
-INIFILE= "full path\filename" , where full path and filename are replaced by the specific
path and file name.
If this command line switch is not used and you move or rename your onbase32.ini file,
OnBase will recreate the file in the default folder and ignore the newly created file.
INI Considerations in a Citrix and Microsoft Windows Remote Desktop

Environment
In Remote Desktop environments, a remote session is established in which the user is
running applications that are not installed locally. This presents a challenge when an
application, such as OnBase, requires a user-specific INI file to establish unique settings.
In a Remote Desktop environment, you must ensure that each user has a single, unique
INI file to make sure any user-specific settings are consistent for that user.
Note: The default location of the OnBase INI file is not unique in a Remote Desktop
environment.
To ensure that the INI file is accessible by OnBase and unique to each user in a Remote
Desktop environment, the -INIFILE command line switch must be applied to the OnBase
Client and Configuration shortcuts and be set to a unique location for the INI file.
Note: Additional details regarding the deployment of OnBase in a remote desktop
environment is discussed in detail in the Citrix and Microsoft Windows Remote Desktop
Environment Deployment Guide , available from your first line of support.
Editing the INI File

Users with the Configuration Product Right can open the onbase32.ini file from the
OnBase Client by selecting Admin | Utilities | Edit INI File. When multiple onbase32.ini
files exist, opening the onbase32.ini file from the OnBase Client ensures that a user is
editing the correct onbase32.ini file instance. In most cases, this will be the onbase32.ini
file residing in the default directory described above. If an alternate location for the
onbase32.ini file is specified by the -INIFILE command line switch, the file in the
specified location will be opened.

111
Installation
Note: To maintain backwards compatibility with previous versions of OnBase, OnBase will
check the workstations C:\Windows folder for the OnBase INI file if it is not found in the
folder specified above. If the OnBase INI file is found in the C:\Windows folder, OnBase
will copy the file to the new location. The previously existing version of the OnBase INI
file will remain in the C:\Windows folder, but will no longer be used by OnBase.
OnBase 15
Troubleshooting
1. How do I prevent my template from opening in a separate window if Im using Word
2007?
Installation
Edit the registry as described in Microsoft KnowledgeBase Article 927009.

2. I successfully installed Document Composition, but the Template Builder tab is not
displayed when I launch Word.
Enable and load the Document Composition add-in:
a.In Word, click the Office button.
b.Select Add-ins.
c. Select Disabled Items from the Manage drop-down list.
d.Click Go.
e.If the Document Composition add-in is included in the Disabled Items dialog
box, select it and click Enable.
f. The Document Composition add-in is enabled.
g.Select Add-ins.
h.Select COM Add-ins from the Manage drop-down list.
i. Click Go.
j. Select the check box next to the Document Composition add-in in the COM AddIns dialog box, and click OK .
k. The Document Composition add-in is loaded.
3. When using Enterprise Document Composition, the Diagnostics Console displays a
message stating, Could not get performance counter Total Documents Created in
category DocumentComposition.
This issue can occur after upgrading or when migrating from the Document
Composition for Microsoft Word module. Previous Document Composition
performance counters were not uninstalled, thus preventing the new ones from
being created.
To resolve this issue:
a.Stop the Document Composition Windows Service.
b.Open a command prompt and navigate to the directory where the Document
Composition Windows Service was installed (for example, C:\Program
Files\Hyland\Document Composition Service or C:\Program
Files(x86)\Hyland\Services\Document Composition).
c. Type Run Hyland.Office.DocumentComposition.NTService.exe /removeCounters.
d.Press the Enter key.
e.Type Run Hyland.Office.DocumentComposition.NTService.exe /installCounters.
f. Press the Enter key.

112
OnBase 15
4. The Diagnostics Console displays a message stating,

System.IO.IsolatedStorage.IsolatedStorageException: Unable to open the store.

113
Installation
This issue can occur when attempting to create a document using a large
template (i.e., hundreds of pages), or if a template creates a large document. It
is caused by an issue in the .NET Framework. To resolve this issue, enable
Impersonation on the Application Server. If Enterprise Document Composition is
being used, the Composition Windows Service should be configured to run as a
user instead of as SYSTEM .
5. How do I modify the service location I specified during Template Builder installation?
Edit Hyland.Office[year].DocumentComposition.Config.dll.config. In a typical MSI
installation, this file is located in C:\Program Files\Hyland\Office
Integration\Office [year] (32-bit operating systems) or C:\Program
Files(x86)\Hyland\Office Integration\Office [year] (64-bit operating systems).
6. When composing a document and storing it as a PDF or TIFF, some Word features (for
example, art page borders) are not displayed on the composed document.
Document Composition does not support the use of all Word features when
composed documents are stored as PDF or TIFF. If Word features are not
displayed on composed documents being stored as a PDF or TIFF, store the
composed document as a Word document (.docx).
7. How do I resolve the There was an error in gathering Field Information selected
Field error, which occurs when upgrading a database that is licensed for Document
Composition and WorkView?
Upgrade the OnBase database, install and run WorkView Configuration, and install
8. When configuring a new template with a Metadata Placeholder, the Document Type
and Keyword Type drop-down lists on the Placeholder Input screen are both empty.
This occurs because of the fact that WorkView attributes can be used as
Placeholders. If the WorkView database tables are not present in the database,
none of the Document Types or Keyword Types will display unless the WorkView
tables have been created in the OnBase database. To resolve this issue, install
and run WorkView Configuration to create the WorkView tables in the OnBase
database. After creating the WorkView tables, close and re-open Microsoft Word,
and then re-launch the Template Builder.
9. When using a Workflow ad-hoc task to generate a document using a Document
Composition template, a Navigation to the webpage was cancelled message is
displayed if you are using Microsoft Word 2007.
This is because the Browse in same window option for .DOC or .DOCX file
extensions is not set. This setting is configured per user, and may be turned off
when upgrading Internet Explorer. This error may also be caused by changing the
version of Microsoft Word that is used. To resolve this issue, enable the Browse in
same window option for .DOC and .DOCX files. For complete instructions, refer to
Microsoft KB Article 162059 (http://support.microsoft.com/kb/162059).
10. When composing a PDF or TIFF document using a Document Composition template,
tables within the document overlap surrounding tables, images, and/or text.
This issue may be a result of one or more tables in the template using the Around
text wrapping table property. To change this, open the template in the Template
Builder and right-click the appropriate table. Select Table Properties and select the
None property for Text Wrapping. Do this for each overlapping table.
You can also try adjusting the spacing in between the tables to solve the issue if
you do not want to change the table properties.
OnBase 15
Installation
11. When using the AscW VBScript function, negative values are returned when asking for
the Unicode value of a non-Latin character. This negative number is then composed
onto a document at runtime rather than the desired Unicode character.
Microsoft has acknowledged this is a known issue. For more information on how to
work around this issue, refer to Microsoft KB article 272138 (http://
support.microsoft.com/kb/272138/en).
12. When using C/WScript to run VBScripts, an error message is displayed.
This issue occurs if the script file is UTF-8 encoded. UTF-8 encoded script files are
not supported when using C/WScript to run VBScripts. When using C/Scripts to
run VBScripts, UTF-16 encoded script files must be used.

114
CONFIGURING THE DISTRIBUTION SERVICE

Overview
The Hyland Distribution Service is a Core Services component that integrates with
several OnBase modules, allowing email notifications to be sent through a centralized
mail service. All installation and configuration settings are located on one workstation as
opposed to several workstations. This provides high security, control, and easy
maintenance.
The Distribution Service process is depicted in the following illustration. The process
begins when OnBase client applications send system notifications to the database. The
Distribution Service polls the database on a configured interval and composes an email
when it receives a new notification. The service then sends the email to an SMTP server,
where it is distributed externally to all users who are configured to receive notifications
from modules that use the Distribution Service. When OnBase documents are attached
to these emails, attachment names reflect the documents Auto-Name strings in OnBase.
The Distribution Service can run on a machine separate from that of the Application
Server.
Note: The Distribution Service must be configured to use a Service Account to send
notifications. For more information, see Configuring a Service Account on page 119.
Installation
The Hyland Distribution Service can be installed either manually or using the Hyland
Components Installer. See the Core Enterprise Installers reference guide for information
about using the Hyland Components Installer.
For manual installation steps, see the following:

115
OnBase 15
Configuring the Distribution Service
Installing the Distribution Service Manually

If necessary, you can manually install the Distribution Service and configure it by editing
its XML configuration file.
1. From your OnBase Core Services directory, open the ..\apps\NTServices\
Hyland.Core.Distribution folder.
2. Copy the contents of the Hyland.Core.Distribution folder and paste them in a
logical location on the server. For example: C:\Program
Files\Hyland\Services\Distribution in a 32-bit environment, or C:\Program Files
(x86)\Hyland\Services\Distribution in a 64-bit environment.
3. From the Command Prompt, navigate to the location of your Distribution Service
executable For example, type:
cd "C:\Program Files\Hyland\Services\Distribution"
4. From this location, run the following command:
Hyland.Core.Distribution.NTService.exe /install
This will add the Distribution Service to your Windows Services console.
5. Navigate to the location where you copied the files in step 2.
6. With a text editor, open the Hyland.Core.Distribution.NTService.exe.config file.
7. In the <Hyland.Core.Distribution> section, configure values for the following
securitySettings. Be sure to remove the brackets from the values you are adding,
but keep the quotation marks. For example, provide the value for password as
"PASSWORD" not "[PASSWORD]"
Setting a
Description
pollSettings
interval
This is the interval that the Distribution Service uses to poll OnBase for
notifications. The default value is 120 (seconds). Change this value to
the number of seconds you consider an acceptable delay for sending
notifications. For example, if five minutes is an acceptable delay,
change the value to 300 (5 mins. x 60 secs/min.). If notifications need
to be sent within a minute of being created, change the value to 60 (1
min. x 60 secs/min.).
datasource
This is the ODBC connection to the OnBase database. When creating

the ODBC connection in a 64-bit environment, use the 32-bit version of
the ODBC Administrator Console instead of the default console residing
in system32 (odbcad32.exe). The 32-bit version typically resides in
C:\Windows\SysWow64.
Note: To add support for multiple data sources, see Adding Support for
Multiple Data Sources on page 125.
username
The user must be configured as a Service Account and must have the
Service Account check box checked. See Configuring a Service Account
on page 119.

116
OnBase 15
Description
password
The password of the Service Account.

Note: For increased security, encrypt the Service Accounts user name
and password in the system registry. See Encrypting the Service
Account Credentials on page 123.
institution
(Optional)
For institutional databases, add the parameter institution="99"
(where 99 is the Service Accounts institution number).
a. The names of these settings are case sensitive.

Note: The testconnection attribute lets you specify whether you want the Distribution
Service to check the data source connection when it starts. It is recommended that you
keep the default setting of false. There is a known issue where changing this setting to
true will cause the Distribution Service to time out every other time it starts.
8. Under smtpSettings, modify the following settings:
Setting
Description
smtpServer
Set to your organizations SMTP server.
defaultSender
This value is displayed as the sender of the notification by

default. If you enter a valid email address, undeliverable
notifications will be sent to this address. For example, enter
Administrator@yourdomain.com. When notifications are
delivered to users, the From field will display
Administrator@yourdomain.com. Any notifications that could not
be delivered will be sent to this address.
Tip: Change the defaultSender value to USER (all uppercase) to
display the email address of the OnBase user who triggered the
notification. For more information and requirements, see
Displaying the User Who Triggered the Notification as the Sender
on page 126.
mimeParameterEncoding
Controls how attachment file names are displayed. This setting

may need to be changed to support non-ASCII characters in file
names. Valid values are QuotedPrintable, Raw8Bit, or
RFC2231. For more information, see Supporting Non-ASCII
Characters in Attachment File Names on page 126.

117
Setting a
OnBase 15
Setting
Description
maxRecipientsPerSend
This setting controls the number of recipients that are sent

emails at once. If the recipient list is longer than the value of
this setting, emails are sent in multiple batches in order to
prevent timeout errors.
The default value is 500 recipients. Modifying this setting is
optional.
9. Open Services from the Administrative Tools in the Windows Control Panel, and
double-click Hyland Distribution Service.
10. Click the Log On tab.
11. Enter the correct login information for the user account that will be used to run
the Distribution Service. Click OK.
12. Start the service.
Note: For troubleshooting purposes, it is recommended you run only one instance of the
Distribution Service on the system.
Uninstalling the Distribution Service

There are several methods for uninstalling the Distribution Service. If you installed the
Distribution Service manually, you can either run a command from a command prompt,
or manually stop the service and remove the files.
If you installed the Distribution Service using the Hyland Server Side Components
installer, then you can use the Add or Remove Programs utility in the Windows Control
Panel to remove Hyland Server Components.
Running a Command
This is the preferred method for uninstalling the Distribution Service.
1. From a command prompt, navigate to the location of your Distribution Service
executable (for example, C:\Program Files\Hyland\Services\Distribution).
2. From this location, run the following command:
Hyland.Core.Distribution.NTService.exe /uninstall
Stopping the Service and Removing Files

1. Using a Run dialog box, run services.msc.
To do this, select Start | Run, type services.msc and click OK. The Services console
is displayed.
2. Stop the Distribution Service.
3. Use the Task Manager to ensure the executable is no longer running.
You may now delete the Distribution Services physical files.
4. From a Run dialog box, run regedt32.exe.
Select Start | Run, type regedt32.exe and click OK. The Registry Editor window is
displayed.

118
OnBase 15
5. Navigate to HKLM\SYSTEM\CurrentControlSet\Services.
6. Delete the Hyland.Core.Distribution.NTService registry key.
7. Restart the computer.
Upgrading the Distribution Service

All Distribution Servers should be upgraded to OnBase 15 when the OnBase database is
upgraded to OnBase 15.
The OnBase 15 Distribution Service can send notifications generated in earlier OnBase
versions. However, Distribution Service versions 13 and older cannot send notifications
generated in OnBase 15 clients; any notifications generated in OnBase 15 clients will not
be sent until the Distribution Service is upgraded to OnBase 15.
Using the Distribution Service with Document Distribution

When using the Distribution Service with Document Distribution, new configuration steps
are required when upgrading to OnBase 15. If your system is configured with the Global
Client Setting Use Email Distribution Service for Document Distribution enabled, a
temporary file cache must be configured and associated with the Distribution Service.
See Configuring a Temporary File Cache on page 127 for more information.
Configuration
Configuring a Service Account
The Distribution Service must be configured to use a Service Account.
Note: The service account running the Distribution Service cannot have special
characters, such as & , in the password. If the password contains a special character,
then the Distribution Service will fail to start.

119
Caution: Modify the registry at your own risk. Incorrectly editing the Windows registry can
cause serious problems that may require you to reinstall your operating system. Be sure to
back up the registry before making any changes to it. For more registry information, see
the following Microsoft articles: http://support.microsoft.com/kb/256986 and http://
technet.microsoft.com/en-us/library/cc725612.aspx
OnBase 15
To configure a Service Account:

1. From the Configuration module, select Users | User Names / Passwords.
The User Names & Passwords dialog box is displayed.
2. Enter a new user name in the field beneath the User Name list and click Create.
The User Settings dialog box is displayed.
You can also select an existing user account to designate as a service account,
then click Settings. The User Settings dialog box is displayed.

120
OnBase 15
Caution: The Service Account check box should never be selected with an account that is
being used to run the OnBase Client (obclnt32.exe) as a Windows service.
Caution: Designating an existing user account as a Service Account removes the existing
user from all User Groups and prevents the user from being added into a User Group. Users
that are configured as service accounts will not be able to log into OnBase through
standard interfaces. A Service Account also grants the user name full rights and privileges
in OnBase.

121
3. Select the Service Account check box under Administrator Options .

All options not applicable to a Service Account are disabled. Deselecting the
Service Account check box for the existing user allows them to retain all rights and
privileges that were previously assigned to them. Options in the User Settings
dialog box are cleared when the Service Account check box is selected and must
be reapplied when the check box is deselected.
OnBase 15
4. Enter a User Password and repeat this password in the Verify Password field.
If this is an existing user account and you need to change its password, select
Update Password to enable the fields. Then, enter a new password for the user
account.
5. Click Save.
Enabling the Distribution Service

To use the Distribution Service to send users email notifications or to distribute emails,
you must enable it through Global Client Settings. (This step is not necessary if the
Distribution Service is used only by WorkView.)
The Distribution Service can be used to send email distributions while using the
Document Distribution module and is optional.
The Distribution Service is optional if you want to send notifications for the following
modules in the OnBase Client: Document Knowledge Transfer, Workflow, and Physical
Records Management. The Distribution Service is required for all other modules that are
able to send notifications (such as Document Knowledge Transfer or Workflow in the Web
Client).
To enable email automation using the Distribution Service:
1. From the Configuration module, select Users | Global Client Settings.
2. Click the Email tab.
3. Select the Use Email Distribution Service for automated emails check box or, if you
are configuring the Distribution Service for Document Distribution, select the Use
Email Distribution Service for Document Distribution check box.
4. Click Save.
The Distribution Service can be configured to send attachments with certain file names.
To configure file names for attachments:
1. From the Configuration module, select Users | Global Client Settings.
2. Click the Email tab.
3. Select one of the following from the Auto-Name string for external email
attachments drop-down select list:
Random String: OnBase will generate a random file name for the attachment.
Document Type Autoname String: OnBase will use the Auto-Name string
configured for the Document Type of the document being sent.
Document Type Print Autoname String: OnBase will use the Print Title string
configured for the Document Type of the document being sent. If no Print
Title string has been configured for that Document Type, OnBase will use the
Document Type and the Document Date.
4. Click Save.
Note: The Distribution Service needs to be restarted after changes are made to the AutoName string for external email attachments setting.

122
OnBase 15
Users Configuration Requirements
1. From the Configuration module, select Users | User Names/Passwords .

2. Select the user name and click Settings.
3. In the Users Email field, type the users email address.
Encrypting the Service Account Credentials

By default, the Service Accounts user name and password are entered in
Hyland.Core.Distribution.NTService.exe.config file in clear text. Although these
credentials cannot be used to log on to any OnBase client application, you should
encrypt them in the Windows registry using the aspnet_setreg utility. The Distribution
Service can then be configured to refer to the encrypted registry keys to retrieve the
Service Accounts user name and password.
Note: Full details on creating encrypted account registry keys are available in the
Microsoft article: How to use the ASP.NET utility to encrypt credentials and session
state connection strings available at: http://support.microsoft.com/kb/329290/
1. From a command line, change the directory to the location where the
aspnet_setreg.exe utility resides. A copy of aspnet_setreg.exe is available in the
..\utilities\MISC subdirectory of the Core Services build.
For example, if the utility is in C:\Program Files\Hyland\Web Server\Utilities, then
enter:
cd C:\Program Files\Hyland\Web Server\Utilities
2. Enter the following command, where username is the user name of the Service
Account, and password is the password.
aspnet_setreg.exe -k:SOFTWARE\Hyland\DistributionService\Identity -u:"username"
-p:"password"
3. Open a Run dialog box and enter regedt32 .
Caution: Modify the registry at your own risk. Incorrectly editing the Windows registry can
cause serious problems that may require you to reinstall your operating system. Be sure to
back up the registry before making any changes to it. For more registry information, see
the following Microsoft articles: http://support.microsoft.com/kb/256986 and http://
technet.microsoft.com/en-us/library/cc725612.aspx

123
The following procedure describes the steps necessary to configure the Distribution
Service for system notifications. Ensure users who will receive notifications have email
accounts configured in their User Settings.
OnBase 15
4. Grant the Windows account that will run the Distribution Service Read permissions
to the appropriate key.
In 32-bit environments, grant the Read permission on
HKLM:SOFTWARE\Hyland\DistributionService\Identity\ASPNET_SETREG.
In 64-bit environments, grant the Read permission on
HKLM:SOFTWARE\Wow6432Node\Hyland\DistributionService\Identity\ASPNE
T_SETREG. When run in a 64-bit environment, the aspnet_setreg utility
automatically stores the encrypted credentials in this key.
5. Open the Hyland.Core.Distribution.NTService.exe.config file.
In a 32-bit environment, this files default location is
C:\Program Files\Hyland\Services\Distribution.
C:\Program Files (x86)\Hyland\Services\Distribution.
6. Modify the securitySettings element to retrieve the encrypted credentials from the
registry.
a.Replace the username value with the following:
"registry:HKLM\SOFTWARE\Hyland\DistributionService\Identity\ASPNET_SETREG,userName
"
b.Replace the password value with the following:
"registry:HKLM\SOFTWARE\Hyland\DistributionService\Identity\ASPNET_SETREG,password
"
When you are finished, the securitySettings element should resemble the
following:
7. Save the configuration file.

8. Restart the Hyland Distribution Service using the Windows Services console.

124
OnBase 15
Changing Configuration File Settings

2. Change the settings as needed.
3. Restart the Distribution Service. The new settings are respected.
Adding Support for Multiple Data Sources

If your solution uses multiple data sources, then the Hyland Distribution Service can be
configured to access each data source.
2. Copy the following element, which is located under <Hyland.Core.Distribution>:
3. For each data source that the service needs to access, paste a copy of the
element directly under the existing element. For example, if the service needs to
access two data sources, then there should be two securitySettings elements,
each with its own closing tag
( </securitySettings>).
In the following example, support has been added for two data sources:
4. For each securitySettings element, change the datasource value to the name of the
data source that the service needs to access.

125
You can change settings like the data source, SMTP server, and default sender by editing
the Distribution Services configuration file. To modify these settings, do the following:
OnBase 15
5. For each securitySettings element, change the username and password values to
reflect the service account credentials for each data source.
Note: To conserve system resources, increasing the pollSettings interval value is
recommended. The default value is 120 (seconds). Change this value to the number of
seconds you consider an acceptable delay for sending notifications. For example, if five
minutes is an acceptable delay, change the value to 300 (5 mins. x 60 secs/min).
6. Save the file.

7. Restart the Hyland Distribution Service using the Windows Services console.
Sending Notifications to Global Distribution Lists

The Hyland Distribution Service can send notifications to global distribution lists that are
set up on your SMTP server. This option is available in modules like Workflow and
WorkView, which let you specify the users you want to send notifications to.
To send a notification to a global distribution list, specify the distribution list as the
notifications recipient during configuration. Ensure the value you enter matches the
name of the global distribution list configured on the SMTP server.
Displaying the User Who Triggered the Notification as the Sender

The defaultSender setting in the Distribution Services configuration file controls the
name or address displayed as the sender of automated notifications. You can configure
the Distribution Service to display the email address of the user who triggered the
notifications by setting defaultSender to USER.
Note: USER must be entered in all uppercase characters.
Users who trigger notifications must have valid email addresses configured in OnBase.
Otherwise, the notifications are not sent, and the message Server Error: 501 5.5.4 Invalid
Address is displayed in the Errors tab of the Diagnostics Console.
The defaultSender setting can be overridden by modules like Workflow and WorkView,
which allow you to configure the sender address for notifications.
Supporting Non-ASCII Characters in Attachment File Names

The mimeParameterEncoding setting in the Distribution Service configuration file controls
how attachment Auto-Names are displayed. This setting may need to be modified if
Auto-Names contain non-ASCII characters, such as Japanese characters.

126
OnBase 15
The following values are supported:

QuotedPrintable Offers full compatibility with Microsoft Outlook.
Raw8BitDisplays unencoded file names, which may be inappropriate for
names containing non-ASCII characters. Try using this value if names are not
displaying appropriately with the default mimeParameterEncoding value.
The default value is QuotedPrintable. If the mimeParameterEncoding setting is blank or
missing, Raw8Bit is used.
Note: File names that contain only ASCII characters are not encoded.
Configuring the Distribution Service to Save Notifications as Text

Files
In some instances, you might want to output email notifications to text files to be
processed by a third-party mail application. When this method for distributing
notifications is necessary, complete the following steps:
1. Create a directory to store the text files. This directory should be accessible
locally, in a mapped drive or through an UNC path to a shared directory. The path
name must be fully qualified. It must start with \\Name, where Name is the name
of the machine name, or X:\, where X is any drive letter.
2. Modify the Hyland.Core.Distribution.NTService.exe.config file for the Distribution
Service so that the smtpServer entry specifies this directory name. One file per
notification will be written to the target directory specified.
Sending Unity Forms

If you plan to send Unity Forms using the Distribution Service, please see Unity Forms
Limitations on page 135.
Configuring a Temporary File Cache

When the Global Client Setting Use Email Distribution Service for Document Distribution is
enabled, a temporary file cache must be configured and associated with the Distribution
Service.
Email notifications and their attachments sent from Document Distribution are stored in
the temporary file cache. This allows Document Distribution to send emails and
attachments that are not archived in OnBase. The Distribution Service sends these
emails from the temporary file cache. Attachments are sent in their configured file
format.
Once a temporary file cache is configured, it must be associated with the Distribution
Service. See Associating a Temporary File Cache with the Distribution Service on page
130 for more information.

127
RFC2231 Latest standard, not supported by Outlook.
OnBase 15
To create a temporary file cache:

1. In the Configuration module, select Disk Mgmt | Temporary File Caching .
The Temporary File Caches dialog is displayed.
Previously configured file caches, if any, are displayed in the Temporary File
Caches list.
2. Type the name of the new file cache in the text field below the Temporary File
Caches list.

128
OnBase 15
3. Click Create.
The Cache Configuration dialog is displayed.
4. Enter the desired file path of the file cache in the Path field. Use the Browse
button to navigate to the desired location.
5. From the Type drop-down menu, select either Distribution Service or M icrosoft
Office Web Apps .
Select Distribution Service if the file cache is to be used with the Distribution
Service.
Select Microsoft Office Web Apps if the file cache is to be used with the WOPI
viewer.
Note: If the Cache Configuration dialog was accessed from the Distribution Service Settings
or Microsoft Office Web Apps Settings dialog, the Type field will be set to Distribution
Service or Microsoft Office Web Apps, depending on the point of access, and cannot be
changed. These temporary caches, created from the Configure button in the Distribution
Service Settings dialog or the Microsoft Office Web Apps Settings dialog, are automatically
associated with the desired functionality upon completion of configuration.
6. In the Purging Information section of the dialog, select either Automatic Purge or
Manual Purge .
Select Automatic Purge if you would like the file cache to be cleared automatically
when the Retention Time has been reached.
Select Manual Purge if you would like to empty the file cache yourself.
7. If you selected Automatic Purge in the previous step, set the Retention Time in the
Retention Time (Days) field. This value represents how many days files are stored
in the temporary file cache before being automatically purged.
This field is unavailable if the Manual Purge option is selected.
8. Click Save when finished.

129
OnBase 15
Associating a Temporary File Cache with the Distribution Service

Once a temporary file cache has been created for use with Document Distribution, it
must be associated with the Distribution Service.
To associate a temporary file cache with the Distribution Service:
1. In the Configuration module, navigate to Utils | Distribution Service Settings. The
Distribution Service Settings dialog box is displayed:
2. From the Temporary Cache drop-down select list, select the temporary file cache
you want to associate with the Distribution Service.
If there are no temporary file caches available, one must be configured. Click
Create New to configure a temporary file cache. See Configuring a Temporary File
Cache on page 127 for more information on this process.
3. Click Save.
Configuring Retry Settings

The Distribution Service can be configured to attempt to send notifications again upon a
failure. To configure these settings:
1. In the Configuration module, navigate to Utils | Distribution Service Settings. The
Distribution Service Settings dialog box is displayed:

130
OnBase 15
2. In the Retry Settings section, select one of the following options:
Never retry - The Distribution Service does not attempt to send the
notification if a failure occurs.
Retry specific number of times - The Distribution Service tries to send the
notification until the specified number of attempts is reached. In the field
provided, enter the number of attempts that you want the Distribution
Service to make.
3. Click Save.
Troubleshooting
The following troubleshooting information may help you diagnose and resolve issues
with the Hyland Distribution Service.
Logging Information to the Diagnostics Console

You can use the Diagnostics Console to troubleshoot Distribution Service issues.
Diagnostics information is logged under the Timer / Distribution Service tab in the
Diagnostic Console.
If Distribution Service information should be logged to the Diagnostics Console, logging
must be enabled in Hyland.Core.Distribution.NTService.exe.config . To enable logging, set
the enableMailSlot attribute for the timer-profile log to true .
Note: In previous versions of OnBase, the path and enableFile configuration settings were
used to log events to a file. The preferred method of logging events to a file is using
service logs created by the Diagnostics Service. For more information, see the
Diagnostics Service reference guide or the Diagnostics Console help files.
Under Hyland.Core.Distribution, modify the verbose level to control the amount of

information that is logged. In the threadSettings element, set the verboseLevel attribute
to the appropriate value, as described below:
0 - Logs service start, stop, and error messages to the Error Viewer log.
1 - Logs notifications sent by the service to the Timer/Distribution Service log.
2 - Logs all trace messages that are sent to the Error Viewer log.
When the verboseLevel is set to 2 , each of the steps in connecting to and sending an
email from the SMTP server is logged. These are the same steps one would see when
connecting to the SMTP server using TELNET. Testing the same process using TELNET
can allow you to prove whether a suspected step is the point of failure.
Note: If the Distribution Service sends an email without a specified To address, an SMTP
server error displays on the Errors tab. The SMTP server sends Undeliverable Message
notifications to the From address specified in the message template.

131
Retry indefinitely - The Distribution Service continuously tries to send a

notification if a failure occurs.
OnBase 15
Access to the path...is denied

If you try to manually install or uninstall the Hyland Distribution Service on a server with
Windows User Account Control (UAC) enabled, an Access denied message may be
displayed.
To address this issue, run the Command Prompt as an administrator. Under Start |
Accessories , right-click on Command Prompt and select Run as administrator.
For more information about how the User Account Control can affect OnBase
deployments, see Windows User Account Control Statement on page 135.
Error Loading Document: Attachments Are Not Sent

When the Hyland Distribution Service sends emails with attachments, the body of the
emails may say the following:
ERROR LOADING DOCUMENT: Document Number: [#]
This error may occur because the account running the Hyland Distribution Service lacks
privileges to the document on the OnBase disk group.
To resolve this issue, perform the following steps on the server where the Hyland
Distribution Service is installed.
1. Using a Run dialog box, run services.msc .
To do this, select Start | Run, type services.msc and click OK. The Services console
is displayed.
2. Double-click Hyland Distribution Service from the list of services.
3. Click the Log On tab.
4. Under Log on as, select This account.
5. Type a valid domain user name and password that has access to the OnBase disk
groups. This user account will be used to run the service.
6. Click OK to save your changes and close the properties dialog box.
7. Restart the Hyland Distribution Service.

132
OnBase 15
Messages Are Not Sent
1. Ensure the Hyland.Core.Distribution.NTService.exe.config file is configured

correctly. See Installing the Distribution Service Manually on page 116 for a
description of required settings. After modifying the file, restart the Hyland
Distribution Service in the Services console.
2. Ensure the smtpPort configured in the Hyland Distribution Service configuration
file matches the incoming request port on the SMTP server.
3. If there are any firewalls between the servers running the Hyland Distribution
Service and the SMTP server, open the SMTP port to allow the traffic to pass
through.
4. Verify that the SMTP server will allow for relaying without authentication.
5. Verify that your antivirus software is not configured to block the SMTP port.
Workstation Registration Not Found

When you run the Distribution Service, messages are not sent, and the following error is
logged to the Diagnostics Console: Workstation Registration not found for distribution
server machine .
This error is displayed because required OnBase components such as registry keys and
the onbase32.ini file have not been created on the server running the Distribution
Service.
To resolve this issue, log in to either the OnBase Client or the OnBase Configuration
module from the server that is running the Distribution.
Cannot Create a Session Pool

If the Distribution Service is running but fails to send messages, the following error may
be logged to the Diagnostics Console:
Cannot create a session pool without a data source, user name, and password.
When this error occurs, do the following:
Check the Hyland.Core.Distribution.NTService.exe.config file and ensure the
datasource , username , and password parameters are specified correctly.
Ensure the names of the parameters in the configuration file are spelled
correctly, including case. Parameter names are case sensitive. For example, if
username is spelled as UserName, the parameter is not loaded.
"No Count" Is On
If the Diagnostics Console reveals that notifications are being processed but are not
being sent, you may need to turn off the No Count variable on your SQL Server. Please
contact your solution provider for assistance.

133
Messages may not be sent for multiple reasons. The following are general steps to
troubleshoot the issue. Steps to address specific issues are provided in the following
topics.
OnBase 15
Version Mismatch
If you find that messages are not being sent, you may be using a version of the
Distribution Service that is incompatible with your current version of OnBase. If this is
the case, an error is logged to the Diagnostics Console indicating that there is a
database version mismatch. Ensure the Distribution Service is upgraded to the same
version as the rest of your OnBase solution.
Message Content and Attachments Are Reversed

Some email clients do not properly handle content types for attachments with certain file
formats. As a result, documents with these file formats are sent as the message text
instead of as attachments, and the actual message text is sent as the attachment. If
users receive emails where the message and the attachment are reversed, you may
need to configure the Distribution Service to override the content type for those
attachments file formats.
Note: E-Forms are one example of documents with a file format that may be handled
incorrectly. By default, the Distribution Services configuration file is configured to
override the content type on E-Forms, allowing them to be sent correctly as
attachments.
1. Open Hyland.Core.Distribution.NTService.exe.config.
2. Locate the following element:
<securitySettings datasource="DMS" username="SVCACCT"
password="PASSWORD" >
3. Add a ContentTypeOverride element to override the default content type for the
file format, as shown in the following example. You can add these elements for
each data source the Distribution Service is configured to use.
<securitySettings datasource="DMS" username="SVCACCT"
password="PASSWORD" >

134
OnBase 15
Attribute
Description
fileType
The attachments file format number, as shown in the upper-right corner of

the File Format Configuration dialog box.
For E-Forms, this number is 24. You can specify different file format
numbers to override the content type assigned to other file formats.
mimeType
The generic MIME type to label attachments that have the specified file
format.
Unity Forms Limitations

When Unity Forms are sent using the Distribution Service, section and page
security configured on a Unity Form is not respected. The entire form is sent
regardless of the security settings on the form.
When Unity Forms are sent using the Distribution Service via the right-click
Send to option, page tabs are not displayed in the form. Instead, the forms
pages are displayed laterally.
Windows User Account Control Statement

Hyland Software is dedicated to ensuring that OnBase is compatible with Windows User
Account Control (UAC). UAC is a feature of Windows operating systems that was
introduced with Windows Vista. It limits the ability of standard users to make global
system changes to a workstation and prevents malicious software from making
unauthorized changes to protected areas.
For details on UAC, refer to your Microsoft support information or see http://
technet.microsoft.com/en-us/library/cc709691(WS.10).aspx.
You may encounter UAC in OnBase when:
Installing or uninstalling OnBase, OnBase modules, or OnBase ActiveX controls.
Copying, moving, or saving files to the Program Files directory, Windows
directory, or another protected location.
Modifying system-wide settings, such as the registry.
If Windows UAC is enabled, the above operations may prompt for administrator
privileges or credentials, even if an administrator is currently logged on.

135
<ContentTypeOverride fileType="24" mimeType="application/octetstream" />

</securitySettings>
The above example will override the default behavior for E-Form attachments and
label them with the generic MIME type application/octet-stream. As long as the
attachment name still has the html file extension, email clients should handle the
E-Form documents correctly.
For a description of configurable attributes for the ContentTypeOverride element,
see the following table:
OnBase 15

136
DOCUMENT COMPOSITION BEST PRACTICES
The following best practice recommendations have been assembled by a team of OnBase
subject matter experts. They represent the accumulation of years of experience
installing and configuring OnBase solutions.
The following recommendations are general in nature, and are applicable to most
OnBase solutions and network environments. Depending on your solution design and
your organizations needs, not all of the best practice recommendations listed below may
apply to, or be recommended for, your OnBase solution.
Carefully consider the impact of making any changes, including those listed below, to
your OnBase solution prior to implementing them in a production environment.
Enterprise Document Composition Configuration

Configuring Templates for Use with Enterprise Document
Composition
When configuring a template for use with Enterprise Document Composition:
Avoid gathering critical data through anything that requires user interaction,
such as a User Prompt Placeholder. If the template has User Prompt Placeholders
on it, they will be removed from the document and ignored during Enterprise
Use Keyword Mapping, either by applying the Inherit Keywords from Source
Document when possible template option or by configuring Keyword Mapping for
individual Placeholders.
Installation
Installing Enterprise Document Composition
While it is possible to install the Document Composition Windows Service on the same
workstation as the Application Server, it is not recommended. System resources can be
compromised if you are using Enterprise Document Composition to generate a large
quantity of documents.

137
OnBase 15
Document Composition Best Practices

138
DOCUMENT COMPOSITION TEMPLATE

CONVERTER
The Document Composition Template Converter converts templates created with the
Document Composition for Microsoft Word module to templates that can be used by the
Document Composition module.
After the conversion is complete, the Document Composition for Microsoft Word
templates can still be used in Document Composition for Microsoft Word module.
Before You Begin

Before using the Document Composition Template Converter, ensure that you
understand the following:
You must contact your OnBase solution provider in order to obtain the
Document Composition Template Converter.
Microsoft .NET Framework 4.5.1 must be installed on the workstation that the
Template Converter will be run from.
The Document Composition Template Converter should only be run once.
Running it multiple times creates duplicate templates.
The Document Composition Template Converter should be run by a user with
rights to all templates that need to be converted. This is because the Document
Composition Template Converter only allows you to convert templates that you
have rights to modify.
Known Limitations
Because of architectural differences between the Document Composition for Microsoft
Word and Document Composition modules, modifications to Document Composition
templates are often required after conversion.
Limitations of the Document Composition Template Converter are listed below:
Image fields are converted to Unconfigured Placeholders.
Fragments and Bookmarks are converted to Fragment Placeholders. However,
when selected on the converted template, they do not display as being
configured in the Placeholder Settings pane. After conversion, select the
Placeholder, click Edit Placeholder, and associate the correct fragment.
Any Placeholders in the header or footer are not converted. The converted
template will not contain header or footer fields.

139
Document Composition Template Converter
OnBase 15
Installation and Usage

After obtaining the Document Composition Template Converter from your OnBase
solution provider:
1. Open TemplateConverter.exe.config.
2. Modify the following settings:
Setting Name
Description
ServicePath
Type the name of the Application Server.
DataSource
Type the name of the data source.
DisplayName
Type the name of the service location.

For example, http://[Application Server]/[Virtual Directory]/
service.asmx.
UseNTAuthentication
When set to true, the Document Composition Template Converter is

configured to use Active Directory or LDAP Authentication.
When set to false, the Document Composition Template Converter is
not configured to use Active Directory or LDAP Authentication.
3.
4.
5.
6.
7.
8.
9.
Save and close TemplateConverter.exe.config .

Ensure that all instances of Microsoft Word (winword.exe) are closed.
Double-click TemplateConverter.exe.
Log on using your OnBase user name and password.
The Document Composition Template Converter is displayed.
Click Convert .
The conversion activity is displayed and logged to the ConversionLog.log file. Click
Cancel at any time to cancel conversion.
10. When conversion is complete, click Close to close the Document Composition
Template Converter.
Post-Conversion
When template conversion is complete, it is considered a best practice to review the
converted template.
Tip: Perform the following steps using two separate workstations, or with virtual
machines.
1. Open the original Document Composition for Microsoft Word template in the
OnBase Client.
Note: You can only view Document Composition for Microsoft Word templates using a
pre-OnBase 14 Application Server and OnBase Client.
2. Open the newly created Document Composition template from the Template
Builder.

140
OnBase 15

141
3. Compare the two templates, modifying the newly created Document Composition
template if necessary.
OnBase 15

142

OnBase 15 - Document Composition MRG

Uploaded by

Document Informationclick to expand document informationDocument Composition 15- Manual Reference Guide

Document Informationclick to expand document information

Copyright:

Available Formats

OnBase 15 - Document Composition MRG

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

OnBase 15 - Document Composition MRG

Uploaded by

Copyright:

Available Formats

Document Composition

2015 Hyland Software, Inc. All rights reserved.

Document Name .................................................................. Document Composition

2015 Hyland Software, Inc.

Hyland Software, Inc.

Hyland Software, Inc.

USING THIS MODULE REFERENCE GUIDE (PDF)

referred to another MRG if a referenced function is not specific to this module.

What is in the MRG?

How to Navigate the MRG

In the current document - Searches the document you are viewing.

Hyland Software, Inc.

Example of a cross-reference: What is in the MRG? on page v.

Hyland Software, Inc.

USING THIS MODULE REFERENCE GUIDE (PDF)

USAGE - ONBASE CLIENT

USAGE - ONBASE WEB CLIENT

USAGE - ONBASE UNITY CLIENT

2015 Hyland Software, Inc.

Testing Templates .........................................................................................75

System Interaction ........................................................................................82

2015 Hyland Software, Inc.

Firefox Browser Support .................................................................................... 96

Installing Document Composition ................................................................105

Installing the Template Builder ...................................................................110

2015 Hyland Software, Inc.

CONFIGURING THE DISTRIBUTION SERVICE

DOCUMENT COMPOSITION BEST PRACTICES

2015 Hyland Software, Inc.

DOCUMENT COMPOSITION TEMPLATE CONVERTER

Installation and Usage.................................................................................140

2015 Hyland Software, Inc.

2015 Hyland Software, Inc.

2015 Hyland Software, Inc.

An Enterprise Document Composition license is required for Enterprise Document

2015 Hyland Software, Inc.

USAGE - ONBASE CLIENT

2015 Hyland Software, Inc.

Usage - OnBase Client

Select to view and/or edit the document before importing it into

Select to create an email notification after the document has been

8. Select OK to begin creating the document, or Cancel to exit.

Saves the document.

Starts the document creation process over from the beginning.

Discards the document.

Prints the document.

2015 Hyland Software, Inc.

13. After clicking Accept, the Upload dialog box is displayed:

Usage - OnBase Client

The Keyword Values Document Composition scraped from the line-of-business

2015 Hyland Software, Inc.

Usage - OnBase Client

16. Specify the following on the Compose tab:

Type the email address of the sender.

Type the subject of the email.

Type the body text of the email.

17. Click OK to email the document.

2015 Hyland Software, Inc.