Professional Documents
Culture Documents
Version 12
COPYRIGHT
Information in this document is subject to change without notice. The OnBase Information Management
System 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, or without the expressed written consent
of Hyland Software, Inc. If Hyland Software, Inc. and you have entered into a nondisclosure agreement,
then this document or accompanying materials provided by Hyland Software, Inc. contains certain
information which is confidential information of Hyland Software, Inc. and which may be used or copied
only according to the terms of such nondisclosure agreement. 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, 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.
Attribute Detail
Department/Group Documentation
Revision Number 12
2012 Hyland Software, Inc.
ii
Workflow Table of Contents
EXPOSURE
Overview .........................................................................................................1
Applications .....................................................................................................1
Medical Insurance Payment Processing ........................................................................ 1
Accounts Payable...................................................................................................... 1
Proof of Delivery Audit............................................................................................... 2
Loan Processing........................................................................................................ 2
Electronic Forms ....................................................................................................... 3
Licensing .........................................................................................................3
Workflow Licensing ................................................................................................... 3
Combined Workflow/WorkView Licensing ..................................................................... 4
How Combined Licensing Works ............................................................................ 4
Register the Workstation ........................................................................................... 5
Clearing Excess Registrations ............................................................................... 7
Workstation Cleanup ................................................................................................. 8
View Current Users ................................................................................................... 8
Clean Up ........................................................................................................... 9
Workstation Registration............................................................................................ 9
USAGE
OnBase Client ................................................................................................11
Workflow Document Security.................................................................................... 11
Workflow Inbox Windows ......................................................................................... 12
Workflow Client Life Cycle View .......................................................................... 14
Tree View ................................................................................................... 15
Graphic View ............................................................................................... 15
Workflow Client Documents Window .................................................................... 16
Display Columns in Single Queues .................................................................. 19
Show Combined View ................................................................................... 19
Workflow Client User Interaction Window ............................................................. 20
Workflow Client Work Folder Window ................................................................... 20
Workflow Client Document Viewer ....................................................................... 23
Terminal Session .............................................................................................. 23
Client Menu for Workflow Application ................................................................... 24
Changing the Default Rotation of Pages ............................................................... 24
Restoring the Default Layout .............................................................................. 25
Using the Client Toolbar in Workflow ................................................................... 25
Classic User Interface.............................................................................................. 25
Changing the Layout of the Inbox Windows .......................................................... 25
Right-Click Menu .......................................................................................... 26
Click and Drag Window Positioning ................................................................. 27
Document Count Displayed ................................................................................ 28
Core-Based User Interface ....................................................................................... 28
2012 Hyland Software, Inc.
iii
Table of Contents Workflow
2012 Hyland Software, Inc.
iv
Workflow Table of Contents
DESKTOP WORKFLOW
Workflow Document Security ........................................................................57
Opening Workflow Using the Desktop............................................................57
Workflow Windows........................................................................................58
Arranging Windows ................................................................................................. 58
Click and Drag Window Positioning ...................................................................... 58
Pinning ............................................................................................................ 58
Life Cycle View Window ........................................................................................... 59
Documents Window ................................................................................................ 60
Work Folder Window ............................................................................................... 61
User Interaction Window.......................................................................................... 61
Tasks Window ........................................................................................................ 62
Status Bar ............................................................................................................. 62
Opening Queues ............................................................................................62
Filtering the Documents Window ...................................................................62
Selecting Filters...................................................................................................... 63
Persistent Filter ...................................................................................................... 63
Display Columns in Single Queues............................................................................. 63
Viewing Other Users Documents in Load-Balanced Queues ..........................64
Show All Documents ......................................................................................64
Using Filters with Show All Documents ................................................................. 65
Load Balancing Administration ......................................................................65
Refreshing Windows ......................................................................................68
Documents and Work Folder Windows Toolbar ..............................................68
Determining What Queues a Document Is In.................................................69
Combined View Settings ................................................................................69
Filters in Combined View.......................................................................................... 70
Beginning User Work .....................................................................................71
Entering Documents into a Workflow.............................................................71
Importing Documents.............................................................................................. 72
Creating New Documents......................................................................................... 72
Re-Indexing Documents .......................................................................................... 72
Interaction with E-Forms in Workflow ........................................................................ 72
Keyword Validation in OnBase ............................................................................ 73
Workflow Options ..........................................................................................73
Document Workflow History ..........................................................................74
Workflow Queues.................................................................................................... 75
2012 Hyland Software, Inc.
v
Table of Contents Workflow
WEB WORKFLOW
Workflow Document Security ........................................................................77
Accessing the Workflow Screen .....................................................................77
Opening Workflow From Documents..............................................................78
Defining the Layout .......................................................................................79
Resizing and Pinning the Workflow Window ..................................................79
Restoring the Workflow Window to the Default Settings ...............................79
Adding Documents to Workflow.....................................................................80
Life Cycle View Tab ........................................................................................80
Filtering .........................................................................................................81
Refreshing Queue Counts ..............................................................................83
Graphical View...............................................................................................83
Documents Tab ..............................................................................................84
Show All Documents ......................................................................................86
Combined View Settings ................................................................................87
Show Combined View ....................................................................................88
Filters in Combined View.......................................................................................... 88
Create List Report..........................................................................................89
Create List Report Options ................................................................................. 90
Workflow History...........................................................................................91
Workflow Queues.................................................................................................... 91
Workflow Transactions ............................................................................................ 91
Work Folder Tab ............................................................................................93
Document Viewer ..........................................................................................94
User Interaction Tab......................................................................................95
Performing Ad Hoc Tasks...............................................................................95
Performing Ad Hoc Tasks on Related Documents ......................................................... 96
Entering Documents into a Workflow.............................................................96
Importing Documents.............................................................................................. 97
Creating New Documents......................................................................................... 97
Re-Indexing Documents .......................................................................................... 97
Running System Tasks...................................................................................97
Viewing Other Users Documents in Load Balanced Queues...........................98
Load Balancing Administration ......................................................................99
Understanding Auto-Feed Locks ..................................................................103
Allowing Users to Override the Auto-Feed Documents Setting ......................................104
Closing the Application While a Task is Executing........................................104
2012 Hyland Software, Inc.
vi
Workflow Table of Contents
UNITY WORKFLOW
Workflow Security .......................................................................................117
Opening the Unity Workflow Interface ........................................................117
Life Cycles Pane ....................................................................................................118
Inbox Views Pane ............................................................................................119
All Life Cycles Pane ..........................................................................................119
Process Flow ...................................................................................................121
Inbox Pane ...........................................................................................................122
Filtering the Inbox Pane ....................................................................................125
Display Columns in Single Queues .................................................................125
Related Items Pane................................................................................................126
Portfolios ........................................................................................................127
User Interaction Pane.............................................................................................127
Workflow Tab ..............................................................................................128
Changing the Workflow Layout ....................................................................132
Arranging Panes ....................................................................................................133
Click and Drag Pane Positioning .........................................................................134
Pinning ...........................................................................................................135
Primary Viewer and Secondary Viewer Tabs ........................................................136
Managing User Group Layouts .................................................................................136
2012 Hyland Software, Inc.
vii
Table of Contents Workflow
2012 Hyland Software, Inc.
viii
Workflow Table of Contents
2012 Hyland Software, Inc.
ix
Table of Contents Workflow
Adding ..................................................................................................186
Deleting ................................................................................................186
In the Graphic Configuration Window .............................................................187
Adding ..................................................................................................187
Deleting ................................................................................................187
Configuring Queues................................................................................................187
Standard Tab ..................................................................................................187
Allowing Users to Override the Auto-Feed Documents Setting ...........................193
Understanding Auto-Feed Locks .........................................................................193
Advanced Tab .................................................................................................194
Queue Types ..............................................................................................194
Allocated Percentage Configuration ...........................................................195
By Priority..............................................................................................195
In Order Configuration.............................................................................196
Keyword Based Configuration ...................................................................196
Match Keyword to User Name Configuration ...............................................197
Rule Based Configuration .........................................................................197
Shortest Queue Configuration ...................................................................198
Configure Members .....................................................................................198
Configuring Role Selection........................................................................200
Removing Members.................................................................................201
Removing Users from a User Group Who are Members.................................201
Load Balancing Considerations for Institutional Databases ................................202
Work Folder ...............................................................................................202
Default Template ........................................................................................203
VB Script to Execute on Selected Document ...................................................203
Inbox Refresh Rate .....................................................................................203
Sort Options ...............................................................................................204
Window Titles .............................................................................................204
User Task Order .........................................................................................204
User Privileges ...........................................................................................205
Filters Tab ......................................................................................................207
Use Only Selected Filters .............................................................................207
Assigned Filters ..........................................................................................208
Available Filters ..........................................................................................208
Default Filter ..............................................................................................208
Display Filtered Document Count ..................................................................209
Coverage Tab ..................................................................................................209
Monitoring Tab ................................................................................................209
Queue Watermarks .....................................................................................209
Icon Tab .........................................................................................................210
Workflow Queue Right-Click Menu ......................................................................212
Transitions............................................................................................................212
Transitions in the Graphic Layout .......................................................................212
Adding ......................................................................................................212
2012 Hyland Software, Inc.
x
Workflow Table of Contents
Deleting ....................................................................................................213
Configuring .....................................................................................................213
Transitions in the Tree View ..............................................................................213
Adding ......................................................................................................213
Deleting ....................................................................................................213
Attaching Work to Transitions ............................................................................213
Create a transition task list ..........................................................................214
Rules ...................................................................................................................214
Adding ...........................................................................................................214
Deleting .........................................................................................................215
Configuring .....................................................................................................215
Copy and Paste Rules ..................................................................................216
Rule Right-Click Menu ......................................................................................216
Actions.................................................................................................................217
Adding ...........................................................................................................217
Deleting .........................................................................................................217
Configuring .....................................................................................................217
Copy and Paste Actions ....................................................................................218
Workflow Action Right-Click Menu ......................................................................219
Forms ..................................................................................................................219
Adding ...........................................................................................................219
Configuring .....................................................................................................219
User Forms and the Workflow Property Bag ....................................................220
User Forms in the Core-Based Workflow .........................................................220
Configure...............................................................................................220
Deleting .........................................................................................................221
Notifications..........................................................................................................221
Adding ...........................................................................................................222
Deleting .........................................................................................................222
Configuring .....................................................................................................222
Sending Notifications via System Tasks ...............................................................227
Assign User Rights ..................................................................................227
Assign Document Types ...........................................................................228
Task Lists .............................................................................................................228
Break On ...................................................................................................229
Icon ..........................................................................................................230
Help Text ...................................................................................................230
Assigned Tasks ...........................................................................................231
Adding Load Balancing Work .............................................................................231
Deleting Load Balancing Work ...........................................................................231
Configuring Load Balancing Work .......................................................................231
Adding System Work ........................................................................................231
Deleting Tasks from System Work ......................................................................232
Configuring System Work .................................................................................232
Break On ...................................................................................................232
2012 Hyland Software, Inc.
xi
Table of Contents Workflow
Icon ..........................................................................................................234
Help Text ...................................................................................................234
Assigned Tasks ...........................................................................................234
Adding User Work ............................................................................................234
Deleting Tasks from User Work ..........................................................................235
Configuring User Work ......................................................................................235
Break On ...................................................................................................235
Icon ..........................................................................................................237
Help Text ...................................................................................................237
Assigned Tasks ...........................................................................................237
Create Ad Hoc Tasks ........................................................................................237
Adding an Ad Hoc Task List ...............................................................................237
Adding a Task to the Ad Hoc Task List ................................................................237
Deleting an Ad Hoc Task List .............................................................................238
Deleting a Task from an Ad Hoc Task List ............................................................238
Configuring Ad Hoc Task Lists ............................................................................238
Break On ...................................................................................................238
Icon ..........................................................................................................240
Help Text ...................................................................................................240
Assigned Tasks ...........................................................................................240
Password Protection ....................................................................................240
Creating Shortcuts ......................................................................................241
Workflow Ad Hoc Task Right-Click Menu ..............................................................241
Copy and Paste Task List ..................................................................................242
On Abort Task Lists ..........................................................................................242
Adding On Abort Task Lists ...............................................................................243
Configuring On Abort Task Lists .........................................................................243
Break On ...................................................................................................243
Icon ..........................................................................................................245
Help Text ...................................................................................................245
Assigned Tasks ...........................................................................................245
Adding a Web/API Task ....................................................................................245
Deleting a Web/API Task ..................................................................................246
Configuring Web/API Tasks ...............................................................................246
Break On ...................................................................................................246
Icon ..........................................................................................................248
Help Text ...................................................................................................248
Assigned Tasks ...........................................................................................248
Adding a System Task ......................................................................................249
Deleting a System Task ....................................................................................249
Configuring System Tasks .................................................................................249
Break On ...................................................................................................249
Icon ..........................................................................................................251
Help Text ...................................................................................................251
Assigned Tasks ...........................................................................................251
2012 Hyland Software, Inc.
xii
Workflow Table of Contents
2012 Hyland Software, Inc.
xiii
Table of Contents Workflow
2012 Hyland Software, Inc.
xiv
Workflow Table of Contents
WORKFLOW INSTALLATION
Requirements ..............................................................................................311
Client Module Supported Operating Systems .............................................................311
Operating System Requirements ........................................................................312
Client Retrieval Workstation Hardware Requirements..................................................312
Desktop Supported Operating Systems .....................................................................312
Desktop Requirements ...........................................................................................313
Local Mode Desktop Support ...................................................................................314
Databases Supported .............................................................................................314
Microsoft SQL Server ........................................................................................314
Oracle ............................................................................................................315
Sybase SQL Anywhere ......................................................................................315
Database Client / Server Version Compatibility ..........................................................315
Database/File Servers ......................................................................................316
Third-Party Software Support ..................................................................................316
About Virtual Environments.....................................................................................316
64-Bit Support Statement .......................................................................................317
Windows User Account Control Statement .................................................................317
Modifying Configuration Files .............................................................................318
Licensing ..............................................................................................................318
Pre-Installation ...........................................................................................318
Installation ..................................................................................................318
Sending Notifications using Outlook 2003..................................................................318
Sending Notifications Using the Hyland Distribution Service .........................................318
Sending Notifications Using the Workflow Service.......................................................319
Using the Core-Based OnBase Client Interface ...........................................................319
Application Server Overview....................................................................................319
Defining the Application Server ..........................................................................319
Workflow Web.config Settings .................................................................................320
Viewer Vars ....................................................................................................321
Workflow for the Java Client and the Web.config File ............................................321
Workflow Unity Client Configuration File Settings .......................................322
Command Line Switches and .ini Settings....................................................323
Command Line Switches .........................................................................................323
INI File.................................................................................................................323
Previous File Location/File Name ........................................................................324
Location .........................................................................................................324
INI Considerations in a Citrix and Microsoft Windows Remote Desktop Environment ..325
Editing the INI File ...........................................................................................325
INI File Settings ....................................................................................................326
Backup/Recovery ........................................................................................332
Backup.................................................................................................................332
Configuration ..................................................................................................332
Registry Settings .............................................................................................332
2012 Hyland Software, Inc.
xv
Table of Contents Workflow
2012 Hyland Software, Inc.
xvi
Workflow Table of Contents
2012 Hyland Software, Inc.
xvii
Table of Contents Workflow
2012 Hyland Software, Inc.
xviii
Workflow Table of Contents
2012 Hyland Software, Inc.
xix
Table of Contents Workflow
2012 Hyland Software, Inc.
xx
Workflow Table of Contents
2012 Hyland Software, Inc.
xxi
Table of Contents Workflow
WORD RECORD
Limitations and Requirements .....................................................................673
Procedures for Configuration .......................................................................673
Example ...............................................................................................................673
Example ...............................................................................................................675
Example ...............................................................................................................678
2012 Hyland Software, Inc.
xxii
Workflow Table of Contents
2012 Hyland Software, Inc.
xxiii
Table of Contents Workflow
2012 Hyland Software, Inc.
xxiv
Workflow Table of Contents
2012 Hyland Software, Inc.
xxv
Table of Contents Workflow
2012 Hyland Software, Inc.
xxvi
Workflow Table of Contents
Change privileges to Ad Hoc Tasks, Web/API Tasks and System Tasks ....................833
Assign or revoke privileges to Ad hoc Tasks ....................................................834
Assign Web/API Tasks to a User Group: .........................................................834
Assign or revoke privileges to System Tasks ...................................................834
Assign/revoke System Tasks to/from Document Types .....................................834
Grant Administrative Processing Privileges ..........................................................835
Granting Workflow Log Purging Privileges ............................................................835
Workflow Studio Options .............................................................................835
General ................................................................................................................835
Doctor..................................................................................................................837
Action/Rule Categories ...........................................................................................839
Script Editors ........................................................................................................839
BPMN Color Schemes .............................................................................................840
Customizing Color Schemes ..............................................................................840
Renaming a Customized Scheme .......................................................................841
Deleting a Customized Scheme ..........................................................................841
Exporting a Customized Scheme ........................................................................842
Importing a Customized Theme .........................................................................842
About...................................................................................................................842
Unity Projects ..............................................................................................842
Creating Unity Projects ...........................................................................................843
Unity Project Properties ....................................................................................845
Reference Tab ............................................................................................846
Version Tab ................................................................................................846
Permissions Tab .........................................................................................846
Workflow Search .........................................................................................846
Finding Items in Workflow Studio.............................................................................846
Search Options ................................................................................................847
Workflow Doctor..........................................................................................849
Defining Doctor Options..........................................................................................849
Doctor Results.......................................................................................................849
Exporting Doctor Results ........................................................................................851
Output Tab ..................................................................................................851
Shortcuts .....................................................................................................852
Enabling the Recycle AppPool Button ..........................................................852
Exporting .....................................................................................................852
Exporting Life Cycles ..............................................................................................855
Importing ....................................................................................................859
Resolving Conflicts .................................................................................................862
Using Auto Resolve ................................................................................................866
Saving Resolutions.................................................................................................866
Using the Verification Report ...................................................................................867
2012 Hyland Software, Inc.
xxvii
Table of Contents Workflow
2012 Hyland Software, Inc.
xxviii
Workflow Table of Contents
2012 Hyland Software, Inc.
xxix
Table of Contents Workflow
2012 Hyland Software, Inc.
xxx
Workflow Table of Contents
2012 Hyland Software, Inc.
xxxi
Table of Contents Workflow
2012 Hyland Software, Inc.
xxxii
Workflow Table of Contents
2012 Hyland Software, Inc.
xxxiii
Table of Contents Workflow
2012 Hyland Software, Inc.
xxxiv
Workflow Table of Contents
2012 Hyland Software, Inc.
xxxv
Table of Contents Workflow
2012 Hyland Software, Inc.
xxxvi
EXPOSURE
Overview
The Workflow module is an electronic document routing system that processes work more
efficiently, quickly and accurately than traditional paper processing. Workflow streamlines
business processes and is designed to accommodate change quickly. Documents can enter
Workflow in a variety of ways, including input processors like COLD, DIP, Document Imaging,
and PCL. Documents may also be imported into a Workflow process manually or via an
electronic form completed over the Internet. Configurable rules and actions ensure that
documents are distributed in a standard, controlled manner and that business rules and
practices are followed.
Workflow has the ability to prompt users for input or automatically process documents based
on information such as a keyword, document handle (a unique OnBase ID), or Document
Type. Assigning specific users with rights to modify a documents movement on an ad hoc
basis accommodates exceptions to the configured model. Timers can be employed on queues
to make sure documents continue through the process efficiently. Troubleshooting and queue-
logging tools allow for error-free, secure configurations. Configured workflows can be
exported to disk for backup and recovery purposes or for distribution to another OnBase
system. Workflow is accessible via the Internet when the OnBase Web Server is purchased.
Applications
Medical Insurance Payment Processing
The process begins with a fax, an image, or a text report. Claims documents enter the
Workflow and initiate the process. An initial claim review queue in Workflow checks for
duplicate claims and checks to see what related documents currently exist. Timers trigger
notifications and check on documents that are missing. The claims are then load-balanced as
they are assigned to an adjuster.
The adjuster reviews all the available information, making notes on the document. A fax or e-
mail may be sent to the provider requesting more information. Ultimately, the claim is either
accepted or rejected. Accepted claims then go to the accounts payable queue to be paid and
the rejected claims go to the rejected claims queue where a letter is generated explaining to
the provider the reason the claim has been rejected.
Accounts Payable
It can be cumbersome ensuring that vendors get paid promptly and accurately with a high
volume of invoices flowing into a company daily. An accounts payable clerk needs to find and
review all of the related documentation for an invoice. This may include an initial requisition,
a purchase order, and packing slips. The issue is complicated when a supplier sends you a
billing statement for several purchase orders. Some may contain full shipments and others
partial shipments. All of which make it very difficult to organize and track. A Workflow solution
can streamline and organize the process.
2012 Hyland Software, Inc.
1
Workflow OnBase 12
As invoices and statements enter Workflow, system work checks for related documents. The
requisitions, purchase orders, and packing slips are matched as supporting documentation.
The accounts payable clerk has all the necessary documentation to make a payment decision.
The clerk is alerted to documentation that is incomplete or missing. A task can be executed to
pay the invoice in full or issue a partial payment. A full payment decision can be designed to
trigger payment from the companys accounting system. If a partial payment is issued, a
notification can be sent to the vendor. The notification tells the vendor that a partial payment
is in order and invites them to login to the companys Web Server. Vendors can then
participate in Workflow. They have access to areas and documents that you allow them
access. They can review all the documentation and dispute or approve the partial pay. By
Exposure
involving the vendor directly in the payment process resolution, you can eliminate the need to
send information back and forth.
The resolution and payment of invoices is both quick and accurate for you and your vendors.
Loan Processing
Workflow can be used to monitor the status of loan files and automatically route them to the
appropriate person(s) based upon pre-defined rules and process flows. In addition to
automated routing, users can route documents on an ad hoc basis. Workflow allows
management to analyze the loan production process, plan and test changes to the work
process.
Workflow provides an environment where the tools and documents required to process a loan
are readily available on the desktop. In some cases, Workflow identifies which task the user is
performing and automatically opens documents appropriate for that task.
When a new loan file arrives, it is assigned to an underwriter. The underwriter selects the loan
file and Workflow executes the user work specified for underwriters. For example, a form may
be displayed in which the underwriter enters comments and then selects the appropriate
button, cancel, approve or deny. A rule then tests to determine the underwriters response
and initiates the appropriate transition; to cancel, deny, or to route to the account manager. It
may be necessary to route the document to multiple underwriters for approval before
submission to the account manager. If the underwriter is out that day, a timer, (a monitoring
process running on the Workflow server) automatically reassigns the loan file to another
underwriter.
2012 Hyland Software, Inc.
2
OnBase 12 Workflow
When the loan file makes the transition to the account manager queue, the system work for
the account manager queue initiates and automatically faxes the approval to the broker. The
loan file rests in the queue until the account manager selects it and begins the user work.
When the account manager completes their work, Workflow checks to see if any outstanding
funding conditions remain. If there are no further conditions, Workflow automatically routes
the appropriate documents to funding. Otherwise, the loan file remains in the account
manager queue until all conditions are fulfilled.
Typically, queues are shared by groups of individuals. Many workers can share the same
queue, but each would see only the document files assigned to him or her using a load
balancing queue.
Exposure
Electronic Forms
Workflow is often used in conjunction with Electronic Forms (E-Forms), which can be used for
request processes that require one or more levels of verification. For example, a Human
Resources departments vacation request process may require that one or more managers
sign a vacation request before it is approved. The OnBase Digital Signature module can be
used in conjunction with Workflow and E-Forms to provide a means for electronically signing
documents.
Example applications for E-Forms include:
Requests for Purchase Orders
Departmental work requests. For example, an Information Systems Request can
be filled out by a user who needs assistance from the organizations IS department.
When the E-Form is submitted, an employee is notified. The request can be assigned
a status, enabling the originator to check on the progress of the request at any time.
Office supplies
Software bugs and enhancements
Online questionnaires. Answers are standardized and tabulating the results is a
more streamlined process.
Shipping requests
Licensing
Workflow Licensing
A Workflow license is required to configure life cycles as well as to perform Workflow activity.
Effective January 1, 2007, one of the following licenses is required:
Workflow Concurrent Client SL
Workflow Workstation Client SL
Workflow Named User Client SL
2012 Hyland Software, Inc.
3
Workflow OnBase 12
Check your current licensing status by selecting Utils | Product Licenses from the Configuration
module.
2012 Hyland Software, Inc.
4
OnBase 12 Workflow
1. From the OnBase Client, click Admin | User Management | Workstation Registration. The
Products Registered for Workstation dialog box is displayed.
Exposure
The right side displays all products registered on the selected workstation.
The left side of the screen displays a list of the workstations that have, at any time,
been logged on to OnBase. The current workstation is shown at the top of the list and
marked with an asterisk (*). The columns are as follows:
License(s) Displays the symbols of the products registered for that workstation. The legend
for the symbols is located below the list of workstations.
Registered Displays the name of each workstation that has ever been logged in to OnBase.
Last Logon Displays the date that the workstation was last logged on.
2012 Hyland Software, Inc.
5
Workflow OnBase 12
2. Make sure that the current workstation, denoted by an asterisk (*), is selected. Select
the proper Workstation License from the Products Registered drop-down list.
If you are properly licensed for the Workstation License and it is not available from the
drop-down list, it may be registered on another workstation. Select each workstation
that is marked with a + (which indicates that the workstation is registered for the
Workstation License or another product) until the Workstation License is found. To
revoke registration from the workstation, select the Workstation license on the right
side and click the Revoke button. Then, select the current workstation and register it.
If the Workstation License is not displayed in the drop-down and it is not registered to
any other workstation, it is possible that the module may not be licensed.
Exposure
Note: If a registered workstation needs to be re-registered, the old workstation can be deleted
by selecting it in the workstation list and clicking Delete. All product rights held by the
workstation will be returned to the list of available licenses found in the Products Registered
drop-down. This forces the user logging on from that workstation to register the workstation
the next time they attempt to log on.
2012 Hyland Software, Inc.
6
OnBase 12 Workflow
4. Verify registrationSelect Window | System Status from the menu bar to display the
System Status dialog box. At the bottom of the window is a list of all products
registered on the workstation and a status message for each.
2012 Hyland Software, Inc.
7
Workflow OnBase 12
Any products that are registered in excess of the licensing limit will contain the [Excess
Registration] string. Select the necessary products and click Revoke to remove the excess
registration from the workstation.
Workstation Cleanup
At some point, it may be necessary to delete workstations from the list in the Products
Registered for Workstation dialog box. This may be necessary if there are many workstations
on the list that are no longer accessing OnBase. One method of cleanup is to delete all of
them and allow the list to regenerate as workstations are logged back on to OnBase.
Exposure
Alternatively, you can select the desired workstations and delete them in groups. If
workstations are deleted inadvertently, they will be added back when the workstation is
logged onto OnBase. If the current workstation is selected, an error message is displayed and
it is not removed from the list.
To delete a workstation from the Products Registered for Workstation:
1. From the OnBase Client, click Admin | User Management | Workstation Registration. The
Products Registered for Workstation dialog box is displayed.
2. The left side of the dialog box contains four sortable columns. The Last Logon column
allows the user to delete all workstations that have not been logged on to OnBase
during a specified period of time.
3. Select the desired workstations and click the Delete button.
4. Select Exit when finished.
2012 Hyland Software, Inc.
8
OnBase 12 Workflow
Clean Up
User entries can be removed, or cleaned up, from the Users Currently Logged In dialog box
provided that the user is not trying to remove his or her own session and the session being
cleaned up is not displaying an Active status.
Workstation Registration
The workstation must be registered for any of the workstation licenses issued (Workflow User
- Concurrent or Workflow User- Named).
Exposure
2012 Hyland Software, Inc.
9
Workflow OnBase 12
Exposure
2012 Hyland Software, Inc.
10
USAGE
OnBase Client
Workflow Document Security
Access to documents via Workflow is accomplished by a combination of assignments made at
the Document Type, life cycle, and work queue level. Specifically:
Document Types must be configured for use in a specific life cycle.
In the Configuration module, select Document | Document Types, then select the
desired Document Type and select Life Cycles. Assign the desired life cycles at the
Life Cycles for <document type> dialog box.
Users must be granted rights to a specific life cycle, as well as each queue within
that life cycle, in order to view documents within those queues.
In the Configuration module, select Users | User Groups/Rights. Select the desired
user group and select Workflow. Assign the desired life cycles and queues at the
Assigning Workflow for <user group> dialog box.
In all Workflow interfaces except the Unity Workflow interface, users must be
granted the Retrieve/View privilege, either as a user group privilege or as an
override privilege. If this privilege is not granted (or in the case of override
privileges, overridden), users will not be able to view documents in Workflow. For
more information on configuring user group rights, please see the System
Administration module reference guide or help files.
Caution: The ability to view documents in a life cycle is controlled at the queue level. If users
have rights to a Workflow queue, they will also have rights to view all the documents in that
queue by default, regardless of their security rights (i.e. Document Type rights). This includes
related documents.
Caution: The ability to modify a document in a life cycle is controlled at the queue level. If users
have rights to a Workflow queue, they will also have rights to modify all documents in that queue
by default, regardless of their Modify privilege setting, including related documents.
Administrators should be aware that Workflow automatically grants the Modify privilege to users
for any documents that are in their queue. As a result, care should be taken to only present
documents which users should be allowed to modify.
Note: To view or change Keyword Values or to re-index a document via the right-click menu,
you must have appropriate rights for modifying keywords or re-indexing. The re-index option
is not present in the Java Workflow interface.
2012 Hyland Software, Inc.
11
Workflow OnBase 12
2012 Hyland Software, Inc.
12
OnBase 12 Workflow
The Workflow Inbox displays several main interaction windows. The initial appearance of the
screen varies, depending on how it was set up the last time it was used.
Life Cycle View Displays all life cycles and queues to which the user has access. Depending
on your systems configuration, a number may appear in square brackets
next to a queue. This indicates the number of documents currently in that
queue.
Note: This window is also called the Workflow window in the Workstation
Usage
Options dialog box.
Documents Window Lists the documents that are in the queue selected in the life cycle window.
If there are no documents in the queue, this window will be empty.
Note: This window is also called the Inbox window in the Workstation
Options dialog box.
User Interaction Displays the specific work that must be performed by the user in order to
Window process the selected document. This window displays information only if
user questions, life cycle or queue help text, message boxes, or HTML forms
have been configured.
Note: This window is also called the User Interface window in the
Workstation Options dialog box.
Work Folder Displays all documents in OnBase that are related to the selected inbox
Window document, based on the criteria configured for the folder type.
Note: This window is also called the Folder window in the Workstation
Options dialog box.
Note: A document must be selected in order for the context menu to display
in the Work Folder tab.
Tasks Bar Contains icons for the tasks that the user can select to perform on the
document. Tasks also appear on the Workflow drop-down list to allow for
more space on the desktop.
Note: Specific display options can be set for this window using the options available on the
Workflow Display Options tab of the Workstation Options dialog box. Specifically, the size of this
window is controlled by the Percent Workflow parameter.
Note: When a filter is applied to the inbox and columns are resized, column widths are
retained. The next time the filter is applied to the inbox, the set column widths will be
2012 Hyland Software, Inc.
13
Workflow OnBase 12
reflected.
Options Description
Refresh Enables you to refresh the life cycle without transitioning the document out of the
queue.
Workflow Enables users with Administrative Processing Privileges to view the status of the
Replay life cycle at any given time as well as track a document's progress through the
system.
Create List Creates a report of all documents in that life cycle. The Document Type is SYS List
Report Contents Report.
For a user with administration rights, the user can select to create the report on
either Assigned Documents or All Documents in the selected life cycle. The report will
list each queue and the appropriate list of documents based on the user's rights.
When this right-click option is selected, a dialog box will display prompting you to
select to generate a report based on All Documents or Assigned Documents Only.
Click the appropriate button.
If a user does not have administration rights for all queues, the All Documents
option will only be applicable to queues for which the user has administration rights.
For a user that has no administration rights, only assigned documents in each queue
will be displayed.
Option Description
Create List Creates a report of all documents in that life cycle. The Document Type is SYS List
Report Contents Report.
For a user with administration rights in a load balancing queue, the user can select
to create the report on either Assigned Documents Only or All Documents in the
selected queue.
If the user does not have administration rights, the report will only list assigned
documents.
2012 Hyland Software, Inc.
14
OnBase 12 Workflow
Option Description
Execute Executes the timer work associated with the selected timer.
Timer Work
Auto-Work This option opens the next available document in the queue. Any documents that
are opened by other users will be skipped over to access a document that can be
worked on. This option is disabled if the queue is using auto-feed functionality. If a
queue is configured for auto-feed, this option is only available after Show All
Usage
Documents is selected.
Note: This option is only available when Exclusive Document Viewing is engaged
on the queue.
Show All This option is only available for queue configured with the auto-feed option and
Documents appropriate rights are granted. This option overrides the auto-feed setting and
displays all documents within the queue.
Tree View
When you select User | Workflow, a tree view of the configured life cycles displays in the
upper left window. Click the plus sign preceding the selected life cycle to view the queues
within.
If documents are present in the queue, a numeric label (counter) may appear in the tree view
that indicates the actual document count. In tree view, the count is updated when Refresh is
selected at the queue level, or when documents are manually transitioned in/out of a queue.
Note: As documents are processed in/out of the queue, the counter may need to be refreshed
for an accurate document count.
Select any life cycle. If a description of the life cycle was entered in the Life Cycle Help Text box
during the configuration phase, the text displays in the user interaction window. Right-click to
obtain the life cycle right-click menu.
Graphic View
To display the graphic view, select the life cycle and click the Change View toolbar button. The
graphic view displays in the same window that contained the tree view.
In graphic view, the count is updated whenever documents are processed in/out or
transitioned in/out of the queue.
Turn the background grid on and off by clicking the Grid toolbar button.
Use the Zoom In and Zoom Out buttons to adjust the display.
Select any life cycle. If a description of the life cycle was entered in the Life Cycle Help Text box
during the configuration phase, the text displays in the user interaction window. Right-click to
obtain the life cycle right-click menu.
2012 Hyland Software, Inc.
15
Workflow OnBase 12
Note: If you received an error stating Access Denied. User 'username' is already working with this
document., a user already has the document open in a Workflow queue.
Right-clicking on a document displays a menu with processing options. The options presented
vary slightly depending on whether the document is an image or text file format.
Multiple documents can be selected by holding down the Ctrl key and selecting the desired
documents with the mouse. In the same manner, the Shift key can be used to select a range
of documents.
Note: In the Classic Client interface, you cannot deselect documents with the Ctrl key held
down. In order to deselect documents, release the Ctrl key and click on a document. All
documents will be deselected except the document that you clicked on.
Note: In the Classic Client interface, if you click a link in an E-Form, the link will open in the
Document window.
Note: If you select Send To | Create New Document from the Document Viewer's right-click
menu, the new document created will reside in the same queue as the document that is
displayed in the Document Viewer at that time.
Note: If a keyword in an Auto-Name string is changed via the user interface in a Core-based
workflow, such as when performing an ad hoc task, the Auto-Name string in the Documents
window will automatically update to reflect the change. There are instances, however, when
the Auto-Name string will not refresh automatically. If scripts are being used in a task to
update keywords, the Auto-Name string will not refresh when the keyword is updated. For
more information, please contact your system administrator.
2012 Hyland Software, Inc.
16
OnBase 12 Workflow
Option Description
Keywords Opens the Add / Modify Keywords dialog box to view or modify the document
Keyword Values.
Re-Index Opens the Re-Index Document dialog box to re-index the open document.
Usage
Note: This option is not functional for documents that are signed E-Forms.
History Opens the Document History dialog box, which lists the past actions performed on
the document. By default, the entries are sorted in descending order, with recent
actions listed first.
Cross- Select the appropriate Document Type from this menu option to display the cross-
References references related to the selected document.
Note: Only the Document Types that the current user has appropriate rights to will
be available for selection.
View All Opens the Defined Cross-References dialog box, which lists the cross-references
Cross- that are configured for the selected document.
References
Send To | When properly configured, the system will create a blank e-mail message with the
Mail specified document attached.
Recipient
Send To | Sends selected document(s) to the defined user's internal mailbox. Opens the Send
Internal Mail dialog box.
User
Send To | You will be prompted to enter a page range and whether you want to send the file in
Advanced native format. When properly configured, the system will create a blank e-mail
Mail message with the specified document attached.
Show All Removes the filter and displays a list of all documents.
Show Toggles the combined view on and off. See Show Combined View on page 19 for
Combined more information.
View
Begin User Available when user work has been configured within a queue. When selected, the
Work User Interaction window displays question boxes, message boxes, and HTML forms.
2012 Hyland Software, Inc.
17
Workflow OnBase 12
Option Description
Route Allows you to move a document to any queue connected to the current queue by a
Document transition. This activity bypasses user work associated with the document. This
option is only available to users that are administrators, have the Workflow
Administrative Processing privilege, or have the Ad Hoc Routing user privilege at the
queue level.
Note: When using the Classic Client interface, this option is only available in an auto-
feed queue after a document has been double-clicked.
Usage
Note: This option is only enabled if all of the selected documents are in the same
queue, and the queue has at least one transition.
Workflow Displays the queues that the selected document exists in. A document can only exist
Queues in one queue within a life cycle, but can exist in multiple life cycles.
If multiple documents are selected at once, this option is disabled.
Filter Inbox Allows you to select a pre-configured custom query to apply to the Document
window.
Change Switches the focus of the Document window to the queue specified. The menu
Queue presents a list of queues to which you have rights.
Create List
Report Note: This option is only available if you have been given appropriate rights.
Creates a report of all documents in that queue. The Document Type is SYS List
Contents Report.
This option allows you to report on either the selected document or all documents
listed.
When using the Auto-Feed Documents configuration option, documents will be listed
in the report, even if they are not currently displayed in the inbox.
Upon selection of this option, you will be prompted on whether you want to create
the report for only the selected item. Click Yes to generate the report for the
selected document. Click No to generate the report for all documents. By clicking
Cancel, the report will not be generated.
Note: A List Content Report generated from a Workflow life cycle automatically has a
header and summary information included. If a Filter has been applied to the Inbox,
the Filter name will appear in the title, also. You do not have the option to change
these features, nor can you include a report summary in the report.
Properties The properties of a document display in the Document Information dialog box.
Note: You may have more options available depending on user rights and licensing. You may
also not have all of these options depending on granted user rights.
2012 Hyland Software, Inc.
18
OnBase 12 Workflow
When applying a filter to a single queue, the following is true concerning the display columns
for the filter:
If no display columns have been configured on the filter, the Document Name column
will display.
If display columns have been configured, all configured columns will display.
Usage
The Document window can display the contents of a combination of life cycles and queues. In
order to show the contents of multiple life cycle queues, life cycles and/or queues must be
selected for display. To enable a combined view:
3. Select the check box next to a life cycle to include in the combined view. You can
expand a life cycle by clicking the corresponding plus sign.
4. If you want to include only specific queues from a life cycle, expand the life cycle and
clear the check box(es) next to the queue(s) you do not want to include in the
combined view. If all queues within a life cycle are selected to be shown in the
combined view, the check box for the life cycle is white. If only some of the queues
within a life cycles are selected, the life cycles check box is shaded.
5. Repeat steps 3 and 4 until all of the appropriate life cycles and/or queues are selected.
2012 Hyland Software, Inc.
19
Workflow OnBase 12
6. If you want the default display to show the combined life cycles and/or queues, select
the Show Combined View at Startup check box.
7. Click OK.
Once a combined view has been enabled, it can be toggled on and off at any time. Right-click
on the Document window and select Show Combined View at Startup to toggle the view on or
off. When the view is on, the documents that exist in the life cycles and queues that were
selected in the Workflow Combined View tab will be displayed. The Workflow Queue column will
display the queue in which the listed document resides.
The User Interaction window displays any work that the user must perform while the
document is in the selected queue. To begin user work, select a document in the queue, and
click the Begin User Work button on the Workflow toolbar, right-click the document and select
Begin User Work, or click an ad hoc task on the Tasks Bar or from the Workflow menu.
Note: The Begin User Work button is only enabled if all of the selected documents are in
queues that contain user work.
The User Interaction window appears differently, depending on how the work was configured.
User questions, message boxes and HTML forms are all possible options. Notice that the user
has customized the window sizes and that an HTML form is displayed in the User Interaction
window. The user must complete the user work by typing responses into the appropriate
boxes on the HTML form and then clicking Submit.
Note: If the windows are docked on top of the User Interaction window when user work is
initiated, the focus will automatically switch to the User Interaction and wait for input before
you can continue.
Note: Selecting multiple documents and executing a task will refresh the contents of the Work
Folder for each primary document that is selected. The Work Folder is not updated in real
time. If documents are added to the Work Folder after the primary document has been
displayed in the viewer, but before the task list is resumed, those documents will not be
displayed in the Work Folder, but the newly added documents will be acted upon by the
Workflow logic when the task is executed.
Note: When a Keyword Type that is determining the contents of the Work Folder has a value
that contains an asterisk (*) or question mark (?), the characters are treated as wildcards and
all documents that meet the criteria are returned as related documents.
2012 Hyland Software, Inc.
20
OnBase 12 Workflow
You can perform an Ad Hoc Task on a related document by dragging the document from this
window onto the icon in the Tasks Bar. Ad Hoc tasks are also available from the Workflow
menu.
Note: Use folders to group documents related to the current document, called supporting
documents. These documents may or may not exist in the Workflow and may be of a different
Document Type than the current document in the Workflow.
Caution: User group right restrictions on Document Types do not apply to Document Types
included in the Work Folder window.
Usage
2012 Hyland Software, Inc.
21
Workflow OnBase 12
The following right-click options are available in the Work Folder window:
Option Description
Template Allows you to select a template to apply to filter the work folder.
Note: If a template is applied to the Work Folder window, each Document Type
within the folder is represented with one item listing. The display will not reflect the
number of documents that match the keyword criteria, but rather, will serve as a
reference as to what Document Types are represented in the folder.
Usage
Keywords Opens the Add / Modify Keywords dialog box to view or modify the document
Keyword Values.
Re-Index Opens the Re-Index Document dialog box to re-index the open document.
Note: This option is not available for documents that are signed E-Forms.
History Opens the Document History dialog box, which lists the past actions performed on
the document. By default, the entries are sorted in descending order, with recent
actions listed first.
Display in When selected, the related document will open in the top level window. If multiple
Top-Level documents are selected, the first document in the list is opened in the top-level
Window window.
Note: There is only one top-level window. If a related document is displayed in the
top-level window and another related document is selected to display in the top-level
window, only the last related document selected is displayed.
Send To | When properly configured, the system will create a blank e-mail message with the
Mail specified document attached.
Recipient
Send To | Sends selected document(s) to the defined user's internal mailbox. Opens the Send
Internal Mail dialog box.
User
Send To | You will be prompted to enter a page range and whether you want to send the file in
Advanced native format. When properly configured, the system will create a blank e-mail
Mail message with the specified document attached.
Workflow Displays the queues that the selected document exists in. A document can only exist
Queues in one queue within a life cycle, but can exist in multiple life cycles.
Properties The properties of a Document display in the Document Information dialog box.
Note: You may have more options available depending on user rights and licensing. You may
2012 Hyland Software, Inc.
22
OnBase 12 Workflow
also not have any of these options depending on granted user rights.
Note: When you exit a PDF document in the Document Viewer window, an instance of Adobe
Acrobat will still be running in the Task Manager.
Usage
You can also set defaults for the zoom level and page number to which image documents
open in the viewer. This setting is effective across all life cycles. The option is set by right-
clicking the Workflow toolbar, selecting Defaults | Set Default Page or Set Default Zoom. You
can clear these settings by right-clicking the Workflow toolbar and selecting Defaults | Clear
Default Page or Clear Default Zoom.
You can open any number of viewer windows to facilitate viewing and comparing of multiple
documents. With custom programming, Workflow can be enabled to present the
organizations host system through the Document Viewer window for viewing documents and
data entry. This requires a minimal amount of custom programming to interact with an
organization's unique host system.
When a document is open in the viewer, the status bar displays whether or not the document
is read-only or whether the current user has it checked out. If you hover over the document
status (Read-Only or Checked Out) the name of the user that has the document checked out
currently is displayed.
Terminal Session
The Terminal window is a Reflections emulation window accessing a host system. If your
OnBase system has been configured to interact with a host system, follow these steps to
make a connection:
Note: The Terminal Session button may not be available depending on your configuration.
2012 Hyland Software, Inc.
23
Workflow OnBase 12
If a host system (i.e. mainframe) has been configured to interact with OnBase, you may also
see a terminal window like the one pictured below:
Usage
Note: If the Workflow application is not active, the Tasks bar is used to display System Tasks
that are currently configured and assigned to certain Document Types. System Tasks can be
used in any client application, but will only appear in the Tasks bar when a Document Type
has been assigned System Tasks during configuration.
2012 Hyland Software, Inc.
24
OnBase 12 Workflow
Usage
Using the Client Toolbar in Workflow
When using the Client toolbar in Workflow, document-based actions that are initiated by
toolbar buttons, including running a VBScript, are performed on the document displayed in
the Workflow viewer, regardless of how many documents are selected in the Workflow Inbox.
2012 Hyland Software, Inc.
25
Workflow OnBase 12
Right-Click Menu
Right-click the Workflow toolbar to display menu options. If an option is activated, a check
mark appears in front of the menu item. Restore Default Display is the only item that does not
display a check mark because it performs a function as soon as it is clicked.
Display Show Grippers Displays the window grippers and causes the
Toggle Grippers icon to appear active on
the Workflow toolbar.
Lock Window Positions Locks the current window positions. The lock
icon on the Workflow toolbar appears active.
While locked, the Restore Default Display
option is not available.
2012 Hyland Software, Inc.
26
OnBase 12 Workflow
Defaults The following options are available when viewing an image file:
If you have the second pane displayed, each of these options will be available for
the Primary Pane and Secondary Pane respectively.
Usage
Clear Default Page Clears the default page settings. All images
now open to the first page.
Set Default Zoom Allows you to set a zoom level that remains
constant across documents in a queue.
Zoom an image to a desired setting, right-
click the inbox toolbar and select Defaults |
Set Default Zoom.
Note: For toolbar button identification and descriptions, see Workflow Toolbar on page 33.
2012 Hyland Software, Inc.
27
Workflow OnBase 12
You can also share the docking position of multiple windows in the undocked state
by dragging a window on top of an undocked window.
If the Life Cycle view, Document, Work Folder, or User Interaction windows are
dragged on top of one another, a pop-up box displays, asking if you want to share
docking position.
If you click Yes, the window being moved lies on top and all windows sharing the
same pane are labeled with a tab.
If you click No, the window restores itself to its previous position.
Tip: You can drag Workflow windows outside of the Client module onto your Windows desktop.
Usage
This can be useful, especially if you are using a dual monitor setup. You can double-click on a
window to remove it from the confines of the Client module. You can double-click on it to
restore its position in the Client module.
The layout of the windows is saved automatically upon exiting the system.
2012 Hyland Software, Inc.
28
OnBase 12 Workflow
Right-Click Menu
Right-click the Workflow toolbar to display menu options. If an option is activated, a check
mark appears in front of the menu item. Restore Default Display is the only item that does not
display a check mark because it performs a function as soon as it is clicked.
Usage
Life Cycle View Displays the Life Cycle view.
Display | Restore Default Selecting this option causes a confirmation message box to appear.
Display Select Yes to restore the Workflow Inbox to its default display.
Select No to close the message box without making any changes.
Display | Show Second Pane Opens a second window that displays items from the Workflow
Work Folder window and is the target for Doc Display This/
Related Document actions. If the second window is already
opened, the option will be disabled.
Display | Close Second Pane Closes the second window that displays items from the Workflow
Work Folder window and is the target for Doc Display This/
Related Document actions. If the second window is already
closed, the option will be disabled.
Note: If you have the second pane displayed, each of these options
will be available in the Primary Pane and Secondary Pane
respectively.
Defaults | Set Default Page Allows you to open multi-page image files to the same page each
time an image displays in the viewer. Navigate to the page to
display, right-click the inbox toolbar, and select Defaults | Set
Default Page.
Defaults | Clear Default Clears the default page settings. All images now open to the first
Page page.
Defaults | Set Default Zoom Allows you to set a zoom level that remains constant across
documents in a queue. Zoom an image to a desired setting, right-
click the inbox toolbar and select Defaults | Set Default Zoom.
Defaults | Clear Default Clears the default zoom settings. Images open to their actual size.
Zoom
2012 Hyland Software, Inc.
29
Workflow OnBase 12
Defaults | Set Default Sets the rotation of the page displayed by default. You must set the
Rotation Set Default Page option to the page you want to be auto-rotated
by default. When a page in the document has had a rotation saved
for it (via the Process | Save Rotation) menu, the default rotation
should not be applied.
Default rotation is reset when a Workflow session ends.
Any rotation set via the Set Default Rotation will override any
rotations set via the Save Rotation as Default for Page option.
Usage
Windows can be arranged in many ways. Click and drag the window you want to move and
release the mouse button when the window is positioned appropriately. A gray outline of
where the window will be placed is shown while dragging the window.
You can also stack windows on top of each other to create combined windows that will be
displayed in a tabular format. If you drag one windows title bar on top of the other windows
title bar, they will combine into one window. Tabs will display at the bottom of the combined
window for each window that can be accessed within the combined window.
Note: When windows are stacked in tabular form, clicking on the x button in the upper right
hand corner will close the displayed tab.
Pinning
Windows can be pinned to a specific place or hidden when not in use. If you want to always
see a window, pin it. To pin it, click the pin button in the title bar. If a pin button is not
present, the window cannot be pinned or hidden. The window will always display in the
current position, even if it is obstructing another window. Rearrange the window to the outer
edge of the screen to find a position where the window can be pinned.
When a window is not pinned, the window will be hidden when not in use. In order to access
a hidden window, hover over the tab that corresponds to the appropriate window. The tab
label will correspond to the title displayed in the windows title bar. The window will be
displayed. Window tabs are displayed on the left or right edges of the screen.
2012 Hyland Software, Inc.
30
OnBase 12 Workflow
Usage
You can specify the number of documents you want returned at a time in the Results Per Page
field. Only numbers greater than 0 can be entered.
You can also specify if you want the Previous Results and Next Results buttons to display with
or without text labels. If you want the labels to be displayed on the button, select Show Text
Labels. Otherwise, select No Text Labels.
You can navigate through the document results list using the Previous Results and Next Results
buttons.
2012 Hyland Software, Inc.
31
Workflow OnBase 12
When a filter is applied while using Combined View, the following is true concerning the
display columns. The columns display from left to right.
If no display columns have been configured on the filter:
Icon
Document Name
Workflow Life Cycle
Workflow Queue
Usage
Entry Date
If display columns have been configured on the filter:
All configured columns in user-configured order
Workflow Queue
Queues will be sorted by Entry Date by default. Queues can also be sorted by a defined filter
sort or by clicking a display column to sort by.
Note: If Workflow Queue has been configured as a display column, it will not be added again.
Note: If no filter has been applied, the display columns will be: Document Name, Workflow
Queue, Entry Date.
Note: If a keyword in an Auto-Name string is changed via the user interface in a Core-based
workflow, such as when performing an ad hoc task, the Auto-Name string in the Documents
window will automatically update to reflect the change. There are instances, however, when
the Auto-Name string will not refresh automatically. If scripts are being used in a task to
update keywords, the Auto-Name string will not refresh when the keyword is updated. For
more information, please contact your system administrator.
Shortcut Keys
In some instances, the same keyboard shortcut key may be configured to initiate multiple
actions. When this occurs, shortcut keys are processed in the following order:
task lists
If no matching task list is found, then accelerators configured in Workstation Options
are processed.
If none of the above conditions are met, other areas of the software, such as file
menus, are processed.
Note: In some cases, shortcut keys for Internet Explorer and the OnBase Client may override
the configured Accelerator Key when the Accelerator Key uses the same shortcut key
configuration.
2012 Hyland Software, Inc.
32
OnBase 12 Workflow
Shortcut Description
Usage
Workflow Toolbar
Workflow toolbar icons are active and available for use based on the active window within the
Workflow Inbox that you are using. A description of each icon follows:
Button Description
The Begin User Work button is available if there is user work associated with the
selected document. Select this option to begin processing the document.
Note: This button is only enabled if all of the selected documents are in queues that
contain user work.
The Route Document button displays the Possible Transitions dialog box, which lists
other queues to which the document can be routed.
Note: This button is only enabled if all of the selected documents are in the same queue,
and the queue has at least one transition.
The Save button saves changes made to a document that is opened with another
application, such as Microsoft Word or Excel.
The Filter Inbox button is used to apply a custom query to the Inbox. Filters are
designed during the configuration process, and override the sort columns of the Inbox.
Note: If a Keyword Type that is used as a display column has more than one value for a
document, the document will be listed for each Keyword Value.
Note: This button is disabled if no filters are configured, or if the user currently logged in
does not have rights to the configured filters.
The Change View button can be used to toggle between the life cycle graphic layout and
life cycle tree view.
2012 Hyland Software, Inc.
33
Workflow OnBase 12
Button Description
The Zoom Out button minimizes the graphic layout view until the default size is
restored.
The Grid button displays a grid pattern in the graphic layout view. The grid appears
beneath the queues and transitions to assist in lining up the icons.
Usage
The Toggle Grippers button displays or hides the window grippers. Grippers are used for
rearranging windows.
Note: This button is functional for the Classic Client interface only.
The Lock Windows button prevents the windows from being moved or resized, except
for the split window handle on the document viewer. The Restore Default Display right-
click menu option is unavailable when the windows are locked in position.
Note: This button is functional for the Classic Client interface only.
The Terminal Session button opens a session with a host system if one is configured.
This works only with WRQ Reflection terminal emulator.
Note: The Terminal Session button may not be available depending on your
configuration.
The Display in Separate Window button is provided for use with documents in the Work
Folder. If a Work Folder has been configured for use, enabling allows the selected
document from the Work Folder to be opened in its own viewer, without affecting the
display of the currently selected document in the Inbox. When the button is disabled,
selecting a document from the Work Folder overwrites the currently selected document
in the Inbox (unless the Display Second Pane option has been enabled for the Inbox).
The following buttons are visible when the -WFTRACE command line switch is added to the Client
module command line:
2012 Hyland Software, Inc.
34
OnBase 12 Workflow
Button Description
Classic Interface:
The Trace Window button opens a window that displays a text description of each step
that takes place during the execution of the Workflow. This is useful for troubleshooting
Workflow configurations. Set onbase32.ini file parameter WriteTimeStamp=1 to include
the time the step executes.
In addition, any actions/rules/task lists that have the Enable Debug Breakpoint check
box selected in the Configuration module will cause a message box to display giving
details of the breakpoint.
Usage
Core-based Interface:
When the Trace button is depressed, tracing is activated on the Application Server and
all messages from that client will be logged to the Diagnostic Console. All messages from
all clients logging trace messages to the Application Server will be displayed in the
Diagnostic Console. Thus, if two clients are logging trace messages (have the Trace
button depressed), any Diagnostic Console connected to that Application Server will
display messages from both clients simultaneously.
Note: The Diagnostics Console must be configured to log Workflow trace messages. For
information about configuring the Diagnostics Console, see the Diagnostics Console Help
files.
The Trace to File button enables logging of the activities during execution of a Workflow.
This differs from the Trace Window in that it writes to the WFDEBUG.TXT file, in the
program temp directory specified in Workstation Options.
The Breakpoint Debug button enables break point debugging. Any actions/rules/task
lists that have the Enable Debug Breakpoint check box selected in the Configuration
module will cause a message box to display giving details of the breakpoint.
Note: This button is only available for the Core-based interface. The functionality this
button provides is built into the Trace Window buttons functionality in the Classic Client
interface.
The Step Debug button displays a message box after each rule, action or task
completes. If Enable Debug Breakpoint option is selected during configuration, the
message box displays before the rule, action or task executes. Used for determining the
location of logic problems in a Workflow configuration.
Processing Documents
Documents are processed through a life cycle in several ways, either by the system or the
user. Tasks can be configured to occur manually or automatically.
2012 Hyland Software, Inc.
35
Workflow OnBase 12
System Work
If a queue is configured with system work, that work is automatically executed as soon as the
document enters that queue. This work takes precedence over all other types of configured
work. Rules and actions composing system work are performed by the workstation that
placed the document in the queue. If workflow is taking place on documents as they are being
processed, that workstation is also executing the Workflow activities. If documents are
initiated into Workflow during a commit, then the machine that commits the documents
performs the Workflow activity.
Note: When using the Core-based interface during any import process, documents must be
added to Workflow only during commit. Executing system work on uncommitted documents is
Usage
User Work
Right-clicking a document in the Document window and selecting Begin User Work initiates
user work that has been configured for a queue. This work steps a user through one or more
actions. The remaining right-click options are described in Workflow Client Documents
Window on page 16.
Timer Work
Timer work is configured to initiate tasks at a certain point in time by defining exactly when
and how often the work will execute on the documents in the queue. A client workstation
running with the WFSRVR command line switch to convert it into a Workflow server can be
configured to monitor and execute timers automatically. An administrative user may trigger
timers manually.
Note: Tasks can be executed on multiple documents at the same time. To select consecutive
documents in the Document window, click the first document, hold the Shift key and click the
last document. To select non-consecutive documents in the Document window, hold the Ctrl
key while clicking the documents. The tasks you execute apply to the selected documents.
2012 Hyland Software, Inc.
36
OnBase 12 Workflow
Tasks Bar
The Tasks bar displays ad hoc tasks to which you have been granted user group rights. The
functionality available is dependent on the content of the active Workflow window.
To display/hide the Tasks bar, select Window | Tasks Bar.
Usage
Note: Ad hoc tasks are also available from the Workflow menu.
Tip: Depending on the Windows color scheme you are using on the workstation, you may have
difficulty reading the text of the ad hoc tasks.
Note: If the combined view is used and multiple documents are selected, ad hoc tasks are only
displayed if all of the selected documents are in the same queue.
In addition, the Tasks bar displays System Tasks when the document selected from a
Document Search Results list belongs to a Document Type that is assigned to the System
Task, and the currently logged in user has been granted rights to the System Task. System
Tasks are also available from within processing queues for those documents that have been
indexed.
3. If you want to open the document within a queue, select the appropriate queue and
click Open Queue. The queue will open with the document displayed.
The Workflow Queues dialog box will also list who a document is assigned to if the document is
within a load-balanced queue within the Assigned to Users column. <Restricted> will be
displayed for queues and lifecycles that you do not have the rights and/or privileges to view.
2012 Hyland Software, Inc.
37
Workflow OnBase 12
1. Right-click on the life cycle or queue and select Create List Report.
2. The Create Report dialog box flashes on the screen during processing.
3. The report then displays on the screen. This report is stored in OnBase as a SYS List
Contents Report Document Type.
Note: Typically, not all users have rights to this Document Type. However, this does not
prevent users from creating reports. Once created, the report opens in the viewer. After the
Usage
report is closed, only users with rights to the SYS List Contents Report Document Type can
view the report.
1. Right-click on the queue and select See Other Users Documents. The View Other Users
Documents dialog box displays.
2. Select the appropriate user or role from the Select User list.
Note: If you want to view all of the users documents, select <All>. If you have selected the
Show Assigned To column for LB Queue option, an Assigned To column is displayed showing
who each document is currently assigned to.
2012 Hyland Software, Inc.
38
OnBase 12 Workflow
Note: If <Unassigned> is selected, only documents that are not assigned to a user are
displayed. This option is not supported for the Match Keyword to User Name assignment type.
Note: When the Administrator opens a queue, all documents are displayed. In order to see
only their own documents, select See Other User's Documents and choose Administrator from
the View Other Users Documents dialog box.
Usage
Note: When a load balanced queue is configured as Match Keyword to User Name, the View
Other Users Documents list only includes the names of members assigned to the selected load
balanced queue. The Load Balance Administration dialog box includes all users that have
documents assigned to them, regardless of whether they are members assigned to the
selected load balanced queue.
2012 Hyland Software, Inc.
39
Workflow OnBase 12
3. The Load Balancing Administration dialog box displays. The name of the queue and the
time the document entered the queue is also displayed in the title bar of the dialog
box. Expand the users/groups/roles by double-clicking them to view their contents.
Users/user groups/roles are sorted alphabetically. A <Unassigned> group will always
be displayed. This group will contain any documents that have not been assigned to a
valid user. Logged in users are in bold type.
Note: Users or roles that are configured as members for load balancing queues and have no
documents currently assigned to them will appear in Load Balancing Administration.
Usage
Note: Documents may be assigned to more than one user. Because of this, the total number of
documents in a queue and the sum total number of documents assigned to specific users may
not be equal.
To reassign documents to another user/group/role, click the document name, drag the
document to another user/group, and release the mouse button. The selected
documents are transferred to the intended user/group/role.
To reassign all documents from one user/group/role to another, select the user/group
that is assigned the documents and drag the user/group/role icon over the intended
user/group/role icon and release the mouse button. All documents are transferred
from the originally-assigned user/group/role to the intended user/group/role.
If you are in a queue that is configured as a Match Keyword to User Name queue type,
using this method will remove the current assignment from the user, from which the
document was dragged, and add the new user assignment for the dragged document.
If you want to assign multiple users to a document, press CTRL, click and drag the
document to the new user assignment. When this method is used, the old assignments
are retained and the new assignment is added.
2012 Hyland Software, Inc.
40
OnBase 12 Workflow
Note: Any assignment made in a load balanced queue is not recorded in a documents history.
Keyword changes made in Load Balancing Administration are recorded in a documents
history.
Usage
Select the user affected by the reassignment.
Note: In order to select multiple users to perform the reassign task upon, you must press the
Ctrl or Shift keyboard keys while selecting the user.
2012 Hyland Software, Inc.
41
Workflow OnBase 12
A right-click menu is also accessible at both the queue, user group, and document levels in
the Load Balancing Administration dialog box.
Option Description
Create List Report The information included in the List Report is dependent on the level of
detail selected in the queue. If a queue is selected, the report contains all
documents in that queue. If a user is selected, the report will only include
documents assigned to that user. (Create List Report is disabled when
one or more documents are selected.) The report is saved into the SYS
List Contents Report Document Type.
Usage
Reassign Documents Displays the Reassigning Documents dialog box, allowing the selected
documents to be moved to another user/user group or role in Load
Balancing Administration.
Rebalance Queue level: When Rebalance is initiated at the queue level, the
distribution of documents is equalized across all users/user groups.
User/User Group or role level: When Rebalance is initiated at the user/
user group level, the documents currently assigned to the selected user/
user group or role are redistributed within the queue, according to the
rebalance parameters configured.
Note: This option is not available for Match Keyword to User Name load
balancing queues or if the queue is load balanced by rules and there is no
load balancing work task list on the queue. In addition, if you are using
the Core-based interface, this option is not available when the queue is
load balanced by rules and the load balancing work task list does not
contain any actions, rules or sub task lists.
2012 Hyland Software, Inc.
42
OnBase 12 Workflow
Option Description
Keywords Displays the Add/Modify Keyword dialog box, and allows you to add or
modify document Keyword Values.
Usage
document.
Note: You may have more options available depending on user rights and licensing. You may
also not have any of these options depending on granted user rights.
Note: When a document is added to OnBase, the engine (Core-based or Classic) that is
selected will be used to add the document to Workflow.
Input Processors
If input processors are configured to initiate Workflow, documents will automatically be
entered into life cycles upon processing.
2012 Hyland Software, Inc.
43
Workflow OnBase 12
Importing Documents
Upon importing documents, you can select the Initiate Workflow option to add imported
documents into the life cycle(s) assigned to the Document Type to which the document was
imported. Depending on your configuration, the Initiate Workflow option may not be available
and upon import under this condition, Workflow will automatically be initiated.
Caution: If you are using the Core-based interface, the Application Server must be appropriately
installed and configured in order for the document to be added to Workflow. If the Application
Server is not running, the following message is displayed: The application server is not available.
The document will not be added to workflow. Would you like to continue? Clicking OK imports the
document, but does not add the document to Workflow. Clicking Cancel cancels the import.
Usage
Note: When you select this option in the Awaiting Index scan queue, the document will not be
added to a Workflow queue regardless of whether or not the Initiate Workflow option was
selected.
2012 Hyland Software, Inc.
44
OnBase 12 Workflow
Manual Entry
To feed a document into a life cycle from a Document Search Results list:
Note: If a document has been removed from the life cycle by system work, Execute Workflow
will not open Workflow or display an error message.
Usage
If you have user rights to the life cycle chosen above, the queue containing the
document is selected in the Workflow Inbox and the document is listed in the Workflow
Document window. The document added to the life cycle is shown in the Workflow
Inbox.
If a document or group of documents does not have an associated life cycle, the Add
Document to Workflow dialog box is displayed. If you want all the selected documents
to be added to the same life cycle, select the Apply to All check box. Click Yes to add
the document(s). Click No if you do not want to add the document(s) to the life cycle.
2012 Hyland Software, Inc.
45
Workflow OnBase 12
Usage
Note: If you add a document to a Workflow life cycle for which you do not have rights to the
initial queue, the Unable to open Workflow dialog box is displayed, stating The requested Queue
does not exist or you do not have rights to open it.
If the selected document(s) is/are not assigned to a life cycle, the Cannot Add Document to
Workflow dialog box is displayed. Click Cancel This Document to cancel the Workflow execution
for the current document listed in the dialog box. If multiple documents were selected, you
can cancel the Workflow execution for all the documents by clicking Cancel All Documents.
To import a file from disk into a life cycle:
Note: You do not need user rights to the life cycle to put a document into it; you only need
rights to the life cycle to see the document.
Forms Processing
E-Forms can be opened and completed from the Client module or the Internet (Web Server).
OnBase can also interact with forms software to launch a life cycle when the forms are
completed electronically.
Note: E-Forms enter a Workflow life cycle once, when they are initially submitted as a new
document. Resubmitting or revising a form will not cause the form to re-enter its associated
life cycle. For more information about re-entering document revisions into Workflow, see the
EDM Services documentation.
Document Retention
Documents can be fed into a life cycle through an evaluation process set up in the Document
Retention module.
2012 Hyland Software, Inc.
46
OnBase 12 Workflow
Host Emulation
Documents can enter a Workflow life cycle from a host system using custom programming.
This allows users to enter data as they normally would on a host screen from their data entry
activity. The system captures the information as an indexed document to launch Workflow.
Remote Entry/Internet
Workflow can be initiated from activities conducted over the Internet, including completion of
an electronic form, manual importing of a document, or launching a document from within an
e-mail.
Notifications
Usage
If your system configuration supports this option, Workflow can be accessed through
automated e-mail notifications. When a notification is received, click the link in the
notification to display a logon screen. Logging in will automatically display the appropriate
combination of document, queue, and life cycle that the notification was configured for.
Exiting the Workflow window will log the user out of the system.
Note: The user attempting to access Workflow via e-mail notification must be licensed for
Workflow, with appropriate privileges.
2012 Hyland Software, Inc.
47
Workflow OnBase 12
When a new E-Form is created via an ad hoc task, the E-Form may be created before any
Keyword Values are added to the E-Form by the user. Depending on configuration options,
one of two things will occur:
After the E-Form is created in the system, it will be displayed in the User Interaction
window. Clicking Cancel will close the E-Form without saving any changes made to
the E-Form.
Clicking Cancel will close the E-Form and not create it in the system.
When a submit button is configured on an E-Form and it is not configured using OBBtn_
syntax, the button will function as a cancel button.
Usage
Note: Keyword validation does not apply to currency keywords in the Core. The user must be
familiar with the format used for currency in order to ensure accuracy.
From an open document or the Document Search Results list, right-click and select History.
The Document History dialog box displays the Workflow related actions in the Workflow Queues
and Workflow Transactions tabs.
Note: If a user does not have the Document History product right, this option will not be
available. Workflow history is only available when appropriately licensed and registered for
Workflow.
Workflow Queues
Workflow Transactions
2012 Hyland Software, Inc.
48
OnBase 12 Workflow
The Workflow Transactions tab displays information created by either the SYS - Custom Log
Entry action or by actions, rules, or task list configured with the Log Execution setting. The
following information is available on this tab:
Log Date - date the information was logged.
Log Time - time the information was logged.
Life Cycle - life cycle the transaction occurred in.
Queue - queue the transaction occurred in.
User Name - user responsible for the transaction.
Type - can be action, rule, task list or custom entry.
Usage
Name - name of the action, rule or task list that made the entry.
Message - when the entry was caused by the SYS - Custom Log Entry action, this will
be the message that was specified in the action. If an action, rule, or task list is
disabled, a message displays stating that the item is disabled.
In this dialog box, you can select the Life Cycle, Queue, User name, and Log Date for which you
want entries displayed. You also have the option to select <ALL> from the Life Cycle, Queue,
and User name drop-down lists.
Note: To clear the filter and view all the information in the Workflow related tabs, select <ALL>
from the drop-down lists in the Select Items to View dialog box, clear the Log Date check box,
and click OK.
2012 Hyland Software, Inc.
49
Workflow OnBase 12
The Workflow Display Options tab allows you to customize the appearance of the
Workflow Inbox.
The Workflow Server Queues tab allows you to select timer queues to monitor.
Note: These tabs are visible only if your user group has been granted privileges to the Client
User/Workstation Options.
2012 Hyland Software, Inc.
50
OnBase 12 Workflow
Options Description
Percent Allows you to change the default size of the Workflow windows. The cumulative
allocated percent of all windows must total 100.
Restore Updates the onbase32.ini file with the currently configured Percent settings. (This
Default does not affect the currently displayed Percent values.)
Usage
Display
Note: After changing Percent settings, the windows must also be refreshed in
Workflow, by selecting Display | Restore Default Display from the Workflow
toolbar right-click menu.
Initial Pertains to the default size of the life cycle graphic layout that displays in the life
Graphic cycle view. The higher the number, the larger the graphic layout appears.
Zoom
Graphic Indicates the speed at which the visual update of transitions occurs. The higher the
Update number, the faster the graphic transitions display. The lower the number, the slower
the transition displays.
Refresh tree When selected, the document counter for a queue will be refreshed based on the
counters Refresh Rate configured under User Options. If this option is not selected, the
queue counts will only be refreshed when a user manually refreshes the counts or if
an action that refreshes the queue count, such as a transition, is processed.
Display When selected, the document viewer is divided into two sections. You can specify
second pane whether you want the pane to be split vertically or horizontally by selecting Vertical
split or Horizontal split, respectively.
Note: Vertical split and Horizontal split are disabled when using the Core-based
interface.
2012 Hyland Software, Inc.
51
Workflow OnBase 12
Options Description
Inbox Status This section configures the Workflow Inbox status bar, displayed directly below the
Pane Order Inbox window. Four pane options are available: Queue Name, User Name,
Document Count, and Filter. You can choose any combination and arrangement of
panes. Use the Up and Down buttons to arrange the selected panes. Panes will be
displayed as they are listed (top to bottom) from left to right on the screen. Panes
can be removed or added. To remove a pane, select the pane in the box and click
Remove. To add a pane, select it from the drop-down list and click Add. If no panes
are available for addition, the drop-down list will be disabled. Changes made in this
section will be reflected in the following onbase32.ini setting: StatusPaneOrder.
The size of the panes can be specified in the onbase32.ini settings.
Usage
Auto-Open Select the queue to open automatically upon opening the Workflow Inbox. The
Queue queue names are prefaced with the life cycles to which they belong. If you cannot
read the entire text, hover over the drop-down list and a tooltip will display the
name of the life cycle and queue that is selected.
Use If enabled, this option causes the Workflow filter to remain in effect, when switching
Persistent queues, until the user removes it. If disabled, Workflow filters are removed when
Filters the user changes queues.
If there is not a selected filter or the selected filter cannot be applied to the queue,
the configured default filter is applied, if applicable. Otherwise, the persistent filter
overrides the default filter.
Note: If a queue has the Use only selected filters option selected, and the current
persistent filter is not explicitly configured for the queue, the persistent filter is not
applied to the queue.
Show When selected, the Workflow menu displays in the Client menu bar.
Workflow
Menu
Show When this option is selected, an Assigned To column is added to the inbox when
Assigned To you select See Other Users Documents for a load balancing queue and view
Column for <ALL>. This column displays what user is assigned to the document currently.
LB Queue
Note: If a filter is applied to the inbox, the columns are determined by the columns
configured for the filter and this column will not display.
Note: This setting does not apply to queues configured as Match Keyword to User
Name load balancing type.
Reuse Top- This option relates to the Doc - Display Related Document and Doc - Display This
level Window Document actions. It is used in conjunction with the Use Top Level Window option.
for When this option is enabled with the Use Top Level Window, only one window will
Displaying be used to display documents. If multiple documents are displayed, only the last
Document document will be displayed in the window. When this option is not selected, a new
window is displayed for each document.
2012 Hyland Software, Inc.
52
OnBase 12 Workflow
Options Description
Accelerators Allows you to assign shortcut keys to assist in performing repetitive actions.
Note: The Answer Yes, Answer No, and Answer Cancel accelerators are only
supported for use with the SYS - Prompt User with Question Box action.
Note: The Answer Yes accelerator is also supported for use with the Notify -
Display Message Box action.
Usage
Switch to Life Cycle Window, Switch to Document Window, Switch to User
Interaction Window, Switch to Folder Window, Switch to Document Window,
and Switch to Related Document Viewer allows you to configure shortcut keys to
switch the focus to various windows within the Workflow interface.
Once you have configured accelerators, you must close Workflow and restart it for
accelerators to be available for use.
Configure Displays the Accelerator Key dialog box for mapping the Ctrl, Alt, or Shift keys for
keyboard short cuts.
User
Interface Note: Depending on your configuration, this option may not be enabled.
Allows you to specify what Workflow client interface to use. Selecting Default will
adhere to the interface specified in the Configuration module. Selecting Classic will
use the Classic Client interface. Selecting Core-based uses the Core-based
interface.
Note: This setting overrides the setting configured in the Configuration module.
Note: This tab is only available if you are licensed for Workflow, have the Workflow
Administrative Processing Privileges product right, and the -WFSRVR or the -WFSRVR,C switch
applied to the Client modules shortcut. -WFSRVR,C can only be used to configure and does
not execute timers.
The Workflow Server Queues tab in the Workstation Options dialog box is used for indicating
the queues that need to be monitored for timer work by the Workflow server. Timer work is
not performed automatically until the server is asked to monitor the queue. To open the
Workflow Server Queues tab:
2012 Hyland Software, Inc.
53
Workflow OnBase 12
The first list is titled Workflow Servers. This is a list of Workflow servers. All queues monitored
by the selected Workflow server are listed in the Assigned Queues list.
Note: Queue names are prefaced with the life cycle to which they belong, displayed in
brackets.
The second list is titled Available Workstations. It contains all workstations that have logged on
to the database at least once. When a workstation is selected, the available timer queues are
listed in the Available Queues list. Select any queue that you want to assign for monitoring and
click Assign Queue. You can select multiple queues at one time by holding down either the Ctrl
or Shift keyboard keys. The selected queue(s) will move to the Assigned Queues list and the
Usage
workstation that was selected will become a Workflow Server and will be moved to the
Workflow Servers list. You can unassign a queue at any time by selecting it from the Assigned
Queues list and clicking Remove Queue. When all queues from a Workflow Server are
unassigned, the Workflow Server workstation will be removed from the Workflow Servers list
and will be placed in the Available Workstations list.
Timer work may also be executed manually by users with Administrative Processing Privileges
for Workflow. In this case, the timer does not need to be added to the Workflow Server
Queues. See Timer Work on page 36 for details.
Note: Tasks are suspended while the Workflow Server Queues tab is open. Upon closing this
tab, tasks resume.
This monitor supplies the name of the timer(s) and a countdown to the next inspection, which
is updated every 5 seconds. When the timer is evaluated, the actions, rules and other task
lists are executed.
2012 Hyland Software, Inc.
54
OnBase 12 Workflow
Workflow Log
The Workflow log is a report of the activities in Workflow. The information is contained in
database tables that tracks changes made to documents within Workflow. Privileges to view
this log are limited to the system administrator; however, users may be given authority to
purge all, or a selection, of the log file. Logging can be disabled at the queue level.
Note: The Workflow Log menu option is visible only if your user group has been granted
appropriate rights.
Usage
Note: The time shown on all logs reflects the database server time; not the processing
workstations time.
Purge
Users with permission to purge the entire Workflow log can do so by selecting Admin |
Workflow Log | Purge All Entries. A Confirmation dialog box is displayed. To proceed with the
purge, click Yes. Click No to close the message box and cancel the purge.
Caution: Once you delete information from the Workflow log it is permanently removed from the
database.
A Purged Workflow Log action entry is made in the Transaction Log any time a Purge All Entries
is performed. The log is also automatically saved in the SYS Workflow Logs Document Type.
When the Workflow log is purged, information is also removed from the Workflow Transaction
tab within Document History.
Restricted Purge
A restricted purge enables you to focus purging entries based on one or more specific life
cycles and/or queues, or a document handle or a range of entry dates. To open the Workflow
Log Restricted Purge dialog box, select Admin | Workflow Log | Restricted Purge.
Select the desired settings according to the entries to be purged. When complete, click Purge.
Caution: Once you delete information from the Workflow log it is permanently removed from the
database.
A Confirmation dialog box is displayed. To proceed with the purge, click Yes. Click No to close
the message box and cancel the purge.
A detail entry is made in the Transaction Log that describes what restrictions were placed on
the purge. The log is also automatically saved in the SYS Workflow Logs Document Type.
When the Workflow log is purged, information is also removed from the Workflow Transaction
tab within Document History.
2012 Hyland Software, Inc.
55
Workflow OnBase 12
Usage
2012 Hyland Software, Inc.
56
DESKTOP WORKFLOW
Caution: The ability to view documents in a life cycle is controlled at the queue level. If users
have rights to a Workflow queue, they will also have rights to view all the documents in that
queue by default, regardless of their security rights (i.e. Document Type rights). This includes
related documents.
Caution: The ability to modify a document in a life cycle is controlled at the queue level. If users
have rights to a Workflow queue, they will also have rights to modify all documents in that queue
by default, regardless of their Modify privilege setting, including related documents.
Administrators should be aware that Workflow automatically grants the Modify privilege to users
for any documents that are in their queue. As a result, care should be taken to only present
documents which users should be allowed to modify.
Note: To view or change Keyword Values or to re-index a document via the right-click menu,
you must have appropriate rights for modifying keywords or re-indexing. The re-index option
is not present in the Java Workflow interface.
2012 Hyland Software, Inc.
57
Workflow OnBase 12
On the Desktop task bar icon, right-click and select Workflow. If Workflow is selected from the
Quick Launch drop-down list in the Desktop Options dialog box, double-click the Desktop task
bar icon.
When Workflow is opened, the queue displayed is determined by the following:
If the combined view is set to show by default, the combined view will be shown.
If an auto open queue has be configured, that queue will be selected.
If the last queue accessed was recorded, it will open.
Desktop Workflow
If none of these are true, the first life cycle in the list is selected.
Workflow Windows
Workflow in the Desktop is comprised of windows. Each window has its own specific function.
There are 6 major windows that make up a Workflow interface. These windows are:
Life Cycle View
Documents
Work Folder
Document Viewer
User Interaction
Tasks
Arranging Windows
Click and Drag Window Positioning
Windows can be arranged in many ways. Click and drag the window you want to move and
release the mouse button when the window is positioned appropriately. A gray outline of
where the window will be placed is shown while dragging the window.
You can also stack windows on top of each other to create combined windows that will be
displayed in a tabular format. If you drag one windows title bar on top of the other windows
title bar, they will combine into one window. Tabs will display at the bottom of the combined
window for each window that can be accessed within the combined window.
Pinning
Windows can be pinned to a specific place or hidden when not in use. If you want to always
see a window, pin it. To pin it, click the pin button in the title bar. If a pin button is not
present, the window cannot be pinned or hidden. The window will always display in the
current position, even if it is obstructing another window. Rearrange the window to the outer
edge of the screen to find a position where the window can be pinned.
When a window is not pinned, the window will be hidden when not in use. In order to access
a hidden window, hover over the tab that corresponds to the appropriate window. The tab
label will correspond to the title displayed in the windows title bar. The window will be
displayed. Window tabs are displayed on the left or right edges of the screen.
2012 Hyland Software, Inc.
58
OnBase 12 Workflow
Windows can also be opened or hidden by right-clicking on any dark gray background area or
the status bar and selecting the appropriate window. Likewise, you can restore the default
arrangement of windows by right-clicking on any dark gray background area or the status bar
and selecting Restore Default Display.
Desktop Workflow
To view queues, expand a life cycle by clicking on the corresponding plus sign. Clicking on a
queue will open its contents in the Documents window.
2012 Hyland Software, Inc.
59
Workflow OnBase 12
The Life Cycle View window has two different views: Tree View and Graphical View. The
window defaults to the Tree View. To view a life cycle in Graphical View:
Note: The view you are in when you close Workflow will be the view displayed the next time
you open Workflow. When displaying the combined view by default, the Tree View will be
displayed regardless of the last view you were in.
Documents Window
The Documents window contains all of the documents in the currently selected queue or in the
combined view. When a document is selected, it will open in the viewer. If the document is
opened using an external viewer, a message stating The document is displayed in an external
viewer. is displayed in the Documents window. The following types of files are opened in an
external viewer: .msg, .avi, .wav, and .mov.
2012 Hyland Software, Inc.
60
OnBase 12 Workflow
Multiple documents can be selected at once by holding the Ctrl key down while making
selections. You can select a consecutive group by selecting the first document in the group,
holding down the Shift key, and selecting the last document in the group. You can perform
user work and ad hoc tasks on multiple documents by selecting multiple documents before
performing the action. The right-click menu that is available is described in the Desktop
documentation.
You can perform an ad hoc task on one or multiple documents by right-clicking and dragging
the document(s) from this window onto the icon in the Tasks window.
Desktop Workflow
Any documents that are related to the document(s) selected in the Documents window are
displayed in the Work Folder window.
Note: When a Keyword Type that is determining the contents of the Work Folder has a value
that contains an asterisk (*) or question mark (?), the characters are treated as wildcards and
all documents that meet the criteria are returned as related documents.
If the User Interaction window is closed or not pinned, the window will open when a task is
initiated that requires the user interaction to display in the User Interaction window.
2012 Hyland Software, Inc.
61
Workflow OnBase 12
Tasks Window
The Tasks window contains all ad hoc tasks that are available for a queue. Click the tasks icon
to initiate the ad hoc task. If your configuration allows, you can also initiate user work from
this window.
Status Bar
Desktop Workflow
The Status Bar is located at the bottom of the Desktop Workflow window. It contains
information pertinent to the current Workflow selections. The following information is
displayed in the Status Bar:
Current Queue
User Name of the logged-in user OR the name of the user whose documents are
being displayed in a load-balanced queue
Filter selected
The documents currently being viewed
If any of the names are too long to display completely, you can view the name by hovering
over it in the status bar. A tooltip displays the name in its entirety.
Additionally, a right-click menu is available from the Status Bar that allows you to open and
close windows and restore the default display layout.
Opening Queues
Queues can be opened in one of two ways:
In the Life Cycle View window, expand the appropriate life cycle and select the
appropriate queue.
In the Documents window, right-click and select Change Queue | <life cycle name> |
<queue name>.
2012 Hyland Software, Inc.
62
OnBase 12 Workflow
Selecting Filters
In order to use a filter, you must select the appropriate filter to apply to the Documents
window. To select a filter to apply, right-click in the Documents window and select Filter Inbox
| <name of filter>. If you are using a filter form, the filter form will display in the User
Interaction window. Enter the filter's requirements and submit the form. The documents
matching the filter's requirements are displayed in the Documents window. If a Could not load
filter E-Form message is displayed, the selected filter is unavailable.
Desktop Workflow
Note: Depending on the queues configuration, you may not have the option to filter a queue.
Note: A filter form will only display if the filter has been configured to use a form. Not all filters
need forms.
If Filter Inbox | <No Filter> is selected, a filter is not currently applied to the window.
Note: If a Keyword Type that is used as a display column has more than one value for a
document, the document will be listed for each Keyword Value.
Persistent Filter
If you want to apply the same filter and search requirements when moving from queue to
queue, right-click on the Documents window and select Filter Inbox | Use Persistent Filters. The
Use Persistent Filters option will become enabled. If enabled, this option causes the selected
Workflow filter to remain in effect, when switching queues, until the user disables it. If
disabled, Workflow filters are removed when the user changes queues. To disable the User
Persistent Filters option, right-click on the Current Queue window and select Filter Inbox | Use
Persistent Filters. This option is also accessible by right-clicking in the Life Cycle View window
and selecting Workflow Options.
2012 Hyland Software, Inc.
63
Workflow OnBase 12
Note: If See Other Users Documents is not available, you do not have rights to this
functionality. Contact your system administrator for further information.
Desktop Workflow
Selecting this option displays a screen from which you can choose to view another users
documents. All users who are load-balancing members display.
You can select to view the documents of a particular user, all documents, or documents not
currently assigned to a user. In the case of a Coverage queue, the See Other Users Documents
options will not reflect coverage documents.
When a load balanced queue is configured as Match Keyword to User Name, the View Other
Users Documents list only includes the names of members assigned to the selected load
balanced queue. The Load Balance Administration dialog box includes all users that have
documents assigned to them, regardless of whether they are members assigned to the
selected load balanced queue.
Some users may have rights to override the Auto-Feed setting and view all documents within
the queue. When this right is granted, the user can right-click the queue in the tree view and
select Show All Documents. All documents within the queue will be listed, and a check mark
will display next to the right-click menu option. To turn this off, select Show All Documents
option from the right-click menu again, or select another queue. The check mark will no
longer display. The option must be manually turned on each time it is used, for each queue it
is used with.
2012 Hyland Software, Inc.
64
OnBase 12 Workflow
Note: If a queue has filters assigned to it, additional filters cannot be placed on the queue
after Show All Documents has been selected. The additional filter must be in place before the
option is used.
Desktop Workflow
Load Balancing Administration
You can perform load balancing administration tasks by selecting the appropriate queue,
right-clicking, and selecting Load Balance Administration.
Note: This option is only available if the selected queue is configured as a load-balanced queue
and the logged-in user has appropriate administrative privileges.
Load Balance Administration is displayed in the Life Cycle View window. This dialog box allows
you to perform load balancing.
Note: To return to the original view of the Life Cycle View window, right-click and select Close.
A right-click menu is available at the queue, user/user group, and document levels.
2012 Hyland Software, Inc.
65
Workflow OnBase 12
Option Description
Keywords Displays the Add/Modify Keyword dialog box, and allows you to add or modify
document Keyword Values.
Desktop Workflow
Properties Displays the Document Information for Document Handle <nnn> window. This
window displays certain attributes stored for the document, some of which reflect
data stored in the database tables for that document.
Note: You may have more options available depending on user rights and licensing. You may
also not have any of these options depending on granted user rights.
Note: When modifying Keyword Values with the right-click menu, the documents Auto-Name
string will not update.
2012 Hyland Software, Inc.
66
OnBase 12 Workflow
These options are available at the queue, user/user group, and document levels:
Option Description
Reassign Displays the Reassign Documents dialog box, allowing the selected documents to
Documents be assigned to another User/User Group or role in Load Balance Administration.
Desktop Workflow
You can also reassign documents by clicking and dragging the document under the
appropriate user/User Group.
In the Desktop, you can reassign all documents from one user/User Group or role to
another. Select the user/User Group or role that is assigned the documents, drag
the user/User Group or role icon over the intended user/User Group or role icon,
and release the mouse button.
2012 Hyland Software, Inc.
67
Workflow OnBase 12
Option Description
Rebalance Queue level: When Rebalance is initiated at the queue level, the documents are re-
distributed according to the load-balancing logic.
User/User Group or role level: When Rebalance is initiated at the user/user group
or role level, the documents currently assigned to the selected user/user group or
role are redistributed within the queue, according to the load balancing parameters
configured.
Desktop Workflow
If no items are selected, or the root item is selected then the whole queue is
rebalanced.
To see the results of a rebalance, refresh the screen.
You can initiate rebalancing of documents by dragging one or more documents to
the root of the queue.
Note: When the rebalance function is initiated, existing assignments are cleared and
new assignments are made based on the load-balancing queues configuration.
Refresh Refreshes the display of documents in the queue, without transitioning documents
out of the queue.
Close Closes Load Balancing Administration and returns the window to the life cycles view.
Refreshing Windows
The information displayed in the Life Cycle View, Documents, and Work Folder windows can be
updated by right-clicking in the window and selecting Refresh.
Previous Results - If the entire search results list cannot be viewed in the window, clicking
Previous Results displays the prior set of documents from the search results list.
Next Results - If the entire search results list cannot be viewed in the window, clicking Next
Results displays subsequent documents in the list.
2012 Hyland Software, Inc.
68
OnBase 12 Workflow
Options - Opens the Options dialog box, which controls aspects of the search results list.
Desktop Workflow
Results Per Page determines the maximum number of documents displayed in the search
results list. The new setting takes effect the next time the list is loaded. Enable or disable the
text labels for toolbar options by selecting Show Text Labels or No Text Labels from the drop-
down select list.
To view a documents queues, select a document, right-click, and select Workflow | Workflow
Queues. The Workflow Locations dialog box is displayed. All of the life cycles, queues that the
document belongs to, and users/user groups or roles assigned to the document are listed.
<Restricted> will be displayed for queues and life cycles that you do not have the rights and/
or privileges to view.
2012 Hyland Software, Inc.
69
Workflow OnBase 12
1. In the Life Cycle View window, right-click and select Combined View Settings. The
Combined View Settings dialog box is displayed.
Desktop Workflow
2. Select the check boxes that correspond with the appropriate life cycles or queues.
Expand a life cycle by clicking on the plus sign in order to access queues for selection.
3. If you want the combined view to be displayed by default the next time Workflow is
accessed from the Desktop, select the Show Combined View check box.
Once queues have been selected for the combined view, you can select to view the combined
queues by right-clicking in the Documents window and selecting Show Combined View. When
the combined view is enabled, a check mark is placed next to this right-click option. To turn
off this view, right-click on the Documents window and select Show Combined View. The
queues included in the view are listed in the User Interaction window.
Note: A count of the documents in the queue will not be shown in the status bar when using
the Combined View.
2012 Hyland Software, Inc.
70
OnBase 12 Workflow
When a filter is applied while using Combined View, the following is true concerning the
display columns. The columns display from left to right.
If no display columns have been configured on the filter:
Icon
Document Name
Desktop Workflow
Workflow Life Cycle
Workflow Queue
Entry Date
If display columns have been configured on the filter:
All configured columns in user-configured order
Workflow Queue
Queues will be sorted by Entry Date by default. Queues can also be sorted by a defined filter
sort or by clicking a display column to sort by.
Note: If Workflow Queue has been configured as a display column, it will not be added again.
Note: If no filter has been applied, the display columns will be: Document Name, Workflow
Queue, Entry Date.
2012 Hyland Software, Inc.
71
Workflow OnBase 12
Importing Documents
Upon importing documents, you can select the Initiate Workflow check box to add imported
documents into the life cycle(s) assigned to the Document Type to which the document was
imported. Depending on your configuration, the Initiate Workflow check box may not be
available. Upon importing documents, Workflow will automatically be initiated.
Upon creating a new document from an existing document through Send To | Create New
Document, you can select Add To Workflow in the Archive Documents dialog box to add created
documents into the life cycle(s) assigned to the Document Type to which the document was
created. Depending on your configuration, the Add To Workflow check box may not be
available. Upon creating a new document, Workflow will automatically be initiated.
Re-Indexing Documents
Upon re-indexing documents, you can select the Add To Workflow check box to add the
documents into the life cycle(s) assigned to the Document Type to which the document was
re-indexed.
Depending on your configuration, the Add To Workflow check box may not be available. Upon
re-indexing documents, Workflow will automatically be initiated regardless of whether you
modified the documents Keyword Values or Document Type. When Workflow is automatically
initiated, its behavior is dependent upon how you re-index the document:
If you only modify Keyword Values, system work is not performed.
If you modify the Document Type and the new Document Type is assigned to a life
cycle, the document is added to that life cycle and system work is performed.
If you modify the Document Type of a document currently in a life cycle and the new
Document Type is assigned to a different life cycle, the document remains in the
current life cycle and is added to the life cycle assigned to the new Document Type.
System work is performed for the re-indexed Document Type in the new life cycle.
2012 Hyland Software, Inc.
72
OnBase 12 Workflow
Note: Keyword validation does not apply to currency keywords in the Core. The user must be
familiar with the format used for currency in order to ensure accuracy.
Desktop Workflow
Workflow Options
Workflow options can be configured in the Workflow Options dialog box.
To open Workflow Options from the Life Cycle View window, right-click and select Workflow
Options. The following options are available:
Option Description
Use Persistent Filters If enabled, this option causes the Workflow filter
to remain in effect, when switching queues, until
the user removes it. If disabled, Workflow filters
are removed when the user changes queues.
2012 Hyland Software, Inc.
73
Workflow OnBase 12
Option Description
Open Related Documents in Separate When this option is selected, a new viewer
Window window is opened for accessed related
documents. If this option is not selected, related
documents will be opened in the viewer, taking
the place of the primary document.
User Work Style - Task Button When this option is selected, a Begin User Work
button is displayed in the Tasks window that
initiates user work when it is clicked.
User Work Style - Menu Option When this option is selected, a Begin User Work
right-click option is available in the Documents
window that initiates user work when it is
selected.
User Work Style - Both When this option is selected, both the Begin User
Work button and right-click option are available.
Filter Inbox Style - Queue Inbox Pane When this option is selected, the Filter Inbox
right-click option is available in the Documents
window.
Filter Inbox Style - Lifecycle Pane When this option is selected, the Filter Inbox
right-click option is available in the Life Cycle
View window.
Filter Inbox Style - Both Panes When this option is selected, the Filter Inbox
right-click option is available in both the
Documents and Life Cycle View windows.
Filter Inbox Style - Hidden When this option is selected, the Filter Inbox
right-click option is not available in any window.
2012 Hyland Software, Inc.
74
OnBase 12 Workflow
From an open document or the Document Search Results list, right-click and select History.
The Document History dialog box displays the Workflow related actions in the Workflow Queues
and Workflow Transactions tabs.
Note: If a user does not have the Document History product right, this option will not be
available. Workflow history is only available when appropriately licensed and registered for
Workflow.
Desktop Workflow
Workflow Queues
Workflow Transactions
The Workflow Transactions tab displays information created by either the SYS - Custom Log
Entry action or by actions, rules, or task list configured with the Log Execution setting. The
following information is available on this tab:
Log Date and Time - date and time the information was logged.
Life cycle - life cycle transaction occurred in.
Queue - queue transaction occurred in.
User Name - user responsible for the transaction.
Type - can be Action, Rule, Task List or Custom Entry.
Name - name of the action, rule or task list that made the entry.
Message - when the entry was caused by the SYS Custom Log Entry action, this
will be the message that was specified in the action. If an action, rule, or task list is
disabled, a message displays stating that the item is disabled.
2012 Hyland Software, Inc.
75
Workflow OnBase 12
You can filter the information displayed in the Workflow-related tabs by right-clicking in either
tab and selecting Filter Items. The Select Items to View dialog box displays.
Desktop Workflow
In this dialog box, you can select the Life Cycle, Queue, User name, and Log Date for which you
want entries displayed. You also have the option to select <ALL> from the Life Cycle, Queue,
and User name drop-down lists.
Note: To clear the filter and view all the information in the Workflow related tabs, select
<ALL> from the drop-down lists in the Select Items to View dialog box, clear the Log Date
check box, and click OK.
Closing Workflow
To close Workflow, click the X button in the top right-hand corner of the screen or press ALT +
F4 on the keyboard.
2012 Hyland Software, Inc.
76
WEB WORKFLOW
Caution: The ability to view documents in a life cycle is controlled at the queue level. If users
have rights to a Workflow queue, they will also have rights to view all the documents in that
queue by default, regardless of their security rights (i.e. Document Type rights). This includes
related documents.
Caution: The ability to modify a document in a life cycle is controlled at the queue level. If users
have rights to a Workflow queue, they will also have rights to modify all documents in that queue
by default, regardless of their Modify privilege setting, including related documents.
Administrators should be aware that Workflow automatically grants the Modify privilege to users
for any documents that are in their queue. As a result, care should be taken to only present
documents which users should be allowed to modify.
Note: To view or change Keyword Values or to re-index a document via the right-click menu,
you must have appropriate rights for modifying keywords or re-indexing. The re-index option
is not present in the Java Workflow interface.
2012 Hyland Software, Inc.
77
Workflow OnBase 12
If the Workflow button is not displayed on your Web Server, you do not have access to
Workflow. Contact your System Administrator for further information.
The Workflow interface can also be directly accessed. To directly access Workflow:
1. Open a browser and enter the path to the WFLogin.aspx page. In a typical installation,
the path will be http://[machinename]/AppNet/Workflow/WFLogin.aspx, where
[machinename] is the name of the server.
2. Type your OnBase user name and password.
3. Click Login. The Workflow interface is displayed upon successful login.
Web Workflow
1. From an open document, the Document Search Results list, or a folder, right-click the
document and select Workflow | Open Workflow. The Workflow screen with the queue
containing the open or selected document displays. If the document does not exist in a
life cycle, the option is disabled. If an instance of Workflow is already open, the current
Workflow screen will display the selected document.
Note: When viewing an OLE document or PDF document that has been assigned to a life cycle,
Workflow can be opened by selecting Process | Workflow | Open Workflow.
2. If the associated Document Type is configured for multiple life cycles, you are
prompted to select a life cycle. After you select a life cycle, the queue containing the
open or selected document displays. If an instance of Workflow is already open, the
current Workflow screen will display the selected document.
If Workflow is currently executing a task that has not completed and the Open Workflow
option is selected, the following message is displayed:
ATTENTION: You are currently executing a Workflow task that has not completed. Press CANCEL to
complete your Workflow task. Failure to do so will cause the task to terminate before completed.
Press OK to continue, or Cancel to stay on the current page.
Note: Open Workflow is not available when right-clicking an image document in the Document
Search Results list.
Note: When viewing an OLE document or PDF document that has been assigned to a life cycle,
Workflow can be executed on the document by selecting Process | Workflow | Execute
Workflow.
Additionally, the Workflow Queues option is available from the Documents tab in Workflow.
To view a documents queues, select a document, right-click, and select Workflow | Workflow
Queues. The Workflow Locations dialog box is displayed. All of the life cycles, queues that the
document belongs to, and users/user groups or roles assigned to the document are listed.
<Restricted> will be displayed for queues and life cycles that you do not have the rights and/
or privileges to view.
2012 Hyland Software, Inc.
78
OnBase 12 Workflow
Web Workflow
When the Workflow Layout Options button is clicked, these options are available: Horizontal
Layout, Vertical Layout, or Separate Viewer Layout.
When the Horizontal Layout option is selected, the layout displays the document viewer
horizontally spanning the Workflow interface.
When the Vertical Layout option is selected, the layout displays the document viewer vertically
spanning the Workflow interface.
When the Separate Viewer Layout option is selected, the layout displays the document viewer
in a separate window from the Workflow interface.
When the window is pinned, the window will open in the same location on the screen.
Likewise, you can unpin the window by clicking Unpin Window Location.
2012 Hyland Software, Inc.
79
Workflow OnBase 12
Note: Any time the Workflow window settings are changed, the Workflow User Interface option
is available.
If the Document Type assigned to the open or selected document has been configured for
Workflow, you can add the document to the initial queue of the configured Workflow.
1. From an open document or the Document Search Results list, right-click the document
and select Workflow | Execute Workflow.
2. If the document is configured for one life cycle, Workflow launches automatically.
If the associated Document Type is configured for multiple life cycles, you are
prompted to select a life cycle and click OK. A message stating Document was
successfully assigned to life cycle name is displayed.
All life cycles and their queues, to which the currently logged in user has rights, are displayed
in this tab. Single-click a life cycle to select it; double-click it to select and expand it. Use the
+ (plus) and - (minus) buttons to expand or collapse a life cycle without actually selecting it.
Once you have selected a queue, it will open in the Documents tab and the documents within
the queue are listed.
2012 Hyland Software, Inc.
80
OnBase 12 Workflow
The following options are available when right-clicking on a queue in the Life Cycle View Tab:
Refresh - Will refresh the selected queues document count. Only available when
queue counts are turned on.
Generate List Report - For more information, see Create List Report on page 89.
Perform System Work - Initiates system work configured for the queue to begin.
Execute Timer Work - Executes the timer work associated with the selected timer.
Auto-Work - Selecting Auto-Work will display the next available document in a
queue. Users can still select a document from a queue manually.
Web Workflow
Note: Auto-Work is only available on Exclusive Viewing queues that have not been configured
for Auto-Feed.
When a life cycle or queue is selected, the Graphical View button is available for selection.
Filtering
Depending on your configuration, you may be able to filter queues to display a specific subset
of documents within the selected queue.
To filter a queue:
2012 Hyland Software, Inc.
81
Workflow OnBase 12
4. Select the appropriate filter. The Documents tab will display the documents that match
the filter criteria within the selected queue. In some instances, an HTML form will
display in the User Interaction tab when a filter is initiated. Enter your filter criteria and
submit the form to filter the queue. Only one filter may be used at a time.
Note: If the number of characters entered in a field within an HTML form filter exceeds the
allowed number of characters for a keyword value, an error will be returned and no
documents will be displayed in the inbox.
Note: The filtered number of documents will only be displayed if the Display Filtered Document
Count setting is checked on the queues Filter tab. Otherwise, the unfiltered number will be
displayed, even if the queue is currently being filtered.
Note: If a Keyword Type that is used as a display column has more than one value for a
document, the document will be listed for each Keyword Value.
When a filter is applied, you can size columns and the column sizing settings are retained for
the next time you access the queue with the same filter applied.
2012 Hyland Software, Inc.
82
OnBase 12 Workflow
Web Workflow
Note: This button is not available if queue counts are not enabled.
Graphical View
Note: Graphical View is not supported in the standard Non-ActiveX Web Client.
The Graphical View button allows you to view the configured graphical layout for the selected
life cycle.
Note: Graphical View is not enabled until a life cycle or queue is selected.
2012 Hyland Software, Inc.
83
Workflow OnBase 12
When clicked, the configured graphical layout opens in a new window. The window displays
the queues, icons, and transitions configured for the selected life cycle. Example:
Web Workflow
If you select a queue in the graphical view, it will highlight in red and the documents within
the queue will display in the Documents tab. To update this view after performing work, right-
click in the window and select Refresh. You can magnify or shrink the view by right-clicking
and selecting Zoom In or Zoom Out. You can restore the view back to its original size by right-
clicking and selecting Actual Size.
Documents Tab
Documents within the selected queue are displayed in the Documents tab.
2012 Hyland Software, Inc.
84
OnBase 12 Workflow
You can click a document to select it and display a list of its related documents or perform an
ad hoc task on a document. The Documents tab displays the life cycle and queue (up to 95
characters) in which the documents reside. If the names of the life cycle and queue exceed 95
characters, the queue name is displayed.
Note: If Exclusive Document Viewing has been enabled, attempting to open a document
another user has opened will result in a Access Denied--[User Name]--is already working with
this document message.
Web Workflow
The following right-click options are available when a document is selected in the Documents
tab and the appropriate rights have been granted:
Keywords: Opens the Add / Modify Keywords dialog box to view or modify the
document Keyword Values.
History: Opens the Document History dialog box, which lists the past actions
performed on the document. By default, the entries are sorted in descending order,
with recent actions listed first.
Print: Displays the Print dialog box and sends the selected document(s) to a user-
specified print queue.
Send To | Mail Recipient: When properly configured, the system will create a blank e-
mail message with the specified document attached.
Send To | File: Saves selected document(s) as a TIFF file in a user-specified
directory.
Send To | Create New Document: Select to create a new document from the current
one, specifying Page Range, Document Type, Document Date, and Keywords as
needed. Available for indexed documents only.
Send To | Internal User: Sends selected document(s) to the defined user's internal
mailbox. Opens the Send Mail dialog box.
Send To| Folder: Adds the selected document(s) to a static folder.
Workflow | Workflow Queues: Displays the queues that the selected document exists
in. A document can only exist in one queue within a life cycle, but can exist in
multiple life cycles.
Note: You may have more options available depending on user rights and licensing. You may
also not have any of these options depending on granted user rights.
2012 Hyland Software, Inc.
85
Workflow OnBase 12
Note: This option is only available if you have been given appropriate rights.
Previous Results - If entire search results list cannot be viewed in the window, clicking Previous
Results displays the prior set of documents from the search results list.
Next Results - If the entire search results list cannot be viewed in the window, clicking Next
Results displays subsequent documents in the list.
Options - Click to open the Options dialog box, which controls aspects of the search results
list.
Results Per Page determines the maximum number of documents displayed in the search
results list. The new setting takes effect the next time the list is loaded. Enable or disable the
text labels for toolbar options by selecting Show Text Labels or No Text Labels from the drop-
down list.
Some users may have rights to override the auto-feed setting and view all documents within
the queue. When this right is granted, the user can right-click the Documents tab and select
Show All Documents. All documents within the queue will be listed.
2012 Hyland Software, Inc.
86
OnBase 12 Workflow
1. Right-click in the Documents tab and select Combined View Settings. The Workflow -
Combined View Settings dialog box is displayed.
Web Workflow
2012 Hyland Software, Inc.
87
Workflow OnBase 12
3. Repeat step 2 until all appropriate life cycles and queues are added.
4. Click OK.
View again.
Note: Applying a filter to combined view windows will filter documents in the entire view.
Note: If Show Combined View is selected and no queues have been configured for combined
view, the filter inbox icon will be disabled.
When a filter is applied while using Combined View, the following is true concerning the
display columns. The columns display from left to right.
If no display columns have been configured on the filter:
Icon
Document Name
Workflow Life Cycle
Workflow Queue
Entry Date
If display columns have been configured on the filter:
All configured columns in user-configured order
Workflow Queue
Queues will be sorted by Entry Date by default. Queues can also be sorted by a defined filter
sort or by clicking a display column to sort by.
Note: If Workflow Queue has been configured as a display column, it will not be added again.
Note: If no filter has been applied, the display columns will be: Document Name, Workflow
Queue, Entry Date.
2012 Hyland Software, Inc.
88
OnBase 12 Workflow
Note: This option is only available if you have been given appropriate rights.
Web Workflow
1. In the Documents tab, right-click and select Create List Report. The List Report Options
dialog box is displayed.
2012 Hyland Software, Inc.
89
Workflow OnBase 12
1. Right-click on the queue and select Generate List Report. The List Report Options dialog
box is displayed.
Web Workflow
Option Description
Generate Page Headers Includes the date and time of the report and the user that created
the report.
Generate Summary Info Includes the number of documents in the report and the time it
took to process the report.
2012 Hyland Software, Inc.
90
OnBase 12 Workflow
Option Description
Report Summary This fields allows you to enter information that will be included in
the report.
Reports generated are stored in the SYS List Contents Report Document Type.
Workflow History
Web Workflow
From an open document or the Document Search Results list, right-click and select History.
The Document History dialog box displays the Workflow related actions in the Workflow Queues
and Workflow Transactions tabs.
Note: If a user does not have the Document History product right, this option will not be
available. Workflow history is only available when appropriately licensed and registered for
Workflow.
Workflow Queues
Workflow Transactions
The Workflow Transactions tab displays information created by either the SYS - Custom Log
Entry action or by actions, rules, or task lists configured with the Log Execution setting. This
tab also displays information related to ownership.
The following information is available on this tab:
Log Date and Log Time: date and time the information was logged.
Life Cycle: life cycle the transaction occurred in.
Queue: queue the transaction occurred in.
User Name: user responsible for the transaction.
Type: can be action, rule, task list, custom entry, or ownership.
Name: name of the action, rule, task list, or ownership change that made the entry.
2012 Hyland Software, Inc.
91
Workflow OnBase 12
Message: when the entry was caused by the SYS - Custom Log Entry action, this will
be the message that was specified in the action. If an action, rule, or task list is
disabled, a message displays stating that the item is disabled. Ownership change
information is also displayed in this column.
Filtering Workflow Tabs
You can filter the information displayed in the Workflow-related tabs by right-clicking in either
tab and selecting Filter Items. The Select Items to View dialog box displays.
Web Workflow
In this dialog box, you can select the Life Cycle, Queue, User name, and Log Date for which you
want entries displayed. You also have the option to select <ALL> from the Life Cycle, Queue,
and User name drop-down lists.
Note: To clear the filter and view all the information in the Workflow related tabs, select
<ALL> from the drop-down lists in the Select Items to View dialog box, clear the Log Date
check box, and click OK.
2012 Hyland Software, Inc.
92
OnBase 12 Workflow
Web Workflow
To open a related document, click on it. It will open in the Document Viewer
Note: A document must be selected in order for the context menu to display in the Work
Folder tab.
When the Work Folder tab is selected, the Display in Separate Window button and the Show
Second Panel/Close Second Panel button are available for selection in the toolbar.
Display in Separate Window Button
Deselected
Selected
2012 Hyland Software, Inc.
93
Workflow OnBase 12
When the Display in Separate Window button is selected, related documents will open in a
separate window, leaving the original document in the Document Viewer window.
Note: If a ZIP file is opened when this option is selected, an additional blank window will be
displayed in addition to the ZIP file window. This is Windows functionality.
When the Show Second Panel button is selected, the document viewing area is divided into two
panels. The left panel displays the selected document and the right panel displays the
selected related document. If you don't want to use the two panel display, click the Close
Web Workflow
Note: If the Display in Separate Window button is selected and a related document is displayed
in the second window, when the primary document leaves the queue (or primary viewer), the
related document remains displayed in the second window.
Note: When a Keyword Type that is determining the contents of the Work Folder has a value
that contains an asterisk (*) or question mark (?), the characters are treated as wildcards and
all documents that meet the criteria are returned as related documents.
The following right-click options are available from the Work Folder tab when a document is
selected:
View Keywords
Properties
Note: You may have more options available depending on user rights and licensing. You may
also not have any of these options depending on granted user rights.
Document Viewer
The Viewer is the large window on the bottom of the page or in a separate window, depending
on the options you have selected. This window displays the selected document. For more
information about viewing documents, see the Web Client documentation.
2012 Hyland Software, Inc.
94
OnBase 12 Workflow
Web Workflow
When the User Interaction tab is active, you will be unable to select the Documents, Life Cycle
View, or Work Folder tabs. Once the tasks that require user interaction are completed, the
Documents tab will become enabled again and you will not be able to select the User
Interaction tab.
Note: The User Interaction tab will only display when an task requiring user interaction (e.g.,
an ad hoc task) is executed. When the task is completed, the tab will no longer be displayed.
To initiate an ad hoc task, select the appropriate document and click on the appropriate ad
hoc task icon.
2012 Hyland Software, Inc.
95
Workflow OnBase 12
To perform an ad hoc task on a batch of documents, select multiple documents using one of
the following methods:
Pressing CTRL and clicking each document.
Pressing SHIFT and clicking on the first and last documents of a desired range of
documents.
After selecting the desired number of documents, click on the appropriate ad hoc task icon.
If there are more ad hoc tasks than can be displayed on the screen, a drop-down menu is
displayed, allowing you to access all of the ad hoc tasks available by clicking on the arrow
Web Workflow
drop-down button. The following is an example of an ad hoc task pane with a drop-down
menu:
Only one ad hoc task may be performed at a time. If an ad hoc task requires processing time,
such as importing a document or stamping a version, a message will display notifying the
user of this. During this time, other ad hoc task icons will not be visible. Any task requiring
user interaction will display the message as well.
Note: If the documents selected are in different queues, such as when in Combined View, the
ad hoc task list will clear.
Note: When a task requiring user interaction is being carried out, the Documents tab will be
grayed-out and not selectable.
Note: Documents in the Inbox cannot be dragged and dropped onto ad hoc user task icons.
This action is limited to the documents contained in the Work Folder tab.
Note: The active document will remain in view and selected after performing any ad hoc user
task that does not remove that document from the queue.
2012 Hyland Software, Inc.
96
OnBase 12 Workflow
Importing Documents
Upon importing documents, you can select the Initiate Workflow check box to add imported
Web Workflow
documents into the life cycle(s) assigned to the Document Type to which the document was
imported. Depending on your configuration, the Initiate Workflow check box may not be
available. Upon importing documents, Workflow will automatically be initiated.
Re-Indexing Documents
Upon re-indexing documents, you can select the Initiate Workflow check box to add the
documents into the life cycle(s) assigned to the Document Type to which the document was
re-indexed.
Depending on your configuration, the Initiate Workflow check box may not be available. Upon
re-indexing documents, Workflow will automatically be initiated regardless of whether you
modified the documents Keyword Values or Document Type. When Workflow is automatically
initiated, its behavior is dependent upon how you re-index the document:
If you only modify Keyword Values, system work is not performed.
If you modify the Document Type and the new Document Type is assigned to a life
cycle, the document is added to that life cycle and system work is performed.
If you modify the Document Type of a document currently in a life cycle and the new
Document Type is assigned to a different life cycle, the document remains in the
current life cycle and is added to the life cycle assigned to the new Document Type.
System work is performed for the re-indexed Document Type in the new life cycle.
2012 Hyland Software, Inc.
97
Workflow OnBase 12
You can also run system tasks on documents from a hit list. To run a system task from a hit
list:
1. Select one or more documents in the hit list that you want to run the system task on.
2. Right-click and select Workflow | System Tasks... The Workflow System Tasks dialog box
is displayed.
Web Workflow
3. Select the task you want to run from the Select a System Task to execute drop-down
select list.
4. Click OK. A message stating what system task was executed and how many items it
was executed on. Click OK on this message.
Note: If See Other Users Documents is not available, you do not have rights to this
functionality. Contact your system administrator for further information.
2012 Hyland Software, Inc.
98
OnBase 12 Workflow
Selecting this option displays a screen from which you can choose to view another users
documents. All users assigned as load-balancing members display:
Web Workflow
You can select to view the documents of a particular user, all documents, or all documents not
currently assigned to a user. This does not apply to Coverage queues. See Other Users
Assigned Documents only displays assigned documents, not covered ones. Any filters that
were being used prior to viewing another users documents will be in effect for those
documents.
Note: When a load balanced queue is configured as Match Keyword to User Name, the View
Other Users Documents list only includes the names of members assigned to the selected load
balanced queue. The Load Balance Administration dialog box includes all users that have
documents assigned to them, regardless of whether they are members assigned to the
selected load balanced queue.
2012 Hyland Software, Inc.
99
Workflow OnBase 12
You can perform load balancing administration tasks by selecting the appropriate queue and
clicking the Load Balance Administration button.
Note: This button only functions if the selected queue is configured as a load balanced queue.
Web Workflow
You can also reassign a document by clicking and dragging the document under the
appropriate user/user group. This will work for queues configured as Match Keyword to User
Name even if the documents are dragged to a user who is not a member of the queue.
Note: Users configured as members for load balancing queues will always appear in Load
Balancing Administration regardless of the number of documents assigned to them.
This dialog box allows you to manually perform load balancing functions.
A right-click menu is available at the queue, user group, and document levels.
2012 Hyland Software, Inc.
100
OnBase 12 Workflow
Keywords Displays the Add/Modify Keyword dialog box, and allows you to add or modify
document Keyword Values.
When a Keyword is changed on a document in a queue configured as Match
Keyword to User Name, the user name assignments will automatically refresh in
Web Workflow
Load Balancing Administration.
Properties Displays the Document Information for Document Handle <nnn> window. This
window displays certain attributes stored for the document, some of these values
reflect data stored in the database tables for that document.
Note: This menu option may or may not be available depending on user rights.
Note: You may have more options available depending on user rights and licensing. You may
also not have any of these options depending on granted user rights.
2012 Hyland Software, Inc.
101
Workflow OnBase 12
These options are available at the queue, user group, and document levels:
Option Description
Reassign Documents Displays the Reassign Documents dialog box, allowing the selected
documents to be assigned to another User/User Group or role in Load
Balance Administration.
Web Workflow
You can also reassign documents by clicking and dragging the document
under the appropriate user/User Group.
You can reassign all documents from one user/User Group or role to
another. Select the user/User Group or role that is assigned the
documents, drag the user/User Group or role icon over the intended user/
User Group or role icon, and release the mouse button.
2012 Hyland Software, Inc.
102
OnBase 12 Workflow
Option Description
Rebalance Queue level: When Rebalance is initiated at the queue level, documents
are redistributed according to the configured load-balancing logic.
User/User Group or role level: When Rebalance is initiated at the user/
user group or role level, the documents currently assigned to the selected
user/user group or role are redistributed within the queue, according to
the load-balancing parameters configured.
If no items are selected, or the root item is selected then the whole queue
Web Workflow
is rebalanced.
Note: This option is not available for Match Keyword to User Name load
balancing queues or if the queue is load balanced by rules and there is no
load balancing work task list on the queue. Additionally, this option is not
available when the queue is load balanced by rules and the load balancing
work task list does not contain any actions, rules, or sub task lists.
Note: When modifying Keyword Values with the right-click menu, the documents Auto-Name
string will not update.
2012 Hyland Software, Inc.
103
Workflow OnBase 12
E-Form Interaction
2012 Hyland Software, Inc.
104
OnBase 12 Workflow
After the E-Form is created in the system, it will be displayed in the User Interaction
window. Clicking Cancel will close the E-Form without saving any changes made to
the E-Form.
Clicking Cancel will close the E-Form and not create it in the system.
When a submit button is configured on an E-Form and it is not configured using OBBtn_
syntax, the button will function as a cancel button.
Web Workflow
In either of the above cases, clicking the Submit button with valid Keyword Values entered will
store the form in the database with the new Keyword Values. If the Keyword Values are not
valid (e.g., a date Keyword Value where an alphanumeric one should be), the user will be
prompted to fix the error and the form will stay open.
Note: Keyword validation does not apply to currency keywords in the Core. The user must be
familiar with the format used for currency in order to ensure accuracy.
2012 Hyland Software, Inc.
105
Workflow OnBase 12
Web Workflow
2012 Hyland Software, Inc.
106
JAVA CLIENT WORKFLOW
Caution: The ability to view documents in a life cycle is controlled at the queue level. If users
have rights to a Workflow queue, they will also have rights to view all the documents in that
queue by default, regardless of their security rights (i.e. Document Type rights). This includes
related documents.
Caution: The ability to modify a document in a life cycle is controlled at the queue level. If users
have rights to a Workflow queue, they will also have rights to modify all documents in that queue
by default, regardless of their Modify privilege setting, including related documents.
Administrators should be aware that Workflow automatically grants the Modify privilege to users
for any documents that are in their queue. As a result, care should be taken to only present
documents which users should be allowed to modify.
Note: To view or change Keyword Values or to re-index a document via the right-click menu,
you must have appropriate rights for modifying keywords or re-indexing. The re-index option
is not present in the Java Workflow interface.
2012 Hyland Software, Inc.
107
Workflow OnBase 12
Note: If Workflow is not available, you do not have access to Workflow. Contact your system
administrator for further information.
After opening the Workflow interface, the Task List window is displayed. This window can be
Java Client Workflow
closed and opened at a later time or moved to another position on the screen.
Double-click a life cycle to select and expand it. Click the icons to the left of each life cycle to
expand and collapse the life cycle without selecting it.
Click a queue to select and open it. Once a queue is open, all documents in the queue will
display in the Documents inbox.
You can collapse the Life Cycle View box by clicking the Click to Collapse pane arrow button. You
can expand the Life Cycle View box by clicking the Click to Expand pane arrow button.
Documents Inbox
Documents within the opened queue are displayed in the Documents inbox. The Documents
inbox displays the life cycle and queue in which the documents reside.
2012 Hyland Software, Inc.
108
OnBase 12 Workflow
The following secondary click options, depending on configured rights, are available from a
selected document in the Documents inbox:
Note: These secondary click options are not available when multiple documents are selected.
View Keywords: Opens the Add/Modify Keywords dialog box to view or modify the
Note: The Workflow Queues and Workflow Transaction tabs are also displayed when this option
is selected. See Workflow Queues on page 114 and Workflow Transactions on page 114 for
more information.
Open in New Window: Opens the selected document in a new browser window.
Workflow
Workflow Queues: Displays all the life cycles and queues the selected document is
currently in, along with the user(s) assigned to the document. <Restricted> will
be displayed for queues and life cycles that you do not have the rights and/or
privileges to view.
Note: The Workflow Queues option in this menu and the Workflow Queues tab (see page 114)
display different information.
Note: You may have more options available depending on user rights and licensing. You may
also not have any of these options depending on granted user rights.
Note: For more information about the Java Client Viewer, see the Java Client documentation.
You can collapse the Documents box by clicking the Click to Collapse pane arrow button. You
can expand the Documents box by clicking the Click to Expand pane arrow button.
2012 Hyland Software, Inc.
109
Workflow OnBase 12
2. Enter the number of documents that you want to display in the inbox at a time.
Java Client Workflow
3. Click OK.
In the following example, only one document is set to display in the inbox at a time:
The Previous Page and Next Page buttons allow you to navigate through all of the documents.
If there are more documents available than the ones currently displayed, the Document Name
heading will indicate more documents exist by displaying a plus sign (+) next to the
document count.
1. Select the queue you want to filter in the Life Cycle View.
2. Click the Filter Inbox button.
To remove a filter from the inbox, click the Filter Inbox button and select No Filter from the
drop-down select list.
2012 Hyland Software, Inc.
110
OnBase 12 Workflow
Work Folder
If a selected document has related documents, these documents will display in the Work
Folder. The following secondary click options, depending on configured rights, are available
from a selected document in the Work Folder:
Template: Opens the Apply Template dialog box which allows you to select a template
to apply to the Work Folder.
Note: The Workflow Queues and Workflow Transaction tabs are also displayed when this option
is selected. See Workflow Queues on page 114 and Workflow Transactions on page 114 for
more information.
Open in New Window: Opens the selected document in a new browser window.
Workflow
Workflow Queues: Displays all the life cycles and queues the selected document is
currently in, along with the user(s) assigned to the document. <Restricted> will
be displayed for queues and life cycles that you do not have the rights and/or
privileges to view.
Note: The Workflow Queues option in this menu and the Workflow Queues tab (see page 114)
display different information.
Note: You may have more options available depending on user rights and licensing. You may
also not have any of these options depending on granted user rights.
Note: When a Keyword Type that is determining the contents of the Work Folder has a value
that contains an asterisk (*) or question mark (?), the characters are treated as wildcards and
all documents that meet the criteria are returned as related documents.
When you double-click on a related document in the Work Folder, the document is opened in
the document viewer. If you want to keep the primary document open in the document
viewer, you can open the related document in a separate window by clicking the Display in
Separate Window button.
2012 Hyland Software, Inc.
111
Workflow OnBase 12
When this button is clicked and the document will be displayed in a separate window, the
button looks like the following:
You can collapse the Work Folder by clicking the Click to Collapse pane arrow button. You can
Java Client Workflow
expand the Work Folder by clicking the Click to Expand pane arrow button.
User Interaction
User Interaction displays tasks that require user interactions. Forms and questions that
require user entry are displayed in this area.
Note: Some actions that are configured for user interaction will display in a separate window.
You can collapse User Interaction by clicking the Click to Collapse pane arrow button. You can
expand User Interaction by clicking the Click to Expand pane arrow button.
Note: Depending on your configuration, the Task List window and Task List button may not be
available. When this window is not available, tasks can be executed through the Tasks menu.
2012 Hyland Software, Inc.
112
OnBase 12 Workflow
If the window is not displayed, it can be accessed by clicking the Task List button.
To initiate an ad hoc task, select the appropriate document(s) and double-click on the
appropriate ad hoc task icon. Hover the mouse over the ad hoc task icon to display a
descriptive tooltip. This will only display, if a tooltip has been configured for the task by your
Workflow History
From the Documents inbox, use a secondary click to access the History option. The dialog box
displays the Workflow-related actions in the Workflow Queues and Workflow Transactions tabs.
The History tab displays each time a document and/or its keywords are viewed.
Note: The Workflow Queues tab displays different information than the Workflow Queues
secondary click option, which is accessible from any document.
Note: This option is only available when granted the Document History product right.
2012 Hyland Software, Inc.
113
Workflow OnBase 12
Workflow Queues
Note: The Workflow Queues tab displays different information than the Workflow Queues
secondary click option, which is accessible from any document.
Workflow Transactions
The Workflow Transactions tab displays information created by either the SYS - Custom Log
Entry action or by actions, rules, or task lists configured with the Log Execution setting. This
tab also displays information related to ownership.
The following information is available on this tab:
Log Date and Log Time: date and time the information was logged.
Life Cycle: life cycle the transaction occurred in.
Queue: queue the transaction occurred in.
User Name: user responsible for the transaction.
Type: can be action, rule, task list, custom entry, or ownership.
Name: name of the action, rule, task list, or ownership change that made the entry.
Message: when the entry was caused by the SYS - Custom Log Entry action, this will
be the message that was specified in the action. If an action, rule, or task list is
disabled, a message displays stating that the item is disabled. Ownership change
information is also displayed in this column.
2012 Hyland Software, Inc.
114
OnBase 12 Workflow
3. The dialog box will also list who a document is assigned to if the document is within a
load-balanced queue within the Assigned Users column. <Restricted> will be displayed
for queues and life cycles that you do not have the rights and/ or privileges to view
2012 Hyland Software, Inc.
115
Workflow OnBase 12
Java Client Workflow
2012 Hyland Software, Inc.
116
UNITY WORKFLOW
Workflow Security
Access to items via Workflow is accomplished by a combination of assignments made at the
Document Type, life cycle, and work queue level. Specifically:
Document Types must be configured for use in a specific life cycle.
In the Configuration module, select Document | Document Types, then select the
desired Document Type and select Life Cycles. Assign the desired life cycles at the
Life Cycles for <document type> dialog box.
Users must be granted rights to a specific life cycle, as well as each queue within
that life cycle, in order to view items within those queues.
In the Configuration module, select Users | User Groups/Rights. Select the desired
user group and select Workflow. Assign the desired life cycles and queues at the
Assigning Workflow for <user group> dialog box.
In all Workflow interfaces except the Unity Workflow interface, users must be
granted the Retrieve/View privilege, either as a user group privilege or as an
override privilege. If this privilege is not granted (or in the case of override
privileges, overridden), users will not be able to view documents in Workflow. For
more information on configuring user group rights, please see the System
Administration module reference guide or help files.
Caution: The ability to view items in a life cycle is controlled at the queue level. If users have
rights to a Workflow queue, they will also have rights to view all the items in that queue by
default, regardless of their security rights (i.e. Document Type rights). This includes related
items. The exception to this rule is WorkView objects. In order to work with WorkView objects,
the user must have rights to view that object.
Caution: The ability to modify items in a life cycle is controlled at the queue level. If users have
rights to a Workflow queue, they will also have rights to modify all items in that queue by
default, regardless of their Modify privilege setting, including related items. Administrators
should be aware that Workflow automatically grants the Modify privilege to users for any items
that are in their queue. As a result, care should be taken to only present items which users
should be allowed to modify.
2012 Hyland Software, Inc.
117
Workflow OnBase 12
2012 Hyland Software, Inc.
118
OnBase 12 Workflow
Note: My Owned Items is only displayed if you have rights to access a life cycle that supports
ownership.
Unity Workflow
Combined Inbox - Select to display work items from multiple life cycles. See
Combined View Settings on page 152 for more information.
Option Description
Refresh Select to refresh the selected queues item count and the Inbox
pane.
Add To Personal Page Select to add the selected queue to your personal page.
Note: For more information on list reports, see the Unity Client
help files.
2012 Hyland Software, Inc.
119
Workflow OnBase 12
Option Description
When a life cycle is selected, the Refresh, Add To Personal Page, and Create List Report options
are available.
2012 Hyland Software, Inc.
120
OnBase 12 Workflow
Process Flow
The Process Flow pane allows you to view the process flow of a life cycle. To open the Process
Flow pane:
1. Select the appropriate life cycle from the All Life Cycles pane.
2. Place your mouse cursor over Process Flow:
Unity Workflow
3. The Process Flow pane displays the process flow of the selected life cycle:
2012 Hyland Software, Inc.
121
Workflow OnBase 12
You can zoom in or out by moving the slider in the top right corner of the Process Flow pane:
Unity Workflow
Note: When the Inbox is displaying a combined view, the Process Flow pane displays the
process flow for the Workflow queue that the selected Inbox item is in.
Inbox Pane
The Inbox pane displays documents and other OnBase items, such as managed folders:
Column Description
Entry Date The date and time the item entered Workflow.
2012 Hyland Software, Inc.
122
OnBase 12 Workflow
Column Description
Workflow Life Cycle The name of the life cycle that the item is in.
Note: This column is only displayed when a life cycle is selected in the Life
Cycles pane.
Workflow Queue The name of the queue that the item is in.
Unity Workflow
Note: This column is only displayed when a life cycle is selected in the Life
Cycles pane.
Note: This column is only displayed when a life cycle is configured for
ownership.
These columns can be grouped and sorted like other Unity Client data lists. See the Unity
Client documentation for more information.
When an item is selected in the Inbox pane, it will open in the Primary Viewer tab:
2012 Hyland Software, Inc.
123
Workflow OnBase 12
If there is only one item in the currently selected queue, it is automatically displayed in the
Primary Viewer tab.
Note: The first 2000 items in the currently selected queue or in the combined view are
displayed. If more than 2000 items exist in the currently selected queue, you are prompted
with a message that, "Workflow is displaying only the first 2000 items in this queue. Not all
items are shown."
Multiple items can be selected at once by holding the Ctrl key down while making selections,
Unity Workflow
or you can select a consecutive group by selecting the first item in your selection, holding
down the Shift key, and selecting the last item in your selection. You can perform ad hoc
tasks on multiple items by selecting multiple items before performing the action.
The status bar is located at the bottom of the Inbox pane. It displays the current queue, any
selected filter, and the number of items in the pane:
When working with items in the Inbox pane, the task pane, which opens if you choose to view
an items keywords, cross-references, etc., includes the Inbox tabs icon:
This is so that you can easily distinguish between items in the Inbox, and related items. Any
items that are related to the item(s) selected in the Inbox pane are displayed on the Related
Items tab. For more information, see Related Items Pane on page 126.
A right-click menu is available in the Inbox pane. This menu contains options used in the
Unity Client and options specific to Workflow. Menu options used in the Unity Client are
described in the Unity Client documentation. The following Workflow-specific right-click
options are available from the Workflow menu when an item is selected in the Inbox and the
appropriate rights have been granted:
Option Description
Workflow Queues Displays the queues that the selected item exists in. An item can only
exist in one queue within a life cycle, but can exist in multiple life cycles.
Execute Workflow Click to manually enter one or more items into a life cycle.
For more information, see Entering Items into a Workflow on page 159.
Note: If Exclusive Document Viewing has been enabled, attempting to open a document
another user has opened will result in a message stating, You cannot view document
[Document ID, Auto-Name string] as user [User Name] is already working with this document.
2012 Hyland Software, Inc.
124
OnBase 12 Workflow
Unity Workflow
Could not load filter E-Form message is displayed, the selected filter is unavailable.
Note: Depending on the queue configuration, you may not have the option to filter a queue.
Note: A filter form will only display if the filter has been configured to use a form. Not all filters
need forms.
When a filter is applied to the Inbox pane, the name of the filter is displayed in the status bar.
To remove the filter, click the name of the filter in the status bar:
If Apply Filter | None is selected, a filter is not currently applied to the Inbox pane.
Note: If a Keyword Type that is used as a display column has more than one value for an item,
the item will be listed for each Keyword Value.
When applying a filter to a single queue, the following is true concerning the display columns
for the filter:
If no display columns have been configured on the filter, the Document Name column
will display.
If display columns have been configured, all configured columns will display.
2012 Hyland Software, Inc.
125
Workflow OnBase 12
When the Related Items pane is displayed, the item that is selected in the Inbox pane is
displayed in the Primary Viewer tab.
The following buttons are available:
Display Click to display the related item in a separate window instead of the
Secondary Viewer.
Tasks Click to select a task to execute on the item selected in the Related
Items pane.
2012 Hyland Software, Inc.
126
OnBase 12 Workflow
A right-click menu is available when working with related items. This menu contains options
used in the Unity Client and options specific to Workflow. Menu options used in the Unity
Client are described in the Unity Client documentation. For non-document items, this right-
click menu is limited.
The status bar is located at the bottom of the Related Items pane. It displays the current
queue, the number of items in the pane, and any selected filter.
When working with related items, the task pane changes to light green, and includes the
Related Items tabs icon:
Unity Workflow
This is so that you can easily distinguish between related items and items in the Inbox.
Note: When a Keyword Type that is determining the contents of the Related Items pane has a
value that contains an asterisk (*) or question mark (?), the characters are treated as
wildcards and all items that meet the criteria are returned as related items.
Portfolios
If the life cycle is configured to display items related to the item selected in the Inbox using
portfolios, the Portfolios drop-down select list is displayed in the Related Items pane:
To view items related to the item selected in the Inbox pane using a portfolio, click the
Portfolios drop-down select list and choose a portfolio, or select the portfolios tab in the
Related Items pane.
To refresh the items displayed on a portfolios tab, select the portfolios tab.
2012 Hyland Software, Inc.
127
Workflow OnBase 12
Workflow Tab
When the Workflow interface is displayed, the Workflow tab is available:
Unity Workflow
2012 Hyland Software, Inc.
128
OnBase 12 Workflow
Layout Description
Close This Layout Click to close the Workflow layout and return to your Home layout. If the
Workflow layout is your Home layout, the default OnBase layout is
Unity Workflow
displayed. After clicking, you are prompted to confirm that you want to
close the Workflow layout. Click Yes to close the layout. Click No to keep
the layout open. Select the Do not prompt me again check box to no
longer be prompted after clicking Close This Layout. This selection
persists for the duration of your current OnBase session.
Using this button to close the Workflow layout, or closing the Unity
Client, releases the Workflow license that you consumed, as well as any
auto-feed locks, Exclusive Document Viewing locks, process locks, and
document locks. Navigating to a different layout (for example, Document
Retrieval) does not release the Workflow license that you consumed,
even though the Workflow tab is no longer displayed. It also does not
release auto-feed locks, Exclusive Document Viewing locks, process
locks, or document locks.
Tip: Use this button to close the Workflow layout if you will not be using
Workflow again during your current OnBase session.
If you close the Workflow layout or the Unity Client while Workflow is
awaiting user interaction, you are prompted to verify that you want to
close the layout. Click No to complete the task. Click Yes to close the
layout and terminate the task.
Secondary Viewer Click to display the Secondary Viewer tab in the document content
area.
For more information on this tab, see Primary Viewer and Secondary
Viewer Tabs on page 136.
View Description
Apply Filter Click to select a pre-configured custom query to apply to the Inbox
pane.
See Filtering the Inbox Pane on page 125 for more information.
Auto Work Click to enable or disable auto-work functionality in the Inbox pane.
When auto-work is enabled, any items that are exclusively locked by
other users will be skipped over to access an item that can be worked
on. This option is disabled if the queue is using auto-feed functionality. If
a queue is configured for auto-feeding, this option is only available after
auto-feed functionality is disabled.
2012 Hyland Software, Inc.
129
Workflow OnBase 12
View Description
Override Auto-feed Click to enable or disable auto-feed functionality in the Inbox pane. The
ability to enable or disable auto-feed functionality is only available to
users with the appropriate rights.
When auto-feed is enabled, the following message is displayed in the
Inbox panes title bar: "You are currently viewing items in an auto feed
queue. When this functionality is enabled you can only view one item at
a time."
Unity Workflow
When auto-feed is disabled, all items in the queue are displayed. You
cannot view all items in auto-feed queues when in the combined view. If
a queue has filters assigned to it, additional filters cannot be placed on
the queue after disabling auto-feed functionality. The additional filter
must be in place before disabling auto-feed functionality.
You can also enable or disable auto-feed functionality in the Inbox pane
using the Enable or Disable buttons in the Inbox panes title bar.
Actions Description
Route Item Allows you to move an item in the Inbox pane to any queue connected
to the current queue by a transition. This option is only available to users
that are administrators, have the Workflow Administrative Processing
privilege, or have the Ad Hoc Routing user privilege at the queue level.
Take Ownership Click to take ownership of the selected items in the Inbox pane.
Release Ownership Click to release your ownership of the selected items in the Inbox pane.
Execute Script Task Click and select a Unity Script to execute on the selected items in the
Inbox pane.
To change the order of script tasks in the Execute Script Task drop-
down list, select Configure Items... from this drop-down list. In the
Organize Tasks dialog box, select tasks and re-position them using the
corresponding arrows.
The Tasks ribbon group on the Workflow tab contains all ad hoc tasks that are available for a
queue. Click the tasks icon to initiate the ad hoc task on the selected items in the Inbox pane.
A status message displays indicating that a task was successfully executed.
You can re-order the list of tasks in the Tasks ribbon group. To do so:
2012 Hyland Software, Inc.
130
OnBase 12 Workflow
Unity Workflow
3. Select an ad hoc task and use the up or down arrow to change the order of the task in
the Tasks ribbon group.
Note: The task displayed at the top of this dialog box will be displayed in the leftmost position
in the Tasks ribbon group.
4. Click OK.
5. The Tasks ribbon group is updated to reflect your changes.
2012 Hyland Software, Inc.
131
Workflow OnBase 12
2012 Hyland Software, Inc.
132
OnBase 12 Workflow
4. The layout you selected is displayed. As an example, the following screen shot depicts
the Classic layout:
Unity Workflow
5. To save the newly selected layout as your default layout, click Change Layout on the
Workflow tab and select Save current layout as my default. Your default layout is
displayed each time you open the Unity Workflow interface.
After saving a layout as your default layout, you can return to this layout at any time by
clicking Change Layout on the Workflow tab and selecting My Default.
Arranging Panes
You can arrange panes in the Unity Workflow interface using the functionality that is
embedded in the title bar of panes. Any changes you make are persisted and used the next
time you open Workflow.
Note: If you open multiple layouts during your Workflow session, the last layout you close will
have its layout setting restored the next time you open Workflow.
2012 Hyland Software, Inc.
133
Workflow OnBase 12
2012 Hyland Software, Inc.
134
OnBase 12 Workflow
You can also stack panes on top of each other to create combined windows that will be
displayed in a tabular format. If you drag one panes title bar on top of the other panes title
bar, they will combine into one pane. Tabs will display at the bottom of the combined pane for
each pane that can be accessed within the combined pane.
To undock a pane, double-click the panes title bar or right-click the panes title bar and select
Dockable. Click and drag the pane until it is displayed as a window outside of the main
interface. This window can be positioned anywhere on the screen. You can re-dock a window
by right-clicking on the window header and selecting Dockable and then double-clicking on the
header of the window.
Unity Workflow
Pinning
Panes can be pinned to a specific place or hidden when not in use. If you want to always see
a window, pin it. To pin it, click the Auto Hide button in the title bar:
To hide a pane when it is not in use, click the Auto Hide button. When a pane is not pinned,
the pane will be hidden when not in use. In order to access a hidden pane, hover over the tab
that corresponds to the appropriate pane. The tab label corresponds to the title displayed in
the panes title bar.
The following is any example of a hidden pane:
2012 Hyland Software, Inc.
135
Workflow OnBase 12
Consequently, they cannot be repositioned and pinned like the other panes in the Workflow
layout. However, these tabs can be stacked on one another.
The Primary Viewer and Secondary Viewer tabs contain the following buttons:
Clicking the Active Files button allows you to select the tab that has focus.
Clicking the Close button will close the tab.
2012 Hyland Software, Inc.
136
OnBase 12 Workflow
1. Click Change Layout on the Workflow tab and select Manage user group layout settings.
2. The Manage user group layout settings dialog box is displayed:
Unity Workflow
3. Select an existing layout from the drop-down select list at the top of the Manage user
group layout settings dialog box.
To create a new layout, click New. Type a name for the layout in the Layout Name field
and click OK.
4. To rename the layout, click Rename. Type a name for the layout in the Layout Name
field and click OK.
2012 Hyland Software, Inc.
137
Workflow OnBase 12
5. To modify the layout, click Modify Layout. The [name of layout] - Layout Designer
window is displayed:
Unity Workflow
Modify the layout accordingly. To add the Secondary Viewer tab to the layout, click
Secondary Viewer.
Click Save to save modifications to the layout and close the [name of layout] - Layout
Designer window.
6. In the Assigned User Groups portion of the Manage user group layout settings dialog
box, select the check box that corresponds to the OnBase User Group to which this
layout should be assigned.
7. To save all changes, including newly created layouts, click Save All.
Note: If you created a new layout, a numeric ID is assigned after saving it. This numeric ID is
displayed next to the name of the layout in the Manage user group layout settings dialog boxs
drop-down select list.
Note: If you created a new layout for yourself, you need to restart to be able to select this new
layout. Users are required to restart before changes you make to their layouts take effect.
8. To delete the selected layout, click Delete. You are prompted to delete the selected
layout. Click OK to delete the layout, or Cancel to retain the layout.
9. To close the Manage user group layout settings dialog box, click Close.
2012 Hyland Software, Inc.
138
OnBase 12 Workflow
Unity Workflow
2012 Hyland Software, Inc.
139
Workflow OnBase 12
Always display Workflow in a The Workflow layout always opens in a new window, separate
new window from the main Unity Client window.
Allow multiple instances of More than one instance of the Workflow layout can be opened.
the Workflow layout The ability to detach and float panes in the Workflow layout is
Unity Workflow
disabled.
Note: Changes to Layout Options take effect after the client has been restarted.
Automatically open the last When Workflow is opened, the last selected view will
selected view automatically be displayed.
Open the following view When Workflow is opened, the view selected from this drop-down
list will automatically be displayed.
The following views are available:
<None>
Combined View
My Owned Items
A specific life cycle
A specific queue
Note: Workflow startup display options are only applicable to the Unity Workflow interface. They
do not persist to other Workflow interfaces.
2012 Hyland Software, Inc.
140
OnBase 12 Workflow
Enable persistent inbox filter Switching between Workflow queues applies the existing
Workflow filter to the Inbox. This user option overrides any
default filter set for the queue.
When this user option is selected, the Remember the last filter
applied to each Inbox view check box is available. When this
check box is selected, the last Workflow filter you applied to each
Unity Workflow
Workflow queue is automatically reapplied when you return to
that queue. For example, you apply filter 1 to queue A. You then
navigate to queue B. When you return to queue A, filter 1 is
automatically applied.
Remember the last folder The last Workflow filter applied to the related folder in each
template or filter applied to Workflow queue is automatically reapplied when you return to
each related items view that view.
For more information on the User Options dialog box, see the Unity Client documentation.
Queue Administration
You can perform queue administration tasks, such as load balancing administration and
managing ownership assignments, by selecting the appropriate queue, right-clicking, and
selecting Queue Administration.
Note: This option is only available if the selected queue is configured as a load-balanced or
ownership queue. The logged-in user must also have one of the following administrative
privileges: Workflow Administrative Processing, Load-Balancing Administration, or Ownership
Administration.
2012 Hyland Software, Inc.
141
Workflow OnBase 12
For load balanced queues, the Workflow Queue Administration windows status bar displays the
type of queue (Type) and any filter that is applied (Filtered by). For ownership queues, the
Workflow Queue Administration windows status bar displays the type of queue (Type) and the
number of items (Count).
Users with Ownership Administration privileges can view items assigned to the current user
and all items in the queue. They also can also view the Owner and Since columns in the Queue
Administration dialog box. These columns indicate the owner of the item, as well as how long
the item has been owned.
2012 Hyland Software, Inc.
142
OnBase 12 Workflow
The Home tab is available in the Workflow Queue Administration window. This tab contains the
following buttons:
Common Description
Unity Workflow
Load Balancing Description
Rebalance Queue Click to rebalance all items in the selected queue. Items are re-
distributed according to the queues load-balancing logic.
2012 Hyland Software, Inc.
143
Workflow OnBase 12
Reassign Item Displays the Reassign To dialog box, allowing the selected item to be
assigned to another User/User Group or role that are also queue
members.
Note: When displaying items that are assigned to multiple users in the
queue inbox, the Reassign Item button is not available.
Unity Workflow
You can also reassign items by clicking and dragging the item under the
appropriate user/user group.
When a queue is configured as Match Keyword to User Name or rules-
based, the following options are available:
Unassign From Current User - Select to remove the current
assignment from the currently selected item(s) assignment in the
Workflow Queue Administration window and add the new
assignment.
Remove All Existing Assignments - Select to remove all existing
assignments for the currently selected item(s) and add the new
assignment.
Keep All Existing Assignments - Select to keep all existing
assignments for the currently selected item(s) and add the new
assignment.
2012 Hyland Software, Inc.
144
OnBase 12 Workflow
Rebalance Item Click to rebalance the selected item. The item is re-distributed according
to the queues load-balancing logic.
Unity Workflow
2012 Hyland Software, Inc.
145
Workflow OnBase 12
Ownership Description
Select a user from this drop-down select list and click OK.
Note: Once you have reached the maximum configured number of items
that can be owned in a life cycle, you cannot take ownership of
additional items.
Apply Filter Click to filter load balancing assignees. The Filter Load Balance
Members window is displayed. For more information on applying a filter
to the Workflow Queue Administration window, see Filtering Load
Balanced Members on page 147.
Clear Filter Click to clear the filter applied to the Workflow Queue Administration
window.
Tasks Description
Perform System Work Click to perform the system work for the selected queue.
Execute Timer Work Click to execute timer work for the selected queue.
Items Description
2012 Hyland Software, Inc.
146
OnBase 12 Workflow
A right-click menu is available. This menu contains options used in the Unity Client and
options specific to Workflow. Menu options used in the Unity Client are described in the Unity
Client documentation. The following Workflow-specific right-click options are available:
Note: You may have more options available depending on user rights and licensing. You may
also not have all of these options depending on granted user rights.
Unity Workflow
Option Description
Workflow History Displays the Document History window, which allows you to view
Document History, Workflow Queues, and Workflow Transactions.
For more information, see Document Workflow History on page 155.
To apply a filter:
1. From the Look at drop-down select list, select one of the following:
User Groups - The filter will be based upon a list of OnBase user groups.
Users - The filter will be based upon a list of OnBase users.
2012 Hyland Software, Inc.
147
Workflow OnBase 12
Filtered By Description
Specified Member Select to apply a filter based on one or more specified members.
When User Groups is selected from the Look at drop-down select list,
select a user group from this drop-down select list.
When Users is selected from the Look at drop-down select list, select a
Unity Workflow
Members of user group Select to apply a filter based on members of a user group. Select a user
group from the corresponding drop-down select list.
Note: This filtering criteria is not available when User Groups is selected
from the Look at drop-down select list.
Note: This filtering criteria is not available when User Groups is selected
from the Look at drop-down select list.
Note: This filtering criteria is not available when User Groups is selected
from the Look at drop-down select list.
2012 Hyland Software, Inc.
148
OnBase 12 Workflow
Unity Workflow
Much of the functionality that is available from this tab is also available from the Workflow
Queue Administration window.
The following buttons are available:
Assigned To Select to view items assigned to the current user in the Inbox pane.
Current User
Unassigned Items Select to view items not assigned to any user in the Inbox pane.
Show Other Users Select to view items assigned to another user in the Inbox pane.
Inbox
Show All Items Select to view all items in the queue in the Inbox pane.
Reassign Item Click to reassign the selected item in the Inbox pane.
For more information, see Reassign Item on page 144.
Change Owner Click to change the owner of the selected item in the Inbox pane.
For more information, see Change Owner on page 146.
Tasks Description
Queue Click to open the Workflow Queue Administration window for the selected
Administration queue.
For more information, see Queue Administration on page 141.
2012 Hyland Software, Inc.
149
Workflow OnBase 12
Tasks Description
Perform System Click to perform the system work for the selected queue.
Work
Evaluate Click to evaluate the documents against the Business Rule Engine.
Documents
Execute Timer Click to execute timer work for the selected queue.
Work
Unity Workflow
Note: If Show Other Users Inbox is not displayed, you do not have rights to this functionality.
Contact your system administrator for further information.
Note: You cannot view unassigned items in a Match Keyword to User Name queue.
Selecting this option displays a dialog box where you can choose to view another users inbox.
All users who are load-balancing members are displayed:
2012 Hyland Software, Inc.
150
OnBase 12 Workflow
You can select to view the inbox of a particular user, all items (<All Users>), or items not
currently assigned to a user (<Unassigned Items>). You can also click in the list of users and
type the name of a user to go directly to that user. After you click OK, the Inbox pane displays
the name of the selected user:
Unity Workflow
In the case of a Coverage queue, the Show Other Users Inbox options will not reflect coverage
documents.
When a load balanced queue is configured as Match Keyword to User Name, the Show Other
Users Inbox list only includes the names of members assigned to the selected load balanced
queue. The Queue Administration dialog box includes all users that have items assigned to
them, regardless of whether they are members assigned to the selected load balanced queue.
Button Description
Display Queue Click to open the selected item in the Workflow layout and display the
selected item in the Inbox.
You can also double-click an item to open the Workflow layout and display the
selected item in the Inbox.
2012 Hyland Software, Inc.
151
Workflow OnBase 12
Button Description
Execute Workflow Click to manually enter one or more items into a life cycle.
For more information, see Entering Items into a Workflow on page 159.
In addition, depending on your installation, a Workflow Queues button may be available in OLE
or PDF documents. Clicking this button will open the Workflow Locations dialog box.
Unity Workflow
1. From the Life Cycles pane, in Inbox Views, right-click Combined Inbox.
2. Select Configure Combined Inbox.
2012 Hyland Software, Inc.
152
OnBase 12 Workflow
Unity Workflow
4. Select the check boxes that correspond with the appropriate life cycles or queues.
Expand a life cycle by clicking on the plus sign in order to access queues for selection.
5. Click OK to close the Combined View Settings dialog box and apply the new settings to
the Inbox pane.
2012 Hyland Software, Inc.
153
Workflow OnBase 12
Once queues have been configured for the combined view, you can select to view the
combined queues by clicking Combined Inbox in the Inbox Views pane. The Inbox panes
status bar is updated to reflect that you are working in combined view:
Unity Workflow
To turn off the combined view, select another Inbox View or a life cycle and/or queue from the
All Life Cycles pane.
Note: Items in Auto-Feed queues are not displayed when using the combined view.
Note: You cannot configure an auto-open queue in the Unity Workflow interface, but can use
the auto-open queue configured via another OnBase client. If a queue is configured to auto-
open, but is not configured for combined view, the queue is auto-opened after opening
Workflow. Select a life cycle to show the combined view in the Inbox pane.
2012 Hyland Software, Inc.
154
OnBase 12 Workflow
When a filter is applied while using Combined View, the following is true concerning the
display columns. The columns display from left to right.
If no display columns have been configured on the filter:
Icon
Document Name
Unity Workflow
Workflow Life Cycle
Workflow Queue
Entry Date
If display columns have been configured on the filter:
All configured columns in user-configured order
Workflow Queue
Queues will be sorted by Entry Date by default. Queues can also be sorted by a defined filter
sort or by clicking a display column to sort by.
Note: If Workflow Queue has been configured as a display column, it will not be added again.
Note: If no filter has been applied, the display columns will be: Document Name, Workflow
Queue, Entry Date.
2012 Hyland Software, Inc.
155
Workflow OnBase 12
From an open document or the Document Search Results list, right-click and select History.
The Document History dialog box displays the Workflow related actions in the Workflow Queues
and Workflow Transactions tabs.
Note: If a user does not have the Document History product right, this option will not be
available. Workflow history is only available when appropriately licensed and registered for
Workflow.
Unity Workflow
The Workflow Queues and Workflow Transactions data lists can be grouped, sorted, and
filtered like other Unity Client data list. See the Unity Client documentation for more
information.
2012 Hyland Software, Inc.
156
OnBase 12 Workflow
Unity Workflow
2012 Hyland Software, Inc.
157
Workflow OnBase 12
Button Description
Workflow Click to display a list of all the queues the item is in. To open the item in a
Queues different Workflow queue, allowing you access to tasks from that queue, select
the Workflow queue from this list.
Related Items Click to display a list of related items in the task pane:
Unity Workflow
Ad Hoc Tasks/ Click to execute an ad hoc task or system task on the item. When a task is
System Tasks executed, a status message displays indicating that the task was successfully
executed.
The name of the Workflow queue is displayed in the name of the ribbon group.
Execute Task Click to display a list of Unity Scripts that are available for use. For more
information on executing a Unity Script, see the Unity Client documentation.
Note: If the Tasks tab is accessed from a Document Search Results list and the Document
Viewer pane is not displayed, it only contains system tasks. The name of the Workflow queue
is displayed below these tasks. Click the tasks icon to initiate the system task.
2012 Hyland Software, Inc.
158
OnBase 12 Workflow
Unity Workflow
2012 Hyland Software, Inc.
159
Workflow OnBase 12
Documents can be manually entered into a life cycle by right-clicking one or more
documents and selecting Workflow | Execute Workflow.
Note: Users can add documents to a life cycle even if they do no have rights to the life cycle.
If the document is configured for one life cycle, Workflow enters the document into
that life cycle and you are prompted to open the Workflow layout. Click Yes to open
the Workflow layout, or No to continue working outside the Workflow layout.
Unity Workflow
If the document is configured for multiple life cycles, you are prompted to select the
appropriate life cycle by the Add To Workflow dialog box:
Review the selections in the Add To Workflow dialog box. The following check boxes
are available:
Add all items to the following life cycle When selected, all documents listed in the Add To
Workflow dialog box will be added to the life cycle
selected from the corresponding drop-down list after
clicking OK.
Launch the Workflow layout When selected, the Workflow layout will launch after
clicking OK.
2012 Hyland Software, Inc.
160
OnBase 12 Workflow
Unity Workflow
Some Document Types have system tasks associated with them. When a document belongs
to a Document Type that is configured to use system tasks, system tasks can be initiated on
the document. To initiate a system task from an open document or a document in document
retrieval, select the Tasks tab and then select the appropriate system task from the System
Tasks ribbon group.
Developer Tab
Depending on your configuration, the Developer tab may be available. The Developer tab
includes the following buttons:
Trace When selected, tracing is activated on the Application Server and all
messages from that client will be logged to the Diagnostic Console. All
messages from all clients logging trace messages to the Application
Server will be displayed in the Diagnostic Console. Thus, if two clients
are logging trace messages, any Diagnostic Console connected to that
Application Server will display messages from both clients
simultaneously.
Breakpoint Debug Click to enable break point debugging. Any actions/rules/task lists that
have the Enable Debug Breakpoint check box selected in the
Configuration module will cause a message box to display giving details
of the breakpoint.
Step Breakpoint Debug Click to display a message box after each rule, action, or task completes.
Used for determining the location of logic problems in a Workflow
configuration.
2012 Hyland Software, Inc.
161
Workflow OnBase 12
Unity Workflow
2012 Hyland Software, Inc.
162
CONFIGURATION MODULE CONFIGURATION
Configuration
A life cycle represents a course of business that a document must follow. Each step the
document makes is represented by a separate queue in the life cycle. Each time a document
moves to a new queue, it is called a transition. When a document enters a life cycle, all the
necessary work that must be performed during the normal course of business is performed on
the electronic document that is stored in OnBase. In the Configuration module, a life cycle can
be viewed in a tree configuration format, which displays the life cycle, queues, rules, actions
and tasks in a hierarchical structure. The other format for viewing life cycles is a graphic view,
which displays the queues as bitmaps with transition arrows representing movement between
the queues.
Pre-Plan
Before you create a new life cycle, prepare a detailed outline and diagram of your business
process. In order to create a successful life cycle, know what steps and tasks need to be
performed to achieve a specified goal.
2012 Hyland Software, Inc.
163
Workflow OnBase 12
The example below demonstrates a business process for approving requisitions, and a life
cycle that uses a Process Flow Design to accomplish that business objective.
Configuration Module Configuration
Graphic Layout
Once all of the queues have been created and the work and tasks have been configured,
proceed to the graphic layout. In the graphic layout, you create a picture of the life cycle.
Transitions must be drawn graphically to manually route documents from the right-click menu
in the Client module.
Assign Rights
Rights are important. Without them, you do not have access to certain items, such as life
cycles, Document Types, note types and folder types. You must assign user rights to both the
life cycles and to the individual queues within the life cycles.
2012 Hyland Software, Inc.
164
OnBase 12 Workflow
Conditional Branching
Uses rules to conduct if-then-else logic.
Looping
Eliminates nesting which uses stacked memory. Higher levels of nesting exhaust the stack
and causes OnBase to close unexpectedly. This process involves sending the same document
through the task list, incrementing a keyword using actions or a VBScript to update the status
of the document each time.
Breaking Execution
Break On - Breaking execution to fall out of a loop can be achieved through the use of the
Break On option for task lists. Conduct the work with Break On at the top level, not under the
evaluations.
Break Processing - Breaking can also be achieved through the use of SYS Break Processing
action to terminate a task list.
Caution: Memory requirements increase with newer versions; validate your life cycle against the
upgrade in a test environment before implementing it in a production environment.
Design Concepts
A primary consideration during the design phase is creating a resilient Workflow solution. A
small effort in the beginning to make batches recoverable at each stage of the Workflow
process can prevent a catastrophic event during production.
While not every possible abort can be predicted, a list of typical failure scenarios can lead to a
Workflow that is resilient to entire classes of failures:
The Workflow process aborts during a bulk loading operation (i.e. DIP).
2012 Hyland Software, Inc.
165
Workflow OnBase 12
The database shuts down while Workflow users are executing task lists on
documents.
The Workflow process aborts during an output process.
A power outage causes a timer to fire inappropriately, or not at all.
Configuration Module Configuration
A --> B --> C
During the day, the streaming Workflow queue has an error, or the file generated by the B
queue is lost. The documents processed are mixed in with all the other documents stored in
queue C, making it difficult to recover or recreate the file.
The preferred recovery method is to reprocess all the documents and generate a new file. To
do this, a queue must be created to hold a copy of the documents until the streamed file is
successfully processed, transferred or uploaded. The following diagram shows the improved
life cycle:
A --> B --> C
If OnBase lost power during the middle of DIP, this life cycle would not be recovered easily.
While the OnBase system could easily be recovered by simply purging the DIP batch and
reprocess the input file, the data loaded into the other system might be difficult or impossible
to remove. Often it is destructive to submit duplicate data, which would occur when the DIP
file is reprocessed.
This life cycle becomes more recoverable when a queue is included to hold a temporary copy
of the documents in the A queue. This type of queue makes it easy to restart the output
process by clearing out the A queue and reloading it with the contents of the Wait Queue. The
following diagram shows the improved life cycle:
2012 Hyland Software, Inc.
166
OnBase 12 Workflow
Queue Recoverability
Queue recoverability is the ability to recover from an interruption during a process. The
easiest way to achieve this is to design the queue so a document can be routed through the
same queue multiple times with no adverse effects. It is important to change keywords in
such a way that re-processing the same document in the same queue leads to the same
keyword values being set.
Performance Concepts
When designing and implementing a Workflow where high processing speeds are required,
there are several concepts to keep in mind. Remember that every rule and action requires
one or more database operations to be performed. Determining which operations are fast and
which are not is important in designing and implementing a high-performance Workflow.
2012 Hyland Software, Inc.
167
Workflow OnBase 12
view the complete workload in similar queues, across all life cycles. For example if each life
cycle contains a Data Entry queue, you would have to check each life cycle individually to get
the number of documents in the Data Entry state. This situation can be rectified by the
creation of another type of function call life cycle. This function call life cycle could contain a
single Data Entry queue where documents are moved during their own life cycles. Once the
actions are performed in this separate life cycle, the documents are moved back to their
original main life cycle to continue. This centralizes the documents to one queue, which allows
for easier logic and security maintenance. The diagram below demonstrates how a unified
view of the work that needs to be performed by the data entry personnel can be accomplished
across multiple life cycles operating on potentially different document types. In the diagram,
the dashed lines represent when the control is passed between the life cycles. In reality, the
documents never leave their starting life cycle until the end. These documents are added from
the Initial Queue in Application A and Application B to the Demographic Entry life cycle.
2012 Hyland Software, Inc.
168
OnBase 12 Workflow
Another option is to employ Keyword Type Groups, which allow OnBase to retrieve all the
keywords for a document with a single query. When using Keyword Type Groups you cannot
assign individual keywords to the Document Types. Once a Keyword Type Group is created,
changes can be made to add keywords to the group, but you cannot delete them.
Note: If there is an attribute for a value in an E-Form, and only the "" exist, the E-Form will
not work as intended in Workflow.
When an E-Form is used in Workflow and a button of type=submit has the value
OBBtn_Cancel, when clicked, the form is not submitted, the Last Execution Result is set to
False, and the entire task is aborted.
When an E-Form is used in Workflow and a button of type=submit has the value OBBtn_No,
when clicked, the form is not submitted, the Last Execution Result is set to False, but the Task
is not aborted.
2012 Hyland Software, Inc.
169
Workflow OnBase 12
In all Workflow interfaces except the Unity Workflow interface, users must be
granted the Retrieve/View privilege, either as a user group privilege or as an
override privilege. If this privilege is not granted (or in the case of override
privileges, overridden), users will not be able to view documents in Workflow. For
Configuration Module Configuration
more information on configuring user group rights, please see the System
Administration module reference guide or help files.
Caution: The ability to view documents in a life cycle is controlled at the queue level. If users
have rights to a Workflow queue, they will also have rights to view all the documents in that
queue by default, regardless of their security rights (i.e. Document Type rights). This includes
related documents.
Caution: The ability to modify a document in a life cycle is controlled at the queue level. If users
have rights to a Workflow queue, they will also have rights to modify all documents in that queue
by default, regardless of their Modify privilege setting, including related documents.
Administrators should be aware that Workflow automatically grants the Modify privilege to users
for any documents that are in their queue. As a result, care should be taken to only present
documents which users should be allowed to modify.
Note: To view or change Keyword Values or to re-index a document via the right-click menu,
you must have appropriate rights for modifying keywords or re-indexing. The re-index option
is not present in the Java Workflow interface.
There are also optional elements that can be used to further develop a life cycle. These
include:
Load Balancing Work (page 231)
Transitions (page 212)
Forms (page 219)
Notifications (page 221)
2012 Hyland Software, Inc.
170
OnBase 12 Workflow
Definitions
Actions
An Action is a task or process performed within the life cycle of a business process. Examples
of actions include moving a document to the next stage of the business process, adding a
keyword to a document or deleting a document from a life cycle. Once an action type is
selected, OnBase prompts you for the information necessary to complete the task. Any task
that you need the Workflow process to perform must be configured as an action.
Action Types
Action Types must be associated with every new action created. When a new action is added,
an Action Type drop-down list containing the action types available is displayed. Each action
type causes OnBase to perform a specific kind of task. Once you select an action type you can
specify any additional configuration required for that action type. The drop-down list of action
types is divided into groups, based upon what the action will do and what will be affected.
Note: Tasks can be executed on multiple items at the same time. To select consecutive items,
click the first item, hold the Shift key and click the last item. To select specific items, hold the
Ctrl key while clicking the items. The tasks you execute apply to the selected items.
Items
Items can be routed through a life cycle. Items consists of documents, WorkView objects,
managed folders, Agenda Items, Meetings, or Plan Review Projects. Only Unity Life Cycles
support the routing of all items. All other life cycles can only route documents. Unity Life
Cyles and the routing of all item types can only be configured in the Workflow Studio. Life
cyles configured in the Configuration module can only route the document item type.
Life Cycle
A life cycle or set of life cycles represent a business process that an item travels through. A
life cycle defines the steps that an item takes in a given business process. Each step or state
is represented by queues. Every time an item moves to a new step or state it is called a
transition. Essentially, a life cycle consists of a series of queues, transitions, actions and rules
that solve a specific business issue.
2012 Hyland Software, Inc.
171
Workflow OnBase 12
When an item enters a life cycle, all of the necessary work that must be performed for the
business process is performed on the item contained in OnBase. If the business process
changes, any procedural changes can be incorporated into the life cycle(s) configuration
immediately.
Configuration Module Configuration
Notification
A Notification is a message sent to a user or users during the Workflow process. The message
is sent via e-mail, either an internal or an external mail system. Notifications can be used to
alert administrators of potential problems with items or to inform a user of the status of a
item. The message can also include information specific to the item that triggered the
notification.
Queue
A Queue represents a step or state within a business process. A queue contains lists of tasks
that are executed on the items the queue contains and will vary from one queue to another.
Rules
A rule represents a decision in the business process. Examples of rules are "is the purchase
order amount over $10,000?" and "does the employee acknowledge and agree with the
performance review?".
A rule can evaluate to true or false and this determines what tasks are performed on the item
being routed through Workflow.
Rule Type
When you create a new rule you specify what it will evaluate by selecting a Rule Type. The
rule type drop-down select list divides the types into groups based on what they evaluate.
Once you select an rule type you can specify any additional configuration required for that
rule type.
Task List
A Task List is a series of actions and rules that are executed with respect to an item in a
queue, or the current item in OnBase. When a task list for an item is initiated, the task list is
executed on the item until the item transitions out of the queue that began the task list. A
task list is also referred to as work.
System Work
System Work is a rule, action or task list, created for a queue, that is executed as soon as an
item enters that queue. System work is always performed first, before user work or any other
tasks.
Note: When using a Core-based Workflow interface during any import process, it is highly
recommended that items be added to Workflow only during commit to minimize the impact on
performance. It is a best practice to add items to Workflow during commit.
2012 Hyland Software, Inc.
172
OnBase 12 Workflow
When designing a life cycle, system work should be utilized to perform any functions that do
not require user interaction.
Note: Re-indexing affects the way in which an item enters a life cycle, and therefore the
Note: System work that requires user interaction is not supported in the Core-based
interfaces. When using the Classic Client interface, it is not recommended to configure system
work that requires user interaction.
User Work
Note: This is legacy functionality. This is supported for systems that already have user work
configured.
The user initiates this work, which follows a specific sequence determined during
configuration.
Note: User work is not available in the Unity, Web Client, or Java Client Workflow interfaces.
Web/API Tasks
Note: This is legacy functionality and are no longer required to be configured separately from
standard ad hoc user tasks. These are supported for systems configured before the support of
ad hoc tasks in the Web Client.
This type of task list allows you to create tasks for the web-view task list that emulate
functionality available on the non web-based Client module.
Timer Work
A timer triggers a rule, action or task list at a specific point in time. A Workflow server
monitors queues with timers configured. Status of timers is monitored either by the OnBase
Client Workflow System Monitor or the Core Workflow Timer Service.
2012 Hyland Software, Inc.
173
Workflow OnBase 12
System Task
System Task allow you to execute a task list against a document that is not necessarily
associated with a life cycle. You must associate the system task with any document types on
which you want to execute the task.
Configuration Module Configuration
Note: System tasks are not supported in the Desktop Workflow and Java Web Client Workflow
interfaces.
Note: System tasks that require user interaction are supported in the Unity and Web
interfaces. System tasks that require user interaction are not supported in all other Core-
based interfaces. When using the Classic Client interface, it is not recommended to configure
system tasks that require user interaction.
These types of task lists differ by when the task is executed and which computer executes the
task on the document.
Note: The same task cannot be placed in both Ad Hoc User Tasks and Web/API Tasks folders.
Web/API tasks, however, can be a part of any other task list (including Ad Hoc task lists, User
Work, etc.)
Timers
Timers allow OnBase to execute rules or actions at a specific time. Timers can be configured
to execute periodically, after a certain amount of time, or at an exact point in time.
Transitions
A Transition, when used as a noun, refers to the path a document can take from one queue in
a life cycle to another queue. All of the transitions, taken together, define the paths that a
document can take during the business process performed by the life cycle. In the graphical
configuration, the transitions are seen as the arrows between the queues in the life cycle.
Transition is also used as a verb to describe the process of moving a document from one
queue to another. Actions, which transition documents, move the documents from one queue
of a life cycle to another queue in the life cycle.
User Form
A User Form is a customized form, designed using Hyper Text Markup Language (HTML) to
allow user interaction during a Workflow process. User forms can also be auto-generated for
actions that use HTML forms. A user form must be created outside the system before it can be
used within Workflow. Any user forms that are used in a Workflow process must be available
to all users of the Workflow process, from the same network location.
Note: The Web Workflow interface, Core-Based OnBase Client Workflow interface, and Unity
Workflow interface can accommodate user forms accessible by URL.
2012 Hyland Software, Inc.
174
OnBase 12 Workflow
The main difference between a user form and an E-Form is that the user form is not imported
into OnBase, and therefore, is not stored in the database. It is merely used as a placeholder
for keyword information.
Note: This is legacy functionality. This is supported for systems that already have user work
configured.
User Work is a task list that must be run by the user processing the documents in a queue.
This type of work differs from system work in that a user at a workstation initiates it. User
work is a series of rules and actions that walk a user through a series of activities. Through
questions or dialogs, the user is usually required to provide more information about the
document(s) to determine what course of action should be taken.
Web/API Task
Note: This is legacy functionality. Such tasks are no longer required to be configured
separately from standard ad hoc user tasks. These are supported for systems configured
before the support of ad hoc tasks in the Web Client.
A Web/API Task is an optional task that can be created for use with the web-based
application. This option allows you to create tasks for the web-view task list that emulate
functionality available on the non web-based Client module.
2012 Hyland Software, Inc.
175
Workflow OnBase 12
2012 Hyland Software, Inc.
176
OnBase 12 Workflow
The following right-click options are available from the System Tasks folder:
Option Description
The graphic layout toolbar can be used to configure certain aspects of the life cycle:
Button Description
To return to the Tree Configuration, click the close button on the Graphic Layout
window.
The Select button enables you to move the queue icons into position. This button
automatically activates when an icon is clicked.
2012 Hyland Software, Inc.
177
Workflow OnBase 12
Button Description
The Erase button enables you to remove transition arrows and queues. Click the button
and then click the object you want to erase.
Configuration Module Configuration
The New Queue button enables you to create a queue. Click the button and then click in
the graphic view window. Enter the queue name and select large and small icons in the
New Queue dialog box.
The New Transition button lets you draw a transition between queues.
The Zoom Out button widens the focus of the graphic view window.
The Grid On button displays grid lines (useful during the design process).
Tip: Hold down the Shift key and select one or more queues. This locks the selected queues,
enabling you to move them simultaneously. This functionality is helpful if you are adding new
queues to an existing life cycle.
Note: In order for a document to travel both directions between two queues, you need to
insert a transition in both directions.
2012 Hyland Software, Inc.
178
OnBase 12 Workflow
Life Cycles
Caution: Encrypted keywords are not supported in the Classic Client interface.
Adding
1. Right-click on the System Tasks folder in the Tree Configuration window, or right-click
on existing life cycle.
2. Click New Life Cycle. A folder, followed by a field, displays.
3. Type the name of the life cycle in the field.
Note: The maximum number of characters for a life cycle name is 50.
4. Press Enter.
5. In the Assign Life Cycle to User Group dialog box, select the user group(s) that will have
rights to this life cycle. When the Use Workflow Configuration Rights option is selected,
you must select the Execution Rights tab to assign user groups that will access
Workflow in the Client.
6. Click Close.
Note: The new life cycle appears in red until a queue has been added.
Once a new life cycle is created, add new queues, actions, and rules, configure the graphic
layout and complete the configuration of the life cycle.
2012 Hyland Software, Inc.
179
Workflow OnBase 12
Deleting
1. Right-click on the life cycle name and select Delete.
2. The Delete Confirmation box, displays. Click Yes to remove the life cycle from the
Configuration Module Configuration
Note: A life cycle cannot be deleted if documents exist in the life cycle.
Configuring
Once a new life cycle is created, half of the Tree Configuration window displays a configuration
section. In the upper right-hand corner of this section, the life cycle number is displayed.
Option Description
Life Cycle Help Text An optional description of the life cycle that displays in the User Work
window when viewing the life cycle in the Client module.
Initial Queue Specifies the queue that initially receives the documents into the life
cycle.
Work Folder An optional setting to select a dynamic Workflow folder for related
documents. This can be overridden at the queue level.
Note: Only folder types configured as Workflow folders will display for
selection in the Work Folder drop-down select list.
Make Available In This drop-down select list allows you to specify what interfaces the life
cycle is available in. You can select the Classic Thick Client
(Deprecated) option to only allow the life cycle to be available when
using the Classic View in the OnBase Client. You can select Core-Based
Interfaces to allow the life cycle to be available in all interfaces using
Core Services. Select Both for the life cycle to be available in all
interfaces.
Org Chart and Calendar This section allows you to configure Org Charts and Calendars for the
queue. See Org Charts and Calendars in Workflow Configuration on
page 695
Queue Sequence To change the queue sequence, select a queue and use the Move Up or
Move Down button to move the queue to the correct position. Click
Close to execute the changes.
2012 Hyland Software, Inc.
180
OnBase 12 Workflow
Option Description
Window Titles When any of the windows in the Client module share a docking position,
they have name tabs at the bottom. The default names are Document,
Note: Editing window titles in this area renames them for the entire life
cycle. Window titles can also be renamed at the queue level. The titles
set at the queue level take precedence over those set at the life cycle
level.
Icon An optional setting to represent life cycle(s) and queue(s) with bitmap
images. The larger icon represents the life cycle in the graphic layout;
the small icon is used in tree configuration. The Icon drop-down list
contains the SYS System Icons Document Types. The Small Icon drop-
down list contains the SYS System Bitmaps Document Types.
Apply Saves any changes made in the life cycle configuration section.
Clear Resets the Life Cycle Help Text box, Initial Queue and Work Folder
fields. It does not clear the settings to Queue Sequence, Window
Titles, or Icon.
2012 Hyland Software, Inc.
181
Workflow OnBase 12
If the main document has multiple values for a Keyword Type that is assigned to the working
folder, all documents that have either of the values assigned to it will be pulled into the
working folder as a related document. For more information concerning configuring folder
types, see the Folders documentation.
Configuration Module Configuration
Caution: If you give a user group rights to a folder type used as a Work Folder in Workflow, users
in that group will be able to view the document regardless of the rights they have for the
affected Document Type(s) in the Related Documents window except for the Classic Client
interface. This interface relies on user rights for Work Folder document display.
Once a folder type is configured appropriately, it must be associated with the life cycle. To
associate a folder type with a life cycle:
Note: When a Workflow folder type is associated with a life cycle, the folder type cannot be
deleted.
1. Configure the Document Handle system Keyword Type as a keyword on the Keyword
tab of the Folder Type used as a Work Folder.
2. Configure the Document Handle system Keyword Type as a keyword on your primary
document.
3. A Work Folder must be configured at either the Life Cycle or Queue level.
4. When you select the primary document from the Inbox all related documents
configured for the Work Folder will display along with any documents that have a
Document Handle that is entered as a value on the primary document in the
configured Document Handle system Keyword Type.
To query for related documents by their Document Handle when using rules and actions that
query for related documents using the relate by Folder Type option:
1. Configure the Document Handle system Keyword Type as a keyword on the Keyword
tab of the Folder Type used as a Work Folder.
2. Configure the Document Handle system Keyword Type as a keyword on your primary
document.
2012 Hyland Software, Inc.
182
OnBase 12 Workflow
3. Configure the Folder Type in the Related Document Query window of the rule or action.
4. When you select the primary document from the Inbox then execute the rule or action
all related documents configured for the Folder Type will be queried along with any
documents that have a Document Handle that is entered as a value on the Primary
Note: In the core-based interface, if you configure a folder to relate documents by Document
Handle and you configure the order of the documents to be determined by Document Type
Sequence, since all documents are listed, regardless of their Document Types, the documents
are ordered by the Document Type name.
2012 Hyland Software, Inc.
183
Workflow OnBase 12
1. In the Configuration module, right-click on the life cycle that you would like to create a
version of and select Create Life Cycle Version. The Select Life Cycle dialog box is
Configuration Module Configuration
displayed.
2. You can select multiple life cycles to create a version of at once. Move the appropriate
life cycles into the Selected box.
3. If you want to create a reference version of the selected life cycle(s), select Create
Reference Version.
If you want to create a working version of the selected life cycle(s), select Create
Working Version.
2012 Hyland Software, Inc.
184
OnBase 12 Workflow
4. Click Continue>>. The Choose New Life Cycle Names dialog box displayed.
Graphic Layout Opens the graphic layout configuration window for the selected
life cycle.
Create Configuration Report Creates a SYS Configuration Report that can be viewed in the
Client. This report lists a breakdown of all queues, Load
Balancing Work in Rules Based Load Balancing queues,
descriptions, help text, associated Document Types, and task
lists on a life cycle basis.
User Group Displays the Assign Life Cycle to User Group dialog box, and
allows for editing of the currently assigned user groups for that
life cycle.
Document Type Opens the Assign Life Cycle to Document Type dialog box
that allows you to assign Document Types to the select life
cycle.
Expand Tree Expands all life cycles, queue and task lists.
2012 Hyland Software, Inc.
185
Workflow OnBase 12
New Life Cycle Creates a new life cycle below the System Tasks Folder. Exit
and re-enter Workflow configuration and the life cycles are
Configuration Module Configuration
listed alphabetically.
New Queue Creates a new queue at the bottom of the list of queues for the
life cycle selected. Use the Queue Sequence button to reorder
the queues.
New System Task Creates a new system task at the bottom of the list of life
cycles.
Edit Comments Displays Comments field. You may type comments that display
when the mouse pointer rests on the life cycle name, in the
Configuration module. Edit comments is also available on
queues, system work, user work, rules, actions and transitions.
Queues
Adding and Deleting a Queue
In the Tree Configuration Window
Adding
1. Right-click the queue name and select Delete. Click Yes to proceed and the queue is
removed from OnBase. Click No and the action is cancelled.
2. If the queue is not in use elsewhere in the life cycle, a Delete Confirmation box
displays. If you answer Yes, the queue is deleted from OnBase. If you select No, the
queue remains in OnBase and can be selected from the drop-down list when another
queue is added to the life cycle.
Note: You cannot delete a queue if it contains documents or if documents associated with the
queue are in Document Maintenance. Documents must be removed from the queue or purged
from Document Maintenance before the queue can be deleted.
2012 Hyland Software, Inc.
186
OnBase 12 Workflow
1. To configure the graphic layout, right-click on the name of a life cycle and select
Configuring Queues
Standard Tab
When a queue is selected, the Standard tab on the queue configuration section displays.
2012 Hyland Software, Inc.
187
Workflow OnBase 12
Be sure to click the Save button before leaving the queue configuration section to keep your
settings.
Configuration Module Configuration
Parameter Description
Queue Name The queue name field is read-only. To change the name of a queue,
right-click on the queue name in the Tree Configuration window and
select Rename.
Description Optional area to add comments about the queues function. For
informational purposes only and is not displayed in the Client.
2012 Hyland Software, Inc.
188
OnBase 12 Workflow
Parameter Description
Help Text Optional area to add instructions, tips or any information that may be
useful to the users of this queue. This information displays in the User
Exclusive Document Permits only one user to view the document at a time. Another user can
Viewing retrieve the document through the Document Retrieval window, but not
through Workflow. A document that exists in multiple queues in
different life cycles that have this setting enabled will only permit the
document to be opened in one queue at a time. If the document lives in
two life cycles in two queues and if one queue has this setting enabled
and the other does not, the same document is available for viewing in
both queues by two different users.
Note: When this option is applied, documents open within the queue
cannot have a system task executed upon it from the document
retrieval hit list, the document viewer, or a folder.
Note: The Java Workflow interface does not support the Exclusive
Document Viewing locks.
Auto-Feed Documents Automatically displays the next available document in the viewer.
2012 Hyland Software, Inc.
189
Workflow OnBase 12
Parameter Description
Auto-Select Next
Document Note: This option applies to the Core-based Client interface.
Configuration Module Configuration
Available in Combined When this option is selected, the queue will be available for selection
View when configuring the Combined View.
2012 Hyland Software, Inc.
190
OnBase 12 Workflow
Parameter Description
Respect Security
Keywords Caution: This option is not supported in the Classic Client interface.
Hide Document Count If this option is enabled, the number of documents within the queue is
not displayed in the Client module. If it is disabled, the number of
documents within a queue is displayed. If no documents exist in a
queue, a zero will be displayed for the count.
Note: For the Web Client and Java Client, if the Web Servers
web.config file ShowQueueCounts option is set to true, it will not
override the individual queue's Hide Document Count setting. If
ShowQueueCounts is set to false, no queue counts will be displayed.
Disable Logging Every time a document enters or exits a queue, an entry is made in the
Workflow log. Checking this option disables the logging function.
Hidden Hides the queue in the Clients Tree View and Graphic Layout, even if the
user has rights to the queue.
2012 Hyland Software, Inc.
191
Workflow OnBase 12
Parameter Description
Override Document When the For Primary Document option is checked, allows users who
Modification Privilege do not have a modify privilege to modify a document and update its
Configuration Module Configuration
When the For Work Folder Documents option is checked, allows users
who do not have a modify privilege to modify a document and update its
keywords that is a document within the Work Folder within the queue.
Note: Users do not need access to the documents Document Type for
the override to apply.
Hide Queue Queue does not display in Client Tree View or Graphic Layout if a user
does not have rights to a queue.
Show Disabled Icon If a user does not have rights to the queue:
Queue and Icon display grayed out in the Graphic Layout of the
Client module. In some instances, a gray box will be displayed in
place of an icon.
The queue does not appear in the Clients Tree View.
When using the Web Client or OnBase Client Workflow interfaces
and the Workflow Queues or Workflow Locations dialog box is
accessed, the queue name will be displayed even if the user does
not have rights to the queue. When using other interfaces, the
queue name is not displayed regardless of this setting.
MRM Queue This option allows users access medical record charts residing in this
queue from the Medical Records Management (MRM) Web Client.
If this option is selected, then the queue is accessible from the MRM
Web Client. If it is disabled, then the queue is not accessible from the
MRM Web Client.
The MRM Web Client and medical record charts are available on systems
licensed for HL7 or the Medical Records Management Solution.
Type If MRM Queue is selected, then the queue can be used for Analysis,
Reanalysis, or Coding in the MRM Web Client.
If this queue will be used for deficiency creation (Analysis) or
confirmation (Reanalysis), or if it will be part of a Coding life cycle,
then select one of these options from the Type drop-down list.
If the queue should be available in the MRM Web Client but should
not be used for Analysis, Reanalysis, or Coding, then select
<None>.
See the Medical Records Management Solution module reference guide
for more information.
2012 Hyland Software, Inc.
192
OnBase 12 Workflow
Parameter Description
Coding Completion If Coding is selected as the MRM queue type, then the Coding
Queue Completion Queue option is available. Select this option if Coders
Click Save before leaving the queue configuration section to keep your settings. If you make
changes without clicking Save and go to another area in the tree view, the system displays a
Confirm prompt box asking you if you if you want to save before you move on.
2012 Hyland Software, Inc.
193
Workflow OnBase 12
Advanced Tab
When you click on each queue, an Advanced tab is available that provides queue level
configuration options.
Configuration Module Configuration
Queue Types
The Queue Type drop-down list is the first field in the Advanced tab. You may choose to skip
this setting, in which case the default setting of Standard prevails. The Configure button is only
active when Load Balancing is selected from the list.
Caution: Changing queue types clears information that is not required for the newly selected
type.
Standard
A Standard queue type has no special configuration. Users with access to a standard
queue can see and perform work associated with any of its documents.
2012 Hyland Software, Inc.
194
OnBase 12 Workflow
Note: If a Default user was configured for load balancing, certain configurations options will be
available. In these cases, the first document received in the queue will be assigned to the
Default user. The Default user will also be assigned documents that do not meet load balance
criteria configured for any of the other assigned users.
Select Load Balancing Queue and click Configure to assign one of these types:
Allocated Percentage Configuration. See page 195.
By Priority Configuration. See page 195.
In Order Configuration. See page 196.
Keyword Based Configuration. See page 196.
Match Keyword to User Name Configuration. See page 197.
Rules Based Configuration. See page 197.
Shortest Queue Configuration. See page 198.
Caution: The Administrator user should not be included as a load balancing member. By default,
the Administrator has rights to see all documents in a load balancing queue.
Note: If the sum of the percentage amounts is not equal to 100 when you save and close the
dialog box, a Confirmation Box displays, asking if you would like to exit. If you choose Yes, the
percentage of documents unaccounted for are not routed to a user/user group.
By Priority
By Priority distributes documents to users based on the priority assigned to documents.
Priority values are assigned to specific user groups.
2012 Hyland Software, Inc.
195
Workflow OnBase 12
3. Select the User or User Group from the drop-down select list.
4. Click Save.
5. Repeat steps 2 through 4 until all priority assignments are configured.
6. Click Close.
Configuration Module Configuration
In Order Configuration
In Order distributes documents to users in a specified order until all of the documents in the
system have been assigned. As additional documents enter the system, assignments continue
with the next member or group in the rotation.
Note: The Assign to Logged-in Users functionality is currently only supported in the Core.
4. The documents are routed to the User/User Groups specified in the Members
configuration. This is performed in alphabetical order.
Note: If no Default Recipient is defined, the document is assigned to the first user or user
group assigned to that queue.
Note: If the Keyword Type selected above is configured as an Alphanumeric Data Type, the
Operator drop-down box defaults to = and cannot be modified. However, if the Keyword Type
selected above is configured as a Numeric Data Type, the Operator drop-down list allows you
to choose an operand.
Note: Regardless of the workstations regional settings, values entered for Currency Data Type
Keyword Types will be stored as a decimal value with two decimal places. For example, if 11 is
entered as a value, 11.00 will be stored.
5. Select a User or User Group from the last drop-down list. This indicates who receives
the document based on its Keyword Value.
2012 Hyland Software, Inc.
196
OnBase 12 Workflow
Caution: In order for proper document assignment, do not configure the same load balancing
criteria for more than one user or user group.
Note: Configure a keyword for user name before applying this queue type.
Note: Assigning User Groups to the load balancing Match Keyword to User Name queue type is
not supported.
Note: Users configured as members for load balancing in this queue type will always appear in
Load Balancing Administration regardless of the number of documents assigned to them.
1. Select Match Keyword to User Name in the Assignment Type drop-down list.
2. Click the Configure button.
3. Select the user name Keyword Type from the Keyword Type drop-down list in the Match
Keyword and User Name window.
Rule Based Configuration
Rule Based configuration allows you to configure Load Balancing Work within the load
balanced queue. In addition, the following actions can be used to administer the queue:
SYS - Assign Related Document to User
SYS - Assign to User
SYS - Remove All User Assignments
SYS - Remove All User Assignments from Related Documents
SYS - Remove User Assignment
SYS - Remove User Assignment from Related Document
Note: The Assign to Logged-in Users functionality is currently only supported in the Core.
2012 Hyland Software, Inc.
197
Workflow OnBase 12
3. Click Save.
Note: If there is no Load Balancing Work configured for the queue, nothing occurs when
Configuration Module Configuration
Rebalance is selected.
For more information about configuring Load Balancing Work, see Configuring Load Balancing
Work on page 231.
Shortest Queue Configuration
Shortest Queue initially assigns documents to users one by one in an orderly fashion. As
additional documents enter the system, assignments are made to the user with the fewest
unprocessed documents that is encountered first by the system.
Note: The Assign to Logged-in Users functionality is currently only supported in the Core.
Configure Members
1. Activate the Members drop-down list by choosing Load Balancing Queue in the Queue
Type drop-down list.
2. Select Users, User Groups, or Roles from the Members drop-down list.
Caution: When configuring a Match Keyword to User Name load balancing queue, only the Users
option is supported.
Note: Some window titles and field names display User, User Groups, or Roles, depending on
which member type you choose.
Note: The Coverage tab is not available when Roles or User Groups is selected.
Note: When Roles is selected, the Load Balancing Queue Assignment Type is automatically set to
Rules Based.
2012 Hyland Software, Inc.
198
OnBase 12 Workflow
5. From the Default Recipient drop-down list, select one of the Users/User Groups/Roles to
receive the initial document when the life cycle is turned on. Documents that cannot
be assigned to a specific user (or Role) will be assigned to the default user. If you do
not want these documents to automatically be routed to a specific user, select
Note: Rules-based load balancing will always place documents in the <Unassigned> state if
they fall outside of the configured assignment logic.
6. If you want to specify a Keyword Type that will contain the user, user group or role
assignment, select the appropriate Keyword Type from the Keyword to Hold Assignee
drop-down select. Upon assignment, the Keyword Types value will be populated with
the assignment.
Note: If this is configured in conjunction with Match Keyword to User Name load balancing
queue type, the Keyword Types value will not be populated with the assignment.
7. If Users is selected for the Members drop-down list, a Role Selection button is available.
This button allows you to assign users based on their roles. For more information, see
Configuring Role Selection on page 200.
8. Click the Save button.
Caution: When editing the Members drop-down lists setting, a message stating Changing the
member type will delete all configuration information for the previous type. Change anyway? is
displayed. After clicking Yes, the previously configured Members setting and configured members
are cleared and the change made to the drop-down list setting is saved.
2012 Hyland Software, Inc.
199
Workflow OnBase 12
1. In the queues Advanced tab, select Users from the Members drop-down list, then click
Configuration Module Configuration
the corresponding Configure button. The User Selection dialog box is displayed.
2012 Hyland Software, Inc.
200
OnBase 12 Workflow
2. Click Role Selection. The Assign to Load Balancing Queue dialog box is displayed.
Note: Users can be removed from the User Selection dialog box and the role(s) they belong to
will retain assignment settings.
Removing Members
If you remove a member to which documents are currently assigned, a message is displayed
stating There are currently document assignments related to this user group/user/role. Are you
sure you want to remove the user group/user/role? Click Yes to remove the member. Click No if
you do not want to remove the member. If you removed members that had document
assignments, assignments will be removed upon clicking Save.
Removing Users from a User Group Who are Members
If you remove a user from a user group who is currently a member of a load balancing queue
and has documents assigned, a warning will display upon removing the user from a user
group. This warning states The user is a load balancing queue member and has documents
assigned. User may lose access to these documents if removed from the group. Are you sure you
want to continue? Click OK to remove the user. Upon removal, the following occurs:
2012 Hyland Software, Inc.
201
Workflow OnBase 12
All documents assigned to the removed user are reassigned to the default user (if
configured) or to <Unassigned>.
All Load Balancing information (Allocated %, Keyword-based, etc.) for the removed
user is removed.
Configuration Module Configuration
The user is removed from all drop-down lists in the Load Balancing configuration
dialog boxes and from the Load Balancing tree in the Client.
Work Folder
Folders are used to contain supporting documents for the main document passing through the
life cycle. As a simplified example, a folder for an accounts payable life cycle could contain
purchase orders and vendor invoices to help users compare the quantity ordered on the
invoice against the quantity ordered on the purchase order.
Note: When selecting a work folder from the Work Folder tab, a context menu will only be
available when a document from that folder is selected.
The Work Folder drop-down select list contains folder types to which you have been granted
rights from the User Groups/Rights submenu under the User menu in the configuration menu.
If you have configured a folder for this queue, select it here. Configuring folders is discussed
in detail in the Configuration help files.
Note: Only folder types configured as Workflow folders will displayed for selection in the Work
Folder drop-down select list.
Folders used within Workflow must have dynamic foldering configured and be set for Workflow
in the Usage section for the Folder Type Settings tab.
2012 Hyland Software, Inc.
202
OnBase 12 Workflow
Default Template
A template filters a folder of related Document Types. Apply a template to search for specific
Keyword Values and display a subset of the folder contents.
The Default Template drop-down list contains templates that have been configured in OnBase.
If you have configured a template for this queue, select it here. Configuring templates is
discussed in detail in the Configuration help files.
Note: In order for the Inbox Refresh Rate feature to function in the Core-based Client interface,
the Refresh tree counters Workstation Option must be selected.
2012 Hyland Software, Inc.
203
Workflow OnBase 12
Sort Options
The Sort Documents By section allows you to set the display order for entries in the Document
window in the Client module.
Configuration Module Configuration
Document Handle Documents are sorted on the unique document identifier that was
stored when the document first entered the system.
Document Name Documents are sorted on the configured Auto-Name string for the
Document Type, in ascending order.
Document Date Documents are sorted by the document date, in ascending order.
Entry Time Documents are sorted on the date of entry to the queue (arrival time),
in ascending order.
Priority Documents are sorted based on the priority value that is assigned.
When sorting ascending, 1 would be the highest priority and at the top
of the list, while 999 would be the lowest priority. When sorting
descending, 999 would be the highest priority and at the top of the list,
while 1 would be the lowest priority.
Sort Descending When enabled, sets the sort order of the selected sort type (Document
Handle, Document Name, Document Date, Entry Time, or Priority) to
descending, instead of the default (ascending) order.
Window Titles
The Window Titles button calls the Tab Name Configuration dialog box. This box allows you to
rename the tabs on the Workflow Inbox windows, which by default are labeled Life Cycle View,
Document, User Interaction, and Work Folder.
To change a window title:
1. Select the window you would like to change from the Window drop-down list.
2. Type a new name over the text in the New Window Title drop-down list and click the
Save button.
3. Repeat steps 1 and 2 to change other window titles.
4. Click Close.
To delete a window title:
1. Select the window title to delete from the New Window Title drop-down list and click
the Delete Title button.
2. A Confirmation box displays, informing you that any windows currently using that title
will reset to their default title. Click Yes to continue or No to leave the title unchanged.
3. Repeat steps 1 and 2 to delete other window titles.
4. Click Close.
2012 Hyland Software, Inc.
204
OnBase 12 Workflow
User Privileges
In the User Privileges dialog box, you can assign users rights to administrative functions.
To open the User Privileges dialog box, click User Privileges on the Advanced tab.
2012 Hyland Software, Inc.
205
Workflow OnBase 12
Within this dialog box, you can assign the following privileges:
Privilege Description
Configuration Module Configuration
Load-Balancing Administration Grants access for selected user to the Load Balancing
Administration dialog box and the functionality contained within
this dialog box.
See Other Users Documents Grants access to the See Other User's Documents queue right-
click menu.
Note: Users can also view other users documents if they are
Administrator users, or members of a group that has the
Workflow Administration right.
Execute System Work Grants access to the Perform System Work queue right-click
menu.
Execute Timer Grants access to the Execute Timer Work queue right-click
menu.
Ad hoc Routing Grants access to configured ad hoc tasks and the Route
Document right-click menu. For ad hoc routing, the queue must
have transitions configured.
Override Auto-Feed Grants users the right to view all documents in a queue
configured with the Auto-Feed Documents setting by granting
access to the Show All Documents right-click menu for queues
configured for Auto-Feeding Documents.
Note: These privileges are assigned on a per user or per User Group, per queue basis.
1. Rights can be granted to a user or a User Group. You can display the User Groups
currently assigned to the queue by selecting the User Groups with Rights to the Queue
option. You can display users currently assigned to the queue by selecting the Users
with Rights to the Queue option.
2. Select the appropriate user or User Group.
Note: User names are followed by the configured real name in parenthesis.
To remove a user, select the user from the list of configured users and click Remove.
2012 Hyland Software, Inc.
206
OnBase 12 Workflow
If you want to edit an existing configuration, select the user, add and/or remove privileges,
and click Save.
Filters Tab
Note: Work folder filters are configured at the folder level. In order for filters to be available in
the client, filters must be configured at the folder level. See the folders documentation for
more information. This is only available in the Core-based OnBase Client user interface.
2012 Hyland Software, Inc.
207
Workflow OnBase 12
Assigned Filters
The Assigned Filters box contains a list of all filters that have been selected for use with the
queue. A filter can be removed from the list by selecting it and clicking Remove. Only the
custom queries configured as a Workflow Filter that are assigned to the queue and that the
Configuration Module Configuration
user has permission to are displayed for selection when Filter Inbox is displayed.
Available Filters
The Available Filters drop-down select list contains all custom queries that can be used as a
filter for Workflow. This drop-down select list is only enabled when the Use only selected filters
option is selected. These custom queries are those that are configured with the Workflow Filter
option. To add a filter to the Assigned Filters box, select it from the drop-down select list and
click Add.
Default Filter
The Default Filter drop-down select list allows you to select a query to use as a default filter for
the selected queue. If the Use only selected filters option is selected, only those filters will be
available in the Default Filter drop-down for selection, otherwise, all available custom queries
configured as Workflow Filters that the user has permission to will be available. Custom
queries that are configured with the Workflow Filter option selected in the Custom Query
Options dialog box are available in this drop-down select list.When a default filter is selected,
the queue is automatically filtered and the documents displayed reflect that filter's
specifications. If you choose a filter from the Filter Inbox right-click option, it will override the
selected default filter and the display will reflect the newly chosen filter.
If you select Display HTML Form used by Filter, the HTML form associated with the filter will
display when the queue is selected in the Client module, allowing you to specify search
criteria by which the inbox can be filtered. If you cancel a default filter, the filter will be
applied with no Keyword Values specified.
Note: If you use a default filter in conjunction with Use Persistent Filters option in Workstation
Options, the default filter will be ignored in the OnBase Client. In the Desktop, the default
filter will override the persistent filter. The use of persistent filters in the Desktop is initiated
by right-clicking in the Document window and selecting Filter Inbox | Use Persistent Filters.
Persistent filters are not supported in the Web or Java Web Clients.
Note: Use caution when using a filter with a queue configured with the Auto-Feed Documents
option. Ensure that the desired filter will not prevent documents from displaying for any user.
Note: If the user selects Filter Inbox while the inbox is displaying the combined view, all of the
custom queries configured as a Workflow Filter that the user has permission to and are
assigned to each queue within the combined view are displayed.
Note: When a filter has Workflow Queue configured as a display column and the Combined
View is not showing, the filter applied will not show results related to the currently selected
queue.
2012 Hyland Software, Inc.
208
OnBase 12 Workflow
Monitoring Tab
The Monitoring tab provides access to features that monitor queue document counts.
Queue Watermarks
Watermarks can be set to help monitor how many documents are in a queue at any given
time. These watermarks are user-configured integers which help clarify the movements and
quantity of documents in any queue.
To configure watermarks:
2012 Hyland Software, Inc.
209
Workflow OnBase 12
Entries will be made to the Workflow log under the following circumstances:
A document enters the queue (i.e., the queue count is increasing) and the document
count reaches the Low Watermark. (Warning or Alert)
Configuration Module Configuration
A document enters the queue (i.e., the queue count is increasing) and the document
count surpasses the High Watermark. (Warning or Alert)
A document leaves the queue (i.e., the queue count is decreasing) and the
document count reaches the High Watermark. (Warning or Alert)
A document leaves the queue (i.e., the queue count is decreasing) and the
document count goes below the Low Watermark. (Warning or Alert)
The watermarks should be configured so that the High Watermark > Low Watermark >= 0. It
is not necessary to enable and configure both watermarks.
Note: Watermarks take into account all transition and moving of documents except for
deleting and undeleting documents. If a watermark point is met by deleting or undeleting a
document, (e.g., via Document Maintenance or deleting a document from a Document Search
Results list), an entry will not be made in the Workflow log.
Note: The Use Watermarks options are also used for Business Activity Monitor functionality.
Note: The Document Age and Monitor Keyword Sum options are used by the Workflow
Dashboard and Workflow Process Statistics StatusView portlets. These settings provide
default setting for those portlets. See the StatusView documentation for further information
regarding these settings.
Icon Tab
2012 Hyland Software, Inc.
210
OnBase 12 Workflow
Click the Icons tab to select an icon to symbolize the queue in the Graphic Layout and in the
Tree Configuration window. This is an optional setting.
Note: The default representation of a queue in the Graphic Layout for the Web Client Workflow
is a notebook.
Note: Icons are only available after they have been stored in the SYS System Icons and SYS
System Bitmaps Document Types.
2012 Hyland Software, Inc.
211
Workflow OnBase 12
Add Load Balancing Work This option is only enabled for Rules Based load balancing queues.
Once load balancing work has been added to a Rules Based queue,
this option is no longer enabled. See Adding Load Balancing Work on
page 231 for more information.
Delete Removes the reference to the queue from that portion of the life
cycle or from the life cycle entirely, depending on the user response
to the Queue <name> is no longer in use. Destroy permanently?
prompt box.
User Group Displays the Assign Work Queue to User Group dialog box, and
allows for editing of the currently assigned user groups for that
queue.
Edit Comments Enables editing of the contents of the comment field stored for that
queue. Comments display when the mouse pointer rests on the name
of the queue in the Workflow Configuration tree.
Rename Allows the name of the queue, as it appears in the Workflow tree, to
be edited. All occurrences of the queue within the same life cycle will
be renamed.
Expand Tree Causes the contents of the queue (i.e., any rules, actions, or tasks
defined for the queue) to be fully displayed in the tree.
Transitions
For the life cycle to route documents manually, queues must be configured with transitions.
Transitions can either be added in the Graphic Layout or in the Tree View.
2012 Hyland Software, Inc.
212
OnBase 12 Workflow
Deleting
Configuring
Once a transition is drawn, a Transition Configuration dialog box displays.
Item Description
Deleting
1. Right-click on the transition name and select Delete.
2. Click Yes to proceed and the transition is removed from the system. Click No to cancel.
2012 Hyland Software, Inc.
213
Workflow OnBase 12
To use these options, first create the transition action in the life cycle, and then create the
pre- or post-transition task list. The task list is performed before system work on a pre-
transition and after the system work on a post-transition.
Configuration Module Configuration
Option Description
Add Pre-Transition Task Adds a task list to be executed before the transition is executed.
List
Add Pre-Transition Test Adds a rule, which is evaluated before the transition takes place. If
the rule evaluation returns false, the transition is cancelled. If the
rule evaluation returns true, the transition proceeds. This test
ensures that a transition is allowed to proceed out of the queue.
Add Post-Transition Task Adds a task list that is to be executed when the transition completes.
List
Note: This task list is executed after the system work in the
destination queue is performed.
Edit Comments Displays the Comments dialog box. Comments pop up when the
pointer is held over the transition name in the Tree Configuration.
Rules
Adding
1. In the Tree Configuration window, right-click the task list to which you are going to add
the rule.
2. Select New Rule.
3. Type the name of the new rule in the field. If you have previously added rules, a list
allows you to select an existing rule; however, if you make changes to the rule, they
take effect everywhere that rule exists.
4. Press Enter.
Note: The rule name displays in red until a rule type has been selected.
2012 Hyland Software, Inc.
214
OnBase 12 Workflow
Deleting
1. Right-click the rule name and select Delete.
2. Click Yes to proceed and remove the rule from the system. Click No to cancel the
Configuring
Option Description
Disable Allows you the flexibility of turning off a rule without deleting it. A rule in a
disabled state appears grayed-out. The rule can be reinstated, without
reconfiguring, by re-selecting this box.
Enable Debug Used for determining the location of logic problems in a Workflow configuration.
Breakpoint Causes a message box to display before the execution of the rule.
To use this option in the OnBase Client, you must have the WFTRACE switch on
the command line of the Client module and the Step Debug toolbar button or the
Debug Window open in the Client module. A command line switch is not required
to use this option in the Unity interface.
Note: This option is only supported in the Classic Client, Core-based client, and
Unity interfaces.
Log Execution When this check box is selected and the rule is executed, an entry is made into
the system's database. If the rule is disabled when an entry is made, it will be
logged in the system's database that the rule was disabled at the time of
execution.
On Failure All rule types allow you to configure what happens when the rule fails. Click On
Failure to display the On Failure dialog box.
Show Message on Failure: Allows you to display a message when the rule fails.
Activates the Help Text box.
Help Text: Text message that displays when the rule fails.
Override User Group: Specifies members of a user group that have the ability to
override the failure of a rule.
Override Key Type: Only has meaning if the Override User Group field is
configured. Allows selection of a Keyword Type in order to save the users
response to the override as a keyword. This lets you distinguish documents that
succeed on the rule from those that succeed on an override of the rule.
2012 Hyland Software, Inc.
215
Workflow OnBase 12
The remaining information necessary to configure a rule depends on the rule type selected.
Since many of the rule types have the same configuration requirements, the rule field
configuration is grouped by rule type, followed by a description of the related rule fields.
When configuring a rule, you can click on the Rule Type drop-down select list and type the
Configuration Module Configuration
name of the rule you want to use. Typing the name of the rule will select the rule in the drop-
down select list.
For more information about rules, see Rules Descriptions.
Note: Rules that have been added, but not assigned a rule type, appear in red in the tree
configuration view. If a rule is not fully configured, processing is aborted. In some situations,
rules not fully configured may return a false result if the value is determined before the
missing configuration information is encountered.
Option Description
Delete Removes the reference to the rule from that portion of the life cycle or from the
workflow entirely, depending on the user response to the Rule is no longer in use.
Delete permanently? prompt box that appears.
Edit Enables editing of the contents of the comment field stored for that rule. Comments
Comments display when the mouse pointer rests on the name of the rule in the Workflow
Configuration tree.
Rename Allows the name of the rule, as it appears in the Workflow tree, to be edited. All
occurrences of the rule within the same workflow will be renamed.
Copy Saves a duplicate of the rule in memory, allowing the rule to be pasted into other
queues or life cycles.
2012 Hyland Software, Inc.
216
OnBase 12 Workflow
Option Description
Expand Tree Causes the contents of the rule to be fully displayed in the tree.
Adding
1. In the Tree Configuration window, right-click on any task list within the queue to
receive the new action.
2. Select New Action. A field or drop-down select list for that entry displays. A drop-down
select list only displays if other actions have been configured for this queue.
3. Type the name of the new action in the field or select an existing action from the drop-
down select list.
4. Press Enter.
Note: The action name displays in red until an action type is configured.
Deleting
1. Right-click on the action name and select Delete.
2. Click Yes to remove the action from the system. Click No to cancel the action.
3. In the Confirm box, select Yes to delete the action permanently or No to delete the
action but keep it available on the drop-down select list for future use.
Configuring
Once you have added a new action, and while the action is selected, the right side of the Tree
Configuration window displays an action configuration section.
Option Description
Disable Allows you the flexibility of turning off an action without deleting it. The action can
be reinstated, without reconfiguring, by deselecting this box. An action in a disabled
state appears grayed-out.
2012 Hyland Software, Inc.
217
Workflow OnBase 12
Option Description
Enable Used for determining the location of logic problems in a Workflow configuration.
Debug Causes a message box to display before the execution of the rule.
Configuration Module Configuration
Breakpoint
To use this option in the OnBase Client, you must have the WFTRACE switch on the
command line of the Client module and the Step Debug toolbar button or the Debug
Window open in the Client module. A command line switch is not required to use
this option in the Unity interface.
Note: This option is only supported in the Classic Client, Core-based client, and Unity
interfaces.
Log When selected and the action is executed, an entry is made in the database. If the
Execution action is disabled when an entry is made, it will be logged in the OnBase database
that the action was disabled at the time of execution.
The information necessary to configure an action depends on the action type selected. Choose
an action type from the Action Type drop-down select list in the configuration section.
When configuring an action, you can click on the Action Type drop-down select list and type
the name of the action you want to use. Typing the name of the action will select the action in
the drop-down select list.
Note: Actions that have been added, but not assigned an action type, appear in red in the tree
configuration.
2012 Hyland Software, Inc.
218
OnBase 12 Workflow
Add Pre- Allows for the configuration of a rule that the action is conditional upon. Select Pre-
Action Test Action Test and a new rule is created.
Delete Removes the reference to the action from that portion of the workflow or from the
workflow entirely.
Edit Enables editing of the contents of the comment field stored for that action.
Comments Comments display when the mouse pointer rests on the name of the action in the
Workflow Configuration tree.
Rename Allows the name of the action, as it appears in the Workflow tree, to be edited. All
occurrences of the action within the same workflow will be renamed.
Copy Saves a duplicate of the action in memory, allowing the action to be pasted into
other queues or life cycles.
Forms
Note: For Keyword Values to be added, the Keyword Types configured on the user form must
be assigned to the active document in Workflow.
Adding
1. Select Workflow | User Forms. The User Forms dialog box displays.
2. Select the life cycle for which the form will be added from the Life Cycle drop-down list.
Note: Only life cycles for which you have configuration rights will be available for selection.
3. Type the name for the form in the field below the Form Name list.
4. Click Save.
Configuring
Note: User forms are created in the same manner as E-Forms. For more information about
creating a user form, see the E-Forms documentation.
2012 Hyland Software, Inc.
219
Workflow OnBase 12
4. Type the file path in the Form Location field or click Browse, select the file and click
Open.
Tip: Use UNC paths to the file because drives are not always mapped to the same letter on
Configuration Module Configuration
Note: If you are using Distributed Disk Services, see the Distributed Disk Services
documentation for more information about constructing appropriate paths.
Note: The instance number must be in place, even if there is only one instance. Without the
instance number, the form field will fail and the property will not be input into the property
bag.
Note: This form field applies only to user forms. If it is used on an E-Form, no action will be
taken on any data input into the form field. E-Form fields configured in the above format will
need to be changed to continue to function properly in Workflow.
Configure
An alternative to a user form that is accessed via a UNC path is to use an HTML form via URL.
This configuration is only supported for Core-based user interfaces. The Classic Client
interface does not support this configuration. Follow these steps to configure a user form that
is accessible via URL:
2012 Hyland Software, Inc.
220
OnBase 12 Workflow
3. The Form Name list displays all the forms currently available for that life cycle. Type a
name from your new form in the field below this list and click Apply.
4. With your new form selected in the Form Name list, click Configure.
5. In the User Form Configuration dialog box, type in the URL of the form you wish to use,
Note: The form is configured for use in the same way as a standard user form, however,
OnBase must pass an obTarget parameter to the form. This can be accomplished by
embedding script in the form to retrieve this parameter and set the forms action attribute.
Whenever the user submits a form, the form needs to be directed back to the Workflow
interface for further processing. The form must programmatically retrieve the value of a
querystring parameter called obTarget and set the action attribute of the form to this value.
The following is an example using JavaScript in the HTML page's OnLoad event:
document.forms.item(0).action = location.search.split("obTarget=")[1];
E-Forms are also utilized in Workflow when using certain form actions. These differ from user
forms in that they must be imported into OnBase and the system must be licensed for the E-
Forms module.
Deleting
1. Select the Workflow | User Forms. The User Forms dialog box displays.
2. Select the life cycle from which you are removing the form from the Life Cycle drop-
down list.
3. Select the name of the form in the Form Name list.
4. Click Delete. A Delete Confirmation box appears.
5. Click Yes to delete this form from the life cycle. Click No to cancel.
Note: If the form is in a life cycle, it will not be deleted until it is no longer in use.
Notifications
Note: In the Web Client, the IIS Admin and World Wide Web Publishing services must be run
using a network user account in order for external notifications to execute correctly in
Workflow.
2012 Hyland Software, Inc.
221
Workflow OnBase 12
Adding
1. Select Workflow | Notifications. The Workflow Configuration-Notifications dialog box
displays.
Configuration Module Configuration
2. Select the life cycle to which you are adding the notification from the Life Cycle list box.
The notifications created for that life cycle populate the Notification Name list.
Note: Only life cycles for which you have configuration rights will be available for selection.
Note: If <None> is selected, the notification will be available across all life cycles.
3. Type the name of the new notification in the text box below the Notification Name list.
4. Click Apply to add the notification to the Notification Name list.
Deleting
1. Select Workflow | Notifications. The Workflow Configuration-Notifications dialog box
displays.
2. Select the life cycle containing the notification from the Life Cycle list box. The
notifications created for that life cycle populate the Notification Name list.
Note: Only life cycles for which you have configuration rights will be available for selection.
Configuring
1. After a notification has been added to a life cycle, select the notification in the
Notification Name list and click the Configure button. The Notification Configuration
dialog box displays.
2. In the Subject field, type a name for the notification. You can also include keywords as
well as keyword symbols that are described in the table below.
2012 Hyland Software, Inc.
222
OnBase 12 Workflow
3. In the Message field, type the message to be sent. You can include keywords and
keyword symbols in the Message field. Click inside the field and either type the symbol
or click the symbol's button from the right side of the dialog box to add the symbol.
Note: If you want to include the percent sign (%) in notification text, you must place two
percent signs (%%) to represent that percent sign. If only one percent sign is entered, the
percent sign will not display in the notification text.
Note: Links can be configured for a Life cycle and Queue, or Life cycle, Queue, and document,
but not just a Life cycle.
Symbol Description
Note: This symbol is only applicable when used with an Institutional Database.
%C Displays the name of the user who created the current document.
%D1 Displays the date that the document was stored. This value cannot be changed.
%I1 or %T Displays the time that the document was stored. This value cannot be changed.
%K###.n Displays the Keyword Value of Keyword Type ### n times. For example, %K101.4
would display up to 4 unique Keyword Values for Keyword Type 101 for a single
document.
For some functionality, a Keyword Type drop-down list may be available to
configure this. Select a Keyword Type from the drop-down select list, enter the
number of times you want the Keyword Value to be displayed in the Repeat field,
and click Keyword. The value in the Repeat field specifies how many instances of
the Keyword Value will be displayed. Entering an * character will pull all existing
Keyword Values for display up to 99 instances.
Note: When using the Classic Client interface, double digits in the Repeat field are
not supported.
2012 Hyland Software, Inc.
223
Workflow OnBase 12
Symbol Description
%M Extracts metadata values from items. This includes attribute values from Workview
objects or a field values from an Entity item.
Configuration Module Configuration
%M must be followed by the metadata value you want to extract. For example, if
you want to extract the value of a WorkView attribute called Name, it would be
%MName.
The token strings can contain nested expressions. Example, a nested WorkView
attribute: %MVendor.Buyer.Name.
%R Displays the real user name (if configured) of the user who created the current
document. If a real user name is not configured, a blank space will be displayed.
%U Displays the user name of the currently logged in user who executed the task.
%V### Displays the value of a configured Workflow property. For example, to display the
value for the property Color, this symbol would be configured %VColor.
Note: If a property name has spaces, using %V to display the property value alone
will not preserve the spaces, and therefore, the property will not be correctly
identified. When %V is used with a property name containing space in conjunction
with a formatting code, the property will be identified. %C(VProperty Name) would
be an example of property with spaces that will be identified correctly with the first
letter capitalized. This formatting option are available for the following actions:
Prompt User with Question Box/SYS - Prompt User with Question Box, Create Note/
Doc - Create Note on This Document/Related Document, Display Message Box/
Notify - Display Message Box, and Custom Log Entry/SYS - Custom Log Entry.
The following symbols are not supported in the Classic Client interface:
%L [life cycle ID]
%L2 [life cycle name]
%Q [queue ID]
%Q2 [queue name]
%M [item metadata value] is not supported in the Classic OnBase Client interface or the
Core-Based OnBase Client interface.
2012 Hyland Software, Inc.
224
OnBase 12 Workflow
4. Use the Keyword Type drop-down list to add a keyword to the message. The Keyword
Itemnum number is displayed in parenthesis next to the Keyword Type name. If the
keyword type has multiple values on a document, specify the number of occurrences
of the keyword value by entering a value in the Repeat field. You can choose to format
Note: In order for the checksum to work correctly, the web.config file must have DPCheckSum
set to true. For more information about DocPop, see the DocPop Module Reference Guide.
8. Select Recipients to configure who receives the notification when it is sent. A Recipients
for [notification name] dialog box displays, showing you who is currently configured to
receive the notification.
9. Different types of recipients can be configured for a notification from the Type drop-
down select list:
Address: allows you to specify an External mail e-mail address to be used for the
notification.
Keyword Type: takes the value of that Keyword Type on the current document, and
uses that as the address to send the notification. The Keyword Value could be a user
or an external mail address, if your system has external mail enabled. The Keyword
Value can contain multiple addresses, separated by a comma or a semicolon.
2012 Hyland Software, Inc.
225
Workflow OnBase 12
Load Balancing Members: when selected, a drop-down select list containing all of the
load balancing queues in the system displays. Adding a queue assigns the load
balancing user group(s) to the recipient list. For external notifications, if the user
that is assigned to the document (or to all members of the user group that
Configuration Module Configuration
document is assigned to) in the Client has an e-mail address configured (select Users
| User Names/Passwords and click Settings), an e-mail will be sent to the specified
address.
Note: Queues configured as Match Keyword to User Name queues are not in the list of available
queues in the drop-down select list.
Role Members: when selected, a drop-down select list containing configured roles in
the system is displayed for configuration.
Note: The Role Members recipient option is not supported for the Classic OnBase Client User
Interface.
Caution: Extra characters, such as '[', ']', '<', '>', will cause notifications to not be sent properly.
Using prefixes such as "mail:" and "fax:" before e-mail addresses will cause notifications to not
be sent properly.
10. To send the notification internally, you must select the Internal mail option before
clicking Add.
Note: When sending internal notifications, if no keyword on the notification is a valid OnBase
user name, the notification will not be sent. This will happen even if a valid e-mail address is
present.
To send the notification externally, select the External mail option before clicking Add.
Note: When sending an external notification, an e-mail address must be present for the
notification to be sent. OnBase will not attempt to match e-mail accounts with internal user
names. However, OnBase will attempt to match internal user names with e-mail accounts.
To send the notification both internally and externally, select Both Internal and External
before clicking Add.
Note: After a system upgrade, if recipients were previously configured, the Mail Type may be
displayed as Not Configured. The users mail type must be updated. To update the mail type
used for a user, select the user, select the appropriate mail type radio button, and click
Update Mail Type. If the mail type is not updated, the recipients will be handled in the
following way: User and User Group notifications will be sent as internal mail; Address
notifications will be sent as external mail; load balance queue recipients will retain the
Internal or External setting as previously configured; Keyword recipients will first try to
resolve the value as an internal user and if found, an Internal notification is sent. If a valid
OnBase user is not found, an attempt is made to resolve the value with an e-mail account and
send it externally.
2012 Hyland Software, Inc.
226
OnBase 12 Workflow
11. Once a type has been configured, click Add. Multiple types of recipients can be
combined, allowing the notification to be sent to everyone in a user group, a user who
is not in that group, a user name or address specified in a Keyword Value or any
combination of these by repeating steps 9 through 11 for each type required. If a
Note: If an invalid e-mail address/distribution list is included for an external notification, the
invalid addresses are ignored and the e-mail is sent to any valid addresses/distribution lists.
To remove a recipient from a notification, select the name of the recipient in the list or
the appropriate drop-down list. Click Remove.
Note: In the case of multiple recipients with the same name, messages will not be sent. An
error message will display.
12. When the Send Attachments as Unity Pop option is selected, the notification will be sent
via the Distribution Service and the attachments will be sent as Unity Pop URLs.
13. If you are licensed for Integration for Microsoft Outlook 2007 or Integration for
Microsoft Outlook 2010 and you want users to be able to perform ad hoc tasks from
Outlook e-mail notifications, select Add Outlook Header.
Note: Ad hoc tasks for queues configured with the Auto-Feed Documents or Exclusive Document
Viewing options are not available in Outlook e-mail notifications. Ad hoc tasks for load
balancing queues are only available when the document is assigned to the logged in user.
Note: In the Message field, you can use HTML tags to format your e-mail notifications (e.g.,
format the font, embed images and logos). An <html> tag should designate the point youd
like the HTML formatting to begin. For example:
<html>
<body>
<font size="6" face="arial" color="red">Greetings, </font>
<b>Sincerely,</b>
<img src="logo.gif/>
</body>
</html>
2012 Hyland Software, Inc.
227
Workflow OnBase 12
4. Click Close on the System Tasks window and Exit on the User Groups & Rights dialog
box.
Assign Document Types
Configuration Module Configuration
Task Lists
A task list is a series of actions and rules that are executed with respect to a document in a
queue, or the current document in the system. When a task list for a document is initiated,
the task list is executed on the document until the document transitions out of the queue that
began the task list. A task list is also referred to as work.
When a task list is run on multiple documents and a document is encountered that is
processed locked by another user, the processed locked document is not processed and a
message is logged in Document History and the task list is executed on the other unlocked
documents. Locks placed on a document by a user other than the user executing the task list
are not removed when the task list is complete. If a document processed by the task list has
a process lock, the last execution result is false. Actions that deal with related documents
vary in behavior regarding last execution results. See Last Execution Result Behavior for
Related Document Actions on page 604 for more information. In addition, action behave
differently when working with documents managed by the Records Management module. See
Records Managements Effect on the Last Execution Result on page 604 for more information.
Note: The task list ID number is displayed in the upper right hand corner.
Caution: If you have Document Types configured to delete the original document upon redaction,
a user should not create a redacted image of a document within these Document Types while a
Workflow task list is being executed on that document. This may result in unexpected behavior,
since the task list is trying to execute against the a document that has been deleted.
2012 Hyland Software, Inc.
228
OnBase 12 Workflow
Break On
The Break On section pertains to how the system reacts when it encounters a rule.
On success of an evaluation, the system stops processing the current task list on the
Success
document. This means that if a rule evaluates to true, it will complete the On True
tasks before breaking.
On failure of an evaluation, the system stops processing the current task list on the
Failure
document. This means that if a rule evaluates to false, it will complete the On False
tasks before breaking.
Default setting. Processing of the task list continues, regardless of success or failure
Never
of the evaluation.
The check boxes below the Break On section are described below:
Option Description
Continue Processes work in the task list after the primary document has transitioned.
Execution
After
Transition
Apply Tasks Applies the task to the batch ticket and not to the individual documents it
to Batch represents.
Tickets
Note: This feature is no longer available for configuration, but is still functional if
previously configured.
Disable Temporarily disables the task list. Allows for the testing of changes to configuration
without giving access to users. A task list in a disabled state appears grayed-out.
Enable Used for determining the location of logic problems in a Workflow configuration.
Debug Causes a message box to display before the execution of the rule.
Breakpoint
To use this option in the OnBase Client, you must have the WFTRACE switch on the
command line of the Client module and the Step Debug toolbar button or the Debug
Window open in the Client module. A command line switch is not required to use
this option in the Unity interface.
Note: This option is only supported in the Classic Client, Core-based client, and Unity
interfaces.
Log When selected and the task is executed, an entry is made into the system's
Execution database. If the task list is disabled when an entry is made, it will be logged in the
system's database that the task list was disabled at the time of execution.
2012 Hyland Software, Inc.
229
Workflow OnBase 12
Option Description
Disable When this option is selected, users cannot drag-and-drop an item onto a task.
Execution
When using the Unity Client or Microsoft Outlook Integration interfaces, this option
Configuration Module Configuration
from Related
disables the task from displaying in the Task drop-down select list in the Related
Items
Items pane.
Available in When this option is selected, this task can be used with the Integration for Microsoft
Outlook Outlook 2007 or Integration for Microsoft Outlook 2010 modules. This task can be
executed directly from a Workflow e-mail notification.
Note: This option is only available for ad hoc tasks. Ad hoc tasks for queues
configured with the Auto-Feed Documents or Exclusive Document Viewing options
are not available in Workflow e-mail notifications. Ad hoc tasks for load balancing
queues are only available when the document is assigned to the logged in user.
Available for When this option is selected, this task can be used with the following modules:
Mobile Mobile Access for Android Phone
Devices
Mobile Access for BlackBerry Phone
Mobile Access for iPad
Mobile Access for iPhone
Mobile Access for Windows Phone
Mobile Workflow for BlackBerry
Note: Actions that require user interaction are not supported for use with these
modules.
Icon
1. To assign an icon to represent the task, click the Icon button. The Icons for: [task
name] dialog box opens.
2. Select an icon from the drop-down list to represent the task in the Tasks Window and
an icon from the Small Icon drop-down list to represent the task in the Tree
Configuration.
3. Click Save. Click Apply on the Task List Configuration dialog box.
Help Text
For ad hoc tasks and Web/API tasks, information added to this box will display when the
tasks icon is hovered over. For task lists configured for a rule queue, load balancing work,
system work, On Abort, and user work, this box is used for informational purposes within the
Configuration module and does not display in the Client. For all tasks and work, the maximum
number of characters that can be entered is 250.
2012 Hyland Software, Inc.
230
OnBase 12 Workflow
Assigned Tasks
The Assigned Tasks field contains a list of all the rules, actions and task lists that have been
configured. The Move Up and Move Down buttons are used to sequence these tasks.
Note: This option is only enabled if you are accessing it from a rule-based load balancing
queue. Once load balancing work has been added, the option becomes disabled.
5. Right-click on the Load Balancing Work folder and select New Rule, New Action, or New
Task List.
6. Type the name of the load balancing work in the field or select an existing entry from
the drop-down list. Press Enter.
7. Grant access to the appropriate user groups by selecting the name and clicking
Add>>.
8. Click Close.
Note: It is recommended that actions that require user interaction not be used as load
balancing work.
2012 Hyland Software, Inc.
231
Workflow OnBase 12
Caution: System work that requires user interaction is not supported in the Core-based
interfaces. When using the Classic Client interface, it is not recommended to configure system
work that requires user interaction.
Break On
The Break On section pertains to how the system reacts when it encounters a rule.
Option Description
On success of an evaluation, the system stops processing the current task list on the
Success
document. This means that if a rule evaluates to true, it will complete the On True
tasks before breaking.
On failure of an evaluation, the system stops processing the current task list on the
Failure
document. This means that if a rule evaluates to false, it will complete the On False
tasks before breaking.
Default setting. Processing of the task list continues, regardless of success or failure
Never
of the evaluation.
2012 Hyland Software, Inc.
232
OnBase 12 Workflow
The check boxes below the Break On section are described below:
Option Description
Apply Tasks Applies the task to the batch ticket and not to the individual documents it
to Batch represents.
Tickets
Note: This feature is no longer available for configuration, but is still functional if
previously configured.
Disable Temporarily disables the task list. Allows for the testing of changes to configuration
without giving access to users. A task list in a disabled state appears grayed-out.
Enable Used for determining the location of logic problems in a Workflow configuration.
Debug Causes a message box to display before the execution of the rule.
Breakpoint
To use this option in the OnBase Client, you must have the WFTRACE switch on the
command line of the Client module and the Step Debug toolbar button or the Debug
Window open in the Client module. A command line switch is not required to use
this option in the Unity interface.
Note: This option is only supported in the Classic Client, Core-based client, and Unity
interfaces.
Log When selected and the task is executed, an entry is made into the system's
Execution database. If the task list is disabled when an entry is made, it will be logged in the
system's database that the task list was disabled at the time of execution.
Disable When this option is selected, users cannot drag-and-drop an item onto a task.
Execution
When using the Unity Client or Microsoft Outlook Integration interfaces, this option
from Related
disables the task from displaying in the Task drop-down select list in the Related
Items
Items pane.
Available in When this option is selected, this task can be used with the Integration for Microsoft
Outlook Outlook 2007 or Integration for Microsoft Outlook 2010 modules. This task can be
executed directly from a Workflow e-mail notification.
Note: This option is only available for ad hoc tasks. Ad hoc tasks for queues
configured with the Auto-Feed Documents or Exclusive Document Viewing options
are not available in Workflow e-mail notifications. Ad hoc tasks for load balancing
queues are only available when the document is assigned to the logged in user.
2012 Hyland Software, Inc.
233
Workflow OnBase 12
Option Description
Available for When this option is selected, this task can be used with the following modules:
Mobile Mobile Access for Android Phone
Configuration Module Configuration
Devices
Mobile Access for BlackBerry Phone
Mobile Access for iPad
Mobile Access for iPhone
Mobile Access for Windows Phone
Mobile Workflow for BlackBerry
Note: Actions that require user interaction are not supported for use with these
modules.
Icon
1. To assign an icon to represent the task, click the Icon button. The Icons for: [task
name] dialog box opens.
2. Select an icon from the drop-down list to represent the task in the Tasks Window and
an icon from the Small Icon drop-down list to represent the task in the Tree
Configuration.
3. Click Save. Click Apply on the Task List Configuration dialog box.
Help Text
For ad hoc tasks and Web/API tasks, information added to this box will display when the
tasks icon is hovered over. For task lists configured for a rule queue, load balancing work,
system work, On Abort, and user work, this box is used for informational purposes within the
Configuration module and does not display in the Client. For all tasks and work, the maximum
number of characters that can be entered is 250.
Assigned Tasks
The Assigned Tasks field contains a list of all the rules, actions and task lists that have been
configured. The Move Up and Move Down buttons are used to sequence these tasks.
2012 Hyland Software, Inc.
234
OnBase 12 Workflow
Break On
The Break On section pertains to how the system reacts when it encounters a rule.
Option Description
On success of an evaluation, the system stops processing the current task list on the
Success
document. This means that if a rule evaluates to true, it will complete the On True
tasks before breaking.
On failure of an evaluation, the system stops processing the current task list on the
Failure
document. This means that if a rule evaluates to false, it will complete the On False
tasks before breaking.
Default setting. Processing of the task list continues, regardless of success or failure
Never
of the evaluation.
The check boxes below the Break On section are described below:
Option Description
Continue Processes work in the task list after the primary document has transitioned.
Execution
After
Transition
Apply Tasks Applies the task to the batch ticket and not to the individual documents it
to Batch represents.
Tickets
Note: This feature is no longer available for configuration, but is still functional if
previously configured.
Disable Temporarily disables the task list. Allows for the testing of changes to configuration
without giving access to users. A task list in a disabled state appears grayed-out.
2012 Hyland Software, Inc.
235
Workflow OnBase 12
Option Description
Enable Used for determining the location of logic problems in a Workflow configuration.
Debug Causes a message box to display before the execution of the rule.
Configuration Module Configuration
Breakpoint
To use this option in the OnBase Client, you must have the WFTRACE switch on the
command line of the Client module and the Step Debug toolbar button or the Debug
Window open in the Client module. A command line switch is not required to use
this option in the Unity interface.
Note: This option is only supported in the Classic Client, Core-based client, and Unity
interfaces.
Log When selected and the task is executed, an entry is made into the system's
Execution database. If the task list is disabled when an entry is made, it will be logged in the
system's database that the task list was disabled at the time of execution.
Disable When this option is selected, users cannot drag-and-drop an item onto a task.
Execution
When using the Unity Client or Microsoft Outlook Integration interfaces, this option
from Related
disables the task from displaying in the Task drop-down select list in the Related
Items
Items pane.
Available in When this option is selected, this task can be used with the Integration for Microsoft
Outlook Outlook 2007 or Integration for Microsoft Outlook 2010 modules. This task can be
executed directly from a Workflow e-mail notification.
Note: This option is only available for ad hoc tasks. Ad hoc tasks for queues
configured with the Auto-Feed Documents or Exclusive Document Viewing options
are not available in Workflow e-mail notifications. Ad hoc tasks for load balancing
queues are only available when the document is assigned to the logged in user.
Available for When this option is selected, this task can be used with the following modules:
Mobile Mobile Access for Android Phone
Devices
Mobile Access for BlackBerry Phone
Mobile Access for iPad
Mobile Access for iPhone
Mobile Access for Windows Phone
Mobile Workflow for BlackBerry
Note: Actions that require user interaction are not supported for use with these
modules.
2012 Hyland Software, Inc.
236
OnBase 12 Workflow
Icon
1. To assign an icon to represent the task, click the Icon button. The Icons for: [task
name] dialog box opens.
Help Text
For ad hoc tasks and Web/API tasks, information added to this box will display when the
tasks icon is hovered over. For task lists configured for a rule queue, load balancing work,
system work, On Abort, and user work, this box is used for informational purposes within the
Configuration module and does not display in the Client. For all tasks and work, the maximum
number of characters that can be entered is 250.
Assigned Tasks
The Assigned Tasks field contains a list of all the rules, actions and task lists that have been
configured. The Move Up and Move Down buttons are used to sequence these tasks.
2012 Hyland Software, Inc.
237
Workflow OnBase 12
Break On
The Break On section pertains to how the system reacts when it encounters a rule.
Option Description
On success of an evaluation, the system stops processing the current task list on the
Success
document. This means that if a rule evaluates to true, it will complete the On True
tasks before breaking.
On failure of an evaluation, the system stops processing the current task list on the
Failure
document. This means that if a rule evaluates to false, it will complete the On False
tasks before breaking.
Default setting. Processing of the task list continues, regardless of success or failure
Never
of the evaluation.
The check boxes below the Break On section are described below:
Option Description
Continue Processes work in the task list after the primary document has transitioned.
Execution
After
Transition
2012 Hyland Software, Inc.
238
OnBase 12 Workflow
Option Description
Apply Tasks Applies the task to the batch ticket and not to the individual documents it
to Batch represents.
Disable Temporarily disables the task list. Allows for the testing of changes to configuration
without giving access to users. A task list in a disabled state appears grayed-out.
Enable Used for determining the location of logic problems in a Workflow configuration.
Debug Causes a message box to display before the execution of the rule.
Breakpoint
To use this option in the OnBase Client, you must have the WFTRACE switch on the
command line of the Client module and the Step Debug toolbar button or the Debug
Window open in the Client module. A command line switch is not required to use
this option in the Unity interface.
Note: This option is only supported in the Classic Client, Core-based client, and Unity
interfaces.
Log When selected and the task is executed, an entry is made into the system's
Execution database. If the task list is disabled when an entry is made, it will be logged in the
system's database that the task list was disabled at the time of execution.
Disable When this option is selected, users cannot drag-and-drop an item onto a task.
Execution
When using the Unity Client or Microsoft Outlook Integration interfaces, this option
from Related
disables the task from displaying in the Task drop-down select list in the Related
Items
Items pane.
Available in When this option is selected, this task can be used with the Integration for Microsoft
Outlook Outlook 2007 or Integration for Microsoft Outlook 2010 modules. This task can be
executed directly from a Workflow e-mail notification.
Note: This option is only available for ad hoc tasks. Ad hoc tasks for queues
configured with the Auto-Feed Documents or Exclusive Document Viewing options
are not available in Workflow e-mail notifications. Ad hoc tasks for load balancing
queues are only available when the document is assigned to the logged in user.
2012 Hyland Software, Inc.
239
Workflow OnBase 12
Option Description
Available for When this option is selected, this task can be used with the following modules:
Mobile Mobile Access for Android Phone
Configuration Module Configuration
Devices
Mobile Access for BlackBerry Phone
Mobile Access for iPad
Mobile Access for iPhone
Mobile Access for Windows Phone
Mobile Workflow for BlackBerry
Note: Actions that require user interaction are not supported for use with these
modules.
Icon
1. To assign an icon to represent the task, click the Icon button. The Icons for: [task
name] dialog box opens.
2. Select an icon from the drop-down list to represent the task in the Tasks Window and
an icon from the Small Icon drop-down list to represent the task in the Tree
Configuration.
3. Click Save. Click Apply on the Task List Configuration dialog box.
Help Text
For ad hoc tasks and Web/API tasks, information added to this box will display when the
tasks icon is hovered over. For task lists configured for a rule queue, load balancing work,
system work, On Abort, and user work, this box is used for informational purposes within the
Configuration module and does not display in the Client. For all tasks and work, the maximum
number of characters that can be entered is 250.
Assigned Tasks
The Assigned Tasks field contains a list of all the rules, actions and task lists that have been
configured. The Move Up and Move Down buttons are used to sequence these tasks.
Password Protection
2012 Hyland Software, Inc.
240
OnBase 12 Workflow
You can password protect task list execution. If you select None, no password protection is
configured. If you select Task, when an ad hoc task is initiated in the Workflow Client, users
will be prompted to enter their passwords once, regardless of the number of documents that
are selected. If you select Document, when an ad hoc task is initiated in the Workflow Client,
Note: In the Core-based Workflow interfaces, a transaction is logged whether or not the user
enters a correct password.
When a password protection task is executed, it is logged for each document it was executed
upon and will display on the Workflow Transactions tab of the Document History dialog box. If
Disable Logging is selected at the queue level, this is not logged.
Note: When using NT Authentication or LDAP Authentication, if the wrong password is entered
exceeding the configured failed login attempt limit, the user account is locked in Active
Directory.
Creating Shortcuts
You can create keyboard shortcuts to execute Ad Hoc Tasks in the OnBase Client. To create a
shortcut, place a & character in front of the letter you want to use in the shortcut. The letter
that you placed the & character in front of will display with an underline in the Client. Pressing
ALT + O + the underlined letter for the task will execute the task in the Client.
Note: Ad hoc task shortcuts are only supported in the OnBase Client Classic and Core-Based
interfaces.
Delete Deletes the task from the configuration of the current queue.
New Rule Allows for the addition of a rule to the task definition.
New Action Allows for the addition of an action to the task definition.
New Task List Allows for the addition of a task to the task definition.
On Abort Task LIst Allows the addition of a task list to be run when an abort occurs.
User Group Allows for editing of the currently assigned user groups for that task.
Edit Comments Enables editing of the contents of the comment field stored for that task.
Comments display when the mouse pointer rests on the name of the task in
the Workflow Configuration tree.
Rename Allows the name of the task, as it appears in the Workflow tree, to be edited.
All occurrences of the task within the same Workflow will be renamed.
2012 Hyland Software, Inc.
241
Workflow OnBase 12
Copy Saves a duplicate of the task in memory, allowing the task to be pasted into
other queues or life cycles.
Configuration Module Configuration
Paste Pastes the currently copied rule/action/task list into the selected ad hoc
task.
Expand Tree Causes the contents of the task (i.e., any rules, actions, or tasks defined for
the task) to be fully displayed in the tree.
Note: On Abort task lists are only available in the Core-based and Web Client interfaces.
On Abort task lists are task lists that execute when an abort occurs. An abort occurs in the
following situations:
Workflow is closed during a user interaction process
The Cancel button is selected during user interaction
The Client closes during a user interaction process
Note:The Exit button used during re-indexing user interaction is not considered an abort.
These task lists are designed to be used in conjunction with a task list that involves user
interaction. As such, On Abort task lists should not be configured in System Work, Timer
Work, or Load Balance Work. No more than one On Abort task list can be created per task list.
User interaction should not be configured as part of the On Abort task list.
2012 Hyland Software, Inc.
242
OnBase 12 Workflow
Note: On Abort task lists can also be created for specific task lists. To create these, right-click
on the user task description to display the menu and select On Abort Task List.
5. Select On Abort Task List. A field or drop-down list for that entry displays. A drop-down
list only displays if other task lists have been configured for this life cycle.
6. Type the name of the new task list in the field or select an existing action from the
drop-down list. Press Enter.
7. To create work for the On Abort task list, right-click on the task list name to display the
available menu options.
8. Select either New Rule, New Action or New Task List to begin creating optional work
that will be executed upon an abort.
Note: The On Abort task list will display above the user work it is configured for. During a
Workflow session, the user will complete user interaction normally. The On Abort task list will
be rolled back to in the case of an abort.
Note: If a nested task list does not have an On Abort task list configured for it, and an abort
occurs, the closest upward On Abort task list will execute.
Break On
The Break On section pertains to how the system reacts when it encounters a rule.
Option Description
On success of an evaluation, the system stops processing the current task list on the
Success
document. This means that if a rule evaluates to true, it will complete the On True
tasks before breaking.
On failure of an evaluation, the system stops processing the current task list on the
Failure
document. This means that if a rule evaluates to false, it will complete the On False
tasks before breaking.
2012 Hyland Software, Inc.
243
Workflow OnBase 12
Option Description
Default setting. Processing of the task list continues, regardless of success or failure
Never
of the evaluation.
Configuration Module Configuration
The check boxes below the Break On section are described below:
Option Description
Continue Processes work in the task list after the primary document has transitioned.
Execution
After
Transition
Apply Tasks Applies the task to the batch ticket and not to the individual documents it
to Batch represents.
Tickets
Note: This feature is no longer available for configuration, but is still functional if
previously configured.
Disable Temporarily disables the task list. Allows for the testing of changes to configuration
without giving access to users. A task list in a disabled state appears grayed-out.
Enable Used for determining the location of logic problems in a Workflow configuration.
Debug Causes a message box to display before the execution of the rule.
Breakpoint
To use this option in the OnBase Client, you must have the WFTRACE switch on the
command line of the Client module and the Step Debug toolbar button or the Debug
Window open in the Client module. A command line switch is not required to use
this option in the Unity interface.
Note: This option is only supported in the Classic Client, Core-based client, and Unity
interfaces.
Log When selected and the task is executed, an entry is made into the system's
Execution database. If the task list is disabled when an entry is made, it will be logged in the
system's database that the task list was disabled at the time of execution.
Disable When this option is selected, users cannot drag-and-drop an item onto a task.
Execution
When using the Unity Client or Microsoft Outlook Integration interfaces, this option
from Related
disables the task from displaying in the Task drop-down select list in the Related
Items
Items pane.
2012 Hyland Software, Inc.
244
OnBase 12 Workflow
Option Description
Available in When this option is selected, this task can be used with the Integration for Microsoft
Outlook Outlook 2007 or Integration for Microsoft Outlook 2010 modules. This task can be
Note: This option is only available for ad hoc tasks. Ad hoc tasks for queues
configured with the Auto-Feed Documents or Exclusive Document Viewing options
are not available in Workflow e-mail notifications. Ad hoc tasks for load balancing
queues are only available when the document is assigned to the logged in user.
Available for When this option is selected, this task can be used with the following modules:
Mobile Mobile Access for Android Phone
Devices
Mobile Access for BlackBerry Phone
Mobile Access for iPad
Mobile Access for iPhone
Mobile Access for Windows Phone
Mobile Workflow for BlackBerry
Note: Actions that require user interaction are not supported for use with these
modules.
Icon
1. To assign an icon to represent the task, click the Icon button. The Icons for: [task
name] dialog box opens.
2. Select an icon from the drop-down list to represent the task in the Tasks Window and
an icon from the Small Icon drop-down list to represent the task in the Tree
Configuration.
3. Click Save. Click Apply on the Task List Configuration dialog box.
Help Text
For ad hoc tasks and Web/API tasks, information added to this box will display when the
tasks icon is hovered over. For task lists configured for a rule queue, load balancing work,
system work, On Abort, and user work, this box is used for informational purposes within the
Configuration module and does not display in the Client. For all tasks and work, the maximum
number of characters that can be entered is 250.
Assigned Tasks
The Assigned Tasks field contains a list of all the rules, actions and task lists that have been
configured. The Move Up and Move Down buttons are used to sequence these tasks.
2012 Hyland Software, Inc.
245
Workflow OnBase 12
3. Right-click the Web/API Tasks folder in the queue where the task will be available. The
right-click menu allows the following actions:
New Web/API Task - allows for the addition of a Web/API task.
Expand Tree - displays the expanded view of all actions/rules defined for all Web/API
Configuration Module Configuration
tasks.
4. Select New Web/API Task.
5. In the drop-down box that appears, type the name of the new task or select an
existing task from the list.
Break On
The Break On section pertains to how the system reacts when it encounters a rule.
Option Description
On success of an evaluation, the system stops processing the current task list on the
Success
document. This means that if a rule evaluates to true, it will complete the On True
tasks before breaking.
On failure of an evaluation, the system stops processing the current task list on the
Failure
document. This means that if a rule evaluates to false, it will complete the On False
tasks before breaking.
Default setting. Processing of the task list continues, regardless of success or failure
Never
of the evaluation.
The check boxes below the Break On section are described below:
Option Description
Continue Processes work in the task list after the primary document has transitioned.
Execution
After
Transition
2012 Hyland Software, Inc.
246
OnBase 12 Workflow
Option Description
Apply Tasks Applies the task to the batch ticket and not to the individual documents it
to Batch represents.
Disable Temporarily disables the task list. Allows for the testing of changes to configuration
without giving access to users. A task list in a disabled state appears grayed-out.
Enable Used for determining the location of logic problems in a Workflow configuration.
Debug Causes a message box to display before the execution of the rule.
Breakpoint
To use this option in the OnBase Client, you must have the WFTRACE switch on the
command line of the Client module and the Step Debug toolbar button or the Debug
Window open in the Client module. A command line switch is not required to use
this option in the Unity interface.
Note: This option is only supported in the Classic Client, Core-based client, and Unity
interfaces.
Log When selected and the task is executed, an entry is made into the system's
Execution database. If the task list is disabled when an entry is made, it will be logged in the
system's database that the task list was disabled at the time of execution.
Disable When this option is selected, users cannot drag-and-drop an item onto a task.
Execution
When using the Unity Client or Microsoft Outlook Integration interfaces, this option
from Related
disables the task from displaying in the Task drop-down select list in the Related
Items
Items pane.
Available in When this option is selected, this task can be used with the Integration for Microsoft
Outlook Outlook 2007 or Integration for Microsoft Outlook 2010 modules. This task can be
executed directly from a Workflow e-mail notification.
Note: This option is only available for ad hoc tasks. Ad hoc tasks for queues
configured with the Auto-Feed Documents or Exclusive Document Viewing options
are not available in Workflow e-mail notifications. Ad hoc tasks for load balancing
queues are only available when the document is assigned to the logged in user.
2012 Hyland Software, Inc.
247
Workflow OnBase 12
Option Description
Available for When this option is selected, this task can be used with the following modules:
Mobile Mobile Access for Android Phone
Configuration Module Configuration
Devices
Mobile Access for BlackBerry Phone
Mobile Access for iPad
Mobile Access for iPhone
Mobile Access for Windows Phone
Mobile Workflow for BlackBerry
Note: Actions that require user interaction are not supported for use with these
modules.
Icon
1. To assign an icon to represent the task, click the Icon button. The Icons for: [task
name] dialog box opens.
2. Select an icon from the drop-down list to represent the task in the Tasks Window and
an icon from the Small Icon drop-down list to represent the task in the Tree
Configuration.
3. Click Save. Click Apply on the Task List Configuration dialog box.
Help Text
For ad hoc tasks and Web/API tasks, information added to this box will display when the
tasks icon is hovered over. For task lists configured for a rule queue, load balancing work,
system work, On Abort, and user work, this box is used for informational purposes within the
Configuration module and does not display in the Client. For all tasks and work, the maximum
number of characters that can be entered is 250.
Assigned Tasks
The Assigned Tasks field contains a list of all the rules, actions and task lists that have been
configured. The Move Up and Move Down buttons are used to sequence these tasks.
2012 Hyland Software, Inc.
248
OnBase 12 Workflow
Note: System tasks that require user interaction are supported in the Unity and Web
interfaces. System tasks that require user interaction are not supported in all other Core-
based interfaces. When using the Classic Client interface, it is not recommended to configure
system tasks that require user interaction.
Caution: When configuring system tasks, tasks that require user interaction are not supported
and, if configured for system tasks, may produce undesired results.
Break On
The Break On section pertains to how the system reacts when it encounters a rule.
Option Description
On success of an evaluation, the system stops processing the current task list on the
Success
document. This means that if a rule evaluates to true, it will complete the On True
tasks before breaking.
2012 Hyland Software, Inc.
249
Workflow OnBase 12
Option Description
On failure of an evaluation, the system stops processing the current task list on the
Failure
document. This means that if a rule evaluates to false, it will complete the On False
Configuration Module Configuration
Default setting. Processing of the task list continues, regardless of success or failure
Never
of the evaluation.
The check boxes below the Break On section are described below:
Option Description
Continue Processes work in the task list after the primary document has transitioned.
Execution
After
Transition
Apply Tasks Applies the task to the batch ticket and not to the individual documents it
to Batch represents.
Tickets
Note: This feature is no longer available for configuration, but is still functional if
previously configured.
Disable Temporarily disables the task list. Allows for the testing of changes to configuration
without giving access to users. A task list in a disabled state appears grayed-out.
Enable Used for determining the location of logic problems in a Workflow configuration.
Debug Causes a message box to display before the execution of the rule.
Breakpoint
To use this option in the OnBase Client, you must have the WFTRACE switch on the
command line of the Client module and the Step Debug toolbar button or the Debug
Window open in the Client module. A command line switch is not required to use
this option in the Unity interface.
Note: This option is only supported in the Classic Client, Core-based client, and Unity
interfaces.
Log When selected and the task is executed, an entry is made into the system's
Execution database. If the task list is disabled when an entry is made, it will be logged in the
system's database that the task list was disabled at the time of execution.
Disable When this option is selected, users cannot drag-and-drop an item onto a task.
Execution
When using the Unity Client or Microsoft Outlook Integration interfaces, this option
from Related
disables the task from displaying in the Task drop-down select list in the Related
Items
Items pane.
2012 Hyland Software, Inc.
250
OnBase 12 Workflow
Option Description
Available in When this option is selected, this task can be used with the Integration for Microsoft
Outlook Outlook 2007 or Integration for Microsoft Outlook 2010 modules. This task can be
Note: This option is only available for ad hoc tasks. Ad hoc tasks for queues
configured with the Auto-Feed Documents or Exclusive Document Viewing options
are not available in Workflow e-mail notifications. Ad hoc tasks for load balancing
queues are only available when the document is assigned to the logged in user.
Available for When this option is selected, this task can be used with the following modules:
Mobile Mobile Access for Android Phone
Devices
Mobile Access for BlackBerry Phone
Mobile Access for iPad
Mobile Access for iPhone
Mobile Access for Windows Phone
Mobile Workflow for BlackBerry
Note: Actions that require user interaction are not supported for use with these
modules.
Icon
1. To assign an icon to represent the task, click the Icon button. The Icons for: [task
name] dialog box opens.
2. Select an icon from the drop-down list to represent the task in the Tasks Window and
an icon from the Small Icon drop-down list to represent the task in the Tree
Configuration.
3. Click Save. Click Apply on the Task List Configuration dialog box.
Help Text
For ad hoc tasks and Web/API tasks, information added to this box will display when the
tasks icon is hovered over. For task lists configured for a rule queue, load balancing work,
system work, On Abort, and user work, this box is used for informational purposes within the
Configuration module and does not display in the Client. For all tasks and work, the maximum
number of characters that can be entered is 250.
Assigned Tasks
The Assigned Tasks field contains a list of all the rules, actions and task lists that have been
configured. The Move Up and Move Down buttons are used to sequence these tasks.
2012 Hyland Software, Inc.
251
Workflow OnBase 12
Configuring Timers
A Workflow server monitors queues with timers configured. Status of timers is monitored in
the Classic Client using the Workflow System Monitor using the WFSRVR switch. For all other
user interfaces, timers can be monitored using the Workflow Timer Service. Refer to the
Workflow Timer Service documentation for more information. Users with Administrative
Processing Privileges may also execute timer work manually.
Adding
1. Right-click on the timer folder. The right-click menu allows the following actions:
New Timer - allows for the addition of a timer.
Paste Timer - allows a previously copied timer to be placed in the folder. If the timer
already exists in the life cycle, a message stating Timer <name> is already present in
the Life Cycle. Do you want to use it? is displayed. Click Yes to confirm the paste. Click
No to paste the timer with a different name. Specify the name you want for the
pasted timer and click Save. Subsequently, you will encounter a prompt for every
task, rule, or action in the task list that already exists in the life cycle.
Expand Tree - displays the expanded view of all tasks/actions/rules defined for all
timers.
2012 Hyland Software, Inc.
252
OnBase 12 Workflow
Configuring
1. Select the Document Type to be affected by the timer.
Note: The default Document Type <ALL>, means all Document Types are subject to the task
performed under the timer. The timer evaluates all documents in the queue.
2. Three types of timers are available in the Type section: At Certain Time, Every, and
After time in Queue. After selecting the type, select the number of Day(s), Business
Day(s), Hour(s), or Minute(s) or a specific day and time to evaluate the documents in
the queue.
Note: Business Day(s) is only available if a Work Calendar has been assigned to the life cycle.
Note: You can view a queues timer information from the Workflow System Monitor screen in
the OnBase Client module.
3. Set the status of the First Document Only check box. If enabled, the Workflow Timer
will only execute against the first document found in the queue, instead of executing
against every document found in the queue. The first document found is determined
by the lowest Document Handle value in the queue. Example: This option can be used
to send out a notification that a queue contains documents that need attention. If First
Document Only is not selected, if the queue contains 100 documents, the notification is
sent 100 times (once for each document).
4. If your business process requires that documents are processed by the timer in the
order specified for the queue by the Sort Documents By option of the queues Advanced
tab, select the Respect Queue Sort Order option. If this option is not selected,
documents are still processed in the order they are returned from the database.
5. If the Log Start/Stop option is selected, every time the selected timer is executed or
stopped, it will be logged in the systems database.
Note: All logs will show the database server time, rather than the processing workstations
time.
2012 Hyland Software, Inc.
253
Workflow OnBase 12
6. If you are using a periodic or queue-based timer, the Use Execution Windows check box
and Configure Execution Windows button are enabled. Select the Use Execution Windows
check box if you want to use the configured execution windows. Execution windows
are windows of time that you want timers to be executed.
Configuration Module Configuration
When the Use Execution Windows check box is selected, the Stop immediately at end
check box is enabled. When Stop immediately at end is selected, timer work is ended
immediately at the end of a configured execution window. If a timer configured with
an execution window still has documents to be processed when the end of the
execution window is reached, this option will break the processing immediately and
any remaining documents will not be processed. If Stop immediately at end is not
selected for a timer using execution windows, the timer will not stop processing
documents when the end of the execution window is reached. The timer work will
continue to run past the end of the execution window until all configured documents
have been processed.
7. Click Apply.
Note: A record is kept of a timers last execution, allowing it to resume where it left off if the
Client is closed. If the timer needs to be restarted, the timer could be removed and then
reassigned to the Assigned Queues list in the Workflow Server Queues tab of the Workstation
Options dialog box. This will effectively force the timer to start from the beginning of the
configured timer period.
After configuring a timer, actions and rules or timer work can be added to the timer. This
work will be initiated when the timer is executed.
Caution: When configuring timer work, work that requires user interaction is not supported and,
if configured for timer work, may produce undesired results.
View a queues timer information from the Workflow System Monitor screen in the Client
module. This screen is available only if:
The workstation has been enabled as a Workflow server by applying the -WFSRVR
command line switch on the Client modules command line.
The workstation has be enabled for timer configuration by applying the -WFSRVR,C
command line switch to the Client modules command line. Timers will not execute
and the Workflow System Monitor screen is not available
The queue that contains the timer is assigned to the Workflow server. To do so,
select User | Workstation Options. See page 53 for more information
2012 Hyland Software, Inc.
254
OnBase 12 Workflow
One Workflow server can monitor multiple timers and perform other server work. Workflow
timers can be initiated automatically or manually.
Note: If timers are configured for a queue that is going to be deleted, it is recommended to
Caution: When you are using more than one workstation to perform timers, if Keyword Values
are changed after one workstations timer work, a notification may be sent falsely by a second
workstation running the same timer if the document is not removed from the queue.
Caution: If you are using a timer to send notifications, there is no way in the Workflow module to
verify that the notification was successfully received.
Caution: When a timer is configured to perform an action on a document if it stays in a queue for
a certain period of time, the timer will reprocess the document if it is not removed from the
queue.
Caution: If you have a task that runs a Client Side script, and the timer is manually executed, the
Client Side script(s) is/are not executed in the Core-based Client interface.
2012 Hyland Software, Inc.
255
Workflow OnBase 12
1. Click Configure on the timer configuration dialog box. The Execution Windows
Configuration dialog box displays.
Configuration Module Configuration
Note: The Configure button is not available if the At Certain Time type is selected.
2. Click Add.
3. Select the days and time ranges for which you want the timer to be executed.
Note: If you select more than one day, all of the days selected will use the same time range. If
you want to specify different time ranges for different days, you must configure multiple
Execution Windows.
4. Click Save. The Execution Window information will be listed in the All Execution
Windows box.
Caution: In order for a timer to use the configured Execution Windows, the Use Execution
Windows check box must be selected.
To edit an existing Execution Window, select it in the All Execution Windows box, make changes,
and click Save.
Shortcut Description
2012 Hyland Software, Inc.
256
OnBase 12 Workflow
Shortcut Description
Custom Queries
Custom Queries can be used to create filters that can be applied to a Workflow queue. A filter
is used to view documents from within the life cycle that meet specific criteria.
Any queries created only as Workflow filters, using the Workflow Filter setting during custom
query configuration, will be available for selection via the Workflow Document Inbox and are
not selectable via the Custom Query list in the Client module.
If you want to use an HTML Form for a standard custom query and as a Workflow filter,
selecting the Workflow Filter setting is not required. In this instance, the Use HTML Form option
must be selected and a path to the HTML form must be specified.
Note: Filtering overrides the default columns in the Document Inbox. Ensure that the
appropriate columns required for viewing in Workflow are configured for the custom query.
A custom query can be assigned to multiple queues to be used as a filter. This can be
configured in the Custom Query Options dialog box in the Configuration module. When a filter
is assigned to a queue, the filter is automatically available in the Use only selected filters
selection box in the Filters tab during Workflow queue configuration for the selected queue(s).
To assign a custom query as a filter to multiple queues:
1. Click the Assign button next to the Workflow Filter check box.
2. Select the queues that you want assign the custom query to and click Add.
3. Click Close and save the custom query.
Configuring your custom queries for Workflow filters with a Keyword Type name that contains
underscores is not supported. If a Keyword Type name contains underscores, you must use
the Keyword Type number to configure the custom query. For example, if a Keyword Type
name is First_Name and its Keyword Type number is 222, the Keyword Type must be
configured using OBKey__222_1.
For more information about configuring custom queries, see the Configuration module
documentation.
2012 Hyland Software, Inc.
257
Workflow OnBase 12
Note: It is recommended that Custom Queries used as Workflow filters not use the By Keyword
option. Instead, the By Document Type option should be used whenever possible.
Configuration Module Configuration
1. In the Client module, expand a life cycle that contains the Document Type you
assigned to the custom query.
2. Select a queue in the Life Cycle View or right-click in the Document Window. Select
Filter Inbox and choose your filter from the list.
3. If a form displays, enter value(s) and click the Submit button to filter the Document
Window.
4. The documents meeting the criteria are displayed in a sortable list in the Workflow
Inbox.
Locks
Configuration locking can be used to prevent accidental changes to the configuration of a life
cycle. While enabled, you can view the Tree Configuration window and browse through the
queues without the ability to make changes. While locked, the graphic layout cannot be
accessed. Lock Configuration is not a security feature. Any user with rights to configure the
life cycle can lock or unlock the life cycle. Locking a life cycle does not prohibit the ability to
assign User Groups and Document Types to the locked life cycle.
2012 Hyland Software, Inc.
258
OnBase 12 Workflow
Lock Configuration
1. Select Workflow | Configuration Locking. The Lock Configuration dialog box opens.
Enter the password in the Enter New Password for the Life Cycle field and confirm the
password by entering it in the Confirm New Password field. Click OK.
Note: The maximum number of characters the password can be is 39 single-byte characters.
4. Repeat steps 2 and 3 for each life cycle for which it is appropriate.
5. Click Save.
2012 Hyland Software, Inc.
259
Workflow OnBase 12
1. Select the check mark box next to the life cycle to remove the check mark.
2. If the life cycle is password protected, the Enter Password to Unlock Life Cycle dialog
Configuration Module Configuration
box is displayed.
3. Enter the password for the life cycle and click OK.
4. Click Save.
To exit without making changes, click Close.
Note: The ability to view documents in a life cycle is controlled at the queue level. If a user has
rights to a Workflow queue, they will also have rights to view all the documents in that queue,
regardless of their security rights to the Document Types assigned to that queue.
Caution: If you assign a Document Type to both Unity Life Cycles and standard life cycles, when
using the Classic Client Workflow interface, when a document is added to life cycles, the
document is only added to the standard life cycles the documents Document Type is associated
with. The document will not be added to any Unity Life Cycles the documents Document Type is
associated with.
Adding
1. Select Document | Document Types, or in the Workflow configuration screen, right-click
on the life cycle and select Document Type.
2. Select the Document Type.
3. Click Life Cycles.
4. Select the life cycle(s) on the Available list.
5. Click Add>> to move them to the Selected list.
6. Click Save.
2012 Hyland Software, Inc.
260
OnBase 12 Workflow
Verification Reports
The SYS - Verification Reports Document Type can be assigned to a life cycle and verification
reports can be routed through a life cycle upon creation of the verification report.
Note: The ability to view documents in a life cycle is controlled at the queue level. If a user has
rights to a life cycle queue, they will also have rights to view all the documents in that queue,
regardless of their security rights (i.e., security keyword assignments).
Note: To view documents within Workflow, users need to have access to at least one
Document Type as well as privileges to retrieve / view documents. The Document Type to
which the user is given access does not need to contain any documents, nor does it need to
be associated with the Life Cycle. The user also does not need access to the Retrieval dialog.
Note: To add life cycles to the user group, the workstation must have a Workflow module
license.
2012 Hyland Software, Inc.
261
Workflow OnBase 12
6. Click Close.
Note: In order to grant access to specific queues, the user group must have rights to the life
cycle that contains the queues.
Configuration Module Configuration
In addition, life cycles rights can be granted to user groups by right-clicking on a life cycle in
the configuration tree and selecting User Group. You can assign user groups to the selected life
cycle.
1. Select Users | User Groups/Rights. The User Groups & Rights dialog box is displayed.
2. Select the User Group from which you want to copy rights.
3. Click Copy. The User Group Copy Options dialog box is displayed.
4. Enter a new User Group Name that will inherit the selected settings from the existing
User Group.
5. Select the User Group Settings to Copy of the existing User Group that you would like
your new User Group to inherit.
Note: You do not have to choose all settings assigned to the existing User Group.
2012 Hyland Software, Inc.
262
OnBase 12 Workflow
6. Click Retain Copy Options if you would like to save the selected settings for a future
User Group you will create.
7. Click Copy.
1. Click the Configuration Rights button in the User Groups & Rights dialog box.
2. Select the Products tab.
3. Select the Workflow Configuration check box. If you want to grant configuration rights
for all life cycles, select All Life Cycles. If you want to only allow a user group to
configure only the life cycles they have rights to, select Assigned Life Cycles.
4. Click Save & Close. The Workflow menu becomes active in the Configuration module.
5. Click Exit.
Note: If the Use Workflow Configuration Rights option is configured, the rights set at the user
group level are ignored.
2012 Hyland Software, Inc.
263
Workflow OnBase 12
Note: The Workflow Configuration Administration right also gives a specific user the option to
Manage user group layout settings in the Unity Workflow interface.
1. Select Users | User Groups/Rights to display the User Groups & Rights dialog box.
2. Type the new user group name in the field or select an existing one from the User
Group Name list and click Privileges.
3. On the Assigning User Group Privileges for [group name] Group dialog box, check the
Workflow box in Client Based Products.
2012 Hyland Software, Inc.
264
OnBase 12 Workflow
4. To assign Workstation Options, check the User/Workstation Options box in the Client
Features section.
5. Click Save & Close.
Change viewing privileges to life cycles and queues in the Workflow inbox
In order for users to access life cycles, they must have the appropriate privileges.
Note: The MANAGER and ADMINISTRATOR accounts must be assigned specific rights to any
queues those user groups require access to.
3. Select life cycle(s) from the Life Cycle list on the Available for selection list. The
associated queues are selected in the Work Queue list below. You can deselect
individual queues by clicking them in the Work Queue list.
4. Click the Add>> button to move the life cycle and queues to the Selected for Group list.
To revoke access, select the life cycle(s) on the Selected for Group list and click the
<<Remove button.
5. When finished, click Close.
Note: When using the Classic Client interface, users must be assigned to more than one queue
in order for the Life Cycle window to be displayed by default. If you only want to assign users
to one queue and make the Life Cycle window available by default, create a hidden queue and
assign it to the users that you only want to access one Workflow queue.
2012 Hyland Software, Inc.
265
Workflow OnBase 12
Note: Only ad hoc tasks belonging to life cycles to which users have rights are displayed for
selection.
2012 Hyland Software, Inc.
266
OnBase 12 Workflow
Note: The Workflow Administrator privilege overrides all queue level privileges in those queues
that the user/user groups has rights.
Caution: The MANAGER and ADMINISTRATOR user will automatically be granted Workflow log
purging privileges when the Workflow or Workflow Restricted privilege is granted.
Configuration Rights
From the User Group & Rights screen, appropriate permissions must be granted. The following
rights affect Workflow.
Configure custom queries, VB scripts, folder and notes. See page 264.
Gain access to the Workflow inbox and workstation options. See page 264.
Change viewing privileges to life cycles and queues in the Workflow Inbox. See
page 265.
Change privileges to Ad Hoc Tasks and System Tasks. See page 265.
Grant Administrative Processing Privileges. See page 267.
2012 Hyland Software, Inc.
267
Workflow OnBase 12
4. Enter the WSDL location. The location value cannot exceed 255 characters.
5. Click OK.
2012 Hyland Software, Inc.
268
OnBase 12 Workflow
Note: If a form references a URL, the URL reference and the form are exported.
Caution: Upon import, the Manager user group is granted access to imported AutoFill Keyword
Sets. A user from the Manager user group must appropriately grant AutoFill Keyword Set access
to users.
When importing encrypted keywords, these keywords will lose the encryption flag. If
you wish for the imported keywords to be encrypted, you must lock the system
through the Configuration module (Utils | Database Settings) and reset the
encryption for the Keyword Types.
2012 Hyland Software, Inc.
269
Workflow OnBase 12
Data within Data Sets. Upon import, if the destination database already has a Data
Set for the affected Keyword Type, the existing and imported values are merged into
the Data Set, meaning all existing values are kept and only new values are added.
Values will never be removed. If an imported Keyword Type is mapped to a Keyword
Configuration Module Configuration
Type in the destination database that does not have Use Keyword Data Set option
selected, no values will be imported into the destination database for the mapped
Keyword Type. If imported data set values are longer than allowed by the mapped
destination Keyword Type, they will be truncated.
Cascading Data Sets. Data set values are not imported. Only the structure of the
Cascading Data Sets is exported. Upon import, any conflict resolution necessary for
Cascading Data Sets is done after all Keyword Types conflicts are resolved.
Cascading Data Set resolution is accomplished in the following way: If there is a
Cascading Data Set with the same name that has Keyword Types with the same
names, in the same order, the imported data set is mapped to it without any user
interaction. If there is a Cascading Data Set with Keyword Types with the same
names, but the data set has a different name, a conflict will result and the user can
map to the existing Data Set or create a new data set. If there is no existing Data
Set with Keyword Types with the same names, a new set is created. If a set with the
same name as the imported one already exists, a user is prompted for a new name;
otherwise there is no user interaction.
Note: A Document Type cannot have two Cascading Data Sets assigned if these Data Sets
share a Keyword Type. If this occurs, the user is prompted to create a new Document Type or
unassign the Cascading Data Set from the Document Type.
If you export a rule engine queue, the queue configuration, conditions, outputs,
parameters, and the active condition setting are all exported. Only the latest version
of a rule set is exported. All other versions of a rule set are not exported.
When using Org Charts and users in an Org Chart are members of a load balancing
queue within the life cycle, life cycle users are exported along with any user on
which the exported user is dependent, including the root user.
Caution: When exporting Org Charts and Calendars, ensure that the proper elements are
exported and resolved properly during import.
When using calendars, all business calendars configured for life cycles are exported.
User-specific calendars will be exported for users, but the Time Off information will
not be exported. Upon import, if a user already existed in the destination database,
the business calendar information is not overwritten.
If you have life cycles configured to use actions or rules associated with WorkView,
related WorkView Document Type Associations, applications, classes, notifications,
filters, and attributes are exported.
If you have life cycles configured to use actions associated with the Records
Management module, Managed Folders, Hold Sets, Hold Reasons, Retention Plans,
Event Sets, and Events are exported.
Note: Only the Events that are assigned to actions are exported. Event Sets are exported, but
the Events assigned to an Event Set are only exported if in use by an exported life cycle.
2012 Hyland Software, Inc.
270
OnBase 12 Workflow
2012 Hyland Software, Inc.
271
Workflow OnBase 12
You can export one or more life cycles during a single export process. To initiate an export:
1. Select Workflow | Export, or right-click the life cycle in the Workflow window and
choose Export to display the Workflow Configuration Export dialog box.
Configuration Module Configuration
2. Enter a path to the directory where the file(s) will be placed in the Export File Name
edit field.
Note: Use the same directory name for the import process.
You also can browse to the directory using the ellipse button (...). You must specify the
full file name, including the file extension (.xml), in order to use the browsing feature.
3. The left side of the dialog box (Available Life Cycles) shows a list of all life cycles
available for export.
Select life cycle(s) to export and click Add>>, or click Add All>> to include all the life
cycles for export. (<<Remove can be used to exclude any selected life cycle from the
export; <<Remove All removes all life cycles from the Selected Life Cycles list.)
4. If you want to archive the export file into OnBase, select Save Export File into OnBase.
The export .xml file is archived into the SYS Configuration Reports Document Type. The
name of the report will be SYS Configuration Reports - <date> WORKFLOW EXPORT FILE.
2012 Hyland Software, Inc.
272
OnBase 12 Workflow
5. When you are finished, and all the life cycles to be exported appear in the Selected Life
Cycles list, click OK to begin the export process or Cancel to discard these settings.
Note: Multiple life cycles are exported into one file. They are separated into individual life
Note: Life cycles that contain invalid characters cannot be exported successfully. If you
continue to attempt the export after being alerted that an invalid character exists, a
configuration report stored in SYS Configuration Reports will provide information about the
location of the invalid character. An export file will not be created until the invalid character is
corrected.
If a life cycle being exported has an action or rule configured which has a dependency
on another life cycle, a prompt asking An action/A rule name of action or rule refers to
another Life Cycle name of life cycle referenced. Do you want to add this Life Cycle to
Export? Click Yes to export the life cycle. Click No and the life cycle will be created as a
placeholder. This life cycle is displayed in red in the configuration in the destination
database, and appear only when the life cycle being exported has a rule/action that
interacts with that life cycle.
If an Org Chart was configured for the life cycle, a prompt asking Do you want to export
Org Chart? is displayed. Click Yes to export the Org Chart. Click No and the Org Chart
will not be exported.
When the export is complete, a message stating Workflow Export Complete is
displayed.
An export is canceled if any of the following are encountered:
The SYS HTML Forms document used as an E-Form was deleted.
An invalid path to a user form is found.
A SYS HTML Forms document, an overlay, an icon, or a bitmap used in the life cycle
was deleted manually from the Disk Group (not using the OnBase interface).
2012 Hyland Software, Inc.
273
Workflow OnBase 12
Tip: Apply the verbose command line switch (-V) to the Client shortcut when importing life
cycles; logging is turned on and errors encountered during import will be logged. In addition,
if an invalid character is encountered, the lines of XML up to, but not including, the invalid
character will be reported in a report stored in the SYS Configuration Reports Document Type.
Note: Importing involves careful scrutiny of the data presented in the import dialogs. Care
must be taken to identify each element in the life cycle to be imported, and determine how
those elements will be mapped to the import life cycle.
Note: Workflow task lists are always imported as New Objects and assigned new tasklist IDs.
Any existing VBScripts or OnBase API integrations referencing tasklists linked to the imported
life cycle will need to be updated with the new tasklist ID value.
2012 Hyland Software, Inc.
274
OnBase 12 Workflow
6. The Workflow Import dialog box displays. From this dialog box, you must choose
whether you want to restore a life cycle from backup, resume a saved session, or
import new data.
4. Click OK.
5. Resolve any life cycle or queue conflicts. See page 277 for more information about
conflict resolution.
2012 Hyland Software, Inc.
275
Workflow OnBase 12
6. Resolve Document Type conflicts or any other conflicts. You can also save your session
at this point.
7. When the import has completed successfully, the Import Completed Successfully dialog
box displays.
Configuration Module Configuration
8. Click OK. Close and open the Configuration module in order to see the changes made
by the restore.
9. Complete the necessary post import activities. See page 292 for more information.
Caution: If a document belonging to the SYS System Overlay Images Document Type is imported
during a Workflow import, and it has the same description as a document found in the
destination database, the existing document is used for overlay. If no match is found, a new
document is created from the import XML file and stored into the database.
Caution: The destination database should not have been changed between the time that the
session was saved and the time the session was resumed.
3. Click Open.
4. Resolve all conflicts. See page 282 for more information.
5. Click Retest. See page 289 for more information.
6. When all conflicts are successfully resolved, the All dependencies resolved. Do you want
to Import the Life Cycle? message displays. Click OK to continue with the import
process. Click Cancel to cancel the import process.
2012 Hyland Software, Inc.
276
OnBase 12 Workflow
7. When the import has completed successfully, the Import Completed Successfully dialog
box displays.
8. Click OK. Close and open the Configuration module in order to see the changes made
by the import.
Conflict Resolution
Conflicts can occur when a life cycle being imported contains one or more of the following that
have the same database identification number or name as an item in the new database:
a life cycle
a Unity Life Cycle
queue
Document Type Group
Document Type
document templates
Keyword Type
Caution: When importing encrypted keywords, these keywords will lose the encryption flag. If
you wish for the imported keywords to be encrypted, you must lock the system through the
Configuration module (Utils | Database Settings) and reset the encryption for the Keyword Types.
custom queries
file types
folder types
folder templates
fonts
print formats
print queues
XML formats
XML format ports
notifications
currency formats
users (only applicable to users that are used in a life cycle. For example, a load
balancing queue would have associations to users.)
Note: Deactivated users in the destination database are not available for selection using
conflict resolution.
user groups
note types
VBScripts
Note: On import, if you choose to Replace or Map a VBScript to an existing VBScript that has
the same name, the scope specified for the incoming VBScript must match the existing
VBScript.
2012 Hyland Software, Inc.
277
Workflow OnBase 12
E-Forms
user forms
Unity Forms Templates
Configuration Module Configuration
Note: When resolving this conflict type, ensure that the Document Type associated with the
Unity Form template is assigned all the Keyword Types configured for the Unity Form
template. Document Type conflicts need to be resolved before resolving Unity Form template
conflicts.
Note: If an imported Unity Form template has the same name as a Unity Form template that
already exists in the destination database, but is associated with a different document type,
the user will not be able to use the Map to Same Name button.
Caution: Be extremely careful when mapping Org Charts and Users within the Org Charts. Ensure
that you do not map users in a way that would make them their own managers or their own
assistant. This is not supported.
Roles
Calendars
Document Composition Libraries
Form Letter Templates
SAP servers
Managed Folders
Caution: Always resolve Managed Folders before resolving Hold Reasons to ensure you are
resolving the Hold Reasons correctly and matching the Hold Reason with the correct Managed
Folder.
Caution: Always resolve Event Sets before resolving Events to ensure you are resolving the
Events correctly and matching the Events with the correct Event Set.
RIM Events
RIM Retention Plans
actions and rules that refer to another queue
WorkView Class DTAs
WorkView Filter DTAs
WorkView Applications
WorkView Classes
2012 Hyland Software, Inc.
278
OnBase 12 Workflow
WorkView Attributes
WorkView Notifications
WorkView Filters
Portfolio Relations
There are two dialog boxes associated with conflict resolution: Workflow Conflicts Resolution
dialog box and Naming Conflicts for Name of Life Cycle dialog box.
Understanding Conflicts
When a conflict is being resolved, the Workflow Conflicts Resolution dialog box will provide you
with information that will aid you in the conflict resolution process. When a conflict is
selected, the detail of that conflict will be displayed in the Description of Conflict box located in
the upper right-hand corner of the screen.
The following are categories of conflict types:
Life cycle - page 279
Queue - page 280
Document Types - page 283
All other conflict types - page 285
1. Select the life cycle to obtain a description of the conflict on the right side of the dialog
box.
2. Resolve the conflict in any of the following ways:
Rename the life cycle by clicking Create New and supplying the new name. The
maximum number of characters allowed is 50.
Replace the current life cycle with the newly imported life cycle by selecting a life
cycle from the Mapping/Replacing Choices dialog box and clicking Replace.
2012 Hyland Software, Inc.
279
Workflow OnBase 12
3. Click Save when all conflicts have been resolved for the life cycle.
Note: If you select the Show Mapped Objects, mapped items will be displayed. If you select
Show Replacing Objects, items replacing existing items will be displayed. If you select Show
Configuration Module Configuration
New Objects, items that are created as a new object will be displayed. When these options are
not selected, the corresponding objects will not be displayed in the dialog box.
Note: If the life cycle you exported uses E-Forms and you used the keyword number in the
OBKeys values, you will need to make sure these values correspond to the same keywords in
OnBase to which you are importing. Also, the path configured to any user forms must be
reconfigured for the imported form.
Queue Conflicts
If you choose to replace an existing life cycle with a newly imported life cycle, and queues in
the new life cycle match queues already in the system from the life cycle being replaced, the
Workflow Conflict Resolution dialog box will display.
To resolve a queue conflict:
1. Select the queue to obtain a description of the conflict on the right side of the dialog
box.
2. Resolve the conflict in any of the following ways:
Rename the queue by clicking Create New and supplying the new name. The
maximum number of characters allowed is 50.
Replace the current queue with the newly imported queue by selecting a queue from
the Mapping/Replacing Choices box and clicking Replace.
2012 Hyland Software, Inc.
280
OnBase 12 Workflow
Note: If you select the Show Mapped Objects, mapped items will be displayed. If you select
2012 Hyland Software, Inc.
281
Workflow OnBase 12
Resolve opens the Workflow Conflicts Resolution dialog box. Each category must be selected
and resolved. See page 283 and page 285 for more information.
Retest evaluates the conflict status of the import. Retesting must be performed after conflicts
have been resolved in order to move forward with the import. See page 289 for more
information.
Create Report can be used at any time during conflict resolution to produce a report of the
resolved conflicts, in addition to the WORKFLOW CONFIGURATION IMPORT report that is
automatically produced as a result of the import process. All resolved conflicts in all
categories will be reported, regardless of the selected category. See page 290 for more
information.
Save Session allows you to save your progress in the current import process. See page 290 for
more information.
Resolutions from File allows you to import a saved session information to use for the current
conflict resolution. See page 290 for more information.
If the Hide Resolved Conflicts (Retest to see changes) check box is selected, once a conflict is
resolved and the conflicts are retest, the resolved conflicts will be removed from the conflict
list.
2012 Hyland Software, Inc.
282
OnBase 12 Workflow
Caution: If a document belonging to the SYS System Overlay Images Document Type is imported
during a Workflow import, and it has the same description as a document found in the
Tip: When importing multiple Document Types that map to the same HTML form, care must be
taken when creating new forms, versus mapping to existing HTML forms.
1. Select the Document Type category in the Naming Conflicts for Name of Life Cycle
dialog box.
2. Click Resolve.
3. The Workflow Conflicts Resolution dialog box displays.
4. Select the Document Type to obtain a description of the conflict on the right side of the
dialog box.
5. Resolve the conflict in any of the following ways:
Map the currently selected Document Type to an existing Document Type in the
database by selecting an existing Document Type to map to in the Mapping/
Replacing Choices list and clicking Map.
Replace the current Document Type with the newly imported Document Type by
selecting a Document Type from the Mapping/Replacing Choices dialog box and
clicking Replace. Document Type settings are preserved as they were in the existing
Document Type.
2012 Hyland Software, Inc.
283
Workflow OnBase 12
Rename the Document Type by clicking Create New and supplying the new name.
The maximum number of characters allowed is 50. When a new Document Type is
created, its first revision is created with the Document Type settings from imported
Document Type.
Configuration Module Configuration
Add a new revision of existing Document Type by clicking Create Revision. The
Document Type settings are applied from the import file.
Map all selected imported Document Types to existing Document Types that match
in name by clicking Map to Same Name.
Note: The Default Disk Group setting is not applied from imported Document Types.
Caution: Care must be exercised when selecting Map to Same Name. All dependencies within the
mapped Document Type will also be mapped to existing configurations and may result in errors.
6. Click Save when all conflicts have been resolved for the life cycle.
Note: If you select Show Mapped Objects, mapped items will be displayed. If you select Show
Replacing Objects, items replacing existing items will be displayed. If you select Show New
Objects, items that are created as a new object will be displayed. When these options are not
selected, the corresponding objects will not be displayed in the dialog box.
1. Select the User Forms category in the Naming Conflicts for Name of Life Cycle dialog
box.
2. Click Resolve.
3. The Workflow Conflicts Resolution dialog box displays.
4. Select the user form to obtain a description of the conflict on the right side of the
dialog box.
5. Resolve the conflict in any of the following ways:
Map the currently selected user form to an existing user form in the database by
selecting an existing user form to map to in the Mapping/Replacing Choices list and
clicking Map.
Replace the current user form with the newly imported user form by selecting a user
form from the Mapping/Replacing Choices dialog box and clicking Replace.
Rename the user form by clicking Create New and supplying the new name. The
maximum number of characters allowed is 50.
2012 Hyland Software, Inc.
284
OnBase 12 Workflow
6. Click Apply when all conflicts have been resolved for the life cycle.
Note: If you select Show Mapped Objects, mapped items will be displayed. If you select Show
Replacing Objects, items replacing existing items will be displayed. If you select Show New
7. After clicking Apply, if Create New was selected for a user form, the Browse for Folder
dialog box is displayed.
Browse to the location where you would like to store the form and click OK. Ensure the
path used is accessible to users by using a UNC path.
Caution: Security user group rights are not exported for libraries. If you use the Map or Replace
options during the import for library, the user group rights will not change and will remain
according to what was already on the destination system. When using the Create New option for
a library, the MANAGER group will automatically be assigned to have edit access to the library.
2012 Hyland Software, Inc.
285
Workflow OnBase 12
Keyword Type
Note: When importing a Keyword Type that is configured to use auto numbering, if you choose
Create New, the new Keyword Type's initial value starts at 0. If you choose Map To, the
Configuration Module Configuration
Keyword Type's initial value maps to the keyword value in the destination database and will
use the existing sequence value. If you map a Keyword Type that is configured with auto
numbering to a Keyword Type in the destination database that is not configured with auto
numbering, the mapped Keyword Type will not be configured with auto numbering because
the mapped Keyword Type inherits the properties of the Keyword Type in the destination
database.
custom queries
document templates
file types
folder types
folder templates
fonts
Form Letter Templates
Caution: Security user group rights are not exported for templates. If you use the Map or Replace
options during the import for template, the user group rights will not change and will remain
according to what was already on the destination system. When using the Create New option for
a template, the MANAGER group will automatically be assigned to have edit access to the
template.
print formats
print queues
XML formats
XML format ports
notifications
currency formats
Org Charts
Roles
users (only applicable to users that are used in a life cycle. For example, a load
balancing queue would be associated with users.)
user groups
note types
VBScripts
E-Forms
Note: If a document belonging to the SYS HTML Form Document Type is imported and does not
have a value for the Description Keyword Type, or it has spaces as the value, it will be
imported with a unique, automatically-generated value in the format of Eform ID nnn,
where nnn is the ID number for the form.
2012 Hyland Software, Inc.
286
OnBase 12 Workflow
Note: When resolving this conflict type, ensure that the Document Type associated with the
Unity Form template is assigned all the Keyword Types configured for the Unity Form
Note: If an imported Unity Form template has the same name as a Unity Form template that
already exists in the destination database, but is associated with a different document type,
the user will not be able to use the Map to Same Name button.
Caution: Always resolve Managed Folders before resolving Hold Reasons to ensure you are
resolving the Hold Reasons correctly and matching the Hold Reason with the correct Managed
Folder.
Caution: Always resolve Event Sets before resolving Events to ensure you are resolving the
Events correctly and matching the Events with the correct Event Set.
RIM Events
RIM Retention Plans
2012 Hyland Software, Inc.
287
Workflow OnBase 12
1. Select the category in the Naming Conflicts for Name of Life Cycle dialog box.
Configuration Module Configuration
Note: For conflicts with actions that transition documents to another queue, they will not be
listed in the Naming Conflicts for Name of Life Cycle dialog box. They will open in their own
Workflow Conflicts Resolution dialog box. Skip to step 3 for this type of conflict.
2. Click Resolve.
3. The Workflow Conflicts Resolution dialog box displays.
4. Select the conflict to obtain a description of the conflict on the right side of the dialog
box.
Note: Actions that transition documents to another queue will have the life cycles to which
they belong displayed in brackets next to the conflict item and the item in the Mapping/
Replacing Choices box.
Note: When resolving a WorkView Class DTA or a WorkView Filter DTA, you can only map to an
existing DTA. You cannot create a new DTA or replace an existing DTA with the imported DTA.
Replace the current item with the newly imported item by selecting a item from the
Mapping/Replacing Choices dialog box and clicking Replace.
Rename the conflict by clicking Create New and supplying the new name. The
maximum number of characters allowed is 50.
Map all selected imported document types to existing document types that match in
name by clicking Map to Same Name.
Note: When resolving queue references, if you select multiple queues that do not belong to
the same life cycle and multiple queues with the same name exist but in different life cycles
and click Map to Same Name, you will be prompted to resolve the mappings individually.
Caution: Use care when selecting Map All to Same Name. All dependencies within the mapped item
will also be mapped to existing configurations and may result in errors.
6. Click Save when all conflicts have been resolved for the life cycle.
Note: If you select the Show Mapped Objects, mapped items will be displayed. If you select
Show Replacing Objects, items replacing existing items will be displayed. If you select Show
New Objects, items that are created as a new object will be displayed. When these options are
not selected, the corresponding objects will not be displayed in the dialog box.
Note: Some object types do not have the Replace button available by design. For these object
types, you must create a new object or map the object to an existing object.
2012 Hyland Software, Inc.
288
OnBase 12 Workflow
Retesting Conflicts
Once conflicts have been resolved, you must retest the import for conflicts. To test for
remaining conflicts:
1. Upon clicking Retest after all conflicts have been solved, a Workflow Import dialog box
will display stating Please select a directory to store HTML Forms. Click OK.
2. The Browse for Folder dialog box is displayed.
2012 Hyland Software, Inc.
289
Workflow OnBase 12
Creating Reports
You can create a report listing all of the conflict resolutions in the Naming Conflict for Name of
Life Cycle dialog box by clicking Create Report. The report will contain all resolved conflicts in
Configuration Module Configuration
all categories. The reports are accessed in the SYS Configuration Reports Document Type.
A report is also created during an import process automatically. This report can be accessed
by retrieving the SYS Configuration Reports Document Type, and selecting the most recent
WORKFLOW CONFIGURATION IMPORT document. The Workflow Configuration Report lists the
name of the imported life cycle, how conflicts were resolved, and all configuration objects
associated with the imported life cycle (e.g., user groups, keywords, Document Types, etc.).
Saving Sessions
Once you reach the Naming Conflict for Name of Life Cycle dialog box, you have the option to
save the conflict resolution progress in your current import session. In addition, saved
sessions can be imported and the information can be used in subsequent life cycle imports.
Tip: If you are using a saved session as a resolution file, use a descriptive name to identify the
file as a resolution file and the database in which it was created.
To save a session:
1. Click Save Session in the Naming Conflict for Name of Life Cycle dialog box.
2. Select the appropriate directory that you want to save your session file in.
3. Enter an appropriate file name with an .xml extension.
4. Click Save.
5. Click OK.
6. Click Cancel, followed by Yes, to exit the Naming Conflict for Name of Life Cycle dialog
box.
1. Click Resolutions from File. The Choose a File to Process dialog box is displayed.
2. Select the appropriate file.
Caution: Resolution files are specific to the database they were created in. A resolution file should
only be used for the database in which it was created. The destination database should not be
changed between the time the resolution file was saved and the time the saved session is
resumed.
3. Click Open.
2012 Hyland Software, Inc.
290
OnBase 12 Workflow
Orphaned Documents
When a queue is deleted by the replacement of a life cycle in the destination database (with a
life cycle that does not contain comparable queues), orphaned documents exist. Orphaned
documents are listed in the Deleted Work Queue Document Migration dialog box.
2012 Hyland Software, Inc.
291
Workflow OnBase 12
4. Repeat steps 1 through 3 for each orphaned document you would like to resolve.
5. Click Apply when complete.
Configuration Module Configuration
Note: If the Deleted Work Queue Document Migration dialog box is exited without assigning
orphaned documents to existing queues or deleting the orphaned documents from the life
cycle, the queue that no longer exists in the replaced life cycle will be created as a
placeholder. The queue will not be configured. This can allow for the queue to be kept and
reconfigured, while maintaining its current documents. In addition, documents can be
transitioned out of this created queue manually at a later time.
Tip: You can select all orphaned documents to perform an identical assignment or deletion on
by clicking Select All. Alternately, you can select multiple orphaned documents to perform an
identical assignment or deletion by holding down Ctrl while selecting individual documents.
You can select a group of documents that are listed next to each other by holding down Shift,
clicking the first document in the group, then clicking the last document in the group.
2012 Hyland Software, Inc.
292
OnBase 12 Workflow
Note: The option selected for User Interface in the Workflow Display Options tab in the Client
overrides this setting.
Configuring the Server for Use with the Core-Based OnBase Client Interface
In order for the Workflow Queues right-click option to function correctly, the usequerycontext
attribute must be set to false in the Application Servers web.config file. If this attribute is not
set to false, the Workflow Queues right-click option will not function in the Core-based OnBase
Client interface as described.
2012 Hyland Software, Inc.
293
Workflow OnBase 12
1. In the Configuration module, select Workflow | Options. The Workflow Options dialog
box is displayed.
When this option is selected, documents imported into OnBase will initiate Workflow and the
Initiate Workflow check box is not available to users.
Note: This option does not apply to the Unity or Java Client interfaces because the Initiate
Workflow check box is not available in these interfaces.
2012 Hyland Software, Inc.
294
OnBase 12 Workflow
When this option is selected, documents re-indexed in OnBase will initiate Workflow
automatically. The option to initiate Workflow will not be available in the Re-Index Document
dialog box.
Note: This option does not apply to the Unity or Java Client interfaces because the option to
initiate Workflow when re-indexing is not available in these interfaces.
A programmer familiar with the Core API can use the session object to access the full range of
OnBase Core functionality. The document can be used to access information about or modify
the document.
2012 Hyland Software, Inc.
295
Workflow OnBase 12
Example
Important Notes
1. The OnBase Core does not support script substitutions, such as "<<DocumentNum>>" or
Configuration Module Configuration
"<<OBKey_[]>>".
Note: These scripts run on the Application Server, not the client machine.
Administration
In addition to the design considerations that go into making a resilient Workflow solution,
certain maintenance and administration tasks can be performed to ensure that the life cycle is
performing at maximum efficiency. Areas in which preventive maintenance can be applied
(and their associated tools) include:
Timer Management. See page 296.
Workflow Search. See page 297.
Workflow Replay. See page 300.
Workflow Doctor. See page 301.
Managing Timers
If timers are configured to run at the same time, the system will kick off the first timer in the
list; the next timer, scheduled for the same execution time, will not begin until the previous
one completes.
The server that manages and executes the timers is a primary factor in the life cycles
efficiency. For example, if the OnBase Client that initiates a life cycle must also perform all of
the System Work for a document, the placement of workload is important. If you are running
a DIP Process that feeds a Workflow Queue then you may want to consider using a timer to
kick off the system work.
Timers can been monitored in the Classic Client interface using the Workflow System Monitor
when the WFSRVR command line switch is applied. For all other user interfaces, timers can
be monitored using the Workflow Timer Service. Refer to the Workflow Timer Service
documentation for more information.
Note:The -LT command line switch indicates the log off time of the Client module. Be aware of
timers that may be running when using the auto logoff switch because they will not trigger
unless the Client workstation is logged in to OnBase.
2012 Hyland Software, Inc.
296
OnBase 12 Workflow
Workflow Search
The Workflow Search utility is a tool that indicates where various aspects of the Workflow
configuration (e.g., Keyword Types, Document Types, or VBScripts) are in use. This tool is
especially helpful in assisting administrators determine how changes to an area will affect the
When searches are performed, results are based on references to the selected Object type and
Object. If an object exists but no task list, action, or rule refers to the object, the object will
not display in the results.
2012 Hyland Software, Inc.
297
Workflow OnBase 12
1. In the Configuration module, select Workflow | WF Search. The Workflow Search dialog
box is displayed.
Configuration Module Configuration
2. Select the type of object to search for from the Object type drop-down list.
3. Select the specific object (of that type) to search for from the Object drop-down list.
This field is disabled if <All Objects> is selected from the Object type drop-down list.
4. If <All Objects> is selected from the Object type drop-down list, the Search Text field is
enabled. You can enter text in this field to search across objects. This field can be used
in conjunction with the Search this Life Cycle Only and Search this Queue Only options.
This field allows up to 40 characters. The search is case-insensitive.
Note: If you are searching for a life cycle or a queue, all reference to that life cycle or queue in
a rule or action are searched for.
5. If you want to search a specific life cycle, select Search this Life Cycle Only check box
and select the appropriate life cycle from the corresponding drop-down list.
Note: If you select this search option, and you are searching for an action, a rule, a task list,
or a timer, the Object drop-down list will refresh to only include those objects that exist in the
selected life cycle.
6. If you selected the Search this Life Cycle Only check box, you can also search a specific
queue within the selected life cycle. If you want to search a specific queue, select the
Search this Queue Only check box and select the appropriate queue from the
corresponding drop-down list.
2012 Hyland Software, Inc.
298
OnBase 12 Workflow
7. Click Search and the system will proceed to check the life cycle configuration and
determine all locations that the object is in use. A list is then presented and can be
sorted by Life Cycle, Queue, and Top Task List, and Task List, Action or Rule columns.
8. Select the object of interest and click Open Occurrence or double-click the item in the
list. This opens the Workflow configuration tree at that location and automatically
selects the object (or the container object, if the object itself does not appear in the
tree).
The search results list remains open after an occurrence is selected, to allow selection
of other objects without having to perform the search multiple times. During this time,
normal actions in Workflow configuration may be performed.
To perform another search, click Next Search and the Workflow Search dialog box will
be presented again. Click Close.
2012 Hyland Software, Inc.
299
Workflow OnBase 12
Workflow Replay
Workflow Replay shows the state of a life cycle at any given time. This is a tool to allow
system administrators to uncover bottlenecks and inefficiencies within a life cycle. Workflow
Configuration Module Configuration
Note: Although Workflow Replay is executed in its own viewer, it can only be used if Workflow
is active. Closing the Workflow window also terminates Workflow Replay.
1. To use Workflow Replay, right-click the life cycle name in the tree view of the Classic
Client interface.
2. Select Workflow Replay. A graphic view displays the state of each of the queues at the
date and time specified in the Workflow Replay Controls window.
Oldest Date - The date and time when the first document entered the queue.
Recent Date - The most recent date and time currently being tracked for the queue.
Document Count - The number of documents processed by the queue. The counter is
increased incrementally for each processing function performed on a document, this
number does not track the physical number of documents in the queue, but rather
document transactions.
2012 Hyland Software, Inc.
300
OnBase 12 Workflow
Note: In order to adjust the time interval per multiple time characteristics (i.e., day, hour and
minute), use the date and time drop-downs.
1. Adjust the date and/or time using the arrows in the associated drop-downs.
2. When the time interval is satisfactory, select Set Time.
The queues are updated with statistics that summarize the change in queue count
over the time interval specified. The time interval is defined by the currently set time
and the time prior to when Set Time was activated.
Workflow Doctor
Workflow Doctor is used to examine the state and general health of a life cycle configuration
and the related Workflow system. It can be used to diagnose existing and potential problems
for a Workflow system. Each time Workflow Doctor is used, a Workflow Doctor Configuration
Report is produced and stored in the SYS Configuration Reports Document Type.
The Workflow Doctor consists of the following:
Report Issues. See page 302.
Fix Configuration Errors. See page 305.
2012 Hyland Software, Inc.
301
Workflow OnBase 12
Report Issues
You can run a report of the issues existing in OnBase. This function analyzes existing life
Configuration Module Configuration
cycle(s) and produces corresponding reports. Reports created can be accessed in the Client
module in the SYS Configuration Reports Document Type. When reports are run as one single
report, reports have a description Keyword Value of WORKFLOW DOCTOR. To run a report of
issues:
1. In the Configuration module, select Workflow | WF Doctor | Report issues. The Select
Reports dialog box is displayed.
2012 Hyland Software, Inc.
302
OnBase 12 Workflow
2. Select the check box next to the appropriate report items to be included in a final
Workflow Doctor Configuration Report. By default, all items under a report type will be
selected. To deselect all items, select the corresponding check box. You also can select
individual items to include in the report. The following is a description of each category
Object Count The count of each type of Workflow object that is configured in the system.
Document Includes the number of documents in each queue, broken down by life cycle, the
Statistics oldest/newest documents in each queue, the number of documents processed by
each user, and the average time a document spends in each queue.
Transitions Transition that have been created in the graphic view, and have been configured in
that have a Workflow function, but have not been executed.
never been
used
Configuration Issues - errors that exist in the configuration of the life cycle.
Disabled Objects that are currently configured for use, but have been disabled (e.g., disabled
Objects logging of a document in the Workflow log, disabled task lists, rules, actions, etc.)
Duplicate Instances where a duplicate name is found for the same life cycle entry (typically
Object names caused by import/export errors).
in Life Cycle
Graphic Life cycles that have not had a graphic layout created for them.
Layout
Missing
Incorrectly The objects that have an invalid configuration by either an error in configuration or a
Configured removed/deleted object. For example, a transition action that has a "From queue
Objects that is in a different life cycle than the To queue.
Objects Objects that have not been associated with a specific icon via Workflow
without Configuration.
Icons
Rules or The rules, actions, and task lists that are triggered by a timer at a specific point in
Actions time, and require input from the user.
under Timers
requiring
User
Interaction
2012 Hyland Software, Inc.
303
Workflow OnBase 12
Task List Tasks lists that have been configured with more than 10 levels of nesting.
Trees that
Configuration Module Configuration
are Over 10
Levels Deep
Transitions Transitions that have been created in the graphic layout, but are not used in any
that are Workflow configuration.
Present with
no
Configuration
to use them
System Errors - errors that exist in the client execution of the life cycle.
Documents Referential Documents that have references in Workflow, but have been
Integrity deleted.
Invalid Task Sequence Task list sequences that either are out of order or have multiple
tasks with the same sequence number.
Missing Tasks Queues that have become corrupt because they are pointing to
load balancing work, user work, or system work that does not
actually exist; therefore, task lists are listed that do not exist.
Object Rights Referential Users that have rights to an object that does not exist or users
Integrity that do not exist have rights to a Workflow object.
Orphaned Objects The objects that are no longer in use (i.e., not part of any
configured life cycle).
System Referential Integrity Workflow objects that have been deleted, but have lingering
configuration. For example, if you have a deleted queue that is still
assigned to a life cycle, it would fall under this category.
Remove Rules-Based User Locates instances where a document is not present in a life cycle,
Assignments for Documents but still has a load balance assignment associated with it, and
Not In Life Cycle remove these assignments from the database.
3. If you would like the selected report sections generated into separate reports, select
the Create Separate Reports option. When System Statistics, Configuration Issues, and
System Errors are all selected, a single report will be created with a Description
Keyword Value of WORKFLOW DOCTOR. When the reports are generated separately,
reports will be created for each section. The System Statistics report will have a
Description Keyword Value of SYSTEM STATISTICS. The Configuration Issues report
will have a Description Keyword Value of CONFIGURATION ERRORS. The System
Errors report will have a Description Keyword Value of SYSTEM ERRORS.
2012 Hyland Software, Inc.
304
OnBase 12 Workflow
2012 Hyland Software, Inc.
305
Workflow OnBase 12
2. Select the appropriate error(s) you want to find. If you want to find all errors, select
the All Errors check box. For information about the types of errors, see the descriptions
in Report Issues on page 302.
3. Click Next>>. The Select Life Cycles dialog box is displayed.
Configuration Module Configuration
4. Select the appropriate life cycles and click Add>>. Click Add All>> to add all life cycles.
5. Click Diagnose.
6. Both the Workflow Tree Configuration dialog box and the Workflow Configuration Errors
dialog box open.
7. Any existing configuration errors display in the Workflow Objects list with information
concerning the type of object, the error type, and the name of the object.
2012 Hyland Software, Inc.
306
OnBase 12 Workflow
8. To view the details of an error, select the error. Information pertaining to the errors
location is displayed in the Object Location list.
9. To automatically find the error to correct it, select the error and click Open Occurrence.
The error will be opened in the Tree Configuration dialog box, allowing you to make
To refresh the display in order to see the most recent error results, click Search.
1. In the Configuration module, select Workflow | WF Doctor | Fix System Errors. The
Select Errors dialog box is displayed.
2. Select the appropriate error(s) you want to find. If you want to find all errors, select
the All Errors check box. For information about the types of errors, see the descriptions
in Report Issues on page 302.
2012 Hyland Software, Inc.
307
Workflow OnBase 12
4. To automatically find the error to correct it, select the error and click Repair. You can
repair all errors by clicking Repair All.
5. When you are done repairing errors, click Cancel to exit the dialog box.
System Interaction
Database
The performance of Workflow can be adversely affected if the database indexes are not
properly maintained. This maintenance will vary depending on the type of database. (i.e.,
Oracle, Microsoft SQL Server, etc.) Also, the placement of the OnBase table spaces on the
type and number of RAID arrays can also dramatically affect performance. See database
documentation for a discussion on this topic.
Security
Access to documents via Workflow is accomplished by a combination of assignments made at
the document type, life cycle, and work queue level. Specifically:
2012 Hyland Software, Inc.
308
OnBase 12 Workflow
Caution: The ability to view documents in a life cycle is controlled at the queue level. If a user has
rights to a Workflow queue, they will also have rights to view all the documents in that queue,
regardless of their security rights (i.e., security keyword assignments, Document Type rights).
EDM Services
If a user does not have rights to the Document Type to which a document belongs that is in
Workflow, the Save as New Document button is disabled in Workflow. If you want to create a
new document under this circumstance, use the DOC - Copy Document action.
Likewise, if a user does not have rights to the Document Type to which a document belongs
that is in Workflow and the queue the document belongs to does not have the proper Override
Document Modification Privilege options selected, the Save as Revision button is disabled in
Workflow.
When documents are checked out to the EDM Briefcase, Workflow actions are still executed
upon them.
1. Create and configure a Workflow e-mail notification with the Add Outlook Header check
box selected.
2. Add the e-mail notification you created in step 1 to the system work of a queue, using
one of the following action types:
Notify - Send Notification
2012 Hyland Software, Inc.
309
Workflow OnBase 12
2012 Hyland Software, Inc.
310
WORKFLOW INSTALLATION
Requirements
The following sections list requirements for using Workflow with the OnBase Client and
Desktop.
If you will be using Workflow with the Web Client, refer to the Web Server documentation for
current Web Server requirements.
If you will be using Workflow with the Unity Client, refer to the Unity Client documentation for
current Unity Client requirements.
Refer to the respective documentation for current requirements if you will be using Workflow
with any of the following modules:
Integration for Microsoft Outlook 2007
Integration for Microsoft Outlook 2010
Mobile Access for Android Phone
Mobile Access for BlackBerry Phone
Mobile Access for iPad
Mobile Access for iPhone
Mobile Access for Windows Phone
Mobile Workflow for BlackBerry
Office Business Application for 2007
Office Business Application for 2010
2012 Hyland Software, Inc.
311
Workflow OnBase 12
Note: As of release 7.2, OnBase no longer supports the use of the Windows NT 4.0 and
Windows 98 operating systems. Microsoft retired its support of Windows NT 4.0 on January
1, 2005 and Windows 98 on July 11, 2006. Microsoft no longer offers technical support or
security updates for these operating systems.
Workflow Installation
Note: As of release 10.0.0, OnBase no longer supports the use of the Windows 2000
Professional Edition and Windows 2000 Server operating systems. Microsofts extended
support for these operating systems was retired on July 13, 2010. Microsoft will no longer
offer technical support or security updates for these operating systems after that date.
Additionally, these operating systems do not support Microsoft .NET Framework 4.0, which is
a requirement as of OnBase version 10.0.0. If you are using either Windows 2000 operating
system, you should not upgrade to OnBase 12 until you have upgraded to a Windows
operating system supported by OnBase.
Note: The Microsoft Visual C++ 2010 Redistributable Package (x86) is installed using the
vcredist_x86.exe delivered with OnBase.
Screen Resolution 1024 x 768 (1280 x 800) 1280 x 1024 (1440 x 900 widescreen)
2012 Hyland Software, Inc.
312
OnBase 12 Workflow
Apple Mac OS X version 10.4 or laterSupported only by the HTML Web Client and
Java Web Client.
Windows XP SP3 or later service pack
Windows Server 2003 SP2 or later service pack
Windows Vista SP1 or later service pack
Windows Server 2008 SP2 or later service pack
Windows Server 2008 R2 SP1 or later service pack
Workflow Installation
Windows 7 RTM or later service pack
Note: As of release 7.2, OnBase no longer supports the use of the Windows NT 4.0 and
Windows 98 operating systems. Microsoft retired its support of Windows NT 4.0 on January
1, 2005 and Windows 98 on July 11, 2006. Microsoft no longer offers technical support or
security updates for these operating systems.
Note: As of release 10.0.0, OnBase no longer supports the use of the Windows 2000
Professional Edition and Windows 2000 Server operating systems. Microsofts extended
support for these operating systems was retired on July 13, 2010. Microsoft will no longer
offer technical support or security updates for these operating systems after that date.
Additionally, these operating systems do not support Microsoft .NET Framework 4.0, which is
an OnBase requirement as of version 10.0.0. If you are using either Windows 2000 operating
system, you should not upgrade to OnBase 12 until you have upgraded to a Windows
operating system supported by OnBase.
Desktop Requirements
CPU 1 GHz
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.
2012 Hyland Software, Inc.
313
Workflow OnBase 12
Databases Supported
The following tables list the databases supported in OnBase 12.
Microsoft SQL Server Microsoft SQL Server 2000 and 2005 must be running in compatibility
2000 (SP4 mode 7 or greater. Running in compatibility mode 6.5 or lower will result
recommended) in errors during the upgrade process.
Microsoft SQL Server SQL Server 2005 drivers must be upgraded to the Feature Pack for
2005 (SP2 or later Microsoft SQL Server 2005 - December 2008 or a later feature pack.
recommended)
Microsoft SQL Server Note: On January 11, 2011 Microsoft discontinued technical support for
2008 (RTM, SP1, SP2; Microsoft SQL Server 7.0. As of release 11.0.0, Hyland Software no
SP2 recommended) longer supports SQL Server 7.0.
Microsoft SQL Server
2008 R2 (RTM, SP1; Note: You must ensure that your SQL Server database client software
SP1 recommended) version matches or exceeds the database server version. For example, if
Microsoft SQL Server your database server is SQL Server 2005, verify that the database client
2012 is SQL Server 2005 (or later). Running a previous client version, such as
SQL Server 2000, 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 315.
2012 Hyland Software, Inc.
314
OnBase 12 Workflow
Oracle
Note: If you are using an Oracle database, it is strongly recommended that you have a
certified Oracle Database Administrator on staff.
Workflow Installation
Oracle v 8.0.5.0 or Oracle version 8.0.5.0 can be used, but it is not recommended due to
later 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 ODBC drivers should be 8.1.7 or later. 8.1.6.x drivers have known issues
later and are not supported.
2012 Hyland Software, Inc.
315
Workflow OnBase 12
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
Workflow Installation
(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).
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.
If your database server software is SQL Server 2005, the version number should
appear as 2005.[##.####.##] (or later), where 2005 is the version number and
[##.####.##] represents the service pack.
The above descriptions are examples of two commonly used database version numbering
schemes. Ensure that the supported database you use adheres to the database client/server
recommendation.
Database/File Servers
Server requirements are site-specific. Database/file servers should be dedicated purpose
servers; i.e., not used as a domain controller, e-mail 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.
2012 Hyland Software, Inc.
316
OnBase 12 Workflow
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.
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
Workflow Installation
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.
2012 Hyland Software, Inc.
317
Workflow OnBase 12
Licensing
See Licensing on page 3 for licensing requirements.
Pre-Installation
You must have a functioning OnBase database licensed for Workflow.
Installation
The Professional Services Group (PSG) at Hyland Software, Inc. (HSI) is exclusively
responsible for technical involvement with all OnBase Workflow implementations. OnBase
Solution Providers can engage the PSG in either an advisory role, or as the primary provider
of the design, installation, and integration or support of OnBase Workflow solutions. Prior to
engagement, OnBase Solution Providers must sign an integration services agreement,
provide a detailed statement of work, and issue a purchase order for PSG services.
Hyland Softwares PSG must play the role of primary provider in any case where the OnBase
Solution Provider is not an HSI-certified OnBase Workflow installer.
2012 Hyland Software, Inc.
318
OnBase 12 Workflow
In order for notifications to be sent using the Hyland Distribution Service, the Use E-mail
Distribution Service for automated e-mails global client setting must be selected. If you are
using the web Workflow interface, you must restart the web services before the setting will
take effect. To set this setting:
Workflow Installation
4. Click Save.
Note: You do not need a separate license in order to use the Application Server.
2012 Hyland Software, Inc.
319
Workflow OnBase 12
1. In the Configuration module, select Utils | Application Server. The Application Server
Configuration dialog box is displayed.
Workflow Installation
2. Enter the Application Server Path. This path must point to the OnBase Application
Server. Pointing it to the OnBase Web Server is not supported.
For a typical installation, the path will be like the following: http://hostname/
AppServer/Service.asmx. The path can be up to 255 characters.
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.
2012 Hyland Software, Inc.
320
OnBase 12 Workflow
If there is no queue with that ID, the Workflow will still be opened by default, but no queue
should be opened.
Note: If an Auto-Open Queue is specified in the OnBase Clients Workstation Options dialog box,
it will override the queue specified to open by default in the web.config file.
Note: When Workflow is opened by default, when you click the Back button, the Retrieval
Workflow Installation
context is available when you click the Retrieve button.
Viewer Vars
WORKFLOWMENU When workflowMenu is set to true, the Workflow right-click option is
available from the open document right-click menu.
WORKFLOW RELATED DOCUMENTS The DisplayRelatedDocuments setting controls tab
focus. If this is set to always, the focus will always be on the Work Folder tab upon document
selection in a queue. If this is set to never, the focus will always be in the Documents tab upon
document selection in a queue. If this is set to document, the focus will be on the Work Folder
tab when related documents exist for the selected document in a queue. Otherwise, focus will
remain on the Documents tab.
WINDOW SIZE The WorkflowUserInteractionHeight setting controls the size of the top half
of the Workflow window. This setting is measured in pixels. The minimum value is 150. The
default value is 375.
2012 Hyland Software, Inc.
321
Workflow OnBase 12
Setting Description
enableWfQueueCountService This setting controls whether the Unity Client respects the
configured Inbox Refresh Rate for Workflow queues.
When set to true, the configured Inbox Refresh Rate for
all Workflow queues is used. When set to false, the
configured Inbox Refresh Rate for all Workflow queues is
not used.
This setting is not present in the Unity Client configuration
file by default. When this setting is not present in the
Unity Client configuration file, it is treated as true. To
configure this setting, you must manually add it to the
Unity Client configuration files <appsettings> section, in
the following format:
<add key="enableWfQueueCountService"
value="true"/>
Tip: Use this setting to limit which users are using the
configured Inbox Refresh Rate.
2012 Hyland Software, Inc.
322
OnBase 12 Workflow
Setting Description
startupWorkflowLayout This setting controls the OnBase User Group layout that is
displayed by default when a user opens the Unity Clients
Workflow interface.
When set to a numeric ID of a layout that was created by
an administrator for a user group, the configured layout is
Workflow Installation
used.
For more information on the Unity Client configuration file, including location and additional
settings, see the Unity Client documentation.
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.
2012 Hyland Software, Inc.
323
Workflow OnBase 12
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.
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.
Location
The table below shows the default location of the onbase32.ini for supported operating
systems.
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.
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.
2012 Hyland Software, Inc.
324
OnBase 12 Workflow
Workflow Installation
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 shortcut 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.
2012 Hyland Software, Inc.
325
Workflow OnBase 12
[System] section
Workflow Installation
[Workflow] section
DefaultHTMLBackground Defines the image used for the background of the inbox and
the graphical view. The background image used must be a
valid bitmap (.bmp) image file.
HTMLTextColor Defines the text color for auto-generated HTML forms. This
entry is Red, Green, Blue (RGB) format with values in the
range of 1-255.
InitGraphicZoom Indicates the initial zoom level for the graphic view. Valid
values are 1-20.
GridColor Indicates the grid color in the graphic view. This entry is RGB
format. Valid values range from 1-255.
2012 Hyland Software, Inc.
326
OnBase 12 Workflow
Settings Description
Workflow Installation
Terminal Bar* Used internally by OnBase to indicate the ID of the last
control bar on which the terminal window was docked
SubmitFlag* Indicates the hot key used to answer 'Yes' to a message box
or submit forms
SubmitKey*
NoFlag* Indicates the hot key used to answer 'No' to a message box.
NoKey*
LCWindowFlag* Indicates the hot key used to set focus to the Life cycle
window
LCWindowKey*
DocumentWindowFlag* Indicates the hot key used to set focus to the Document
window
DocumentWindowKey*
UIWindowFlag Indicates the hot key used to set focus to the User
Interaction window
UIWindowKey
FolderWindowFlag* Indicates the hot key used to set focus to the Folder window
FolderWindowKey*
Last Life Cycle* Indicates the number of the life cycle opened during the
previous Workflow session; this life cycle opens by default on
the next session.
2012 Hyland Software, Inc.
327
Workflow OnBase 12
Settings Description
RecycleTopLevelWindow Applies to the Use Top Level Window check box in Display
Document actions. If set to 1 (default), when a new
document is displayed, it reuses the window, if it exists. This
allows you to position the top-level window in a second
monitor. All displayed documents will appear in that window.
If 0 (zero), each display action opens a new window at the
Workflow Installation
StatusPaneOrder Specifies the order if panes of the status bar for the Workflow
Inbox window. Panes should be comma separated. Example:
StatusPaneOrder=1,2,3, 4
StatusPaneSize_1 Specifies the size of the Queue Name pane. Value measured
in pixels. Default value: StatusPaneSize_1=200
StatusPaneSize_2 Specifies the size of the User Name pane. Value measured in
pixels. Default value: StatusPaneSize_2=150
2012 Hyland Software, Inc.
328
OnBase 12 Workflow
Settings Description
Parent Window Zoomed Defines whether the Workflow parent window is maximized
or not.
SplitPaneSize Defines the location for the split in the Workflow window.
Workflow Installation
Client will wait for a response from the Application Server
during ad hoc task execution.
[Colors] section
WFManualTransition Indicates the color of transition lines in the graphic view. This
entry is RGB format with values in the range of 1-255.
[Customer] section
2012 Hyland Software, Inc.
329
Workflow OnBase 12
Settings Description
[WorkflowInboxColumnWidths] section
Document Name Sets the width of the Document Name inbox column in
pixels.
Arrival Time Sets the width of the Arrival Time inbox column in pixels.
These .INI settings are used to store the layout of the Workflow display and cannot be edited
manually:
[Workflow-Bar1]
2012 Hyland Software, Inc.
330
OnBase 12 Workflow
The following INI settings control the display of the Core-based OnBase Client user interface.
These .INI settings are used to store the layout of the Workflow display and cannot be edited
manually:
[WorkflowWindowPosition-Summary]
Workflow Installation
ScreenCX=1280 Cannot be edited.
[WorkflowWindowPosition-
BarX]
2012 Hyland Software, Inc.
331
Workflow OnBase 12
Backup/Recovery
Backup
Configuration
The configuration of Workflow is stored in the database. A proper backup of the database will
Workflow Installation
Registry Settings
If you are using the Hyland Distribution Service and/or you are using notification actions in
conjunction with Windows XP SP2, you must back up your registry.
External Files
It is necessary to backup the onbase32.ini file.
It is necessary to backup the Web Servers web.config file if using Workflow in the Web Client.
Recovery
Configuration
Restoring all Disk Groups and restoring the database from backup will recover Workflow data.
The Workflow Import feature can be used to recover Workflow life cycles.
External Files
Restore the onbase32.ini file.
Web.config
Restore the web.config file for the Web Server installation.
Troubleshooting
There are several tools for troubleshooting life cycles.
2012 Hyland Software, Inc.
332
OnBase 12 Workflow
Debug Breakpoints
This option causes a Windows message box to display before the execution of the rule. This is
useful for determining the location of logic problems in a Workflow configuration.
To use this option in the OnBase Client, you must have the -WFTRACE command line switch
applied to the Client modules shortcut and the Step Debug toolbar button activated or the
Trace Window open within the Client module.
Workflow Installation
A command line switch is not required to use this option in the Unity Workflow interface.
The Unity Client configuration files enableWorkflowDebugTrace setting controls whether the
Debug Options ribbon group is displayed on the Developer tab. When set to true, the Debug
Options ribbon group is displayed. When set to false, the Debug Options ribbon group is not
displayed.
Note: The enableWorkflowDebugTrace setting controls whether the Debug Options ribbon group
is displayed when accessing the Unity Workflow interface through other OnBase modules,
such as the Integration for Microsoft Outlook 2007.
Queue Logging
The Workflow log is a report of the activities in Workflow. The information is contained in a
database table that tracks changes made to documents within the Workflow. Privileges to
view this log are limited to the system administrator; however, users may be given authority
to purge all, or a selection, of the log file.
Workflow log entries consume database space and add overhead to processing time. Use
logging only when necessary.
Note: The Workflow Log menu option is visible only if your user group has been granted
appropriate rights.
Purge
Users granted permission to purge the Workflow log could do so in the Client module by
selecting the Admin | Workflow Log |Purge All Entries. A Confirmation message box opens. To
proceed with the purge, click Yes. Clicking No closes the message box and cancels the purge.
2012 Hyland Software, Inc.
333
Workflow OnBase 12
Restricted Purge
To open the Workflow Log Restricted Purge dialog box, select Admin | Workflow Log | Restricted
Purge.
Workflow Installation
A restricted purge enables you to focus purging entries based on one or more specific life
cycles and/or queues, or a document handle or a range of entry dates.
Caution: Once you delete information from the Workflow log, it is permanently removed from the
database.
2012 Hyland Software, Inc.
334
OnBase 12 Workflow
Generate Reports
Configuration Report
In the Configuration module, right-click on a life cycle and select Create Configuration Report.
This generates a configuration report that can be viewed in the Client.
Workflow Installation
In Document Retrieval, select the System Documents Document Type Group and SYS
Configuration Reports Document Type. This report steps through the queues and task lists and
all the options configured for the entire Workflow.
2012 Hyland Software, Inc.
335
Workflow OnBase 12
2. To view this report through Document Retrieval later, select the System Documents
Document Type Group.
Workflow Installation
3. Reports are stored in the SYS List Contents Report Document Type.
Timers
You need the -WFSRVR command line switch applied to the Client workstation monitoring
timers in the Classic Client using the Workflow System Monitor.
For all other interfaces, the Workflow Timer Service should be used to monitor timers. See the
Workflow Timer Service documentation for more information.
2012 Hyland Software, Inc.
336
OnBase 12 Workflow
Workflow Installation
If the Application Server is not configured correctly and running, the following message is
displayed: Unable to initialize Workflow. Failed to connect to application server. Check that the
application server is running and that the application server URL is correct.
Diagnostics Console
You can log Workflow trace information to the Workflow Trace tab of the Diagnostics Console
by completing the following steps:
2012 Hyland Software, Inc.
337
Workflow OnBase 12
For more information about configuring the Diagnostics Console, see the Diagnostics Console
Help files.
Contacting Support
When contacting your solution provider, please provide the following information:
The OnBase module where the issue was encountered.
The OnBase version and build (Example: 12.571) and/or the Core Services version
and build (Example: 12.6).
The type and version of the connected database, such as Microsoft SQL Server 2008
or Oracle 11g, and any Service Packs that have been installed.
The operating system that the workstation is running on, such as Windows XP or
Windows Server 2008, and any Service Packs that have been installed. Check the
supported operating systems for this module to ensure that the operating system is
supported.
The name and version of any application related to the issue.
The version of Internet Explorer, and any Service Packs that have been installed, if
applicable.
A complete description of the problem, including actions leading up to the issue.
Screenshots of any error messages.
Supplied with the above information, your solution provider can better assist you in correcting
the issue.
2012 Hyland Software, Inc.
338
CONFIGURATION MODULE ACTIONS
DESCRIPTIONS
Caution: Encrypted keywords are not supported in the Classic Client interface.
Caution: Within Workflow life cycles, users with rights to tasks that modify keywords can modify
encrypted Keyword Values upon task execution, regardless of their encrypted keyword user
rights. When using E-Forms that display user interaction, encrypted keywords are displayed
masked when the user does not have rights to view encrypted Keyword Values and the user
cannot change values that they do not have rights to regardless of the users ad hoc task rights.
Note: System tasks that require user interaction are supported in the Unity and Web
interfaces. System tasks that require user interaction are not supported in all other Core-
based interfaces. When using the Classic Client interface, it is not recommended to configure
system tasks that require user interaction.
Note: When configuring timer work, work that requires user interaction is not supported and,
if configured for timer work, may produce undesired results.
Actions
The following prefixes are used to group actions:
DOC actions performed on the active document or a document related to the current
document.
FORM actions that create or display forms.
KEY actions performed on keywords or related to keywords.
Caution: Actions in Workflow that add or change Keyword Values to a document do not adhere to
the Keyword Must Be Unique and Keyword Must Exist Keyword Type settings. Pay close attention
when configuring these actions.
Caution: If an action changes a Keyword Value to a value that is larger than the allowed length,
the value may be truncated, ignored, or not saved.
Caution: Actions that involve comparing keywords configured for Case Sensitive Searching must
match the keywords exactly or the desired results may not be achieved. Pay close attention to
any configured Case Sensitive settings in your system. Property names are also case sensitive.
2012 Hyland Software, Inc.
339
Workflow OnBase 12
KEYSET actions related to AutoFill Keyword Sets and their values in OnBase.
Configuration Module Actions Descriptions
Note: Actions with the KEYSET prefix are not compatible with external AutoFill Keyword Sets.
Note: If you will be using Workflow AutoFill Keyword Set actions, you must associate your
AutoFill Keyword Sets at the Document Type level.
MED actions that are related to the Medical Records Management module.
NOTIFY actions that prompt notifications to be sent or displayed.
Note: If you are sending attachments with notifications and are using Windows XP SP2, in
order to successfully send the attachments with the notifications, the following registry
setting must be set:
Under: HKEY_LOCAL_MACHINE\Software\Microsoft\Internet Explorer\Main\FeatureControl
(32 bit system) or HKEY_LOCAL_MACHINE\Software\Wow6432Node\Microsoft\Internet
Explorer\Main\FeatureControl (64 bit system)
On the server:
FEATURE_MIME_HANDLING\explorer.exe and FEATURE_MIME_HANDLING\iexplore.exe:
should be set to 1
FEATURE_MIME_SNIFFING\explorer.exe and FEATURE_MIME_SNIFFING\iexplore.exe: should
be set to 1
On the client:
LOCALMACHINE_LOCKDOWN\explorer.exe and LOCALMACHINE_LOCKDOWN\iexplore.exe:
should be set to 1
Workflow Property Bag - The Workflow Property Bag is a session specific property bag that can
be used to store and retrieve temporary values from VBScripts and the property-related
actions and rules. The values in the Workflow property bag can also be used in the conditions
for a rule queue.
Note: The >>Assigned To, >>Batch Number, >>Document Date, >>Document Handle, >>Entry
to Queue Date, >>Last Revision, and >>Last Version options are functional only in the Core-
based interfaces.
2012 Hyland Software, Inc.
340
OnBase 12 Workflow
You can specify a life cycle and queue to which you want to add the document. Select a Life
Cycle from the drop-down select list. Select a queue from the Assign Document to this Queue
1. Select the Get Life Cycle from this Property check box. The Life Cycle and Assign
Document to this Queue drop-down select lists are disabled. The Get Queue from this
Property check box is automatically selected.
2. Enter the name of the property from which you want to pull the life cycle in the field
under the Get Life Cycle from this Property check box.
3. If you do not want the document added to the initial queue of the life cycle, enter the
name of the property from which you want to pull the queue in the field under the Get
Queue from this Property check box. If this field is left blank, the life cycles initial queue
will be used.
In addition, you can select the Get Queue from this Property check box to specify a
property for the queue, while using a life cycle selected in the Life Cycle drop-down list.
You can select the Use Initial Queue if Property does not exist option if you want
documents to be placed in the initial queue when a property does not exist.
Note: The Use Initial Queue, if property does not exist option is only supported in the Web Client
and Core-based OnBase Client interfaces.
Note: You must be licensed for Integration for Microsoft Search for this action to function.
Adds a related document to a configured Content Source for Integration for Microsoft Search.
This will enable the document to be crawled for full-text search in Microsoft SharePoint.
Select a Content Source to assign the related document to. This will display all the configured
Content Sources.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
2012 Hyland Software, Inc.
341
Workflow OnBase 12
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
2012 Hyland Software, Inc.
342
OnBase 12 Workflow
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
Associated Primary Document (Applicable to Work Folder documents only)
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
2012 Hyland Software, Inc.
343
Workflow OnBase 12
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
2012 Hyland Software, Inc.
344
OnBase 12 Workflow
After you select the related Document Type, click Common Keywords. The Related Document
Types dialog box opens. To add Keyword Types to the list, select the Keyword Type in the list
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
2012 Hyland Software, Inc.
345
Workflow OnBase 12
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
2012 Hyland Software, Inc.
346
OnBase 12 Workflow
You can specify a life cycle and queue to which you want to add the document. Select a Life
Cycle from the drop-down select list. Select a queue from the Assign Document to this Queue
1. Select the Get Life Cycle from this Property check box. The Life Cycle and Assign
Document to this Queue drop-down select lists are disabled. The Get Queue from this
Property check box is automatically selected.
2. Enter the name of the property from which you want to pull the life cycle in the field
under the Get Life Cycle from this Property check box.
3. If you do not want the document added to the initial queue of the life cycle, enter the
name of the property from which you want to pull the queue in the field under the Get
Queue from this Property check box. If this field is left blank, the life cycles initial queue
will be used.
In addition, you can select the Get Queue from this Property check box to specify a
property for the queue, while using a life cycle selected in the Life Cycle drop-down list.
You can select the Use Initial Queue if Property does not exist option if you want
documents to be placed in the initial queue when a property does not exist.
Note: The Use Initial Queue, if property does not exist option is only supported in the Web Client
and Core-based OnBase Client interfaces.
Note: You must be licensed for Integration for Microsoft Search for this action to function.
Adds a document to a configured Content Source for Integration for Microsoft Search. This
will enable the document to be crawled for full-text search in Microsoft SharePoint.
Select a Content Source from the Content Source drop-down select list.
Assigns the displayed related document to a reading group. This action can be used to prompt
the user for assignment information or it can be used to automatically assign documents to a
reading group.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
2012 Hyland Software, Inc.
347
Workflow OnBase 12
Under the Related Documents heading, the status of the related documents configuration is
displayed.
Configuration Module Actions Descriptions
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
2012 Hyland Software, Inc.
348
OnBase 12 Workflow
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
Associated Primary Document (Applicable to Work Folder documents only)
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
2012 Hyland Software, Inc.
349
Workflow OnBase 12
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
Note: If the document is already in a reading group, processing breaks and the subsequent
actions/rules in a task list will not complete.
Note: This action is not supported in the OnBase Mobile interfaces when this option is
selected.
Note: In order to use this option successfully, users must have rights to the appropriate
reading groups to make new assignments.
Note: In the Client, if the Create New Assignment dialog box is canceled, processing breaks and
the subsequent actions/rules in a task list will not complete.
2012 Hyland Software, Inc.
350
OnBase 12 Workflow
Note: This action is only available if licensed for the Document Knowledge Transfer module.
Assigns the document to a reading group. This action can be used to prompt the user for
assignment information or it can be used to automatically assign documents to a reading
group.
Note: When a reading group is configured with the Enable Deadline Date option in the
Document Knowledge Transfer module, documents entering a reading group using this action
will assign the configured deadline date to the document.
Note: If the document is already in a reading group, processing breaks and the subsequent
actions/rules in a task list will not complete.
Note: This action is not supported in the OnBase Mobile interfaces when this option is
selected.
Note: In order to use this option successfully, users must have rights to the appropriate
reading groups to make new assignments.
Note: In the Client, if the Create New Assignment dialog box is canceled, processing breaks and
the subsequent actions/rules in a task list will not complete.
2012 Hyland Software, Inc.
351
Workflow OnBase 12
If you want to require that documents are filtered through one or two approval groups before
being sent to users for review, select the appropriate group(s) from the drop-down select
Configuration Module Actions Descriptions
list(s).
New Revision Should Use Existing Settings
When this option is selected, if the document is the latest revision of a document, it will copy
the assignment from the previous revision, instead of performing the assignment of the
selected radio button. If the document is not revisable, this is the first revision of the
document, or the previous revision was not assigned to any group, this option is ignored and
the selected radio button setting will be applied.
5. Select the Only Auto-Folder this Item from Workflow Auto-Folder Actions check box.
2012 Hyland Software, Inc.
352
OnBase 12 Workflow
6. Repeat steps 4 and 5 for each Document Type you want to configure auto-foldering in
conjunction with Workflow actions.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
2012 Hyland Software, Inc.
353
Workflow OnBase 12
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
Configuration Module Actions Descriptions
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
Associated Primary Document (Applicable to Work Folder documents only)
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
2012 Hyland Software, Inc.
354
OnBase 12 Workflow
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
2012 Hyland Software, Inc.
355
Workflow OnBase 12
4. Select the Document Type within the Selected Document Types box that you want to
auto-folder only in conjunction with Workflow actions.
Configuration Module Actions Descriptions
5. Select the Only Auto-Folder this Item from Workflow Auto-Folder Actions check box.
6. Repeat steps 4 and 5 for each Document Type you want to configure auto-foldering in
conjunction with Workflow actions.
7. Click Save.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
2012 Hyland Software, Inc.
356
OnBase 12 Workflow
Under the Related Documents heading, the status of the related documents configuration is
displayed.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
2012 Hyland Software, Inc.
357
Workflow OnBase 12
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
Configuration Module Actions Descriptions
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
Associated Primary Document (Applicable to Work Folder documents only)
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
2012 Hyland Software, Inc.
358
OnBase 12 Workflow
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
2012 Hyland Software, Inc.
359
Workflow OnBase 12
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Configuration Module Actions Descriptions
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
2012 Hyland Software, Inc.
360
OnBase 12 Workflow
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
2012 Hyland Software, Inc.
361
Workflow OnBase 12
Configuration Module Actions Descriptions
Note: If the primary document belongs to a closed or cutoff Records Management folder, the
Document Handle Keyword Value will not be copied from the new document to the primary
document.
You can copy notes on the current document by selecting Copy Note(s).
The copied document is not added to Workflow by default. If you want the document to be
added to Workflow, select Initiate Workflow.
If the document that is being copied belongs to a Document Type that is configured for auto-
foldering, when the documents keywords are copied, auto-foldering is initiated.
Note: If the original documents Document Type has E-form revisions associated with it, the
revision associated with the original document will be used for the copied document and not
the latest revision.
Note: If working in an Institutional Database, the Institution # keyword will always be copied,
regardless of selection.
Note: If a document has multiple renditions of the current revision of the document, the
renditions will also be copied.
2012 Hyland Software, Inc.
362
OnBase 12 Workflow
In order for this action to complete successfully, the documents file format must be
compatible with the type of note or annotation to be placed on it. The following table
illustrates what file formats are compatible with what type of notes and annotations. See the
System Administration documentation for more information about notes and annotations.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
2012 Hyland Software, Inc.
363
Workflow OnBase 12
Select a Document Type from the Related Document Type drop-down list.
Configuration Module Actions Descriptions
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
2012 Hyland Software, Inc.
364
OnBase 12 Workflow
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
2012 Hyland Software, Inc.
365
Workflow OnBase 12
Note: When adding a note to a document with multiple pages, the note is added to the first
Configuration Module Actions Descriptions
page.
Note: The note will be added to the newest revision of the document.
In the Note Contents field, enter the appropriate text for the note. You can enter keywords and
other system data into the message using the appropriate symbols, which are entered when
you select the appropriate buttons. These symbols will pull data into the note that is pertinent
to the current primary document.
The following symbols can be used:
Symbol Description
Note: This symbol is only applicable when used with an Institutional Database.
%C Displays the name of the user who created the current document.
%D1 Displays the date that the document was stored. This value cannot be changed.
%I1 or %T Displays the time that the document was stored. This value cannot be changed.
%K###.n Displays the Keyword Value of Keyword Type ### n times. For example, %K101.4
would display up to 4 unique Keyword Values for Keyword Type 101 for a single
document.
For some functionality, a Keyword Type drop-down list may be available to
configure this. Select a Keyword Type from the drop-down select list, enter the
number of times you want the Keyword Value to be displayed in the Repeat field,
and click Keyword. The value in the Repeat field specifies how many instances of
the Keyword Value will be displayed. Entering an * character will pull all existing
Keyword Values for display up to 99 instances.
Note: When using the Classic Client interface, double digits in the Repeat field are
not supported.
2012 Hyland Software, Inc.
366
OnBase 12 Workflow
Symbol Description
%R Displays the real user name (if configured) of the user who created the current
document. If a real user name is not configured, a blank space will be displayed.
%U Displays the user name of the currently logged in user who executed the task.
%V### Displays the value of a configured Workflow property. For example, to display the
value for the property Color, this symbol would be configured %VColor.
Note: If a property name has spaces, using %V to display the property value alone
will not preserve the spaces, and therefore, the property will not be correctly
identified. When %V is used with a property name containing space in conjunction
with a formatting code, the property will be identified. %C(VProperty Name) would
be an example of property with spaces that will be identified correctly with the first
letter capitalized. This formatting option are available for the following actions:
Prompt User with Question Box/SYS - Prompt User with Question Box, Create Note/
Doc - Create Note on This Document/Related Document, Display Message Box/
Notify - Display Message Box, and Custom Log Entry/SYS - Custom Log Entry.
The following symbols are not supported in the Classic Client interface:
%L [life cycle ID]
%L2 [life cycle name]
%Q [queue ID]
%Q2 [queue name]
%M [item metadata value] is not supported in the Classic OnBase Client interface or the
Core-Based OnBase Client interface.
Caution: The Note Contents field will override the default text configured for a note type.
Specify the type of note by selecting it from the Note Type drop-down list.
2012 Hyland Software, Inc.
367
Workflow OnBase 12
If you want to specify the exact position that the note should be placed on the document, you
can specify Horizontal and Vertical coordinates. If the document is in a text format, the
Configuration Module Actions Descriptions
coordinates (0-100) are the column and row where the note will appear. For documents in
other formats, like images, these coordinates (0-1500) measure the note position in pixels.
Note: The Note Position setting is an optional feature and should only be used if you are
certain of the appropriate coordinates for the note position. If you are not certain or do not
have the need to place notes in a specific position, leave the values equal to 0. When the
values are equal to zero, the note will be placed in the default position on documents.
If you are using an annotation style note, you can use the Size settings to determine the
placement of the annotation on the document upon note creation. Specify the Width and
Height of the annotation note that will be displayed on the document.
When the note type is Highlight with note attached and the document is a text document, the
Width setting determines the number of columns that will be highlighted on a document. The
Height setting determines the number of rows that are highlighted. Negative values cannot be
entered for this type of annotation.
When the note type is Highlight with note attached and the document is an image document,
the Width setting determines the number of pixels that will be highlighted on a document. The
Height setting determines the number of pixels that are highlighted. Negative values cannot
be entered for this type of annotation.
When the note type is an Arrow or Ellipse style, the Width setting determines the how wide
the annotation will be and in what direction from the specified Note Position. A negative value
will annotate to the left of the Note Position. A positive value will annotate to the right. The
Height setting determines the how tall the annotation will be and in what direction from the
specified Note Position. A negative value will annotate above the Note Position. A positive
value will annotate below. This is measured in pixels.
When the note type is an Icon Stamp style, the Width and Height settings determine the size
of the icon image that is displayed on the document.
Note: If a note type is an Icon Stamp style and is configured with the Keep Original Icon Size
option selected, in all interfaces except the OnBase Client the icon will display in the default
size, regardless of what width and height are configured at the action level. The OnBase Client
will display the icon in the size configured at the action level.
2012 Hyland Software, Inc.
368
OnBase 12 Workflow
When the note type is the Overlapped Text style, the Width setting determines how wide of an
area is allotted for the annotation before the text of the annotation is sent to another line.
Note: In the Core-based OnBase Client interface, the Overlapped Text note style is only
displayed on image documents.
Caution: Notes are not supported in the Java Client Workflow interface.
Note: If 0 is used as the value for both the Width and Height settings, annotations will not be
applied to the document at all for all annotation note types except the Arrow style. If 0 is used
as the value for both the Width and the Height settings, the arrowhead is still drawn, but no
line is draw from the arrowhead.
If you want to allow users to edit note text within a note, select the Display Note Text for Edit
option. When this option is selected, the action will display a text box in the User Interaction
window for users to edit text associated with the note created on the document.
Caution: The Core-Based interfaces allow you to enter more than 249 characters when the
Display Note Text for Edit option is selected. Notes with text greater than 250 characters will be
truncated to 250 characters.
Note: The Display Note Text for Edit option is not supported in the OnBase Mobile Access for
BlackBerry or Mobile Access for Windows Phone interfaces.
2012 Hyland Software, Inc.
369
Workflow OnBase 12
In order for this action to complete successfully, the documents file format must be
compatible with the type of note or annotation to be placed on it. The following table
Configuration Module Actions Descriptions
illustrates what file formats are compatible with what type of notes and annotations. See the
System Administration documentation for more information about notes and annotations.
Note: When adding a note to a document with multiple pages, the note is added to the first
page.
Note: The note will be added to the newest revision of the document.
In the Note Contents field, enter the appropriate text for the note. You can enter keywords and
other system data into the message using the appropriate symbols, which are entered when
you select the appropriate buttons. These symbols will pull data into the note that is pertinent
to the current primary document.
The following symbols can be used:
Symbol Description
Note: This symbol is only applicable when used with an Institutional Database.
%C Displays the name of the user who created the current document.
%D1 Displays the date that the document was stored. This value cannot be changed.
%I1 or %T Displays the time that the document was stored. This value cannot be changed.
2012 Hyland Software, Inc.
370
OnBase 12 Workflow
Symbol Description
Note: When using the Classic Client interface, double digits in the Repeat field are
not supported.
%M Extracts metadata values from items. This includes attribute values from Workview
objects or a field values from an Entity item.
%M must be followed by the metadata value you want to extract. For example, if
you want to extract the value of a WorkView attribute called Name, it would be
%MName.
The token strings can contain nested expressions. Example, a nested WorkView
attribute: %MVendor.Buyer.Name.
%R Displays the real user name (if configured) of the user who created the current
document. If a real user name is not configured, a blank space will be displayed.
%U Displays the user name of the currently logged in user who executed the task.
%V### Displays the value of a configured Workflow property. For example, to display the
value for the property Color, this symbol would be configured %VColor.
The following symbols are not supported in the Classic Client interface:
%L [life cycle ID]
%L2 [life cycle name]
%Q [queue ID]
%Q2 [queue name]
2012 Hyland Software, Inc.
371
Workflow OnBase 12
%M [item metadata value] is not supported in the Classic OnBase Client interface or the
Core-Based OnBase Client interface.
Configuration Module Actions Descriptions
Caution: The Note Contents field will override the default text configured for a note type.
Specify the type of note by selecting it from the Note Type drop-down list.
If you want to specify the exact position that the note should be placed on the document, you
can specify Horizontal and Vertical coordinates. If the document is in a text format, the
coordinates (0-100) are the column and row where the note will appear. For documents in
other formats, like images, these coordinates (0-1500) measure the note position in pixels.
Note: The Note Position setting is an optional feature and should only be used if you are
certain of the appropriate coordinates for the note position. If you are not certain or do not
have the need to place notes in a specific position, leave the values equal to 0. When the
values are equal to zero, the note will be placed in the default position on documents.
If you are using an annotation style note, you can use the Size settings to determine the
placement of the annotation on the document upon note creation. Specify the Width and
Height of the annotation note that will be displayed on the document.
When the note type is Highlight with note attached and the document is a text document, the
Width setting determines the number of columns that will be highlighted on a document. The
Height setting determines the number of rows that are highlighted. Negative values cannot be
entered for this type of annotation.
When the note type is Highlight with note attached and the document is an image document,
the Width setting determines the number of pixels that will be highlighted on a document. The
Height setting determines the number of pixels that are highlighted. Negative values cannot
be entered for this type of annotation.
When the note type is an Arrow or Ellipse style, the Width setting determines the how wide
the annotation will be and in what direction from the specified Note Position. A negative value
will annotate to the left of the Note Position. A positive value will annotate to the right. The
Height setting determines the how tall the annotation will be and in what direction from the
specified Note Position. A negative value will annotate above the Note Position. A positive
value will annotate below. This is measured in pixels.
When the note type is an Icon Stamp style, the Width and Height settings determine the size
of the icon image that is displayed on the document.
Note: If a note type is an Icon Stamp style and is configured with the Keep Original Icon Size
option selected, in all interfaces except the OnBase Client the icon will display in the default
size, regardless of what width and height are configured at the action level. The OnBase Client
will display the icon in the size configured at the action level.
2012 Hyland Software, Inc.
372
OnBase 12 Workflow
When the note type is the Overlapped Text style, the Width setting determines how wide of an
area is allotted for the annotation before the text of the annotation is sent to another line.
Note: In the Core-based OnBase Client interface, the Overlapped Text note style is only
displayed on image documents.
Caution: Notes are not supported in the Java Client Workflow interface.
Note: If 0 is used as the value for both the Width and Height settings, annotations will not be
applied to the document at all for all annotation note types except the Arrow style. If 0 is used
as the value for both the Width and the Height settings, the arrowhead is still drawn, but no
line is draw from the arrowhead.
If you want to allow users to edit note text within a note, select the Display Note Text for Edit
option. When this option is selected, the action will display a text box in the User Interaction
window for users to edit text associated with the note created on the document.
Caution: The Core-Based interfaces allow you to enter more than 249 characters when the
Display Note Text for Edit option is selected. Notes with text greater than 250 characters will be
truncated to 250 characters.
Note: The Display Note Text for Edit option is not supported in the OnBase Mobile Access for
BlackBerry or Mobile Access for Windows Phone interfaces.
2012 Hyland Software, Inc.
373
Workflow OnBase 12
Note: This action requires the Conversion from Microsoft Office to Image Framework license.
Configuration Module Actions Descriptions
Note: This action requires a special version of the Snowbound .dll file, the docplug.dll file, and
pdfplug.dll file. The new Snowbound .dll, docplug.dll, and pdfplug.dll files need to be placed in
a location where the IIS Worker Process on the Application Server can access them. In
addition, when using Microsoft Word 2007 or 2010, this action requires the Aspose.Words.dll
and Aspose.Words.lic files to convert the .docx file format. For more information on obtaining
the special version of the Snowbound .dll, docplug.dll, pdfplug.dll, and Aspose files, contact
your OnBase solution provider.
Caution: During the conversion process, some formatting may be lost. Tables, images, Word Art,
Clip Art, shapes and other non-text portions of the Word document can be altered in the
conversion process. Margins, borders, and columns can be slightly altered during the conversion
process as well.
Caution: This action supports the following versions of Microsoft Word: 97, 2000, 2002, 2003,
2007, and 2010. Microsoft Word versions 6 and 95 are not currently supported by this action.
This action allows a user to create an image-based PDF rendition or a TIFF rendition of any
Microsoft Word document which has a file extension of .doc or .docx. This action can also be
configured to create a new image-based PDF document or TIFF document from any Microsoft
Word document which has a file extension of .doc or .docx.
In addition, you can create a TIFF image rendition of any PDF document. Also, new TIFF
image documents can be created from any PDF document.
File Type
Select PDF or TIFF to determine which file type is created.
Keep Color
If you want to maintain the color in the Word document upon conversion, select this option.
As Rendition of Active Document
If you want the new converted document to be a rendition of the current, active document,
select this option.
As New Document
If you want the converted document to be a new document, select this option. When this
option is selected, the following options are enabled.
Document Type
Select the Document Type in which you want to store the new document.
Inherit Keys from Active Document
2012 Hyland Software, Inc.
374
OnBase 12 Workflow
If Inherit Keys from Active Document is selected, the Inherit All and Inherit Selected options are
enabled. If Inherit All is selected, all Keyword Values on the current document are inherited by
Note: This action is only available if licensed for Connector for use with SAP ArchiveLink
module.
Sends a request to a SAP content server asking it to create a work item for the document. The
action does not perform validation on the object type and SAP Document Type.To configure
this action:
1. Select the appropriate Content Server from the drop-down list. You can also click the
button to the right of the drop-down list to access the Create Content Server Alias dialog
box to create an alias for a content server. See the Connector for use with SAP
ArchiveLink documentation for more information about this dialog box.
Note: The default port number can be overridden by specifying a port number in the address.
The following format can be used: address:portnumber
2012 Hyland Software, Inc.
375
Workflow OnBase 12
Note: This action is not functional in the Classic Client or Java Client interfaces.
Note: WorkView must be installed on the database in which you want to configure this action.
If you import a life cycle into a database, that database must have WorkView installed to
successfully import the life cycle.
Allows the user to create a WorkView object, pulling the attribute values from Keyword Values
on the current document. The user can only specify one Document Type Association per
Document Type.
1.Select a Document Type from the Document Type drop-down list. Only the Document
Types that have associations will be listed.
2.Select a Document Type Association from the drop-down list. The Document Type
Associations listed are associations configured at the class level for the selected
Document Type.
Note: The Document Type Association selected determines the attribute/keyword type
mapping, and therefore, the values that populate the attribute fields of an object upon
creation.
3.Click Add.
4.Repeat steps 1 through 3 for each association you want to create an object for.
5.If you want the object to display after it is created, select the Display Object option. This
can allow you to enter data into fields that have not been mapped to a Keyword Type.
Note: The Display Object option is only supported in the Web Client and Unity interfaces. The
OnBase Web Server is required to display WorkView objects from the Unity interface.
Note: The Display Object option is not functional when this action is running as timer work.
Caution: When a relationship attribute is used during object creation, if more than one object is
found for the relationship attributes value, the first object found is used for the relationship. If
an object is not found that matches the relationship attributes value, a new relationship object is
created.
Note: Notes will be deleted using this action regardless of the note type privileges the
currently logged in user has outside of Workflow.
2012 Hyland Software, Inc.
376
OnBase 12 Workflow
Related Documents
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
2012 Hyland Software, Inc.
377
Workflow OnBase 12
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
Configuration Module Actions Descriptions
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
Associated Primary Document (Applicable to Work Folder documents only)
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
2012 Hyland Software, Inc.
378
OnBase 12 Workflow
Note: When deleting a note, if more than one note of the specified type exists on the
document, all notes of the same type are deleted from the current document.
You must specify the type of note to create or delete by selecting it from the Note Type drop-
down list.
Note: Notes will be deleted using this action regardless of the note type privileges the
currently logged in user has outside of Workflow.
Note: When deleting a note, if more than one note of the specified type exists on the
document, all notes of the same type are deleted from the current document.
You must specify the type of note to delete by selecting it from the Note Type drop-down list.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
2012 Hyland Software, Inc.
379
Workflow OnBase 12
Under the Related Documents heading, the status of the related documents configuration is
displayed.
Configuration Module Actions Descriptions
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
2012 Hyland Software, Inc.
380
OnBase 12 Workflow
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
Associated Primary Document (Applicable to Work Folder documents only)
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
2012 Hyland Software, Inc.
381
Workflow OnBase 12
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
Note: If the Abort Processing After Delete option is selected, processing is aborted after the
current document is deleted.
Note: This action is not supported in the Desktop, Unity, Java Client, or OnBase Mobile
interfaces.
This action will open the File Cabinet window with the folder to which the document belongs. If
the document is associated with multiple folders, all of the folders are listed in the bottom left
pane. If the document within Workflow does not have a folder associated with it, a message
will display stating No Folders Found. In addition, users are prompted with a message that no
folders were found if they do not have the rights to access a folder in which the document
resides. If a user does not have rights to the Document Type that is in the folder, the
document will not display in the folder.
2012 Hyland Software, Inc.
382
OnBase 12 Workflow
When used in conjunction with Display in Separate Window, the Use Top Level Window check
box causes the document to be opened in a window that can be dragged outside of the
Note: When the Use Primary Pane option is selected and the action is the last action in a task
list, the related document will only display for a few seconds in the primary pane before the
interface refreshes and restores focus to the primary document.
Note: The Use Primary Pane option is not applicable to the Desktop interface.
Note: In the Unity Workflow interface, the related document is displayed in the primary pane
momentarily only when you do not have an action after it that displays something in the User
Interaction pane. If you do have an action after it that displays something in the User
Interaction pane, then the document is displayed in the primary pane. When the task list is
finished executing, the document selected when executing the task is reloaded into the
viewer.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
2012 Hyland Software, Inc.
383
Workflow OnBase 12
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Configuration Module Actions Descriptions
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
2012 Hyland Software, Inc.
384
OnBase 12 Workflow
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
2012 Hyland Software, Inc.
385
Workflow OnBase 12
Configuration Module Actions Descriptions
The display document action will display the document to the user. By default the document
will be displayed in the Workflow clients embedded document viewer.
You can also specify that the document should open in a separate window by checking the
Display in Separate Window check box. When used in conjunction with Display in Separate
Window, the Use Top Level Window check box causes the document to be opened in a window
that can be dragged outside of the Workflow window to display it on a second screens
desktop (if using dual monitors).
Note: When performing this action directly from an Outlook e-mail message using the
Integration for Microsoft Outlook 2007 or Integration for Microsoft Outlook 2010, the
document will always be displayed in a separate Document Viewer window. This is because
Outlook does not have its own viewer.
Note: The Use Top Level Window option is not supported in the Unity interface. When
performing this action from the Unity interface, the document will always be displayed in a
separate Document Viewer window.
The Use Top Level Window option is enabled only when Display in Separate Window is selected.
The Use Top Level Window option works in conjunction with the Reuse Top-level Window for
Displaying Document workstation option.
When a workstation also has the Reuse Top-level Window for Displaying Document option
selected, documents will use only one window to display all documents. If there are multiple
documents displayed, only the last document is displayed. If this option is not selected,
documents will use a new window for each document.
The Use Primary Pane option is only enabled while the Display In Separate Window option is not
selected. The Use Primary Pane option has the following effects:
If the Display Second Pane option is not checked in Workstation Options, the Use Primary Pane
option is ignored.
If the Use Primary Pane option is not checked, another copy of the main document is displayed
in the second, lower-right pane.
If the Use Primary Pane option is selected, the main document is displayed in the primary,
upper-left pane.
Note: The Use Primary Pane option is not applicable to the Desktop interface.
2012 Hyland Software, Inc.
386
OnBase 12 Workflow
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
The order documents are viewed and/or printed using the work folder is controlled by the
Order Documents By option configured on the Display tab in folder configuration. The batch will
be sent to the queues specified in the Print Queue drop-down select list.
Note: When using a Web Client using Standard mode, a network printer is the only Print Queue
type supported.
Print Format
Allows you to select a print format to use during printing. Print formats are configured in the
Configuration module under Printing | Print Formats. See the System Administration
documentation for more information.
Note: Regardless of the Enable User Group based Print Format security option global client
setting, the print format selected will be available when this action is executed.
Note: If printing an OLE or HTML document, format settings for the document override the
print format settings.
Caution: The Application Server and Web Client interfaces do not support the Default Printer or
Local Print Queue options. The Unity interface does not support the Local Printer option.
Note: If the user that initiates this action does not have rights to the specified print queue, the
rights will be overridden and the user will have access to the print queue for use with action.
2012 Hyland Software, Inc.
387
Workflow OnBase 12
If the Include Current Document in Batch option is selected, the current active document will be
printed with the batch. If the option is not selected, the current active document will not be
Configuration Module Actions Descriptions
Note: If the current active document also exists in the folder and the Include Current Document
in Batch option is selected, the document will be printed twice. In the Core-based interfaces, if
this setting is not selected and the current active document exists in the folder, the document
will be printed once. In the Classic Client interface, if this setting is not selected and the
current active document exists in the folder, the document will not be printed at all.
If the Show Print Dialog option is selected, the Print dialog box will be displayed, allowing you
to select options before printing.
Note: The Show Print Dialog option is not supported in the OnBase Mobile interfaces. This
option is not supported in the Web Client when printing with a Network Print Queue. The print
dialog box will not display.
Note: When printing to a Named network print queue, a workstation must be running as a
Print Server when using the Web Client interface.
Note: This option is not supported in either the Classic or Core-based OnBase Client
interfaces.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
2012 Hyland Software, Inc.
388
OnBase 12 Workflow
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
2012 Hyland Software, Inc.
389
Workflow OnBase 12
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Configuration Module Actions Descriptions
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
2012 Hyland Software, Inc.
390
OnBase 12 Workflow
Caution: When used in system work and the documents are brought into the system using the
Print Queue
Allows you to send the document to an OnBase-configured print queue specified by a
selection from the Print Queue drop-down list.
Caution: The Application Server and Web Client interfaces do not support the Default Printer or
Local Print Queue options. The Unity interface does not support the Local Printer option.
Note: When using a Web Client using Standard mode, a network printer is the only Print Queue
type supported.
Print Format
Allows you to select a print format to use during printing. Print formats are configured in the
Configuration module under Printing | Print Formats. See the Configuration documentation for
more information.
Note: Regardless of the Enable User Group based Print Format security option global client
setting, the print format selected will be available when this action is executed.
Note: If printing an OLE or HTML document, format settings for the document override the
print format settings.
2012 Hyland Software, Inc.
391
Workflow OnBase 12
De-select the Show Print Dialog box to send the current/related document directly to the
printer.
Configuration Module Actions Descriptions
Note: The Show Print Dialog option is not supported in the OnBase Mobile interfaces. This
option is not supported in the Web Client when printing with a Network Print Queue. The print
dialog will not display.
Note: When Show Print Dialog is selected, the Print Format selected will be available for
selection in the Print dialog box when the action is executed regardless of user rights to the
print format.
Note: When this option is used with the Java Workflow Client, a dialog box is displayed
allowing users to select No overlay, Overlay, or Fax Compatible before displaying the printing
dialog box.
Note: This option is only supported in the Web and Java Client Workflow interfaces.
Note: When printing to a Named network print queue, a workstation must be running as a
Print Server when using the Web Client interface.
When using this action in the Java Client, there are a few limitations:
The Java Client only supports printing to local printers.
The Java Client does not support print formats.
This action is only supported for image, text, and HTML documents.
In addition, a user will be unable to print related documents if a folder is used as the criteria
for finding related documents and the folder has one or more documents that the user cannot
access.
2012 Hyland Software, Inc.
392
OnBase 12 Workflow
The document goes to the print queue configured in the client as the default print queue. All
the settings used for printing are the defaults specified in the print format for the document
Caution: When used in system work and the documents are brought into the system using the
Fax Import Integration for Captaris RightFax or Integration for Open Text Fax Server, RightFax
Edition modules and a local printer is used, this action will not function. If you want to use this
action in system work with the Fax Import Integration for Captaris RightFax or Integration for
Open Text Fax Server, RightFax Edition modules, it is recommended that you use a network
printer. If you must use a local printer, you can configure this action using a timer and the
OnBase Client running as a Timer Server.
Print Queue
Allows you to send the document to an OnBase-configured print queue specified by a
selection from the Print Queue drop-down list.
Caution: The Application Server and Web Client interfaces do not support the Default Printer or
Local Print Queue options. The Unity interface does not support the Local Printer option.
Note: When using a Web Client using Standard mode, a network printer is the only Print Queue
type supported.
Print Format
Allows you to select a print format to use during printing. Print formats are configured in the
Configuration module under Printing | Print Formats. See the Configuration documentation for
more information.
Note: Regardless of the Enable User Group based Print Format security option global client
setting, the print format selected will be available when this action is executed.
Note: If printing an OLE or HTML document, format settings for the document override the
print format settings.
2012 Hyland Software, Inc.
393
Workflow OnBase 12
De-select the Show Print Dialog box to send the current/related document directly to the
printer.
Configuration Module Actions Descriptions
Note: The Show Print Dialog option is not supported in the OnBase Mobile interfaces. This
option is not supported in the Web Client when printing with a Network Print Queue. The print
dialog will not display.
Note: When Show Print Dialog is selected, the Print Format selected will be available for
selection in the Print dialog box when the action is executed regardless of user rights to the
print format.
Note: When this option is used with the Java Workflow Client, a dialog box is displayed
allowing users to select No overlay, Overlay, or Fax Compatible before displaying the printing
dialog box.
Note: This option is only supported in the Web and Java Client Workflow interfaces.
Note: When printing to a Named network print queue, a workstation must be running as a
Print Server when using the Web Client interface.
When using this action in the Java Client, there are a few limitations:
The Java Client only supports printing to local printers.
The Java Client does not support print formats.
This action is only supported for image, text, and HTML documents.
Note: This action is only supported in the Classic Client Workflow interface.
2012 Hyland Software, Inc.
394
OnBase 12 Workflow
Places the current document in a predetermined file cache (which is configured via the Disk
Mgmt option in OnBase Configuration). This is the only way to place documents into cache for
Note: In order for this action to execute successfully on a document, the document must
belong to a Document Type configured with the Allow File Caching option selected. See the
System Administration Module Reference Guide or the Configuration help files for more
information about this setting.
Places the specified related document in a predetermined file cache. Related documents are
defined by specifying a Document Type with common Keyword Types, Folder Type, or by
selecting the Document Handle check box.
Cache
Specify the name of the cache in the Cache drop-down list after its location has been
established and configured. Caching up to 2 Terabytes is supported.
Note: In order for this action to execute successfully on a document, the document must
belong to a Document Type configured with the Allow File Caching option selected. See the
System Administration Module Reference Guide or the Configuration help files for more
information about this setting.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
2012 Hyland Software, Inc.
395
Workflow OnBase 12
Select a Document Type from the Related Document Type drop-down list.
Configuration Module Actions Descriptions
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
2012 Hyland Software, Inc.
396
OnBase 12 Workflow
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
2012 Hyland Software, Inc.
397
Workflow OnBase 12
Note: In order to use this action, the system must be licensed for Ad-Hoc Automated
Indexing, Automated Indexing, Intelligent Indexing, Ad Hoc Document OCR, or Batch OCR. In
addition, the required OCR software must be installed and the Document Type to which the
document belongs that the action will be executed upon must be configured appropriately for
OCR functionality. See the Batch OCR documentation for more information.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
2012 Hyland Software, Inc.
398
OnBase 12 Workflow
After you select the related Document Type, click Common Keywords. The Related Document
Types dialog box opens. To add Keyword Types to the list, select the Keyword Type in the list
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
2012 Hyland Software, Inc.
399
Workflow OnBase 12
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
2012 Hyland Software, Inc.
400
OnBase 12 Workflow
Automated Index
If you want the document to be sent to the Awaiting Ad-Hoc OCR queue, select the None
option. This option requires either the Batch OCR license or the Ad Hoc Document OCR
license.
If you want the document to be sent to the Awaiting Ad-Hoc Automated Indexing queue, select
the Automated Indexing option. This option requires either the Ad Hoc Automated Indexing
license or the Automated Indexing license.
If you want the document to be queued to be processed by the Intelligent Indexing Service,
select the Intelligent Indexing option. This action will queue the document in the database
based on the document handle to be processed by the II Service when the service executes.
This option requires the Intelligent Indexing license.
Note: A script can be created that will check the status of the document in the II process.
Note: In order to use this action, the system must be licensed for Ad-Hoc Automated
Indexing, Automated Indexing, Intelligent Indexing, Ad Hoc Document OCR, or Batch OCR. In
addition, the required OCR software must be installed and the Document Type to which the
document belongs that the action will be executed upon must be configured appropriately for
OCR functionality. See the Batch OCR documentation for more information.
Automated Index
Note: This option requires that the documents being automatically indexed are image
documents.
If you want the document to be sent to the Awaiting Ad-Hoc OCR queue, select the None
option. This option requires either the Batch OCR license or the Ad Hoc Document OCR
license.
If you want the document to be sent to the Awaiting Ad-Hoc Automated Indexing queue, select
the Automated Indexing option. This option requires either the Ad Hoc Automated Indexing
license or the Automated Indexing license.
2012 Hyland Software, Inc.
401
Workflow OnBase 12
If you want the document to be queued to be processed by the Intelligent Indexing Service,
select the Intelligent Indexing option. This action will queue the document in the database
Configuration Module Actions Descriptions
based on the document handle to be processed by the II Service when the service executes.
This option requires the Intelligent Indexing license.
Note: A script can be created that will check the status of the document in the II process.
Note: This action will not re-index a document that is a signed E-Form. If this action
encounters a signed E-Form, the last execution result is set to FALSE. If this action is part of a
task list, the task list is not aborted if a signed E-Form is encountered.
Note: When this action is initiated on a document, the documents current Document Type is
available for selection during re-indexing, regardless of the currently logged in users
Document Type rights.
Note: When a document is re-indexed that is being managed by Document Retention, only the
Document Type to which the document belongs will be available for re-indexing. The
Document Retention Manager privilege is required for a user to re-index a document being
managed by Document Retention into a different Document Type.
Note: If Cancel is clicked during the re-indexing process, only re-indexing is canceled.
Subsequent processing is not automatically aborted.
Allows primary documents within a life cycle queue to be re-indexed. This action should not
be used in System Work or Timer Work. The Remove Document from Current Workflow
Locations check box allows documents to be removed from a life cycle after they have been
indexed. The Reinsert Document into Workflow check box allows OnBase to place documents
into the appropriate life cycle, based on the Document Type the document was re-indexed
under. If the document already exists in any of the life cycles the new Document Type is
associated with, the document will not be reinserted into those life cycles unless the Remove
Document From Current Workflow Locations option is used in conjunction with the Reinsert
Document into Workflow option.
2012 Hyland Software, Inc.
402
OnBase 12 Workflow
The Display Document Type Read-Only check box displays the Document Type Group and
Document Type drop-down select lists as read-only during re-indexing.
Caution: This option is only supported in the Classic OnBase Client, Core-based OnBase Client,
and the Web Client user interfaces.
For more information on Reverse Lookups, see the AutoFill Keyword Sets documentation.
Documents can only be re-indexed to Document Types that the user has rights to. The Create
privilege is not required.
The only exception is in the Web Client interface, where the document can be re-indexed
using the same Document Type that the document is currently indexed under, regardless of
rights.
Note: If a user has the document that needs to be re-indexed locked, re-indexing cannot take
place until the user is done with the document and it is not locked.
If the document re-indexed belongs to a Document Type that is configured for auto-foldering,
the change to Keyword Values will initiate auto-foldering to take place for the affected
document.
When using AutoFill Keyword Sets, entering a primary value and then clicking Re-index in the
OnBase Client and Web Client, a message stating Warning! An autofill keyword set has
expanded as a result of this operation. Do you want to review the keyword change? is displayed.
Clicking OK will return the user to the re-index panel to review the values populated. Clicking
Cancel will complete the re-indexing action. The confirmation message will not display if the
user enters the primary value and then presses Tab to initiate AutoFill Keyword Set population
before clicking Re-index. Pressing Tab will automatically expand the Autofill Keyword Set. If
multiple Autofill Keyword Sets exist for the primary Keyword Value entered in the re-index
panel, the user will be prompted to select the correct Autofill Keyword Set values.
2012 Hyland Software, Inc.
403
Workflow OnBase 12
If you use the Application Enabler module, the AppEnabler Options allow you to specify the
behavior of the Document Imaging window and enabled application during OnBase Client
Configuration Module Actions Descriptions
indexing. The Application Enabler module allows you to use OnBase Client indexing to index
documents by screen scraping. When you double-click on the enabled application, values
are scraped (copied) from the enabled application and used to populate the corresponding
keyword fields in the Document Imaging window. See the Application Enabler documentation
for more information.
Note: The Application Enabler-related options are not supported in the Java Client or Desktop
interfaces.
Note: This option is not supported in the Unity Workflow interface. To accomplish this same
behavior in the Unity Workflow interface, clear the Include all configured keywords when
posting events from this screen Application Enabler configuration option.
If enabled, the only keyword values that will be populated are those from the keyword type(s)
in the Selected list in the Hotspot Configuration dialog box. When this option is not selected,
keyword types from both the Available and Selected lists in the Hotspot Configuration dialog
box will be used.
Note: If neither the Clear Keywords or Replace Keywords options are selected, existing Keyword
Values in the indexing window are retained and new values are added during screen scraping.
Multiple Keyword Type fields and values are displayed in the indexing window.
2012 Hyland Software, Inc.
404
OnBase 12 Workflow
When this option is selected, the Document Type scraped from Application Enabler will not be
used to update and re-index a document. When this option is not selected, the Document
Select the Remove All User Assignments option if you want all load balancing user assignments
removed from the item upon its exit from the life cycle using this action.
Caution: When using a core-based interface, items in Document Maintenance that this action is
executed upon will not be removed from the life cycle.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
2012 Hyland Software, Inc.
405
Workflow OnBase 12
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Configuration Module Actions Descriptions
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
2012 Hyland Software, Inc.
406
OnBase 12 Workflow
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
2012 Hyland Software, Inc.
407
Workflow OnBase 12
Configuration Module Actions Descriptions
Removes a related document from one or all reading groups to which it belongs.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
2012 Hyland Software, Inc.
408
OnBase 12 Workflow
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
Associated Primary Document (Applicable to Work Folder documents only)
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
2012 Hyland Software, Inc.
409
Workflow OnBase 12
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
If you want to remove the related document from all reading groups, select the Remove from
All Reading Groups option.
If you want to remove the related document from a specific reading group, select Remove
from Selected Reading Group and select the appropriate reading group from the drop-down
select list.
If you want to remove all revisions of the document, select the Remove All Revisions check
box.
2012 Hyland Software, Inc.
410
OnBase 12 Workflow
Select the Remove All User Assignments option if you want all load balancing user assignments
removed from the item upon its exit from the life cycle using this action.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
2012 Hyland Software, Inc.
411
Workflow OnBase 12
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
Configuration Module Actions Descriptions
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
Associated Primary Document (Applicable to Work Folder documents only)
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
2012 Hyland Software, Inc.
412
OnBase 12 Workflow
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
Select the Remove All User Assignments option if you want all load balancing user assignments
removed from the item upon its exit from the life cycle using this action.
Caution: When using a core-based interface, items in Document Maintenance that this action is
executed upon will not be removed from the life cycle.
Removes the primary document from one or all reading groups to which it belongs.
2012 Hyland Software, Inc.
413
Workflow OnBase 12
If you want to remove the primary document from all reading groups, select the Remove from
All Reading Groups option.
Configuration Module Actions Descriptions
If you want to remove the primary document from a specific reading group, select Remove
from Selected Reading Group and select the appropriate reading group from the drop-down
select list.
If you want to remove all revisions of the document, select the Remove All Revisions check
box.
Select the Remove All User Assignments option if you want all load balancing user assignments
removed from the item upon its exit from the life cycle using this action.
Caution: When using a core-based interface, items in Document Maintenance that this action is
executed upon will not be removed from the life cycle.
Caution: This action does not support Medical Records Management Document Types.
2012 Hyland Software, Inc.
414
OnBase 12 Workflow
Sets the Document Type of the document to the Document Type specified. If the Document
Type selected has multiple revisions configured, the most recent revision of the Document
Note: If the Document Type specified belongs to a life cycle, the document does not enter the
life cycle associated with the new Document Type upon execution of this action.
Note: If the Document Type of a document is changed to a Document Type that is set up for
document revisions and the original Document Type was not configured for document
revisions, an initial revision of the document is automatically created when the new Document
Type is applied.
Caution: If the Document Type transitioned from uses a Keyword Type Group, non-common
keywords will not be kept, regardless of the Keep Only Common Keywords setting. Likewise, if the
Document Type transitioned to uses a Keyword Type Group, the non-common keyword will not
be kept.
Caution: If a Document Type associated with standard Keyword Types is changed to a Document
Type associated with a Keyword Type Group and then changed back to the original Document
Type, all non-common Keyword Values are lost.
Caution: If a Document Type associated with standard Keyword Types or a Keyword Type Group
is changed to a Document Type associated with a Multi-Instance Keyword Type Group, all
Keyword Values are lost. Likewise, if a Document Type associated with a Multi-Instance Keyword
Type Group is changed to a Document Type associated with standard Keyword Types or a
Keyword Type Group, all Keyword Values are lost. Keyword Values will only be kept if a
Document Type assigned with a Multi-Instance Keyword Type Group is set to another Document
Type with the same Multi-Instance Keyword Type Group association.
2012 Hyland Software, Inc.
415
Workflow OnBase 12
Sets the Document Type of the current documents related document to the Document Type
specified. If the Document Type selected has multiple revisions configured, the most recent
Configuration Module Actions Descriptions
revision of the Document Type structure will be used for the document. The manner in which
Keyword Values are transitioned between the Document Types is determined by the Keep Only
Common Keywords check box. If the box is checked, only keywords common to the two
Document Types are maintained. (If the document is transitioned back to the original
Document Type, any keywords not in common will be lost.) If the box is unchecked, all
keyword references are maintained, although only the common keywords are reflected in the
keyword dialog box of the transitioned Document Type.
Note: If the Document Type specified belongs to a life cycle, the document does not enter the
life cycle associated with the new Document Type upon execution of this action.
Caution: If the Document Type transitioned from uses a Keyword Type Group, non-common
keywords will not be kept, regardless of the Keep Only Common Keywords setting. Likewise, if the
Document Type transitioned to uses a Keyword Type Group, the non-common keyword will not
be kept.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
2012 Hyland Software, Inc.
416
OnBase 12 Workflow
After you select the related Document Type, click Common Keywords. The Related Document
Types dialog box opens. To add Keyword Types to the list, select the Keyword Type in the list
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
2012 Hyland Software, Inc.
417
Workflow OnBase 12
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
2012 Hyland Software, Inc.
418
OnBase 12 Workflow
Caution: If a Document Type associated with standard Keyword Types or a Keyword Type Group
Caution: If a Document Type associated with standard Keyword Types is changed to a Document
Type associated with a Keyword Type Group and then changed back to the original Document
Type, all non-common Keyword Values are lost.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
2012 Hyland Software, Inc.
419
Workflow OnBase 12
After you select the related Document Type, click Common Keywords. The Related Document
Types dialog box opens. To add Keyword Types to the list, select the Keyword Type in the list
Configuration Module Actions Descriptions
and click Add. To remove a Keyword Type from the list, select the keyword and click Remove.
The Document Types with these Keyword Types are evaluated when this action executes.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
2012 Hyland Software, Inc.
420
OnBase 12 Workflow
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
2012 Hyland Software, Inc.
421
Workflow OnBase 12
This field allows you to specify a priority value to assign. This priority value can be used for
sorting in the inbox and for load balancing queue assignments. Priority rank is dependent on
Configuration Module Actions Descriptions
sorting and load balancing configurations. Numbers 1 to 999 are valid values. There are three
options to set the priority value:
You can specify a Specific Value for the priority value.
You can specify a Property that will define the priority value.
You can select a Keyword that will define the priority value.
Note: The Property and Keyword options are not supported in the Classic Client interface.
Note: The Property and Keyword options are not supported in the Classic Client interface.
2012 Hyland Software, Inc.
422
OnBase 12 Workflow
Select the life cycle from this drop-down select list for which you would like the priority set for
the active item/document. Priorities are attached to life cycles for an item or document. It is
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
2012 Hyland Software, Inc.
423
Workflow OnBase 12
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
Configuration Module Actions Descriptions
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
Associated Primary Document (Applicable to Work Folder documents only)
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
2012 Hyland Software, Inc.
424
OnBase 12 Workflow
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
Note: This action requires that your system is licensed for Digital Signatures.
Note: This action is not supported in the OnBase Mobile or Desktop interfaces.
Signs the document using the Workflow module. When used with the Classic Client interface,
this action respects the Allow batch signing Global Client Settings option to allow multiple
documents to be signed and providing a user name and password only once. A message is
displayed if no certificate-based signatures are configured. This option is not respected within
the Core-based Workflow interfaces. This action cannot be configured under system work,
load balancing work, or timer work.
Note: Web Client Workflow uses certificates stored on the users workstation. Core-based
Workflow interfaces use certificates stored on the Application Server. The IIS application pool
should be configured to use your identity, or use impersonation with an account that can login
and import certificates into your personal certificate store.
2012 Hyland Software, Inc.
425
Workflow OnBase 12
If the Do Not Break Processing option is selected, task lists do not abort processing after
signing a document fails or is canceled.
Configuration Module Actions Descriptions
Note: When using the Create Document from Select Page(s) option, this action is not supported
in the Web Client, Java Client, Desktop, Outlook Integration, or OnBase Mobile interfaces. The
Break Document on Each Page option is supported in the Web Client and Java Client interfaces.
If Inherit Keys from Active Document is selected, the Inherit All and Inherit Selected options are
enabled. If Inherit All is selected, all Keyword Values on the current document are inherited by
the new document. If Inherit Selected is selected, the Configure button is enabled. Click
Configure and select the Keyword Types from which you want the new document(s) to inherit
values.
Inherit Notes
If this option is selected, notes from the current document are inherited by the new
document(s).
Initiate Workflow on New Document(s)
If this option is selected, Workflow is initiated for the newly created document(s).
Note: Users must have rights to the Document Type to which documents will be split into.
Note: This action requires that your system is licensed for EDM Services.
2012 Hyland Software, Inc.
426
OnBase 12 Workflow
Stamps the most recent revision of the current document as a version. If the Document Type
of the document is not revisable or does not allow versions, the action is not executed. Also,
Note: This action is not supported in the Unity or OnBase Mobile interfaces when this option is
selected.
The next three options are ideal for life cycles that require the document to be stamped
silently. Examples of this are configurations that use timers or system work to stamp the
document.
Enter Name: Enables the user to configure a name that will be assigned to
documents when the version is stamped. By using this option, users can use %V as
a wildcard. This wildcard will display on the document as the version number.
Note: Enter Name is the only option that supports the %V wildcard. The name is limited to 14
characters.
Keyword Type: Enables the user to configure a Keyword Type from which the value
for the version number will be pulled. Users can select a Keyword Type from a drop-
down list.
Property Name: Enables the user to configure a property name from which the value
for the version number will be pulled.
If the Do Not Break Processing option is selected, a task list does not abort after a user cancels
out of the Version Information dialog box.
Note: The Do Not Break Processing option is currently not available in the Core.
Note: The related documents must be in a life cycle to be transitioned using this action.
2012 Hyland Software, Inc.
427
Workflow OnBase 12
The Core-based interfaces also support transitioning a document based on properties. The
source and/or destination queues are found based on the configured property value. To
Configuration Module Actions Descriptions
configure a source queue based on property value, select the Get From Queue from Property:
check box and enter the name or number of the desired Workflow property in the data entry
field. The From Queue drop-down select list will be disabled and not applicable as soon as this
check box is selected. To configure a destination queue based on property value, select the
Get To Queue from Property: check box and enter the name or ID number of the desired
Workflow queue in the data entry field. The To Queue drop-down select list will be disabled
and not applicable as soon as this check box is selected. Both queues in a transition must
exist in the same life cycle. The document will not be transitioned if the configured properties
are not set on the document.
Note: When Get To Queue from Property: is selected, a specific life cycle must also be selected
in the Life Cycle drop-down select list. The <ALL> option for life cycles will not function when a
property is configured as a destination queue, because multiple queues across life cycles
could have the same property.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
2012 Hyland Software, Inc.
428
OnBase 12 Workflow
After you select the related Document Type, click Common Keywords. The Related Document
Types dialog box opens. To add Keyword Types to the list, select the Keyword Type in the list
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
2012 Hyland Software, Inc.
429
Workflow OnBase 12
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
2012 Hyland Software, Inc.
430
OnBase 12 Workflow
Note: When Get To Queue from Property: is selected, a specific life cycle must also be selected
in the Life Cycle drop-down select list. The <ALL> option for life cycles will not function when a
property is configured as a destination queue, because multiple queues across life cycles
could have the same property.
Note: This action is not supported in the Classic Client or Java Client interfaces.
Note: WorkView must be installed on the database in which you want to configure this action.
If you import a life cycle into a database, that database must have WorkView installed to
successfully import the life cycle.
2012 Hyland Software, Inc.
431
Workflow OnBase 12
Allows the user to update one or more WorkView objects, pulling the attribute values from
Keyword Values on the current document. The action determines which WorkView objects to
Configuration Module Actions Descriptions
update by the user configuring the action to use a filter Document Type Association or to
update all WorkView objects that have the current document attached. The user can only
specify one filter/update Document Type Association per Document Type. When the action
executes it looks for a filter/update Document Type Association that matches the current
Document Type, and uses the filter Document Type Association (if specified) to determine
which WorkView objects to update, and uses the update Document Type Association to
determine what values to set the WorkView objects attributes to.
To configure the action:
1. Select the appropriate Document Type from the drop-down select list. The Filter
Document Type Association and Update Document Type Association drop-down select
lists will populate based on the Document Type selected.
2. If you want to specify the Filter Document Type Association for which the object meets
the configured criteria to determine which objects should be updated, select the
appropriate Filter Document Type Association. When this option is configured, a
document does not have to be attached to an object in order for it to be updated. The
Filter Document Type Association name is followed by (Class ClassName). Only Filter
Document Type Associations associated with the Document Type selected are
displayed. If no Filter Document Type Associations are configured for the selected
Document Type or you wish to evaluate an objects existence based on whether the
current document in Workflow is attached to an object in a static folder, select <All
objects that have doc attached>. When using the <All objects that have doc attached>
option, the object(s) must be attached in a static folder.
3. Select a Document Type Association to update the applicable objects from the Update
Document Type Association. The Document Type Associations that are displayed are
configured at the class level and are configured for the selected Document Type.
4. Click Add.
Caution: When a relationship attribute is used during object creation, if more than one object is
found for the relationship attributes value, the first object found is used for the relationship. If
an object is not found that matches the relationship attributes value, the value for the
relationship attribute is stored as blank in the updated object.
2012 Hyland Software, Inc.
432
OnBase 12 Workflow
The Form Type drop-down select list contains the list of E-Form and Virtual E-Form Document
Types available in the system. Select the E-Form Document Type to be used for form creation
Caution: The Document Type selected from the Form Type drop-down select list must have either
Electronic Form or Virtual Electronic Form selected as the Default File Format or a document will
not be created successfully using this action.
Caution: Ensure that all Keyword Types mapped on the HTML form are also assigned to the E-
Form Document Type selected from the Form Type drop-down select list.
Caution: If you are using the Classic Client interface, and the E-Form Document Type is
configured for auto-foldering, creating a document using this action will not initiate auto-
foldering. If you wish to initiate auto-foldering, additionally, you must use the DOC - Auto-Folder
This Document action.
Caution: The following options are not supported in the Java Client: Display For Input, Save Form
on Submit, and Initiate Workflow on Submit.
Keywords
The Keyword Type drop-down list lets you choose a Keyword Type to add to the new form.
Enter the keyword value in the field.
Inherit Common Keys
If you want keywords from the active document to be added to the form, select the Inherit
Common Keys from Active Document check box. If you want all common Keyword Type values,
select Inherit All. If you want to specify a subset of common Keyword Type values that are
inherited, select Inherit Selected. The Configure button will be enabled. Click Configure to
specify what Keyword Types you would like to inherit values.
Note: When Inherit Common Keys is selected, the action will ignore any Keyword Types that are
on the primary document but not on the E-Form. Only the common Keyword Types will be
inherited.
Note: If a default value is configured for a Keyword Type field in a form and a value exists for
a Keyword Type on the primary document, the value is inherited from the primary document
and the default value is not stored for the new form. If a default value is configured for a
Keyword Type field in a form and the Keyword Type is blank on the primary document, the
default value is stored.
2012 Hyland Software, Inc.
433
Workflow OnBase 12
The Document Handle Keyword Type must be assigned to both Document Types of the primary
document and the new E-Form.
Configuration Module Actions Descriptions
Note: If the primary document belongs to a closed or cutoff Records Management folder, the
Document Handle Keyword Value will not be copied from the new document to the primary
document.
Keyword Handling
The following table describes the behavior for copying a keyword from a primary item to a
related item or a new E-Form.
Multi -Instance Multi-Instance Only copy if they are the same Multi-Instance
Keyword Type Group Keyword Type Group Keyword Type Group (means they have the same
identification number)
2012 Hyland Software, Inc.
434
OnBase 12 Workflow
When this option is selected, the form is displayed in the User Interaction window for
additional data entry.
Tip: When using the Classic OnBase Client, if the Display for Input option is selected when
using this action as a System Task, it is required for the Workflow user interface to be open in
the background. It is recommended that the DOC - Display Related Document action be used
instead of this option under this circumstance.
Note: If working in an Institutional Database, the Institution # keyword will always be copied,
regardless of selection.
Note: The Save Form On Submit option is not supported in the OnBase Mobile Access for
BlackBerry, Mobile Access for Windows Phone, or Desktop interfaces.
Caution: If you are using encrypted keyword functionality when Save Form On Submit is selected,
encrypted keywords are not masked and the values are displayed. These values can be modified
and saved by the user. If you are using encrypted keyword functionality in the OnBase Client
when Save Form On Submit is not selected, encrypted keywords may appear as though they are
editable when creating a new form, but upon saving the form, any changes made to encrypted
Keyword Values are not saved; the original encrypted Keyword Values are retained.
Note: OBBtn_KS### and OBBtn_Keyset are not supported for this action.
2012 Hyland Software, Inc.
435
Workflow OnBase 12
The OBBtn_Cancel and OBBtn_No E-Form buttons function differently depending on what
option are selected for the FORM - Create New Form action when the Display for Input option is
Configuration Module Actions Descriptions
selected. The following table outlines the different outcomes these buttons produce:
2012 Hyland Software, Inc.
436
OnBase 12 Workflow
If an OBBtn_Cancel or OBBtn_No button is clicked, the last execution result is set to False and
the task list is aborted.
If you want to expand AutoFill Keyword sets using this action, use the OBBtn_ExpandKS###
button.
Note: Keyword validation does not apply to currency keywords in the Core. The user must be
familiar with the format used for currency in order to ensure accuracy.
Note:This action is supported only in the Unity and Web Client interfaces.
2012 Hyland Software, Inc.
437
Workflow OnBase 12
This action allows you to create a Unity Form of a specified form type. It allows you to map
Keyword Type values to automatically populate the form and/or display the form for user
Configuration Module Actions Descriptions
input.
Form Type
Select the Unity Form template that you would like to use to create the new form from the
Form Type drop-down select list.
Keyword Type/Keyword
Select a Keyword Type that you would like to populate on the form with a value. Enter the
value you want to populate in that Keyword Type in the Keyword field.
Inherit Common Keys from Active Document
If you want keywords from the active document to be added to the form, select the Inherit
Common Keys from Active Document check box. If you want all common Keyword Type values,
select Inherit All. If you want to specify a subset of common Keyword Type values that are
inherited, select Inherit Selected. The Configure button will be enabled. Click Configure to
specify what Keyword Types you would like to inherit values.
Note: When Inherit Common Keys is selected, the action will ignore any Keyword Types that
are on the primary document but not on the Form. Only the common Keyword Types will be
inherited.
Note: If a default value is configured for a Keyword Type field in a form and a value exists for
a Keyword Type on the primary document, the value is inherited from the primary document
and the default value is not stored for the new form. If a default value is configured for a
Keyword Type field in a form and the Keyword Type is blank on the primary document, the
default value is stored.
Note:If the primary document belongs to a closed or cutoff Records Management folder, the
Document Handle Keyword Value will not be copied from the new document to the primary
document.
Keyword Handling
2012 Hyland Software, Inc.
438
OnBase 12 Workflow
The following table describes the behavior for copying a keyword from a primary item to a
related item or a new E-Form.
Multi -Instance Multi-Instance Only copy if they are the same Multi-Instance
Keyword Type Group Keyword Type Group Keyword Type Group (means they have the same
identification number)
Tip: If the Display for Input option is selected when using this action as a System Task, it is
required for the Workflow user interface to be open in the background. It is recommended
that the DOC - Display Related Document action be used instead of this option under this
circumstance.
Note: If working in an Institutional Database, the Institution # keyword will always be copied,
regardless of selection.
Note: When configured with the Display For Input option selected, AutoFill Keyword Sets that
are configured on the form will expand when the value of the primary keyword of that AutoFill
Keyword Set is either inherited or added with the action. The expansion of the AutoFill
Keyword Set takes place when the form is displayed in the User Interaction window. If Display
for Input option is not selected, the AutoFill Keyword Set will not be expanded.
2012 Hyland Software, Inc.
439
Workflow OnBase 12
If you want to allow users the ability to discard the changes made to a form, but continue with
the task list, select the Allow User to Discard Changes and Continue Execution check box. When
Configuration Module Actions Descriptions
this check box is selected, a Discard and Continue button is available to the user.
Allow User to Discard Changes and Cancel Execution
If you want to allow users the ability to discard the changes made to a form, but cancel the
execution of the task list, select the Allow User to Discard Changes and Cancel Execution check
box. When this check box is selected, a Discard and Cancel button is available to the user.
Note: This action is not supported in the OnBase Mobile Access for BlackBerry or Mobile
Access for Windows Phone interfaces.
Displays an E-Form or Virtual E-Form. Requires a license for the E-Forms module.
Document Handle
This option causes OnBase to use the value contained in the Document Handle keyword as
the common denominator between the current and related document.
Related E-Form Type
All Document Types are available for selection; however, only E-Form and Virtual E-Form
Document Types are valid selections. Once a Document Type is selected, the Common
Keywords button is enabled.
Note: Workflow will display an error message to a user attempting to view a related document
that is not an E-Form Document Type.
Common Keywords
After you select the Related E-Form Type, click Common Keyword. The Related Document Types
dialog box opens. To add Keyword Types to the list, select the Keyword Type in the drop-down
list and click Add. To remove a Keyword Type from the list, select the keyword and click
Remove. The Document Types with these Keyword Types are evaluated when this action
executes.
Caution: If the current document contains a null value for a common Keyword Type, Workflow will
not find any related documents.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added (as shown in the screen
image).
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
2012 Hyland Software, Inc.
440
OnBase 12 Workflow
The Cancel Form Applies to: sections allows you to specify how you want the a form
cancellation to be processed whose form creation was initiated by this action.
If you want to expand AutoFill Keyword sets using this action, use the OBBtn_ExpandKS###
button.
Note: OBBtn_KS### and OBBtn_Keyset are not supported for this action.
Current form OBBtn_Cancel All E-Forms are displayed, but the task
only list is broken.
Current form OBBtn_No All E-Forms are displayed and the task
only list is not broken. The last execution
result is set to False.
Current and all OBBtn_Cancel All E-Forms are not displayed and the
subsequent task list is broken.
forms
Current and all OBBtn_No All E-Forms are displayed and the task
subsequent list is not broken. The last execution
forms result is set to False.
Displays an HTML form that allows the user to alter the keywords or Workflow properties of a
document related to the current document. Related documents are defined by specifying a
document type by common Keyword Types, Folder Type, or by selecting the Document Handle
check box.
Note: To input Workflow properties into a user form, the form must be configured properly. For
more information, see User Forms and the Workflow Property Bag on page 220.
Form
2012 Hyland Software, Inc.
441
Workflow OnBase 12
If a user form has been created for the life cycle, you can select it from the Form drop-down
list. You may also choose Auto-Generate and click Config, which calls the User Form
Configuration Module Actions Descriptions
Configuration dialog box. In this screen, specify the instructions and up to three Keyword
Types to display on your form. Workflow properties cannot be selected for an auto-generated
form. When finished, click OK. OnBase then builds the form. User forms display in the User
Interaction screen when the action is performed.
Note: If the document this action is performed on has multiple related documents and the
cancel button for the form is clicked at any point, processing will break and the form will not
be displayed for additional related documents.
Note: When using the Auto-Generate option, if you want a drop-down select list available in
the form, the selected Keyword Type must be configured with the Use Keyword Data Set and
Keyword Must Exist options.
Note: OBBtn_KS###, OBBtn_ExpandKS###, and OBBtn_Keyset are not supported for this
action.
Note: If you perform this action from an e-mail notification in the Integration for Microsoft
Outlook 2007 or Integration for Microsoft Outlook 2010 and click the cancel button, the e-mail
notification is still modified to indicate that the ad hoc task that was successfully executed.
Task list execution does not continue.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
2012 Hyland Software, Inc.
442
OnBase 12 Workflow
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
2012 Hyland Software, Inc.
443
Workflow OnBase 12
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Configuration Module Actions Descriptions
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
2012 Hyland Software, Inc.
444
OnBase 12 Workflow
Configure
1. Create a form with an HTML editor such as Microsoft FrontPage; save to disk as an
.HTM or .HTML file type.
Note: Any HTML forms that are used in a Workflow process must be available to all users of
the workflow process, from the same location on the network.
2012 Hyland Software, Inc.
445
Workflow OnBase 12
If you want the Keyword Values or Workflow properties associated with the document to
populate the forms fields, select the Fill HTML fields with document keyword and property
Configuration Module Actions Descriptions
values option. When this is selected, the form will display the documents Keyword Values or
Workflow properties in the appropriate fields. When Keyword Values are changed and the
changes are saved, the Keyword Values or Workflow properties associated with the document
will be updated.
Note: When the Fill HTML fields with document keyword and property values option is selected,
the cursor will not appear initially in the first field of the form unless the Allow active content to
run in files on My Computer option under Security is selected (accessed in Internet Explorer by
selecting Tools | Internet Options, then selecting the Advanced tab) in Windows XP or Windows
Server 2003.
Caution: When an HTML form allows the input of multiple values for a single Keyword Type within
a Multi-Instance Keyword Type Group, then only the last value specified for the Keyword Type
will be saved into the Multi-Instance Keyword Type Group.
Note: When auto-generating an HTML form for a document, the clients regional settings will
determine formatting for date and date time keywords.
Caution: When the Fill HTML fields with document keyword and property values option is selected,
ensure that the form is configured to display all instances of all keyword values. Only keyword
values displayed on the form will be saved. All other keyword values will be removed from the
document.
Configure
An alternative to a user form that is accessed via a UNC path is to use an HTML form via URL.
This configuration is only supported for Core-based user interfaces. The Classic Client
interface does not support this configuration. Follow these steps to configure a user form that
is accessible via URL:
2012 Hyland Software, Inc.
446
OnBase 12 Workflow
7. The Form drop-down list on the action configuration screen is now available for user
form selection.
Note: When using a URL to specify a user form, the Fill HTML Fields with document keyword and
property values field is not functional.
Caution: When using a URL-accessed user form, the data on the form will not be posted to the
URL until after the next action in the task list has executed. Due to this behavior, subsequent
actions after the form is submitted should not rely on the data being submitted to the web
application.
Note: If there are several forms within a task list, if one of the forms is cancelled, the task
execution is aborted.
Note: If working in an Institutional Database, the Institution # keyword will always be copied,
regardless of selection.
2012 Hyland Software, Inc.
447
Workflow OnBase 12
Displays an HTML form in the User Interaction window that allows the user to change Keyword
Values on the document.
Configuration Module Actions Descriptions
Form
This action requires configuration of the Form drop-down list. If a user form has been created
for the life cycle, you can select it from the Form drop-down list. You may also choose Auto-
Generate and click Config, which calls the User Form Configuration dialog box. In this screen,
specify the instructions and up to three keyword types to display on your form. When
finished, click the OK button. OnBase then builds the form. User forms display in the User
Interaction screen when the action is performed.
Note: When using the Auto-Generate option, if you want a drop-down select list available in
the form, the selected Keyword Type must be configured with the Use Keyword Data Set and
Keyword Must Exist options.
Note: If working in an Institutional Database, the Institution # keyword will always be copied,
regardless of selection.
Note: To input Workflow properties into a user form, the form must be configured properly. For
more information, see User Forms and the Workflow Property Bag on page 220.
Note: If you perform this action from an e-mail notification in the Integration for Microsoft
Outlook 2007 or Integration for Microsoft Outlook 2010 and click the cancel button, the e-mail
notification is still modified to indicate that the ad hoc task that was successfully executed.
Task list execution does not continue.
1. Create a form with an HTML editor such as Microsoft FrontPage; save to disk as an
.HTM or .HTML file type.
Note: Any HTML forms that are used in a Workflow process must be available to all users of
the workflow process, from the same location on the network.
2012 Hyland Software, Inc.
448
OnBase 12 Workflow
4. The Form Name list activates, displaying all the forms currently available for that life
cycle. Type a name from your new form in the field below this list and click Save.
Note: When the Fill HTML fields with document keyword and property values option is selected,
the cursor will not appear initially in the first field of the form unless the Allow active content to
run in files on My Computer option under Security is selected (accessed in Internet Explorer by
selecting Tools | Internet Options, then selecting the Advanced tab) in Windows XP or Windows
Server 2003.
Caution: When an HTML form allows the input of multiple values for a single Keyword Type within
a Multi-Instance Keyword Type Group, then only the last value specified for the Keyword Type
will be saved into the Multi-Instance Keyword Type Group.
Note: When auto-generating an HTML form for a document, the clients regional settings will
determine formatting for date and date time keywords.
Caution: When the Fill HTML fields with document keyword and property values option is selected,
ensure that the form is configured to display all instances of all keyword values. Only keyword
values displayed on the form will be saved. All other keyword values will be removed from the
document.
Configure
An alternative to a user form that is accessed via a UNC path is to use an HTML form via URL.
This configuration is only supported for Core-based user interfaces. The Classic Client
interface does not support this configuration. Follow these steps to configure a user form that
is accessible via URL:
2012 Hyland Software, Inc.
449
Workflow OnBase 12
4. With your new form selected in the Form Name list, click Configure.
5. In the User Form Configuration dialog box, type in the URL of the form you wish to use,
Configuration Module Actions Descriptions
Note: The form is configured for use in the same way as a standard user form, however,
OnBase must pass an obTarget parameter to the form. This can be accomplished by
embedding script in the form to retrieve this parameter and set the forms action attribute.
Whenever the user submits a form, the form needs to be directed back to the Workflow
interface for further processing. The form must programmatically retrieve the value of a
querystring parameter called obTarget and set the action attribute of the form to this value.
The following is an example using JavaScript in the HTML page's OnLoad event:
document.forms.item(0).action = location.search.split("obTarget=")[1];
Note: When using a URL to specify a user form, the Fill HTML Fields with document keyword and
property values field is not functional.
Caution: When using a URL-accessed user form, the data on the form will not be posted to the
URL until after the next action in the task list has executed. Due to this behavior, subsequent
actions after the form is submitted should not rely on the data being submitted to the web
application.
Note: OBBtn_KS###, OBBtn_ExpandKS###, and OBBtn_Keyset are not supported for this
action.
2012 Hyland Software, Inc.
450
OnBase 12 Workflow
Note: Date and date & time formatting are dependent on regional settings.
Keyword Type
The drop-down list displays all available Keyword Types. Only keywords of the Keyword Type
selected are affected.
Keyword Value
2012 Hyland Software, Inc.
451
Workflow OnBase 12
Note: When setting an Alphanumeric Keyword Type and using the Time Stamp option in the
Core-based interface, the value will be truncated if it is over 20 characters. This also applies
to the Core itself.
Currency Format
When the Keyword Type selected is configured as a Specific Currency Data Type, a Currency
Format drop-down select list is displayed. Any specific currency format configured for the
system can be selected from the drop-down select list.
Note: When setting an Alphanumeric Keyword Type and using the Time Stamp option in the
Core-based interface, the value will be truncated if it is over 20 characters. This also applies
to the Core itself.
Currency Format
When the Keyword Type selected is configured as a Specific Currency Data Type, a Currency
Format drop-down select list is displayed. Any specific currency format configured for the
system can be selected from the droop-down select list.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
2012 Hyland Software, Inc.
452
OnBase 12 Workflow
Under the Related Documents heading, the status of the related documents configuration is
displayed.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
2012 Hyland Software, Inc.
453
Workflow OnBase 12
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
Configuration Module Actions Descriptions
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
Associated Primary Document (Applicable to Work Folder documents only)
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
2012 Hyland Software, Inc.
454
OnBase 12 Workflow
Caution: If more than one Autofill Keyword Set exists with the same primary Keyword Value and
the Expand All Matching Instances option is not set for the AutoFill Keyword Set, when the action
is executed, no AutoFill will take place.
Two options are available: Keep Existing Values and Replace Secondary Values When Only One
Instance Exists.
Caution: The Replace Secondary Value When Only One Instance Exists option should not be used
with documents that have more than one secondary value of the same Keyword Type.
When Keep Existing Values is selected, it will retain the original secondary Keyword Values and
a new instance will be added containing the AutoFill Keyword Set data.
When Replace Secondary Values When Only One Instance Exists is selected, the following will
occur:
When using standard Keyword Types, the secondary Keyword Values will be replaced if
only one instance of the secondary keyword exists. If more than one instance of the
secondary keyword is found, the original secondary values will be retained and a
new instance is created containing the data from the AutoFill keyword set.
Caution: In the Classic OnBase Client user interface, if there are already keyword values
associated with the primary Keyword Type value, the associated values will be replaced with the
value from the AutoFill Keyword Set when this action is executed.
2012 Hyland Software, Inc.
455
Workflow OnBase 12
When using Keyword Type Groups, secondary Keyword Values will always be replaced
with the data from the AutoFill Keyword Set.
Configuration Module Actions Descriptions
When using Multi-Instance Keyword Type Groups, if a single instance of the primary
Keyword Type exists, secondary Keyword Values will be replaced with the data from
the AutoFill Keyword Set. If multiple instances of the specified primary value exist,
the original data will be retained and a new instance containing the data from the
AutoFill Keyword Set will be populated.
2012 Hyland Software, Inc.
456
OnBase 12 Workflow
The following describes what can be expected using the Keep Existing Values and Replace
Secondary Values When Only One Instance Exists options with standard Keyword Types,
Caution: When using the Classic OnBase Client, it is recommended that the Replace Secondary
Values When Only One Instance Exists option is used only if has been determined that documents
only have one value for each Keyword Type. If there are two or more secondary values on a
document and the action is configured to Replace Secondary Value When Only One Value Exists, the
Classic Client does not know which value to replace and the user will not know which value has
been replaced.
2012 Hyland Software, Inc.
457
Workflow OnBase 12
Caution: This action can populate values for multiple primary values. For each primary, there will
be corresponding secondary values for the associated Keyword Types, as defined in the AutoFill
Configuration Module Actions Descriptions
Keyword Set. If a primary value is associated with multiple AutoFill Keyword Sets, no secondary
values will be populated for that primary value.
Caution: If using a Multi-Instance Keyword Type Group, the AutoFill Keyword Set will only
populate if both the primary and secondary values reside in the Keyword Group. If the secondary
values are outside of the Multi-Instance Keyword Type Group, the AutoFill Keyword Set will not
populate.
2012 Hyland Software, Inc.
458
OnBase 12 Workflow
Creates an empty Multi-Instance Keyword Type Group of the type specified in the Keyword
Record drop-down select list. Only Multi-Instance Keyword Type Groups will be listed in this
drop-down select list. The Multi-Instance Keyword Type Group that is created is not saved to
the database until Workflow encounters the Key-End Keyword Record action.
Caution: Any rules or actions that evaluate Keyword Values that have been added to the Multi-
Instance Keyword Type Group before the Key-End Keyword Record action is encountered will not
be evaluated correctly. The newly created Multi-Instance Keyword Type Group must be saved
before the values within it can accurately be evaluated.
Note: It is recommended to keep tasks simple that modify Multi-Instance Keyword Type
Groups. It is recommended to only add keywords between the Key - Begin Keyword Record and
Key - End Keyword Record actions. If this cannot be achieved, make sure that the Key - End
Keyword Record action follows after every Key - Begin Keyword Record action and test the
configuration thoroughly. The Key - Add Keyword to Document, Prop - Set Keyword from
Property, and Key - Set Keyword to Entry to Queue Date actions may be used in between the Key
- Begin Keyword Record and Key - End Keyword Record actions for Core-based interfaces. The
Classic Client interface only supports Key - Add Keyword to Document between the Key - Begin
Keyword Record and Key - End Keyword Record.
2012 Hyland Software, Inc.
459
Workflow OnBase 12
See Using Multi-Instance Groups with Begin/End Keyword Record on page 673 for more
information.
Configuration Module Actions Descriptions
Note: Keyword Values from standard Keyword Types cannot be copied to/from Keyword Types
in a Multi-Instance Keyword Type Group.
Source/Destination Keyword
Select the Keyword Type from which to take the values in the Source Keyword drop-down list.
The following system keywords are available from this drop-down select list, in addition to
configured Keyword Types:
>> Document Date
>> Date Stored
>> Document Handle
>> Document Name
>> Document Type
For more information about these system properties, see the Document Properties topic in
the OnBase Client help system.
Select the Keyword Type to which the value should be copied in the Destination Keyword drop-
down list.
Note: When copying currency formatted Keyword values, the currency format of both the
Source Keyword and Destination Keyword must have the same formatting to ensure successful
copying.
Note: When a Date or Date/Time Keyword Value is copied into an alphanumeric Keyword Type,
the servers default date and date/time format is used.
Note: Keyword Values from standard Keyword Types cannot be copied to/from Keyword Types
in a Multi-Instance Keyword Type Group.
2012 Hyland Software, Inc.
460
OnBase 12 Workflow
Source/Destination Keyword
Select the Keyword Type from which to take the values in the Source Keyword drop-down list.
For more information about these system properties, see the Document Properties topic in
the OnBase Client help system.
Select the Keyword Type to which the value should be copied in the Destination Keyword drop-
down list.
Note: When copying currency formatted Keyword values, the currency format of both the
Source Keyword and Destination Keyword must have the same formatting to ensure successful
copying.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
2012 Hyland Software, Inc.
461
Workflow OnBase 12
After you select the related Document Type, click Common Keywords. The Related Document
Types dialog box opens. To add Keyword Types to the list, select the Keyword Type in the list
Configuration Module Actions Descriptions
and click Add. To remove a Keyword Type from the list, select the keyword and click Remove.
The Document Types with these Keyword Types are evaluated when this action executes.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
2012 Hyland Software, Inc.
462
OnBase 12 Workflow
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
2012 Hyland Software, Inc.
463
Workflow OnBase 12
This action copies all of the Multi-Instance Keyword Type Groups from all of the related
documents to the current document.
Select the Keyword Group that you want to copy from the drop-down select list.
Note: When copying currency formatted Keyword values, the currency format of both the
Source Keyword and Destination Keyword must have the same formatting to ensure successful
copying.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
2012 Hyland Software, Inc.
464
OnBase 12 Workflow
After you select the related Document Type, click Common Keywords. The Related Document
Types dialog box opens. To add Keyword Types to the list, select the Keyword Type in the list
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
2012 Hyland Software, Inc.
465
Workflow OnBase 12
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
2012 Hyland Software, Inc.
466
OnBase 12 Workflow
The Keyword Group drop-down select list specifies what Multi-Instance Keyword Type Group
you want to copy from the related documents. Only Multi-Instance Keyword Type Groups will
Note: When this action is not fully configured, no actions are executed after it.
Note: When copying currency formatted Keyword values, the currency format of both the
Source Keyword and Destination Keyword must have the same formatting to ensure successful
copying.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
2012 Hyland Software, Inc.
467
Workflow OnBase 12
After you select the related Document Type, click Common Keywords. The Related Document
Types dialog box opens. To add Keyword Types to the list, select the Keyword Type in the list
Configuration Module Actions Descriptions
and click Add. To remove a Keyword Type from the list, select the keyword and click Remove.
The Document Types with these Keyword Types are evaluated when this action executes.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
2012 Hyland Software, Inc.
468
OnBase 12 Workflow
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
2012 Hyland Software, Inc.
469
Workflow OnBase 12
The Keyword Group drop-down select list specifies what Multi-Instance Keyword Type Group
you want to copy to the related documents. Only Multi-Instance Keyword Type Groups will be
Configuration Module Actions Descriptions
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
2012 Hyland Software, Inc.
470
OnBase 12 Workflow
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
Associated Primary Document (Applicable to Work Folder documents only)
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
2012 Hyland Software, Inc.
471
Workflow OnBase 12
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
Source/Destination Keyword
Select the Keyword Type from which to take the values in the Source Keyword drop-down list.
The following system keywords are available from this drop-down select list, in addition to
configured Keyword Types:
>> Document Date
>> Date Stored
>> Document Handle
>> Document Name
>> Document Type
For more information about these system properties, see the Document Properties topic in
the OnBase Client help system.
2012 Hyland Software, Inc.
472
OnBase 12 Workflow
Select the Keyword Type to which the value should be copied in the Destination Keyword drop-
down list.
Caution: Copying a Keyword Type Group (non-Multi-Instance) from a related document using this
action will result in the copied values replacing the existing values regardless of the keyword
options configured for the action.
Note: When copying currency formatted Keyword values, the currency format of both the
Source Keyword and Destination Keyword must have the same formatting to ensure successful
copying.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
2012 Hyland Software, Inc.
473
Workflow OnBase 12
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
2012 Hyland Software, Inc.
474
OnBase 12 Workflow
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
Associated Primary Document (Applicable to Work Folder documents only)
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
2012 Hyland Software, Inc.
475
Workflow OnBase 12
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
Note: If the Folder Type method is used, the Keep existing values for common keywords and
Delete existing values for common keywords options are not available.
Keyword Handling
The following table describes the behavior for copying a keyword from a primary item to a
related item or a new E-Form.
Multi -Instance Multi-Instance Only copy if they are the same Multi-Instance
Keyword Type Group Keyword Type Group Keyword Type Group (means they have the same
identification number)
The following table describes the behavior for deleting a keyword from a related document
based on a primary document.
2012 Hyland Software, Inc.
476
OnBase 12 Workflow
Multi -Instance Multi -Instance Only delete if they are the same Multi -Instance
Keyword Type Group Keyword Type Group Keyword Type Group (means they have the same
identification number)
Note: When copying currency formatted Keyword values, the currency format of both the
Source Keyword and Destination Keyword must have the same formatting to ensure successful
copying.
2012 Hyland Software, Inc.
477
Workflow OnBase 12
Related Documents
Configuration Module Actions Descriptions
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
2012 Hyland Software, Inc.
478
OnBase 12 Workflow
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
Associated Primary Document (Applicable to Work Folder documents only)
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
2012 Hyland Software, Inc.
479
Workflow OnBase 12
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
Note: If the Folder Type method is used, the Keep existing values for common keywords and
Delete existing values for common keywords options are not available.
Keyword Handling
The following table describes the behavior for copying a keyword from a primary item to a
related item or a new E-Form.
Multi -Instance Multi-Instance Only copy if they are the same Multi-Instance
Keyword Type Group Keyword Type Group Keyword Type Group (means they have the same
identification number)
The following table describes the behavior for deleting a keyword from a related document
based on a primary document.
2012 Hyland Software, Inc.
480
OnBase 12 Workflow
Multi -Instance Multi -Instance Only delete if they are the same Multi -Instance
Keyword Type Group Keyword Type Group Keyword Type Group (means they have the same
identification number)
Note: Ensure that the Keyword Type that is selected for this action contains numeric-based
values.
Keyword Type
The drop-down list displays available Keyword Types. Only keywords of the selected Keyword
Type are affected.
Amount
2012 Hyland Software, Inc.
481
Workflow OnBase 12
The Amount field is available with actions that increment or decrement a Keyword Value. Use
the Amount field to specify the quantity by which the Keyword Value is to change. The
Configuration Module Actions Descriptions
Caution: If you enter 0 in this field, when saved, it will automatically default to 1 for the value.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
2012 Hyland Software, Inc.
482
OnBase 12 Workflow
After you select the related Document Type, click Common Keywords. The Related Document
Types dialog box opens. To add Keyword Types to the list, select the Keyword Type in the list
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
2012 Hyland Software, Inc.
483
Workflow OnBase 12
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
2012 Hyland Software, Inc.
484
OnBase 12 Workflow
Note: Ensure that the Keyword Type that is selected for this action contains numeric-based
values.
Keyword Type
The drop-down list displays available Keyword Types. Only keywords of the selected Keyword
Type are affected.
Amount
The Amount field is available with actions that increment or decrement a Keyword Value. Use
the Amount field to specify the quantity by which the Keyword Value is to change. The
maximum value that can be entered is 999999999.
Caution: If you enter 0 in this field, when saved, it will automatically default to 1 for the value.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
2012 Hyland Software, Inc.
485
Workflow OnBase 12
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
Configuration Module Actions Descriptions
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
2012 Hyland Software, Inc.
486
OnBase 12 Workflow
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
2012 Hyland Software, Inc.
487
Workflow OnBase 12
Configuration Module Actions Descriptions
Allow Wildcards
The Allow Wildcards allows wildcards to be used in the Keyword Value field. When using
wildcards, you can use the? (question mark) wildcard to replace a specific number of
characters. For example, a value of COLUMB ?? succeeds for COLUMBUS, COLUMBIA and any
other eight-character Keyword Value beginning with COLUMB. The * (asterisk) wildcard
represents an indefinite number of characters. COLUMB* succeeds for any length keyword
values beginning with COLUMB, such as those mentioned above and COLUMBO and
COLUMBIANA.
Note: The Allow Wildcards check box is only enabled for Alphanumeric Keyword Types.
Wildcards can be used with Alphanumeric Keyword Types that have masking configured.
When masking is used, the ? wildcard must be used.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
2012 Hyland Software, Inc.
488
OnBase 12 Workflow
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
2012 Hyland Software, Inc.
489
Workflow OnBase 12
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Configuration Module Actions Descriptions
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
2012 Hyland Software, Inc.
490
OnBase 12 Workflow
Allow Wildcards
The Allow Wildcards allows wildcards to be used in the Keyword Value field. When using
wildcards, you can use the? (question mark) wildcard to replace a specific number of
characters. For example, a value of COLUMB ?? succeeds for COLUMBUS, COLUMBIA and any
other eight-character Keyword Value beginning with COLUMB. The * (asterisk) wildcard
represents an indefinite number of characters. COLUMB* succeeds for any length keyword
values beginning with COLUMB, such as those mentioned above and COLUMBO and
COLUMBIANA.
Note: The Allow Wildcards check box is only enabled for Alphanumeric Keyword Types.
Wildcards can be used with Alphanumeric Keyword Types that have masking configured.
When masking is used, the ? wildcard must be used.
Signals to save the new Keyword Type Group of the type specified in the Keyword Record
drop-down select list created by the Key-Begin Keyword Record action. Only Multi-Instance
Keyword Type Groups will be listed in this drop-down select list. This action saves all Keyword
Values added to the Keyword Type Group.
Caution: If this action is not used in conjunction with the Key - Begin Keyword Record, all values
added to a Keyword Type Group created by the Key - Begin Keyword Record action will not be
saved and the values entered will be lost.
Note: It is recommended to keep tasks simple that modify Multi-Instance Keyword Type
Groups. It recommended to only add keywords between the Key - Begin Keyword Record and
Key - End Keyword Record actions. If this cannot be achieved, make sure that the Key - End
Keyword Record action follows after every Key - Begin Keyword Record action and test the
configuration thoroughly.
2012 Hyland Software, Inc.
491
Workflow OnBase 12
See Using Multi-Instance Groups with Begin/End Keyword Record on page 673 for more
information.
Configuration Module Actions Descriptions
Note: Ensure that the Keyword Type that is selected for this action contains numeric-based
values.
Keyword Type
The drop-down list displays available Keyword Types. Only keywords of the selected Keyword
Type are affected.
Amount
The Amount field is available with actions that increment or decrement a Keyword Value. Use
the Amount field to specify the quantity by which the Keyword Value is to change. The
maximum value that can be entered is 999999999.
Caution: If you enter 0 in this field, when saved, it will automatically default to 1 for the value.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
2012 Hyland Software, Inc.
492
OnBase 12 Workflow
Select a Document Type from the Related Document Type drop-down list.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
2012 Hyland Software, Inc.
493
Workflow OnBase 12
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
2012 Hyland Software, Inc.
494
OnBase 12 Workflow
Caution: If you enter 0 in this field, when saved, it will automatically default to 1 for the value.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
2012 Hyland Software, Inc.
495
Workflow OnBase 12
Select a Document Type from the Related Document Type drop-down list.
Configuration Module Actions Descriptions
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
2012 Hyland Software, Inc.
496
OnBase 12 Workflow
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
2012 Hyland Software, Inc.
497
Workflow OnBase 12
Select the Keyword Type from the drop-down select list of which you would like to replace the
value. If you have a specific value you want the system to look for and replace, enter the
Configuration Module Actions Descriptions
value in the Old Keyword field. Enter the value that you want to put in the old value's place in
the New Keyword section.
There are many options under the New Keyword section. If you want to specify a new value to
replace the Old Keyword with, select Specific Value and enter the value in the field. If you
would like to replace the Old Keyword with a value from the system, select System Value.
Select Current Date from the drop-down to use the current date as the new value. Select
Current User ID if you want the new value to be the User Id of the currently logged in user.
Select Current Users Name if you want the new value to be the user name of the currently
logged in user. select Current Users Real Name if you want the new value to be the real name
specified for the currently logged in user.
If you want to replace all Keyword Type values with the value in the New Keyword selection,
select the Delete All Existing Values option to delete all values regardless of what the value is.
When this option is selected, the Old Keyword field is disabled and if any value was entered in
that field previously, it will be ignored by the system.
Using This Action With Multi-Instance Keyword Type Groups
If the Delete All Existing Values option is selected when configured to use a Keyword Type
within a Multi-instance Keyword Type Group, the Keyword Value of the Keyword Type will be
removed from all Multi-Instance Keyword Type instances that exist. A new Multi-Instance
Keyword Type Group instance is created with the new Keyword Value.
Note: In the Classic Client interface, when setting an Alphanumeric Keyword Type and using
the Time Stamp option, the value will be truncated if it is exceeds the number of characters
configured for a Keyword Type. The Core-based interfaces will not allow the value to be saved
if the length exceeds the number of characters configured for a Keyword Type.
Currency Format
When the Keyword Type selected is configured as a Specific Currency Data Type, a Currency
Format drop-down select list is displayed. Any specific currency format configured for the
system can be selected from the droop-down select list.
Select the Keyword Type from the drop-down select list of which you would like to replace the
value. If you have a specific value you want the system to look for and replace, enter the
value in the Old Keyword field. Enter the value that you want to put in the old value's place in
the New Keyword section.
There are many options under the New Keyword section. If you want to specify a new value to
replace the Old Keyword with, select Specific Value and enter the value in the field. If you
would like to replace the Old Keyword with a value from the system, select System Value.
Select Current Date from the drop-down to use the current date as the new value. Select
Current User ID if you want the new value to be the User Id of the currently logged in user.
Select Current Users Name if you want the new value to be the user name of the currently
logged in user. select Current Users Real Name if you want the new value to be the real name
specified for the currently logged in user.
2012 Hyland Software, Inc.
498
OnBase 12 Workflow
If you want to replace all Keyword Type values with the value in the New Keyword selection,
select the Delete All Existing Values option to delete all values regardless of what the value is.
Note: In the Classic Client interface, when setting an Alphanumeric Keyword Type and using
the Time Stamp option, the value will be truncated if it is exceeds the number of characters
configured for a Keyword Type. The Core-based interfaces will not allow the value to be saved
if the length exceeds the number of characters configured for a Keyword Type.
Currency Format
When the Keyword Type selected is configured as a Specific Currency Data Type, a Currency
Format drop-down select list is displayed. Any specific currency format configured for the
system can be selected from the droop-down select list.
2012 Hyland Software, Inc.
499
Workflow OnBase 12
Keyword Type
The drop-down list displays available Keyword Types. Only keywords of the selected Keyword
Configuration Module Actions Descriptions
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
2012 Hyland Software, Inc.
500
OnBase 12 Workflow
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
Associated Primary Document (Applicable to Work Folder documents only)
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
2012 Hyland Software, Inc.
501
Workflow OnBase 12
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
2012 Hyland Software, Inc.
502
OnBase 12 Workflow
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
2012 Hyland Software, Inc.
503
Workflow OnBase 12
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
Configuration Module Actions Descriptions
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
Associated Primary Document (Applicable to Work Folder documents only)
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
2012 Hyland Software, Inc.
504
OnBase 12 Workflow
Keyword Type
The drop-down list displays available Keyword Types. Only keywords of the selected Keyword
Type are affected.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
2012 Hyland Software, Inc.
505
Workflow OnBase 12
Types dialog box opens. To add Keyword Types to the list, select the Keyword Type in the list
and click Add. To remove a Keyword Type from the list, select the keyword and click Remove.
The Document Types with these Keyword Types are evaluated when this action executes.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
2012 Hyland Software, Inc.
506
OnBase 12 Workflow
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
2012 Hyland Software, Inc.
507
Workflow OnBase 12
Keyword Type
The drop-down list displays available Keyword Types. Only keywords of the selected Keyword
Type are affected.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
2012 Hyland Software, Inc.
508
OnBase 12 Workflow
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
Associated Primary Document (Applicable to Work Folder documents only)
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
2012 Hyland Software, Inc.
509
Workflow OnBase 12
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
This action will create an AutoFill Keyword Set instance from the values on the current
document. Select the appropriate AutoFill Keyword Set from the drop-down select list that will
be filled with values from the document.
When using this action, the primary keyword of the AutoFill Keyword Set must contain a value
on the document in Workflow in order for the AutoFill Keyword Set record to be created.
Caution: When creating AutoFill Keyword Sets that consist of a mixture of standard Keyword
Types, Single Instance Keyword Type Groups, and/or Multi-Instance Keyword Type Groups,
values of the Keyword Types that are of the same type and, if part of a Keyword Type Group,
belong to the same Keyword Type Group as the primary Keyword Type will be populated.
Keyword Types not of the same type as the primary Keyword Type will not be populated.
2012 Hyland Software, Inc.
510
OnBase 12 Workflow
This action will create an AutoFill Keyword Set instance from the values on the related
documents of the current document. Select the appropriate AutoFill Keyword Set from the
drop-down select list that will be filled with values from the document.
When using this action, the primary keyword of the AutoFill Keyword Set must contain a value
on the related documents in Workflow in order for the AutoFill Keyword Set record to be
created.
Caution: When creating AutoFill Keyword Sets that consist of a mixture of standard Keyword
Types, Single Instance Keyword Type Groups, and/or Multi-Instance Keyword Type Groups,
values of the Keyword Types that are of the same type and, if part of a Keyword Type Group,
belong to the same Keyword Type Group as the primary Keyword Type will be populated.
Keyword Types not of the same type as the primary Keyword Type will not be populated.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
2012 Hyland Software, Inc.
511
Workflow OnBase 12
After you select the related Document Type, click Common Keywords. The Related Document
Types dialog box opens. To add Keyword Types to the list, select the Keyword Type in the list
Configuration Module Actions Descriptions
and click Add. To remove a Keyword Type from the list, select the keyword and click Remove.
The Document Types with these Keyword Types are evaluated when this action executes.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
2012 Hyland Software, Inc.
512
OnBase 12 Workflow
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
2012 Hyland Software, Inc.
513
Workflow OnBase 12
Caution:This action will remove AutoFill Keyword Set record(s), with specified value(s) in the
primary keyword, from the database. Ensure that this action is configured properly. The removal
of AutoFill Keyword Set records is permanent and irreversible.
This action will delete AutoFill Keyword Set records that match the configured criteria.
Select the AutoFill Keyword Set from which you would like to remove records from.
The primary Keyword Types populates the Keyword Type to Search field automatically.
If you want to specify a certain value that will identify the records that will be deleted, select
Specific Value and enter the appropriate value in the field.
If you want to use the a value within a property to identify the record(s) to be deleted, select
Property and enter the name of the property in the field.
If you want to use a Keyword Type value to identify the record(s) to be deleted. select
Keyword and select the Keyword Type from the drop-down list that will contain the
appropriate value.
Note:This action is not supported when working with external AutoFill Keyword Sets.
Note:This action is not supported in the Core when Currency, Date, or Date/Time keywords
are configured as the primary keyword in the AutoFill Keyword Set.
This action allows you to change the value of a Keyword Type within a specific AutoFill
Keyword Set using static values. The AutoFill Keyword Set that will be updated is identified by
matching values of the specified Keyword Type(s) associated with the currently displayed
document.
AutoFill Keyword Set drop-down select list allows you to select the AutoFill Keyword Set in
which you want to update values.
Based on your selection in the AutoFill Keyword Set drop-down select list, the First Keyword
Type to Search field will be populated with the primary Keyword Type associated with the
AutoFill Keyword Set. The value from the currently selected document will be used for the
search.
2012 Hyland Software, Inc.
514
OnBase 12 Workflow
The Second Keyword Type (Optional) drop-down select list allows you to further identify the
AutoFill Keyword Set for which you want to update values. It is an optional selection. The
Note: The primary Keyword Type is not available for selection in the Second Keyword Type
(Optional) drop-down select list.
The Keyword Type to Set Value drop-down select list allows you to select the Keyword Type
value for which you want to change.
The Keyword Value field contains the value to which the Keyword Type will be changed.
When an Alphanumeric Keyword Type is selected, the Time Stamp option can be selected to
use the date/time information for the keyword value.
Note: This action is not supported when working with external AutoFill Keyword Sets.
This action allows you to change the value of a Keyword Type within a specific AutoFill
Keyword Set using existing Keyword Type values. The AutoFill Keyword Set that will be
updated is identified by matching values of the specified Keyword Type(s) associated with the
currently displayed document.
AutoFill Keyword Set drop-down select list allows you to select the AutoFill Keyword Set in
which you want to update values.
Based on your selection in the AutoFill Keyword Set drop-down select list, the First Keyword
Type to Search field will be populated with the primary Keyword Type associated with the
AutoFill Keyword Set. The value from the currently selected document will be used for the
search.
The Second Keyword Type (Optional) drop-down select list allows you to further identify the
AutoFill Keyword Set for which you want to update values. It is an optional selection. The
value from the currently selected document will be used for the search.
Note: The primary Keyword Type is not available for selection in the Second Keyword Type
(Optional) drop-down select list.
The Keyword Type to Set Value drop-down select list allows you to select the Keyword Type
from which you would like to copy the value from the currently displayed document to the
identified AutoFill Keyword Set.
Note: This action is not supported when working with external AutoFill Keyword Sets.
2012 Hyland Software, Inc.
515
Workflow OnBase 12
This action allows you to copy a date value within an AutoFill Keyword Set to the Entry to
Queue Date for a document. This date is displayed as the Arrival Time in the Workflow Inbox.
Only Date Keyword Types are available from the Keyword Type to Set Value drop-down list
AutoFill Keyword Set drop-down select list allows you to select the AutoFill Keyword Set in
which you want to update values.
Based on your selection in the AutoFill Keyword Set drop-down select list, the First Keyword
Type to Search field will be populated with the primary Keyword Type associated with the
AutoFill Keyword Set. The value from the currently selected document will be used for the
search.
The Second Keyword Type (Optional) drop-down select list allows you to further identify the
AutoFill Keyword Set for which you want to update values. It is an optional selection. The
value from the currently selected document will be used for the search.
Note: The primary Keyword Type is not available for selection in the Second Keyword Type
(Optional) drop-down select list.
The Keyword Type to Get Value From drop-down select list specifies what Keyword Type value
will be used as the entry to queue date (arrival time) and will be copied to the document.
Note: If no value exists in the AutoFill Keyword Set for the specified Keyword Type, no action
is taken.
Note: If multiple AutoFill Keyword Sets match the search criteria, the value from the first
AutoFill Keyword Set found will be applied.
Note: This action is not supported when working with external AutoFill Keyword Sets.
This action allows you to copy a value within an AutoFill Keyword Set to the currently
displayed document. This action copies the Keyword Value without expanding the entire
AutoFill Keyword Set on the document.
AutoFill Keyword Set drop-down select list allows you to select the AutoFill Keyword Set in
which you want to update values.
Based on your selection in the AutoFill Keyword Set drop-down select list, the First Keyword
Type to Search field will be populated with the primary Keyword Type associated with the
AutoFill Keyword Set. The value from the currently selected document will be used for the
search.
2012 Hyland Software, Inc.
516
OnBase 12 Workflow
The Second Keyword Type (Optional) drop-down select list allows you to further identify the
AutoFill Keyword Set for which you want to update values. It is an optional selection. The
Note: The primary Keyword Type is not available for selection in the Second Keyword Type
(Optional) drop-down select list.
The Keyword Type to Set Value drop-down select list specifies what Keyword Type value will be
copied to the document.
Note: If there are several matching AutoFill set records, all corresponding Keyword Values will
be copied to the document.
Note: When copying a value from an AutoFill Keyword Set to a document, all special keyword
settings, such as Keyword Must Exist and Keyword Must Be Unique, are respected; therefore, if
a value from an AutoFill record does not adhere to a special keyword setting, the keyword
value will not be copied to the document.
Note: This action is not supported when working with external AutoFill Keyword Sets.
Note: This action is not supported in the Classic Client, Desktop, or Java Client interfaces.
Note: This action is only available when licensed for the Medical Records Management or
Signature Deficiencies for Epic modules.
2012 Hyland Software, Inc.
517
Workflow OnBase 12
Note: This action is only available when licensed for HL7, Medical Records Management, or
Signature Deficiencies for Epic.
If you want to append the chksum parameter to the generated URL, select the Verify
Checksum check box. In order for this option to function properly, the EnablePopChecksum
setting must be set to true in the ChartPop web.config file.
Creates a HL7 message and queues it with the HL7 Auto-Sender which handles the delivery of
the message.
1. From the Destination drop-down select list, select the destination for the HL7 message.
Only export destinations configured to Queue out-going messages for HL7 Auto-Sender
are available.
2. From the Message drop-down select list, select the HL7 Message Template for the
message you want to send. If the Message Template contains fields whose default
values begin with $^ characters, these fields can be mapped to The Value of a Property,
a URL, or a Value.
3. To map a field, select the field and select the type of mapping you want to use.
If you select The Value of a Property, enter the name of the property.
If you select URL, select the appropriate Document Display URL. This option uses
DocPop or a medical Pop integration to display a URL to the document or associated
chart. These URLs are configured under Utils | Document Display URLs in the
Configuration module.
If you select Value, enter a value to map to the field
4. After selecting a type, click Map.
2012 Hyland Software, Inc.
518
OnBase 12 Workflow
5. Click Properties for additional options. The Properties dialog box is displayed.
Option Description
Document Handle The action appends the docid parameter with the document ID as
the value. For DocPop URLs, this parameter would retrieve the
document that triggered the message.
Keyword Value The action appends the specified Parameter Name with the value
of a Keyword Type from the document.
Parameter Name Enter the parameter name to append to the URL. For example, if
you are using ChartPop, you might use the acctnum parameter.
For available parameters, see the documentation for the
respective Pop integration.
Keyword Type Select the Keyword Type whose value should be used for the
specified parameter.
If the document does not have an instance of the specified
Keyword Type, the parameter appended without a value.
If the document contains multiple instances of the specified
Keyword Type, then the first value is used.
2012 Hyland Software, Inc.
519
Workflow OnBase 12
7. Select Include Text Transcription to include text transcription data in the OBX.5 field.
The OBX.5 field in the HL7 message template must have a default value of $^TXDATA.
Configuration Module Actions Descriptions
Caution: Do not enable this option if you want Workflow to send HL7 messages for image
documents. The Include Text Transcription option is supported only for text documents. If this
option is enabled, it will stop Workflow from sending an HL7 message if the documents format is
not Text Report Format. For documents with both image and text renditions, the latest text
rendition is sent.
Note: The Include Text Transcription option is not supported in the Classic Client interface.
8. Click OK.
9. When finished, click Apply.
1. Select Utils | Document Display URLs. The Document Display URLs dialog box is
displayed.
2012 Hyland Software, Inc.
520
OnBase 12 Workflow
2. Enter a name and click Create. The Document Display URL Options dialog box is
displayed.
Note: This action is not supported in the OnBase Mobile Access for BlackBerry or Mobile
Access for Windows Phone interfaces.
Displays a customizable message box. This action allows you to enter a message to display in
the User Interaction screen. Enter the text to display in the Action Fields box under the Action
Type drop-down list.
The buttons along the side of the screen allow you to pull system information relative to the
document into the message box. Click the button to enter the information in the text.
Space-Space Adds a space, a hyphen, and another space to separate the different symbols ( - )
Doc Date Adds the document date of the current document (%D)
User Adds the user logged into the Client processing the action.(%U)
Time Stored Adds the time the current document was stored into OnBase (%I1)
Date Stored Adds the date the current document was stored into OnBase (%D1)
2012 Hyland Software, Inc.
521
Workflow OnBase 12
Keyword Adds the value of the Keyword Type and Keyword Number (%K) of the selected
Keyword Type in the Keyword Type drop-down select list. Enter the number of
times the Keyword Value will repeat in the message in the Repeat field. This
number is based on the number of Keyword Type instances on documents.
Additional Symbols
The following symbols can be used:
Symbol Description
Note: This symbol is only applicable when used with an Institutional Database.
%C Displays the name of the user who created the current document.
%D1 Displays the date that the document was stored. This value cannot be changed.
%I1 or %T Displays the time that the document was stored. This value cannot be changed.
%K###.n Displays the Keyword Value of Keyword Type ### n times. For example, %K101.4
would display up to 4 unique Keyword Values for Keyword Type 101 for a single
document.
For some functionality, a Keyword Type drop-down list may be available to
configure this. Select a Keyword Type from the drop-down select list, enter the
number of times you want the Keyword Value to be displayed in the Repeat field,
and click Keyword. The value in the Repeat field specifies how many instances of
the Keyword Value will be displayed. Entering an * character will pull all existing
Keyword Values for display up to 99 instances.
Note: When using the Classic Client interface, double digits in the Repeat field are
not supported.
%M Extracts metadata values from items. This includes attribute values from Workview
objects or a field values from an Entity item.
%M must be followed by the metadata value you want to extract. For example, if
you want to extract the value of a WorkView attribute called Name, it would be
%MName.
The token strings can contain nested expressions. Example, a nested WorkView
attribute: %MVendor.Buyer.Name.
2012 Hyland Software, Inc.
522
OnBase 12 Workflow
Symbol Description
%R Displays the real user name (if configured) of the user who created the current
document. If a real user name is not configured, a blank space will be displayed.
%U Displays the user name of the currently logged in user who executed the task.
%V### Displays the value of a configured Workflow property. For example, to display the
value for the property Color, this symbol would be configured %VColor.
Note: If a property name has spaces, using %V to display the property value alone
will not preserve the spaces, and therefore, the property will not be correctly
identified. When %V is used with a property name containing space in conjunction
with a formatting code, the property will be identified. %C(VProperty Name) would
be an example of property with spaces that will be identified correctly with the first
letter capitalized. This formatting option are available for the following actions:
Prompt User with Question Box/SYS - Prompt User with Question Box, Create Note/
Doc - Create Note on This Document/Related Document, Display Message Box/
Notify - Display Message Box, and Custom Log Entry/SYS - Custom Log Entry.
The following symbols are not supported in the Classic Client interface:
%L [life cycle ID]
%L2 [life cycle name]
%Q [queue ID]
%Q2 [queue name]
%M [item metadata value] is not supported in the Classic OnBase Client interface or the
Core-Based OnBase Client interface.
Note: Only notifications that are specific to the life cycle for which the action is being
configured and notifications that are not assigned to a specific life cycle are available for
selection.
2012 Hyland Software, Inc.
523
Workflow OnBase 12
down select list. Only notifications assigned to the life cycle in which the action is being
configured are available.
Priority
This gives you the ability to designate a priority of Low, Normal or High to your notification
when sending it through Microsoft Outlook.
Sender Address
Selecting the Use the distribution services default address option uses the e-mail address
specified in the Distribution Service configuration for the From: field value on the e-mail
notification.
Selecting the Use the users email address option uses the e-mail address specified in user
configuration in OnBase for the logged in user for the From: field value on the e-mail
notification.
Selecting the Use the following address: option allows you to specify an e-mail address for the
sender of the notification. The value specified is used s the display name in the From: field on
the e-mail notification.
Note: If you are using any Core-based interface, the Hyland Distribution Service is required
for sending notifications in Workflow. If you are using the Classic Client interface, the Hyland
Distribution Service is required to support any of the Sender Address options.
Caution: If you are using IDSMail to send multiple messages at once and one of the messages is
sent to an invalid address, all messages will be ignored and not sent. If you are using MAPI
(dmmailservice.dll) to send multiple messages at once and one of the messages is sent to an
invalid address, only the message sent to an invalid address will not be sent. All other messages
will be sent.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
If the Include current document option is selected, the current document active in the life cycle
will be attached to the notification in addition to the documents within the selected folder.
Notification
2012 Hyland Software, Inc.
524
OnBase 12 Workflow
After a notification has been added and configured, you can select it from the Notification
drop-down select list.
Note: If you are using any Core-based interface, the Hyland Distribution Service is required
for sending notifications in Workflow. If you are using the Classic Client interface, the Hyland
Distribution Service is required to support any of the Sender Address options.
Caution: If you are using IDSMail to send multiple messages at once and one of the messages is
sent to an invalid address, all messages will be ignored and not sent. If you are using MAPI
(dmmailservice.dll) to send multiple messages at once and one of the messages is sent to an
invalid address, only the message sent to an invalid address will not be sent. All other messages
will be sent.
If you want to send a notification even when no documents are attached, select the Send Even
If No Documents Attached option.
2012 Hyland Software, Inc.
525
Workflow OnBase 12
attachment. Related documents are defined by specifying a Document Type with Keyword
Types, Folder Type, or by selecting Document Handle. Any overlays or notes present on the
document will be included in the attachment.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
2012 Hyland Software, Inc.
526
OnBase 12 Workflow
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
Associated Primary Document (Applicable to Work Folder documents only)
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
2012 Hyland Software, Inc.
527
Workflow OnBase 12
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
Notification
After a notification has been added and configured, you can select it from the Notification
drop-down select list.
Note: Only notifications that are specific to the life cycle for which the action is being
configured and notifications that are not assigned to a specific life cycle are available for
selection.
2012 Hyland Software, Inc.
528
OnBase 12 Workflow
Selecting the Use the users email address option uses the e-mail address specified in user
configuration in OnBase for the logged in user for the From: field value on the e-mail
Note: If you are using any Core-based interface, the Hyland Distribution Service is required
for sending notifications in Workflow. If you are using the Classic Client interface, the Hyland
Distribution Service is required to support any of the Sender Address options.
Caution: If you are using IDSMail to send multiple messages at once and one of the messages is
sent to an invalid address, all messages will be ignored and not sent. If you are using MAPI
(dmmailservice.dll) to send multiple messages at once and one of the messages is sent to an
invalid address, only the message sent to an invalid address will not be sent. All other messages
will be sent.
If you want to send a notification even when no documents are attached, select the Send Even
If No Documents Attached option.
Note: Only notifications that are specific to the life cycle for which the action is being
configured and notifications that are not assigned to a specific life cycle are available for
selection.
2012 Hyland Software, Inc.
529
Workflow OnBase 12
Selecting the Use the distribution services default address option uses the e-mail address
specified in the Distribution Service configuration for the From: field value on the e-mail
Configuration Module Actions Descriptions
notification.
Selecting the Use the users email address option uses the e-mail address specified in user
configuration in OnBase for the logged in user for the From: field value on the e-mail
notification.
Selecting the Use the following address: option allows you to specify an e-mail address for the
sender of the notification. The value specified is used s the display name in the From: field on
the e-mail notification.
Note: If you are using any Core-based interface, the Hyland Distribution Service is required
for sending notifications in Workflow. If you are using the Classic Client interface, the Hyland
Distribution Service is required to support any of the Sender Address options.
Caution: If you are using IDSMail to send multiple messages at once and one of the messages is
sent to an invalid address, all messages will be ignored and not sent. If you are using MAPI
(dmmailservice.dll) to send multiple messages at once and one of the messages is sent to an
invalid address, only the message sent to an invalid address will not be sent. All other messages
will be sent.
Copies the value of the configured E-Form Field Name to the designated Property Name
configured.
2012 Hyland Software, Inc.
530
OnBase 12 Workflow
Updates the configured E-Form Field Name with the value of the specified Property Name. This
action is supported only for fields that are not linked to Keyword Types. This field should be a
Note: Check boxes and radio button values are currently not supported for copying.
Note: This action cannot set an XML node equal to a collection property.
In order for XPath queries containing references to namespaces to be properly evaluated, the
following criteria must be met:
The document must be imported via the Document Connector.
The document must be associated with a valid XML Format.
All namespaces referenced in the XPath Query must be defined in the associated
XML Format.
Note: This action is supported only in the Unity and Web Client interfaces.
This action will copy a property value to a Unity Form field or it will copy a value from a Unity
Form field to a property.
Property Name
Enter the name of the property that you would like to copy a value from or to.
Unity Form Field Name
2012 Hyland Software, Inc.
531
Workflow OnBase 12
From the Unity Form Field Name drop-down select list, select the field that you would like to
copy to or from. Each field that exists on Unity forms within the OnBase system is listed. If
Configuration Module Actions Descriptions
more than one form contains the same field name and those forms are used within the same
life cycle, the field defined will be used regardless of what form it exists on.
Copy to Unity Form Field
Select this option if you want to copy a property value to a Unity Form field.
Note: If a value does not meet formatting requirements for a field, the value will not be copied
and if a value already existed, the existing value will be retained on the form.
Note: This action cannot be used to copy the value of a property to a calculated field in a Unity
Form.
Enter the XPATH at which the node is located in the XPATH field. The XPATH is where the XML
node is located. This opens the text of the XML document, looks for the node, and copies the
value associated with the node to the specified property.
For this to execute successfully, the document must be an XML document, a rendition of an
XML document or an XDP document.
When accessing complex or mixed nodes, the value of the node and its descendents will be
flattened into a single string value.
Note:This action can retrieve collections of nodes only if Set property to all nodes is set. If Set
property to all nodes is set, this action can retrieve the first value of a collection.
Note:When this action references complex or mixed nodes, it will return a single concatenated
string.
In order for XPath queries containing references to namespaces to be properly evaluated, the
following criteria must be met:
The document must be imported via the Document Connector.
The document must be associated with a valid XML Format.
All namespaces referenced in the XPath Query must be defined in the associated
XML Format.
2012 Hyland Software, Inc.
532
OnBase 12 Workflow
Note:The maximum value for the Increment and Decrement fields is 9 digits (999999999).
2012 Hyland Software, Inc.
533
Workflow OnBase 12
If the property value contains an array of values, all of those values are added to the
document. If a property contains an array of values and the action is configured to replace
Configuration Module Actions Descriptions
existing values, only the first value in the array will be used to set the keyword value. For
example, if the property being used by the action contains the array of values "Property #1"
and "Property #2", the "Property#1" value will be used to replace existing keyword values.
Note: The value of a property does not support properties containing array values.
2012 Hyland Software, Inc.
534
OnBase 12 Workflow
If you select Related Document Keyword/Property the Configure button is enabled. In addition,
if a document has multiple related documents with one or more values on each document, the
Note: The properties of Entry to Queue Date, Assigned User, and Batch Number are not available
for related documents.
Note: The >>Assigned To, >>Batch Number, >>Document Date, >>Document Handle,
>>Document Type, >>Entry to Queue Date, >>Last Revision, and >>Last Version options are
functional only in the Core-based interfaces.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
2012 Hyland Software, Inc.
535
Workflow OnBase 12
After you select the related Document Type, click Common Keywords. The Related Document
Types dialog box opens. To add Keyword Types to the list, select the Keyword Type in the list
Configuration Module Actions Descriptions
and click Add. To remove a Keyword Type from the list, select the keyword and click Remove.
The Document Types with these Keyword Types are evaluated when this action executes.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
2012 Hyland Software, Inc.
536
OnBase 12 Workflow
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
2012 Hyland Software, Inc.
537
Workflow OnBase 12
Select the Set property to all keyword value instances option to set the property to an array of
values for documents containing multiple values for a Keyword Type or system property. If the
Configuration Module Actions Descriptions
check box is not selected and there are no Keyword Type or system property values for the
document then the property is deleted. If the document has multiple Keyword Types or
system property values then the property is set to the first Keyword Value.
In the case that Assigned User is selected for a document that is assigned to multiple users,
and Set Property to all Keyword Instances is selected, all user names will be set for the
property value. This includes user group and role for each user. If Set Property to all Keyword
Instances is not selected, only the first user name (with user group and role) will be set.
If the property specified in the Property Name field does not already exist, it will be created.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
2012 Hyland Software, Inc.
538
OnBase 12 Workflow
After you select the related Document Type, click Common Keywords. The Related Document
Types dialog box opens. To add Keyword Types to the list, select the Keyword Type in the list
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
2012 Hyland Software, Inc.
539
Workflow OnBase 12
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
2012 Hyland Software, Inc.
540
OnBase 12 Workflow
Note: If you do not use the Document Handle option and do not specify any common keywords,
Triggers the creation of a new SharePoint site from a document in Workflow, by using a set of
System Keyword Types associated with a Document Type.
The first time you configure this action, OnBase automatically creates the following
Alphanumeric Keyword Types:
SPS Member Role 250 Yes The role name of the SharePoint members
Name group, if SPS Use Unique Permissions is set
to Yes.
Examples of role names are Read, Full
Control, Contribute, and Design. See your
SharePoint administrator to help determine
the security of SharePoint groups.
SPS Members Group 250 Yes The name of the SharePoint members group, if
SPS Use Unique Permissions is set to Yes.
SPS Owner Role Name 250 Yes The role name of the SharePoint owners
group, if SPS Use Unique Permissions is set
to Yes.
Examples of role names are Read, Full
Control, Contribute, and Design. See your
SharePoint administrator to help determine
the security of SharePoint groups.
SPS Owners Group 250 Yes The name of the SharePoint owners group, if
SPS Use Unique Permissions is set to Yes.
SPS Site Description 250 Yes The description of the SharePoint site.
2012 Hyland Software, Inc.
541
Workflow OnBase 12
SPS Site Title 250 Yes The title of the SharePoint site.
SPS Site URL 250 Yes The URL of the existing SharePoint site. This
can be a top-level site, such as
http://vm-moss:8080, or a lower-level site,
such as http://vm-moss:8080/Accounting.
SPS Subsite URL 250 Yes The component added to the SPS Site URL to
create the URL for the new subsite.
For example, if the SPS Site URL value is
http://vm-moss:8080, and the SPS Subsite
URL is Sub1, then the new sites URL will be
http://vm-moss:8080/Sub1.
SPS Visitor Role Name 250 Yes The role name of the SharePoint visitors
group, if SPS Use Unique Permissions is set
to Yes.
Examples of role names are Read, Full
Control, Contribute, and Design. See your
SharePoint administrator to help determine
the security of SharePoint groups.
SPS Visitors Group 250 Yes The name of the SharePoint visitors group, if
SPS Use Unique Permissions is set to Yes.
2012 Hyland Software, Inc.
542
OnBase 12 Workflow
Caution: If there is already a Keyword Type by the same name as one of those listed above, then
Field Description
Administrator Name Type the name of the SharePoint administrator who has privileges
for creating SharePoint sites.
Administrator User Name Type the SharePoint administrator's Windows user name.
Assigns a related document to a user within a rule-based load balancing queue. The queue
must be configured for rules-based load balancing for this action to execute successfully.
If this action is configured in a life cycle that is associated with a org chart, the following
assignment types are available: Assistant of Logged In User, Assistant of User Specified in
Keyword Value, Assistant of User Specified in Property, Manager of Logged In User, Manager
of User Specified in Keyword Value, and Manager of User Specified in Property. When one of
these assignment types is selected, the action will only execute successfully when the queue
is configured to load balance by Users.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
2012 Hyland Software, Inc.
543
Workflow OnBase 12
Document Type
Select a Document Type from the Related Document Type drop-down list.
Configuration Module Actions Descriptions
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
2012 Hyland Software, Inc.
544
OnBase 12 Workflow
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
2012 Hyland Software, Inc.
545
Workflow OnBase 12
The Assign in Life Cycle drop-down select list allows you to select the life cycle from which you
want to select a load balancing queue. The contents of the Load Balancing Queue drop-down
Configuration Module Actions Descriptions
The Load Balancing Queue drop-down select list contains the rule based load balancing queues
that you want to use for the user assignment.
The Assignment Type drop-down select list allows you to select the type of assignment you
want to perform. The assignment type options are Assistant of Logged in User, Assistant of User
Specified in Keyword Value, Assistant of User Specified in Property, Current User, Default User, Get
User Name, Group or Role from Keyword, Get User Name, Group or Role from Property, In Order,
Manager of Logged in User, Manager of User Specified in Keyword Value, Manager of User Specified
in Property, Prompt for User, Group or Role, Selected User, Group or Role, and Shortest Queue.
Note: When using any of the following assignment types, when multiple values exist, all
values are used for document assignment: Assistant of User Specified in Keyword Value; Get
User Name, Group or Role from Keyword; and Manager of User Specified in Keyword Value.
The Assistant of Logged In User option specifies that documents should be assigned to all of
the assistants of the currently logged in user as defined by the Organization Chart. If the
currently logged in user does not have any assistants, the action will not be successful with
this setting.
The Assistant of User Specified in Keyword Value option allows you to specify a Keyword Type
from which to take the user to which the Assistant belongs. Select the appropriate Keyword
Type that you want to take the value from to determine the user from the Get User Name from
Keyword drop-down select list.
The Assistant of User Specified in Property option allows you to specify a property from which to
take the user to which the Assistant belongs. Enter the appropriate property name that you
want to take the value from to determine the user from the Get User name from Property field.
Optionally, you can specify a Required Role.
Note: In order for documents to be assigned to the Assistant of Logged In User, the Assistant
must be configured as a member of the queue. If this is configured and Assistants are not
members of the queue, documents will be put into the <Unassigned> category. In order for
documents to be assigned to the Assistant of User Specified in Keyword Value or Assistant of
User Specified in Property, both the Assistant and the user specified in the Keyword value or
Property must be configured as a member of the queue. If this is configured and Assistants
and users are not members of the queue, documents will be put into the <Unassigned>
category.
The Current User option specifies that the documents should be assigned to the user currently
logged in and executing the task, assuming that the user has been assigned as a member of
the load balancing queue.
Note: If using this option in conjunction with a load-balanced queue, the option is only
available when the load-balanced queue has users as members.
The Default User option allows you to assign the document to the user specified as the Default
Recipient during membership configuration.
2012 Hyland Software, Inc.
546
OnBase 12 Workflow
The In Order option will distribute documents in the order the user groups are listed in the
load balancing queue.
Note: In order for documents to be assigned to the Manager of Logged In User, Manager of User
Specified in Keyword Value or Manager of User Specified in Property, the Manager must be
configured as a member of the queue. If this is configured and Managers are not members of
the queue, documents will be put into the <Unassigned> category.
The Prompt for User option will prompt the user to select the appropriate user group to assign
to documents. The user groups listed in the prompt are the user groups selected as members
of the load balancing queue.
Note: The Prompt for User option is not supported in the OnBase Mobile Access for BlackBerry
or Mobile Access for Windows Phone interfaces.
The Selected User option assigns the documents to the user selected in the Assigned User,
Group or Role drop-down select list.
The Shortest Queue option assigns documents to the user group that has the fewest number
of documents assigned to it.
Caution: When using the Assistant or Manager Assignment Type, never place these actions under
system work, timer work, load balancing work, or any other automatic function. If these types of
actions are placed into automation mode, the user logged in may not be the user that you would
want documents assignments based on.
2012 Hyland Software, Inc.
547
Workflow OnBase 12
The Assigned User, Group or Role drop-down select list is only enabled for the Selected User,
Group or Role assignment type. When Get User Name, Group or Role from Keyword is select a
Configuration Module Actions Descriptions
Get User Name, Group or Role from Keyword field is displayed. Select the appropriate Keyword
Type from which to acquire the value. When Get User Name, Group or Role from Property is
selected, a Get User Name, Group or Role from Property field is displayed. Enter the name of the
property from which you want to acquire the value.
Note: The Assigned User, Group or Role drop-down select list is populated based on the user
group(s) assigned to load balancing queue selected in the Load Balancing Queue drop down
select list.
Assigns a document to a user within a rule-based load balancing queue. The queue must be
configured for rules-based load balancing for this action to execute successfully.
If this action is configured in a life cycle that is associated with a org chart, the following
assignment types are available: Assistant of Logged In User, Assistant of User Specified in
Keyword Value, Assistant of User Specified in Property, Manager of Logged In User, Manager
of User Specified in Keyword Value, and Manager of User Specified in Property. When one of
these assignment types is selected, the action will only execute successfully when the queue
is configured to load balance by Users.
The Assign in Life Cycle drop-down select list allows you to select the life cycle from which you
want to select a load balancing queue. The contents of the Load Balancing Queue drop-down
select list is determined by the Assign in Life Cycle selection.
The Load Balancing Queue drop-down select list contains the rule based load balancing queues
that you want to use for the user assignment.
Select <<This Queue>> from the Load Balancing Queue drop-down select list to configure the
action for the specific queue that the document is in. Selecting <<This Queue>> allows this
action to easily be copied for other queues within the configured life cycle, as the action will
always apply to the queue that the document is in. When <<This Queue>> is selected, the
active life cycle must also be selected. If <ALL> is selected in the Assign in Life Cycle drop-
down select list, the active life cycle will automatically be selected for the action when the
Apply button is selected.
2012 Hyland Software, Inc.
548
OnBase 12 Workflow
The Assignment Type drop-down select list allows you to select the type of assignment you
want to perform. The assignment type options are Assistant of Logged in User, Assistant of User
Note: When using any of the following assignment types, when multiple values exist, all
values are used for document assignment: Assistant of User Specified in Keyword Value; Get
User Name, Group or Role from Keyword; and Manager of User Specified in Keyword Value.
The Assistant of Logged In User option specifies that documents should be assigned to all of
the assistants of the currently logged in user as defined by the Organization Chart. If the
currently logged in user does not have any assistants, the action will not be successful with
this setting.
The Assistant of User Specified in Keyword Value option allows you to specify a Keyword Type
from which to take the user to which the Assistant belongs. Select the appropriate Keyword
Type that you want to take the value from to determine the user from the Get User Name from
Keyword drop-down select list.
The Assistant of User Specified in Property option allows you to specify a property from which to
take the user to which the Assistant belongs. Enter the appropriate property name that you
want to take the value from to determine the user from the Get User name from Property field.
Optionally, you can specify a Required Role.
Note: In order for documents to be assigned to the Assistant of Logged In User, the Assistant
must be configured as a member of the queue. If this is configured and Assistants are not
members of the queue, documents will be put into the <Unassigned> category. In order for
documents to be assigned to the Assistant of User Specified in Keyword Value or Assistant of
User Specified in Property, both the Assistant and the user specified in the Keyword value or
Property must be configured as a member of the queue. If this is configured and Assistants
and users are not members of the queue, documents will be put into the <Unassigned>
category.
The Current User option specifies that the documents should be assigned to the user currently
logged in and executing the task, assuming that the user has been assigned as a member of
the load balancing queue.
Note: If using this option in conjunction with a load-balanced queue, the option is only
available when the load-balanced queue has users as members.
The Default User option allows you to assign the document to the user specified as the Default
Recipient during membership configuration.
The In Order option will distribute documents in the order the user groups are listed in the
load balancing queue.
2012 Hyland Software, Inc.
549
Workflow OnBase 12
The Manager of Logged In User option specifies that the document should be assigned to the
manager of the currently logged in user, as specified in the Organizational Chart. Optionally,
Configuration Module Actions Descriptions
you can specify a Required Role. When a Required Role is specified, it requires that the
manager that the document is assigned to has the specified role in the Organization Chart. If
the immediate manager is not assigned the selected role, Workflow will move up a managerial
tier until it finds a manager with the specified role. If a manager cannot be found with the
selected role, the document will be assigned the <Unassigned> status.
The Manager of User Specified in Keyword Value option allows you to specify a Keyword Type
from which to take the user to which the Manager belongs. Select the appropriate Keyword
Type that you want to take the value from to determine the user from the Get User Name from
Keyword drop-down select list. Optionally, you can specify a Required Role. When a Required
Role is specified, it requires that the manager that the document is assigned to is assigned to
the specified role in the Organization Chart. If the immediate manager is not assigned to the
selected role, Workflow will move up a managerial tier until it finds a manager with the
specified role. If a manager cannot be found with the selected role, the document will be
assigned the <Unassigned> status.
The Manager of User Specified in Property option allows you to specify a property from which to
take the user to which the Manager belongs. Enter the appropriate property name that you
want to take the value from to determine the user from the Get User name from Property field.
Optionally, you can specify a Required Role. When a Required Role is specified, it requires that
the manager that the document is assigned to is assigned to the specified role in the
Organization Chart. If the immediate manager is not assigned to the selected role, Workflow
will move up a managerial tier until it finds a manager with the specified role. If a manager
cannot be found with the selected role, the document will be assigned the <Unassigned>
status.
Note: In order for documents to be assigned to the Manager of Logged In User, Manager of User
Specified in Keyword Value or Manager of User Specified in Property, the Manager must be
configured as a member of the queue. If this is configured and Managers are not members of
the queue, documents will be put into the <Unassigned> category.
The Prompt for User option will prompt the user to select the appropriate user group to assign
to documents. The user groups listed in the prompt are the user groups selected as members
of the load balancing queue.
Note: The Prompt for User option is not supported in the OnBase Mobile Access for BlackBerry
or Mobile Access for Windows Phone interfaces.
The Selected User option assigns the documents to the user selected in the Assigned User,
Group or Role drop-down select list.
The Shortest Queue option assigns documents to the user group that has the fewest number
of documents assigned to it.
Caution: When using the Assistant or Manager Assignment Type, never place these actions under
system work, timer work, load balancing work, or any other automatic function. If these types of
actions are placed into automation mode, the user logged in may not be the user that you would
want documents assignments based on.
2012 Hyland Software, Inc.
550
OnBase 12 Workflow
The Assigned User, Group or Role drop-down select list is only enabled for the Selected User,
Group or Role assignment type. When Get User Name, Group or Role from Keyword is select a
Note: The Assigned User, Group or Role drop-down select list is populated based on the user
group(s) assigned to load balancing queue selected in the Load Balancing Queue drop down
select list.
Note: When the selected queue is <<This Queue>>, the available assignment types are
restricted to those that could apply to any queue in the life cycle, regardless of membership.
Used when you have created batches with the SYS - Create Batch action. When executed, this
action halts batch processing. If you do not select the Break All Processing box, any other non-
batch processing continues.
Note: When the action is configured outside of System Work, none of the settings will impact
the execution of System Work.
2012 Hyland Software, Inc.
551
Workflow OnBase 12
In this example, the Break action is set to break current task list. When the task list breaks at
the highlighted action, the tasks under the current actions parent task list that have not been
executed yet are not executed. Additionally, any actions that have not be executed under the
current actions grandparent task list are not executed. The remaining actions under the great
grandparent task are executed, however. The following graphic illustrates what is executed.
The pink actions are not executed. The green action is executed.
2012 Hyland Software, Inc.
552
OnBase 12 Workflow
When processing a related document using an ad hoc task or system work, the option breaks
all processing for the current related document and the current top-level document.
Break All Processing option Break All Processing for Current Document
selected
The call web service action allows a user to call a method exposed via a web service. The
action provides a wrapper around the .NET framework classes that handle calling methods in
web services.
Features of this Action
Supports complex data types including arrays of nested complex data types.
Retrieves the information about complex types from the WSDL.
Supports SOAP headers as inputs, outputs or by reference (input and output).
Retrieves the information about SOAP headers from the WSDL.
Allows the user to decide whether the task list execution should be broken if there
was an issue calling the web service.
Supports multiple protocols: HTTP GET, HTTP POST, SOAP 1.1 and SOAP 1.2.
Supports mapping to system keywords.
Supports the following.NET primitive data types: System.Boolean, System.Byte,
System.Char, System.Decimal, System.Double, System.Int16, System.Int32,
System.Int64, System.SByte, System.Single, System.String. System.UInt16,
System.UInt32, System.UInt32
Has limited support for the System.Xml.XmlAttribute data type.
Supports mapping to constant values containing tokens.
2012 Hyland Software, Inc.
553
Workflow OnBase 12
1. You can either select a configured WSDL location from the drop-down select list or,
with >> Use the specified WSDL Location selected in the drop-down select list, enter the
location of the WSDL file used by the Web Service in the field. The location value
cannot exceed 255 characters.
Note: Workflow Studio supports case-sensitivity when configuring a WSDL web service path.
This functionality is not respected in the Configuration module. Any web service that requires
case-sensitivity must be configured within Workflow Studio.
2. Click Retrieve.
3. If you do not want to store the WSDL within the action configuration, but want to
retrieve the WSDL the first time the action is executed, select the Retrieve the WSDL at
execution time option.
4. Select the Protocol from the drop-down select list.
5. Select a method using the Method drop-down select list.
6. Click Mappings. The Mappings dialog box is displayed.
2012 Hyland Software, Inc.
554
OnBase 12 Workflow
2012 Hyland Software, Inc.
555
Workflow OnBase 12
7. Select a parameter. The Keyword, Property, and Constant Value mapping properties are
enabled. Keyword maps to the Keyword Type selected from the drop-down select list.
Configuration Module Actions Descriptions
Property maps to the property specified in the field. Constant Value maps to the value
entered in the field.
Symbol Description
Note: This symbol is only applicable when used with an Institutional Database.
2012 Hyland Software, Inc.
556
OnBase 12 Workflow
Symbol Description
%D1 Displays the date that the document was stored. This value cannot be changed.
%I1 or %T Displays the time that the document was stored. This value cannot be changed.
%K###.n Displays the Keyword Value of Keyword Type ### n times. For example, %K101.4
would display up to 4 unique Keyword Values for Keyword Type 101 for a single
document.
For some functionality, a Keyword Type drop-down list may be available to
configure this. Select a Keyword Type from the drop-down select list, enter the
number of times you want the Keyword Value to be displayed in the Repeat field,
and click Keyword. The value in the Repeat field specifies how many instances of
the Keyword Value will be displayed. Entering an * character will pull all existing
Keyword Values for display up to 99 instances.
Note: When using the Classic Client interface, double digits in the Repeat field are
not supported.
%M Extracts metadata values from items. This includes attribute values from Workview
objects or a field values from an Entity item.
%M must be followed by the metadata value you want to extract. For example, if
you want to extract the value of a WorkView attribute called Name, it would be
%MName.
The token strings can contain nested expressions. Example, a nested WorkView
attribute: %MVendor.Buyer.Name.
%R Displays the real user name (if configured) of the user who created the current
document. If a real user name is not configured, a blank space will be displayed.
%U Displays the user name of the currently logged in user who executed the task.
2012 Hyland Software, Inc.
557
Workflow OnBase 12
Symbol Description
Configuration Module Actions Descriptions
%V### Displays the value of a configured Workflow property. For example, to display the
value for the property Color, this symbol would be configured %VColor.
Note: If a property name has spaces, using %V to display the property value alone
will not preserve the spaces, and therefore, the property will not be correctly
identified. When %V is used with a property name containing space in conjunction
with a formatting code, the property will be identified. %C(VProperty Name) would
be an example of property with spaces that will be identified correctly with the first
letter capitalized. This formatting option are available for the following actions:
Prompt User with Question Box/SYS - Prompt User with Question Box, Create Note/
Doc - Create Note on This Document/Related Document, Display Message Box/
Notify - Display Message Box, and Custom Log Entry/SYS - Custom Log Entry.
The following symbols are not supported in the Classic Client interface:
%L [life cycle ID]
%L2 [life cycle name]
%Q [queue ID]
%Q2 [queue name]
%M [item metadata value] is not supported in the Classic OnBase Client interface or the
Core-Based OnBase Client interface.
The value is an array (separated by commas) - This is only useful for items that are
arrays. It allows the user to specify a list of values (separated by commas) to
send.
9. Click Map.
10. Click OK.
11. Repeat steps 5 through 10 for each method and parameter.
12. Click Apply.
Options
When you click the Options button, you can access many addition options for the action.
General
When the Break processing on failure option is selected, if there is an issue calling the web
service, the action will stop executing the task list.
If this option is not selected, then the action will set the last execution result to S_FALSE and
continue executing the task list.
The Request timeout [ ] seconds option allows for a time out duration to be set. If the response
from the web service has not been returned in the configured amount of time, the action will
time out. Enter the number of seconds you want to wait before the request times out. Tasks
following this action will either abort or continue, based on whether the option to Break
Processing on failure option has been selected.
Proxy
2012 Hyland Software, Inc.
558
OnBase 12 Workflow
To use a proxy, select the Use the following proxy server option and enter the proxy server.
You can also select Use the following credentials to use the User Name, Password, and Domain
Note: When retrieving the WSDL this information is only used if the WSDL is coming from a
URL. If the WSDL is a local file, this information is not used.
Advanced
The Advanced tab allows you to override the port binding address that is contained in the
WSDL. Select the Use the following end point URL instead of the one in the WSDL option and
specify the location in the field.
The following is an example of WSDL:
<wsdl:definitions>
<wsdl:service name="Service1"> <wsdl:port name="Service1Soap"
binding="tns:Service1Soap">
<soap:address location="http://server/virtualdir/Service1.asmx" />
</wsdl:port>
</wsdl:service>
</wsdl:definitions>
Enabling HTTP Get / Post protocols
In .NET the HTTP Get and HTTP Post protocols are disabled by default (See http://
support.microsoft.com/default.aspx?scid=kb;en-us;819267). When the action retrieves the
WSDL it excludes the protocols that are not enabled on the application server (HTTP Get) as
well as the protocols not enabled in the web service.
To allow the action to call a web service via HTTP Get or Post you need to modify the
web.config file of the Application Server and the web service you are calling to include the
following settings:
<configuration>
<system.web>
<webServices>
<protocols>
<add name="HttpPost" />
<add name="HttpGet" />
</protocols>
</webServices>
</system.web>
</configuration>
2012 Hyland Software, Inc.
559
Workflow OnBase 12
If you are executing a timer using the Workflow Timer Service and HTTP Post / Get is
executed from this service, you must also place the following setting in the
Configuration Module Actions Descriptions
Hyland.Core.Workflow.NTService.exe.config file:
<system.web>
<webServices>
<protocols>
<add name="HttpPost" />
<add name="HttpGet" />
</protocols>
</webServices>
</system.web>
Testing the Web Service Call
You can test the displayed method by clicking Test. The Test Web Service Call dialog box is
displayed.
2012 Hyland Software, Inc.
560
OnBase 12 Workflow
To test a method:
Caution: Before using features enabled by the -ROMANZO switch, ensure that you understand the
feature and implications of any changes to your system. Contact your service provider with any
questions regarding these features. Features enabled by the -ROMANZO switch should not be
made available to the casual user. Remove the -ROMANZO switch after completing necessary
actions.
WSDL Tab
2012 Hyland Software, Inc.
561
Workflow OnBase 12
The WSDL tab is available when you click the Options button.
Configuration Module Actions Descriptions
This tab displays the WSDL information that was used to configure the action.
Invoke method in a separate application Domain Setting
In the Test Web Service Call dialog box, the Invoke method in a separate application domain
check box is available when the -ROMANZO switch is applied. This check box controls whether
the type built from the WSDL is loaded into a separate application domain or into the same
application domain the application server is using when testing the method call.
1. Enter the location of the WSDL file used by the Web Service in the WSDL Location field.
The location value cannot exceed 255 characters.
2. Click Retrieve.
3. Select a method using the Method drop-down select list. Select an appropriate
parameter.
2012 Hyland Software, Inc.
562
OnBase 12 Workflow
4. For simple data types, either select Keyword Type and select the appropriate Keyword
Type from the drop-down select list, select The Value of a Property and enter an
Note: This action uses the Proxy Server settings found in the Local Area Network (LAN) Settings
dialog box in Internet Options within Internet Explorer.
The SOAP SDK maps a methods return value and arguments data types to a variant type. The
supported data types are:
VT_I2: short
VT_I4: long
VT_BSTR: string
VT_BOOL: bool
VT_R4: float
VT_R8: double
VT_I1: BYTE
VT_UI1: UBYTE
VT_UI2: USHORT
VT_UI4: UINT32
VT_UINT: UINT32
VT_INT: int32
VT_DECIMAL: int64
VT_DISPATCH (9) for complex data types (VT_EMPTY if the method does not return
a value.)
Note: Arrays are supported for every type listed except VT_DISPATCH.
The column to the right is the data type displayed in the configuration program. Any method
containing a data type not listed above is not displayed in the configuration program.
Mapping Complex Data Types
2012 Hyland Software, Inc.
563
Workflow OnBase 12
When a Method parameter is selected that is a complex data type, the mapping options are
disabled and you must select the appropriate parameter and click Modify to map the
Configuration Module Actions Descriptions
From this dialog box, parameters can be mapped by creating New Members or New Types.
Creating New Members
1. Right-click on the parameter and select Add Member, as appropriate. The New Member
dialog box is displayed.
2012 Hyland Software, Inc.
564
OnBase 12 Workflow
2. Enter a Name.
3. Enter a Namespace for the new member. A namespace may be provided by default.
Note: Authentication selections should match the authentication specified in the IIS settings.
1. Right-click on the parameter and select Add Type, as appropriate. The New Type dialog
box is displayed.
2. Enter a Name.
3. Click OK.
Headers
The Headers tab allows you to configure headers and additional namespaces. The action can
be configured to send zero or more headers, and allows the configuration of any of the
attributes defined by the SOAP protocol (as well as any user defined ones). To create a
header:
2012 Hyland Software, Inc.
565
Workflow OnBase 12
6. If a header is marked as Must Understand, then if the web service that is being called
does not know how to process the header, the web service will return an error.
7. Select the Value you want associated with the header.
8. Click the Attributes tab.
9. Enter the Name for the attribute.
10. Enter the Namespace.
11. Enter the Value.
12. Click Add.
13. When finished entering attributes, click OK.
Proxy
There are several proxy server settings to choose from:
No proxy server
Use proxy settings specified by the proxycfg utility
Use Microsoft Internet Explorer proxy settings for the current user.
Use the following proxy server
You can also select Use the following user name/password to use the User name and Password
you enter.
Advanced
The Advanced tab allows you to overwrite the file specified in the WSDL Location configured
for the action.
Additional Considerations
Only a Keyword Type can be specified for an output or input/output parameter.
Static Text or a Keyword Type can be specified for an input parameter.
If a Keyword Type is mapped to an output parameter, when that method is called, a
new keyword will be added to the document.
If a Keyword Type is mapped to an input/output parameter, then that method is
called the existing keywords value is updated when the method returns.
If a document contains multiple Keyword Values for a mapped Keyword Type, the
value of the first keyword will be used.
If a document does not contain a value for a Keyword Type that is mapped to a
parameter a default value will be used. For numeric types the value is 0, for string
types the value "" is used.
Note: This action does not support arrays of complex data types.
2012 Hyland Software, Inc.
566
OnBase 12 Workflow
Select the appropriate Document Composition Template from the drop-down select list. You can
choose to adhere to the configured settings of the template by selecting Use All Settings
Configured for Template.
You can override those settings 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 information about settings see the Configuring Templates Form Letters Creation section of
the Image Document Composition or Document Composition for Microsoft Word
documentation.
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.
2012 Hyland Software, Inc.
567
Workflow OnBase 12
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
Configuration Module Actions Descriptions
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.
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.
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.
Note: This action is supported only in the Core-based Client interface and the Web Client
interface in ActiveX and HTML Enhanced modes only. This action is only supported in the Unity
interface when it is not configured to require user interaction.
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 information about settings see the Configuring Templates Form Letters Creation section of
the Image Document Composition or Document Composition for Microsoft Word
documentation.
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:
2012 Hyland Software, Inc.
568
OnBase 12 Workflow
Takes individual documents and creates a summary document with a document type of SYS
Batch Tickets, which is then routed through OnBase. The individual documents composing the
batch are sent to a queue where they remain until action is taken to move or delete them. In
the Default Size box, enter the initial size of the batch in number of documents. The number in
the Maximum Size box represents the amount, in documents, by which the default value can
be overridden for special cases.
Select a queue from the After Document is Added to Batch, Transition it to drop-down list
specifying where the original documents should remain after the batch is created.
Note:This action is not supported for the Classic OnBase Client User Interface.
This action allows you to create a Collaboration Workspace based on a selected Collaboration
Template. Select the template that you want to base your Workspace on from the
Collaboration Template drop-down select list. Select the settings that you want to inherit from
the template in the Inherit Template Settings section.
Notification Options - Corresponds to the Options section of the Collaboration Template Settings
dialog box.
Users - Corresponds to the users assigned in the Collaboration Template Default Users dialog
box.
Document Rights - Corresponds to the Document Rights section of the Collaboration Rights
dialog box.
Workview Rights - Corresponds to the Workview Rights section of the Collaboration Rights
dialog box.
Thread Rights - Corresponds to the Thread Rights section of the Collaboration Rights dialog box.
Meeting Rights - Corresponds to the Meeting Rights section of the Collaboration Rights dialog
box when the database is configured for Synchronous Collaboration.
Administration Rights - Corresponds to the Workspace Rights section of the Collaboration Rights
dialog box.
2012 Hyland Software, Inc.
569
Workflow OnBase 12
You can also add the current document within Workflow to the Collaboration Workspace by
selecting the Add document to workspace option.
Configuration Module Actions Descriptions
Note: The Add document to workspace option is only supported for documents. This option is
not supported for non-document items such as Workview objects or Plan Review projects.
Note: An Agenda Management license is required to configure and use this action.
Note: This action is only supported in the Core-based Client and Unity Workflow interfaces.
This action allows you to use a document (typically an E-Form) to add, update, or clear
agenda items. Before configuring this action, ensure that you have completely configured all
necessary items in the Agenda Management client.
Tip: As a best practice, this action should only be used as a System Task when you are
creating a new Agenda Item and the Agenda Item Primary Key can be set to Constant Value of
0.
Note: Exporting this action requires a destination database that already contains a meeting
type or agenda item type.
2012 Hyland Software, Inc.
570
OnBase 12 Workflow
Agenda Item Primary Key - The unique numeric value assigned to the agenda item by
OnBase. This value is assigned when you create an agenda item, and used by
Note: Prompting users to create a new agenda item is not supported in the Unity Workflow
interface.
Tip: When mapping the Agenda Item Primary Key to a Constant Value, use 0 to create new
agenda items. You can also map the Agenda Item Primary Key to an E-Form Field Name. Doing
so keeps this value hidden on the E-Form that you are using to update agenda items.
Meeting Type - The name of the type of meeting the item is associated with.
Note: Ensure that any configured Agenda Item Fields are compatible with the selected Meeting
Type. Agenda Item Fields are configured and assigned to Meeting Types, as described in the
Agenda Management documentation.
Note: The Constant Value, E-Form Field Name, or Workflow Property cannot exceed 255
characters.
5.Click Update.
6.Repeat steps 4 and 5 for the remaining required Agenda Item Fields.
7.Select any optional Agenda Item Fields from the Agenda Item Field drop-down list and
configure them by performing step 4 and clicking Add. The Agenda Item Fields
available from this drop-down list correspond to the Agenda Item Field names that
were created via Agenda Management administration.
If the agenda item will be closed session, select Agenda Item Closed Session Flag.
Note: The Attachment Exclude From Packet Flag, Closed Session, Status, and Requestor
selections are reserved for future functionality.
8.When you have finished configuring Agenda Item Fields, click Close.
9.In the Property to Store Agenda Item Primary Key field, type Agenda Item Primary Key.
2012 Hyland Software, Inc.
571
Workflow OnBase 12
10.Configure the Related Documents settings outlined below. Related documents become
supporting documents for agenda items.
Configuration Module Actions Descriptions
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
2012 Hyland Software, Inc.
572
OnBase 12 Workflow
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
Associated Primary Document (Applicable to Work Folder documents only)
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
2012 Hyland Software, Inc.
573
Workflow OnBase 12
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
Configuration Module Actions Descriptions
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
11. From the Keyword Type to Set Related Document Order drop-down list, select the
Keyword Type being used to store the order of supporting documents attached to
agenda items. If a Keyword Type has not been assigned to related documents for the
purpose of storing the order of supporting documents attached to agenda items,
Keyword Type to Set Related Document Order can be left blank.
12. Click Apply.
Tip: It is considered a best practice to check the resulting property value immediately after the
SYS - Create or Update Agenda Item from Document action is executed by configuring the
following rules: SYS - Check Last Execution Result and Prop - Check Property Value. Configure
the SYS - Check Last Execution Result to verify that the SYS - Create or Update Agenda Item
from Document action occurred. Configure the Prop - Check Property Value rule to use the
property value that was set by the Property to Store Agenda Item Primary Key in the SYS -
Create or Update Agenda Item from Document action.
Symbol Description
2012 Hyland Software, Inc.
574
OnBase 12 Workflow
Symbol Description
Note: This symbol is only applicable when used with an Institutional Database.
%C Displays the name of the user who created the current document.
%D1 Displays the date that the document was stored. This value cannot be changed.
%I1 or %T Displays the time that the document was stored. This value cannot be changed.
%K###.n Displays the Keyword Value of Keyword Type ### n times. For example, %K101.4
would display up to 4 unique Keyword Values for Keyword Type 101 for a single
document.
For some functionality, a Keyword Type drop-down list may be available to
configure this. Select a Keyword Type from the drop-down select list, enter the
number of times you want the Keyword Value to be displayed in the Repeat field,
and click Keyword. The value in the Repeat field specifies how many instances of
the Keyword Value will be displayed. Entering an * character will pull all existing
Keyword Values for display up to 99 instances.
Note: When using the Classic Client interface, double digits in the Repeat field are
not supported.
%M Extracts metadata values from items. This includes attribute values from Workview
objects or a field values from an Entity item.
%M must be followed by the metadata value you want to extract. For example, if
you want to extract the value of a WorkView attribute called Name, it would be
%MName.
The token strings can contain nested expressions. Example, a nested WorkView
attribute: %MVendor.Buyer.Name.
%R Displays the real user name (if configured) of the user who created the current
document. If a real user name is not configured, a blank space will be displayed.
%U Displays the user name of the currently logged in user who executed the task.
2012 Hyland Software, Inc.
575
Workflow OnBase 12
Symbol Description
Configuration Module Actions Descriptions
%V### Displays the value of a configured Workflow property. For example, to display the
value for the property Color, this symbol would be configured %VColor.
Note: If a property name has spaces, using %V to display the property value alone
will not preserve the spaces, and therefore, the property will not be correctly
identified. When %V is used with a property name containing space in conjunction
with a formatting code, the property will be identified. %C(VProperty Name) would
be an example of property with spaces that will be identified correctly with the first
letter capitalized. This formatting option are available for the following actions:
Prompt User with Question Box/SYS - Prompt User with Question Box, Create Note/
Doc - Create Note on This Document/Related Document, Display Message Box/
Notify - Display Message Box, and Custom Log Entry/SYS - Custom Log Entry.
The following symbols are not supported in the Classic Client interface:
%L [life cycle ID]
%L2 [life cycle name]
%Q [queue ID]
%Q2 [queue name]
%M [item metadata value] is not supported in the Classic OnBase Client interface or the
Core-Based OnBase Client interface.
Note: This action is not supported for the Classic Client or OnBase Mobile interfaces.
This action will automatically open a web browser, such as Internet Explorer, and navigate to
the configured URL. The action optionally allows for parameters to be appended to the end of
the URL for more specific results. The values of the parameters can be taken from a keyword
value, a property value, or a constant value. When more than one value of the configured
keyword or property exists, only the first value will be used as the parameter value. Multiple
parameters can also be configured for the same URL. If parameters are configured, the action
will append ? to the end of the URL and then format the parameters as follows:
parameter1=value1¶meter2=value2. For example, if the configured URL is http://
server/default.aspx, and the configured parameters are named parameter1 and
parameter2, the web browser will open to the following URL: http://server/
default.aspx?parameter1=value1¶meter2=value2
Enter the URL you would like the action to open. When configuring the action, a valid
communications protocol such as HTTP:// or HTTPS:// should be placed at the beginning of
the URL.
Optionally, you can set parameters to append to the URL for more specific results.
2012 Hyland Software, Inc.
576
OnBase 12 Workflow
To configure a parameter.
Calls a function in a user-defined DLL. This function takes the action number, the document
handle (internal document number) and the Document Type number as parameters. The
function must have the following format: int (CALLBACK* DLLEXITPROC)(long nActionNum, long
nDocumentHandle, long nDocumentTypeNum)
Specify the name of the DLL in the DLL Name field. The corresponding name of the function
being called goes in the Function Name field. Click Save.
You must enter a reason for the exclusion in the Reason for Exclusion text box. If a reason is
not entered, the action will not execute successfully.
Note:When executing this action in the Workflow Core-based interfaces, this action should not
be used if the program being executed by the action requires a User Interface
Note:This action is currently not supported in the Web Client or Java Client interfaces.
Calls the application at the path specified in the command line. In the Command Line field,
enter the full path to a program executable. Click Save. The specified program launches.
2012 Hyland Software, Inc.
577
Workflow OnBase 12
This action supports the use of %U in the command line. %U will be translated to the user
name of the currently logged in user and will be applied along with the command line.
Configuration Module Actions Descriptions
For example, if the action calls C:\k1\program.exe %U 35 and the user JANE BROWN
performs the actions, the command C:\d1\program.exe JANE BROWN 35 will be run.
Caution: If you are using encrypted keyword functionality, encrypted keywords are not masked
and the values are displayed as read-only in all interfaces.
Note: This action allows a user to import documents into a Document Type for which they do
not have rights. In addition, a user does not need to have the Create Revision privilege
granted in order to create a revision of a document.
Allows users to import a document into OnBase. When the action is executed, the Import
Document dialog box is displayed.
Default Document Type
The Document Type selected from the drop-down select list will be the default Document Type
selected when the Import Document dialog box is displayed. If a default Document Type is not
specified, you will be able to select the appropriate Document Type and file type.
If the Enable Document and File Type Combo Boxes option is selected, the File Type and
Document Type drop-down select lists will be enabled in the Import Document dialog box. This
option is only enabled when a default Document Type is selected. If this option is not
selected, documents will be imported using the selected default Document Type. When
<None> is selected, the Enable Document and File Type Combo Boxes option is automatically
selected.
Note: If a default Document Type is selected and the Enable Document and File Type Combo
Boxes option is not selected, users that do not have rights to the default Document Type will
be able to import documents into the Document Type using this action.
Keywords
Note: When using this action to create a revision of an existing document, an additional
instance of a Keyword Value is added if one instance already exists.
If you want to specify a Keyword Value to automatically be populated in the Import Document
dialog box, select a Keyword Type from the drop-down menu and enter the keyword value in
the Keyword field.
Using the Inherit Common Keys from Active Document option, the user can specify that either
all or some of the keywords in the current document are copied to the imported document.
Selecting this option enables the Inherit All and Inherit Selected options and the Configure
button.
2012 Hyland Software, Inc.
578
OnBase 12 Workflow
If you want all Keyword Values to be inherited from the active document, select the Inherit All
option.
Note: In the Unity interface, common Keyword Types in different Multi-Instance Keyword Type
Groups are inherited regardless of whether the Inherit All or Inherit Selected option is selected.
If you check the Fill Document Handle Keyword(s) check box, the new document and the
primary document inherit each others document handle number keyword values for the
Document Handle keyword. OnBase keyword Document Handle must be assigned to both
Document Types involved in the exchange. This configuration enables the new document,
which had no link to the primary document via a common keyword, to become a related
document based on the document handle when actions and rules are configured to use the
Document Handle option to identify related documents. If the primary document already had a
value in the Document Handle Keyword Type, the document handle of the new document is
added to the primary document as a Document Handle Keyword Value and does not replace
the previous value.
Note: If the primary document belongs to a closed or cutoff Records Management folder, the
Document Handle keyword value will not be copied from the new document to the primary
document.
Options
The user can use the Display Document option to specify that the imported document should
be displayed in the primary pane, secondary pane or a separate window.
If the Primary Pane option is selected, displays new document in the primary pane in the place
of the main document.
If the Secondary Pane option is checked, displays related documents in the secondary pane.
Specify that the document should open in a separate window by selecting the Separate
Window option. The Top Level Window check box causes the document to be opened in a
window that can be dragged outside of the system window to display it on a second desktop
(if using dual monitors).
The Default Initiate Workflow options allow the user to specify that the Initiate Workflow check
box in the Import Document dialog box be checked or unchecked by default. If On is selected,
the check box will be selected by default. If Off is selected, the check box will not be selected
by default. If None is selected, whether or not the check box is selected will be determined by
the DoNotInitiateWorkflow setting in the onbase32.ini file.
The Allow Modify Keywords option specifies if the Keyword Values can be edited in the Import
Document dialog box. The Document Date field is disabled when Allow Modify Keywords is not
selected. The action configuration options override all user group privileges.
2012 Hyland Software, Inc.
579
Workflow OnBase 12
The Enable Initiate Workflow option specifies that the Initiate Workflow check box in the
Import Document dialog box be enabled or disabled.
Configuration Module Actions Descriptions
Note: The Default Initiate Workflow and Enable Initiate Workflow options are not supported in
the OnBase Desktop. If the document being imported using this action is assigned to a
Document Type associated with a life cycle, that document will be entered into the associated
life cycle.
Caution: The action configuration options override all user group privileges.
Caution: If you are attempting to use this action to create a new revision on the existing primary
document, you will only be able to save the imported document as a new document and not as a
revision because the primary document is already locked.
Caution: This action overrides the privileges assigned to users for Records Management.
This action places a hold on the managed folder that is associated with the current, active
document. Holds are placed only on folders that are eligible based on their disposition status
and that belong to a folder of a managed folder type that is associated with the hold set/hold
reason configured.
Select the Hold Set you would like to use to place holds. Hold sets are associated with specific
Managed Folder Types. This drop-down select list will contain the hold sets that are configured
for managed folder types. If you select <Any>, all hold reason configured in the system are
available for selection in the Hold Reason drop-down select list.
From the Hold Reason drop-down select list, select the hold you want to place on folders. This
drop-down will populate the holds that have been configured in the Hold Set selected.
If you want to use the reason that was configured for the hold, select Use Reason Text
Configured for the Selected Hold.
If you want to configure another reason for the hold when placed via this Workflow task,
select Configure Another Reason Text and enter the appropriate text in the field.
2012 Hyland Software, Inc.
580
OnBase 12 Workflow
This action posts an event on the managed folder that is associated with the current, active
document. Events are posted only on folders that are eligible based on their disposition
status.
In the Event Set drop-down select list, select an event set to narrow down the events listed in
the Post Event drop-down select list. If you select <Any>, all events configured in the system
will be available for selection in the Post Event drop-down select list.
In the Post Event drop-down select list, select the event to post on a managed folder. The
selected event will only post on folders that belong to folders types that were configured to
use the selected event.
Note: The -RIMSERVER command line switch must be present on the Client executable for this
action to function correctly. When using this action in the Core-based interfaces, a delay may
occur before the posting of an event.
If the event selected was configured with the Allow User to Set Event Date option selected, the
Event Date options are enabled. When Current Date is selected, the current date at the time
the task was executed is used as the event date. When Specific Date is selected, the date
entered will be used as the event date. When Property Value is selected, the date from the
property specified in the field will be used as the event date. When Keyword Value is selected,
the date value from the Keyword Type selected from the drop-down select list is used as the
event date.
Caution: The Allow User to Set Event Date option is not supported in the Classic Client interface.
Note: When using the Property Value or the Keyword Value option, the value of the property or
Keyword Type must be a valid date or date/time value.
2012 Hyland Software, Inc.
581
Workflow OnBase 12
Deletes all documents in a local server cache. A cache location must be specified before this
action type is configured. Select the name of the cache from the Cache drop-down list and
Configuration Module Actions Descriptions
click Save. Specify the percentage at which you want OnBase to begin purging files in the High
Water Mark field. Enter the percentage at which OnBase should stop purging files in the Low
Water Mark field. Files are purged from oldest to newest.
Note: The high and low watermark settings configured for this action type override the original
settings established when the cache was created.
Caution: This action will remove the current document from OnBase. The removal is total,
permanent, and irreversible. Please ensure this action is only applied to documents that do not
contain important data.
Note: Documents that are under retention using the Document Retention module cannot be
purged using this action.
Note: Documents purged using this action will not appear in the SYS - Document Purge Report.
This action removes all database entries for a document and it will not be accessible by any
means in OnBase including Document Maintenance. If more than one person is accessing the
same document, the document can be purged by the first person to open the document by
initiating the purge action. If the second user tries to purge the document, nothing happens.
If you are using the Classic Client interface, this action removes the documents physical file
from the Disk Group(s) unless the document is currently displayed in the viewer. If the
document is displayed in the viewer when the action is executed, the documents physical file
will not be removed from the disk group. When using a core-based interface, the action does
not remove the documents physical file from the disk group.
If the Action will purge only documents having a file format of Electronic Form, Virtual Electronic
Form, or Unity Form. option is selected, only documents that are Electronic Form, Virtual
Electronic Form, or UnityForm file formats will be purged from OnBase. All documents with
other file formats will not be purged.
If the Action will purge any document option is selected, any document will be purged,
regardless of the file format that is used.
Note: If a COLD, Check Import, or DIP process is running, the physical file being used by the
process does not delete the physical file, but the references to the current document are
removed from OnBase. DIP processes that are affected have a DIPDocumentPerFile
onbase32.ini setting >1.
2012 Hyland Software, Inc.
582
OnBase 12 Workflow
Executes load balancing for the selected item(s). This is the same functionality that is
executed when an item enters a load balancing queue. This action can be configured to
Note:When the rebalance function is initiated, existing assignments are cleared and new
assignments are made based on the load-balancing queues configuration.
You can use the Life Cycle drop-down select list to narrow the queues listed in the Load
Balancing Queue drop-down select list. The Load Balancing Queue drop-down select list will list
all queues configured for load balancing for the life cycle selected in the Life Cycle drop-down
select list. The action will be executed on the selected item(s) within the queue that is
selected from the Load Balancing Queue drop-down select list.
Workflow is designed to automatically refresh the display when a document transitions out of
the queue. This action refreshes the Workflow display when actions have changed the
document, but the document still exists in the same queue. This action is useful for updating
the Auto-Name string of the document after all other tasks have been executed.
Removes all user assignments for the selected document from the rule-based load balancing
queue selected in the Load Balancing Queue drop-down list for the life cycle selected in the
Assign in Life Cycle drop-down list.
Select <<This Queue>> from the Load Balancing Queue drop-down select list to configure the
action for the specific queue that the document is in. Selecting <<This Queue>> allows this
action to easily be copied for other queues within the configured life cycle, as the action will
always apply to the queue that the document is in. When <<This Queue>> is selected, the
active life cycle must also be selected. If <ALL> is selected in the Assign in Life Cycle drop-
down select list, the active life cycle will automatically be selected for the action when the
Apply button is selected.
Removes all user assignments for the related document from the rule based load balancing
queue selected in the Load Balancing Queue drop-down select list for the selected life cycle
selected in the Assign in Life Cycle drop-down select list.
2012 Hyland Software, Inc.
583
Workflow OnBase 12
Related Documents
Configuration Module Actions Descriptions
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
2012 Hyland Software, Inc.
584
OnBase 12 Workflow
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
Associated Primary Document (Applicable to Work Folder documents only)
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
2012 Hyland Software, Inc.
585
Workflow OnBase 12
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
Removes any existing exclusion from Document Retention for the current document. The
Document Type the document belongs to must be configured for use with Document
Retention.
Caution: This action overrides the privileges assigned to users for Records Management.
When initiated, this action will remove the hold on a managed folder in which the current,
active document belongs. If the managed folder that the document belongs to has multiple
holds applied, no holds will be removed. If multiple documents are selected that belong to
different managed folders, holds will be removed from all folders that only have one hold
applied.
Removes a document assignment from a users load balanced queue from the selected rules-
based load balancing queue.
Select a life cycle from the Assign in Life Cycle drop-down select list to limit the queues
displayed in the Load Balancing Queue drop-down select list.
2012 Hyland Software, Inc.
586
OnBase 12 Workflow
The Load Balancing Queue drop-down select list contains the rule based load balancing queues
that you want to use for the user assignment.
Note: This option will require user interaction. Do not use this type with timers or in system
work.
If you want a particular users assignments to be removed, select Select User. When this
option is selected, the Assigned User drop-down select list will become enabled. Select the
appropriate user.
Note: When the selected queue is <<This Queue>>, the available assignment types are
restricted to those that could apply to any queue in the life cycle, regardless of membership.
Removes a related document assignment from a users load balanced queue from the
selected rules-based load balancing queue.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
2012 Hyland Software, Inc.
587
Workflow OnBase 12
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
2012 Hyland Software, Inc.
588
OnBase 12 Workflow
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
Associated Primary Document (Applicable to Work Folder documents only)
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
2012 Hyland Software, Inc.
589
Workflow OnBase 12
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
Select a life cycle from the Assign in Life Cycle drop-down select list to limit the queues
displayed in the Load Balancing Queue drop-down select list.
The Load Balancing Queue drop-down select list contains the rule based load balancing queues
that you want to use for the user assignment.
Note: This option will require user interaction. Do not use this type with timers or in system
work.
If you want a particular users assignments to be removed, select Select User. When this
option is selected, the Assigned User drop-down select list will become enabled. Select the
appropriate user.
2012 Hyland Software, Inc.
590
OnBase 12 Workflow
Executes a VBScript on the current document. The VBScript must be saved into OnBase
through the Configuration module in order for it to be accessible for action configuration.
Note: When using this action, be sure that the visible scope in the script is set according to the
context in which the script will be run. The visible scope will differ depending on whether the
script is run on the Client side or the server side. See the OnBase VBScript documentation for
more information.
Note: When using the Core-based OnBase Client interface and running VBScripts on the client
side and a property bag is used, the property bag will be synchronized between the server
and client prior to executing the script, and again following the execution of the script. This
will insure that property bag values residing on the server will be available to use on the client
side during script execution. These same property bag values, if changed during the script
execution on the client side, will be available in the Core after execution. Synchronizing the
property bag does not support deleting a property value from the property bag. If a property
value is deleted during script execution on the client, the property value will not be removed
from the property bag on the server side when next synchronization occurs. Only non-object
property values are supported for synchronization. If a property holds an interface pointer to
a class instance we will not synchronize these types of properties. Synchronization is not
supported when Timer work is performed on the client side.
2012 Hyland Software, Inc.
591
Workflow OnBase 12
This action will run a VBScript without creating the Application Object. This means that if this
action is part of a task list, the entire task list is run before the work accomplished by this
Configuration Module Actions Descriptions
Note: If a script breaks while running, the resulting error screen will display the scripts ID to
facilitate troubleshooting.
Note: When using this action, be sure that the visible scope in the script is set according to the
context in which the script will be run. The visible scope will differ depending on whether the
script is run on the Client side or the server side. See the OnBase VBScript documentation for
more information.
Note: When using the Core-based OnBase Client interface and running VBScripts on the client
side and a property bag is used, the property bag will be synchronized between the server
and client prior to executing the script, and again following the execution of the script. This
will insure that property bag values residing on the server will be available to use on the client
side during script execution. These same property bag values, if changed during the script
execution on the client side, will be available in the Core after execution. Synchronizing the
property bag does not support deleting a property value from the property bag. If a property
value is deleted during script execution on the client, the property value will not be removed
from the property bag on the server side when next synchronization occurs. Only scalar
property values are supported for synchronization. If a property holds an interface pointer to
a class instance we will not synchronize these types of properties. Synchronization is not
supported when Timer work is performed on the client side.
The Script drop-down select list allows you to select a configured Unity script that will be
executed.
The Refresh document after script has executed option allows you to refresh the document after
the selected script has been executed. The option reloads the document information from the
database, so everything about the document is refreshed, including keyword values,
autoname strings, page, etc. This option is needed when Unity scripts are executed and the
document is modified, including any keyword values on the document, and the rules and
actions that follow the script execution depend on the updates to the document. Changes to
keyword values include the adding, removing, or modifying any keyword value. Using this
option ensures that once the script completes, the current document is refreshed in Workflow
to update any keyword data and other changes made to the document via the script.
2012 Hyland Software, Inc.
592
OnBase 12 Workflow
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
To access related document options, click Configure.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
of the Document Type assigned that match the keyword values provided will be processed.
2012 Hyland Software, Inc.
593
Workflow OnBase 12
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
Configuration Module Actions Descriptions
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
Associated Primary Document (Applicable to Work Folder documents only)
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
2012 Hyland Software, Inc.
594
OnBase 12 Workflow
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
The Script drop-down select list allows you to select a configured Unity script that will be
executed.
This action is used to manually trigger the sending of document event information to the
Event Relay Server. The document must belong to a Document Type that is configured for use
with the Event Relay Server.
This action can be used to accomplish many tasks and the available configuration settings
change depending on the type of protocol used (http(s)/ftp/file) and the method (e.g. HTTP
GET/POST or FTP upload/download).
The list of the actions functionality is:
2012 Hyland Software, Inc.
595
Workflow OnBase 12
File protocol
Import a file from the local file system into OnBase
Configuration Module Actions Descriptions
Set the value of a property from a file in the local file system
Export the current document to a file in the local file system
Export the value of a property to a file in the local file system
Export some specific text to a file in the local file system
FTP protocol
Import a file from an FTP server into OnBase
Set the value of a property from a file on the FTP server
Export the current document to a file on the FTP server
Export the value of a property to a file on the FTP server
Export some specific text to a file on the FTP server
HTTP/HTTPS protocol
Import the response of an HTTP GET/POST into OnBase
Set the value of a property from the response of an HTTP GET/POST
Send the current document as the request body of an HTTP POST
Send the value of a property as the request body of an HTTP POST
Send some specific text as the request body of an HTTP POST
Send specific HTTP headers with the request mapped to keywords, properties or
constant values
Receive specific HTTP headers from the response mapped to keywords or properties
1. Select a Protocol and Method from the drop-down select lists. See Protocols on page
602 for more information.
2. Enter a URI into the Use the following URI field or supply the property from which you
will pull the URI in the Use the URI in the following property field.
3. Configure Request Settings, Response Settings, and Miscellaneous Settings as
appropriate.
Request Settings
2012 Hyland Software, Inc.
596
OnBase 12 Workflow
The Request Settings dialog box is accessed by clicking the Edit button for the Request Settings
section.
Symbol Description
Note: This symbol is only applicable when used with an Institutional Database.
%C Displays the name of the user who created the current document.
2012 Hyland Software, Inc.
597
Workflow OnBase 12
Symbol Description
Configuration Module Actions Descriptions
%D1 Displays the date that the document was stored. This value cannot be changed.
%I1 or %T Displays the time that the document was stored. This value cannot be changed.
%K###.n Displays the Keyword Value of Keyword Type ### n times. For example, %K101.4
would display up to 4 unique Keyword Values for Keyword Type 101 for a single
document.
For some functionality, a Keyword Type drop-down list may be available to
configure this. Select a Keyword Type from the drop-down select list, enter the
number of times you want the Keyword Value to be displayed in the Repeat field,
and click Keyword. The value in the Repeat field specifies how many instances of
the Keyword Value will be displayed. Entering an * character will pull all existing
Keyword Values for display up to 99 instances.
Note: When using the Classic Client interface, double digits in the Repeat field are
not supported.
%M Extracts metadata values from items. This includes attribute values from Workview
objects or a field values from an Entity item.
%M must be followed by the metadata value you want to extract. For example, if
you want to extract the value of a WorkView attribute called Name, it would be
%MName.
The token strings can contain nested expressions. Example, a nested WorkView
attribute: %MVendor.Buyer.Name.
%R Displays the real user name (if configured) of the user who created the current
document. If a real user name is not configured, a blank space will be displayed.
%U Displays the user name of the currently logged in user who executed the task.
2012 Hyland Software, Inc.
598
OnBase 12 Workflow
Symbol Description
Note: If a property name has spaces, using %V to display the property value alone
will not preserve the spaces, and therefore, the property will not be correctly
identified. When %V is used with a property name containing space in conjunction
with a formatting code, the property will be identified. %C(VProperty Name) would
be an example of property with spaces that will be identified correctly with the first
letter capitalized. This formatting option are available for the following actions:
Prompt User with Question Box/SYS - Prompt User with Question Box, Create Note/
Doc - Create Note on This Document/Related Document, Display Message Box/
Notify - Display Message Box, and Custom Log Entry/SYS - Custom Log Entry.
The following symbols are not supported in the Classic Client interface:
%L [life cycle ID]
%L2 [life cycle name]
%Q [queue ID]
%Q2 [queue name]
%M [item metadata value] is not supported in the Classic OnBase Client interface or the
Core-Based OnBase Client interface.
Response Settings
2012 Hyland Software, Inc.
599
Workflow OnBase 12
The Response Settings dialog box is accessed by clicking the Edit button for the Response
Settings section.
Configuration Module Actions Descriptions
2012 Hyland Software, Inc.
600
OnBase 12 Workflow
Headers
When using HTTP and HTTPS protocols, headers can be configured in the Request Settings and
You can select a Header from the drop-down and select Keyword Type, The Value of a Property,
or Value, specify the appropriate value for the selection and click Map. This will map the
Header to the option specified.
Miscellaneous Settings
The actions miscellaneous settings dialog is broken down into three separate pages: General,
Authentication and Proxy.
General Tab
When the Abort processing on failure option is not selected, if the action fails to send the web
request, it will log an error to the Diagnostics Console, set the last execution result to
S_FALSE and continue executing the rest of the actions/rules in the task list.
When the Abort processing on failure option is selected and the action fails to send the web
request, it will also log an error to the Diagnostics Console, but will break the task list
execution.
Authentication Tab
The Authentication tab allows the user to configure what the user name/password should be
used for the request, if applicable.
2012 Hyland Software, Inc.
601
Workflow OnBase 12
No authentication
The action will not use any user name/password with HTTP requests. Any FTP request will use
Configuration Module Actions Descriptions
Note: The file protocol does not support the authentication settings; therefore, if you are
importing/exporting using the file protocol, the location must be accessible by the process
running the Application Server.
Proxy Tab
The Proxy tab allows the user to have the action Use the default proxy settings or they can
specify a particular proxy server using the Use the following proxy server option.
Protocols
File Protocol
The file protocol has two available methods: Import and Export.
Note: The file protocol does not support the actions authentication and proxy settings.
Import Method: The import method allows the action to either set the value of a Workflow
property to the contents of the specific file, or import the file as a new document in OnBase.
The Response Settings dialog allows the user to configure this.
Export Method: The export method allows the action to create a file on the Application Server.
When the user selects the export method they are able to specify the Request Settings.
FTP Protocol
The action connects to an FTP server using this protocol. The ftp protocol has two available
methods: Download and Upload
Note: The FTP protocol does not support the actions proxy settings.
Download Method: The download method allows the action to either set the value of a
Workflow property to the contents of the specific file, or import the file as a new document in
OnBase. The Response Settings dialog allows the user to configure this.
Upload Method: The upload method allows the action to create a file on the Application Server.
When the user selects the upload method they are able to specify the Request Settings.
HTTP Protocol
The http protocol has the following methods:
2012 Hyland Software, Inc.
602
OnBase 12 Workflow
GET: Requests a representation of the specified resource (at the URI). The GET method is
typically used to request a web page. It can also be used to call a web service.
Note: This action is only supported in the Classic Client, Core-based Client, and Unity
interfaces.
This action sets the folder and template that will be used to populate the related documents
list in the Workflow clients. Before configuring this system action, the folder and/or template
that you plan to use must be created. Once configured, select the folder type to apply from
the Folder Type drop-down select list.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
You can select a specific template to display all the time, by selecting the Use This Template
option, or you can select the Get Template to Use from Keyword option to specify a template to
be used under certain conditions. If a folder type or template was configured at the queue or
life cycle level, applying this action type overrides those configurations. If you want to
suppress the reloading of the Work Folder after task execution, select the Suppress Screen
Refresh option. The folder and template that are set with this action will not persist when
another queue or life cycle is selected.
Marks a document for purging or increments the retention period by the number of days,
months, or years configured at the Document Type.
If Mark for Purging is configured for this action, the document is marked for purging and can
be removed from OnBase using the associated Purging Processor in the Client module.
If Increment Retention Period (based on Document Type) is configured, the dateexpire value
stored for the document in the database is increased by a value equal to the retention period
defined for the Document Type, to which the document belongs, from the current date. For
example, if the current date is January 15, 2007 and the retention period defined for the
Document Type is 5 years, the dateexpire value would be updated to January 15, 2012. This
value will then be used when the document is evaluated against the associated Evaluating
Processor in the Client module.
2012 Hyland Software, Inc.
603
Workflow OnBase 12
If Increment Retention Period by Specified Value is configured, you can specify a number of
days, months, or years to increment the dateexpire value. The dateexpire value will be
Configuration Module Actions Descriptions
updated with the current day plus the configured numbered of days, months, or years. Enter
the number of days, months, or years in the field and select Day(s), Month(s), or Year(s) from
the drop-down select list. The maximum number of days that can be entered is 999. The
maximum number of months or years is 255.
If the Do not Purge, Do not Increment Retention Period option is selected, the dateexpire value
is not updated, but the retainstatus value is set to 0, making the document available to be
evaluated by the evaluation Document Retention processor immediately in the Client.
All other actions set the last execution result to TRUE if there is at least one related document
(not locked by Records Management) regardless of the result of the action and FALSE if there
are no related documents (or they are locked by Records Management).
2012 Hyland Software, Inc.
604
OnBase 12 Workflow
The following actions will not execute on related documents locked by Records Management.
Related documents that are locked are not returned as related documents.
Doc - Check In Related Document
Doc - Check Out Related Document
Note: If at least one related document was locked, the last execution result is FALSE
2012 Hyland Software, Inc.
605
Workflow OnBase 12
2012 Hyland Software, Inc.
606
CONFIGURATION MODULE RULES DESCRIPTIONS
Caution: Encrypted keywords are not supported in the Classic Client interface.
Caution: Within Workflow life cycles, users with rights to tasks that modify keywords can modify
encrypted Keyword Values upon task execution, regardless of their encrypted keyword user
rights. When using E-Forms that display user interaction, encrypted keywords are displayed
masked when the user does not have rights to view encrypted Keyword Values and the user
cannot change values that they do not have rights to regardless of the user's ad hoc task rights.
Note: Rules with the KEYSET prefix are not compatible with external AutoFill Keyword Type
Sets.
2012 Hyland Software, Inc.
607
Workflow OnBase 12
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
Note: When a Workflow rule evaluates related documents, as soon as the rule encounters one
related document that evaluates True for the rules condition, the rule evaluates as True and
the True logic is executed. If all related documents evaluate to False, then the False logic is
executed.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle property as
the common denominator between the current and related document. When selected, the
Related Document Type and Common Keyword Types cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values on the current
document, the rule will evaluate true if any related document matches the existing value in
the common Keyword Type.
2012 Hyland Software, Inc.
608
OnBase 12 Workflow
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any one of the values contained for that Keyword Type on the current
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down select list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values on the current
document, the rule will evaluate true if any folder of the assigned folder type has a matching
value for the common Keyword Type. Common Keyword Types for Folder Types are
configured in Folder Type configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
Associated Primary Document (Applicable to Work Folder documents only)
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If a rule that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or
System Tasks), the following message is displayed in the Diagnostics Console, the rule
evaluates to "False", and the remainder of the task list continues execution: "Relationship
type is only valid for tasks executed via drag and drop from the work folder"
2012 Hyland Software, Inc.
609
Workflow OnBase 12
Note: This option is not supported in the Classic Client Workflow interface.
Configuration Module Rules Descriptions
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is checked, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that "Related Document Query aborted:
primary document does NOT have all common keywords present".
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Note: The Lock Related Document check box is always disabled for rules.
Priority Value
This value will be used to evaluate items against. Numbers 1 to 999 are valid values. Priority
rank is dependent on sorting and load balancing configurations.
Operator
The operator selected from this drop-down menu sets how to compare the priority value
configured for the rule to the priority value of the selected document. You can select less than
(<), less than or equal to (<=), not equal to (<>), equal to (=), greater than (>), or greater
than or equal to (>=).
Check on Related Documents in this Life Cycle
Select the life cycle from this drop-down list from which you would like the priority checked
for the related document. Priorities are attached to life cycles for a document. It is possible to
have different priority assignments for the same document in multiple life cycles.
2012 Hyland Software, Inc.
610
OnBase 12 Workflow
The operator selected from this drop-down menu sets how to compare the priority value
configured for the rule to the priority value of the selected document. You can select less than
(<), less than or equal to (<=), not equal to (<>), equal to (=), greater than (>), or greater
Checks to see if the current document is assigned to the reading group specified in the
Reading Group drop-down select list.
Allows verification of whether a document has been signed by a specific user, member of a
user group, or user specified by a Keyword Value. If This User is selected, the rule will be
evaluated based on whether or not the specific user selected in the drop-down select list
signed the document. If Member of this Group is selected, the rule will be evaluated based on
whether or not a user belonging to the group specified in the drop-down select list signed the
document. If User specified by Keyword is selected, the value of the Keyword Type drop-down
select list is compared to the user name of the person who signed the document. If there are
multiple values of the specified Keyword Type, only one of the values must match the user
that signed the document in order to evaluate as true.
If there are multiple revisions of a document, the current revision is evaluated for a signature.
2012 Hyland Software, Inc.
611
Workflow OnBase 12
When the rule is executed on multiple documents and the rule is configured for the Last
Document, the rule will evaluate to true only if it is the last document in the selected list of
documents.
Configuration Module Rules Descriptions
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
Note: When a Workflow rule evaluates related documents, as soon as the rule encounters one
related document that evaluates True for the rules condition, the rule evaluates as True and
the True logic is executed. If all related documents evaluate to False, then the False logic is
executed.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle property as
the common denominator between the current and related document. When selected, the
Related Document Type and Common Keyword Types cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
2012 Hyland Software, Inc.
612
OnBase 12 Workflow
After you select the related Document Type, click Common Keyword. The Related Document
Query dialog box opens. To add Keyword Types to the list, select the Keyword Type in the list
and click Add. To remove a Keyword Type from the list, select the keyword and click Remove.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values on the current
document, the rule will evaluate true if any related document matches the existing value in
the common Keyword Type.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any one of the values contained for that Keyword Type on the current
document (as well as the other common keywords designated) for the rule to succeed. To
enable this feature for a common keyword, click the check box to the left of the Keyword Type
name after the common keyword(s) have been added. If this option is disabled, the related
document must match all values for a given Keyword Type if it contains multiple values on a
primary document.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down select list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values on the current
document, the rule will evaluate true if any folder of the assigned folder type has a matching
value for the common Keyword Type. Common Keyword Types for Folder Types are
configured in Folder Type configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
2012 Hyland Software, Inc.
613
Workflow OnBase 12
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
Configuration Module Rules Descriptions
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If a rule that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or
System Tasks), the following message is displayed in the Diagnostics Console, the rule
evaluates to "False", and the remainder of the task list continues execution: "Relationship
type is only valid for tasks executed via drag and drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is checked, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that "Related Document Query aborted:
primary document does NOT have all common keywords present".
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Note: The Lock Related Document check box is always disabled for rules.
2012 Hyland Software, Inc.
614
OnBase 12 Workflow
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
Note: When a Workflow rule evaluates related documents, as soon as the rule encounters one
related document that evaluates True for the rules condition, the rule evaluates as True and
the True logic is executed. If all related documents evaluate to False, then the False logic is
executed.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle property as
the common denominator between the current and related document. When selected, the
Related Document Type and Common Keyword Types cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values on the current
document, the rule will evaluate true if any related document matches the existing value in
the common Keyword Type.
2012 Hyland Software, Inc.
615
Workflow OnBase 12
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any one of the values contained for that Keyword Type on the current
Configuration Module Rules Descriptions
document (as well as the other common keywords designated) for the rule to succeed. To
enable this feature for a common keyword, click the check box to the left of the Keyword Type
name after the common keyword(s) have been added. If this option is disabled, the related
document must match all values for a given Keyword Type if it contains multiple values on a
primary document.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down select list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values on the current
document, the rule will evaluate true if any folder of the assigned folder type has a matching
value for the common Keyword Type. Common Keyword Types for Folder Types are
configured in Folder Type configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
Associated Primary Document (Applicable to Work Folder documents only)
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If a rule that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or
System Tasks), the following message is displayed in the Diagnostics Console, the rule
evaluates to "False", and the remainder of the task list continues execution: "Relationship
type is only valid for tasks executed via drag and drop from the work folder"
2012 Hyland Software, Inc.
616
OnBase 12 Workflow
Note: This option is not supported in the Classic Client Workflow interface.
When this option is checked, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that "Related Document Query aborted:
primary document does NOT have all common keywords present".
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Note: The Lock Related Document check box is always disabled for rules.
Note: If the Workflow log is purged, the determination of whether documents have existed in
a life cycle before may not be accurate.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
2012 Hyland Software, Inc.
617
Workflow OnBase 12
Under the Related Documents heading, the status of the related documents configuration is
displayed.
Configuration Module Rules Descriptions
Note: When a Workflow rule evaluates related documents, as soon as the rule encounters one
related document that evaluates True for the rules condition, the rule evaluates as True and
the True logic is executed. If all related documents evaluate to False, then the False logic is
executed.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle property as
the common denominator between the current and related document. When selected, the
Related Document Type and Common Keyword Types cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values on the current
document, the rule will evaluate true if any related document matches the existing value in
the common Keyword Type.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any one of the values contained for that Keyword Type on the current
document (as well as the other common keywords designated) for the rule to succeed. To
enable this feature for a common keyword, click the check box to the left of the Keyword Type
name after the common keyword(s) have been added. If this option is disabled, the related
document must match all values for a given Keyword Type if it contains multiple values on a
primary document.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
2012 Hyland Software, Inc.
618
OnBase 12 Workflow
Folder Type
This drop-down select list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values on the current
document, the rule will evaluate true if any folder of the assigned folder type has a matching
value for the common Keyword Type. Common Keyword Types for Folder Types are
configured in Folder Type configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
Associated Primary Document (Applicable to Work Folder documents only)
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If a rule that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or
System Tasks), the following message is displayed in the Diagnostics Console, the rule
evaluates to "False", and the remainder of the task list continues execution: "Relationship
type is only valid for tasks executed via drag and drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
2012 Hyland Software, Inc.
619
Workflow OnBase 12
When this option is checked, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
Configuration Module Rules Descriptions
message is logged to the Workflow Trace stating that "Related Document Query aborted:
primary document does NOT have all common keywords present".
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Note: The Lock Related Document check box is always disabled for rules.
Life Cycle
The Life Cycle drop-down list allows you to specify where the system should search for the
item.
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
Note: When a Workflow rule evaluates related documents, as soon as the rule encounters one
related document that evaluates True for the rules condition, the rule evaluates as True and
the True logic is executed. If all related documents evaluate to False, then the False logic is
executed.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle property as
the common denominator between the current and related document. When selected, the
Related Document Type and Common Keyword Types cannot be configured.
2012 Hyland Software, Inc.
620
OnBase 12 Workflow
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values on the current
document, the rule will evaluate true if any related document matches the existing value in
the common Keyword Type.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any one of the values contained for that Keyword Type on the current
document (as well as the other common keywords designated) for the rule to succeed. To
enable this feature for a common keyword, click the check box to the left of the Keyword Type
name after the common keyword(s) have been added. If this option is disabled, the related
document must match all values for a given Keyword Type if it contains multiple values on a
primary document.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down select list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values on the current
document, the rule will evaluate true if any folder of the assigned folder type has a matching
value for the common Keyword Type. Common Keyword Types for Folder Types are
configured in Folder Type configuration.
2012 Hyland Software, Inc.
621
Workflow OnBase 12
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
Configuration Module Rules Descriptions
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If a rule that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or
System Tasks), the following message is displayed in the Diagnostics Console, the rule
evaluates to "False", and the remainder of the task list continues execution: "Relationship
type is only valid for tasks executed via drag and drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is checked, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that "Related Document Query aborted:
primary document does NOT have all common keywords present".
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Note: The Lock Related Document check box is always disabled for rules.
Queue
2012 Hyland Software, Inc.
622
OnBase 12 Workflow
The Queue drop-down list allows you to specify where the system should search for the item.
Note: If the current queue is selected, the rule will always evaluate true.
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
Note: When a Workflow rule evaluates related documents, as soon as the rule encounters one
related document that evaluates True for the rules condition, the rule evaluates as True and
the True logic is executed. If all related documents evaluate to False, then the False logic is
executed.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle property as
the common denominator between the current and related document. When selected, the
Related Document Type and Common Keyword Types cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
2012 Hyland Software, Inc.
623
Workflow OnBase 12
After you select the related Document Type, click Common Keyword. The Related Document
Query dialog box opens. To add Keyword Types to the list, select the Keyword Type in the list
and click Add. To remove a Keyword Type from the list, select the keyword and click Remove.
Configuration Module Rules Descriptions
The Document Types with these Keyword Types are evaluated when this action executes.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values on the current
document, the rule will evaluate true if any related document matches the existing value in
the common Keyword Type.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any one of the values contained for that Keyword Type on the current
document (as well as the other common keywords designated) for the rule to succeed. To
enable this feature for a common keyword, click the check box to the left of the Keyword Type
name after the common keyword(s) have been added. If this option is disabled, the related
document must match all values for a given Keyword Type if it contains multiple values on a
primary document.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down select list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values on the current
document, the rule will evaluate true if any folder of the assigned folder type has a matching
value for the common Keyword Type. Common Keyword Types for Folder Types are
configured in Folder Type configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
2012 Hyland Software, Inc.
624
OnBase 12 Workflow
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If a rule that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or
System Tasks), the following message is displayed in the Diagnostics Console, the rule
evaluates to "False", and the remainder of the task list continues execution: "Relationship
type is only valid for tasks executed via drag and drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is checked, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that "Related Document Query aborted:
primary document does NOT have all common keywords present".
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Note: The Lock Related Document check box is always disabled for rules.
Life Cycle
The Life Cycle drop-down list allows you to specify where the system should search for the
item.
2012 Hyland Software, Inc.
625
Workflow OnBase 12
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
Note: When a Workflow rule evaluates related documents, as soon as the rule encounters one
related document that evaluates True for the rules condition, the rule evaluates as True and
the True logic is executed. If all related documents evaluate to False, then the False logic is
executed.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle property as
the common denominator between the current and related document. When selected, the
Related Document Type and Common Keyword Types cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
2012 Hyland Software, Inc.
626
OnBase 12 Workflow
After you select the related Document Type, click Common Keyword. The Related Document
Query dialog box opens. To add Keyword Types to the list, select the Keyword Type in the list
and click Add. To remove a Keyword Type from the list, select the keyword and click Remove.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values on the current
document, the rule will evaluate true if any related document matches the existing value in
the common Keyword Type.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any one of the values contained for that Keyword Type on the current
document (as well as the other common keywords designated) for the rule to succeed. To
enable this feature for a common keyword, click the check box to the left of the Keyword Type
name after the common keyword(s) have been added. If this option is disabled, the related
document must match all values for a given Keyword Type if it contains multiple values on a
primary document.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down select list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values on the current
document, the rule will evaluate true if any folder of the assigned folder type has a matching
value for the common Keyword Type. Common Keyword Types for Folder Types are
configured in Folder Type configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
2012 Hyland Software, Inc.
627
Workflow OnBase 12
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
Configuration Module Rules Descriptions
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If a rule that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or
System Tasks), the following message is displayed in the Diagnostics Console, the rule
evaluates to "False", and the remainder of the task list continues execution: "Relationship
type is only valid for tasks executed via drag and drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is checked, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that "Related Document Query aborted:
primary document does NOT have all common keywords present".
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Note: The Lock Related Document check box is always disabled for rules.
Queue
2012 Hyland Software, Inc.
628
OnBase 12 Workflow
The Queue drop-down list allows you to specify where the system should search for the item.
Note: If the current queue is selected, the rule will always evaluate true.
Checks for the existence of a related document across all life cycles in Workflow, or across
multiple life cycles/queues. Specify Anywhere in Workflow, or to look for the document in
specific queues, select In One of the Following Queue(s).
To configure life cycles and queues, select the Configure Queues button. Select a life cycle or
specific queue out of the Available for Selection fields. When selecting a life cycle, all queues
associated with the particular life cycle are also selected. Click on a queue to de-select it.
Specific queues may also be selected without selecting a life cycle. Once life cycles/queues
have been selected, click the Add>> button. This will add your selections to the Selected field.
When all selections have been made satisfactorily, click Save and Close. The life cycles and
queues you have configured will be displayed in the Life Cycle and Queue lists.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
Note: When a Workflow rule evaluates related documents, as soon as the rule encounters one
related document that evaluates True for the rules condition, the rule evaluates as True and
the True logic is executed. If all related documents evaluate to False, then the False logic is
executed.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle property as
the common denominator between the current and related document. When selected, the
Related Document Type and Common Keyword Types cannot be configured.
Document Type
2012 Hyland Software, Inc.
629
Workflow OnBase 12
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
Configuration Module Rules Descriptions
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values on the current
document, the rule will evaluate true if any related document matches the existing value in
the common Keyword Type.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any one of the values contained for that Keyword Type on the current
document (as well as the other common keywords designated) for the rule to succeed. To
enable this feature for a common keyword, click the check box to the left of the Keyword Type
name after the common keyword(s) have been added. If this option is disabled, the related
document must match all values for a given Keyword Type if it contains multiple values on a
primary document.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down select list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values on the current
document, the rule will evaluate true if any folder of the assigned folder type has a matching
value for the common Keyword Type. Common Keyword Types for Folder Types are
configured in Folder Type configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
2012 Hyland Software, Inc.
630
OnBase 12 Workflow
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If a rule that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or
System Tasks), the following message is displayed in the Diagnostics Console, the rule
evaluates to "False", and the remainder of the task list continues execution: "Relationship
type is only valid for tasks executed via drag and drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is checked, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that "Related Document Query aborted:
primary document does NOT have all common keywords present".
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Note: The Lock Related Document check box is always disabled for rules.
2012 Hyland Software, Inc.
631
Workflow OnBase 12
Checks to make sure documents exist in the folder type that is selected from the Folder Type
drop-down select list. Only dynamic folders will appear in the drop-down list.
Configuration Module Rules Descriptions
Note:Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Checks to see if a rendition exists for the current document. You can check for a rendition of
any file format by selecting <Any> in the File Type drop-down select list or you can select a
specific file type.
Note:This rule requires that your system is licensed for Digital Signatures.
Verifies whether a document was modified after being signed. If the signature is valid, the
rule will evaluate true. If a document is invalid or has no signatures, the rule will evaluate
false.
Note: If the Workflow log is purged, the determination of whether documents have existed in
a life cycle before may not be accurate.
Life Cycle
The Life Cycle drop-down list allows you to specify where the system should search for the
item.
Note: If the Workflow log is purged, the determination of whether documents have existed in
a queue before may not be accurate.
2012 Hyland Software, Inc.
632
OnBase 12 Workflow
Queue
The Queue drop-down list allows you to specify where the system should search for the item.
Checks for the existence of the active document across all life cycles in Workflow, or across
multiple life cycles/queues. Specify Anywhere in Workflow, or to look for the document in
specific queues, select In One of the Following Queue(s).
To configure life cycles and queues, select the Configure Queues button. Select a life cycle or
specific queue out of the Available for Selection fields. When selecting a life cycle, all queues
associated with the particular life cycle are also selected. Click on a queue to de-select it.
Specific queues may also be selected without selecting a life cycle. Once life cycles/queues
have been selected, click the Add>> button. This will add your selections to the Selected field.
When all selections have been made satisfactorily, click Save and Close. The life cycles and
queues you have configured will be displayed in the Life Cycle and Queue lists.
2012 Hyland Software, Inc.
633
Workflow OnBase 12
Note:WorkView must be installed on the database in which you want to configure this rule. If
you import a life cycle into a database, that database must have WorkView installed to
successfully import the life cycle.
Note:This rule is not functional in the Classic Client or Java Client interfaces.
Determines whether a WorkView object exists that matches the Filter Document Type
Association option configured for the rule. The user can only specify one Filter Document Type
Association per Document Type.
Note:This rule will evaluate to true if one or more objects exist that meet the criteria
configured.
1. Select a Document Type from the Document Type drop-down select list.
2. If you want to specify a Filter Document Type Association for which objects must meet
the configured criteria in order for the rule to evaluate true, select the appropriate
Filter Document Type Association. The Filter Document Type Association name is
followed by (Class ClassName). Only Filter Document Type Associations associated
with the Document Type selected are displayed. If no Filter Document Type
Associations are configured for the selected Document Type or you wish to evaluate an
objects existence based on whether the current document in the life cycle is attached
to an object, select <All objects that have doc attached>.
3. Click Add.
4. Repeat the these steps for each association you want to create.
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
Note: When a Workflow rule evaluates related documents, as soon as the rule encounters one
related document that evaluates True for the rules condition, the rule evaluates as True and
the True logic is executed. If all related documents evaluate to False, then the False logic is
executed.
2012 Hyland Software, Inc.
634
OnBase 12 Workflow
Note: Some fields will only become enabled after you have selected a method to relate
Document Handle
This option causes the system to use the value contained in the Document Handle property as
the common denominator between the current and related document. When selected, the
Related Document Type and Common Keyword Types cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values on the current
document, the rule will evaluate true if any related document matches the existing value in
the common Keyword Type.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any one of the values contained for that Keyword Type on the current
document (as well as the other common keywords designated) for the rule to succeed. To
enable this feature for a common keyword, click the check box to the left of the Keyword Type
name after the common keyword(s) have been added. If this option is disabled, the related
document must match all values for a given Keyword Type if it contains multiple values on a
primary document.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
2012 Hyland Software, Inc.
635
Workflow OnBase 12
Folder Type
This drop-down select list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
Configuration Module Rules Descriptions
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values on the current
document, the rule will evaluate true if any folder of the assigned folder type has a matching
value for the common Keyword Type. Common Keyword Types for Folder Types are
configured in Folder Type configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
Associated Primary Document (Applicable to Work Folder documents only)
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If a rule that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or
System Tasks), the following message is displayed in the Diagnostics Console, the rule
evaluates to "False", and the remainder of the task list continues execution: "Relationship
type is only valid for tasks executed via drag and drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
2012 Hyland Software, Inc.
636
OnBase 12 Workflow
When this option is checked, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
Note: The Lock Related Document check box is always disabled for rules.
Note: When using the Queue Entry Value option for Data Value D1, the database servers time is
used for the comparison. When using the Keyword Value option for Data Value D1, the Web
Servers time is used for the comparison.
You can compare two date or date/time values on a document using this rule. For the first
value, you can select Queue Entry Value to compare the date that the document entered the
queue. You can also select a Keyword Type from the Keyword Value drop-down select list to
compare the value.
For the second value, you can select Current Date or Current Date/Time to compare the first
value against. You can select Specific Value and enter a specific date to compare the first value
against. You can select a Keyword Type from the Keyword Value drop-down select list to
compare the value.
A comparison relationship between the two values can be configured. You can specify the
number of days, business days, hours, or minutes to use in the comparison in the Number of
Periods N field and the Period drop-down select list.
Note: Business Day(s) is only available from the Period drop-down select list if a Work Calendar
has been assigned to the life cycle.
Note: If both of the values being compared are not date/time values and hours or minutes is
selected, this will evaluate false because only the date is evaluated.
Note: This setting is not applicable for all comparison options. When it is not applicable, the
fields will become disabled.
2012 Hyland Software, Inc.
637
Workflow OnBase 12
Select a comparison option from the drop-down select list. The options are as follows:
Configuration Module Rules Descriptions
Option Description
D1 is more than N Time Periods before D2 This option is dependent on the number of
periods and the interval of the time period set.
The comparison checks to see if the first value
occurs in time before the second value in more
than the time period specified
For example, if you set the time period to 2 days,
in order for this rule to return true, value 1 would
be more than 2 days before value 2.
D1 is fewer than N Time Periods before D2 This option is dependent on the number of
periods and the interval of the time period set.
The comparison checks to see if the first value
occurs in time before the second value in less
than the time period specified.
For example, if you set the time period to 2 days,
in order for this rule to return true, value 1 would
be less than 2 days before value 2.
D1 is fewer than N Time Periods after D2 This option is dependent on the number of
periods and the interval of the time period set.
The comparison checks to see if the first value
occurs in time after the second value in less than
the time period specified.
For example, if you set the time period to 2 days,
in order for this rule to return true, value 1 would
be less than 2 days after value 2.
D1 is more than N Time Periods after D2 This option is dependent on the number of
periods and the interval of the time period set.
The comparison checks to see if the first value
occurs in time after the second value in more
than the time period specified.
For example, if you set the time period to 2 days,
in order for this rule to return true, value 1 would
be more than 2 days after value 2.
2012 Hyland Software, Inc.
638
OnBase 12 Workflow
Note: When using the Queue Entry Value option for Data Value D1, the database servers time is
used for the comparison. When using the Keyword Value option for Data Value D1, the Web
Servers time is used for the comparison.
You can compare two date or date/time values on a document using this rule. For the first
value, you can select Queue Entry Value to compare the date that the document entered the
queue. You can also select a Keyword Type from the Keyword Value drop-down select list to
compare the value.
For the second value, you can select Current Date or Current Date/Time to compare the first
value against. You can select Specific Value and enter a specific date to compare the first value
against. You can select a Keyword Type from the Keyword Value drop-down select list to
compare the value.
A comparison relationship between the two values can be configured. You can specify the
number of days, business days, hours, or minutes to use in the comparison in the Number of
Periods N field and the Period drop-down select list.
Note: Business Day(s) is only available from the Period drop-down select list if a Work Calendar
has been assigned to the life cycle.
Note: If both of the values being compared are not date/time values and hours or minutes is
selected, this will evaluate false because only the date is evaluated.
Note: This setting is not applicable for all comparison options. When it is not applicable, the
fields will become disabled.
Select a comparison option from the drop-down select list. The options are as follows:
Option Description
D1 is more than N Time Periods before D2 This option is dependent on the number of
periods and the interval of the time period set.
The comparison checks to see if the first value
occurs in time before the second value in more
than the time period specified
For example, if you set the time period to 2 days,
in order for this rule to return true, value 1 would
be more than 2 days before value 2.
2012 Hyland Software, Inc.
639
Workflow OnBase 12
Option Description
D1 is fewer than N Time Periods before D2 This option is dependent on the number of
Configuration Module Rules Descriptions
D1 is fewer than N Time Periods after D2 This option is dependent on the number of
periods and the interval of the time period set.
The comparison checks to see if the first value
occurs in time after the second value in less than
the time period specified.
For example, if you set the time period to 2 days,
in order for this rule to return true, value 1 would
be less than 2 days after value 2.
D1 is more than N Time Periods after D2 This option is dependent on the number of
periods and the interval of the time period set.
The comparison checks to see if the first value
occurs in time after the second value in more
than the time period specified.
For example, if you set the time period to 2 days,
in order for this rule to return true, value 1 would
be more than 2 days after value 2.
2012 Hyland Software, Inc.
640
OnBase 12 Workflow
Note: For any operator except <> (not equal), the rule evaluates to FALSE if the document
has no keywords of the Keyword Type being checked. This can occur if the Keyword Type is
not assigned to the Document Type to which the document belongs or if the document does
not have any Keyword Values for the Keyword Type. For the "<>" operator, the rule will
evaluate to TRUE for this scenario. When there are several Keyword Types, for all operators
except <>" (not equal), the rule evaluates to TRUE if there is at least one Keyword Value
that meets the condition. For <>", the rule evaluates to TRUE only if all keywords are
different from the specified Keyword Value.
Note: This rule does not compare Keyword Type values that have different currency formats
based on actual monetary value. If the currency format of a keyword value on a document is
different from the currency format specified in the rule, the rule evaluates to FALSE for this
keyword even if the numerical value is equal, unless the operator used is <>. Using the <>
operator will evaluate to TRUE because the values are not equal. For example, if the value of
a keyword on a document is $1.00 and the rule is evaluating the Keyword Type = to 1 Euro,
the result of the rule is FALSE because the currency formats differ.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
Note: When a Workflow rule evaluates related documents, as soon as the rule encounters one
related document that evaluates True for the rules condition, the rule evaluates as True and
the True logic is executed. If all related documents evaluate to False, then the False logic is
executed.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle property as
the common denominator between the current and related document. When selected, the
Related Document Type and Common Keyword Types cannot be configured.
Document Type
2012 Hyland Software, Inc.
641
Workflow OnBase 12
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
Configuration Module Rules Descriptions
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values on the current
document, the rule will evaluate true if any related document matches the existing value in
the common Keyword Type.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any one of the values contained for that Keyword Type on the current
document (as well as the other common keywords designated) for the rule to succeed. To
enable this feature for a common keyword, click the check box to the left of the Keyword Type
name after the common keyword(s) have been added. If this option is disabled, the related
document must match all values for a given Keyword Type if it contains multiple values on a
primary document.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down select list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values on the current
document, the rule will evaluate true if any folder of the assigned folder type has a matching
value for the common Keyword Type. Common Keyword Types for Folder Types are
configured in Folder Type configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
2012 Hyland Software, Inc.
642
OnBase 12 Workflow
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If a rule that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or
System Tasks), the following message is displayed in the Diagnostics Console, the rule
evaluates to "False", and the remainder of the task list continues execution: "Relationship
type is only valid for tasks executed via drag and drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is checked, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that "Related Document Query aborted:
primary document does NOT have all common keywords present".
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Note: The Lock Related Document check box is always disabled for rules.
Keyword Type
For all rules evaluating keywords, you must provide the system with the Keyword Type to
check. For these rules, a Keyword Type drop-down select list appears.
2012 Hyland Software, Inc.
643
Workflow OnBase 12
Operator
The default operator is = (equal), which indicates that the keyword value of the document
must match the value entered in the field. The selection of operators available from the drop-
Configuration Module Rules Descriptions
down list varies for the keyword type selected. Select the keyword type first, to ensure that
only the correct operators for the keywords data type are represented in the operator drop-
down list.
Value
The field below the Value list allows you to enter the exact value used in the comparison. After
typing the value, click Add to move it to the list box. To remove a value from the list box,
select the name and click Delete.
Allow Wildcards
The Allow Wildcards check box is another option for rules that check keyword values. When
using wildcards, you can use the? (question mark) wildcard to replace a specific number of
characters. For example, a value of COLUMB ?? succeeds for COLUMBUS, COLUMBIA and any
other eight-character keyword value beginning with COLUMB. The * (asterisk) wildcard
represents an indefinite number of characters. COLUMB* succeeds for any length keyword
values beginning with COLUMB, such as those mentioned above and COLUMBO and
COLUMBIANA.
Note: The Allow Wildcards check box is only enabled for Alphanumeric Keyword Types.
Wildcards can be used with Alphanumeric Keyword Types that have masking configured.
When masking is used, the ? wildcard must be used. The * symbol does not work for spaces
or masking symbols.
Note: For any operator except <> (not equal), the rule evaluates to FALSE if the document
has no keywords of the Keyword Type being checked. This can occur if the Keyword Type is
not assigned to the Document Type to which the document belongs or if the document does
not have any keyword values for the Keyword Type. For the "<>" operator, the rule will
evaluate to TRUE for this scenario. When there are several Keyword Types, for all operators
except <>" (not equal), the rule evaluates to TRUE if there is at least one Keyword Value
that meets the condition. For <>", the rule evaluates to TRUE only if all keywords are
different from the specified Keyword Value.
Note: This rule does not compare Keyword Type values that have different currency formats
based on actual monetary value. If the currency format of a keyword value on a document is
different from the currency format specified in the rule, the rule evaluates to FALSE for this
keyword even if the numerical value is equal, unless the operator used is <>. Using the <>
operator will evaluate to TRUE because the values are not equal. For example, if the value of
a keyword on a document is $1.00 and the rule is evaluating the Keyword Type = to 1 Euro,
the result of the rule is FALSE because the currency formats differ.
Keyword Type
2012 Hyland Software, Inc.
644
OnBase 12 Workflow
For all rules evaluating keywords, you must provide the system with the Keyword Type to
check. For these rules, a Keyword Type drop-down select list appears.
Note: The Allow Wildcards check box is only enabled for Alphanumeric Keyword Types.
Wildcards can be used with Alphanumeric Keyword Types that have masking configured.
When masking is used, the ? wildcard must be used. The * symbol does not work for spaces
or masking symbols.
Note: Comparison related to case sensitivity is determined by the case sensitive setting of the
Keyword Type on the primary document. If the primary documents Keyword Type is case
sensitive, the comparison is case sensitive.
Note: This rule will always return FALSE if one of the keywords to be compared is blank or
missing.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
2012 Hyland Software, Inc.
645
Workflow OnBase 12
Under the Related Documents heading, the status of the related documents configuration is
displayed.
Configuration Module Rules Descriptions
Note: When a Workflow rule evaluates related documents, as soon as the rule encounters one
related document that evaluates True for the rules condition, the rule evaluates as True and
the True logic is executed. If all related documents evaluate to False, then the False logic is
executed.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle property as
the common denominator between the current and related document. When selected, the
Related Document Type and Common Keyword Types cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values on the current
document, the rule will evaluate true if any related document matches the existing value in
the common Keyword Type.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any one of the values contained for that Keyword Type on the current
document (as well as the other common keywords designated) for the rule to succeed. To
enable this feature for a common keyword, click the check box to the left of the Keyword Type
name after the common keyword(s) have been added. If this option is disabled, the related
document must match all values for a given Keyword Type if it contains multiple values on a
primary document.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
2012 Hyland Software, Inc.
646
OnBase 12 Workflow
Folder Type
This drop-down select list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values on the current
document, the rule will evaluate true if any folder of the assigned folder type has a matching
value for the common Keyword Type. Common Keyword Types for Folder Types are
configured in Folder Type configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
Associated Primary Document (Applicable to Work Folder documents only)
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If a rule that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or
System Tasks), the following message is displayed in the Diagnostics Console, the rule
evaluates to "False", and the remainder of the task list continues execution: "Relationship
type is only valid for tasks executed via drag and drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
2012 Hyland Software, Inc.
647
Workflow OnBase 12
When this option is checked, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
Configuration Module Rules Descriptions
message is logged to the Workflow Trace stating that "Related Document Query aborted:
primary document does NOT have all common keywords present".
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Note: The Lock Related Document check box is always disabled for rules.
Note: This rule will always return FALSE if one of the keywords to be compared is blank or
missing.
2012 Hyland Software, Inc.
648
OnBase 12 Workflow
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
Under the Related Documents heading, the status of the related documents configuration is
displayed.
Note: When a Workflow rule evaluates related documents, as soon as the rule encounters one
related document that evaluates True for the rules condition, the rule evaluates as True and
the True logic is executed. If all related documents evaluate to False, then the False logic is
executed.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle property as
the common denominator between the current and related document. When selected, the
Related Document Type and Common Keyword Types cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values on the current
document, the rule will evaluate true if any related document matches the existing value in
the common Keyword Type.
2012 Hyland Software, Inc.
649
Workflow OnBase 12
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any one of the values contained for that Keyword Type on the current
Configuration Module Rules Descriptions
document (as well as the other common keywords designated) for the rule to succeed. To
enable this feature for a common keyword, click the check box to the left of the Keyword Type
name after the common keyword(s) have been added. If this option is disabled, the related
document must match all values for a given Keyword Type if it contains multiple values on a
primary document.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down select list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values on the current
document, the rule will evaluate true if any folder of the assigned folder type has a matching
value for the common Keyword Type. Common Keyword Types for Folder Types are
configured in Folder Type configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
Associated Primary Document (Applicable to Work Folder documents only)
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If a rule that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or
System Tasks), the following message is displayed in the Diagnostics Console, the rule
evaluates to "False", and the remainder of the task list continues execution: "Relationship
type is only valid for tasks executed via drag and drop from the work folder"
2012 Hyland Software, Inc.
650
OnBase 12 Workflow
Note: This option is not supported in the Classic Client Workflow interface.
When this option is checked, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that "Related Document Query aborted:
primary document does NOT have all common keywords present".
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Note: The Lock Related Document check box is always disabled for rules.
This rule evaluates whether or not an AutoFill Keyword Set exists that has the same value(s)
for the specified Keyword Type(s) associated with the currently displayed document.
Autofill Keyword Set drop-down select list allows the selection of the AutoFill Keyword Set type
to check values.
Based on your selection in the Autofill Keyword Set drop-down select list, the First Keyword
Type to Search field will be populated with the primary Keyword Type associated with the
AutoFill Keyword Set. The value from the currently selected document will be used for the
search.
The Second Keyword Type (Optional) drop-down select list allows you to further identify the
AutoFill Keyword Set that you want to evaluate. It is optional to use a secondary Keyword
Type. The value from the currently selected document will be used for the search.
2012 Hyland Software, Inc.
651
Workflow OnBase 12
This rule checks for a specified value in an AutoFill Keyword Set that also has the same
value(s) for the specified Keyword Type(s) associated with the currently displayed document.
Autofill Keyword Set drop-down select list allows the selection of the AutoFill Keyword Set type
to check values.
Based on your selection in the Autofill Keyword Set drop-down select list, the First Keyword
Type to Search field will be populated with the primary Keyword Type associated with the
AutoFill Keyword Set. The value from the currently selected document will be used for the
search.
The Second Keyword Type (Optional) drop-down select list allows you to further identify the
AutoFill Keyword Set that you want to evaluate. It is optional to use a secondary Keyword
Type. The value from the currently selected document will be used for the search.
The Keyword Type to Check drop-down select list allows the selection of the Keyword Type that
exists within the AutoFill Keyword Set that you want to check for a specific value. The value of
this Keyword Type and the Keyword Type(s) selected to search for will result in a true or false
return.
Operator
The default operator is = (equal), which indicates that the keyword value of the document
must match the value entered in the field. The selection of operators available from the drop-
down list varies for the keyword type selected. Select the keyword type first, to ensure that
only the correct operators for the keywords data type are represented in the operator drop-
down list.
Value
The field below the Value list allows you to enter the exact value used in the comparison. After
typing the value, click Add to move it to the list box. To remove a value from the list box,
select the name and click Delete.
Allow Wildcards
The Allow Wildcards check box is another option for rules that check keyword values. When
using wildcards, you can use the? (question mark) wildcard to replace a specific number of
characters. For example, a value of COLUMB ?? succeeds for COLUMBUS, COLUMBIA and any
other eight-character keyword value beginning with COLUMB. The * (asterisk) wildcard
represents an indefinite number of characters. COLUMB* succeeds for any length keyword
values beginning with COLUMB, such as those mentioned above and COLUMBO and
COLUMBIANA.
Note: The Allow Wildcards check box is only enabled for Alphanumeric Keyword Types.
Wildcards can be used with Alphanumeric Keyword Types that have masking configured.
When masking is used, the ? wildcard must be used. The * symbol does not work for spaces
or masking symbols.
2012 Hyland Software, Inc.
652
OnBase 12 Workflow
Note: If you make a selection in the Keyword Type to Check drop-down select list, add values,
then change your selection in the Keyword Type to Check drop-down select list, if the data type
This rule will evaluate a date data type keyword. This rule checks for a specified relationship
or test value in an AutoFill Keyword Set that also has the same value(s) for the specified
Keyword Type(s) associated with the currently displayed document.
Autofill Keyword Set drop-down select list allows the selection of the AutoFill Keyword Set type
to check values.
Based on your selection in the Autofill Keyword Set drop-down select list, the First Keyword
Type to Search field will be populated with the primary Keyword Type associated with the
AutoFill Keyword Set. The value from the currently selected document will be used for the
search.
The Second Keyword Type (Optional) drop-down select list allows you to further identify the
AutoFill Keyword Set that you want to evaluate. It is optional to use a secondary Keyword
Type. The value from the currently selected document will be used for the search.
The Keyword Type to Check drop-down select list allows the selection of the Keyword Type that
exists within the AutoFill Keyword Set that you want to check for a specific value. The value of
this Keyword Type and the Keyword Type(s) selected to search for will result in a true or false
return.
For the second value, you can select Current Date or Current Date/Time to compare the first
value against. You can select Specific Value and enter a specific date to compare the first
value against. You can select a Keyword Type from the Keyword Value drop-down select list to
compare the value.
A comparison relationship between the two values can be configured. You can specify the
number of days, business days, hours, or minutes to use in the comparison in the Number of
Periods N field and the Period drop-down select list.
Note: Business Day(s) is only available from the Period drop-down select list if a Work
Calendar has been assigned to the life cycle.
Note: If both of the values being compared are not date/time values and hours or minutes is
selected, this will evaluate false because only the date is evaluated.
Note: This setting is not applicable for all comparison options. When it is not applicable, the
fields will become disabled.
2012 Hyland Software, Inc.
653
Workflow OnBase 12
Select a comparison option from the drop-down select list. The options are as follows:
Configuration Module Rules Descriptions
Option Description
D1 is more than N Time Periods before D2 This option is dependent on the number of
periods and the interval of the time period set.
The comparison checks to see if the first value
occurs in time before the second value in more
than the time period specified
For example, if you set the time period to 2 days,
in order for this rule to return true, value 1 would
be more than 2 days before value 2.
D1 is fewer than N Time Periods before D2 This option is dependent on the number of
periods and the interval of the time period set.
The comparison checks to see if the first value
occurs in time before the second value in less
than the time period specified.
For example, if you set the time period to 2 days,
in order for this rule to return true, value 1 would
be less than 2 days before value 2.
D1 is fewer than N Time Periods after D2 This option is dependent on the number of
periods and the interval of the time period set.
The comparison checks to see if the first value
occurs in time after the second value in less than
the time period specified.
For example, if you set the time period to 2 days,
in order for this rule to return true, value 1 would
be less than 2 days after value 2.
D1 is more than N Time Periods after D2 This option is dependent on the number of
periods and the interval of the time period set.
The comparison checks to see if the first value
occurs in time after the second value in more
than the time period specified.
For example, if you set the time period to 2 days,
in order for this rule to return true, value 1 would
be more than 2 days after value 2.
2012 Hyland Software, Inc.
654
OnBase 12 Workflow
Note: This rule applies only to queues containing SYS Workflow Chart documents, which are
used to route OnBase charts through Workflow. OnBase charts require one of the following
licenses: HL7, Medical Records Management Solution, or Signature Deficiencies for Epic.
1. From the Chart Data drop-down, select the chart data to evaluate using this rule.
2. From the Operator drop-down, select the operator to use when comparing the charts
value against the value configured for the rule. Available operators are equal to (=)
and not equal to (<>).
3. If necessary, select Allow Wildcards to enable the use of wildcards (* or ?) in the value
configured for the rule.
4. In the field below the Compare To list, type the value2 to compare against the selected
chart data field. If the chart satisfies the configured conditions, the rule is evaluated as
TRUE.
5. Click Add.
6. Repeat for each chart field you want to evaluate.
7. Click Apply.
1. To maintain a patients unit history, you must turn on chart column tracking for the Unit Name
chart data field.
2. OnBase stores a charts Patient Sex as a numeric value. If you are using this rule to check the
Patient Sex on charts, enter a numeric value using this convention: 0 for Unknown, 1for Male, 2
for Female, 3 for Other, 4 for Ambiguous, 5 for Not Applicable.
2012 Hyland Software, Inc.
655
Workflow OnBase 12
Note: This rule applies only to queues containing SYS Workflow Chart documents, which are
used to route OnBase charts through Workflow. OnBase charts require one of the following
licenses: HL7, Medical Records Management Solution, or Signature Deficiencies for Epic.
1. Under Date Value D1, select the option to use as the first date value (D1).
Queue Entry Value Select to use the date that the chart entered this queue as D1.
The queue entry time is logged using the database servers time.
Chart Data Value Select to use one of the following chart values as D1:
Admit Date
Discharge Date
Patient Date of Birth
2012 Hyland Software, Inc.
656
OnBase 12 Workflow
Chart Data Value Select to use one of the following chart values as D2:
Relationship Description
D1 is more than N Time Select if the rule is TRUE when D1 is more than the specified
Periods before D2 number of periods before D2. When you select this option, the
Number of Periods N field and Period drop-down become
available.
For example, if you set the time period to 2 days, in order for this
rule to return true, D1 must be more than 2 days before D2.
D1 is fewer than N Time Select if the rule is TRUE when D1 is fewer than the specified
Periods before D2 number of periods before D2. When you select this option, the
Number of Periods N field and Period drop-down become
available.
For example, if you set the time period to 2 days, in order for this
rule to return true, D1 must be fewer than 2 days before D2.
D1 is fewer than N Time Select if the rule is TRUE when D1 is fewer than the specified
Periods after D2 number of periods after D2. When you select this option, the
Number of Periods N field and Period drop-down become
available.
For example, if you set the time period to 2 days, in order for this
rule to return true, D1 must be fewer than 2 days after D2.
D1 is more than N Time Select if the rule is TRUE when D1 is more than the specified
Periods after D2 number of periods after D2. When you select this option, the
Number of Periods N field and Period drop-down become
available.
For example, if you set the time period to 2 days, in order for this
rule to return true, D1 must be more than 2 days after D2.
2012 Hyland Software, Inc.
657
Workflow OnBase 12
4. If you selected an option that uses an N comparison, the Number of Periods N field and
Period drop-down become available.
a. In the Number of Periods N field, type the number of periods to use when comparing
Configuration Module Rules Descriptions
D1 and D2.
b. From the Period drop-down, select the unit for the time period. Available options are
Year(s), Month(s), and Day(s). If the rule is part of a life cycle that is assigned a
Work Calendar, then Business Day(s) is also available.
5. Click Apply.
Note: This rule applies only to queues containing SYS Workflow Chart documents, which are
used to route OnBase charts through Workflow. OnBase charts require one of the following
licenses: HL7, Medical Records Management Solution, or Signature Deficiencies for Epic.
For the second value, you can select Current Date or Current Date/Time to compare the first
value against. You can select Specific Value and enter a specific date to compare the first value
against. You can select a Keyword Type from the Keyword Value drop-down select list to
compare the value.
You can enter a property in the Property Name field to compare the value with a property.
2012 Hyland Software, Inc.
658
OnBase 12 Workflow
A comparison relationship between the two values can be configured. You can specify the
number of days, business days, hours, or minutes to use in the comparison in the Number of
Note: Business Day(s) is only available from the Period drop-down select list if a Work Calendar
has been assigned to the life cycle.
Note: If both of the values being compared are not date/time values and hours or minutes is
selected, this will evaluate false because only the date is evaluated.
Note: This setting is not applicable for all comparison options. When it is not applicable, the
fields will become disabled.
Select a comparison option from the drop-down select list. The options are as follows:
Option Description
D1 is more than N Time Periods before D2 This option is dependent on the number of
periods and the interval of the time period set.
The comparison checks to see if the first value
occurs in time before the second value in more
than the time period specified
For example, if you set the time period to 2 days,
in order for this rule to return true, value 1 would
be more than 2 days before value 2.
D1 is fewer than N Time Periods before D2 This option is dependent on the number of
periods and the interval of the time period set.
The comparison checks to see if the first value
occurs in time before the second value in less
than the time period specified.
For example, if you set the time period to 2 days,
in order for this rule to return true, value 1 would
be less than 2 days before value 2.
D1 is fewer than N Time Periods after D2 This option is dependent on the number of
periods and the interval of the time period set.
The comparison checks to see if the first value
occurs in time after the second value in less than
the time period specified.
For example, if you set the time period to 2 days,
in order for this rule to return true, value 1 would
be less than 2 days after value 2.
2012 Hyland Software, Inc.
659
Workflow OnBase 12
Option Description
D1 is more than N Time Periods after D2 This option is dependent on the number of
Configuration Module Rules Descriptions
When Property Name is selected for the first value, the Property [D1] as DATETIME, if selected;
otherwise, as DATE. option is enabled. This option will specify that the defined property is a
date/time value. When this is not selected, the property is defined as a date value.
If the property (specified in the first field) contains an array value then each value in the array
is checked. If any of those values matches the condition the rule evaluates to true.
If the Date Value D2 property value contains an array, then the value is compared to each
value in the array.
Allows you to evaluate the value of the property specified in the Property Name field.
The Operator drop-down select list allows you to select the operator to use during the
evaluation.
The Case insensitive comparison check box allows you to specify whether or not you want the
evaluation to be case sensitive.
You can compare the property value to either a Keyword Type and/or a constant value. To use
a Keyword Type value for comparison, select the Keyword type check box and select the
appropriate Keyword Type from the drop-down select list.
Constant values can also be used for evaluation. Type the value you want to use and click
Add.
2012 Hyland Software, Inc.
660
OnBase 12 Workflow
If the property contains an array of values, then the rule evaluates to true if any one of those
values matches the condition.
Allows you to determine if a property with the name specified in the Property Name field
exists.
SYS - Audit/Sample
2012 Hyland Software, Inc.
661
Workflow OnBase 12
Moves the specified percentage of documents evaluated down one path and the remaining
documents down another path. Specify the percentage chance each document has of being
audited. A Percent to Pass of 40% in the Rule Fields section means each document has a 40%
Configuration Module Rules Descriptions
Note: If you select a queue that is a Match Keyword to User Name Load Balancing Queue, upon
selection of the Assigned to (Keyword Specified) option, the drop-down select list is disabled
and is automatically populated with the Keyword Type assigned at the queue level.
2012 Hyland Software, Inc.
662
OnBase 12 Workflow
SYS - Check Last Execution Results can also be used to evaluate the last action in a Workflow
when that action originates from an external program such as Application Enabler. For
example, upon cancelling indexing via a mouse or keyboard event defined in Application
Caution: When used against a notification and a notification is sent to an e-mail address that is
outside of the internal server (example: person@company.com), when checked to see if the
notification action was performed successfully, it will always return a true value.
Caution: If multiple messages are sent using IDSMail and one of the messages is sent to an
invalid e-mail address, it returns a false value.
Caution: If multiple messages are sent using MAPI (dmmailservice.dll) and one of the messages
is sent to an invalid address, but others are successfully sent, it returns a true value.
Calls a custom dll function to determine if the rule should evaluate to TRUE for the current
document. The DLL function should implement application-specific logic for your domain. The
function signature should match the following format: int (CALLBACK* DLLEXITPROC)(long
nRuleNum, long nDocumentHandle, long nDocumentTypeNum)
OnBase passes the current rule number, the current Document Handle, and the Document
Type ID to the function. The return value for the function should be TRUE for success, FALSE
for failure, or IDCANCEL to abort processing of the current document.
DLL Name
Type the name of your system DLL in the DLL Name field. This is a required field.
Function Name
Type the name of the function to call in the Function Name field. This is a required field.
Note:It can also have any name you choose, with a maximum length of 30 characters.
Performs an evaluation of the current active document in the queue specified in the Queue
drop-down select list to determine if the document is currently assigned to a user.
2012 Hyland Software, Inc.
663
Workflow OnBase 12
If you want to check if the currently logged on user is assigned to the item or if a user group
to which the user belongs is assigned to the item, select <Current User> from the Assigned to
User, User Group, or Role drop-down select list. If you want to see if any user is assigned to the
Configuration Module Rules Descriptions
SYS - Executed In
Allows task lists to be executed based on the interface in which the action is being executed.
You can select Classic Client or Core-based interfaces to determine which interface this rule
will be evaluated true. Actions can then be configured for the true and false cases.
Note: This action is not supported in the OnBase Mobile Access for BlackBerry or Mobile
Access for Windows Phone interfaces.
Displays a question box and prompts the user to select a button for his or her response. Type
the question to present to the user in the Question Text box in the rule fields section. The
question should be posed to allow for yes/no true/false answers.
Click inside the field and type the symbol or click the symbols button to add it to the Question
Text.
Select a Keyword Type from the Keyword Type drop-down list and enter the Keyword Type
instance in the Repeat field. Click Keyword and the Keyword Value will appear in the Question
Text.
If you have two values for a Keyword Type, you can add multiple Keyword Types to the
Question Text. Type the number, 2, in the Repeat field, select the Keyword Type from the
Keyword Type field and the Keyword Type will appear twice into the Question Text field.
Symbols Used
Space- - Adds a space, a hyphen, and another space to separate the different
Space symbols ( - ).
Doc Date %D Adds the current documents date stored value into the system.
User %U Displays the User Name of the user who is currently logged in.
Time %I1 Adds the time that the current document was stored into the system.
Stored This value cannot be modified.
2012 Hyland Software, Inc.
664
OnBase 12 Workflow
Note: This symbol is only applicable when used with an Institutional Database.
%C Displays the name of the user who created the current document.
%D1 Displays the date that the document was stored. This value cannot be changed.
%I1 or %T Displays the time that the document was stored. This value cannot be changed.
%K###.n Displays the Keyword Value of Keyword Type ### n times. For example, %K101.4
would display up to 4 unique Keyword Values for Keyword Type 101 for a single
document.
For some functionality, a Keyword Type drop-down list may be available to
configure this. Select a Keyword Type from the drop-down select list, enter the
number of times you want the Keyword Value to be displayed in the Repeat field,
and click Keyword. The value in the Repeat field specifies how many instances of
the Keyword Value will be displayed. Entering an * character will pull all existing
Keyword Values for display up to 99 instances.
Note: When using the Classic Client interface, double digits in the Repeat field are
not supported.
%M Extracts metadata values from items. This includes attribute values from Workview
objects or a field values from an Entity item.
%M must be followed by the metadata value you want to extract. For example, if
you want to extract the value of a WorkView attribute called Name, it would be
%MName.
The token strings can contain nested expressions. Example, a nested WorkView
attribute: %MVendor.Buyer.Name.
%R Displays the real user name (if configured) of the user who created the current
document. If a real user name is not configured, a blank space will be displayed.
2012 Hyland Software, Inc.
665
Workflow OnBase 12
Symbol Description
%U Displays the user name of the currently logged in user who executed the task.
Configuration Module Rules Descriptions
%V### Displays the value of a configured Workflow property. For example, to display the
value for the property Color, this symbol would be configured %VColor.
Note: If a property name has spaces, using %V to display the property value alone
will not preserve the spaces, and therefore, the property will not be correctly
identified. When %V is used with a property name containing space in conjunction
with a formatting code, the property will be identified. %C(VProperty Name) would
be an example of property with spaces that will be identified correctly with the first
letter capitalized. This formatting option are available for the following actions:
Prompt User with Question Box/SYS - Prompt User with Question Box, Create Note/
Doc - Create Note on This Document/Related Document, Display Message Box/
Notify - Display Message Box, and Custom Log Entry/SYS - Custom Log Entry.
The following symbols are not supported in the Classic Client interface:
%L [life cycle ID]
%L2 [life cycle name]
%Q [queue ID]
%Q2 [queue name]
%M [item metadata value] is not supported in the Classic OnBase Client interface or the
Core-Based OnBase Client interface.
The question is displayed in the User Interaction window while a document is displayed in the
viewer. The response can then be stored as a keyword by selecting a Keyword Type from the
Key Type To Store Answer drop-down list.
Note: If the answer is stored in a numeric Keyword Type, the affirm button will store 1 as the
value, the deny button will store 0 as the value, and the abort button will not store any value.
Also, the abort button does not store any value when the answer is stored in an alphanumeric
Keyword Type.
You can type your own text into the Affirm Button Text, Deny Button Text and Abort Button Text
edit fields or you can choose the default responses. Whichever option you choose, the
question should be worded in such a way that the buttons clearly answer the question. The
button text for these three buttons is limited to 24 characters.
When the user selects the abort button, all Workflow processing stops for the current
document. If you would like only the current task to be aborted, check the Abort Applies Only
to Current Task List check box. The other task lists continue processing with the current
document.
You can also choose to turn off the abort option, which will force the user to affirm or deny the
task, by selecting the Hide Cancel Button check box.
2012 Hyland Software, Inc.
666
OnBase 12 Workflow
Performs an evaluation of the related document of the current active document in the queue
specified in the Queue drop-down select list to determine if the document is currently
assigned to a user.
Related Documents
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Under the Related Documents heading, the status of the related documents configuration is
displayed.
Note: When a Workflow rule evaluates related documents, as soon as the rule encounters one
related document that evaluates True for the rules condition, the rule evaluates as True and
the True logic is executed. If all related documents evaluate to False, then the False logic is
executed.
Note: Some fields will only become enabled after you have selected a method to relate
documents.
Document Handle
This option causes the system to use the value contained in the Document Handle property as
the common denominator between the current and related document. When selected, the
Related Document Type and Common Keyword Types cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
2012 Hyland Software, Inc.
667
Workflow OnBase 12
After you select the related Document Type, click Common Keyword. The Related Document
Query dialog box opens. To add Keyword Types to the list, select the Keyword Type in the list
and click Add. To remove a Keyword Type from the list, select the keyword and click Remove.
Configuration Module Rules Descriptions
The Document Types with these Keyword Types are evaluated when this action executes.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values on the current
document, the rule will evaluate true if any related document matches the existing value in
the common Keyword Type.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any one of the values contained for that Keyword Type on the current
document (as well as the other common keywords designated) for the rule to succeed. To
enable this feature for a common keyword, click the check box to the left of the Keyword Type
name after the common keyword(s) have been added. If this option is disabled, the related
document must match all values for a given Keyword Type if it contains multiple values on a
primary document.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down select list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values on the current
document, the rule will evaluate true if any folder of the assigned folder type has a matching
value for the common Keyword Type. Common Keyword Types for Folder Types are
configured in Folder Type configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
2012 Hyland Software, Inc.
668
OnBase 12 Workflow
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If a rule that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the rule evaluates to
"False", and the remainder of the task list continues execution: "Relationship type is only valid
for tasks executed via drag and drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is checked, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that "Related Document Query aborted:
primary document does NOT have all common keywords present".
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Note: The Lock Related Document check box is always disabled for rules.
If you want to check if the currently logged on user is assigned to the item or if a user group
to which the user belongs is assigned to the item, select <Current User> from the Assigned to
User, User Group, or Role drop-down select list. If you want to see if any user is assigned to the
item, select <Any>.
2012 Hyland Software, Inc.
669
Workflow OnBase 12
Runs a script specified in the Script drop-down select list. OnBase examines the value of the
ExecutionStatus property. A return value of 0 is failure, any other value is success. For this
rule to work properly, the ExecutionStatus property must be set for all possible outcomes of
the script.
Note: When using the Core-based OnBase Client interface and running VBScripts on the client
side and a property bag is used, the property bag will be synchronized between the server
and client prior to executing the script, and again following the execution of the script. This
will insure that property bag values residing on the server will be available to use on the client
side during script execution. These same property bag values, if changed during the script
execution on the client side, will be available in the Core after execution. Synchronizing the
property bag does not support deleting a property value from the property bag. If a property
value is deleted during script execution on the client, the property value will not be removed
from the property bag on the server side when next synchronization occurs. Only scalar
property values are supported for synchronization. If a property holds an interface pointer to
a class instance we will not synchronize these types of properties. Synchronization is not
supported when Timer work is performed on the client side.
2012 Hyland Software, Inc.
670
OnBase 12 Workflow
2012 Hyland Software, Inc.
671
Workflow OnBase 12
Configuration Module Rules Descriptions
2012 Hyland Software, Inc.
672
USING MULTI-INSTANCE GROUPS WITH BEGIN/END
KEYWORD RECORD
This information is pertinent to the Key - Begin Keyword Record and Key - End Keyword Record
actions. These actions avoid any ambiguity when adding keywords to documents with Multi-
Instance Keyword Type Group (MIKG). These actions should be applied when working with
documents assigned a Keyword Record Set.
Example
The Job Description Multi-Instance Keyword Type Group consists of three Keyword Types:
Position, Department, and Salary.
The following three tasks are configured:
Set Position task consists of a single action of Key - Add Keyword type that adds
Position keyword = Manager
Set Department task consists of a single action of Key - Add Keyword type that
adds Department keyword = Sales
Set Salary task consists of a single action of Key - Add Keyword type that adds
Salary keyword = 40000
2012 Hyland Software, Inc.
673
Workflow OnBase 12
If executed as three separate ad hoc tasks on one document, this document will have three
Job Description MIKGs:
Using Multi-Instance Groups with Begin/End
If we create one ad hoc task, Set Job Description, consisting of these three tasks, and
execute it, then the document will have one Job Description record:
2012 Hyland Software, Inc.
674
OnBase 12 Workflow
2012 Hyland Software, Inc.
675
Workflow OnBase 12
This will result in document having one Name Multi-Instance Keyword Type Group with
First Name = Ann and Last Name = White. The second value for Last Name overrides
Using Multi-Instance Groups with Begin/End
the first.
Keyword Record
2012 Hyland Software, Inc.
676
OnBase 12 Workflow
If Last Name was not part of Multi-Instance Keyword Type Group both Keyword Values
would be added.
For example, in the following sequence, the check for State = Ohio would evaluate to
False:
Task List:
Action Begin Keyword Record (Address)
Action Add Keyword: State = Ohio
Rule Check KW: If (State = Ohio) .
Action End Keyword Record
2012 Hyland Software, Inc.
677
Workflow OnBase 12
Between Begin Keyword Record and End Keyword Record means after executing Begin
Keyword Record but before executing End Keyword Record. The following configuration
Using Multi-Instance Groups with Begin/End
Example
Begin Keyword Record
Some Rule
Keyword Record
On Success:
Some Actions
End Keyword Record
On Failure:
Another Rule
On Success:
Some Action
End Keyword Record
On Failure:
End Keyword Record
Or
Task List1
Task List 2
Begin Keyword Record
Task List 3
End Keyword Record
However to prevent ambiguity, it is strongly recommended that the whole sequence (Begin,
Add Keyword, Add Another Keywords, End) be in one place whenever possible and not
overly nested.
2012 Hyland Software, Inc.
678
ORG CHARTS AND CALENDARS
When Workflow is configured to use Org Charts and Calendars, it gains the ability to more
efficiently route documents to users. The capability of the Calendar allows Workflow to
determine business holidays as well as individual employee vacation days. When joined with
an Org Chart, the capability expands to route documents automatically according to both
employee hierarchy and availability.
Roles-A role is a label for a function that an employee serves in an organization. For example,
employee Team Lead can serve in a proofreader role. Your organization may not have an
actual proofreader position; the role is filled by an existing employee. It is possible for one
employee to serve several roles. Multiple employees may also share one role. A role is a title
that unifies a group of individual users without any security implications. Privileges and rights
are still maintained by the user group that the user belongs to, regardless of his or her role.
Note: An employee does not need to directly report to the manager that s/he is an assistant
to. An employee may serve in the role of assistant for several other managers in an
organization.
Manager - A manager is a user that is configured with reports within the Org Chart hierarchy.
Ad Hoc Managers-When a Queue is configured for Manager coverage, if an Ad Hoc Manager is
assigned to a user and the user is unavailable, the Ad Hoc Manager will see the documents for
that user in the coverage Queue, instead of the Manager in the configured tree structure of
the Org Chart. The Ad Hoc Manager may be anyone within the Org Chart; not necessarily
someone in the reporting hierarchy.
2012 Hyland Software, Inc.
679
Workflow OnBase 12
Product Rights
The Org Chart product right is required to access the Org Chart | Org Charts menu in the
Configuration module.
The Calendar product right is required to access the Org Chart | Calendars menu in the
Configuration module.
Org Charts and Calendars
1. In the Configuration module, select Org Chart | Org Charts. This displays the Org Charts
dialog box. Type the name of the Org Chart.
2. You will be prompted to select a root user, or topmost-ranking employee, from the
Choose Root menu.
Note: If working in an Institutional Database, you will be prompted to assign the Org Chart to
an Institution.
2012 Hyland Software, Inc.
680
OnBase 12 Workflow
3. After selecting the root employee, click Settings on the Org Charts dialog box. This
displays the Org Chart Configuration dialog box. The employee selected as root user is
displayed at the top of the chart.
2012 Hyland Software, Inc.
681
Workflow OnBase 12
4. Right-click on the employees name to display the right-click menu for that employee.
Add Reports When this option is selected, the Add Reports dialog box is displayed.
Select the user(s) to report to the selected employee from the Available
Org Charts and Calendars
Users field. Double-click the user name or select the Add>> button to
add the user as a report. For example, one might choose employees
MANAGER and ASSOCIATE MANAGER to report to employee VICE
PRESIDENT. There is no limit to the amount of subordinate reports an
employee may have.
You can click the Display User Names or Display Real Names button to
toggle the way the users are displayed within the dialog box.
Note: If real names are displayed, but a user does not have a real name,
the dialog box will display the user name in double square brackets, for
example [[MANAGER]]. These names will be placed at the end of the
users list.
Note: Once a user has been configured as a report, the user name cannot
be removed via the Add Reports dialog box. It must be removed using the
Delete User right click option.
Note: Both the root employee and reports will have icons to the left
of the user name.
Note: When no more eligible reports are left, the Add Reports dialog box
will be disabled as well as the Replace User menu option.
Add Assistant When this option is selected, the chosen user will act as assistant to the
2012 Hyland Software, Inc.
682
OnBase 12 Workflow
When the Sys - Assign to User and Sys - Assign Related to User actions
Note: The Ad Hoc Manager may be anyone within the Org Chart; not
necessarily someone in the reporting hierarchy.
Delete User This option deletes the selected user from the Org Chart. If an assistant is
selected, the assistant will be deleted. If you select to delete an employee
with reports, two options will be displayed:
Report to Manager - employees will report to the next higher-ranking
manager on the Org Chart
Remove from Org Chart - the selected employee, plus all subordinate
reports, will be removed from the Org Chart.
2012 Hyland Software, Inc.
683
Workflow OnBase 12
Locate User This option allows you to locate any user configured in the Org Chart.
When this option is selected, the Locate User dialog box is displayed.
Select the user you wish to locate in the Org Chart from the Available
User(s) drop-down select list and click OK.
Org Charts and Calendars
Note: Only those users configured for the particular Org Chart are
available for selection.
The selected users name will be selected and display in boldface in the
Org Chart. In the case of multiple instances of a user name, the Org Chart
will be expanded to display all of them. The last instance of the user name
will be selected.
Replace User This option will replace the selected user with another employee.
Assign Roles Selecting this option allows you to assign roles to a particular employee.
Employees may have no roles, one role, or multiple roles assigned.
Note: Roles will not appear in the Org Chart diagram. In order to view a
users assigned roles, you must right-click on the user name.
Expand Tree Selecting this option expands the Org Chart configuration tree diagram.
Collapse Tree Selecting this option collapses the Org Chart configuration tree diagram.
2012 Hyland Software, Inc.
684
OnBase 12 Workflow
A configured Org Chart for a small department might look like this:
Creating Roles
A role is a specific function an employee will perform. For example, an employee who is at the
Manager level in the hierarchy of the Org Chart may be assigned a role of Human Resources
Manager or Project Approval.
2012 Hyland Software, Inc.
685
Workflow OnBase 12
1. In the Configuration module, select Users | Roles. The Roles dialog box displays.
Org Charts and Calendars
1. In the Org Chart Configuration dialog box, right-click on the user whom you wish to
assign a role.
2. Select Assign Roles.
3. Select the role and click the > arrow button to designate the role for that particular
user. You may assign multiple roles through this dialog box.
2012 Hyland Software, Inc.
686
OnBase 12 Workflow
Note: If a user is deactivated, the user will be removed from any roles s/he is configured for.
5. Click Save. Upon clicking Save, a message asking There is at least one user having been
added or removed for each of the role(s) <Name of Role>. The role(s) might have been
The rest of the Org Chart configuration takes place through Workflow configuration.
Calendar Concepts
Without Calendar functionality, the main purpose of Org Charts exists in load balancing. Org
Charts, even without Calendars, enable Workflow to balance queues based upon user
organization chart hierarchy. When Calendars are also configured to work with the Org
Charts, Workflow can sort through documents based on employee availability, in addition to
role.
Business Calendars
Business calendars can be configured for the business days of a company and be used by
timers and check date rules. Shift Calendars can be configured to utilize Workflows Coverage
queue feature. This calendar would be configured to account only for holidays and shutdowns
that apply to the entire business.
All Calendar usage is based off of Business Calendars. Calendars can be configured for
different purposes.
Shift Calendars
A calendar can also be configured as a Shift Calendar. This Shift Calendar can be applied to a
Coverage queue, which is explained in greater detail below. To account for variances in
individual users schedules, lists of days off can be configured for each user and applied to a
Shift Calendar. This can further refine load-balancing through Coverage queues.
Coverage Queue
A Coverage queue will work exactly like any other queue in Workflow, but adds the
previously-discussed coverage support. When a user opens a Coverage queue, s/he will see
any documents assigned to her/him as well as any documents from unavailable employees
that s/he is covering for. For example, if User A is configured to cover for User B in case of
absence, User A will see any documents of User Bs when User B is unavailable. In Coverage
queues, the document count takes into account both traditionally assigned and covered
documents.
2012 Hyland Software, Inc.
687
Workflow OnBase 12
Business Days
It is important to have a thorough understanding of how the system counts business days
before configuring any calendars. The following points apply to business days:
When counting the number of business days between two dates or times (such as
when using Rules involving dates), the system counts only full work days between
those times. For example, if the Calendar is configured for a 9am to 5pm work day,
Org Charts and Calendars
and a document arrives in-system at noon on Monday, the document will have spent
one full business day in queue at 5:01 Tuesday evening. Although the document
spent time in the queue on Monday, only Tuesday was a full work day. Any timers
configured to fire off at 5:01 will take that document under consideration. Therefore
the document is processed after the first full work day.
Note: Coverage settings are only available for load-balanced queues in which users are
configured as Members. However, a user does not have to be a load balancing member in
order to be a coverage user. The only requirements for using coverage are: user group rights
to view the queue, assignment to the Org Chart associated with the queue, and having a role
that allows for coverage.
Note: Coverage is not supported for load-balanced queues configured with the rule Match
Keyword to Username assignment type.
Note: In the Client, the Load Balancing Administration screen does not display coverage. It only
displays the documents directly assigned to users.
Configuring Calendars
Calendars can be configured for many intended uses. A Business Calendar is the set of
workdays applicable to the entire business. This Calendar would be used by workflow timers
and date rules. Business Calendars can be modified for each user by applying the original
Calendar and adding a configurable list of days off. In this way, a system can have a basic
Business Calendar configured, as well as specific User Calendars for each user. Business
Calendars can also be configured as Shift Calendars, applicable to Coverage queues. This is
useful for organizations where different departments are on different shift schedules. A
different Calendar could be configured for each shift schedule needed.
Note: It is recommended that a single Business Calendar be used for the sole purpose of
timers and rules in Workflow. This Calendar will be applied to a life cycle.
2012 Hyland Software, Inc.
688
OnBase 12 Workflow
1. In the Configuration module, select Org Chart | Calendars. The Business Calendars
dialog box is displayed.
2012 Hyland Software, Inc.
689
Workflow OnBase 12
4. Select the first day of your business week from the Work Week Start drop-down select
list in the upper-right corner.
5. From the drop-down select list under the Work Period Start column, select the first day
of your business week.
6. In the adjacent time field, select or type the time when operating hours begin.
7. In the time field under the Work Period Finish column, select or type the time when
Org Charts and Calendars
operating hours end. By default, the work period ends on the same day it begins. If
you are configuring a work period that extends into the next day, click the time fields
up arrow button until the next day is displayed in the adjacent drop-down select list.
8. Click Add.
9. Repeat steps 5 through 8 for each day of the business week. If you need to remove a
work period, select it and click Remove.
Configuring Holidays
Business Calendars let you configure business holidays and half days, which are days with
shortened periods of operation.
To configure a holiday:
2012 Hyland Software, Inc.
690
OnBase 12 Workflow
4. Optionally, type a name for the holiday you want to configure in the Name field under
Holiday Configuration.
5. From the drop-down select list under Holiday Start, select the start date of the holiday
you want to add.
Note: Any changes to employee Shift or Time Off Calendars do not require a Client restart.
2012 Hyland Software, Inc.
691
Workflow OnBase 12
2012 Hyland Software, Inc.
692
OnBase 12 Workflow
3. The Calendar Configuration dialog box displays. Select the Business Calendar tab.
Note: The holidays configured for the selected Business Calendar will display in the users Time
Off tab.
2012 Hyland Software, Inc.
693
Workflow OnBase 12
1. In the Configuration module, select Users | User Names and Passwords | Calendar.
2. In the User Calendar Configuration dialog box, select the Roles tab.
3. Choose roles that this user will be able to modify calendars for. Use the Add>> and
<<Remove buttons to move the selected roles between the two fields. The user will be
able to modify calendars for all users who are configured as these roles.
4. When finished, click OK.
Copying Calendars
Copying Business Calendars can assist in efficient configuration of Calendars for a system.
Should many Calendars be required, it may be simplest to create one Calendar and copy it,
changing the name and required settings as appropriate.
To copy a Calendar:
1. In the Configuration module, select Org Chart | Calendars. The Business Calendars
dialog box displays.
2. Select the desired Calendar.
3. Click the Copy button. The [Calendar] Copy Configuration dialog box displays.
4. Enter the name for the new Calendar and click Save.
2012 Hyland Software, Inc.
694
OnBase 12 Workflow
1. The Org Chart and Calendar must be assigned to an appropriate life cycle. Each life
cycle may have one Org Chart and one Calendar assigned to it.
2012 Hyland Software, Inc.
695
Workflow OnBase 12
3. In the right-most pane there is an Org Chart and Calendar field. Select the appropriate
Org Chart and Work Calendar from the drop-down menus.
Org Charts and Calendars
Note: Institutional databases may have one Org Chart and one Calendar per life cycle per
institution.
2012 Hyland Software, Inc.
696
OnBase 12 Workflow
Caution: The functionality available on the Coverage tab is not supported in an Oracle 8 database.
Note: If a life cycle has no Org Chart assigned to it, coverage options will not be active. You
Note: Options on the Coverage tab are only active if a queue is load-balanced with Users as
Members. If the queue is configured as Match Keyword to Username, the options will not be
active.
Workday will only check the Business calendar to see if a user is available.
Shift will check the Business calendar as well as the Shift calendar assigned to the user
to see if the user is available.
4. In the check boxes, select whom employees are going to be covered by when
unavailable.
Manager When this option is selected, Workflow will traverse the associated Org
Chart to find a Manager to cover for the absent employee. The first
Manager Workflow finds relative to the employee will cover the absentee.
Assistant When this option is selected, the employee designated as assistant will
cover for an absent employee.
Peer When this option is selected, Workflow will traverse the associated Org
Chart to find a peer to cover for the absent employee. Any employee
within the Org Chart who shares the same role will cover the absentee.
Required Role This option is available when Peer is selected. When configured, all
employees with rights to the queue will be able to view the documents of
unavailable users who have this role.
2012 Hyland Software, Inc.
697
Workflow OnBase 12
Note: All users that meet coverage configuration terms will be able to see documents of
absent employees.
Document coverage is not transitive. For example, when using the See Other Users Documents
Org Charts and Calendars
option, if Employee 1 covers for Employee 2, but Employee 2 is also covering for Employee 3,
Employee 1 will not see Employee 3s documents.
Note: When using coverage, documents are not reassigned to available users. The assignment
to the original user is maintained, but other users are able to view the documents.
2012 Hyland Software, Inc.
698
OnBase 12 Workflow
Only Super Users are permitted to see user names and documents across
institutional boundaries. Workflow Administrators are only able to administer to
users within their own institutions unless they are also designated as Super Users.
Workflow Administrators fall under any of the following categories:
Users in an Administrator group
Those users granted the Workflow Administrative Processing Product Right
1. In the Client module, select User | Change User Calendar. The Choose User Calendar
dialog box displays all the calendars the logged-in user has rights to.
2012 Hyland Software, Inc.
699
Workflow OnBase 12
2. Select the desired calendar and click OK. The User Calendar Configuration dialog box
displays.
Org Charts and Calendars
3. Adjustments to the user calendar can then be made. For more information on
configuring Time Off, please see Configuring Holidays on page 690. Time Off is
configured in the same manner as Holidays.
4. When finished, click OK.
2012 Hyland Software, Inc.
700
WORKFLOW STUDIO CONFIGURATION
Overview
Workflow life cycles can be configured in Workflow Studio. Workflow Studio provides access to
configuration of life cycle compatible with versions previous to 11.0, but also provides the
ability to configure Unity Life Cycles that route not only documents, but WorkView objects,
managed folders, Plan Review projects, and Agenda Manager items for version 12 and
beyond. In addition to routing items other than documents, Unity Life Cycles have ownership
and portfolio functionality. Ownership and portfolio functionality is not available in standard
life cycles compatible with versions 11.0 and previous.
Note: Unity Life Cycles can be viewed only in the Unity Workflow interface.
Definitions
Actions
An Action is a task or process performed within the life cycle of a business process. Examples
of actions include moving a document to the next stage of the business process, adding a
keyword to a document or deleting a document from a life cycle. Once an action type is
selected, OnBase prompts you for the information necessary to complete the task. Any task
that you need the Workflow process to perform must be configured as an action.
Action Types
Action Types must be associated with every new action created. When a new action is added,
an Action Type drop-down list containing the action types available is displayed. Each action
type causes OnBase to perform a specific kind of task. Once you select an action type you can
specify any additional configuration required for that action type. The drop-down list of action
types is divided into groups, based upon what the action will do and what will be affected.
Note: Tasks can be executed on multiple items at the same time. To select consecutive items,
click the first item, hold the Shift key and click the last item. To select specific items, hold the
Ctrl key while clicking the items. The tasks you execute apply to the selected items.
2012 Hyland Software, Inc.
701
Workflow OnBase 12
Items
Items can be routed through a life cycle. Items consists of documents, WorkView objects,
managed folders, Agenda Items, Meetings, or Plan Review Projects. Only Unity Life Cycles
support the routing of all items. All other life cycles can only route documents. Unity Life
Cyles and the routing of all item types can only be configured in the Workflow Studio. Life
Workflow Studio Configuration
cyles configured in the Configuration module can only route the document item type.
Life Cycle
A life cycle or set of life cycles represent a business process that an item travels through. A
life cycle defines the steps that an item takes in a given business process. Each step or state
is represented by queues. Every time an item moves to a new step or state it is called a
transition. Essentially, a life cycle consists of a series of queues, transitions, actions and rules
that solve a specific business issue.
When an item enters a life cycle, all of the necessary work that must be performed for the
business process is performed on the item contained in OnBase. If the business process
changes, any procedural changes can be incorporated into the life cycle(s) configuration
immediately.
Notification
A Notification is a message sent to a user or users during the Workflow process. The message
is sent via e-mail, either an internal or an external mail system. Notifications can be used to
alert administrators of potential problems with items or to inform a user of the status of a
item. The message can also include information specific to the item that triggered the
notification.
Queue
A Queue represents a step or state within a business process. A queue contains lists of tasks
that are executed on the items the queue contains and will vary from one queue to another.
Rules
A rule represents a decision in the business process. Examples of rules are "is the purchase
order amount over $10,000?" and "does the employee acknowledge and agree with the
performance review?".
A rule can evaluate to true or false and this determines what tasks are performed on the item
being routed through Workflow.
Rule Type
When you create a new rule you specify what it will evaluate by selecting a Rule Type. The
rule type drop-down select list divides the types into groups based on what they evaluate.
Once you select an rule type you can specify any additional configuration required for that
rule type.
Task List
2012 Hyland Software, Inc.
702
OnBase 12 Workflow
A Task List is a series of actions and rules that are executed with respect to an item in a
queue, or the current item in OnBase. When a task list for an item is initiated, the task list is
executed on the item until the item transitions out of the queue that began the task list. A
task list is also referred to as work.
System Work
System Work is a rule, action or task list, created for a queue, that is executed as soon as an
item enters that queue. System work is always performed first, before user work or any other
tasks.
Note: When using a Core-based Workflow interface during any import process, it is highly
recommended that items be added to Workflow only during commit to minimize the impact on
performance. It is a best practice to add items to Workflow during commit.
When designing a life cycle, system work should be utilized to perform any functions that do
not require user interaction.
Note: Re-indexing affects the way in which an item enters a life cycle, and therefore the
manner in which system work is performed for that item.
Note: System work that requires user interaction is not supported in the Core-based
interfaces. When using the Classic Client interface, it is not recommended to configure system
work that requires user interaction.
User Work
Note: This is legacy functionality. This is supported for systems that already have user work
configured.
The user initiates this work, which follows a specific sequence determined during
configuration.
Note: User work is not available in the Unity, Web Client, or Java Client Workflow interfaces.
2012 Hyland Software, Inc.
703
Workflow OnBase 12
Web/API Tasks
Note: This is legacy functionality and are no longer required to be configured separately from
standard ad hoc user tasks. These are supported for systems configured before the support of
ad hoc tasks in the Web Client.
Workflow Studio Configuration
This type of task list allows you to create tasks for the web-view task list that emulate
functionality available on the non web-based Client module.
Timer Work
A timer triggers a rule, action or task list at a specific point in time. A Workflow server
monitors queues with timers configured. Status of timers is monitored either by the OnBase
Client Workflow System Monitor or the Core Workflow Timer Service.
System Task
System Task allow you to execute a task list against a document that is not necessarily
associated with a life cycle. You must associate the system task with any document types on
which you want to execute the task.
Note: System tasks are not supported in the Desktop Workflow and Java Web Client Workflow
interfaces.
Note: System tasks that require user interaction are supported in the Unity and Web
interfaces. System tasks that require user interaction are not supported in all other Core-
based interfaces. When using the Classic Client interface, it is not recommended to configure
system tasks that require user interaction.
These types of task lists differ by when the task is executed and which computer executes the
task on the document.
Note: The same task cannot be placed in both Ad Hoc User Tasks and Web/API Tasks folders.
Web/API tasks, however, can be a part of any other task list (including Ad Hoc task lists, User
Work, etc.)
Timers
Timers allow OnBase to execute rules or actions at a specific time. Timers can be configured
to execute periodically, after a certain amount of time, or at an exact point in time.
2012 Hyland Software, Inc.
704
OnBase 12 Workflow
Transitions
A Transition, when used as a noun, refers to the path a document can take from one queue in
a life cycle to another queue. All of the transitions, taken together, define the paths that a
document can take during the business process performed by the life cycle. In the graphical
configuration, the transitions are seen as the arrows between the queues in the life cycle.
User Form
A User Form is a customized form, designed using Hyper Text Markup Language (HTML) to
allow user interaction during a Workflow process. User forms can also be auto-generated for
actions that use HTML forms. A user form must be created outside the system before it can be
used within Workflow. Any user forms that are used in a Workflow process must be available
to all users of the Workflow process, from the same network location.
Note: The Web Workflow interface, Core-Based OnBase Client Workflow interface, and Unity
Workflow interface can accommodate user forms accessible by URL.
The main difference between a user form and an E-Form is that the user form is not imported
into OnBase, and therefore, is not stored in the database. It is merely used as a placeholder
for keyword information.
User Work
Note: This is legacy functionality. This is supported for systems that already have user work
configured.
User Work is a task list that must be run by the user processing the documents in a queue.
This type of work differs from system work in that a user at a workstation initiates it. User
work is a series of rules and actions that walk a user through a series of activities. Through
questions or dialogs, the user is usually required to provide more information about the
document(s) to determine what course of action should be taken.
Web/API Task
Note: This is legacy functionality. Such tasks are no longer required to be configured
separately from standard ad hoc user tasks. These are supported for systems configured
before the support of ad hoc tasks in the Web Client.
A Web/API Task is an optional task that can be created for use with the web-based
application. This option allows you to create tasks for the web-view task list that emulate
functionality available on the non web-based Client module.
2012 Hyland Software, Inc.
705
Workflow OnBase 12
Caution: The ability to view documents in a life cycle is controlled at the queue level. If users
have rights to a Workflow queue, they will also have rights to view all the documents in that
queue by default, regardless of their security rights (i.e. Document Type rights). This includes
related documents.
Caution: The ability to modify a document in a life cycle is controlled at the queue level. If users
have rights to a Workflow queue, they will also have rights to modify all documents in that queue
by default, regardless of their Modify privilege setting, including related documents.
Administrators should be aware that Workflow automatically grants the Modify privilege to users
for any documents that are in their queue. As a result, care should be taken to only present
documents which users should be allowed to modify.
Note: To view or change Keyword Values or to re-index a document via the right-click menu,
you must have appropriate rights for modifying keywords or re-indexing. The re-index option
is not present in the Java Workflow interface.
2012 Hyland Software, Inc.
706
OnBase 12 Workflow
Creating Repositories
A repository must be created first before any additional configuration can take place. A
repository can be thought of as a container that consists of configurations. The studio defines
two types of repositories:
Server Repository: Server repositories allow a user to have multiple connections to
the same OnBase database as different users or different OnBase databases. Server
repositories is based on an OnBase database.
Local Repository: A local repository is a file on the user's local machine containing
business process folders, BPMN processes etc. Local repositories allow a user to
modify a configuration offline and provide a means to send processes to other users.
This allows a user to create and modify BPMN processes and collaboration diagrams
while not connected to an Application Server or OnBase database.
Note: Life cycles and system tasks are not configured in local repositories.
2012 Hyland Software, Inc.
707
Workflow OnBase 12
To create a repository, click Add in the toolbar, click Add Repository in the Repositories window,
or click on the Add Repository task. The Add Repository Wizard dialog box is displayed.
Workflow Studio Configuration
2012 Hyland Software, Inc.
708
OnBase 12 Workflow
2012 Hyland Software, Inc.
709
Workflow OnBase 12
Workflow Studio Configuration
3. Select the appropriate Data Source from the drop-down select list.
4. If you want the user to be prompted for OnBase credentials each time a connection is
made to the repository, select Prompt for credentials.
5. If you want to connect to the data source automatically using OnBase credentials,
select Use the following credentials and enter the User Name and Password.
6. If you want to use NT authentication, select Use NT authentication.
2012 Hyland Software, Inc.
710
OnBase 12 Workflow
7. Click Next.
Note: In order for the Recycle AppPool button to be enabled, the user must belong to a user
group that has been granted rights to the Application Server Administrative Processing
Privilege product right.
2012 Hyland Software, Inc.
711
Workflow OnBase 12
11. The summary screen is displayed. If you want to test the connection, click the Test
Application Server Connection button.
12. When finished, click Finish.
2012 Hyland Software, Inc.
712
OnBase 12 Workflow
1. In the Repositories window, right-click on the repository that you would like to edit and
2012 Hyland Software, Inc.
713
Workflow OnBase 12
1. In the Repositories window, right-click on the repository that you would like to edit and
Workflow Studio Configuration
Note: In order for the Recycle AppPool button to be enabled, the user must belong to a user
group that has been granted rights to the Application Server Administrative Processing
Privilege product right.
5. Click OK.
2012 Hyland Software, Inc.
714
OnBase 12 Workflow
Refreshing Repositories
You can refresh a repository in order to work with the most up-to-date configuration for the
database that the repository is associated with. To refresh a repository, right-click on an item
in the repository within the Repositories pane and select Refresh or select a item and press F5
on the keyboard.
A portfolio type consist of one or more portfolio relations. Portfolio types are assigned at the
queue level to determine what items are displayed in the Related Items pane when a primary
item is selected. In addition, portfolio types and portfolio relationships can be used in rules
and actions configured with a Target of Related Item to determine what related item the rule
or action will process.
Portfolio relations allow you to specify how:
Documents relate to other documents, WorkView objects or entity items.
WorkView Objects relate to other WorkView objects or documents.
Entity Items relate to documents or WorkView objects.
Caution: If you are finding documents by Document Type and Keyword Type mapping, or by
document handle, users must have rights to view the Document Type in order to view related
items. If you are finding documents by folder type, users must have rights to the folder type in
order to view related items. Users do not need rights to the Document Types configured for the
folder type.
2012 Hyland Software, Inc.
715
Workflow OnBase 12
1. In the Home ribbon within the Portfolios ribbon group, click Portfolio Relations.
Workflow Studio Configuration
2. Select the Repository from the drop-down select list in which you would like to
configure the portfolio relation.
2012 Hyland Software, Inc.
716
OnBase 12 Workflow
Wizard Options
Depending on the types of items you are relating, the wizard options available vary. The
following relationship types are available:
Relating Documents to Documents on page 718
Relating Documents to Entity Items on page 721
Relating Documents to WorkView Objects on page 723
Relating Entity Item to Documents on page 728
2012 Hyland Software, Inc.
717
Workflow OnBase 12
When the Content Type is set to Documents, the wizard will prompt with the following screen.
Select the Document Type that you want to create a relationship for from the drop-down select
list. This is the Document Type the primary document belongs to.
2012 Hyland Software, Inc.
718
OnBase 12 Workflow
When Related Content Type is set to Documents, the following options are available:
2012 Hyland Software, Inc.
719
Workflow OnBase 12
1. Select Document Type and select the appropriate Document Type from the drop-down
select list. This is the Document Type the related document(s) belong to.
2. Click Keyword Mappings. The <Document Type> Mappings dialog box is displayed.
Workflow Studio Configuration
3. Double-click on a Keyword Type you would like to map or the select the Keyword Type
and click Map. The Relation Mapping dialog box is displayed.
2012 Hyland Software, Inc.
720
OnBase 12 Workflow
4. You can map to a specific Keyword Type, Property, or Constant value. Select a Keyword
Type from the drop-down select list or enter a Property or Constant value.
If you select Property, you can select Use Scoped Property Bag to use a scoped property.
A session property persists throughout a users session. A scoped property persists
only for the duration of a tasks execution.
2012 Hyland Software, Inc.
721
Workflow OnBase 12
When the Content Type is set to Documents, the wizard will prompt with the following screen.
Workflow Studio Configuration
Select the Document Type that you want to create a relationship for from the drop-down select
list. This is the Document Type the primary document belongs to.
2012 Hyland Software, Inc.
722
OnBase 12 Workflow
When the Related Content Type is set to Entity Items, the following options are available:
Note: If you are licensed for Agenda Management, Agenda Management selections are
available from these drop-down select lists. If you are licensed for Electronic Plan Review,
Plan Review Project selections are available from these drop-down select lists.
2012 Hyland Software, Inc.
723
Workflow OnBase 12
When the Content Type is set to Documents, the wizard will prompt with the following screen.
Workflow Studio Configuration
Select the Document Type that you want to create a relationship for from the drop-down select
list. This is the Document Type the primary document belongs to.
2012 Hyland Software, Inc.
724
OnBase 12 Workflow
When the Related Content Type is set to WorkView Objects, the following options are available:
2012 Hyland Software, Inc.
725
Workflow OnBase 12
When you click Document Type Association, the following screen is displayed.
Workflow Studio Configuration
Select the Application and Class that contains the Document Type Association you want to use
from the drop-down select lists.
Select the Document Type Association that will successfully map the Document Type you
previously configured for the primary document with objects of the Class you selected.
2012 Hyland Software, Inc.
726
OnBase 12 Workflow
2012 Hyland Software, Inc.
727
Workflow OnBase 12
Workflow Studio Configuration
3. Click the ellipsis button next to the Attribute field and select the attribute or system
property you want to map to determine a relationship.
4. Select the Operator you want to use to evaluate whether or not a relationship between
a document and an objects exists from the drop-down select list.
5. You can map to a specific Keyword Type, Property, or Constant value. Select a Keyword
Type from the drop-down select list or enter a Property or Constant value.
If you select Property, you can select Use Scoped Property Bag to use a scoped property.
A session property persists throughout a users session. A scoped property persists
only for the duration of a tasks execution.
6. Click OK.
7. Map all appropriate attributes necessary to determine a relationship.
2012 Hyland Software, Inc.
728
OnBase 12 Workflow
When the Content Type is set to Entity Items, the wizard will prompt with the following screen.
2012 Hyland Software, Inc.
729
Workflow OnBase 12
When the Content Type is set to Entity Items and Related Content Type is set to Documents, the
following options are available:
Workflow Studio Configuration
Document ID
Select Document ID if you want to map the value of item selected in the drop-down select list
to the documents ID.
Document Type
2012 Hyland Software, Inc.
730
OnBase 12 Workflow
1. Select Document Type and select the appropriate Document Type from the drop-down
select list. This is the Document Type the related document(s) belong to.
2. Click Keyword Mappings. The <Document Type> Mappings dialog box is displayed.
4. You can map to a specific Field, Property, or Constant value. Select a Field from the
drop-down select list or enter a Property or Constant value.
If you select Property, you can select Use Scoped Property Bag to use a scoped property.
A session property persists throughout a users session. A scoped property persists
only for the duration of a tasks execution.
2012 Hyland Software, Inc.
731
Workflow OnBase 12
5. Click OK.
6. Repeat 3 to 5 for each mapping you want to establish.
7. When finished, click OK.
Select the Application and Class that you want to create a relationship for from the drop-down
select lists. This is the application and class the primary object belongs to.
2012 Hyland Software, Inc.
732
OnBase 12 Workflow
When the Content Type is set to WorkView Objects and Related Content Type is set to
Documents, the following options are available:
2012 Hyland Software, Inc.
733
Workflow OnBase 12
1. Select Document Type and select the appropriate Document Type from the drop-down
select list. This is the Document Type the related document(s) belong to.
2. Click Keyword Mappings. The <Document Type> Mappings dialog box is displayed.
Workflow Studio Configuration
3. Double-click on a Keyword Type you would like to map or the select the Keyword Type
and click Map. The Relation Mapping dialog box is displayed.
4. You can map to a specific Attribute, Property, or Constant value. Select an Attribute
from the drop-down select list or enter a Property or Constant value.
If you select Property, you can select Use Scoped Property Bag to use a scoped property.
A session property persists throughout a users session. A scoped property persists
only for the duration of a tasks execution.
2012 Hyland Software, Inc.
734
OnBase 12 Workflow
5. Click OK.
6. Repeat 3 to 5 for each mapping you want to establish.
7. When finished, click OK.
By Filter
2012 Hyland Software, Inc.
735
Workflow OnBase 12
1. Select the Application and Class that contains the objects you want to use for the
relationship from the drop-down select lists.
2. If you want to use an existing filter, select Existing Filter to select a filter already
configured in WorkView for the relationship.
3. If you want to create a filter for use in the portfolio relationship, select Dynamic Filter.
2012 Hyland Software, Inc.
736
OnBase 12 Workflow
By Related Object
2012 Hyland Software, Inc.
737
Workflow OnBase 12
1. Select the Application and Class that contains the objects you want to use for the
relationship from the drop-down select lists.
2. If you want to use a related attribute associated with the class selected, select Related
Attribute Name. Click the ellipsis button and select the appropriate relationship
attribute.
If you want to specify a property that will contain the name of the relationship
attribute you want to use to create the relationship, select Related Attribute Name from
Property: and enter the name of the property in the field.
If you select Property, you can select Use Scoped Property Bag to use a scoped property.
A session property persists throughout a users session. A scoped property persists
only for the duration of a tasks execution.
By Object ID
2012 Hyland Software, Inc.
738
OnBase 12 Workflow
2012 Hyland Software, Inc.
739
Workflow OnBase 12
1. In the Home ribbon within the Portfolios ribbon group, click Portfolio Types. The
Portfolio Types dialog box is displayed.
Workflow Studio Configuration
2. Select the Repository from the drop-down select list in which you would like to
configure the portfolio type.
3. Click Add. The Portfolio Type Configuration dialog box is displayed.
4. Enter Name for the portfolio type.
5. Select the Content Type from the drop-down select list that you want to associate with
the portfolio type. Available options are Documents, Entity Items, and WorkView
Objects.
2012 Hyland Software, Inc.
740
OnBase 12 Workflow
2012 Hyland Software, Inc.
741
Workflow OnBase 12
Agenda Item: Route and process agenda items in OnBase. This life cycle type requires an
Agenda Management license.
Meeting: Route and process meetings in OnBase.This life cycle type requires an Agenda
Management license.
Plan Review Project: Route and process plan review projects in OnBase. This life cycle type
Workflow Studio Configuration
1. You can create a life cycle by completing one of the following two actions:
Click the Life Cycle button in the Home ribbon within the New ribbon group or right-
click in a repository in the Repositories pane and select New | Life Cycle.
2. The following dialog box is displayed if a repository is not specified and the Life Cycle
button is clicked:
Select the repository in which you would like to create a life cycle.
2012 Hyland Software, Inc.
742
OnBase 12 Workflow
Note: When the Create a Unity Life Cycle option is not selected, you must select Documents as
the item type. When not using this option, only actions and rules that can be executed on a
document will be available during configuration.
2012 Hyland Software, Inc.
743
Workflow OnBase 12
8. Enter the Name for a queue you want in the life cycle.
9. Click Add or press Enter on the keyboard.
10. Repeat steps 8 to 9 for each queue you want to add.
Note: You can arrange queues in the list by selecting a queue and clicking the Move Up and
Move Down buttons. You can also delete queues by selecting a queue and clicking Remove.
Note: The user group(s) assigned at the life cycle level during life cycle creation are assigned
rights to the queues created in the wizard as well.
2012 Hyland Software, Inc.
744
OnBase 12 Workflow
Note: You must be licensed for Agenda Management or Electronic Plan Review to configure
1. You can create a life cycle by completing one of the following two actions:
Click the Life Cycle button in the Home ribbon within the New ribbon group or right-
click in a repository in the Repositories pane and select New | Life Cycle.
2. The following dialog box is displayed if a repository is not specified and the Life Cycle
button is clicked:
Select the repository in which you would like to create a life cycle.
2012 Hyland Software, Inc.
745
Workflow OnBase 12
2012 Hyland Software, Inc.
746
OnBase 12 Workflow
Note: You can arrange queues in the list by selecting a queue and clicking the Move Up and
Move Down buttons. You can also delete queues by selecting a queue and clicking Remove.
Note: The user group(s) assigned at the life cycle level during life cycle creation are assigned
rights to the queues created in the wizard as well.
2012 Hyland Software, Inc.
747
Workflow OnBase 12
1. You can create a life cycle by completing one of the following two actions:
Click the Life Cycle button in the Home ribbon within the New ribbon group or right-
Workflow Studio Configuration
click in a repository in the Repositories pane and select New | Life Cycle.
2. The following dialog box is displayed if a repository is not specified and the Life Cycle
button is clicked:
Select the repository in which you would like to create a life cycle.
2012 Hyland Software, Inc.
748
OnBase 12 Workflow
2012 Hyland Software, Inc.
749
Workflow OnBase 12
7. Enter the Name for a queue you want in the life cycle.
8. Click Add.
9. Repeat steps 7 to 8 for each queue you want to add.
Note: You can arrange queues in the list by selecting a queue and clicking the Move Up and
Move Down buttons. You can also delete queues by selecting a queue and clicking Remove.
11. Select a managed folder type from the Managed Folder Types drop-down select list that
you want to be processed by the life cycle.
12. Click Add.
13. Repeat steps 11 to 12 for each queue you want to add.
14. Click Next.
15. Select a user group that you would like to grant rights to the life cycle from the drop-
down select list.
Note: The user group(s) assigned at the life cycle level during life cycle creation are assigned
rights to the queues created in the wizard as well.
2012 Hyland Software, Inc.
750
OnBase 12 Workflow
1. You can create a life cycle by completing one of the following two actions:
Click the Life Cycle button in the Home ribbon within the New ribbon group or right-
Select the repository in which you would like to create a life cycle.
2012 Hyland Software, Inc.
751
Workflow OnBase 12
2012 Hyland Software, Inc.
752
OnBase 12 Workflow
7. Enter the Name for a queue you want in the life cycle.
8. Click Add.
9. Repeat steps 7 to 8 for each queue you want to add.
11. Select the Application from the drop-down select list that contains the class you want
to associate with the life cycle.
12. Select the Class from the drop-down select list that you want to associate with the life
cycle.
13. Click Add.
14. Repeat steps 11 to 13 for each queue you want to add.
15. Click Next.
16. Select a user group that you would like to grant rights to the life cycle from the drop-
down select list.
Note: The user group(s) assigned at the life cycle level during life cycle creation are assigned
rights to the queues created in the wizard as well.
2012 Hyland Software, Inc.
753
Workflow OnBase 12
checked out, the user cannot make changes to the configuration of the life cycle. While a user
does have life cycle checked out, other users cannot make changes to the configuration of the
life cycle. Upon creating a new life cycle, the life cycle is automatically checked out.
Checking In
To check in a life cycle:
1. In the Repositories pane, select the life cycle you want to check in, right-click and
select Check In. If edits were made and the repository was not saved, a message
stating The life cycle has been modified and must be saved before it can be checked in is
displayed.
2. Click OK.
3. On the Home tab, click Save.
4. Repeat step 1.
After saving the repository, you can check in all life cycles in a repository by right-clicking on
a life cycle in the Repositories pane and selecting Check In All.
In addition, when you close Workflow Studio, all life cycles are automatically checked back in.
Checking Out
To check out a life cycle, complete one of the following tasks:
In the Repositories pane, select the life cycle you want to check in, right-click and
select Check Out.
With the life cycle selected in the Repositories pane that you want to check out, click
the check out link In the Properties pane.
Option Description
Help Text An optional description of the life cycle that displays in the User
Interaction window when viewing the life cycle in the Client module.
Institutional Select this check box if you are creating a life cycle for a Layer 2 or
Layer 3 institutional database.
Note: Selecting this check box automatically sets every queue in the life
cycle to also be institutional.
Initial Queue Specifies the queue that initially receives the documents into the life
cycle.
2012 Hyland Software, Inc.
754
OnBase 12 Workflow
Option Description
Work Folder
Note: This option is not available in Unity Life Cycles.
Note: Only folder types configured as Workflow folders will displayed for
selection in the Work Folder drop-down select list.
Make Available In This drop-down select list allows you to specify what interfaces the life
cycle is available in. When configuring standard life cycles, you can
select the OnBase Classic Client interface (Deprecated) option to only
allow the life cycle to be available when using the Classic View in the
OnBase Client. You can select OnBase Core-Based interfaces to allow
the life cycle to be available in all interfaces using Core Services. Select
Both for the life cycle to be available in all interfaces. Select None to
not make the life cycle available in any interface.
When configuring Unity Life Cycles, you can select OnBase Core-Based
interfaces or None.
Portfolio Type
Note: This option is available when configuring a Unity Life Cycle.
Determines what items are displayed in the Related Items pane when a
primary item is selected. This can be overridden at the queue level.
For more information on portfolio types, see Configuring Portfolios Types
on page 715.
Institution This drop-down list is available when you are working in a life cycle for a
Layer 2 or Layer 3 institutional database. This drop-down list is used to
filter the Organizational Chart and Calendar drop-down lists, so that
they only show selections related to the selected institution.
The following icon is used to denote the options that can be configured
per institution:
Organizational Chart Select the configured organizational chart you want to associate with
the life cycle.
2012 Hyland Software, Inc.
755
Workflow OnBase 12
Option Description
Calendar Select the configured calendar you want to associate with the life cycle.
Content Type Specifies the type of items that the life cycle contains. This is not
editable.
Entities of this type When selected, items of the type specified in the Content Type drop-
should automatically down select list automatically enter the life cycle upon creation.
enter this life cycle
upon creation Note: This option is only available when configuring content types for
Agenda Items, Meetings, or Plan Review Projects.
Ownership allows a user to have persistent and exclusive access to items within a Workflow
life cycle that they are working on. In order to use ownership functionality, the life cycle must
be configured to allow ownership. To configure a life cycle for ownership:
Note: When Maximum Number of Items Owned by User is set to 0, the number of items owned
by a user is unlimited.
Caution: The action Assign Ownership will ignore the ownership limits defined by the Maximum
Number of Items Owned by User setting.
2012 Hyland Software, Inc.
756
OnBase 12 Workflow
1. In the User Groups tab, select a User Group from the drop-down select list.
2. Click Add.
3. To grant rights to the life cycle in client interfaces, select the Execute check box.
4. To grants rights for the user group to configure the life cycle, select the Configure
check box.
Document Types are assigned to a life cycle in the Document Types tab of the Properties pane.
To assign a Document Type to a life cycle:
1. In the Document Types tab, select a Document Type from the drop-down select list.
2. Click Add.
You can remove a Document Type assignment by selecting it and clicking Remove.
Caution: If you assign a Document Type to both Unity Life Cycles and standard life cycles, when
using the Classic Client Workflow interface, when a document is added to life cycles, the
document is only added to the standard life cycles the documents Document Type is associated
with. The document will not be added to any Unity Life Cycles the documents Document Type is
associated with.
Note: This only applies to life cycles that route managed folders.
Managed folders are assigned to a life cycle in the Managed Folder Types tab of the Properties
pane.
2012 Hyland Software, Inc.
757
Workflow OnBase 12
1. In the Managed Folder Types tab, select a Managed Folder Type from the drop-down
select list.
2. Click Add.
Workflow Studio Configuration
You can remove a managed folder type assignment by selecting it and clicking Remove.
Note: If you do not have rights to a managed folder, you will be able to see the folder in
Workflow; however, if you do not have rights to the documents within the managed folder,
you will not be able to view those documents within Workflow.
Note: This only applies to life cycles that route WorkView objects.
Application classes are assigned to a life cycle in the Application Classes tab of the Properties
pane. In order for objects to be routed in a life cycle, they must belong to an assigned
application class.
To assign an application class to a life cycle:
1. In the Application Classes tab, select an Application from the drop-down select list.
2. Select the Class from the drop-down select list in which the objects belong that will be
routed through the life cycle.
3. Click Add.
You can remove an application class assignment by selecting it and clicking Remove.
2012 Hyland Software, Inc.
758
OnBase 12 Workflow
1. In the Repositories pane, right-click on a checked out life cycle and select Password
When a life cycle is protected, upon checking out the life cycle, a dialog box similar to the
following is displayed.
Enter the password in the field to configure the life cycle and click OK.
2012 Hyland Software, Inc.
759
Workflow OnBase 12
1. Select the life cycle, right-click and select Copy. The Copy Life Cycles Wizard is
Workflow Studio Configuration
displayed.
2. If you want to copy multiple life cycles, you can select a life cycle and click Add. Repeat
this for every life cycle you want to copy.
3. Click Next.
4. Click Next again.
5. Click Finish.
Creating Queues
Queues can be added to life cycles as needed.
To create a new queue:
1. In the Repositories pane, right-click on the checked out life cycle you want to add a
queue to and select New | Queue.
2. Enter the name for the queue.
3. Press Enter on the keyboard.
4. Configure the queue as appropriate.
2012 Hyland Software, Inc.
760
OnBase 12 Workflow
Configuring Queues
General queue configuration options are configured in the General tab in the Properties pane.
The following options are available.
Parameter Description
Description Optional area to add comments about the queues function. For
informational purposes only and is not displayed in the Client.
Help Text Optional area to add instructions, tips or any information that may be
useful to the users of this queue. This information displays in the User
Interaction window when the queue is selected.
Double-Click Begins Double-clicking an item in the inbox window triggers associated user
User Work work.
Hide Count If this option is enabled, the number of items within the queue is not
displayed in the Client module. If it is disabled, the number of items
within a queue is displayed. If no items exist in a queue, a zero will be
displayed for the count.
Note: For the Web Client and Java Client, if the Web Servers
web.config file ShowQueueCounts option is set to true, it will not
override the individual queue's Hide Count setting. If
ShowQueueCounts is set to false, no queue counts will be displayed.
2012 Hyland Software, Inc.
761
Workflow OnBase 12
Parameter Description
Exclusive Viewing Permits only one user to view the item at a time. Another user can
retrieve the item in a Client retrieval interface, but not through
Workflow. An item that exists in multiple queues in different life cycles
Workflow Studio Configuration
that have this setting enabled will only permit the items to be opened in
one queue at a time. If the item lives in two life cycles in two queues
and if one queue has this setting enabled and the other does not, the
same item is available for viewing in both queues by two different users.
Note: When this option is applied, items open within the queue cannot
have a system task executed upon it from the document retrieval hit
list, the document viewer, or a folder.
Note: When a user selects multiple items within the Inbox using the
CTRL or SHIFT keys, Process Lock Administration will only display the
last document selected. This applies to the OnBase Client Core-based
interface.
Note: The Java Workflow interface does not support Exclusive Viewing
locks.
Disable Logging Every time an item enters or exits a queue, an entry is made in the
Workflow log. Checking this option disables the logging function.
Hidden Hides the queue in the Clients Tree View and Graphic Layout, even if the
user has rights to the queue.
2012 Hyland Software, Inc.
762
OnBase 12 Workflow
Parameter Description
Available in Combined When this option is selected, the queue will be available for selection
View when configuring the Combined View.
2012 Hyland Software, Inc.
763
Workflow OnBase 12
Parameter Description
Respect Security
Keywords Caution: This option is not supported in the Classic Client interface.
Workflow Studio Configuration
Institutional When this option is selected, items in the inbox are restricted based on
institution.
Override Document When the For Primary Document option is checked, allows users who
Modification Privilege do not have a modify privilege to modify a document and update its
keywords that is a primary document within the queue.
When the For Work Folder Documents option is checked, allows users
who do not have a modify privilege to modify a document and update its
keywords that is a document within the Work Folder within the queue.
Note: Users do not need access to the documents Document Type for
the override to apply.
2012 Hyland Software, Inc.
764
OnBase 12 Workflow
Parameter Description
Hide Queue Queue does not display in Client Tree View or Graphic Layout if a user
does not have rights to a queue.
Show Disabled Icon If a user does not have rights to the queue:
MRM Queue This option allows users access medical record charts residing in this
queue from the Medical Records Management (MRM) Web Client.
If this option is selected, then the queue is accessible from the MRM
Web Client. If it is disabled, then the queue is not accessible from the
MRM Web Client.
The MRM Web Client and medical record charts are available on systems
licensed for HL7 or the Medical Records Management Solution.
Type If MRM Queue is selected, then the queue can be used for Analysis,
Reanalysis, or Coding in the MRM Web Client.
If this queue will be used for deficiency creation (Analysis) or
confirmation (Reanalysis), or if it will be part of a Coding life cycle,
then select one of these options from the Type drop-down list.
If the queue should be available in the MRM Web Client but should
not be used for Analysis, Reanalysis, or Coding, then select
<None>.
See the Medical Records Management Solution module reference guide
for more information.
Coding Completion If Coding is selected as the MRM queue type, then the Coding
Queue Completion Queue option is available. Select this option if Coders
should be able to mark all Coding as complete on the chart when it exits
this queue.
2012 Hyland Software, Inc.
765
Workflow OnBase 12
The purpose of the auto-feed lock is to prevent another user processing the same queue from
processing the same item. When the user selects the Show All Documents right-click menu
option, the Auto-Feed lock is removed from the document currently displayed and the inbox
displays a list of all the documents in the queue. When the user selects a document, no auto-
feed lock is placed on the document. It works as though the queue never was configured for
auto-feed.
1. In the User Groups tab, select a User Group from the drop-down select list.
2. Click Add.
If you want to assign all of the user groups currently assigned to the life cycle to the selected
queue, click Add All Assigned to Life Cycle. After clicking this button, if user groups are added
at the life cycle level, the queues user group rights are not automatically updated.
Note: When you remove a user group assignment to a queue, if ownership is being used and
users belonging to the user group that was removed no longer have access to the queue via
another user group assignment, the owned items owned by these users will be labeled as
unowned.
Note: The default representation of a queue in the Graphic Layout for the Web Client Workflow
is a notebook.
Icons are only available after they have been stored in the SYS System Icons and SYS System
Bitmaps Document Types.
Advanced Options
The following advanced options are configured at the queue level.
2012 Hyland Software, Inc.
766
OnBase 12 Workflow
Work Folder
Folders are used to contain supporting documents for the main document passing through the
Note:When selecting a work folder from the Work Folder tab, a context menu will only be
available when a document from that folder is selected.
The Work Folder drop-down select list contains folder types to which you have been granted
rights from the User Groups/Rights submenu under the User menu in the configuration menu.
If you have configured a folder for this queue, select it here. Configuring folders is discussed
in detail in the Configuration help files.
Note:Only folder types configured as Workflow folders will displayed for selection in the Work
Folder drop-down select list.
Folders used within Workflow must have dynamic foldering configured and be set for Workflow
in the Usage section for the Folder Type Settings tab.
Portfolio Type
Determines what items are displayed in the Related Items pane when a primary item is selected.
Portfolio types are used to contain supporting items for the main item passing through the life
cycle. Portfolio types can relate a primary item to item of the same content type or of a
different content type. For more information on Portfolio Type see Configuring Portfolios Types
on page 715.
The Portfolio Type drop-down select list contains any portfolio types that are configured for
the content type for which the life cycle is configured. For example, portfolio types configured
with a WorkView Objects Content Type will only be available in life cycle configured to route
WorkView Objects.
Default Template
Note: This option is only available when configuring a document life cycle.
A template filters a folder of related Document Types. Apply a template to search for specific
Keyword Values and display a subset of the folder contents.
Note:Applying a template to a folder causes the documents to no longer follow the sort order
set for the folder. Instead, the documents follow the order assigned in the template.
2012 Hyland Software, Inc.
767
Workflow OnBase 12
The Default Template drop-down list contains templates that have been configured in OnBase.
If you have configured a template for this queue, select it here. Configuring templates is
discussed in detail in the Configuration help files.
The VB Script to Execute on Selected Document drop-down list contains all VBScripts available
for the life cycle. In addition, <None> is available as a selection.
In the Classic Client interface, when a VBScript is selected from the drop-down select list,
each time a document is clicked on within the Queue, the selected script will execute.
In the Core-Based Client interface, when a VBScript is selected from the drop-down select list,
each time a document is selected on within the Queue, the selected script will execute.
Document selection can occur from a refresh or automatic selection, as well as manual
selection of a document in the inbox.
Note:In order for the Inbox Refresh Rate (seconds) feature to function in the Core-based Client
interface, the Refresh tree counters Workstation Option must be selected.
Caution: Configuring the Inbox Refresh Rate (seconds) setting to a small number, making the
refresh rate more frequent, on multiple queues will impact performance.
2012 Hyland Software, Inc.
768
OnBase 12 Workflow
Sort Documents By
The Sort Documents By section allows you to set the display order for entries in the Document
window in the Client module.
Document Date Documents are sorted by the document date, in ascending order.
Document Handle Documents are sorted on the unique document identifier that was
stored when the document first entered the system.
Entry Time Items are sorted on the date of entry to the queue (arrival time), in
ascending order.
Name Items are sorted on the configured Auto-Name string for the Document
Type, in ascending order.
Priority Items are sorted based on the priority value that is assigned. When
sorting ascending, 1 would be the highest priority and at the top of the
list, while 999 would be the lowest priority. When sorting descending,
999 would be the highest priority and at the top of the list, while 1
would be the lowest priority.
Sort Descending When enabled, sets the sort order of the selected sort type (Document
Date, Document Handle, Entry Time, Name, or Priority) to
descending, instead of the default (ascending) order.
User Privileges
User privileges are configured in the Advanced tab of the Properties pane by clicking the
Configure button in the User Privileges section.
To configure user privileges for a queue:
2012 Hyland Software, Inc.
769
Workflow OnBase 12
Privilege Description
Load-Balancing Administration Grants access for selected user to the Load Balancing
Workflow Studio Configuration
See Other Users Documents Grants access to the See Other User's Documents queue right-
click menu.
Note: Users can also view other users items if they are
Administrator users, or members of a group that has the
Workflow Administration right.
Execute System Work Grants access to the Perform System Work queue right-click
menu.
Execute Timer Grants access to the Execute Timer Work queue right-click
menu.
Ad hoc Routing Grants access to configured ad hoc tasks and the Route
Document right-click menu. For ad hoc routing, the queue must
have transitions configured.
Override Auto-Feed Grants users the right to view all items in a queue configured
with the Auto-Feed setting by granting access to the Show All
Documents right-click menu for queues configured for Auto-
Feeding.
Ownership Administration Grants users the right to the Queue Administration window for
the queue. The Queue Administration window allows a user to
change ownership of an item to a different user.
Note:These privileges are assigned on a per user or per User Group, per queue basis.
Queue Monitoring
Queue monitoring is configured in the Advanced tab of the Properties pane by clicking the
Configure button in the Queue Monitoring section.
Watermarks can be set to help monitor how many documents are in a queue at any given
time. These watermarks are user-configured integers which help clarify the movements and
quantity of documents in any queue.
To configure watermarks:
1.In the Advanced tab of a queue, click Configure for Queue Monitoring.
2. Select the Use queue watermarks check box.
2012 Hyland Software, Inc.
770
OnBase 12 Workflow
3.Enter the appropriate number of documents for the High Watermark Warning and Alert
levels and click the corresponding Log check box.
4.Enter the appropriate number of documents for the Low Watermark Warning and Alert
levels and click the corresponding Log check box.
5. Click OK.
The watermarks should be configured so that the High Watermark > Low Watermark >= 0. It
is not necessary to enable and configure both watermarks.
Note:Watermarks take into account all transition and moving of documents except for deleting
and undeleting documents. If a watermark point is met by deleting or undeleting a document,
(e.g., via Document Maintenance or deleting a document from a Document Search Results
list), an entry will not be made in the Workflow log.
Note:The Use Watermarks options are also used for Business Activity Monitor functionality.
Note:The Document Age and Monitor Keyword Sum options are used by the Workflow
Dashboard and Workflow Process Statistics StatusView portlets. These settings provide
default setting for those portlets. See the StatusView documentation for further information
regarding these settings.
2012 Hyland Software, Inc.
771
Workflow OnBase 12
query configured as a Workflow Filter can be used to filter the Workflow inbox. If the user
selects Filter Inbox while the inbox is displaying the combined view, all of the custom queries
that the user has permission to and are assigned to each queue within the combined view are
displayed.
Note:Work folder filters are configured at the folder level. In order for filters to be available in
the client, filters must be configured at the folder level. See the folders documentation for
more information. This is only available in the Core-based OnBase Client user interface.
The box corresponding to the Use only selected filters check box contains a list of all filters that
have been selected for use with the queue. A filter can be removed from the list by selecting
it and clicking Remove. Only the custom queries configured as a Workflow Filter that are
assigned to the queue and that the user has permission to are displayed for selection when
Filter Inbox is displayed.
Available Filters
The Available Filters drop-down select list contains all custom queries that can be used as a
filter for Workflow. This drop-down select list is only enabled when the Use only selected filters
option is selected. These custom queries are those that are configured with the Workflow Filter
option. To add a filter to the Assigned Filters box, select it from the drop-down select list and
click Add.
Default Filter
The Default Filter drop-down select list allows you to select a query to use as a default filter for
the selected queue. If the Use only selected filters option is selected, only those filters will be
available in the Default Filter drop-down for selection, otherwise, all available custom queries
configured as Workflow Filters that the user has permission to will be available. Custom
queries that are configured with the Workflow Filter option selected in the Custom Query
Options dialog box are available in this drop-down select list.When a default filter is selected,
the queue is automatically filtered and the documents displayed reflect that filter's
specifications. If you choose a filter from the Filter Inbox right-click option, it will override the
selected default filter and the display will reflect the newly chosen filter.
2012 Hyland Software, Inc.
772
OnBase 12 Workflow
If you select Display HTML Form used by Filter, the HTML form associated with the filter will
display when the queue is selected in the Client module, allowing you to specify search
criteria by which the inbox can be filtered. If you cancel a default filter, the filter will be
applied with no Keyword Values specified.
Note:Use caution when using a filter with a queue configured with the Auto-Feed option.
Ensure that the desired filter will not prevent documents from displaying for any user.
Note:If the user selects Filter Inbox while the inbox is displaying the combined view, all of the
custom queries configured as a Workflow Filter that the user has permission to and are
assigned to each queue within the combined view are displayed.
Note:When a filter has Workflow Queue configured as a display column and the Combined
View is not showing, the filter applied will not show results related to the currently selected
queue.
Coverage Tab
When a Organizational Chart has been select for a life cycle, you can configure queues within
that life cycle for coverage. To configure a queue for coverage:
1. In the Coverage tab, select the Coverage Type from the drop-down select list.
Workday will only check the Business calendar to see if a user is available.
Shift will check the Business calendar as well as the Shift calendar assigned to the user
to see if the user is available.
2. In the check boxes, select whom employees are going to be covered by when
unavailable.
Manager When this option is selected, Workflow will traverse the associated Org
Chart to find a Manager to cover for the absent employee. The first
Manager Workflow finds relative to the employee will cover the absentee.
2012 Hyland Software, Inc.
773
Workflow OnBase 12
Assistant When this option is selected, the employee designated as assistant will
cover for an absent employee.
Workflow Studio Configuration
Peer When this option is selected, Workflow will traverse the associated Org
Chart to find a peer to cover for the absent employee. Any employee
within the Org Chart who shares the same role will cover the absentee.
Required Role This option is available when Peer is selected. When configured, all
employees with rights to the queue will be able to view the documents of
unavailable users who have this role.
Note: All users that meet coverage configuration terms will be able to see documents of
absent employees.
Document coverage is not transitive. For example, when using the See Other Users Documents
option, if Employee 1 covers for Employee 2, but Employee 2 is also covering for Employee 3,
Employee 1 will not see Employee 3s documents.
Note: When using coverage, documents are not reassigned to available users. The assignment
to the original user is maintained, but other users are able to view the documents.
2012 Hyland Software, Inc.
774
OnBase 12 Workflow
Configuring Members
Note: The Coverage tab is not available when Roles or User Groups is selected.
The Default Recipient drop-down list allows you to select one of the Users/User Groups/Roles
to receive the initial document when the life cycle is turned on. Documents that cannot be
assigned to a specific user (or Role) will be assigned to the default user. If you do not want
these documents to automatically be routed to a specific user, select <Unassigned> for the
Default Recipient. Documents can then be delegated to the appropriate user through Load
Balancing Administration.
Note:Rules-based load balancing will always place documents in the <Unassigned> state if
they fall outside of the configured assignment logic.
If you want to specify a Keyword Type that will contain the user, user group or role
assignment, select the appropriate Keyword Type from the Keyword to Hold Assignee drop-
down select. Upon assignment, the Keyword Types value will be populated with the
assignment.
Note:If this is configured in conjunction with Match Keyword to User Name load balancing
queue type, the Keyword Types value will not be populated with the assignment.
Caution:When configuring a Match Keyword to User Name load balancing queue, only the Users
option is supported.
2012 Hyland Software, Inc.
775
Workflow OnBase 12
drop-down select list and click Add to add a user group as a member. Repeat this step
for each one you want to add.
You can click Add All Assigned to Queue to add all user groups as members that are
assigned rights to the queue.
Allocated Percentage
Allocated Percentage assigns a specified percentage of the systems items to each user.
2012 Hyland Software, Inc.
776
OnBase 12 Workflow
To configure:
1. Once members are configured, click the Configure button. The Allocated Percentage
Configuration dialog box is displayed.
By Priority
By Priority distributes items to users based on the priority assigned to items. Priority values
are assigned to specific user groups.
2012 Hyland Software, Inc.
777
Workflow OnBase 12
To configure:
1. Once members are configured, click the Configure button. The Priority Configuration
dialog box is displayed.
Workflow Studio Configuration
In Order
In Order distributes items to users in a specified order until all of the items in the system have
been assigned. As additional items enter the system, assignments continue with the next
member or group in the rotation.
Configure members as appropriate.
Keyword Based
Keyword Based configuration distributes work depending on Keyword values. For example, you
could define keywords that allow you to sort work based in a geographic territory or product
types.
Note: This load balancing queue type is not available when configuring queues in life cycles
that have a Content Type of WorkView Objects.
2012 Hyland Software, Inc.
778
OnBase 12 Workflow
To configure:
1. Once members are configured, click the Configure button. The Keyword Based
Configuration dialog box is displayed.
Note: If the Keyword Type selected above is configured as an Alphanumeric Data Type, the
Operator drop-down box defaults to = and cannot be modified. However, if the Keyword Type
selected above is configured as a Numeric Data Type, the Operator drop-down list allows you
to choose an operand.
4. Enter the Value you want to associate from the Keyword Type to the member for
assignment.
Note: Regardless of the workstations regional settings, values entered for Currency Data Type
Keyword Types will be stored as a decimal value with two decimal places. For example, if 11 is
entered as a value, 11.00 will be stored.
5. Select the Member you want to assign the keyword value parameter to.
6. Click Add.
2012 Hyland Software, Inc.
779
Workflow OnBase 12
Caution: In order for proper document assignment, do not configure the same load balancing
criteria for more than one user or user group.
Workflow Studio Configuration
Note: This load balancing queue type is only available when configuring queues in life cycles
that have a Content Type of Documents that route document item types.
Note: Configure a keyword for user name before applying this queue type.
Note: Assigning User Groups to the load balancing Match Keyword to User Name queue type is
not supported.
Note: Users configured as members for load balancing in this queue type will always appear in
Load Balancing Administration regardless of the number of documents assigned to them.
To configure:
1. Once members are configured, click the Configure button. The Match Keyword to User
Name Configuration dialog box is displayed.
2. Select the Keyword Type that contains values that will match user names for document
assignment from the drop-down select list.
3. Click OK.
Rules Based
Rules Based configuration allows you to configure Load Balancing Work within the load
balanced queue. In addition, the following actions can be used to administer the queue:
Assign to User
Remove User Assignment
2012 Hyland Software, Inc.
780
OnBase 12 Workflow
If desired, select the Assign to Logged-in Users check box. Selecting this option will assign
documents only to the users that are logged in. If no users are logged in, and documents
come into the system, the documents will be equally distributed among all users.
Note:The Assign to Logged-in Users functionality is currently only supported in the Core.
1. In a Rules Based queue, right-click and select New | Load Balancing Work.
2. Create and configure the appropriate rules and actions with in Load Balancing Work for
the queue.
Shortest Queue
Shortest Queue initially assigns items to users one by one in an orderly fashion. As additional
items enter the system, assignments are made to the user with the fewest unprocessed items
that is encountered first by the system.
If desired, select the Assign to Logged-in Users check box. Selecting this option will assign
documents only to the users that are logged in. If no users are logged in, and documents
come into the system, the documents will be equally distributed among all users.
Note: The Assign to Logged-in Users functionality is currently only supported in the Core.
2012 Hyland Software, Inc.
781
Workflow OnBase 12
If you are configuring load balancing in a Layer 2 or Layer 3 institutional database, the
following queue types can be configured per institution: Allocated Percentage, By Priority,
Keyword Based, Match Keyword to User Name. For Match Keyword to User Name queues, the
configured Keyword Type is the same for all institutions.
Workflow Studio Configuration
Creating Transitions
For the life cycle to route items manually, queues must be configured with transitions.
Transitions can either be added in the Design Layout or in the Repositories pane.
To create a transition in the Repositories pane:
1. Right-click on the queue you want to draw a transition from and select New |
Transition.
2. Select the queue you want to draw the transition to from the drop-down select list
available in the transition that is created.
3. Press Enter on the keyboard.
If you want to the transition to be hidden when viewing the graphic layout in a client
interface, select Hide transition in graphical layout when viewed in client in the General tab of
the Properties pane.
For more information on creating transitions in Design Layout, see Life Cycle Graphical Layout
on page 811 for more information.
Creating Actions
An action is a task or process performed within the life cycle or business process. Action Types
must be associated with an action created in a life cycle, otherwise the new action will not be
properly configured. When a new action is added, the Action Type drop-down select list is
activated. This drop-down select list is divided into groups, based upon what the action does
and what is affected. Once an action type is selected, OnBase prompts you for additional
information required in order to perform the task.
Adding
1.In the Repositories pane, right-click on any task list or System Work folder within a
queue, and select New | Action.
2.Type the name of the new action in the field or select an existing action from the drop-
down select list.
3.Press Enter.
Configuring
Once you have added a new action, and while the action is selected, the right side of the
Properties pane displays an action configuration section.
The information necessary to configure an action depends on the action type selected. Choose
an action type from the Action Type drop-down select list in the configuration section.
2012 Hyland Software, Inc.
782
OnBase 12 Workflow
When configuring an action, you can click on the Action Type drop-down select list and type
the name of the action you want to use. Typing the name of the action will select the action in
the drop-down select list.
Option Description
Use Scoped If you want to use a scoped property that persists only for the duration of a
Property tasks execution, select Use Scoped Property Bag. Otherwise, the property
Bag persists throughout a users session.
Note: This option is only enabled when a scoped property can been used in a
configuration.
Disable Allows you the flexibility of turning off an action without deleting it. The action can be
reinstated, without reconfiguring, by deselecting this box. An action in a disabled
state appears grayed-out.
Enable Used for determining the location of logic problems in a Workflow configuration.
Debug Causes a message box to display before the execution of the rule.
Breakpoint
To use this option in the OnBase Client, you must have the WFTRACE switch on the
command line of the Client module and the Step Debug toolbar button or the Debug
Window open in the Client module. A command line switch is not required to use
this option in the Unity interface.
Note: This option is only supported in the Classic Client, Core-based client, and Unity
interfaces.
Log When selected and the action is executed, an entry is made in the database. If the
Execution action is disabled when an entry is made, it will be logged in the OnBase database
that the action was disabled at the time of execution.
For more information about Actions, see Workflow Studio Actions on page 869.
2012 Hyland Software, Inc.
783
Workflow OnBase 12
When creating a new action, if the same name is used for an action that is the same as an
existing action, the existing action will be used. The following is an example of an action that
is used in multiple places with Workflow.
Workflow Studio Configuration
Creating Rules
A rule is used to determine if the requirements to process a document have been met. A rule
is presented as a question that returns a true or false answer. OnBase performs a set of
actions based upon the response to the question. Some rules may also be aborted, in which
case neither course of action is taken on the document. When a new rule is added, the Rule
Type drop-down select list is activated. This drop-down select list is divided into groups, based
upon what the rule does and what is affected. Once an rule type is selected, OnBase prompts
you for additional information required in order to perform the evaluation.
Adding
1.In the Repositories pane, right-click on any task list or System Work folder within a
queue, and select New | Rule.
2.Type the name of the new rule in the field or select an existing rule from the drop-down
select list.
3.Press Enter.
Configuring
The remaining information necessary to configure a rule depends on the rule type selected.
Since many of the rule types have the same configuration requirements, the rule field
configuration is grouped by rule type, followed by a description of the related rule fields.
When configuring a rule, you can click on the Rule Type drop-down select list and type the
name of the rule you want to use. Typing the name of the rule will select the rule in the drop-
down select list.
For more information about rules, see Workflow Studio Rules on page 1015.
2012 Hyland Software, Inc.
784
OnBase 12 Workflow
3. The Paste Options dialog box is displayed. Select Paste existing item if you want to
share the rule and its settings. Select Paste a copy of the item if you want to create a
copy of the rule, but not maintain a link to the original rule. Changes to the original
rule will not affect the new copy of the action and vice versa.When this option is
selected, you have three additional options. You can elect to Paste the existing children
Click the here link to revert the changes before saving the repository.
2012 Hyland Software, Inc.
785
Workflow OnBase 12
1. In the Repositories pane, select the repository you want to add a system task to.
2. Right-click and select New | System Task. The Create System Task screen is displayed.
Workflow Studio Configuration
Note: An Agenda Management license is required to execute a system task on an Agenda Item
or Meeting. System tasks that are configured for an Agenda Item or Meeting are displayed in
the Entity Items folder.
Note: An Electronic Plan Review license is required to execute a system task on a Plan Review
Project. System tasks that are configured for a Plan Review Project are displayed in the Entity
Items folder.
If you are configuring a system task for documents and you would like the life cycle to
be compatible with versions of OnBase previous to 12, do not select the Create a Unity
System Task option.
5. Click Next.
2012 Hyland Software, Inc.
786
OnBase 12 Workflow
6. If you are configuring a system task that will execute on Documents, select a
Document Type you want to associate with the system task from the drop-down select
list.
If you are configuring a system task that will execute on Managed Folders, select a
Managed Folder Type you want to associated with the system task from the drop-down
Note: System tasks configured for WorkView are specific to the class(es) they are configured
for. They cannot be successfully executed on other classes. In addition, the user groups that
have rights to the class associated with the system task must also have rights to the system
task in order to successfully execute the system task. System tasks configured for WorkView
can only be used in conjunction with WorkView events.
If you are configuring a system task with the Managed Folders, WorkView Objects,
Agenda Item or Meeting options, skip to step 9.
7. Click Add.
8. Repeat for each Document Type you want to associate with the system task. For an
system task configured for documents, you must associate the system task list with
any Document Type on which you want to execute the task.
9. Click Next.
10. Select a User Group that you wish to grants rights to the system task from the drop-
down select list.
11. Click Add.
12. Select Execute if you want to grant Client interface access to the task. Select Configure
if you want to grant configuration rights for the task.
13. Repeat for each user group you want to grant rights to.
14. Click Finish.
15. Add appropriate actions, rules, and task lists to complete the configuration of your
system task.
Note: A system task cannot be added as a task list within another system task.
Sub folders for each type of system task are created upon a system task creation of that type.
Sub folders include: Agenda Item, Documents, Meeting, Managed Folders, and WorkView
Objects.
After the task has been created, you can configured an icon. To configure an icon:
1. Select the task and in the Properties pane, select the Icon tab.
2. Select a Small Icon and a Large Icon for the task.
In addition, you can edit the Document Types assigned to a system task in the Properties
panes Document Types tab for system tasks configured for documents. You can edit the user
groups assigned to a system task in the Properties panes User Groups tab.
2012 Hyland Software, Inc.
787
Workflow OnBase 12
1. With a queue folder within a life cycle selected, right-click and select New | Ad Hoc Task
or click Ad Hoc Task from the Life Cycle ribbon within the New ribbon group. The Create
Workflow Studio Configuration
2012 Hyland Software, Inc.
788
OnBase 12 Workflow
3. Click Next.
Note: If you want to assign all of the user groups currently assigned to the queue to the Ad
Hoc Task, click Add All Assigned to Queue. After clicking this button, if user groups are added at
the queue level, the Ad Hoc Task user group rights are not automatically updated.
8. Click Add.
9. Repeat steps 7 to 8 for each user group you would like to assign.
10. Click Next.
11. Click Finish.
12. In the Properties pane in the General tab, configure the appropriate settings for the
task list.
13. In the Properties pane, click the Documentation tab. Enter any descriptive information
that is applicable in the Overview and Details fields.
14. Add the appropriate action and/or rules to the task list.
2012 Hyland Software, Inc.
789
Workflow OnBase 12
1. With a queue folder within a life cycle selected, right-click and select New | Ad Hoc Task
or click Ad Hoc Task from the Life Cycle ribbon within the New ribbon group. The Create
Workflow Studio Configuration
2. If you want to use an existing task, click Use an existing Ad Hoc Task.
2012 Hyland Software, Inc.
790
OnBase 12 Workflow
3. Click Next.
2012 Hyland Software, Inc.
791
Workflow OnBase 12
Option Description
Disable When this option is selected, users cannot drag-and-drop an item onto a task.
Workflow Studio Configuration
Execution
When using the Unity Client or Microsoft Outlook Integration interfaces, this option
from Related
disables the task from displaying in the Task drop-down select list in the Related
Items
Items pane.
Available in When this option is selected, this task can be used with the Integration for Microsoft
Outlook Outlook 2007 or Integration for Microsoft Outlook 2010 modules. This task can be
executed directly from a Workflow e-mail notification.
Note: This option is only available for ad hoc tasks. Ad hoc tasks for queues
configured with the Auto-Feed or Exclusive Viewing options are not available in
Workflow e-mail notifications. Ad hoc tasks for load balancing queues are only
available when the document is assigned to the logged in user.
Available for When this option is selected, this task can be used with the following modules:
Mobile Mobile Access for Android Phone
Devices
Mobile Access for iPad
Mobile Access for iPhone
Mobile Access for Windows Phone
Mobile Workflow for BlackBerry
Note: Actions that require user interaction are not supported for use with these
modules.
Task When configuring an ad hoc task in a life cycle that supports ownership in a Unity
Executor Life Cycle, the Task Executor Takes Ownership option is available.
Takes
When this option is selected, when a user executes the task, the user automatically
Ownership
owns the item the task was executes upon.
Password Protection
2012 Hyland Software, Inc.
792
OnBase 12 Workflow
You can password protect task list execution. If you select None, no password protection is
configured. If you select Task, when an ad hoc task is initiated in the Workflow Client, users
will be prompted to enter their passwords once, regardless of the number of documents that
are selected. If you select Document, when an ad hoc task is initiated in the Workflow Client,
user will be prompted to enter their passwords for each document that the ad hoc task will be
Note: In the Core-based Workflow interfaces, a transaction is logged whether or not the user
enters a correct password.
When a password protection task is executed, it is logged for each document it was executed
upon and will display on the Workflow Transactions tab of the Document History dialog box. If
Disable Logging is selected at the queue level, this is not logged.
Note: When using NT Authentication or LDAP Authentication, if the wrong password is entered
exceeding the configured failed login attempt limit, the user account is locked in Active
Directory.
Icon
1. To assign an icon to represent the task, click the Icon tab.
2. Select an icon from the drop-down list to represent the task in the Tasks Window and
an icon from the Small Icon drop-down list to represent the task in the Repositories
pane.
2012 Hyland Software, Inc.
793
Workflow OnBase 12
Note: Task lists for rules configured as filter rules are not executed regardless of the result of
the rule evaluation. These rules are used strictly to determine whether or not an ad hoc task
should be displayed.
Once a filter rule has been configured for an ad hoc task, a Filter Rules folder is displayed
under the task in the Repositories pane.
To configure filter rules for an ad hoc task:
1. In the Repositories pane, select the ad hoc task for which you would like to configure
filter rules, right-click and select New | Filter Rule.
2. A filter rule is displayed. Enter the name of the filter rule.
3. Configure the rule appropriately to determine when the ad hoc task should be
available.
Note: The On True and On False task lists do not need to be configured. It is recommended that
you not configure these for filter rules. The rule evaluation for a filter rule is used to
determine if the ad hoc task should be displayed.
You can add a task list to an ad hoc task list by either right-clicking on the task and selecting
New | Task List or clicking the Task List button from the Life Cycle ribbon within the New ribbon
group.
Note: This is legacy functionality and are no longer required to be configured separately from
standard ad hoc user tasks. These are supported for systems configured before the support of
ad hoc tasks in the Web Client.
2012 Hyland Software, Inc.
794
OnBase 12 Workflow
This type of task list allows you to create tasks for the web-view task list that emulate
functionality available on the non web-based Client module.
The Web/API Tasks folder is only displayed in a queue if a Web/API task exists. To create a
Web/API task:
Note: If you want to assign all of the user groups currently assigned to the queue to the Web/
API Task, click Add All Assigned to Queue. After clicking this button, if user groups are added at
the queue level, the Web/API Task user group rights are not automatically updated.
Note: The task list ID number is displayed in the upper right hand corner.
Caution: If you have Document Types configured to delete the original document upon redaction,
a user should not create a redacted image of a document within these Document Types while a
Workflow task list is being executed on that document. This may result in unexpected behavior,
since the task list is trying to execute against the a document that has been deleted.
2012 Hyland Software, Inc.
795
Workflow OnBase 12
1. Select the system task, ad hoc task, action, or rule result in which you want to
configure the task list.
2. Right-click and select New | Task List or click the Task List button in the Life Cycle
ribbon within the New ribbon group.
Workflow Studio Configuration
Note: Task lists cannot be named the same as a common task list, which includes the
following: On True, On False, System Work, User Work, Load Balancing Work, or On Abort.
See Task Options on page 797 for more information on task options.
See On Abort Task Lists on page 796 for more information about on abort tasks.
You can add a task list to a task list by either right-clicking on the task and selecting New |
Task List or clicking the Task List button from the Life Cycle ribbon within the New ribbon
group.
2012 Hyland Software, Inc.
796
OnBase 12 Workflow
Note: On Abort task lists are only available in the Core-based and Web Client interfaces.
On Abort task lists are task lists that execute when an abort occurs. An abort occurs in the
following situations:
Note:The Exit button used during re-indexing user interaction is not considered an abort.
These task lists are designed to be used in conjunction with a task list that involves user
interaction. As such, On Abort task lists should not be configured in System Work, Timer
Work, or Load Balance Work. No more than one On Abort task list can be created per task list.
User interaction should not be configured as part of the On Abort task list.
Note:The On Abort task list will display above the user work it is configured for. During a
Workflow session, the user will complete user interaction normally. The On Abort task list will
be rolled back to in the case of an abort.
Note:If a nested task list does not have an On Abort task list configured for it, and an abort
occurs, the closest upward On Abort task list will execute.
Task Options
The following options are available for all tasks and task lists.
2012 Hyland Software, Inc.
797
Workflow OnBase 12
Help Text
For ad hoc tasks and Web/API tasks, information added to this box will display when the
tasks icon is hovered over. For task lists configured for a rule queue, load balancing work,
system work, On Abort, and user work, this box is used for informational purposes within the
Configuration module and Workflow Studio and does not display in the Client. For all tasks
Workflow Studio Configuration
and work, the maximum number of characters that can be entered is 250.
Break On
The Break On section pertains to how the system reacts when it encounters a rule.
Option Description
Success On success of an evaluation, the system stops processing the current task list on
the document. This means that if a rule evaluates to true, it will complete the On
True tasks before breaking.
Failure On failure of an evaluation, the system stops processing the current task list on the
document. This means that if a rule evaluates to false, it will complete the On False
tasks before breaking.
Never Default setting. Processing of the task list continues, regardless of success or
failure of the evaluation.
Additional Options
Option Description
Disable Temporarily disables the task list. Allows for the testing of changes to configuration
without giving access to users. A task list in a disabled state appears grayed-out.
Enable Used for determining the location of logic problems in a Workflow configuration.
Debug Causes a message box to display before the execution of the rule.
Breakpoint
To use this option in the OnBase Client, you must have the WFTRACE switch on the
command line of the Client module and the Step Debug toolbar button or the Debug
Window open in the Client module. A command line switch is not required to use
this option in the Unity interface.
Note: This option is only supported in the Classic Client, Core-based client, and Unity
Client interfaces.
Log When selected and the task is executed, an entry is made into the system's
Execution database. If the task list is disabled when an entry is made, it will be logged in the
system's database that the task list was disabled at the time of execution.
2012 Hyland Software, Inc.
798
OnBase 12 Workflow
Creating Shortcuts
You can create keyboard shortcuts to execute Ad Hoc Tasks in the OnBase Client. To create a
shortcut, place a & character in front of the letter you want to use in the shortcut. The letter
that you placed the & character in front of will display with an underline in the Client. Pressing
Note: Ad hoc task shortcuts are only supported in the OnBase Client Classic and Core-Based
interfaces.
1. Select the item you want to delete in the Repositories pane, right-click and select
Delete.
2. A message asking Are you sure you want to remove the item name from the task list? If
the item does not exist in another life cycle or queue, the Delete the item name from
the database option is displayed. Select this option if you want to completely remove it
from the database.
3. Click Yes to delete the item. Click No to abort the deletion.
To delete a timer:
1. Select the item you want to delete in the Repositories pane, right-click and select
Delete.
2. A message asking Are you sure you want to remove the timer name from the queue
queue name? If the item does not exist in another life cycle or queue, the Delete the
item name from the database option is displayed. Select this option if you want to
completely remove it from the database.
3. Click Yes to delete the item. Click No to abort the deletion.
You can click the Break Link icon, shown on the right side of the provided example.
When the link is broken, the item will be renamed automatically and any changes made will
not impact the item it was previously linked to.
2012 Hyland Software, Inc.
799
Workflow OnBase 12
The second button on the right is the Show References button. Click on this button to show all
the places the item is used. This information is displayed in the References tab.
Configuring Roles
Workflow Studio Configuration
Within Workflow Studio, you can configure roles that can be used in load balancing queues
and rule queues. A role is a specific function an employee will perform. In order to assign
users to roles, you must create defined roles. To configure roles:
1. In the Home ribbon within the OnBase ribbon group, click Roles.
2012 Hyland Software, Inc.
800
OnBase 12 Workflow
2. Click Add.
Documentation Tab
The Documentation tab for life cycle items allows you to add descriptive information within
Workflow Studio configuration. The Overview field allows you to add text that gives an overall
description and is displayed within the Repositories pane for the item under the items name.
If you enter a URL in the Overview field, it will be an active link in the Repositories pane. The
Details field allows you to add additional information about the item for documentation
purposes.
2012 Hyland Software, Inc.
801
Workflow OnBase 12
1. With the life cycle selected, either click the Create Documentation button on the Life
Cycle ribbon within the Life Cycle ribbon group or right-click on the life cycle in the
Repositories pane and select Create Documentation.
2. Select either Administration Guide or User Guide. If you created a custom template, that
template will be available for selection, as well.
2012 Hyland Software, Inc.
802
OnBase 12 Workflow
3. Click Next.
2012 Hyland Software, Inc.
803
Workflow OnBase 12
6. Enter the appropriate solution parameters. Administration guides have the following
parameters: Solution Name and User Forms Location. User guides have the Solution
Name parameter.
The Solution Name parameter is the name of the solution. The Solution Name is the title
displayed on the first page of the generated document.
The User Forms Location is the path to where user forms are stored for the solution.
2012 Hyland Software, Inc.
804
OnBase 12 Workflow
7. Click Next.
Note: You do not need Microsoft Word to generate documents, but you do need it to view
generated documents.
Configuration Overview
You can create your own custom templates for documentation generation. In addition to
formatting, you can control the Workflow data that is generated from the custom template.
2012 Hyland Software, Inc.
805
Workflow OnBase 12
To create a functioning custom template for documentation generation in Workflow Studio you
must complete four basic steps:
3. Created the .XML file that contains information about the templates.
4. Install the template in Workflow Studio.
The main template contains the fields that will be generated in a document. The fields can
reference fragments.
The fragment template contains fragments as well as fields that rely on those fragments.
Fields that rely on fragments should be placed within the appropriate fragments. For example,
the Queue fragment (wffrag.Queue) could contain a field that pulls the name of the queue
(wffld.Name). wffrag.Queue would be placed in the fragment template and wffld.Name would
be placed within the wffrag.Queue control.
All three of these files are required for successful installation. See Installing the Template on
page 811 for more information about installation.
Caution: Backup your templates and .xml file to a location other than where you install then. If
you uninstall Workflow Studio, your templates and .xml file will be uninstalled as well.
Understanding Tags
Tag information is accessed in the Documentation Tags link in the bottom right corner of the
Create Documentation Wizard.
2012 Hyland Software, Inc.
806
OnBase 12 Workflow
Understanding Fragments
Fragment information is accessed in the Documentation Tags link in the bottom right corner of
the Create Documentation Wizard.
When you select a Fragment type, information necessary to configure the template is
displayed.
The Tag specified in the field listed for the selected Fragment must reside within the template
in order for the data to be pulled into the generated documentation correctly.
Available in Fragment specifies the Fragment that can pull the selected Fragment. For instance,
queue information would need to exist in a life cycle fragment since the queue information is
dependent on the life cycle it is in. The only Fragment type that will have fields that exist in
the main template is Document type.
Note: You must configure a template in Microsoft Word with the Developer tab enabled.
Enabling the Developer tab varies by version. See Microsofts documentation for more
information.
Tip: To ensure your styles are uniform throughout, use the same style configurations for the
both the main template and fragment templates.
In order for a template to pull values from Workflow Studio into a Word document, you must
map Workflow tags to Microsoft Word controls. Both the main template and fragment
template are configured using the same steps. The difference between the two is the fields
within the template. See Accessing Tag Information in Workflow Studio on page 809 for more
information about the tags available and the differences between them.
2012 Hyland Software, Inc.
807
Workflow OnBase 12
In Microsoft Word:
1. From the Developer tab, select a Rich Text or Rich Text Content Control control,
depending on your version of Word.
2. Place the control in the document in the appropriate place.
Workflow Studio Configuration
3. After the control has been placed in the appropriate place in the template, access the
Properties for that control by selecting the control and clicking the Properties button.
4. In the Tag field, enter the name of the tag that is specified in the Documentation Tags
dialog box within Workflow Studio. For example, if you want to generate a field for a
the initial queue of a life cycle, you would enter wffld.InitialQueue. The Documentation
Tags dialog box describes each tag that is available. See Accessing Tag Information in
Workflow Studio on page 809 for more information about the tag.
5. Once you have configured the template with the appropriate fields and format, save
the template with a .docx extension.
1. Create a Rich Text or Rich Text Content Control control with the tag of the data you want
to generate from Workflow Studio.
Fragments that can populate tables will have the suffix of Table. Example:
wffld.AssignedFilterTable. Within the Documentation Tags dialog box, fields that
populate tables will have a expandable Table Definition section that defines the data
tags which can be placed within table cells.
2. Insert a standard Word table within that control.
3. Insert the Table Definition data tags within the table cells as appropriate. The data tag
names should be placed with { }.
As an example, when configuring a wffld.AssignedFilterTable, the following data tags
could be placed in a 3 column table:
Caution: If you do not use { } as a placeholder and leave the column empty, the document
generator will remove that column from the table.
2012 Hyland Software, Inc.
808
OnBase 12 Workflow
2012 Hyland Software, Inc.
809
Workflow OnBase 12
<userdefinedfields>
<userdefinedfield name="Solution Name" tag="SolutionName"
default="Solution Name" />
<userdefinedfield name="Form Location" tag="UserFormsLocation"
Workflow Studio Configuration
Setting Description
name Name of the document. This name will appear in the Create
Documentation Wizard.
2012 Hyland Software, Inc.
810
OnBase 12 Workflow
Setting Description
2012 Hyland Software, Inc.
811
Workflow OnBase 12
On the left side of the screen, there is a Toolbox button. Hover over Toolbox to display the
queue objects you can use to build your life cycle. You can click the Auto Hide pin button to pin
the Toolbox to keep it displayed.
Workflow Studio Configuration
Note: Rule queues are used in conjunction with the Business Rules
Engine module.
2012 Hyland Software, Inc.
812
OnBase 12 Workflow
Note: Rule queues are used in conjunction with the Business Rules
Note: Rule queues are used in conjunction with the Business Rules
Engine module.
Load Balance by Users | Creates a load balanced queue pre-configured as a Rule Based
Rules Based Load Balance Type and Users Assignment Type.
Load Balance by User Groups Creates a load balanced queue pre-configured as an Allocated
| Allocated Percentage Percentage Load Balance Type and User Groups Assignment
Type.
Load Balance by User Groups Creates a load balanced queue pre-configured as a By Priority
| By Priority Load Balance Type and User Groups Assignment Type.
Load Balance by User Groups Creates a load balanced queue pre-configured as an In Order
| In Order Load Balance Type and User Groups Assignment Type.
Load Balance by User Groups Creates a load balanced queue pre-configured as a Keyword
| Keyword Based Based Load Balance Type and User Groups Assignment Type.
2012 Hyland Software, Inc.
813
Workflow OnBase 12
Load Balance by User Groups Creates a load balanced queue pre-configured as a Match
| Match Keyword to User Keyword to User Name Load Balance Type and User Groups
Name Assignment Type.
Workflow Studio Configuration
Load Balance by User Groups Creates a load balanced queue pre-configured as a Rule Based
| Rules Based Load Balance Type and User Groups Assignment Type.
Load Balance by User Groups Creates a load balanced queue pre-configured as a Shortest
| Shortest Queue Queue Load Balance Type and User Groups Assignment Type
Load Balanced by Roles | Creates a load balanced queue pre-configured as a Rule Based
Rules Based Load Balance Type and Roles Assignment Type.
When you double-click on a queue in the Design Layout, the queue is selected and expanded
in the Repositories pane.
You can align two or more shapes with one another. You can click and drag your cursor across
multiple shapes to select them or you can press Shift on the keyboard and click on the shapes
you want to align. The shape that the other selected shape(s) will align with is the shape with
the darkest selection border, indicating the primary shape of the selection. In the example
below, the bottom shape is the shape that the top shape will be aligned with.
In the Design ribbon toolbar, you can select the following options:
Option Description
Align Left Aligns the shapes to the left border of the primary shape.
Align Top Aligns the shapes to the top border of the primary shape.
Align Right Aligns the shapes to the right border of the primary shape.
Align Bottom Aligns the shapes to the bottom border of the primary shape.
Make Same Width Makes the shapes the same width as the primary shape.
Make Same Height Makes the shapes the same height as the primary shape.
Make Same Size Makes the shapes the same size as the primary shape.
Snap to Centers When toggled on, when moving shapes in the editor, the shapes
being moved snap to the center of another shape to aid with shape
alignment. While moving shapes, a dotted line appears showing
the alignment of the shape centers.
Additionally, you can use the Horizontal and Vertical buttons to align the queue.
When Horizontal is clicked, the first queue is put in a row. Any rows that have a transition
from the first queue are placed in the next row. The third tier queues are placed in the third
row and so on.
2012 Hyland Software, Inc.
814
OnBase 12 Workflow
When Vertical is clicked, the first queue is put in a column. Any rows that have a transition
from the first queue are placed in the next column. The third tier queues are placed in the
third column and so on.
Formatting Connectors
Option Description
Source Connection | Sets the source of the connector to the default position on the
Automatic shape.
Source Connection | Left Sets the source of the connector to the left side of the shape.
Source Connection | Top Sets the source of the connector to the top side of the shape.
Source Connection | Right Sets the source of the connector to the right side of the shape.
Source Connection | Bottom Sets the source of the connector to the bottom side of the shape.
Target Connection | Sets the target of the connector to the default position on the
Automatic shape.
Target Connection | Left Sets the target of the connector to the left side of the shape.
Target Connection | Top Sets the target of the connector to the top side of the shape.
Target Connection | Right Sets the target of the connector to the right side of the shape.
Target Connection | Bottom Sets the target of the connector to the bottom side of the shape.
In addition, you can change the color of a connector. To change the color of a connector,
select the connector, click the Format tab, and select a color from the Line Color drop-down
box.
1. Click the small button in the lower right hand corner of the Format ribbon, highlighted
below.
2012 Hyland Software, Inc.
815
Workflow OnBase 12
2. Upon clicking this button, the Format Style dialog box is displayed. Select the Line tab.
Workflow Studio Configuration
3. Move the slider to the right to make the line of the connector thicker and move the
slider to the left to make the line of the connector thinner.
4. Click OK.
Note: You cannot use the Undo right-click option to undo deleting or renaming a queue.
2012 Hyland Software, Inc.
816
OnBase 12 Workflow
Timers
Timers allow OnBase to execute rules or actions at a specific time. Timers can be configured
to execute periodically, after a certain amount of time, or at an exact point in time.
Note: Business Day(s) is only available if a Work Calendar has been assigned to the life cycle.
5. Set the status of the First Document Only check box. If enabled, the Workflow Timer
will only execute against the first document found in the queue, instead of executing
against every document found in the queue. The first document found is determined
by the lowest Document Handle value in the queue. Example: This option can be used
to send out a notification that a queue contains documents that need attention. If First
Document Only is not selected, if the queue contains 100 documents, the notification is
sent 100 times (once for each document).
Note: If your business process requires that documents are processed by the timer in the
order specified for the queue by the Sort Documents By option of the queues Advanced tab,
select the Respect Queue Sort Order option. If this option is not selected, documents are still
processed in the order they are returned from the database. Only use this option if necessary,
as it may slow performance.
6. If the Log Start/Stop option is selected, every time the selected timer is executed or
stopped, it will be logged in the systems database.
Note: All logs will show the database server time, rather than the processing workstations
time.
7. If you want the timer to execute on items that are owned by the user configured to run
the timer, select Respect Ownership. All items not owned by the user configured to run
the timer will not be processed by the timer.
8. Save the repository to save the changes to the timer.
2012 Hyland Software, Inc.
817
Workflow OnBase 12
Managing Timers
If timers are configured to run at the same time, the system will kick off the first timer in the
list; the next timer, scheduled for the same execution time, will not begin until the previous
one completes.
The server that manages and executes the timers is a primary factor in the life cycles
efficiency. For example, if the OnBase Client that initiates a life cycle must also perform all of
the System Work for a document, the placement of workload is important. If you are running
a DIP Process that feeds a Workflow Queue then you may want to consider using a timer to
kick off the system work.
Timers can been monitored in the Classic Client interface using the Workflow System Monitor
when the WFSRVR command line switch is applied. For all other user interfaces, timers can
be monitored using the Workflow Timer Service. Refer to the Workflow Timer Service
documentation for more information.
Note:The -LT command line switch indicates the log off time of the Client module. Be aware of
timers that may be running when using the auto logoff switch because they will not trigger
unless the Client workstation is logged in to OnBase.
2012 Hyland Software, Inc.
818
OnBase 12 Workflow
User Forms
Note:User forms are created in the same manner as E-Forms. For more information about
creating a user form, see the E-Forms documentation.
1. In the Home ribbon within the OnBase ribbon group, click User Forms.
2. Select the appropriate Repository from the drop-down select list.
3. Select the appropriate Life Cycle from the drop-down select list.
4. Click Add on the User Forms dialog box to open the Properties dialog box.
5. Enter the Name of the form in the field.
6. Type the file path in the Location field or click Browse, select the file and click Open.
Tip:Use UNC paths to the file because drives are not always mapped to the same letter on
workstations throughout a network.
Note:If you are using Distributed Disk Services, see the Distributed Disk Services
documentation for more information about constructing appropriate paths.
7. Click OK.
8. Click Close on the User Forms dialog box once the location to the form has been saved.
Note: The instance number must be in place, even if there is only one instance. Without the
instance number, the form field will fail and the property will not be input into the property
bag.
Note: This form field applies only to user forms. If it is used on an E-Form, no action will be
taken on any data input into the form field. E-Form fields configured in the above format will
need to be changed to continue to function properly in Workflow.
2012 Hyland Software, Inc.
819
Workflow OnBase 12
1. In the Home ribbon within the OnBase ribbon group, click User Forms.
2. Select the appropriate Repository from the drop-down select list.
3. Select the appropriate Life Cycle from the drop-down select list.
4. Click Add on the User Forms dialog box to open the Properties dialog box.
5. Enter the Name of the form in the field.
6. In the Properties dialog box, type in the URL of the form you wish to use, in the form
http(s)://www.domainname.com in the Location field. Click OK.
7. At the User Forms box, click Close to complete the configuration.
Note: The form is configured for use in the same way as a standard user form, however,
OnBase must pass an obTarget parameter to the form. This can be accomplished by
embedding script in the form to retrieve this parameter and set the forms action attribute.
Whenever the user submits a form, the form needs to be directed back to the Workflow
interface for further processing. The form must programmatically retrieve the value of a
querystring parameter called obTarget and set the action attribute of the form to this value.
The following is an example using JavaScript in the HTML page's OnLoad event:
document.forms.item(0).action = location.search.split("obTarget=")[1];
E-Forms are also utilized in Workflow when using certain form actions. These differ from user
forms in that they must be imported into OnBase and the system must be licensed for the E-
Forms module.
1. In the Home ribbon within the OnBase ribbon group, click User Forms.
2. Select the appropriate Repository from the drop-down select list.
3. Select the appropriate Life Cycle from the drop-down select list.
4. Select the user form you want to modify.
5. Click Modify.
6. Modify the user form as appropriate and click OK.
1. In the Home ribbon within the OnBase ribbon group, click User Forms.
2. Select the appropriate Repository from the drop-down select list.
3. Select the appropriate Life Cycle from the drop-down select list.
4. Select the user form you want to delete.
2012 Hyland Software, Inc.
820
OnBase 12 Workflow
5. Click Delete. Are you sure you want to delete the specified user form? is displayed. Click
Yes to confirm the deletion. Click No to cancel the deletion.
Note: If the user form is used in a life cycle, a message stating The user form is used by action
<name of action> in life cycle <name of life cycle>.
1. In the Home ribbon within the OnBase ribbons group, click Notifications.
2. Select the Repository from the drop-down select list in which you want to configure the
notification.
3. Select a Life Cycle from the drop-down select list if the notification is assigned to a
specific life cycle to limit the notifications displayed.
4. Click Add. The Notification Configuration dialog box is displayed.
2012 Hyland Software, Inc.
821
Workflow OnBase 12
Note: When configuring notifications for use with the BPMN Modeler module, recipients should
not be configured. The recipients are determined by configuration of the BPMN Modeler
module for the users assigned as approvers and auditors.
Workflow Studio Configuration
9. Different types of recipients can be configured for a notification from the Type drop-
down select list and then populating the Mail Recipient field appropriately:
Address: allows you to specify an External mail e-mail address to be used for the
notification.
Keyword Type: takes the value of that Keyword Type on the current item, and uses
that as the address to send the notification. The Keyword Value could be a user or an
external mail address, if your system has external mail enabled. The Keyword Value
can contain multiple addresses, separated by a comma or a semicolon.
Load Balancing Members: when selected, a drop-down select list containing all of the
load balancing queues in the system displays. Adding a queue assigns the load
balancing user group(s) to the recipient list. For external notifications, if the user
that is assigned to the document (or to all members of the user group that item is
assigned to) in the Client has an e-mail address configured (select Users | User
Names/Passwords and click Settings in the Configuration module), an e-mail will be
sent to the specified address.
Note: Queues configured as Match Keyword to User Name queues are not in the list of
available queues in the drop-down select list.
Property (Session): takes the value of a property specified on the current item and
uses that as the address to send the notification. This is a session based property.
2012 Hyland Software, Inc.
822
OnBase 12 Workflow
Role Members: when selected, a drop-down select list containing configured roles in
the system is displayed for configuration.
Note: The Role Members recipient option is not supported for the Classic OnBase Client User
Interface.
Caution: Extra characters, such as '[', ']', '<', '>', will cause notifications to not be sent properly.
Using prefixes such as "mail:" and "fax:" before e-mail addresses will cause notifications to not
be sent properly.
10. To send the notification internally, you must select the Internal mail option before
clicking Add.
Note: When sending internal notifications, if no keyword on the notification is a valid OnBase
user name, the notification will not be sent. This will happen even if a valid e-mail address is
present.
To send the notification externally, select the External mail option before clicking Add.
When sending an external notification, an e-mail address must be present for the
notification to be sent. OnBase will not attempt to match e-mail accounts with internal
user names. However, OnBase will attempt to match internal user names with e-mail
accounts.
To send the notification both internally and externally, select Both before clicking Add.
Note: After a system upgrade, if recipients were previously configured, the Mail Type may be
displayed as Not Configured. The users mail type must be updated. To update the mail type
used for a user, select the user, select the appropriate mail type radio button, and click Update
Mail Type. If the mail type is not updated, the recipients will be handled in the following way:
User and User Group notifications will be sent as internal mail; Address notifications will be
sent as external mail; load balance queue recipients will retain the Internal or External setting
as previously configured; Keyword recipients will first try to resolve the value as an internal
user and if found, an Internal notification is sent. If a valid OnBase user is not found, an
attempt is made to resolve the value with an e-mail account and send it externally.
11. Once a type has been configured, click Add. Multiple types of recipients can be
combined, allowing the notification to be sent to everyone in a user group, a user who
is not in that group, a user name or address specified in a Keyword Value or any
combination of these by repeating steps 9 through 11 for each type required. If a
recipient is a member of multiple groups on the recipient list, only one message is
sent.
Note: If an invalid e-mail address/distribution list is included for an external notification, the
invalid addresses are ignored and the e-mail is sent to any valid addresses/distribution lists.
2012 Hyland Software, Inc.
823
Workflow OnBase 12
Workflow Studio Configuration
13. If you are configuring multiple values for a Keyword Type to display, you can specify
the characters that separate the values using the Separator and Last Separator drop-
down lists. The options are a dash (-), a comma (,), and, and or. The Last Separator
drop-down specifies the separator displayed between the last two values. Alternately,
you can type separators in the fields.
14. If you are licensed for Integration for Microsoft Outlook 2007 or Integration for
Microsoft Outlook 2010 and you want users to be able to perform ad hoc tasks from
Outlook e-mail notifications, select Add Outlook Header.
Note: Ad hoc tasks for queues configured with the Auto-Feed or Exclusive Viewing options are
not available in Outlook e-mail notifications. Ad hoc tasks for load balancing queues are only
available when the document is assigned to the logged in user.
15. If you want to send the notification as a Unity Pop URL, select Send Attachments as
Unity Pop. When this option is selected, you have two options.
If you want the URL to open in a new window, select Open Documents Using a New
Window.The notification will be sent via the Distribution Service and the attachments
will be sent as Unity Pop URLs.
If you want the URL to open in the Workflow interface, select Display Items Using the
Workflow Layout. The notification will be sent via the Distribution Service and the
attachments will be sent as Unity Pop URLs that will open within the Workflow
interface.
16. Click OK when finished.
2012 Hyland Software, Inc.
824
OnBase 12 Workflow
To remove a recipient from a notification, select the name of the recipient in the list or the
appropriate drop-down list. Click Remove.
Note: In the case of multiple recipients with the same name, messages will not be sent. An
error message will display.
Option Description
%D - Document Date Displays the Document Date. This value can be changed.
%D1 - Document Date Displays the date that the document was stored. This value cannot
Stored be changed.
%I1 - Document Time Displays the time that the document was stored. This value cannot
Stored be changed.
%L - Life Cycle ID Displays the life cycle number of the current document.
%L2 - Life Cycle Name Displays the life cycle name of the current document.
%Q2 - Queue Name Displays the queue name of the current document.
%R - User Real Name Displays the real name of the currently logged in user.
2012 Hyland Software, Inc.
825
Workflow OnBase 12
Option Description
WorkflowPop This option allows you to provide a link to the relevant document
within the Workflow interface in the notification.
The URL dialog box is displayed. Select whether the server is using
a SSL or not. Select HTTPS to specify that SSL is used. Otherwise,
select HTTP. Enter the Server Name of the OnBase Web Server. If
appropriate, enter the Virtual Root where the OnBase Web Server
is installed. Click OK.
DocPop This option allows you to provide a DocPop link to the relevant
document within the notification. The DocPop link only generates a
link based on document handle (docid) and checksum using this
option.
The URL dialog box is displayed. Select whether the server is using
a SSL or not. Select HTTPS to specify that SSL is used. Otherwise,
select HTTP. Enter the Server Name of the OnBase Web Server. If
appropriate, enter the Virtual Root where the OnBase Web Server
is installed. Click OK.
In order for the checksum to work correctly, the web.config file
must have DPCheckSum set to true. For more information about
DocPop, see the DocPop Module Reference Guide.
2012 Hyland Software, Inc.
826
OnBase 12 Workflow
Finding References
To find where a specific action, rule, task, or task list is used, select it, right-click and select
Show References. References to the item are displayed in the References tab. Three columns
Managing Locks
You can manage locks within Workflow Studio. You can access the Manage Locks dialog box by
clicking on the Application Menu button in the upper left hand corner of the application and
select Manage Locks.
You can display only locks that pertain to the BPMN Modeler module or life cycles by selecting
the Display only BPMN and life cycle locks option.
Locks are displayed by repository. Select the Repository from the drop-down select list that
you want to view the lock for.
To remove a lock, select the lock and click Remove Selected.
Click Refresh to refresh the lock information displayed.
2012 Hyland Software, Inc.
827
Workflow OnBase 12
Workflow Studio allows the mapping of a name to WSDL Web Service. Through the use of the
configured Web Services, the Workflow Studio can reference a WSDL via a name.
Subsequently, if a user needs to change the WSDL location, the user only needs to update it
in one place, rather than updating it in every place it is used in the BPMN process. To create a
Web Service:
Workflow Studio Configuration
1. In the Home tab, in the OnBase ribbon group, click the Web Services button. The Web
Services dialog box is displayed.
2. Click Add.
3. Enter the Name of the Web Service. The Name has a maximum of 128 characters.
4. Enter the WSDL Location. The WSDL Location has a maximum of 255 characters.
5. Click OK
You can modify a Web Service by selecting it in the Web Services dialog box and clicking
Modify. Clicking Modify will open the Web Service in the Web Service dialog box, where you can
edit the Name and WSDL Location. Save the repository for changes to be recognized.
2012 Hyland Software, Inc.
828
OnBase 12 Workflow
You can also delete a Web Service by selecting it in the Web Services dialog box and clicking
Delete. A message appears asking Are you sure you want to delete the specified web service?
Click Yes to delete the service. Click No to cancel the action.
Note: The ability to view documents in a life cycle is controlled at the queue level. If a user has
rights to a life cycle queue, they will also have rights to view all the documents in that queue,
regardless of their security rights (i.e., security keyword assignments).
Note: To view documents within Workflow, users need to have access to at least one
Document Type as well as privileges to retrieve / view documents. The Document Type to
which the user is given access does not need to contain any documents, nor does it need to
be associated with the Life Cycle. The user also does not need access to the Retrieval dialog.
Note: To add life cycles to the user group, the workstation must have a Workflow module
license.
Note: In order to grant access to specific queues, the user group must have rights to the life
cycle that contains the queues.
2012 Hyland Software, Inc.
829
Workflow OnBase 12
In addition, life cycles rights can be granted to user groups by right-clicking on a life cycle in
the configuration tree and selecting User Group. You can assign user groups to the selected life
cycle.
Workflow settings can be copied from one User Group to another. These settings include the
following:
Workflow Life Cycles and Work Queues
Workflow System Tasks
Workflow Ad Hoc User Tasks
To copy Workflow rights to another User Group:
1. Select Users | User Groups/Rights. The User Groups & Rights dialog box is displayed.
2. Select the User Group from which you want to copy rights.
3. Click Copy. The User Group Copy Options dialog box is displayed.
4. Enter a new User Group Name that will inherit the selected settings from the existing
User Group.
5. Select the User Group Settings to Copy of the existing User Group that you would like
your new User Group to inherit.
Note: You do not have to choose all settings assigned to the existing User Group.
6. Click Retain Copy Options if you would like to save the selected settings for a future
User Group you will create.
7. Click Copy.
2012 Hyland Software, Inc.
830
OnBase 12 Workflow
Service Accounts
A user account configured as a service account will have the following rights within Workflow:
Retrieve a list of all life cycles including the life cycle name, ID and all other
properties.
1. Click the Configuration Rights button in the User Groups & Rights dialog box.
2. Select the Products tab.
3. Select the Workflow Configuration check box. If you want to grant configuration rights
for all life cycles, select All Life Cycles. If you want to only allow a user group to
configure only the life cycles they have rights to, select Assigned Life Cycles.
4. Click Save & Close. The Workflow menu becomes active in the Configuration module.
5. Click Exit.
Note: If the Use Workflow Configuration Rights option is configured, the rights set at the user
group level are ignored.
2012 Hyland Software, Inc.
831
Workflow OnBase 12
Note: The Workflow Configuration Administration right also gives a specific user the option to
Manage user group layout settings in the Unity Workflow interface.
Workflow Studio Configuration
1. Select Users | User Groups/Rights to display the User Groups & Rights dialog box.
2. Type the new user group name in the field or select an existing one from the User
Group Name list and click Privileges.
3. On the Assigning User Group Privileges for [group name] Group dialog box, check the
Workflow box in Client Based Products.
4. To assign Workstation Options, check the User/Workstation Options box in the Client
Features section.
5. Click Save & Close.
2012 Hyland Software, Inc.
832
OnBase 12 Workflow
To gain access to the Workflow inbox, but deny the right to the Execute Workflow
right-click menu outside of Workflow
1. Select Users | User Groups/Rights to display the User Groups & Rights dialog box.
2. Type the new user group name in the field or select an existing one from the User
Change viewing privileges to life cycles and queues in the Workflow inbox
In order for users to access life cycles, they must have the appropriate privileges.
Note: The MANAGER and ADMINISTRATOR accounts must be assigned specific rights to any
queues those user groups require access to.
3. Select life cycle(s) from the Life Cycle list on the Available for selection list. The
associated queues are selected in the Work Queue list below. You can deselect
individual queues by clicking them in the Work Queue list.
4. Click the Add>> button to move the life cycle and queues to the Selected for Group list.
To revoke access, select the life cycle(s) on the Selected for Group list and click the
<<Remove button.
5. When finished, click Close.
Note: When using the Classic Client interface, users must be assigned to more than one queue
in order for the Life Cycle window to be displayed by default. If you only want to assign users
to one queue and make the Life Cycle window available by default, create a hidden queue and
assign it to the users that you only want to access one Workflow queue.
2012 Hyland Software, Inc.
833
Workflow OnBase 12
2. On the Ad Hoc User Tasks dialog box, select the task(s) from the Available list and click
the Add>> button to move them to the Selected list. To revoke access, select the
task(s) on the Selected list and click the <<Remove button.
Note: Only ad hoc tasks belonging to life cycles to which users have rights are displayed for
selection.
2012 Hyland Software, Inc.
834
OnBase 12 Workflow
Note: The Workflow Administrator privilege overrides all queue level privileges in those queues
that the user/user groups has rights.
Caution: The MANAGER and ADMINISTRATOR user will automatically be granted Workflow log
purging privileges when the Workflow or Workflow Restricted privilege is granted.
General
The following options are configured in the General screen:
Option Description
Restore Default Layout You can restore the layout of the application to the original default
layout by clicking the Restore Default Layout button. The layout
is restored to the default.
Maximum Recent Items You can specify the maximum number of recently viewed items
that are displayed on the start page in the Maximum Recent
Items field.
2012 Hyland Software, Inc.
835
Workflow OnBase 12
Option Description
Display the graphical editor When this option is selected, the graphical layout is displayed upon
when a new life cycle is creating a life cycle.
created
Workflow Studio Configuration
Allow navigation to other life When this option is selected, if a queue has an action that allows
cycles in the graphical editor an item to be added to another life cycle, for example it has the
(requires restart) Add Document to Other Life Cycle action configured, the Workflow
Studio will display a plus sign on the queue within the design
layout window. Clicking on the plus sign opens the life cycle the
queue is capable of added items to in a design layout window.
Display life cycle graphical When this option is selected, when you hover over a life cycle in
layout as tooltip in the the Repositories pane, a thumbnail of the graphical layout is
repository tree (requires displayed.
restart)
Note: After changing this option, the Workflow Studio must be
restarted.
Display user work queue When this option is selected, a user work folder is always displayed
folder (requires restart) in a life cycle, even if user work is not configured
Display action/rule type When this option is selected, the name of the rule type or action
name type is displayed directly below the rule/action in the Repositories
pane.
2012 Hyland Software, Inc.
836
OnBase 12 Workflow
Doctor
The following options control the user of the Workflow Doctor within the Studio. The following
options are available:
Validate items when a Select this option if you want a repository to be evaluated by the
repository is opened Workflow Doctor upon opening a repository in the Workflow
Studio.
Underline repository tree When this option is selected, life cycle items that have warnings
items that contain warnings identified by the Workflow Doctor will be underlined in blue and life
and error (requires restart) cycle items that have errors identified by the Workflow Doctor will
be underlined in red. If both errors and warnings exist, the life
cycle item will be underlined in red.
Highlight error issues in When this option is selected, errors are highlighted in the
property pages (requires Properties pane to easily identify the specific issue.
restart)
Note: After changing this option, the Workflow Studio must be
restarted.
Highlight warning issues in When this option is selected, warnings are highlighted in the
property pages (requires Properties pane to easily identify the specific issue.
restart)
If an action type is not defined, it is not highlighted, but can be
listed as an error in the Doctor Results tab.
Actions and rule When this option is selected, actions and rules are checked for
configuration issues configuration issues.
Action and rule licensing When this option is selected, actions are checked for licensing
issues issues.
Actions that have no action When this option is selected, actions are checked for when no
type set action type is set.
Business process folder When this option is selected, business process folders are checked
configuration issues for configuration issues.
Disabled actions and rules When this option is selected, life cycles are checked for disabled
actions and rules.
2012 Hyland Software, Inc.
837
Workflow OnBase 12
Option Description
Disabled task lists When this option is selected, life cycles are checked for disabled
task lists.
Life cycle configuration When this option is selected, life cycles are checked for
Workflow Studio Configuration
Notification configuration When this option is selected, notifications are checked for
issues configuration issues.
Obsolete actions and rules When this option is selected, action and rules that are not
supported in the Workflow Studio are reported.
Portfolio Type configuration When this option is selected, portfolio types are checked for
issues configuration issues.
Queue configuration issues When this option is selected, queues are checked for configuration
issues.
Rules that have no rule type When this option is selected, rules are checked for when no rule
set type is set.
Task list configuration issues When this option is selected, life cycles are checked for task lists
with configuration issues.
Timer configuration issues When this option is selected, timers are checked for configuration
issues.
Transition configuration When this option is selected, life cycles are checked for transition
issues configuration issues.
Unsupported user When this option is selected, Workflow Doctor reports issues if an
interaction action or rule requires user interaction that a client does not
support. (specified in the display issues related to client category)
User form configuration When this option is selected, user forms are checked for
issues configuration issues.
OnBase Client Classic When this option is selected, issues directly related to the Classic
interface Client Workflow interface are reported.
OnBase Client Core-based When this option is selected, issues directly related to the Core-
interface based Client Workflow interface are reported.
Unity When this option is selected, issues directly related to the Unity
Workflow interface are reported.
Web When this option is selected, issues directly related to the Web
Client Workflow interface are reported.
2012 Hyland Software, Inc.
838
OnBase 12 Workflow
Action/Rule Categories
The Action/Rule Categories screen allows you to define what special action/rule categories are
displayed:
Agenda Manager Select this option if you want actions and rules related to the
Agenda Management module displayed.
Electronic Plan Review Select this option if you want actions and rules related to the ePlan
Review module displayed.
Foldering Select this option if you want actions and rules related to managed
folders displayed.
Workview Select this option if you want actions and rules related to
WorkView objects displayed.
Script Editors
The Script Editors screen lets you define options for the Unity script editor within the Studio
Option Description
Show line numbers Select this option if you wan the line numbers displayed in the
editor.
Default language You can select C# or Visual Basic for the default scripting
language used in the Unity script editor.
2012 Hyland Software, Inc.
839
Workflow OnBase 12
You can select a predefined color scheme from the Color Scheme drop-down select list. You
can preview the way items are displayed by selecting items from the Item drop-down select
list.
1. Select the Color Scheme you want to base the customized scheme off of.
2. Click Copy. The Copy Color Scheme dialog box is displayed.
2012 Hyland Software, Inc.
840
OnBase 12 Workflow
Once a customized scheme is created, you can modify items. To modify an item:
1. Select the customized Color Scheme you want to rename from the drop-down select
list.
2. Click Properties. The Color Scheme dialog box is displayed.
1. Select the customized Color Scheme you want to delete from the drop-down select list.
2. Click Delete. A message asking Are you sure you want to delete the Name of Scheme
scheme? is displayed. Click Yes to continue the deletion of the scheme. Click No to
cancel the deletion.
2012 Hyland Software, Inc.
841
Workflow OnBase 12
1. Select the customized Color Scheme you want to export from the drop-down select list.
2. Click the Export button.
Workflow Studio Configuration
2. Browse to the file you want to import and select the file.
3. Click Open. The Color Scheme dialog box is displayed.
About
The About section lists the version of the software as well as copyright information.
Unity Projects
Note: The Unity Automation API license is required to configure Unity scripts in a database.
2012 Hyland Software, Inc.
842
OnBase 12 Workflow
1. Click the Unity Scripts button. The Unity Scripts dialog box displays.
2012 Hyland Software, Inc.
843
Workflow OnBase 12
2012 Hyland Software, Inc.
844
OnBase 12 Workflow
9. Select the user group you would like to grant rights to the project from the drop-down
select list.
10. Click Add.
11. Next to the user group, select View to grant view rights and select Modify to grant
editing rights.
12. Repeat steps 9 to 11 for each user group.
13. Click Next.
14. Click Finish. A tab opens for the project. You can enter the appropriate script.
15. You can click Save to save the project.
You can click Save & Publish to save and publish the Unity Project.
You can click Build to build the Unity Project.
Note: For more information on Unity Scripts, see the Unity Scripting in the Hyland SDK.
2012 Hyland Software, Inc.
845
Workflow OnBase 12
Reference Tab
The References tab contains a list of assemblies that can be referenced by the script.
Version Tab
The Version tab lists the versions of the project that exist. You can also set an version to be
Workflow Studio Configuration
Permissions Tab
The Permissions tab allows you to grant View or Modify rights to users.
Workflow Search
Finding Items in Workflow Studio
You can search open server repositories for items within Workflow Studio. To access this
feature, press Ctrl + f on the keyboard or right-click in the Repositories pane and select Find.
The Find dialog box is displayed.
2012 Hyland Software, Inc.
846
OnBase 12 Workflow
Enter search options and click Find All. Results are displayed in a tab at the bottom left
windows of Workflow Studio.
Search Options
Repository Select the repository you wan to search from this drop-down select
list.
Look at these types (Find This drop-down select list allows you to specify the type of item
Name) you would like to search for.
The following options are available for the Find Name option:
<All>
Actions
BPMN Collaboration Diagrams
BPMN Processes
Business Process Folders
Life Cycles
Queues
Rules
Task Lists
Timers
2012 Hyland Software, Inc.
847
Workflow OnBase 12
Option Description
Look at these types (Find This drop-down select list allows you to specify the type of item
Dependency) you would like to search for.
The following options are available for the Find Dependency
Workflow Studio Configuration
option:
Actions Types
BPMN Collaboration Diagrams
BPMN Processes
Calendars
Document Types
Folder Templates
Folder Types
Keyword Types
Life Cycles
Note Types
Notifications
Organizational Charts
Portfolio Relations
Portfolio Types
Queues
Rule Types
Timers
Unity Scripts
User Form
VB Scripts
Workflow Property Names
Find What You can enter what you want to search for in this field.
Look in You can search in all life cycles within the selected repository, the
currently selected life cycle, or a specific life cycle.
When you select BPMN Collaboration Diagrams or BPMN
Processes from the Look at these types drop-down select list,
you can only select <All> or select a specific business process
folder.
When you select Business Process Folders from the Look at these
types drop-down select list, you can only search for <All>.
2012 Hyland Software, Inc.
848
OnBase 12 Workflow
Option Description
Find Options Match case: Select this if you want the text entered in the Find
What field to be used as a case sensitive search.
Match whole word: Select this if you want to search for the
Result options Find results 1 window: When this option is selected, the search
results will be displayed in the Find Results 1 tab.
Find results 2 window: When this option is selected, the search
results will be displayed in the Find Results 2 tab.
Workflow Doctor
Workflow Doctor is used to examine the state and general health of a life cycle configuration
and the related Workflow system. It can be used to diagnose existing and potential problems
for a Workflow system.
Workflow Doctor can be configured to validate life cycles when a repository is opened or it will
validate a life cycle upon checking out the life cycle.
Doctor Results
The Doctor Results tab reports errors, warnings, and messages for life cycles. The following is
an example of the Doctors Results window.
Results can be filtered using the buttons at the top of the window. You can filter by Errors,
Warnings, Messages, or a selected life cycle. By selecting filter buttons, you are able to narrow
the information displayed in the Doctor Results tab.
2012 Hyland Software, Inc.
849
Workflow OnBase 12
In addition, when a specific life cycle is selected, a button labeled Filter by <life cycle name>
issues is displayed. If you click on this button, the Workflow Doctor results are filtered to only
show issues related to that specific life cycle.
The following columns of information are display:
Severity: Displays the icon for Error, Warning or Message.
Workflow Studio Configuration
Note: Some reported items cannot be opened because they refer to a general issue or refer to
an item that does not exist in a life cycle, but still exists in the database.
2012 Hyland Software, Inc.
850
OnBase 12 Workflow
In the next example, there was a warning that a queue did not have user groups assigned, so
the User Groups tab is highlighted:
Output Tab
The Output tab displays a log of all of the actions taken in Workflow Studio within a session.
This log contains actions that were completed in any repository during the session. The log
items contain a date and time stamp as well as a short description of the action.
2012 Hyland Software, Inc.
851
Workflow OnBase 12
You can copy the contents of the Output tab by selecting the text you want to copy, right-
clicking on the tab and selecting Copy. Alternately, you can press Ctrl + c on the keyboard to
copy the selected text.
You can clear the contents of the tab at any time. To clear the contents of the tab, right-click
in the Output tab and select Clear.
Workflow Studio Configuration
Shortcuts
The Repositories pane can be navigated using the left and right arrow keyboard keys. These
keys can be used to navigate and expand items in the pane.
You can also use the * key on the number pad or Shift + the right arrow key to expand a tree
item and its children in the Repositories pane. These shortcuts do not work on the repository
top level item or on the Life Cycles folder.
You can also use the Shift + the left arrow key to collapse a tree item and its children in the
Repositories pane. These shortcuts do not work on the repository top level item or on the Life
Cycles folder.
Press F5 to refresh the repository in which you have an item selected.
Press Y to select a Yes button.
Press N to select a No button.
If a dialog box contains a Cancel button, you can use the Esc keyboard key to cancel out of the
dialog box.
Exporting
You can export configuration from a repository to an import file that can be imported into
another repository. The following configurations can be exported:
Business Process Folders (when licensed for the BPMN Modeler)
Document Types (if there are multiple revisions of a Document Type, the latest
revision is exported)
Life Cycles
Portfolio Relations
Portfolio Types
System Tasks
2012 Hyland Software, Inc.
852
OnBase 12 Workflow
To export a configuration:
1. Click the Export button in the Home ribbon within the Import/Export ribbon group. The
Export wizard is displayed.
2012 Hyland Software, Inc.
853
Workflow OnBase 12
3. Select the type of item you want to export from the drop-down select list.
4. You can select one or multiple items and click Add>> or you can double-click on an
item to move it to the Export Items field.
5. Repeat steps 3 and 4 for each item type you want to export.
6. If you want to export associated organizational charts with the selected items, select
the Export Referenced Organizational Charts option.
2012 Hyland Software, Inc.
854
OnBase 12 Workflow
7. Click Next.
Tip: You can initiate an export by right-clicking on a life cycle and selecting Export Life Cycle or
by right-clicking on a system task and selecting Export System Task.
2012 Hyland Software, Inc.
855
Workflow OnBase 12
Transitions
Task Lists
Timers
Ad Hoc User Tasks
Comments
Help Text
Roles and Business Calendars
All Dependencies (Including, but not limited to the following: User Groups,
Document Types/Groups, Keyword Types, AutoFill Keyword Set configuration,
Overlays, Note Types, Custom Queries, VB Scripts, E-Forms (If there are multiple
revisions of an E-Form, the last revision is exported), Unity Forms (including
associated Currency Formats, form field settings, data sets, AutoFill Keyword Sets,
Unity Form Themes, and User Groups configured under Form Visibility), User Forms,
Life Cycle and Queue Bitmaps/Icons, Notifications, Print Queues, Print Formats, File
Types, Folder Types, Folder Templates, Portfolio Relations Portfolio Types, Fonts,
Work Folder Filters, SAP Servers, XML Formats, and XML Format Ports.
Note: If a form references a URL, the URL reference and the form are exported.
Caution: Upon import, the Manager user group is granted access to imported AutoFill Keyword
Sets. A user from the Manager user group must appropriately grant AutoFill Keyword Set access
to users.
When importing encrypted keywords, these keywords will lose the encryption flag. If
you wish for the imported keywords to be encrypted, you must lock the system
through the Configuration module (Utils | Database Settings) and reset the
encryption for the Keyword Types.
Data within Data Sets. Upon import, if the destination database already has a Data
Set for the affected Keyword Type, the existing and imported values are merged into
the Data Set, meaning all existing values are kept and only new values are added.
Values will never be removed. If an imported Keyword Type is mapped to a Keyword
Type in the destination database that does not have Use Keyword Data Set option
selected, no values will be imported into the destination database for the mapped
Keyword Type. If imported data set values are longer than allowed by the mapped
destination Keyword Type, they will be truncated.
2012 Hyland Software, Inc.
856
OnBase 12 Workflow
Cascading Data Sets. Data set values are not imported. Only the structure of the
Cascading Data Sets is exported. Upon import, any conflict resolution necessary for
Cascading Data Sets is done after all Keyword Types conflicts are resolved.
Cascading Data Set resolution is accomplished in the following way: If there is a
Cascading Data Set with the same name that has Keyword Types with the same
Note: A Document Type cannot have two Cascading Data Sets assigned if these Data Sets
share a Keyword Type. If this occurs, the user is prompted to create a new Document Type or
unassign the Cascading Data Set from the Document Type.
If you export a rule engine queue, the queue configuration, conditions, outputs,
parameters, and the active condition setting are all exported. Only the latest version
of a rule set is exported. All other versions of a rule set are not exported.
When using Org Charts and users in an Org Chart are members of a load balancing
queue within the life cycle, life cycle users are exported along with any user on
which the exported user is dependent, including the root user.
Caution: When exporting Org Charts and Calendars, ensure that the proper elements are
exported and resolved properly during import.
When using calendars, all business calendars configured for life cycles are exported.
User-specific calendars will be exported for users, but the Time Off information will
not be exported. Upon import, if a user already existed in the destination database,
the business calendar information is not overwritten.
If you have life cycles configured to use actions or rules associated with WorkView,
related WorkView Document Type Associations, applications, classes, notifications,
filters, and attributes are exported.
If you have life cycles configured to use actions associated with the Records
Management module, Managed Folders, Hold Sets, Hold Reasons, Retention Plans,
Event Sets, and Events are exported.
Note: Only the Events that are assigned to actions are exported. Event Sets are exported, but
the Events assigned to an Event Set are only exported if in use by an exported life cycle.
2012 Hyland Software, Inc.
857
Workflow OnBase 12
those templates within that library that are referenced by the associated
Workflow actions are exported.
The import and export of templates are done for the whole template. All fields
configured on the template will be included, and the user will not have the option
of selectively adding or removing fields during the import/export process.
Attribute type fields configured on a template will not be exported.
Image field types configured on a template always reference a specific document
by their document handle, so both the Document Type and the specific document
itself is exported. If this Document Type is not present in the destination system
during the import you then have the option to Map, Replace, or create a new
Document Type. If you choose to create a new Document Type during the import,
it will be created without a Disk Group configured, and the import of the actual
image file document will fail.
The following data is not exported/imported:
Disk Groups
Document Type Icons
User Group Permissions
The following restrictions apply to exported/imported data:
Only keywords specifically used by the life cycle are exported/imported.
Users are imported, but only by name. Imported users are assigned the password
PASSWORD and the user must be reconfigured.
The requirements below are suggestions for best results:
The life cycle should be exported to, and imported from, the same named directory
location. Specify a common directory location for both processes, such as
temp\[defaultfilename.*]. Create the directory, if necessary, before running the
export process.
The life cycle export/import process is designed to deploy the same life cycle to
multiple sites. Note that if an on-site life cycle has been modified in any way, the
same changes should be made to the master copy (export) life cycle, in order to
maintain integrity between the import and export life cycles.
Validate task sequences.
2012 Hyland Software, Inc.
858
OnBase 12 Workflow
Importing
Once you have exported a configuration, you can import it into the appropriate repository.
Note: Importing involves careful scrutiny of the data presented in the import dialogs. Care
must be taken to identify each element in the life cycle to be imported, and determine how
Note: Workflow task lists are always imported as New Objects and assigned new tasklist IDs.
Any existing VBScripts or OnBase API integrations referencing tasklists linked to the imported
life cycle will need to be updated with the new tasklist ID value.
Note: When importing, the database will be locked and users will not be able to log in through
any interface.
To import a configuration:
2. Select the repository you would like to import the configuration into.
2012 Hyland Software, Inc.
859
Workflow OnBase 12
3. Click Next.
Workflow Studio Configuration
4. In the File Name field, enter the path to the export file. Click Browse to browse to the
file.
Alternately, you can resume a previous import that was saved. Select Set initial
resolutions from file and enter the path to the saved import file. Click Browse to browse
to the file.
Caution: It is important to back up your database before importing new configuration. Ensure
that a current backup is created before proceeding.
Caution: Importing does not respect life cycle check out. Importing can affect life cycles
regardless of their check out state.
2012 Hyland Software, Inc.
860
OnBase 12 Workflow
5. Click Next. The resolution screen is displayed. All conflicts are displayed in red.
7. Once all conflicts are resolved, click Next. A summary of the import is displayed.
8. If you want to view the import verification report, select Display Import Verification
Report.
2012 Hyland Software, Inc.
861
Workflow OnBase 12
9. Click Finish to complete the import. The import is not complete until you click Finish. If
you chose to display the verification report, an Import Report tab is displayed in the
interface. See Using the Verification Report on page 867 for more information.
Caution: If a document belonging to the SYS System Overlay Images Document Type is imported
Workflow Studio Configuration
during a Workflow import, and it has the same description as a document found in the
destination database, the existing document is used for overlay. If no match is found, a new
document is created from the import XML file and stored into the database.
Resolving Conflicts
In order to successfully import a configuration, you must resolve all conflicts displayed.
Conflicts can occur when a life cycle being imported contains one or more of the following that
have the same database identification number or name as an item in the new database:
a life cycle
a Unity Life Cycle
queue
Note: When a queue contains an action that using a cache (Doc - Push Document into Cache
or Doc - Push Related Document into Cache), the cache must be configured in the destination
database in order for the conflict to be resolved. You must map to an existing cache.
Note: When importing a Keyword Type that is configured to use auto numbering, if you choose
Create New, the new Keyword Type's initial value starts at 0. If you choose Map To, the
Keyword Type's initial value maps to the keyword value in the destination database and will
use the existing sequence value. If you map a Keyword Type that is configured with auto
numbering to a Keyword Type in the destination database that is not configured with auto
numbering, the mapped Keyword Type will not be configured with auto numbering because
the mapped Keyword Type inherits the properties of the Keyword Type in the destination
database.
Caution: When importing encrypted keywords, these keywords will lose the encryption flag. If
you wish for the imported keywords to be encrypted, you must lock the system through the
Configuration module (Utils | Database Settings) and reset the encryption for the Keyword Types.
custom queries
file types
folder types
folder templates
fonts
print formats
2012 Hyland Software, Inc.
862
OnBase 12 Workflow
print queues
XML formats
XML format ports
notifications
Note: Deactivated users in the destination database are not available for selection using
conflict resolution.
user groups
note types
VBScripts
Note: On import, you can choose to Replace or Map a VBScript to an existing VBScript that has
the same name, regardless of the scope specified for the incoming VBScript.
E-Forms
Note: If a document belonging to the SYS HTML Form Document Type is imported and does not
have a value for the Description Keyword Type, or it has spaces as the value, it will be
imported with a unique, automatically-generated value in the format of Eform ID nnn,
where nnn is the ID number for the form.
user forms
Unity Forms Templates
Note: When resolving this conflict type, ensure that the Document Type associated with the
Unity Form template is assigned all the Keyword Types configured for the Unity Form
template. Document Type conflicts need to be resolved before resolving Unity Form template
conflicts.
Note: If an imported Unity Form template has the same name as a Unity Form template that
already exists in the destination database, but is associated with a different document type,
the user will not be able to use the Map to Same Name button.
Caution: Be extremely careful when mapping Org Charts and Users within the Org Charts. Ensure
that you do not map users in a way that would make them their own managers or their own
assistant. This is not supported.
Roles
2012 Hyland Software, Inc.
863
Workflow OnBase 12
Calendars
Document Composition Libraries
Caution: Security user group rights are not exported for libraries. If you use the Map or Replace
options during the import for library, the user group rights will not change and will remain
Workflow Studio Configuration
according to what was already on the destination system. When using the Create New option for
a library, the MANAGER group will automatically be assigned to have edit access to the library.
Caution: Security user group rights are not exported for templates. If you use the Map or Replace
options during the import for template, the user group rights will not change and will remain
according to what was already on the destination system. When using the Create New option for
a template, the MANAGER group will automatically be assigned to have edit access to the
template.
SAP servers
Managed Folders
Caution: Always resolve Managed Folders before resolving Hold Reasons to ensure you are
resolving the Hold Reasons correctly and matching the Hold Reason with the correct Managed
Folder.
Caution: Always resolve Event Sets before resolving Events to ensure you are resolving the
Events correctly and matching the Events with the correct Event Set.
RIM Events
RIM Retention Plans
RIM Retention Plan Sets
actions and rules that refer to another queue
WorkView Class DTAs
WorkView Filter DTAs
WorkView Applications
WorkView Classes
WorkView Attributes
WorkView Notifications
WorkView Filters
Portfolio Relations
Portfolio Types
reading groups
approval groups
Application Server Gateways
HL7 messages
2012 Hyland Software, Inc.
864
OnBase 12 Workflow
HL7 destinations
DocPop URLs
content sources
Collaboration Templates
1. In the left pane of the screen, select an item that needs to be resolved.
2. Click Resolve. The Resolution (<conflict type>) dialog box is displayed. The example
shows a resolution dialog box for file type conflicts.
Note: You can select Show only unresolved items to hide resolved conflicts.
4. There are three options Map, Replace, and Create New. Replace is not available for all
conflict types, however.
If you want to map the conflict to an existing configuration item, select the item you
want to map to in the Mapping/Replacing Choices box and click Map. Alternately, if you
want to map every conflict to an item with the same name, click Map to Same Name.
If you want to replace an existing configuration item with the conflict, select the item
you want to replace in the Mapping/Replacing Choices box and click Replace.
If you want to create a new configuration item using the conflicts information, click
Create New.
2012 Hyland Software, Inc.
865
Workflow OnBase 12
Auto Resolve will automatically resolve conflicts by mapping conflicts to items of the same
name when they exist and create new items when items of the same name dont exist.
Clicking Auto Resolve will attempt to resolve all conflicts.
Saving Resolutions
You can save the progress of an import conflict resolution to resume at a later time. In order
to save your progress:
Caution: The destination database should not have been changed between the time that the
session was saved and the time the session was resumed.
2012 Hyland Software, Inc.
866
OnBase 12 Workflow
2012 Hyland Software, Inc.
867
Workflow OnBase 12
Workflow Studio Configuration
2012 Hyland Software, Inc.
868
WORKFLOW STUDIO ACTIONS
The actions available depend on the type of life cycle you are configuring. Only actions that
are supported by the type of life cycle you configuring are displayed for selection and
configuration.
Note: System tasks that require user interaction are supported in the Unity and Web
interfaces. System tasks that require user interaction are not supported in all other Core-
based interfaces. When using the Classic Client interface, it is not recommended to configure
system tasks that require user interaction.
Finding Actions
You can limit the rules displayed in Action Type drop-down select list. Click in the field and
type characters to find the action you are looking for. Any action that contains the characters
entered will be displayed in red in the drop-down select list. If only one action meets the
criteria entered, press Enter on the keyboard to select it. In addition, you can enter comma
separated words and phrases to look for actions that contain any of the words and phrases
entered.
1. In the Properties pane, on the General tab, type a property name in the Property Name
field.
2. From the Field drop-down select list, select the field that will be used to set the
property.
2012 Hyland Software, Inc.
869
Workflow OnBase 12
When Agenda Item is the context, the following selections are available:
Field Description
Field Description
Set Value
Allows you to set the field specified in the Field to set drop-down select list to the specified
value.
1. In the Properties pane, on the General tab, from the Field to set drop-down select list,
select the field to set.
2012 Hyland Software, Inc.
870
OnBase 12 Workflow
When Agenda Item is the context, the following selections are available:
Field Description
2. From the Obtain value from drop-down select list, select one of the following locations
to obtain the value from:
Constant value This option sets the field value to the constant value specified.
Current date/time This option sets the field value to the current date/time.
Current user name This option sets the field value to the user name of the currently
logged in user. If you want to use the configured real name for the
user, select the Use real name option.
Property This option sets the field value to the name of a property.
User group name(s) of This option sets the field value to the user group(s) the current
current user logged in user.
3. In the Properties pane, click the Documentation tab. Enter any descriptive information
that is applicable in the Overview and Details fields.
2012 Hyland Software, Inc.
871
Workflow OnBase 12
Document Category
Add Document to Gateway Caching Server
Note: This action is not supported in the Classic OnBase Client interface.
When this action is executed, the document is cached at one or more remote Gateway
Caching Servers, allowing remote users to quickly retrieve the document on demand.
To configure this action, do the following:
For more information about gateway configuration, see the Application Server Gateway
module reference guide.
Note: This action is not supported in the Classic Client Workflow interface.
Note: You must be licensed for Integration for Microsoft Search for this action to function.
2012 Hyland Software, Inc.
872
OnBase 12 Workflow
Adds a document to a configured Content Source for Integration for Microsoft Search. This
will enable the document to be crawled for full-text search in Microsoft SharePoint.
Select a Content Source from the Content Source drop-down select list.
Target
In the Target drop-down select list, define whether you want the action to execute on the
If you are configuring the action for related documents/items, see Related Tab on page 1007
for more information.
Note: This action is only available if licensed for the Document Knowledge Transfer module.
Assigns the document to a reading group. This action can be used to prompt the user for
assignment information or it can be used to automatically assign documents to a reading
group.
Note: When a reading group is configured with the Enable Deadline Date option in the
Document Knowledge Transfer module, documents entering a reading group using this action
will assign the configured deadline date to the document.
Note: If the document is already in a reading group, processing breaks and the subsequent
actions/rules in a task list will not complete.
Note: This action is not supported in the OnBase Mobile interfaces when this option is
selected.
Note: In order to use this option successfully, users must have rights to the appropriate
reading groups to make new assignments.
Note: In the Client, if the Create New Assignment dialog box is canceled, processing breaks and
the subsequent actions/rules in a task list will not complete.
2012 Hyland Software, Inc.
873
Workflow OnBase 12
Mark as Reference
If you want documents to be automatically marked as a reference, select this option.
Approval Groups
If you want to require that documents are filtered through one or two approval groups before
being sent to users for review, select the appropriate group(s) from the drop-down select
list(s).
Workflow Studio Actions
Target
In the Target drop-down select list, define whether you want the action to execute on the
current document/item in the queue or a related document/item.
If you are configuring the action for related documents/items, see Related Tab on page 1007
for more information.
Auto-Folder Document
This action will create a folder based on the target document (current or related document
depending on your Target configuration.). In order for this action to work correctly, auto-
foldering must be appropriately configured for the Document Type to which the document
belongs. See the foldering documentation for information about configuring auto-folders.
Target
In the Target drop-down select list, define whether you want the action to execute on the
current document/item in the queue or a related document/item.
2012 Hyland Software, Inc.
874
OnBase 12 Workflow
4. Select the Document Type within the Selected Document Types box that you want to
auto-folder only in conjunction with Workflow actions.
If you are configuring the action for related documents, see Related Tab on page 1007 for
more information.
Check In Document
Target
In the Target drop-down select list, define whether you want the action to execute on the
current document/item in the queue or a related document/item.
If you are configuring the action for related documents, see Related Tab on page 1007 for
more information.
2012 Hyland Software, Inc.
875
Workflow OnBase 12
The Check In After Task Execution option can be selected to automatically release the
document lock after the top level task has completed execution.
Target
In the Target drop-down select list, define whether you want the action to execute on the
current document/item in the queue or a related document/item.
If you are configuring the action for related documents, see Related Tab on page 1007 for
more information.
Compose Document
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.
Select the appropriate Document Composition Template from the drop-down select list. You can
choose to adhere to the configured settings of the template by selecting Use All Settings
Configured for Template.
You can override those settings 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 information about settings see the Configuring Templates Form Letters Creation section of
the Image Document Composition or Document Composition for Microsoft Word
documentation.
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.
2012 Hyland Software, Inc.
876
OnBase 12 Workflow
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
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.
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.
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.
Note: This action is supported only in the Core-based Client interface and the Web Client
interface in ActiveX and HTML Enhanced modes only. This action is only supported in the Unity
interface when it is not configured to require user interaction.
2012 Hyland Software, Inc.
877
Workflow OnBase 12
You can override those settings 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.
Workflow Studio Actions
For information about settings see the Configuring Templates Form Letters Creation section of
the Image Document Composition or Document Composition for Microsoft Word
documentation.
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.
The Interactive check box is selected and not editable.
Copy Document
Makes a copy of the current document. If the current document has many revisions, the last
revision will be copied. You can also choose to Copy All Keywords or Copy Selected keywords. If
the Copy Selected option is selected, you must click Configure and select the appropriate
Keyword Types to copy. If the selected keywords are part of a Multi-Instance Keyword Type
Group, the Multi-Instance Keyword Type Group will be copied. The Multi-Instance Keyword
Type Group will be blank for the keywords that were not selected.
The Fill Document Handle Keyword(s) check box enables the new document, which had no link
to the primary document via a common keyword, to become a related document based on the
document handle when actions and rules are configured to use the Document Handle option to
identify related documents. If you select the Fill Document Handle Keyword(s) check box, the
new document and the primary document inherit each others document handle number
Keyword Values for the Document Handle keyword. The Document Handle OnBase keyword
must be assigned to the Document Type of the primary document. If the primary document
already had a value in the Document Handle Keyword Type, the document handle of the new
document is added to the primary document as a Document Handle Keyword Value and does
not replace the previous value.
Note: If the primary document belongs to a closed or cutoff Records Management folder, the
Document Handle Keyword Value will not be copied from the new document to the primary
document.
You can copy notes on the current document by selecting Copy Note(s).
2012 Hyland Software, Inc.
878
OnBase 12 Workflow
The copied document is not added to Workflow by default. If you want the document to be
added to Workflow, select Initiate Workflow.
If the document that is being copied belongs to a Document Type that is configured for auto-
foldering, when the documents keywords are copied, auto-foldering is initiated.
Note: If the original documents Document Type has E-form revisions associated with it, the
Note: If working in an Institutional Database, the Institution # keyword will always be copied,
regardless of selection.
Note: If a document has multiple renditions of the current revision of the document, the
renditions will also be copied.
Creates a Discussion Thread on the document. Requires a license for the Collaboration
module.
You must specify a subject for your Discussion Thread in the Post Subject field, and all
required body text in the Post Body field. If the Display Post for Edit option is selected, the
Discussion Thread will be displayed to the user to be modified as necessary before it is
created.
Note: The Display Post for Edit option is not supported in the Web Client.
Note: You can use the %K token for Keyword Type values and the %V token for property
values inside the Post Body or Post Subject fields. These tokens will be expanded into the
relevant values when the Discussion Thread is created. For example, if you entered a token of
%K101, it would be expanded into the current Keyword Value for Keyword Type 101.
2012 Hyland Software, Inc.
879
Workflow OnBase 12
The Form Type drop-down select list contains the list of E-Form and Virtual E-Form Document
Types available in the system. Select the E-Form Document Type to be used for form creation
when this action executes from the drop-down select list.
Caution: The Document Type selected from the Form Type drop-down select list must have either
Electronic Form or Virtual Electronic Form selected as the Default File Format or a document will
not be created successfully using this action.
Workflow Studio Actions
Caution: Ensure that all Keyword Types mapped on the HTML form are also assigned to the E-
Form Document Type selected from the Form Type drop-down select list.
Caution: If you are using the Classic Client interface, and the E-Form Document Type is
configured for auto-foldering, creating a document using this action will not initiate auto-
foldering. If you wish to initiate auto-foldering, additionally, you must use the Auto-Folder
Document action.
Caution: The following options are not supported in the Java Client: Display For Input, Save Form
on Submit, and Initiate Workflow on Submit.
Keywords
The Keyword Type drop-down list lets you choose a Keyword Type to add to the new form.
Enter the keyword value in the field.
Inherit Keywords
If you want keywords from the active document to be added to the form, select the Inherit
Keywords check box. If you want all common Keyword Type values, select Inherit All. If you
want to specify a subset of common Keyword Type values that are inherited, select Inherit
Selected. The Configure button will be enabled. Click Configure to specify what Keyword Types
you would like to inherit values.
Note: When Inherit Keywords is selected, the action will ignore any Keyword Types that are on
the primary document but not on the E-Form. Only the common Keyword Types will be
inherited.
Note: If a default value is configured for a Keyword Type field in a form and a value exists for
a Keyword Type on the primary document, the value is inherited from the primary document
and the default value is not stored for the new form. If a default value is configured for a
Keyword Type field in a form and the Keyword Type is blank on the primary document, the
default value is stored.
2012 Hyland Software, Inc.
880
OnBase 12 Workflow
The Document Handle Keyword Type must be assigned to both Document Types of the primary
document and the new E-Form.
Note: If the primary document belongs to a closed or cutoff Records Management folder, the
Document Handle Keyword Value will not be copied from the new document to the primary
document.
The following table describes the behavior for copying a keyword from a primary item to a
related item or a new E-Form.
Multi -Instance Multi-Instance Only copy if they are the same Multi-Instance
Keyword Type Group Keyword Type Group Keyword Type Group (means they have the same
identification number)
2012 Hyland Software, Inc.
881
Workflow OnBase 12
When this option is selected, the form is displayed in the User Interaction window for
additional data entry.
Note: The Display For Input option is not supported in the OnBase Mobile Access for BlackBerry
or Mobile Access for Windows Phone interfaces.
Workflow Studio Actions
Tip: When using the Classic OnBase Client, if the Display for Input option is selected when
using this action as a System Task, it is required for the Workflow user interface to be open in
the background. It is recommended that the DOC - Display Related Document action be used
instead of this option under this circumstance.
Note: If working in an Institutional Database, the Institution # keyword will always be copied,
regardless of selection.
Note: The Save Form On Submit option is not supported in the OnBase Mobile or Desktop
interfaces.
Caution: If you are using encrypted keyword functionality when Save Form On Submit is selected,
encrypted keywords are not masked and the values are displayed. These values can be modified
and saved by the user. If you are using encrypted keyword functionality in the OnBase Client
when Save Form On Submit is not selected, encrypted keywords may appear as though they are
editable when creating a new form, but upon saving the form, any changes made to encrypted
Keyword Values are not saved; the original encrypted Keyword Values are retained.
Note: OBBtn_KS### and OBBtn_Keyset are not supported for this action.
2012 Hyland Software, Inc.
882
OnBase 12 Workflow
The OBBtn_Cancel and OBBtn_No E-Form buttons function differently depending on what
option are selected for the FORM - Create New Form action when the Display for Input option is
selected. The following table outlines the different outcomes these buttons produce:
2012 Hyland Software, Inc.
883
Workflow OnBase 12
Submit = Yes
If an OBBtn_Cancel or OBBtn_No button is clicked, the last execution result is set to False and
the task list is aborted.
If you want to expand AutoFill Keyword sets using this action, use the OBBtn_ExpandKS###
button.
Note: Keyword validation does not apply to currency keywords in the Core. The user must be
familiar with the format used for currency in order to ensure accuracy.
Create Note
Adds a note or annotation of the specified type to the document. You can configure the text
contained in the note.
2012 Hyland Software, Inc.
884
OnBase 12 Workflow
In order for this action to complete successfully, the documents file format must be
compatible with the type of note or annotation to be placed on it. The following table
illustrates what file formats are compatible with what type of notes and annotations. See the
System Administration documentation for more information about notes and annotations.
Note: When adding a note to a document with multiple pages, the note is added to the first
page.
Note: The note will be added to the newest revision of the document.
In the Note Contents field, enter the appropriate text for the note. You can enter keywords and
other system data into the message using the appropriate symbols, which are entered when
you select the appropriate buttons. These symbols will pull data into the note that is pertinent
to the current primary document.
The following symbols can be used:
Symbol Description
Note: This symbol is only applicable when used with an Institutional Database.
%C Displays the name of the user who created the current document.
%D1 Displays the date that the document was stored. This value cannot be changed.
%I1 or %T Displays the time that the document was stored. This value cannot be changed.
2012 Hyland Software, Inc.
885
Workflow OnBase 12
Symbol Description
%K###.n Displays the Keyword Value of Keyword Type ### n times. For example, %K101.4
would display up to 4 unique Keyword Values for Keyword Type 101 for a single
document.
For some functionality, a Keyword Type drop-down list may be available to
Workflow Studio Actions
configure this. Select a Keyword Type from the drop-down select list, enter the
number of times you want the Keyword Value to be displayed in the Repeat field,
and click Keyword. The value in the Repeat field specifies how many instances of
the Keyword Value will be displayed. Entering an * character will pull all existing
Keyword Values for display up to 99 instances.
Note: When using the Classic Client interface, double digits in the Repeat field are
not supported.
%M Extracts metadata values from items. This includes attribute values from Workview
objects or a field values from an Entity item.
%M must be followed by the metadata value you want to extract. For example, if
you want to extract the value of a WorkView attribute called Name, it would be
%MName.
The token strings can contain nested expressions. Example, a nested WorkView
attribute: %MVendor.Buyer.Name.
%R Displays the real user name (if configured) of the user who created the current
document. If a real user name is not configured, a blank space will be displayed.
%U Displays the user name of the currently logged in user who executed the task.
%V### Displays the value of a configured Workflow property. For example, to display the
value for the property Color, this symbol would be configured %VColor.
The following symbols are not supported in the Classic Client interface:
%L [life cycle ID]
%L2 [life cycle name]
%Q [queue ID]
%Q2 [queue name]
2012 Hyland Software, Inc.
886
OnBase 12 Workflow
%M [item metadata value] is not supported in the Classic OnBase Client interface or the
Core-Based OnBase Client interface.
Caution: The Note Contents field will override the default text configured for a note type.
Specify the type of note by selecting it from the Note Type drop-down list.
Note: The Note Position setting is an optional feature and should only be used if you are
certain of the appropriate coordinates for the note position. If you are not certain or do not
have the need to place notes in a specific position, leave the values equal to 0. When the
values are equal to zero, the note will be placed in the default position on documents.
If you are using an annotation style note, you can use the Size settings to determine the
placement of the annotation on the document upon note creation. Specify the Width and
Height of the annotation note that will be displayed on the document.
When the note type is Highlight with note attached and the document is a text document, the
Width setting determines the number of columns that will be highlighted on a document. The
Height setting determines the number of rows that are highlighted. Negative values cannot be
entered for this type of annotation.
When the note type is Highlight with note attached and the document is an image document,
the Width setting determines the number of pixels that will be highlighted on a document. The
Height setting determines the number of pixels that are highlighted. Negative values cannot
be entered for this type of annotation.
When the note type is an Arrow or Ellipse style, the Width setting determines the how wide
the annotation will be and in what direction from the specified Note Position. A negative value
will annotate to the left of the Note Position. A positive value will annotate to the right. The
Height setting determines the how tall the annotation will be and in what direction from the
specified Note Position. A negative value will annotate above the Note Position. A positive
value will annotate below. This is measured in pixels.
When the note type is an Icon Stamp style, the Width and Height settings determine the size
of the icon image that is displayed on the document.
Note: If a note type is an Icon Stamp style and is configured with the Keep Original Icon Size
option selected, in all interfaces except the OnBase Client the icon will display in the default
size, regardless of what width and height are configured at the action level. The OnBase Client
will display the icon in the size configured at the action level.
2012 Hyland Software, Inc.
887
Workflow OnBase 12
When the note type is the Overlapped Text style, the Width setting determines how wide of an
area is allotted for the annotation before the text of the annotation is sent to another line.
Negative values cannot be entered for this type of annotation. The Height setting is not
applicable to this note type.
Note: In the Core-based OnBase Client interface, the Overlapped Text note style is only
displayed on image documents.
Workflow Studio Actions
Caution: Notes are not supported in the Java Client Workflow interface.
Note: If 0 is used as the value for both the Width and Height settings, annotations will not be
applied to the document at all for all annotation note types except the Arrow style. If 0 is used
as the value for both the Width and the Height settings, the arrowhead is still drawn, but no
line is draw from the arrowhead.
If you want to allow users to edit note text within a note, select the Display Note Text for Edit
option. When this option is selected, the action will display a text box in the User Interaction
window for users to edit text associated with the note created on the document.
Caution: The Core-Based interfaces allow you to enter more than 249 characters when the
Display Note Text for Edit option is selected. Notes with text greater than 250 characters will be
truncated to 250 characters.
Note: The Display Note Text for Edit option is not supported in the OnBase Mobile Access for
BlackBerry or Mobile Access for Windows Phone interfaces.
Note: An Agenda Management license is required to configure and use this action.
Note: This action is only supported in the Core-based Client and Unity Workflow interfaces.
2012 Hyland Software, Inc.
888
OnBase 12 Workflow
This action allows you to use a document (typically an E-Form) to add, update, or clear
agenda items. Before configuring this action, ensure that you have completely configured all
necessary items in the Agenda Management client.
Tip: As a best practice, this action should only be used as a System Task when you are
creating a new Agenda Item and the Agenda Item Primary Key can be set to Constant Value of
0.
1. Click Configure.
2. The Agenda Item Information Mapping dialog box is displayed.
3. Select one of the following required Agenda Item Fields:
Agenda Item Type - Used to classify individual agenda items.
Agenda Item Primary Key - The unique numeric value assigned to the agenda item by
OnBase. This value is assigned when you create an agenda item, and used by
OnBase to update the agenda item.
When the Agenda Item Primary Key is set to a non-0 value, or a value that does not
match that of an existing agenda item, users will be prompted to create a new
agenda item when executing this task.
Note: Prompting users to create a new agenda item is not supported in the Unity Workflow
interface.
Tip: When mapping the Agenda Item Primary Key to a Constant Value, use 0 to create new
agenda items. You can also map the Agenda Item Primary Key to an E-Form Field Name. Doing
so keeps this value hidden on the E-Form that you are using to update agenda items.
Meeting Type - The name of the type of meeting the item is associated with.
Note: Ensure that any configured Agenda Item Fields are compatible with the selected
Meeting Type. Agenda Item Fields are configured and assigned to Meeting Types, as
described in the Agenda Management documentation.
2012 Hyland Software, Inc.
889
Workflow OnBase 12
Keyword Type - A Keyword Type will be used to populate the Agenda Item Field.
Select a Keyword Type from the Keyword Type drop-down list.
Workflow Property - A Workflow Property will be used to populate the Agenda Item
Field. Type the Workflow Property in the Name or Value field.
Note: The Constant Value, E-Form Field Name, or Workflow Property cannot exceed 255
Workflow Studio Actions
characters.
5.Click Update.
6.Repeat steps 4 and 5 for the remaining required Agenda Item Fields.
7.Select any optional Agenda Item Fields from the Agenda Item Field drop-down list and
configure them by performing step 4 and clicking Add. The Agenda Item Fields
available from this drop-down list correspond to the Agenda Item Field names that
were created via Agenda Management administration.
If the agenda item will be closed session, select Agenda Item Closed Session Flag.
Note: The Attachment Exclude From Packet Flag, Closed Session, Status, and Requestor
selections are reserved for future functionality.
8.When you have finished configuring Agenda Item Fields, click Close.
9.In the Property to Store Agenda Item Primary Key field, type Agenda Item Primary Key.
10.To configure Related Documents, select Attached Related Documents. Related
documents become supporting documents for agenda items.
See Related Tab on page 1007 for more information.
11. From the Keyword Type to Set Related Document Order drop-down list, select the
Keyword Type being used to store the order of supporting documents attached to
agenda items. If a Keyword Type has not been assigned to related documents for the
purpose of storing the order of supporting documents attached to agenda items,
Keyword Type to Set Related Document Order can be left blank.
12. Click Apply.
Tip: It is considered a best practice to check the resulting property value immediately after
the Create or Update Agenda Item from Document action is executed by configuring the
following rules: Check Last Execution Result and Compare Property Value. Configure the
Check Last Execution Result to verify that the Create or Update Agenda Item from Document
action occurred. Configure the Compare Property Value rule to use the property value that
was set by the Property to Store Agenda Item Primary Key in the Create or Update Agenda Item
from Document action.
2012 Hyland Software, Inc.
890
OnBase 12 Workflow
Note: This action requires the Conversion from Microsoft Office to Image Framework license.
Caution: During the conversion process, some formatting may be lost. Tables, images, Word Art,
Clip Art, shapes and other non-text portions of the Word document can be altered in the
conversion process. Margins, borders, and columns can be slightly altered during the conversion
process as well.
Caution: This action supports the following versions of Microsoft Word: 97, 2000, 2002, 2003,
2007, and 2010. Microsoft Word versions 6 and 95 are not currently supported by this action.
This action allows a user to create an image-based PDF rendition or a TIFF rendition of any
Microsoft Word document which has a file extension of .doc or .docx. This action can also be
configured to create a new image-based PDF document or TIFF document from any Microsoft
Word document which has a file extension of .doc or .docx.
In addition, you can create a TIFF image rendition of any PDF document. Also, new TIFF
image documents can be created from any PDF document.
File Type
Select PDF or TIFF to determine which file type is created.
DPI
Select the DPI that you want to use to create PDFs and TIFF images through this action
Keep Color
If you want to maintain the color in the Word document upon conversion, select this option.
As Rendition of Active Document
If you want the new converted document to be a rendition of the current, active document,
select this option.
As New Document
If you want the converted document to be a new document, select this option. When this
option is selected, the following options are enabled.
Document Type
Select the Document Type in which you want to store the new document.
Inherit Keywords
2012 Hyland Software, Inc.
891
Workflow OnBase 12
If Inherit Keywords is selected, the Inherit All and Inherit Selected options are enabled. If
Inherit All is selected, all Keyword Values on the current document are inherited by the new
document. If Inherit Selected is selected, the Configure button is enabled. Click Configure and
select the Keyword Types from which you want the new document(s) to inherit values.
Inherit Note(s)
If this option is selected, notes from the current document are inherited by the new
Workflow Studio Actions
document(s).
Initiate Workflow
If this option is selected, Workflow is initiated for the newly created document(s).
Note: This action is not supported in the Classic Client, Desktop, or Java Client interfaces.
Note: This action is only available when licensed for the Medical Records Management or
Signature Deficiencies for Epic modules.
Note: This action is only available if licensed for Connector for use with SAP ArchiveLink
module.
2012 Hyland Software, Inc.
892
OnBase 12 Workflow
Sends a request to a SAP content server asking it to create a work item for the document.
The action does not perform validation on the object type and SAP Document Type.To
configure this action:
1. Select the appropriate Content Server from the drop-down list. You can also click the
button to the right of the drop-down list to access the Create Content Server Alias dialog
box to create an alias for a content server. See the Connector for use with SAP
Note: The default port number can be overridden by specifying a port number in the address.
The following format can be used: address:portnumber
Create Subsite
Note: A Site Provisioning for Microsoft SharePoint license is required to configure and use this
action.
Triggers the creation of a new SharePoint site from a document in Workflow, by using a set of
System Keyword Types associated with a Document Type.
The first time you configure this action, OnBase automatically creates the following
Alphanumeric Keyword Types:
SPS Member Role 250 Yes The role name of the SharePoint members
Name group, if SPS Use Unique Permissions is set
to Yes.
Examples of role names are Read, Full
Control, Contribute, and Design. See your
SharePoint administrator to help determine
the security of SharePoint groups.
SPS Members Group 250 Yes The name of the SharePoint members group,
if SPS Use Unique Permissions is set to Yes.
2012 Hyland Software, Inc.
893
Workflow OnBase 12
SPS Owner Role Name 250 Yes The role name of the SharePoint owners
group, if SPS Use Unique Permissions is set
to Yes.
Workflow Studio Actions
SPS Owners Group 250 Yes The name of the SharePoint owners group, if
SPS Use Unique Permissions is set to Yes.
SPS Site Description 250 Yes The description of the SharePoint site.
SPS Site Title 250 Yes The title of the SharePoint site.
SPS Site URL 250 Yes The URL of the existing SharePoint site. This
can be a top-level site, such as
http://vm-moss:8080, or a lower-level site,
such as http://vm-moss:8080/Accounting.
SPS Subsite URL 250 Yes The component added to the SPS Site URL to
create the URL for the new subsite.
For example, if the SPS Site URL value is
http://vm-moss:8080, and the SPS Subsite
URL is Sub1, then the new sites URL will be
http://vm-moss:8080/Sub1.
2012 Hyland Software, Inc.
894
OnBase 12 Workflow
SPS Visitor Role Name 250 Yes The role name of the SharePoint visitors
group, if SPS Use Unique Permissions is set
to Yes.
Examples of role names are Read, Full
Control, Contribute, and Design. See your
SharePoint administrator to help determine
the security of SharePoint groups.
SPS Visitors Group 250 Yes The name of the SharePoint visitors group, if
SPS Use Unique Permissions is set to Yes.
Caution: If there is already a Keyword Type by the same name as one of those listed above, then
the new Keyword Type is not created, and the action cannot work correctly.
Field Description
Administrator Name Type the name of the SharePoint administrator who has privileges
for creating SharePoint sites.
Administrator User Name Type the SharePoint administrator's Windows user name.
2012 Hyland Software, Inc.
895
Workflow OnBase 12
Note:This action is supported only in the Unity and Web Client interfaces.
This action allows you to create a Unity Form of a specified form type. It allows you to map
Keyword Type values to automatically populate the form and/or display the form for user
input.
Workflow Studio Actions
Form Type
Select the Unity Form template that you would like to use to create the new form from the
Form Type drop-down select list.
Keyword Type/Keyword Value
Select a Keyword Type that you would like to populate on the form with a value. Enter the
value you want to populate in that Keyword Type in the Keyword Value field.
Inherit Keywords
If you want keywords from the active document to be added to the form, select the Inherit
Keywords check box. If you want all common Keyword Type values, select Inherit All. If you
want to specify a subset of common Keyword Type values that are inherited, select Inherit
Selected. The Configure button will be enabled. Click Configure to specify what Keyword Types
you would like to inherit values.
Note: When Inherit Keywords is selected, the action will ignore any Keyword Types that are on
the primary document but not on the Form. Only the common Keyword Types will be
inherited.
Note: If a default value is configured for a Keyword Type field in a form and a value exists for
a Keyword Type on the primary document, the value is inherited from the primary document
and the default value is not stored for the new form. If a default value is configured for a
Keyword Type field in a form and the Keyword Type is blank on the primary document, the
default value is stored.
Note:If the primary document belongs to a closed or cutoff Records Management folder, the
Document Handle Keyword Value will not be copied from the new document to the primary
document.
Keyword Handling
2012 Hyland Software, Inc.
896
OnBase 12 Workflow
The following table describes the behavior for copying a keyword from a primary document to
a related document or a new E-Form.
Multi -Instance Multi-Instance Only copy if they are the same Multi-Instance
Keyword Type Group Keyword Type Group Keyword Type Group (means they have the same
identification number)
Tip: If the Display for Input option is selected when using this action as a System Task, it is
required for the Workflow user interface to be open in the background. It is recommended
that the DOC - Display Related Document action be used instead of this option under this
circumstance.
Note: If working in an Institutional Database, the Institution # keyword will always be copied,
regardless of selection.
Note: When configured with the Display For Input option selected, AutoFill Keyword Sets that
are configured on the form will expand when the value of the primary keyword of that AutoFill
Keyword Set is either inherited or added with the action. The expansion of the AutoFill
Keyword Set takes place when the form is displayed in the User Interaction window. If Display
for Input option is not selected, the AutoFill Keyword Set will not be expanded.
2012 Hyland Software, Inc.
897
Workflow OnBase 12
If you want to allow users the ability to discard the changes made to a form, but continue with
the task list, select the Allow User to Discard Changes and Continue Execution check box. When
this check box is selected, a Discard and Continue button is available to the user.
Allow User to Discard Changes and Cancel Execution
If you want to allow users the ability to discard the changes made to a form, but cancel the
execution of the task list, select the Allow User to Discard Changes and Cancel Execution check
Workflow Studio Actions
box. When this check box is selected, a Discard and Cancel button is available to the user.
Note: This action is not functional in the Classic Client or Java Client interfaces.
Note: WorkView must be installed on the database in which you want to configure this action.
If you import a life cycle into a database, that database must have WorkView installed to
successfully import the life cycle.
Allows the user to create a WorkView object, pulling the attribute values from Keyword Values
on the current document. The user can only specify one Document Type Association per
Document Type.
1.Select a Document Type from the Document Type drop-down list. Only the Document
Types that have associations will be listed.
2.Select a Document Type Association from the drop-down list. The Document Type
Associations listed are associations configured at the class level for the selected
Document Type.
Note: The Document Type Association selected determines the attribute/keyword type
mapping, and therefore, the values that populate the attribute fields of an object upon
creation.
3.Click Add.
4.Repeat steps 1 through 3 for each association you want to create an object for.
2012 Hyland Software, Inc.
898
OnBase 12 Workflow
5.If you want the object to display after it is created, select the Display Object option. This
can allow you to enter data into fields that have not been mapped to a Keyword Type.
Note: The Display Object option is only supported in the Web Client and Unity interfaces. The
OnBase Web Server is required to display WorkView objects from the Unity interface.
Caution: When a relationship attribute is used during object creation, if more than one object is
found for the relationship attributes value, the first object found is used for the relationship. If
an object is not found that matches the relationship attributes value, a new relationship object is
created.
If you want to save the ID of the object created, select Save Object ID to Property and enter
the name of the property you want to store the ID in the field.
Delete Document
Deletes the document from OnBase. The document is no longer accessible through normal
retrieval. The document may be recovered using the Document Maintenance window.
Note: If the Abort Processing After Delete option is selected, processing is aborted after the
current document is deleted.
Target
In the Target drop-down select list, define whether you want the action to execute on the
current document/item in the queue or a related document/item.
If you are configuring the action for related documents/items, see Related Tab on page 1007
for more information.
Delete Note
Note: Notes will be deleted using this action regardless of the note type privileges the
currently logged in user has outside of Workflow.
Note: When deleting a note, if more than one note of the specified type exists on the
document, all notes of the same type are deleted from the current document.
You must specify the type of note to delete by selecting it from the Note Type drop-down list.
Get Note Type from Property
2012 Hyland Software, Inc.
899
Workflow OnBase 12
You can specify the source note type from a property value by selecting Get Note Type from
Property and entering the property in the field.
Display Document
Workflow Studio Actions
The display document action will display the document to the user. By default the document
will be displayed in the Workflow clients embedded document viewer.
You can also specify that the document should open in a separate window by checking the
Display in Separate Window check box. When used in conjunction with Display in Separate
Window, the Use Top Level Window check box causes the document to be opened in a window
that can be dragged outside of the Workflow window to display it on a second screens
desktop (if using dual monitors).
Note: When performing this action directly from an Outlook e-mail message using the
Integration for Microsoft Outlook 2007 or Integration for Microsoft Outlook 2010, the
document will always be displayed in a separate Document Viewer window. This is because
Outlook does not have its own viewer.
Note: The Use Top Level Window option is not supported in the Unity interface. When
performing this action from the Unity interface, the document will always be displayed in a
separate Document Viewer window.
The Use Top Level Window option is enabled only when Display in Separate Window is selected.
The Use Top Level Window option works in conjunction with the Reuse Top-level Window for
Displaying Document workstation option.
When a workstation also has the Reuse Top-level Window for Displaying Document option
selected, documents will use only one window to display all documents. If there are multiple
documents displayed, only the last document is displayed. If this option is not selected,
documents will use a new window for each document.
The Use Primary Pane option is only enabled while the Display In Separate Window option is not
selected. The Use Primary Pane option has the following effects:
If the Display Second Pane option is not checked in Workstation Options, the Use Primary Pane
option is ignored.
If the Use Primary Pane option is not checked, another copy of the main document is displayed
in the second, lower-right pane.
If the Use Primary Pane option is selected, the main document is displayed in the primary,
upper-left pane.
Note: The Use Primary Pane option is not applicable to the Desktop interface.
Target
In the Target drop-down select list, define whether you want the action to execute on the
current document/item in the queue or a related document/item.
2012 Hyland Software, Inc.
900
OnBase 12 Workflow
If you are configuring the action for related documents/items, see Related Tab on page 1007
for more information.
Displays an E-Form or Virtual E-Form. Requires a license for the E-Forms module.
If you are configuring the action for related documents/items, see Related Tab on page 1007
for more information.
The Cancel Form Applies to: sections allows you to specify how you want the a form
cancellation to be processed whose form creation was initiated by this action.
If Current form only is selected, only the form that is currently displayed is canceled upon a
user clicking a configured OBBtn_Cancel button. Subsequent forms will be displayed.
If Current and all subsequent forms is selected, the currently displayed form and all subsequent
forms will be canceled upon a user clicking a configured OBBtn_Cancel button.
If you want to expand AutoFill Keyword sets using this action, use the OBBtn_ExpandKS###
button.
Note: OBBtn_KS### and OBBtn_Keyset are not supported for this action.
Current form OBBtn_Cancel All E-Forms are displayed, but the task
only list is broken.
Current form OBBtn_No All E-Forms are displayed and the task
only list is not broken. The last execution
result is set to False.
Current and all OBBtn_Cancel All E-Forms are not displayed and the
subsequent task list is broken.
forms
Current and all OBBtn_No All E-Forms are displayed and the task
subsequent list is not broken. The last execution
forms result is set to False.
2012 Hyland Software, Inc.
901
Workflow OnBase 12
Note: This action is not supported in the Desktop, Unity, Java Client, or OnBase Mobile
interfaces.
Workflow Studio Actions
This action will open the File Cabinet window with the folder to which the document belongs. If
the document is associated with multiple folders, all of the folders are listed in the bottom left
pane. If the document within Workflow does not have a folder associated with it, a message
will display stating No Folders Found. In addition, users are prompted with a message that no
folders were found if they do not have the rights to access a folder in which the document
resides. If a user does not have rights to the Document Type that is in the folder, the
document will not display in the folder.
Note: This action is only available when licensed for HL7, Medical Records Management, or
Signature Deficiencies for Epic.
If you want to append the chksum parameter to the generated URL, select the Verify
Checksum check box. In order for this option to function properly, the EnablePopChecksum
setting must be set to true in the ChartPop web.config file.
Note: This action is supported only in the Unity and Web Client interfaces.
2012 Hyland Software, Inc.
902
OnBase 12 Workflow
This action is used in conjunction with the Related Item Exists rule with the Use Related Items
for Tasks option selected. Using this rule provides a way to determine if there are Unity forms
related to the primary item. If a Unity form is found that matches the rule criteria upon task
execution, it will be displayed for input. If multiple Unity forms are found that matches the
rule criteria, they will be displayed one after another until all of the Unity forms are
processed.
Allow User to Discard Changes and Continue Execution
Excludes current document from Document Retention process. The Document Type the
document belongs to must be configured for use with Document Retention.
You must enter a reason for the exclusion in the Reason for Exclusion text box. If a reason is
not entered, the action will not execute successfully.
Import Document
Note: This action is not supported in the Java Client or OnBase Mobile interfaces.
Caution: If you are using encrypted keyword functionality, encrypted keywords are not masked
and the values are displayed as read-only in all interfaces.
Note: This action allows a user to import documents into a Document Type for which they do
not have rights. In addition, a user does not need to have the Create Revision privilege
granted in order to create a revision of a document.
2012 Hyland Software, Inc.
903
Workflow OnBase 12
Allows users to import a document into OnBase. When the action is executed, the Import
Document dialog box is displayed.
Default Document Type
The Document Type selected from the drop-down select list will be the default Document Type
selected when the Import Document dialog box is displayed. If a default Document Type is not
specified, you will be able to select the appropriate Document Type and file type.
Workflow Studio Actions
If the Enable Document and File Type Combo Boxes option is selected, the File Type and
Document Type drop-down select lists will be enabled in the Import Document dialog box. This
option is only enabled when a default Document Type is selected. If this option is not
selected, documents will be imported using the selected default Document Type. When
<None> is selected, the Enable Document and File Type Combo Boxes option is automatically
selected.
Note: If a default Document Type is selected and the Enable Document and File Type Combo
Boxes option is not selected, users that do not have rights to the default Document Type will
be able to import documents into the Document Type using this action.
Keywords
Note: When using this action to create a revision of an existing document, an additional
instance of a Keyword Value is added if one instance already exists.
If you want to specify a Keyword Value to automatically be populated in the Import Document
dialog box, select a Keyword Type from the drop-down menu and enter the Keyword Value in
the field.
Using the Inherit Keywords option, the user can specify that either all or some of the keywords
in the current document are copied to the imported document. Selecting this option enables
the Inherit All and Inherit Selected options and the Configure button.
If you want all Keyword Values to be inherited from the active document, select the Inherit All
option.
If you want to only inherit specific Keyword Values from the active document, select the
Inherit Selected option. Click Configure and select the appropriate Keyword Types from which
you want to inherit values.
Note: In the Unity interface, common Keyword Types in different Multi-Instance Keyword Type
Groups are inherited regardless of whether the Inherit All or Inherit Selected option is selected.
2012 Hyland Software, Inc.
904
OnBase 12 Workflow
If you check the Fill Document Handle Keyword(s) check box, the new document and the
primary document inherit each others document handle number keyword values for the
Document Handle keyword. OnBase keyword Document Handle must be assigned to both
Document Types involved in the exchange. This configuration enables the new document,
which had no link to the primary document via a common keyword, to become a related
document based on the document handle when actions and rules are configured to use the
Document Handle option to identify related documents. If the primary document already had a
Note: If the primary document belongs to a closed or cutoff Records Management folder, the
Document Handle keyword value will not be copied from the new document to the primary
document.
Options
The user can use the Display Document option to specify that the imported document should
be displayed in the primary pane, secondary pane or a separate window.
If the Primary Pane option is selected, displays new document in the primary pane in the place
of the main document.
If the Secondary Pane option is checked, displays related documents in the secondary pane.
Specify that the document should open in a separate window by selecting the Separate
Window option. The Top Level Window check box causes the document to be opened in a
window that can be dragged outside of the system window to display it on a second desktop
(if using dual monitors).
The Default Initiate Workflow options allow the user to specify that the Initiate Workflow check
box in the Import Document dialog box be checked or unchecked by default. If On is selected,
the check box will be selected by default. If Off is selected, the check box will not be selected
by default. If None is selected, whether or not the check box is selected will be determined by
the DoNotInitiateWorkflow setting in the onbase32.ini file.
The Allow Modify Keywords option specifies if the Keyword Values can be edited in the Import
Document dialog box. The Document Date field is disabled when Allow Modify Keywords is not
selected. The action configuration options override all user group privileges.
The Enable Initiate Workflow option specifies that the Initiate Workflow check box in the
Import Document dialog box be enabled or disabled.
Note: The Default Initiate Workflow and Enable Initiate Workflow options are not supported in
the OnBase Desktop. If the document being imported using this action is assigned to a
Document Type associated with a life cycle, that document will be entered into the associated
life cycle.
Caution: The action configuration options override all user group privileges.
Caution: If you are attempting to use this action to create a new revision on the existing primary
document, you will only be able to save the imported document as a new document and not as a
revision because the primary document is already locked.
2012 Hyland Software, Inc.
905
Workflow OnBase 12
Caution: This action overrides the privileges assigned to users for Records Management.
This action places a hold on the managed folder that is associated with the current, active
document. Holds are placed only on folders that are eligible based on their disposition status
and that belong to a folder of a managed folder type that is associated with the hold set/hold
reason configured.
Select the Hold Set you would like to use to place holds. Hold sets are associated with specific
Managed Folder Types. This drop-down select list will contain the hold sets that are
configured for managed folder types. If you select <Any>, all hold reason configured in the
system are available for selection in the Hold Reason drop-down select list.
From the Hold Reason drop-down select list, select the hold you want to place on folders. This
drop-down will populate the holds that have been configured in the Hold Set selected.
If you want to use the reason that was configured for the hold, select Use Reason Text
Configured for the Selected Hold.
If you want to configure another reason for the hold when placed via this Workflow task,
select Configure Another Reason Text and enter the appropriate text in the field.
Caution: This action overrides the privileges assigned to users for Records Management.
This action posts an event on the managed folder that is associated with the current, active
document. Events are posted only on folders that are eligible based on their disposition
status.
In the Event Set drop-down select list, select an event set to narrow down the events listed in
the Post Event drop-down select list. If you select <Any>, all events configured in the system
will be available for selection in the Post Event drop-down select list.
2012 Hyland Software, Inc.
906
OnBase 12 Workflow
In the Post Event drop-down select list, select the event to post on a managed folder. The
selected event will only post on folders that belong to folders types that were configured to
use the selected event.
Note: The -RIMSERVER command line switch must be present on the Client executable for this
action to function correctly. When using this action in the Core-based interfaces, a delay may
occur before the posting of an event.
Caution: The Allow User to Set Event Date option is not supported in the Classic Client interface.
Note: When using the Property Value or the Keyword Value option, the value of the property or
Keyword Type must be a valid date or date/time value.
Print Batch
This action allows users to print multiple documents in multiple Document Types in one
printing batch. This action will print the contents of the folder specified in the Folder Type
drop-down select list.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
The order documents are viewed and/or printed using the work folder is controlled by the
Order Documents By option configured on the Display tab in folder configuration. The batch will
be sent to the queues specified in the Print Queue drop-down select list.
Note: When using a Web Client using Standard mode, a network printer is the only Print Queue
type supported.
Print Format
2012 Hyland Software, Inc.
907
Workflow OnBase 12
Allows you to select a print format to use during printing. Print formats are configured in the
Configuration module under Printing | Print Formats. See the System Administration
documentation for more information.
Note: Regardless of the Enable User Group based Print Format security option global client
setting, the print format selected will be available when this action is executed.
Workflow Studio Actions
Note: If printing an OLE or HTML document, format settings for the document override the
print format settings.
Caution: The Application Server and Web Client interfaces do not support the Default Printer or
Local Print Queue options. The Unity interface does not support the Local Printer option.
Note: If the user that initiates this action does not have rights to the specified print queue, the
rights will be overridden and the user will have access to the print queue for use with action.
If the Include Current Document in Batch option is selected, the current active document will be
printed with the batch. If the option is not selected, the current active document will not be
printed with the batch.
Note: If the current active document also exists in the folder and the Include Current Document
in Batch option is selected, the document will be printed twice. In the Core-based interfaces, if
this setting is not selected and the current active document exists in the folder, the document
will be printed once. In the Classic Client interface, if this setting is not selected and the
current active document exists in the folder, the document will not be printed at all.
If the Show Print Dialog option is selected, the Print dialog box will be displayed, allowing you
to select options before printing.
Note: The Show Print Dialog option is not supported in the OnBase Mobile interfaces. This
option is not supported in the Web Client when printing with a Network Print Queue. The print
dialog box will not display.
Note: When printing to a Named network print queue, a workstation must be running as a
Print Server when using the Web Client interface.
2012 Hyland Software, Inc.
908
OnBase 12 Workflow
When this option is selected, the first revision of the document is printed; otherwise the latest
revision of the document is printed.
Note: This option is not supported in either the Classic or Core-based OnBase Client
interfaces.
The document goes to the print queue configured in the client as the default print queue. All
the settings used for printing are the defaults specified in the print format for the document
type, unless a specific Print Queue, Start Page, or End Page is specified in the action. Clear the
Print Dialog check box if you want printing to occur with no user interaction.
Caution: When used in system work and the documents are brought into the system using the
Fax Import Integration for Captaris RightFax or Integration for Open Text Fax Server, RightFax
Edition modules and a local printer is used, this action will not function. If you want to use this
action in system work with the Fax Import Integration for Captaris RightFax or Integration for
Open Text Fax Server, RightFax Edition modules, it is recommended that you use a network
printer. If you must use a local printer, you can configure this action using a timer and the
OnBase Client running as a Timer Server.
Print Queue
Allows you to send the document to an OnBase-configured print queue specified by a
selection from the Print Queue drop-down list.
Caution: The Application Server and Web Client interfaces do not support the Default Printer or
Local Print Queue options. The Unity interface does not support the Local Printer option.
Note: When using a Web Client using Standard mode, a network printer is the only Print Queue
type supported.
Print Format
Allows you to select a print format to use during printing. Print formats are configured in the
Configuration module under Printing | Print Formats. See the Configuration documentation for
more information.
Note: Regardless of the Enable User Group based Print Format security option global client
setting, the print format selected will be available when this action is executed.
Note: If printing an OLE or HTML document, format settings for the document override the
print format settings.
2012 Hyland Software, Inc.
909
Workflow OnBase 12
When a print action executes and the Show Print Dialog check box is selected, the Print dialog
box displays before the current document or related document (depending on the action type
selected) is sent to the printer.
De-select the Show Print Dialog box to send the current/related document directly to the
printer.
Workflow Studio Actions
Note: The Show Print Dialog option is not supported in the OnBase Mobile interfaces. This
option is not supported in the Web Client when printing with a Network Print Queue. The print
dialog will not display.
Note: When Show Print Dialog is selected, the Print Format selected will be available for
selection in the Print dialog box when the action is executed regardless of user rights to the
print format.
Note: When this option is used with the Java Workflow Client, a dialog box is displayed
allowing users to select No overlay, Overlay, or Fax Compatible before displaying the printing
dialog box.
Note: This option is only supported in the Web and Java Client Workflow interfaces.
Note: When printing to a Named network print queue, a workstation must be running as a
Print Server when using the Web Client interface.
When using this action in the Java Client, there are a few limitations:
The Java Client only supports printing to local printers.
The Java Client does not support print formats.
This action is only supported for image, text, and HTML documents.
Target
In the Target drop-down select list, define whether you want the action to execute on the
current document/item in the queue or a related document/item.
2012 Hyland Software, Inc.
910
OnBase 12 Workflow
If you are configuring the action for related documents, see Related Tab on page 1007 for
more information.
Purge Document
Note: Documents that are under retention using the Document Retention module cannot be
purged using this action.
Note: Documents purged using this action will not appear in the SYS - Document Purge Report.
This action removes all database entries for a document and it will not be accessible by any
means in OnBase including Document Maintenance. If more than one person is accessing the
same document, the document can be purged by the first person to open the document by
initiating the purge action. If the second user tries to purge the document, nothing happens.
If you are using the Classic Client interface, this action removes the documents physical file
from the Disk Group(s) unless the document is currently displayed in the viewer. If the
document is displayed in the viewer when the action is executed, the documents physical file
will not be removed from the disk group. When using a core-based interface, the action does
not remove the documents physical file from the disk group.
If the Action will purge only documents having a file format of Electronic Form, Virtual Electronic
Form, or Unity Form. option is selected, only documents that are Electronic Form, Virtual
Electronic Form, or UnityForm file formats will be purged from OnBase. All documents with
other file formats will not be purged.
If the Action will purge any document option is selected, any document will be purged,
regardless of the file format that is used.
Note: If a COLD, Check Import, or DIP process is running, the physical file being used by the
process does not delete the physical file, but the references to the current document are
removed from OnBase. DIP processes that are affected have a DIPDocumentPerFile
onbase32.ini setting >1.
Note: This action is only supported in the Classic Client Workflow interface.
Places the current document in a predetermined file cache (which is configured via the Disk
Mgmt option in OnBase Configuration). This is the only way to place documents into cache for
prefetching.
Cache
2012 Hyland Software, Inc.
911
Workflow OnBase 12
Specify the name of the cache in the Cache drop-down list after its location has been
established and configured. Caching up to 2 Terabytes is supported.
Note: In order for this action to execute successfully on a document, the document must
belong to a Document Type configured with the Allow File Caching option selected. See the
System Administration Module Reference Guide or the Configuration help files for more
information about this setting.
Workflow Studio Actions
Target
In the Target drop-down select list, define whether you want the action to execute on the
current document/item in the queue or a related document/item.
If you are configuring the action for related documents, see Related Tab on page 1007 for
more information.
Note: In order to use this action, the system must be licensed for Ad-Hoc Automated
Indexing, Automated Indexing, Intelligent Indexing, Ad Hoc Document OCR, or Batch OCR. In
addition, the required OCR software must be installed and the Document Type to which the
document belongs that the action will be executed upon must be configured appropriately for
OCR functionality. See the Batch OCR documentation for more information.
Automated Index
Note: This option requires that the documents being automatically indexed are image
documents.
If you want the document to be sent to the Awaiting Ad-Hoc OCR queue, select the None
option. This option requires either the Batch OCR license or the Ad Hoc Document OCR
license.
If you want the document to be sent to the Awaiting Ad-Hoc Automated Indexing queue, select
the Automated Indexing option. This option requires either the Ad Hoc Automated Indexing
license or the Automated Indexing license.
If you want the document to be queued to be processed by the Intelligent Indexing Service,
select the Intelligent Indexing option. This action will queue the document in the database
based on the document handle to be processed by the II Service when the service executes.
This option requires the Intelligent Indexing license.
Note: A script can be created that will check the status of the document in the II process.
Target
2012 Hyland Software, Inc.
912
OnBase 12 Workflow
In the Target drop-down select list, define whether you want the action to execute on the
current document/item in the queue or a related document/item.
If you are configuring the action for related documents, see Related Tab on page 1007 for
more information.
Re-Index Document
Note: This action will not re-index a document that is a signed E-Form. If this action
encounters a signed E-Form, the last execution result is set to FALSE. If this action is part of a
task list, the task list is not aborted if a signed E-Form is encountered.
Note: When this action is initiated on a document, the documents current Document Type is
available for selection during re-indexing, regardless of the currently logged in users
Document Type rights.
Note: When a document is re-indexed that is being managed by Document Retention, only the
Document Type to which the document belongs will be available for re-indexing. The
Document Retention Manager privilege is required for a user to re-index a document being
managed by Document Retention into a different Document Type.
Note: If Cancel is clicked during the re-indexing process, only re-indexing is canceled.
Subsequent processing is not automatically aborted.
Allows primary documents within a life cycle queue to be re-indexed. This action should not
be used in System Work or Timer Work. The Remove Document from Current Workflow
Locations check box allows documents to be removed from a life cycle after they have been
indexed. The Reinsert Document into Workflow check box allows OnBase to place documents
into the appropriate life cycle, based on the Document Type the document was re-indexed
under. If the document already exists in any of the life cycles the new Document Type is
associated with, the document will not be reinserted into those life cycles unless the Remove
Document From Current Workflow Locations option is used in conjunction with the Reinsert
Document into Workflow option.
The Display Document Type Read-Only check box displays the Document Type Group and
Document Type drop-down select lists as read-only during re-indexing.
2012 Hyland Software, Inc.
913
Workflow OnBase 12
The Display Keywords Read-Only check box will display all keyword fields as read-only during
re-indexing except for the Document Type. Users will only be able to change the Document
Type. Application Enabler can be used to scrape indexing values and options for this are also
available.
While re-indexing a document within Workflow, a user may need to expand an Autofill
Keyword Set. It is possible that the user may not know the primary keyword value that is
Workflow Studio Actions
needed to expand the Autofill Keyword Set, but instead they only know a secondary keyword
value of the Autofill Keyword Set. The Enable Reverse Keyset Lookup option allows the user to
search for the desired Autofill row based on that secondary keyword. If you want to make
Reverse AutoFill Keyword Sets available during re-indexing using this action, select the Enable
Reverse Keyset Lookup option. When this option is enabled, the Lookup button will be
displayed in the Re-Index panel when the following conditions are met:
The selected Document Type contains a Keyword Type that is also the primary
Keyword Type of an Autofill Keyword Set.
A Reverse AutoFill Keyword Set has been configured using the Autofill Keyword Set
with the primary Keyword Type associated with the selected Document Type.
At least one Reverse AutoFill Keyword Set has the Workflow Show Lookup Item option
selected.
Caution: This option is only supported in the Classic OnBase Client, Core-based OnBase Client,
and the Web Client user interfaces.
For more information on Reverse Lookups, see the AutoFill Keyword Sets documentation.
Documents can only be re-indexed to Document Types that the user has rights to. The Create
privilege is not required.
The only exception is in the Web Client interface, where the document can be re-indexed
using the same Document Type that the document is currently indexed under, regardless of
rights.
Note: If a user has the document that needs to be re-indexed locked, re-indexing cannot take
place until the user is done with the document and it is not locked.
If the document re-indexed belongs to a Document Type that is configured for auto-foldering,
the change to Keyword Values will initiate auto-foldering to take place for the affected
document.
When using AutoFill Keyword Sets, entering a primary value and then clicking Re-index in the
OnBase Client and Web Client, a message stating Warning! An autofill keyword set has
expanded as a result of this operation. Do you want to review the keyword change? is displayed.
Clicking OK will return the user to the re-index panel to review the values populated. Clicking
Cancel will complete the re-indexing action. The confirmation message will not display if the
user enters the primary value and then presses Tab to initiate AutoFill Keyword Set population
before clicking Re-index. Pressing Tab will automatically expand the Autofill Keyword Set. If
multiple Autofill Keyword Sets exist for the primary Keyword Value entered in the re-index
panel, the user will be prompted to select the correct Autofill Keyword Set values.
2012 Hyland Software, Inc.
914
OnBase 12 Workflow
If you use the Application Enabler module, the AppEnabler Options allow you to specify the
behavior of the Document Imaging window and enabled application during OnBase Client
indexing. The Application Enabler module allows you to use OnBase Client indexing to index
documents by screen scraping. When you double-click on the enabled application, values
are scraped (copied) from the enabled application and used to populate the corresponding
keyword fields in the Document Imaging window. See the Application Enabler documentation
for more information.
Note: This option is not supported in the Unity Workflow interface. To accomplish this same
behavior in the Unity Workflow interface, clear the Include all configured keywords when
posting events from this screen Application Enabler configuration option.
If enabled, the only keyword values that will be populated are those from the keyword type(s)
in the Selected list in the Hotspot Configuration dialog box. When this option is not selected,
keyword types from both the Available and Selected lists in the Hotspot Configuration dialog
box will be used.
Note: If neither the Clear Keywords or Replace Keywords options are selected, existing
Keyword Values in the indexing window are retained and new values are added during screen
scraping. Multiple Keyword Type fields and values are displayed in the indexing window.
2012 Hyland Software, Inc.
915
Workflow OnBase 12
When this option is selected, the Document Type scraped from Application Enabler will not be
used to update and re-index a document. When this option is not selected, the Document
Type will be updated from the scraped information.
Prevent AutoFill Expansion
When this option is selected, AutoFill Keyword Sets will not be filled upon scraping using
Application Enabler in conjunction with this action.
Workflow Studio Actions
Reload Document
When the action is executed, all cached information about a document is cleared. When the
document is accessed again, information is pulled from the database. This will pick up any
changes made outside of Workflow.
Reload Keywords
Updates the keywords for the current document(s) without having to refresh the Document
window.
Removes the primary document from one or all reading groups to which it belongs.
If you want to remove the primary document from all reading groups, select the Remove from
All Reading Groups option.
If you want to remove the primary document from a specific reading group, select Remove
from Selected Reading Group and select the appropriate reading group from the drop-down
select list.
If you want to remove all revisions of the document, select the Remove All Revisions check
box.
Target
In the Target drop-down select list, define whether you want the action to execute on the
current document/item in the queue or a related document/item.
If you are configuring the action for related documents, see Related Tab on page 1007 for
more information.
2012 Hyland Software, Inc.
916
OnBase 12 Workflow
Removes any existing exclusion from Document Retention for the current document. The
Document Type the document belongs to must be configured for use with Document
Retention.
Enter the reason you want to exclude the document via this action in the Reason for Exclusion
field.
Caution: This action overrides the privileges assigned to users for Records Management.
When initiated, this action will remove the hold on a managed folder in which the current,
active document belongs. If the managed folder that the document belongs to has multiple
holds applied, no holds will be removed. If multiple documents are selected that belong to
different managed folders, holds will be removed from all folders that only have one hold
applied.
Render Statement
Note: This action is only available if licensed for the Image Statements module. The
Distribution Process and Distribution Print Queue options are only available if licensed for the
Document Distribution module.
You can configure a Workflow action to create jobs for rendering and distributing statements.
Note: This Workflow action only creates the jobs; it does not process them. In order to
process jobs for rendering statements and/or distributing statements via a Print Queue,
ensure that the OnBase Client is running with the -PS command line switch. In order to
process jobs for distributing statements via e-mail, ensure that the OnBase Client is running
with the -STMTMAILSRVR command line switch.
To configure the Workflow action, select Render Statement from the Action Type drop-down
select list. The Action Fields allow you to specify a Print Queue, a Statement Type, and,
optionally, a Distribution Process and a Distribution Print Queue.
1. From the Print Queue drop-down select list, select the Print Queue you would like to
use for distribution.
2. From the Statement Type drop-down select list, select the Statement Type you would
like to use for rendering statements.
3. If you wish to specify a Distribution Process for the rendered statements, select a
process from the Distribution Process drop-down select list.
2012 Hyland Software, Inc.
917
Workflow OnBase 12
4. If you wish to specify a Distribution Print Queue, select one from the Distribution Print
Queue drop-down select list.
Note: This drop-down select list is only enabled when a Distribution Process is selected for a
Statement Type that has been configured to use separate jobs for printing and archiving.
Workflow Studio Actions
Run Script
Executes a VBScript on the current document. The VBScript must be saved into OnBase
through the Configuration module in order for it to be accessible for action configuration.
Select the appropriate VBScript from the Script drop-down list.
Note: When using this action, be sure that the visible scope in the script is set according to the
context in which the script will be run. The visible scope will differ depending on whether the
script is run on the Client side or the server side. See the OnBase VBScript documentation for
more information.
Note: When using the Core-based OnBase Client interface and running VBScripts on the client
side and a property bag is used, the property bag will be synchronized between the server
and client prior to executing the script, and again following the execution of the script. This
will insure that property bag values residing on the server will be available to use on the client
side during script execution. These same property bag values, if changed during the script
execution on the client side, will be available in the Core after execution. Synchronizing the
property bag does not support deleting a property value from the property bag. If a property
value is deleted during script execution on the client, the property value will not be removed
from the property bag on the server side when next synchronization occurs. Only non-object
property values are supported for synchronization. If a property holds an interface pointer to
a class instance we will not synchronize these types of properties. Synchronization is not
supported when Timer work is performed on the client side.
If you want to refresh the document after the script executes, select Refresh document after
script has executed.
This action is used to manually trigger the sending of document event information to the
Event Relay Server. The document must belong to a Document Type that is configured for use
with the Event Relay Server.
2012 Hyland Software, Inc.
918
OnBase 12 Workflow
Note:This action is only available if you are licensed for the HL7 Processor or the HL7 Listener.
1. From the Destination drop-down select list, select the destination for the HL7 message.
Only export destinations configured to Queue out-going messages for HL7 Auto-Sender
are available.
2. From the Message drop-down select list, select the HL7 Message Template for the
message you want to send.
3. If the Message Template contains fields whose default values begin with $^
characters, these fields can be mapped to The Value of a Property, a URL, or a Value.
To map a field, select the field and select the type of mapping you want to use.
If you select Property, enter the name of the property.
If you select URL, select the appropriate Document Display URL. This option uses
DocPop or a medical Pop integration to display a URL to the document or associated
chart. These URLs are configured under Utils | Document Display URLs in the
Configuration module.
If you select Value, enter a value to map to the field.
4. After selecting a type, click Map.
2012 Hyland Software, Inc.
919
Workflow OnBase 12
Option Description
Workflow Studio Actions
Document Handle The action appends the docid parameter with the document ID as the value.
For DocPop URLs, this parameter would retrieve the document that triggered
the message.
Keyword Value The action appends the specified Parameter Name with the value of a
Keyword Type from the document.
Parameter Name Enter the parameter name to append to the URL. For example, if you are
using ChartPop, you might use the acctnum parameter.
For available parameters, see the documentation for the respective Pop
integration.
Keyword Type Select the Keyword Type whose value should be used for the specified
parameter.
If the document does not have an instance of the specified Keyword
Type, the parameter appended without a value.
If the document contains multiple instances of the specified Keyword
Type, then the first value is used.
Select Include Text Transcription to include text transcription data in the OBX.5 field.
The OBX.5 field in the HL7 message template must have a default value of $^TXDATA.
Caution: Do not enable this option if you want Workflow to send HL7 messages for image
documents. The Include Text Transcription option is supported only for text documents. If this
option is enabled, it will stop Workflow from sending an HL7 message if the documents format is
not Text Report Format. For documents with both image and text renditions, the latest text
rendition is sent.
Note: The Include Text Transcription option is not supported in the Classic Client interface.
Caution: This action does not support Medical Records Management Document Types.
2012 Hyland Software, Inc.
920
OnBase 12 Workflow
Sets the Document Type of the document to the Document Type specified. If the Document
Type selected has multiple revisions configured, the most recent revision of the Document
Type structure will be used for the document. The manner in which Keyword Values are
transitioned between the Document Types is determined by the Keep Only Common Keywords
check box. If the box is checked, only keywords common to the two document types are
maintained. (If the document is transitioned back to the original document type, any
keywords not in common will be lost.) If the box is unchecked, all keyword references are
Note: If the Document Type specified belongs to a life cycle, the document does not enter the
life cycle associated with the new Document Type upon execution of this action.
Note: If the Document Type of a document is changed to a Document Type that is set up for
document revisions and the original Document Type was not configured for document
revisions, an initial revision of the document is automatically created when the new Document
Type is applied.
Caution: If the Document Type transitioned from uses a Keyword Type Group, non-common
keywords will not be kept, regardless of the Keep Only Common Keywords setting. Likewise, if the
Document Type transitioned to uses a Keyword Type Group, the non-common keyword will not
be kept.
Caution: If a Document Type associated with standard Keyword Types is changed to a Document
Type associated with a Keyword Type Group and then changed back to the original Document
Type, all non-common Keyword Values are lost.
Caution: If a Document Type associated with standard Keyword Types or a Keyword Type Group
is changed to a Document Type associated with a Multi-Instance Keyword Type Group, all
Keyword Values are lost. Likewise, if a Document Type associated with a Multi-Instance Keyword
Type Group is changed to a Document Type associated with standard Keyword Types or a
Keyword Type Group, all Keyword Values are lost. Keyword Values will only be kept if a
Document Type assigned with a Multi-Instance Keyword Type Group is set to another Document
Type with the same Multi-Instance Keyword Type Group association.
Target
In the Target drop-down select list, define whether you want the action to execute on the
current document/item in the queue or a related document/item.
If you are configuring the action for related documents, see Related Tab on page 1007 for
more information.
2012 Hyland Software, Inc.
921
Workflow OnBase 12
Note: This action is only supported in the Classic Client, Core-based Client, and Unity
interfaces.
This action sets the folder and template that will be used to populate the related documents
list in the Workflow clients. Before configuring this system action, the folder and/or template
Workflow Studio Actions
that you plan to use must be created. Once configured, select the folder type to apply from
the Folder Type drop-down select list.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
You can select a specific template to display all the time, by selecting the Use This Template
option, or you can select the Get Template to Use from Keyword option to specify a template to
be used under certain conditions. If a folder type or template was configured at the queue or
life cycle level, applying this action type overrides those configurations. If you want to
suppress the reloading of the Work Folder after task execution, select the Suppress Screen
Refresh option. The folder and template that are set with this action will not persist when
another queue or life cycle is selected.
Sets the related documents priority to be the same as the current documents priority.
Active Document in this Life Cycle
Select the life cycle from this drop-down select list for which you would like the priority set for
the active item/document. Priorities are attached to life cycles for an item or document. It is
possible to have different priority assignments for one item/document in multiple life cycles.
If <Current Life Cycle> is selected, the priority will be set for the life cycle executing the action
Related Documents in this Life Cycle
Select the life cycle from this drop-down select list for which you would like the priority set for
the related document.
If you are configuring the action for related documents, see Related Tab on page 1007 for
more information.
Sign Document
Note: This action requires that your system is licensed for Digital Signatures.
Note: This action is not supported in the OnBase Mobile or Desktop interfaces.
2012 Hyland Software, Inc.
922
OnBase 12 Workflow
Signs the document using the Workflow module. When used with the Classic Client interface,
this action respects the Allow batch signing Global Client Settings option to allow multiple
documents to be signed and providing a user name and password only once. A message is
displayed if no certificate-based signatures are configured. This option is not respected within
the Core-based Workflow interfaces. This action cannot be configured under system work,
load balancing work, or timer work.
If the Do Not Break Processing option is selected, task lists do not abort processing after
signing a document fails or is canceled.
Split Document
Note: When using the Create Document from Select Page(s) option, this action is not supported
in the Web Client, Java Client, Desktop, Outlook Integration, or OnBase Mobile interfaces. The
Break Document on Each Page option is supported in the Web Client and Java Client interfaces.
If Inherit Keys from Active Document is selected, the Inherit All and Inherit Selected options are
enabled. If Inherit All is selected, all Keyword Values on the current document are inherited by
the new document. If Inherit Selected is selected, the Configure button is enabled. Click
Configure and select the Keyword Types from which you want the new document(s) to inherit
values.
Inherit Notes
If this option is selected, notes from the current document are inherited by the new
document(s).
Initiate Workflow on New Document(s)
2012 Hyland Software, Inc.
923
Workflow OnBase 12
If this option is selected, Workflow is initiated for the newly created document(s).
Note: Users must have rights to the Document Type to which documents will be split into.
Stamp Version
Workflow Studio Actions
Note: This action requires that your system is licensed for EDM Services.
Stamps the most recent revision of the current document as a version. If the Document Type
of the document is not revisable or does not allow versions, the action is not executed. Also,
in order for this action to function, the last revision must not be already stamped as a version.
Once a revision is stamped as a version, it cannot be stamped a second time. If the stamped
document is revised again, the action will function, and the new revision will be stamped as a
second version.
Choose from four options to configure this action:
Show Dialog: This option displays a dialog box in the Client in which the user can
configure a version number for the document. Enabling this option requires that the
user be able to interact with the dialog box, otherwise the document will not be
stamped. This option should not be configured to run with timers or system work.
Note: This action is not supported in the Unity or OnBase Mobile interfaces when this option is
selected.
The next three options are ideal for life cycles that require the document to be stamped
silently. Examples of this are configurations that use timers or system work to stamp the
document.
Enter Name: Enables the user to configure a name that will be assigned to
documents when the version is stamped. By using this option, users can use %V as
a wildcard. This wildcard will display on the document as the version number.
Note: Enter Name is the only option that supports the %V wildcard. The name is limited to 14
characters.
Keyword Type: Enables the user to configure a Keyword Type from which the value
for the version number will be pulled. Users can select a Keyword Type from a drop-
down list.
Property Name: Enables the user to configure a property name from which the value
for the version number will be pulled.
If the Do Not Break Processing option is selected, a task list does not abort after a user cancels
out of the Version Information dialog box.
Note: The Do Not Break Processing option is currently not available in the Core.
2012 Hyland Software, Inc.
924
OnBase 12 Workflow
Updates the Auto-Name string for the current document(s). You typically use this action when
a keyword used in the documents auto-name string is changed outside of Workflow
processing.
Marks a document for purging or increments the retention period by the number of days,
months, or years configured at the Document Type.
If Mark for Purging is configured for this action, the document is marked for purging and can
be removed from OnBase using the associated Purging Processor in the Client module.
If Increment Retention Period (based on Document Type) is configured, the dateexpire value
stored for the document in the database is increased by a value equal to the retention period
defined for the Document Type, to which the document belongs, from the current date. For
example, if the current date is January 15, 2007 and the retention period defined for the
Document Type is 5 years, the dateexpire value would be updated to January 15, 2012. This
value will then be used when the document is evaluated against the associated Evaluating
Processor in the Client module.
If Increment Retention Period by Specified Value is configured, you can specify a number of
days, months, or years to increment the dateexpire value. The dateexpire value will be
updated with the current day plus the configured numbered of days, months, or years. Enter
the number of days, months, or years in the field and select Day(s), Month(s), or Year(s) from
the drop-down select list. The maximum number of days that can be entered is 999. The
maximum number of months or years is 255.
If the Do not Purge, Do not Increment Retention Period option is selected, the dateexpire value
is not updated, but the retainstatus value is set to 0, making the document available to be
evaluated by the evaluation Document Retention processor immediately in the Client.
Note: This action is not supported in the Classic Client or Java Client interfaces.
Note: WorkView must be installed on the database in which you want to configure this action.
If you import a life cycle into a database, that database must have WorkView installed to
successfully import the life cycle.
2012 Hyland Software, Inc.
925
Workflow OnBase 12
Allows the user to update one or more WorkView objects, pulling the attribute values from
Keyword Values on the current document. The action determines which WorkView objects to
update by the user configuring the action to use a filter Document Type Association or to
update all WorkView objects that have the current document attached. The user can only
specify one filter/update Document Type Association per Document Type. When the action
executes it looks for a filter/update Document Type Association that matches the current
Document Type, and uses the filter Document Type Association (if specified) to determine
Workflow Studio Actions
which WorkView objects to update, and uses the update Document Type Association to
determine what values to set the WorkView objects attributes to.
To configure the action:
1. Select the appropriate Document Type from the drop-down select list. The Filter
Document Type Association and Update Document Type Association drop-down select
lists will populate based on the Document Type selected.
2. If you want to specify the Filter Document Type Association for which the object meets
the configured criteria to determine which objects should be updated, select the
appropriate Filter Document Type Association. When this option is configured, a
document does not have to be attached to an object in order for it to be updated. The
Filter Document Type Association name is followed by (Class ClassName). Only Filter
Document Type Associations associated with the Document Type selected are
displayed. If no Filter Document Type Associations are configured for the selected
Document Type or you wish to evaluate an objects existence based on whether the
current document in Workflow is attached to an object in a static folder, select <All
objects that have doc attached>. When using the <All objects that have doc attached>
option, the object(s) must be attached in a static folder.
3. Select a Document Type Association to update the applicable objects from the Update
Document Type Association. The Document Type Associations that are displayed are
configured at the class level and are configured for the selected Document Type.
4. Click Add.
Caution: When a relationship attribute is used during object creation, if more than one object is
found for the relationship attributes value, the first object found is used for the relationship. If
an object is not found that matches the relationship attributes value, the value for the
relationship attribute is stored as blank in the updated object.
If you want to save the ID of the object(s) updated, select Save Object ID(s) to Property and
enter the name of the property you want to store the ID(s) in the field.
2012 Hyland Software, Inc.
926
OnBase 12 Workflow
Allows you to set the property specified in the Property Name field to the field value specified
from the Field drop-down select list.
1. In the Properties pane, on the General tab, type a property name in the Property Name
field.
2. From the Field drop-down select list, select the field that will be used to set the
property.
Field Description
Project Review Type The ePlan Review projects review type field.
Submitters Email The e-mail address of the ePlan Review projects submitter.
Set Value
Allows you to set the field specified in the Field to set drop-down select list to the specified
value.
1. In the Properties pane, on the General tab, from the Field to set drop-down select list,
select the field to set.
The following selections are available:
Field Description
Project Review Type The ePlan Review projects review type field.
2012 Hyland Software, Inc.
927
Workflow OnBase 12
Field Description
Submitters Email The e-mail address of the ePlan Review projects submitter.
2. From the Obtain value from drop-down select list, select one of the following locations
Workflow Studio Actions
Constant value This option sets the field value to the constant value specified.
Current date/time This option sets the field value to the current date/time.
Current user name This option sets the field value to the user name of the currently
logged in user. If you want to use the configured real name for the
user, select the Use real name option.
Property This option sets the field value to the name of a property.
User group name(s) of This option sets the field value to the user group(s) the current
current user logged in user.
3. In the Properties pane, click the Documentation tab. Enter any descriptive information
that is applicable in the Overview and Details fields.
Foldering Category
Transition to Final Disposition
Note: This action requires that your system is licensed for Records Management.
Note: This action requires that the appropriate managed folders are configured.
Keyword Category
Add Keyword
Adds a keyword with the specified value of the specified Keyword Type to the active document.
The Keyword Type selected must be associated with the Document Type of the document in
order for the action to succeed. Specify the Keyword Value to add.
2012 Hyland Software, Inc.
928
OnBase 12 Workflow
If the Keyword Type selected uses an Alphanumeric data type, the System Value drop-down
select list is enabled. Select Current User ID if you want the new value to be the User Id of the
currently logged in user. Select Current Users Name if you want the new value to be the user
name of the currently logged in user. Select Current Users Real Name if you want the new
value to be the real name specified for the currently logged in user.
If the Keyword Type selected uses a Date data type, the Current Date option can be selected to
Note: Date and date & time formatting are dependent on regional settings.
Target
In the Target drop-down select list, define whether you want the action to execute on the
current document/item in the queue or a related document/item.
If you are configuring the action for related documents/items, see Related Tab on page 1007
for more information.
Fills Keyword Values on a document with values from an AutoFill Keyword Set. This action
should be used in system work. The primary Keyword Type must have a value associated with
an AutoFill Keyword Set in order for the action to fill Keyword Values. All documents that do
not have a primary value associated with an AutoFill Keyword Set will not have additional
values applied to the document.
Select the appropriate AutoFill Keyword Set from the Select Autofill Set drop-down select list.
Caution: If more than one Autofill Keyword Set exists with the same primary Keyword Value and
the Expand All Matching Instances option is not set for the AutoFill Keyword Set, when the action
is executed, no AutoFill will take place.
Two options are available: Keep Existing Values and Replace Secondary Values When Only One
Instance Exists.
Caution: The Replace Secondary Value When Only One Instance Exists option should not be used
with documents that have more than one secondary value of the same Keyword Type.
When Keep Existing Values is selected, it will retain the original secondary Keyword Values and
a new instance will be added containing the AutoFill Keyword Set data.
2012 Hyland Software, Inc.
929
Workflow OnBase 12
When Replace Secondary Values When Only One Instance Exists is selected, the following will
occur:
When using standard Keyword Types, the secondary Keyword Values will be replaced
if only one instance of the secondary keyword exists. If more than one instance of
the secondary keyword is found, the original secondary values will be retained and a
new instance is created containing the data from the AutoFill keyword set.
Workflow Studio Actions
Caution: In the Classic OnBase Client user interface, if there are already keyword values
associated with the primary Keyword Type value, the associated values will be replaced with the
value from the AutoFill Keyword Set when this action is executed.
When using Keyword Type Groups, secondary Keyword Values will always be replaced
with the data from the AutoFill Keyword Set.
When using Multi-Instance Keyword Type Groups, if a single instance of the primary
Keyword Type exists, secondary Keyword Values will be replaced with the data from
the AutoFill Keyword Set. If multiple instances of the specified primary value exist,
the original data will be retained and a new instance containing the data from the
AutoFill Keyword Set will be populated.
2012 Hyland Software, Inc.
930
OnBase 12 Workflow
The following describes what can be expected using the Keep Existing Values and Replace
Secondary Values When Only One Instance Exists options with standard Keyword Types,
Keyword Type Groups, and Multi-Instance Keyword Type Groups:
Caution: When using the Classic OnBase Client, it is recommended that the Replace Secondary
Values When Only One Instance Exists option is used only if has been determined that documents
only have one value for each Keyword Type. If there are two or more secondary values on a
document and the action is configured to Replace Secondary Value When Only One Value Exists, the
Classic Client does not know which value to replace and the user will not know which value has
been replaced.
2012 Hyland Software, Inc.
931
Workflow OnBase 12
Caution: This action can populate values for multiple primary values. For each primary, there will
be corresponding secondary values for the associated Keyword Types, as defined in the AutoFill
Keyword Set. If a primary value is associated with multiple AutoFill Keyword Sets, no secondary
values will be populated for that primary value.
Workflow Studio Actions
Caution: If using a Multi-Instance Keyword Type Group, the AutoFill Keyword Set will only
populate if both the primary and secondary values reside in the Keyword Group. If the secondary
values are outside of the Multi-Instance Keyword Type Group, the AutoFill Keyword Set will not
populate.
2012 Hyland Software, Inc.
932
OnBase 12 Workflow
Copy Keyword
Copies the value of the Source keyword into the value of the Destination keyword on the active
document.
Note: Keyword Values from standard Keyword Types cannot be copied to/from Keyword Types
in a Multi-Instance Keyword Type Group.
Source/Destination Keyword
Select the Keyword Type from which to take the values in the Source Keyword drop-down list.
The following system keywords are available from this drop-down select list, in addition to
configured Keyword Types:
>> Document Date
>> Date Stored
>> Document Handle
>> Document Name
>> Document Type
For more information about these system properties, see the Document Properties topic in
the OnBase Client help system.
2012 Hyland Software, Inc.
933
Workflow OnBase 12
Select the Keyword Type to which the value should be copied in the Destination Keyword drop-
down list.
Note: When copying currency formatted Keyword values, the currency format of both the
Source Keyword and Destination Keyword must have the same formatting to ensure successful
copying.
Workflow Studio Actions
Note: When a Date or Date/Time Keyword Value is copied into an alphanumeric Keyword Type,
the servers default date and date/time format is used.
You can acquire the source Keyword Type from a property value by selecting Source keyword
type from property and entering the property in the field.
Likewise, you can acquire the destination Keyword Type from a property value by select
Destination keyword type from property and entering the property in the field.
Note: Keyword Values from standard Keyword Types cannot be copied to/from Keyword Types
in a Multi-Instance Keyword Type Group.
Source/Destination Keyword
Select the Keyword Type from which to take the values in the Source Keyword drop-down list.
The following system keywords are available from this drop-down select list, in addition to
configured Keyword Types:
>> Document Date
>> Date Stored
>> Document Handle
>> Document Name
>> Document Type
For more information about these system properties, see the Document Properties topic in
the OnBase Client help system.
2012 Hyland Software, Inc.
934
OnBase 12 Workflow
Select the Keyword Type to which the value should be copied in the Destination Keyword drop-
down list.
Note: When copying currency formatted Keyword values, the currency format of both the
Source Keyword and Destination Keyword must have the same formatting to ensure successful
copying.
You can acquire the source Keyword Type from a property value by selecting Source keyword
type from property and entering the property in the field.
Likewise, you can acquire the destination Keyword Type from a property value by select
Destination keyword type from property and entering the property in the field.
Note: When copying currency formatted Keyword values, the currency format of both the
Source Keyword and Destination Keyword must have the same formatting to ensure successful
copying.
If you are configuring the action for related documents/items, see Related Tab on page 1007
for more information.
Note: When copying currency formatted Keyword values, the currency format of both the
Source Keyword and Destination Keyword must have the same formatting to ensure successful
copying.
If you are configuring the action for related documents/items, see Related Tab on page 1007
for more information.
2012 Hyland Software, Inc.
935
Workflow OnBase 12
Copies the value of the Source Keyword on a related item into the value of the Destination
Keyword on the active item.
Note: Keyword Values from standard Keyword Types cannot be copied to/from Keyword Types
Workflow Studio Actions
Source/Destination Keyword
Select the Keyword Type from which to take the values in the Source Keyword drop-down list.
The following system keywords are available from this drop-down select list, in addition to
configured Keyword Types:
>> Document Date
>> Date Stored
>> Document Handle
>> Document Name
>> Document Type
For more information about these system properties, see the Document Properties topic in
the OnBase Client help system.
Select the Keyword Type to which the value should be copied in the Destination Keyword drop-
down list.
Note: When copying currency formatted Keyword values, the currency format of both the
Source Keyword and Destination Keyword must have the same formatting to ensure successful
copying.
You can acquire the source Keyword Type from a property value by selecting Source keyword
type from property and entering the property in the field.
Likewise, you can acquire the destination Keyword Type from a property value by select
Destination keyword type from property and entering the property in the field.
If you are configuring the action for related documents/items, see Related Tab on page 1007
for more information.
2012 Hyland Software, Inc.
936
OnBase 12 Workflow
You can select Keep all existing keyword values if you want to keep the existing values, but add
the values from the item. You can select Keep all existing values for common keywords if you
want to keep the values of common Keyword Types between the primary item and the related
item, but discard those that are not common between the two. You can select Delete all
existing keyword values if you want to delete the existing values and add the values from the
item. You can select Delete existing values for common keywords if you want to delete the
values of Keyword Types that are common between the primary and related items before
Note:If the Folder Type method is used, the Keep existing values for common keywords and
Delete existing values for common keywords options are not available.
Keyword Handling
The following table describes the behavior for copying a keyword from a primary item to a
related item or a new E-Form.
Multi -Instance Multi-Instance Only copy if they are the same Multi-Instance
Keyword Type Group Keyword Type Group Keyword Type Group (means they have the same
identification number)
The following table describes the behavior for deleting a keyword from a related document
based on a primary document.
2012 Hyland Software, Inc.
937
Workflow OnBase 12
Multi -Instance Multi -Instance Only delete if they are the same Multi -Instance
Keyword Type Group Keyword Type Group Keyword Type Group (means they have the same
identification number)
This action will create an AutoFill Keyword Set instance from the values on the document.
Select the appropriate AutoFill Keyword Set from the drop-down select list that will be filled
with values from the document.
When using this action, the primary keyword of the AutoFill Keyword Set must contain a value
on the document in Workflow in order for the AutoFill Keyword Set record to be created.
Target
In the Target drop-down select list, define whether you want the action to execute on the
current document/item in the queue or a related document/item.
If you are configuring the action for related documents/items, see Related Tab on page 1007
for more information.
Caution: When creating AutoFill Keyword Sets that consist of a mixture of standard Keyword
Types, Single Instance Keyword Type Groups, and/or Multi-Instance Keyword Type Groups,
values of the Keyword Types that are of the same type and, if part of a Keyword Type Group,
belong to the same Keyword Type Group as the primary Keyword Type will be populated.
Keyword Types not of the same type as the primary Keyword Type will not be populated.
2012 Hyland Software, Inc.
938
OnBase 12 Workflow
Target
In the Target drop-down select list, define whether you want the action to execute on the
If you are configuring the action for related documents/items, see Related Tab on page 1007
for more information.
Keyword Type
The drop-down list displays available Keyword Types. Only keywords of the selected Keyword
Type are affected.
You can acquire the source Keyword Type from a property value by selecting Get keyword type
from property and entering the property in the field.
Caution:This action will remove AutoFill Keyword Set record(s), with specified value(s) in the
primary keyword, from the database. Ensure that this action is configured properly. The removal
of AutoFill Keyword Set records is permanent and irreversible.
This action will delete AutoFill Keyword Set records that match the configured criteria.
Select the AutoFill Keyword Set from which you would like to remove records from.
The primary Keyword Types populates the Keyword Type to Search field automatically.
If you want to specify a certain value that will identify the records that will be deleted, select
Specific Value and enter the appropriate value in the field.
If you want to use the a value within a property to identify the record(s) to be deleted, select
Property and enter the name of the property in the field.
If you want to use a Keyword Type value to identify the record(s) to be deleted. select
Keyword and select the Keyword Type from the drop-down list that will contain the
appropriate value.
Note:This action is not supported when working with external AutoFill Keyword Sets.
Note:This action is not supported in the Core when Currency, Date, or Date/Time keywords
are configured as the primary keyword in the AutoFill Keyword Set.
2012 Hyland Software, Inc.
939
Workflow OnBase 12
Delete Keyword
Deletes the specified Keyword value from the active document.
Target
In the Target drop-down select list, define whether you want the action to execute on the
current document/item in the queue or a related document/item.
Workflow Studio Actions
If you are configuring the action for related documents/items, see Related Tab on page 1007
for more information.
Keyword Type
The drop-down list displays available Keyword Types. Only keywords of the selected Keyword
Type are affected.
Keyword Value
Specify the value in the Constant value field for the value that will be deleted.
Specify the name of the property for you which you want to delete keyword values that match
the property value in the Property Name field. This option allows keyword values to be deleted
dynamically by using property values to determine the keyword value to be deleted.
If the Keyword Type selected uses a Date or Date & Time data type, selecting Current Date is
will use the current date as the value. Date and date & time formatting are dependent on
regional settings.
When an alphanumeric Keyword Type is selected, the Timestamp option can be selected to use
the date/time information for the Keyword Value.
Allow Wildcards
The Allow Wildcards allows wildcards to be used in the Keyword Value field. When using
wildcards, you can use the? (question mark) wildcard to replace a specific number of
characters. For example, a value of COLUMB ?? succeeds for COLUMBUS, COLUMBIA and any
other eight-character Keyword Value beginning with COLUMB. The * (asterisk) wildcard
represents an indefinite number of characters. COLUMB* succeeds for any length keyword
values beginning with COLUMB, such as those mentioned above and COLUMBO and
COLUMBIANA.
Note: The Allow Wildcards check box is only enabled for Alphanumeric Keyword Types.
Wildcards can be used with Alphanumeric Keyword Types that have masking configured.
When masking is used, the ? wildcard must be used.
Increment/Decrement Keyword
Adds the value specified to the Keyword Value on the active document. The Keyword Value is
increased or decreased incrementally by the number specified in the Amount edit field.
Target
2012 Hyland Software, Inc.
940
OnBase 12 Workflow
In the Target drop-down select list, define whether you want the action to execute on the
current document/item in the queue or a related document/item.
If you are configuring the action for related documents/items, see Related Tab on page 1007
for more information.
Keyword Type
Caution: If you enter 0 in this field, when saved, it will automatically default to 1 for the value.
2012 Hyland Software, Inc.
941
Workflow OnBase 12
Creates an empty Multi-Instance Keyword Type Group of the type specified in the Keyword
Record drop-down select list. Only Multi-Instance Keyword Type Groups will be listed in this
drop-down select list. The Multi-Instance Keyword Type Group that is created is not saved to
the database until Workflow encounters the Keyword Record - End action.
Caution:Any rules or actions that evaluate Keyword Values that have been added to the Multi-
Instance Keyword Type Group before the Keyword Record - End action is encountered will not be
Workflow Studio Actions
evaluated correctly. The newly created Multi-Instance Keyword Type Group must be saved before
the values within it can accurately be evaluated.
Note:It is recommended to keep tasks simple that modify Multi-Instance Keyword Type
Groups. It is recommended to only add keywords between the Keyword Record - Begin and
Keyword Record - End actions. If this cannot be achieved, make sure that the Keyword Record -
End action follows after every Keyword Record - Begin action and test the configuration
thoroughly. The Add Keyword, Set Keyword from Property Value, and Set Keyword to Entry to
Queue Date actions may be used in between the Keyword Record - Begin and Keyword Record -
End actions for Core-based interfaces. The Classic Client interface only supports Add Keyword
between the Keyword Record - Begin and Keyword Record - End.
You can acquire the source Keyword Type from a property value by selecting Get keyword
record from property and entering the property in the field.
See Using Multi-Instance Groups with Begin/End Keyword Record on page 673 for more
information.
Signals to save the new Keyword Type Group of the type specified in the Keyword Record
drop-down select list created by the Keyword Record - Begin action. Only Multi-Instance
Keyword Type Groups will be listed in this drop-down select list. This action saves all Keyword
Values added to the Keyword Type Group.
Caution:If this action is not used in conjunction with the Keyword Record - Begin, all values added
to a Keyword Type Group created by the Keyword Record - Begin action will not be saved and the
values entered will be lost.
Note:It is recommended to keep tasks simple that modify Multi-Instance Keyword Type
Groups. It recommended to only add keywords between the Keyword Record - Begin and
Keyword Record - End actions. If this cannot be achieved, make sure that the Keyword Record
- End action follows after every Keyword Record - Begin action and test the configuration
thoroughly.
See Using Multi-Instance Groups with Begin/End Keyword Record on page 673 for more
information.
You can acquire the source Keyword Type from a property value by selecting Get keyword
record from property and entering the property in the field.
2012 Hyland Software, Inc.
942
OnBase 12 Workflow
Replace Keyword
Replaces the specified Keyword Value on the active document.
Select the Keyword Type from the drop-down select list of which you would like to replace the
value. If you have a specific value you want the system to look for and replace, enter the
value in the Old Keyword field. Enter the value that you want to put in the old value's place in
Note: In the Classic Client interface, when setting an Alphanumeric Keyword Type and using
the Time Stamp option, the value will be truncated if it is exceeds the number of characters
configured for a Keyword Type. The Core-based interfaces will not allow the value to be saved
if the length exceeds the number of characters configured for a Keyword Type.
Currency Format
When the Keyword Type selected is configured as a Specific Currency Data Type, a Currency
Format drop-down select list is enabled. Any specific currency format configured for the
system can be selected from the drop-down select list.
This action allows you to change the value of a Keyword Type within a specific AutoFill
Keyword Set using static values. The AutoFill Keyword Set that will be updated is identified by
matching values of the specified Keyword Type(s) associated with the currently displayed
document.
AutoFill Keyword Set drop-down select list allows you to select the AutoFill Keyword Set in
which you want to update values.
2012 Hyland Software, Inc.
943
Workflow OnBase 12
Based on your selection in the AutoFill Keyword Set drop-down select list, the First Keyword
Type to Search field will be populated with the primary Keyword Type associated with the
AutoFill Keyword Set. The value from the currently selected document will be used for the
search.
The Second Keyword Type (Optional) drop-down select list allows you to further identify the
AutoFill Keyword Set for which you want to update values. It is an optional selection. The
Workflow Studio Actions
value from the currently selected document will be used for the search.
Note: The primary Keyword Type is not available for selection in the Second Keyword Type
(Optional) drop-down select list.
The Keyword Type to Set Value drop-down select list allows you to select the Keyword Type
value for which you want to change.
The Keyword Value field contains the value to which the Keyword Type will be changed.
When an Alphanumeric Keyword Type is selected, the Current Date option can be selected to
use the date/time information for the keyword value.
Note:This action is not supported when working with external AutoFill Keyword Sets.
This action allows you to change the value of a Keyword Type within a specific AutoFill
Keyword Set using existing Keyword Type values. The AutoFill Keyword Set that will be
updated is identified by matching values of the specified Keyword Type(s) associated with the
currently displayed document.
AutoFill Keyword Set drop-down select list allows you to select the AutoFill Keyword Set in
which you want to update values.
Based on your selection in the AutoFill Keyword Set drop-down select list, the First Keyword
Type to Search field will be populated with the primary Keyword Type associated with the
AutoFill Keyword Set. The value from the currently selected document will be used for the
search.
The Second Keyword Type (Optional) drop-down select list allows you to further identify the
AutoFill Keyword Set for which you want to update values. It is an optional selection. The
value from the currently selected document will be used for the search.
Note: The primary Keyword Type is not available for selection in the Second Keyword Type
(Optional) drop-down select list.
The Keyword Type to Set Value drop-down select list allows you to select the Keyword Type
from which you would like to copy the value from the currently displayed item to the
identified AutoFill Keyword Set.
Note:This action is not supported when working with external AutoFill Keyword Sets.
2012 Hyland Software, Inc.
944
OnBase 12 Workflow
This action allows you to copy a date value within an AutoFill Keyword Set to the Entry to
Queue Date for a document. This date is displayed as the Arrival Time in the Workflow Inbox.
Note: The primary Keyword Type is not available for selection in the Second Keyword Type
(Optional) drop-down select list.
The Keyword Type to Set Value drop-down select list specifies what Keyword Type value will be
used as the entry to queue date (arrival time) and will be copied to the item.
Note:If no value exists in the AutoFill Keyword Set for the specified Keyword Type, no action is
taken.
Note:If multiple AutoFill Keyword Sets match the search criteria, the value from the first
AutoFill Keyword Set found will be applied.
Note:This action is not supported when working with external AutoFill Keyword Sets.
2012 Hyland Software, Inc.
945
Workflow OnBase 12
Target
In the Target drop-down select list, define whether you want the action to execute on the
Workflow Studio Actions
If you are configuring the action for related documents/items, see Related Tab on page 1007
for more information.
Keyword Type
The drop-down list displays available Keyword Types. Only keywords of the selected Keyword
Type are affected.
You can acquire the source Keyword Type from a property value by selecting Get keyword type
from property and entering the property in the field.
The Use Real Name option will cause the keyword to populate with the users real name as
specified in User Settings dialog box in the Configuration module.
This action allows you to copy a value within an AutoFill Keyword Set to the currently
displayed document. This action copies the Keyword Value without expanding the entire
AutoFill Keyword Set on the document.
AutoFill Keyword Set drop-down select list allows you to select the AutoFill Keyword Set in
which you want to update values.
Based on your selection in the AutoFill Keyword Set drop-down select list, the First Keyword
Type to Search field will be populated with the primary Keyword Type associated with the
AutoFill Keyword Set. The value from the currently selected document will be used for the
search.
The Second Keyword Type (Optional) drop-down select list allows you to further identify the
AutoFill Keyword Set for which you want to update values. It is an optional selection. The
value from the currently selected document will be used for the search.
Note: The primary Keyword Type is not available for selection in the Second Keyword Type
(Optional) drop-down select list.
2012 Hyland Software, Inc.
946
OnBase 12 Workflow
The Keyword Type to Set Value drop-down select list specifies what Keyword Type value will be
copied to the document.
Note:If there are several matching AutoFill set records, all corresponding Keyword Values will
be copied to the document.
Note:This action is not supported when working with external AutoFill Keyword Sets.
Keyword Type
The drop-down list displays available Keyword Types. Only keywords of the selected Keyword
Type are affected.
You can acquire the source Keyword Type from a property value by selecting Get keyword type
from property and entering the property in the field.
See Related Tab on page 1007 for more information.
2012 Hyland Software, Inc.
947
Workflow OnBase 12
Keyword Type
The drop-down list displays available Keyword Types. Only keywords of the selected Keyword
Type are affected.
See Related Tab on page 1007 for more information.
Workflow Studio Actions
Property Category
Copy Property
Allows the user to copy the value of a property to another property, an E-Form field, or an
XML Path.
Specify the Property Name of the property that contains the value you want to copy.
Select To another property if you want to copy the value of the specified property to another
property. Enter the property name in the corresponding field. If a value already exists in the
property that will inherit the value and it should be overwritten, select the Overwrite if
property exists option.
Select To E-Form field if you want copy the value of the specified property to an E-Form field.
Specify the E-Form field that you want to copy the value to in the corresponding field. This
action is supported only for fields that are not linked to Keyword Types. This field should be a
text field.
Note:This option is only supported in the Core-based and Java Client interfaces.
All changes to an E-Form made with this option will be recorded in the Document History as a
Field Modified action. If the Document Type of the E-Form is configured for revisions, this
option also will create a new revision of the E-Form.
Note:Check boxes and radio button values are currently not supported for copying.
Select To XML Path if you want to copy the value of the specified property to an XML node.
Enter the XPATH at which the node is located in the corresponding field. The XPATH is where
the XML node is located. This action opens the text of the XML document, looks for the node,
and copies the specified property to the node.
For this to execute successfully, the document must be an XML document or a rendition of an
XML document.
2012 Hyland Software, Inc.
948
OnBase 12 Workflow
If using revisable documents, when the action executes, a new revision will be made of the
document. If the document is either non-revisable or not an XML document, the Last
Execution Result will be set to FALSE, but the process will not be aborted.
In order for XPath queries containing references to namespaces to be properly evaluated, the
following criteria must be met:
The document must be imported via the Document Connector.
The document must be associated with a valid XML Format.
All namespaces referenced in the XPath Query must be defined in the associated
XML Format.
Note: This action is supported only in the Unity and Web Client interfaces.
This action will copy a property value to a Unity Form field or it will copy a value from a Unity
Form field to a property.
Property Name
Enter the name of the property that you would like to copy a value from or to.
Unity Form Field Name
From the Unity Form Field Name drop-down select list, select the field that you would like to
copy to or from. Each field that exists on Unity forms within the OnBase system is listed. If
more than one form contains the same field name and those forms are used within the same
life cycle, the field defined will be used regardless of what form it exists on.
Copy to Unity Form Field
Select this option if you want to copy a property value to a Unity Form field.
Note: If a value does not meet formatting requirements for a field, the value will not be copied
and if a value already existed, the existing value will be retained on the form.
Note: This action cannot be used to copy the value of a property to a calculated field in a Unity
Form.
2012 Hyland Software, Inc.
949
Workflow OnBase 12
Allows you to increment or decrement the property specified in the Property Name field. Enter
the value by which you want to increment or decrement the property in the Amount field.
Select either Increment or Decrement to determine how the Amount value will be applied. If
the property contains an array of values, the action will increment/decrement each value in
Workflow Studio Actions
the array.
Note:The maximum value for the Increment and Decrement fields is 9 digits (999999999).
2012 Hyland Software, Inc.
950
OnBase 12 Workflow
If the property value contains an array of values, all of those values are added to the
document. If a property contains an array of values and the action is configured to replace
existing values, only the first value in the array will be used to set the keyword value. For
example, if the property being used by the action contains the array of values "Property #1"
and "Property #2", the "Property#1" value will be used to replace existing keyword values.
Note: Find value from another property does not support properties containing array values.
You can use the %K token for Keyword Type values and the %V token for property values.
Here is an example: Left( %K00001; 5 ) In this example, the property will be set to the first 5
characters of the specified Keyword Type value.
Supported Operators
The following operators are supported:
+, -, *, /, =, !=, <>, <, <=, >, >=
Brackets for grouping
The NOT, OR, and AND operators
The case-sensitive = operator. In order to compare two values as case-insensitive
the user will need to convert both values to upper or lower case using the
appropriate function.
Functions
The functions are supported:
Function Description
2012 Hyland Software, Inc.
951
Workflow OnBase 12
Function Description
Ceil Returns the smallest whole number greater than or equal to the
specified number.
Floor Returns the largest whole number less than or equal to the
specified number.
IsGroupLoggedIn Returns true if one or more of the members in the specified user
group is logged in.
IsInDataSet Returns a Boolean value that indicates whether the passed value is
in a Data Set. This function will determine whether the specified
value matches a value in the specified Keyword Type's Data Set.
The Keyword Type name must be entered in double quotations
marks. The value specified should be a variable configured for the
current rule engine queue. If the specified Keyword Type is not
configured to use Data Sets, NULL is returned and the condition
will not be evaluated.
2012 Hyland Software, Inc.
952
OnBase 12 Workflow
Function Description
Round Returns the number with the specified precision nearest the
specified value.
XPath Used for retrieving the value from an XML document currently
being evaluated in the rules engine.
Symbol Description
2012 Hyland Software, Inc.
953
Workflow OnBase 12
Symbol Description
Note: This symbol is only applicable when used with an Institutional Database.
Workflow Studio Actions
%C Displays the name of the user who created the current document.
%D1 Displays the date that the document was stored. This value cannot be changed.
%I1 or %T Displays the time that the document was stored. This value cannot be changed.
%K###.n Displays the Keyword Value of Keyword Type ### n times. For example, %K101.4
would display up to 4 unique Keyword Values for Keyword Type 101 for a single
document.
For some functionality, a Keyword Type drop-down list may be available to
configure this. Select a Keyword Type from the drop-down select list, enter the
number of times you want the Keyword Value to be displayed in the Repeat field,
and click Keyword. The value in the Repeat field specifies how many instances of
the Keyword Value will be displayed. Entering an * character will pull all existing
Keyword Values for display up to 99 instances.
Note: When using the Classic Client interface, double digits in the Repeat field are
not supported.
%M Extracts metadata values from items. This includes attribute values from Workview
objects or a field values from an Entity item.
%M must be followed by the metadata value you want to extract. For example, if
you want to extract the value of a WorkView attribute called Name, it would be
%MName.
The token strings can contain nested expressions. Example, a nested WorkView
attribute: %MVendor.Buyer.Name.
%R Displays the real user name (if configured) of the user who created the current
document. If a real user name is not configured, a blank space will be displayed.
%U Displays the user name of the currently logged in user who executed the task.
2012 Hyland Software, Inc.
954
OnBase 12 Workflow
Symbol Description
%V### Displays the value of a configured Workflow property. For example, to display the
value for the property Color, this symbol would be configured %VColor.
The following symbols are not supported in the Classic Client interface:
%L [life cycle ID]
%L2 [life cycle name]
%Q [queue ID]
%Q2 [queue name]
%M [item metadata value] is not supported in the Classic OnBase Client interface or the
Core-Based OnBase Client interface.
Testing Expressions
2012 Hyland Software, Inc.
955
Workflow OnBase 12
You can also test expressions within the Workflow Studio configuration. To test an expression,
click Test. The Test Expression dialog box is displayed.
Workflow Studio Actions
2012 Hyland Software, Inc.
956
OnBase 12 Workflow
Once the expression and variable(s) is configured properly, click Test to verify the expression.
A dialog box is displayed to show you the results of your test. The following is an example:
Document keyword
When you select Document keyword, you can select a Keyword Type that the value can be
used to set the property defined.
Select the Set property to all keyword value instances option to set the property to an array of
values for documents containing multiple values for a Keyword Type or system property. If the
check box is not selected and there are no Keyword Type or system property values for the
document then the property is deleted. If the document has multiple Keyword Type or system
property values then the property is set to the first Keyword Value.
For more information about these system properties, see the Document Properties topic in
the OnBase Client help system.
Target
In the Target drop-down select list, define whether you want the action to execute on the
current document/item in the queue or a related document/item.
If you are configuring the action for related documents/items, see Related Tab on page 1007
for more information.
Work item property
This option allows you to use a property from the current work item. The following properties
are available for selection: >>Assigned To, >>Content Type, >>Current Queue ID, >>Current Queue
Name, >>Entry to Queue Date, >>Item ID, >>Item Type ID, >>Owned By, and >>Priority.
2012 Hyland Software, Inc.
957
Workflow OnBase 12
The following are descriptions for the available work item properties:
>>Assigned To - The user the item is assigned to.
>>Content Type - A numeric value representing a content type (0 or 1 if the item is a
Document, 2 if it is a Folder, 3 for WorkView Item, 4 for a Medical Chart and 5 for an
Entity Items).
>>Current Queue ID - ID of current queue
Workflow Studio Actions
Current date/time
This option sets the property value to the current date/time.
Current user name
This option sets the property value to the user name of the currently logged in user. If you
want to use the configured real name for the user, select the Use real name option.
User group name(s) of current user
This option sets the property value to the user group(s) the currently logged in user. This
option is only supported in the OnBase Client Core-Based, Web Client, and Unity Workflow
interfaces.
Constant value
This option sets the property value to the constant value specified.
When the Parse tokens (%K, %D etc...) check box is selected, tokens can be entered into the
field and parsed into values.
Symbol Description
Note: This symbol is only applicable when used with an Institutional Database.
%C Displays the name of the user who created the current document.
%D1 Displays the date that the document was stored. This value cannot be changed.
%I1 or %T Displays the time that the document was stored. This value cannot be changed.
2012 Hyland Software, Inc.
958
OnBase 12 Workflow
Symbol Description
%K###.n Displays the Keyword Value of Keyword Type ### n times. For example, %K101.4
would display up to 4 unique Keyword Values for Keyword Type 101 for a single
document.
Note: When using the Classic Client interface, double digits in the Repeat field are
not supported.
%M Extracts metadata values from items. This includes attribute values from Workview
objects or a field values from an Entity item.
%M must be followed by the metadata value you want to extract. For example, if
you want to extract the value of a WorkView attribute called Name, it would be
%MName.
The token strings can contain nested expressions. Example, a nested WorkView
attribute: %MVendor.Buyer.Name.
%R Displays the real user name (if configured) of the user who created the current
document. If a real user name is not configured, a blank space will be displayed.
%U Displays the user name of the currently logged in user who executed the task.
2012 Hyland Software, Inc.
959
Workflow OnBase 12
Symbol Description
%V### Displays the value of a configured Workflow property. For example, to display the
value for the property Color, this symbol would be configured %VColor.
Note: If a property name has spaces, using %V to display the property value alone
will not preserve the spaces, and therefore, the property will not be correctly
identified. When %V is used with a property name containing space in conjunction
with a formatting code, the property will be identified. %C(VProperty Name) would
be an example of property with spaces that will be identified correctly with the first
letter capitalized. This formatting option are available for the following actions:
Prompt User with Question Box/SYS - Prompt User with Question Box, Create Note/
Doc - Create Note on This Document/Related Document, Display Message Box/
Notify - Display Message Box, and Custom Log Entry/SYS - Custom Log Entry.
The following symbols are not supported in the Classic Client interface:
%L [life cycle ID]
%L2 [life cycle name]
%Q [queue ID]
%Q2 [queue name]
%M [item metadata value] is not supported in the Classic OnBase Client interface or the
Core-Based OnBase Client interface.
From E-Form Field
This option allows the user to copy a value from the specified E-Form field.
From XML Path
This option allows the user to copy an XML value from a node to the specified property.
Enter the XPATH at which the node is located in the XPATH field. The XPATH is where the XML
node is located. This opens the text of the XML document, looks for the node, and copies the
value associated with the node to the specified property.
For this to execute successfully, the document must be an XML document, a rendition of an
XML document or an XDP document.
2012 Hyland Software, Inc.
960
OnBase 12 Workflow
When accessing complex or mixed nodes, the value of the node and its descendents will be
flattened into a single string value.
Note:This action can retrieve collections of nodes only if Set property to all nodes is set. If Set
property to all nodes is set, this action can retrieve the first value of a collection.
In order for XPath queries containing references to namespaces to be properly evaluated, the
following criteria must be met:
The document must be imported via the Document Connector.
The document must be associated with a valid XML Format.
All namespaces referenced in the XPath Query must be defined in the associated
XML Format.
System Category
Add Item to Other Life Cycle
You can specify a life cycle and queue to which you want to add the item.
Target
In the Target drop-down select list, define whether you want the action to execute on the
current document/item in the queue or a related document/item.
If you are configuring the action for related documents/items, see Related Tab on page 1007
for more information.
Select a Life Cycle from the drop-down select list. Select a queue from the Queue drop-down
select list.
2012 Hyland Software, Inc.
961
Workflow OnBase 12
The life cycle can also be specified by pulling the life cycle name from a property. If the life
cycle name or ID number will be pulled from a property:
1. Select the Get Life Cycle from this Property check box. The Life Cycle and Queue drop-
down select lists are disabled. The Get Queue from this Property check box is
automatically selected.
2. Enter the name of the property from which you want to pull the life cycle in the field
Workflow Studio Actions
under the Get Life Cycle from this Property check box.
3. If you do not want the item added to the initial queue of the life cycle, enter the name
of the property from which you want to pull the queue in the field under the Get Queue
from this Property check box. If this field is left blank, the life cycles initial queue will
be used.
In addition, you can select the Get Queue from this Property check box to specify a
property for the queue, while using a life cycle selected in the Life Cycle drop-down list.
You can select the Use Initial Queue if Property does not exist option if you want items to
be placed in the initial queue when a property does not exist.
Note: The Use Initial Queue, if property does not exist option is only supported in the Web Client
and Core-based OnBase Client interfaces.
Assign Ownership
Assigns ownership of the item to the specified user.
Target
In the Target drop-down select list, define whether you want the action to execute on the
current document/item in the queue or a related document/item.
If you are configuring the action for related documents/items, see Related Tab on page 1007
for more information.
If you want to assign ownership to the currently logged in user, select Current User.
When a queue other than <Current Queue> is selected from the Queue drop-down select list,
the Selected User option allows you to select a specific user that is assigned rights to the
selected queue.
When Current or Last Owner in Queue is selected, if the item is currently in the specified queue,
the action uses its current owner. If no user owns the item in the specified queue, ownership
is not set. If the item is not in the queue specified, the action uses the last user who owned
the item in the queue specified as the owner.
If you want to pull the user from a Keyword Type value, select Keyword and select the
Keyword Type that contains the value from the drop-down select list.
If you want to pull the user from a property value, select Property and enter the name of the
property that contains the value.
Assign to User
2012 Hyland Software, Inc.
962
OnBase 12 Workflow
Assigns a document to a user within a rule-based load balancing queue. The queue must be
configured for rules-based load balancing for this action to execute successfully.
If this action is configured in a life cycle that is associated with a org chart, the following
assignment types are available: Assistant of Logged In User, Assistant of User Specified in
Keyword Value, Assistant of User Specified in Property, Manager of Logged In User, Manager
of User Specified in Keyword Value, and Manager of User Specified in Property. When one of
The Assign in Life Cycle drop-down select list allows you to select the life cycle from which you
want to select a load balancing queue. The contents of the Load Balancing Queue drop-down
select list is determined by the Assign in Life Cycle selection.
The Load Balancing Queue drop-down select list contains the rule based load balancing queues
that you want to use for the user assignment.
Select <<Current Queue>> from the Load Balancing Queue drop-down select list to configure
the action for the specific queue that the document is in. Selecting <<Current Queue>> allows
this action to easily be copied for other queues within the configured life cycle, as the action
will always apply to the queue that the item is in. When <<Current Queue>> is selected, the
active life cycle must also be selected. If <ALL> is selected in the Assign in Life Cycle drop-
down select list, the active life cycle will automatically be selected for the action.
The Assignment Type drop-down select list allows you to select the type of assignment you
want to perform. The assignment type options are Assistant of Logged in User, Assistant of User
Specified in Keyword Value, Assistant of User Specified in Property, Current User, Default User, Get
User Name, Group or Role from Keyword, Get User Name, Group or Role from Property, In Order,
Manager of Logged in User, Manager of User Specified in Keyword Value, Manager of User Specified
in Property, Prompt for User, Group or Role, Selected User, Group or Role, and Shortest Queue.
Note: When using any of the following assignment types, when multiple values exist, all
values are used for document assignment: Assistant of User Specified in Keyword Value; Get
User Name, Group or Role from Keyword; and Manager of User Specified in Keyword Value.
The Assistant of Logged In User option specifies that documents should be assigned to all of
the assistants of the currently logged in user as defined by the Organization Chart. If the
currently logged in user does not have any assistants, the action will not be successful with
this setting.
The Assistant of User Specified in Keyword Value option allows you to specify a Keyword Type
from which to take the user to which the Assistant belongs. Select the appropriate Keyword
Type that you want to take the value from to determine the user from the Get User Name from
Keyword drop-down select list.
2012 Hyland Software, Inc.
963
Workflow OnBase 12
The Assistant of User Specified in Property option allows you to specify a property from which to
take the user to which the Assistant belongs. Enter the appropriate property name that you
want to take the value from to determine the user from the Get User name from Property field.
Optionally, you can specify a Required Role.
Note: In order for documents to be assigned to the Assistant of Logged In User, the Assistant
must be configured as a member of the queue. If this is configured and Assistants are not
Workflow Studio Actions
members of the queue, documents will be put into the <Unassigned> category. In order for
documents to be assigned to the Assistant of User Specified in Keyword Value or Assistant of
User Specified in Property, both the Assistant and the user specified in the Keyword value or
Property must be configured as a member of the queue. If this is configured and Assistants
and users are not members of the queue, documents will be put into the <Unassigned>
category.
The Current User option specifies that the documents should be assigned to the user currently
logged in and executing the task, assuming that the user has been assigned as a member of
the load balancing queue.
Note: If using this option in conjunction with a load-balanced queue, the option is only
available when the load-balanced queue has users as members.
The Default User option allows you to assign the document to the user specified as the Default
Recipient during membership configuration.
The In Order option will distribute documents in the order the user groups are listed in the
load balancing queue.
The Manager of Logged In User option specifies that the document should be assigned to the
manager of the currently logged in user, as specified in the Organizational Chart. Optionally,
you can specify a Required Role. When a Required Role is specified, it requires that the
manager that the document is assigned to has the specified role in the Organization Chart. If
the immediate manager is not assigned the selected role, Workflow will move up a managerial
tier until it finds a manager with the specified role. If a manager cannot be found with the
selected role, the document will be assigned the <Unassigned> status.
The Manager of User Specified in Keyword Value option allows you to specify a Keyword Type
from which to take the user to which the Manager belongs. Select the appropriate Keyword
Type that you want to take the value from to determine the user from the Get User Name from
Keyword drop-down select list. Optionally, you can specify a Required Role. When a Required
Role is specified, it requires that the manager that the document is assigned to is assigned to
the specified role in the Organization Chart. If the immediate manager is not assigned to the
selected role, Workflow will move up a managerial tier until it finds a manager with the
specified role. If a manager cannot be found with the selected role, the document will be
assigned the <Unassigned> status.
2012 Hyland Software, Inc.
964
OnBase 12 Workflow
The Manager of User Specified in Property option allows you to specify a property from which to
take the user to which the Manager belongs. Enter the appropriate property name that you
want to take the value from to determine the user from the Get User name from Property field.
Optionally, you can specify a Required Role. When a Required Role is specified, it requires that
the manager that the document is assigned to is assigned to the specified role in the
Organization Chart. If the immediate manager is not assigned to the selected role, Workflow
will move up a managerial tier until it finds a manager with the specified role. If a manager
Note: In order for documents to be assigned to the Manager of Logged In User, Manager of User
Specified in Keyword Value or Manager of User Specified in Property, the Manager must be
configured as a member of the queue. If this is configured and Managers are not members of
the queue, documents will be put into the <Unassigned> category.
The Prompt for User option will prompt the user to select the appropriate user group to assign
to documents. The user groups listed in the prompt are the user groups selected as members
of the load balancing queue.
Note: The Prompt for User option is not supported in the OnBase Mobile Access for BlackBerry
or Mobile Access for Windows Phone interfaces.
The Selected User option assigns the documents to the user selected in the Assigned User,
Group or Role drop-down select list.
The Shortest Queue option assigns documents to the user group that has the fewest number
of documents assigned to it.
Caution: When using the Assistant or Manager Assignment Type, never place these actions under
system work, timer work, load balancing work, or any other automatic function. If these types of
actions are placed into automation mode, the user logged in may not be the user that you would
want documents assignments based on.
The Assigned User, Group or Role drop-down select list is only enabled for the Selected User,
Group or Role assignment type. When Get User Name, Group or Role from Keyword is select a
Get User Name, Group or Role from Keyword field is displayed. Select the appropriate Keyword
Type from which to acquire the value. When Get User Name, Group or Role from Property is
selected, a Get User Name, Group or Role from Property field is displayed. Enter the name of the
property from which you want to acquire the value.
Note: The Assigned User, Group or Role drop-down select list is populated based on the user
group(s) assigned to load balancing queue selected in the Load Balancing Queue drop down
select list.
Note: When the selected queue is <<Current Queue>>, the available assignment types are
restricted to those that could apply to any queue in the life cycle, regardless of membership.
2012 Hyland Software, Inc.
965
Workflow OnBase 12
Break Processing
Stops the processing of a item in Workflow. The following break options are available:
Note: When the action is configured outside of System Work, none of the settings will impact
the execution of System Work.
Workflow Studio Actions
In this example, the Break action is set to break current task list. When the task list breaks at
the highlighted action, the tasks under the current actions parent task list that have not been
executed yet are not executed. Additionally, any actions that have not be executed under the
current actions grandparent task list are not executed. The remaining actions under the great
grandparent task are executed, however. The following graphic illustrates what is executed.
The pink actions are not executed. The green action is executed.
2012 Hyland Software, Inc.
966
OnBase 12 Workflow
When processing a primary document, this option breaks all processing for the current
document.
When processing a related document, this option breaks all processing for the current related
document and continues on with the next related document, if applicable.
Break All Processing for Top-Level Document
When processing a primary document, this option breaks all processing for the current
Break All Processing option Break All Processing for Current Document
selected
The call web service action allows a user to call a method exposed via a web service. The
action provides a wrapper around the .NET framework classes that handle calling methods in
web services.
Features of this Action
2012 Hyland Software, Inc.
967
Workflow OnBase 12
Supports complex data types including arrays of nested complex data types.
Retrieves the information about complex types from the WSDL.
Supports SOAP headers as inputs, outputs or by reference (input and output).
Retrieves the information about SOAP headers from the WSDL.
Allows the user to decide whether the task list execution should be broken if there
was an issue calling the web service.
Workflow Studio Actions
Supports multiple protocols: HTTP GET, HTTP POST, SOAP 1.1 and SOAP 1.2.
Supports mapping to system keywords.
Supports the following.NET primitive data types: System.Boolean, System.Byte,
System.Char, System.Decimal, System.Double, System.Int16, System.Int32,
System.Int64, System.SByte, System.Single, System.String. System.UInt16,
System.UInt32, System.UInt32
Has limited support for the System.Xml.XmlAttribute data type.
Supports mapping to constant values containing tokens.
Supports mapping to constant values containing arrays.
Allows the user to test that the application server can successfully call the web
service from the Configuration module.
Limitations of this Action
Does not support the Data Set data type.
Does not allow mapping to the InnerText or InnerXml properties of the
System.Xml.XmlAttribute data type. This limits the user to specifying a single value
for a SOAP header.
Does not support WSDLs split across several files.
Configuring this Action
To configure this action:
1. You can either select a configured WSDL location from the drop-down select list or,
with >> Use the specified WSDL Location selected in the drop-down select list, enter the
location of the WSDL file used by the Web Service in the field. The location value
cannot exceed 255 characters.
Note: Workflow Studio supports case-sensitivity when configuring a WSDL web service path.
This functionality is not respected in the Configuration module. Any web service that requires
case-sensitivity must be configured within Workflow Studio.
2. Click Retrieve.
3. If you do not want to store the WSDL within the action configuration, but want to
retrieve the WSDL the first time the action is executed, select the Retrieve WSDL at
execution time option.
4. Select the Protocol from the drop-down select list.
5. Select a method using the Method drop-down select list.
2012 Hyland Software, Inc.
968
OnBase 12 Workflow
2012 Hyland Software, Inc.
969
Workflow OnBase 12
7. Select a parameter. The None, Keyword, Property, and Constant Value mapping
properties are enabled. Keyword maps to the Keyword Type selected from the drop-
down select list. Property maps to the property specified in the field. Constant Value
maps to the value entered in the field.
Workflow Studio Actions
Symbol Description
2012 Hyland Software, Inc.
970
OnBase 12 Workflow
Symbol Description
Note: This symbol is only applicable when used with an Institutional Database.
%D1 Displays the date that the document was stored. This value cannot be changed.
%I1 or %T Displays the time that the document was stored. This value cannot be changed.
%K###.n Displays the Keyword Value of Keyword Type ### n times. For example, %K101.4
would display up to 4 unique Keyword Values for Keyword Type 101 for a single
document.
For some functionality, a Keyword Type drop-down list may be available to
configure this. Select a Keyword Type from the drop-down select list, enter the
number of times you want the Keyword Value to be displayed in the Repeat field,
and click Keyword. The value in the Repeat field specifies how many instances of
the Keyword Value will be displayed. Entering an * character will pull all existing
Keyword Values for display up to 99 instances.
Note: When using the Classic Client interface, double digits in the Repeat field are
not supported.
%M Extracts metadata values from items. This includes attribute values from Workview
objects or a field values from an Entity item.
%M must be followed by the metadata value you want to extract. For example, if
you want to extract the value of a WorkView attribute called Name, it would be
%MName.
The token strings can contain nested expressions. Example, a nested WorkView
attribute: %MVendor.Buyer.Name.
%R Displays the real user name (if configured) of the user who created the current
document. If a real user name is not configured, a blank space will be displayed.
%U Displays the user name of the currently logged in user who executed the task.
2012 Hyland Software, Inc.
971
Workflow OnBase 12
Symbol Description
%V### Displays the value of a configured Workflow property. For example, to display the
value for the property Color, this symbol would be configured %VColor.
Note: If a property name has spaces, using %V to display the property value alone
will not preserve the spaces, and therefore, the property will not be correctly
identified. When %V is used with a property name containing space in conjunction
with a formatting code, the property will be identified. %C(VProperty Name) would
be an example of property with spaces that will be identified correctly with the first
letter capitalized. This formatting option are available for the following actions:
Prompt User with Question Box/SYS - Prompt User with Question Box, Create Note/
Doc - Create Note on This Document/Related Document, Display Message Box/
Notify - Display Message Box, and Custom Log Entry/SYS - Custom Log Entry.
The following symbols are not supported in the Classic Client interface:
%L [life cycle ID]
%L2 [life cycle name]
%Q [queue ID]
%Q2 [queue name]
%M [item metadata value] is not supported in the Classic OnBase Client interface or the
Core-Based OnBase Client interface.
The value is an array (separated by commas) - This is only useful for items that are
arrays. It allows the user to specify a list of values (separated by commas) to
send.
9.Click Map.
10.Repeat steps 5 through 9 for each method and parameter.
11.Click OK.
Testing the Web Service
2012 Hyland Software, Inc.
972
OnBase 12 Workflow
You can test the displayed method by clicking Test. The Test Web Service Call dialog box is
displayed.
2012 Hyland Software, Inc.
973
Workflow OnBase 12
To test a method:
2. Enter a value in the field. If the value entered is an array separated by commas, select
the The value is an array (separated by commas) option.
3. Click Set.
4. Repeat steps 1 and 3 for each mapping.
5. Click Test. The Test Web Service Call Results dialog box is displayed, showing a list of
keywords and properties that are mapped to output or by reference parameters.
Return values for each area also shown.
Invoke method in a separate application Domain Setting
This check box controls whether the type built from the WSDL is loaded into a separate
application domain or into the same application domain the application server is using when
testing the method call.
Options Tab
When the Break processing on failure option is selected, if there is an issue calling the web
service, the action will stop executing the task list.
If this option is not selected, then the action will set the last execution result to S_FALSE and
continue executing the task list.
If the web service you are accessing uses cookies, you can select Allow Cookies. This will allow
the action to acquire the value of a cookie that was sent to the service from the client. The
option is only available when the protocol is set to use either http or https.
2012 Hyland Software, Inc.
974
OnBase 12 Workflow
The Request timeout [ ] seconds option allows for a time out duration to be set. If the response
from the web service has not been returned in the configured amount of time, the action will
time out. Enter the number of seconds you want to wait before the request times out. Tasks
following this action will either abort or continue, based on whether the option to Break
Processing on failure option has been selected.
Select the Use the following end point URL instead of the one in the WSDL option and specify the
Note:When retrieving the WSDL this information is only used if the WSDL is coming from a
URL. If the WSDL is a local file, this information is not used.
Available Protocols
When configuring the Call Web Service action in Workflow Studio, the protocols available are
defined in the wfstudio.exe.config in the following setting:
<system.web>
<webServices>
<protocols>
<add name="HttpGet"/>
<add name="HttpPost"/>
</protocols>
</webServices>
</system.web>
In order for protocols to be available in this action, they must be added to this xml setting.
2012 Hyland Software, Inc.
975
Workflow OnBase 12
Note:This action is not supported for the Classic OnBase Client User Interface.
This action allows you to create a Collaboration Workspace based on a selected Collaboration
Workflow Studio Actions
Template. Select the template that you want to base your Workspace on from the
Collaboration Template drop-down select list. Select the settings that you want to inherit from
the template in the Inherit Template Settings section.
Notification Options - Corresponds to the Options section of the Collaboration Template Settings
dialog box.
Users - Corresponds to the users assigned in the Collaboration Template Default Users dialog
box.
Document Rights - Corresponds to the Document Rights section of the Collaboration Rights
dialog box.
Workview Rights - Corresponds to the Workview Rights section of the Collaboration Rights
dialog box.
Thread Rights - Corresponds to the Thread Rights section of the Collaboration Rights dialog box.
Meeting Rights - Corresponds to the Meeting Rights section of the Collaboration Rights dialog
box when the database is configured for Synchronous Collaboration.
Administration Rights - Corresponds to the Workspace Rights section of the Collaboration Rights
dialog box.
You can also add the current document within Workflow to the Collaboration Workspace by
selecting the Add document to workspace option.
Note: The Add document to workspace option is only supported for documents. This option is
not supported for non-document items such as Workview objects or Plan Review projects.
Allows log text to be recorded in the wftransactionlog and wftransactionmsg tables. All of the
Action Field values are written to the wfmessage field in the wftransactionmsg table.
The following values can be automatically pulled into the logged text: Document Date, User,
Document Name, Time Stored, Keyword. Use the corresponding buttons and drop-down
select list to configure the Log Text appropriately.
Additional Symbols
Symbol Description
2012 Hyland Software, Inc.
976
OnBase 12 Workflow
Symbol Description
Note: This symbol is only applicable when used with an Institutional Database.
%D1 Displays the date that the document was stored. This value cannot be changed.
%I1 or %T Displays the time that the document was stored. This value cannot be changed.
%K###.n Displays the Keyword Value of Keyword Type ### n times. For example, %K101.4
would display up to 4 unique Keyword Values for Keyword Type 101 for a single
document.
For some functionality, a Keyword Type drop-down list may be available to
configure this. Select a Keyword Type from the drop-down select list, enter the
number of times you want the Keyword Value to be displayed in the Repeat field,
and click Keyword. The value in the Repeat field specifies how many instances of
the Keyword Value will be displayed. Entering an * character will pull all existing
Keyword Values for display up to 99 instances.
Note: When using the Classic Client interface, double digits in the Repeat field are
not supported.
%M Extracts metadata values from items. This includes attribute values from Workview
objects or a field values from an Entity item.
%M must be followed by the metadata value you want to extract. For example, if
you want to extract the value of a WorkView attribute called Name, it would be
%MName.
The token strings can contain nested expressions. Example, a nested WorkView
attribute: %MVendor.Buyer.Name.
%R Displays the real user name (if configured) of the user who created the current
document. If a real user name is not configured, a blank space will be displayed.
%U Displays the user name of the currently logged in user who executed the task.
2012 Hyland Software, Inc.
977
Workflow OnBase 12
Symbol Description
%V### Displays the value of a configured Workflow property. For example, to display the
value for the property Color, this symbol would be configured %VColor.
Note: If a property name has spaces, using %V to display the property value alone
will not preserve the spaces, and therefore, the property will not be correctly
identified. When %V is used with a property name containing space in conjunction
with a formatting code, the property will be identified. %C(VProperty Name) would
be an example of property with spaces that will be identified correctly with the first
letter capitalized. This formatting option are available for the following actions:
Prompt User with Question Box/SYS - Prompt User with Question Box, Create Note/
Doc - Create Note on This Document/Related Document, Display Message Box/
Notify - Display Message Box, and Custom Log Entry/SYS - Custom Log Entry.
The following symbols are not supported in the Classic Client interface:
%L [life cycle ID]
%L2 [life cycle name]
%Q [queue ID]
%Q2 [queue name]
%M [item metadata value] is not supported in the Classic OnBase Client interface or the
Core-Based OnBase Client interface.
Note:This action is not supported in the OnBase Mobile Access for BlackBerry or Mobile Access
for Windows Phone interfaces.
Displays an HTML form that allows the user to alter the keywords or Workflow properties of an
item.
Target
In the Target drop-down select list, define whether you want the action to execute on the
current document/item in the queue or a related document/item.
If you are configuring the action for related documents/items, see Related Tab on page 1007
for more information.
Form
If a user form has been created for the life cycle, you can select it from the Form drop-down
list. Global user forms and forms assigned to the life cycle in which the action is being
configured are available for selection.
2012 Hyland Software, Inc.
978
OnBase 12 Workflow
You may also choose Auto-Generate, specify the Instructions and up to three Keyword Types to
display on your form. Workflow properties cannot be selected for an auto-generated form.
User forms display in the User Interaction screen when the action is performed.
Note:If the document this action is performed on has multiple related documents/items and
the cancel button for the form is clicked at any point, processing will break and the form will
not be displayed for additional related documents/items.
Additionally, you can create a new form or edit an existing form by selecting the drop-down
button next to the Form field. The Properties dialog box is displayed when you select either
option. Enter the Name of the form and enter the path to the form in the Location field.
If you perform this action from an e-mail notification in the Integration for Microsoft Outlook
2007 or Integration for Microsoft Outlook 2010 and click the cancel button, the e-mail
notification is still modified to indicate that the ad hoc task that was successfully executed.
Task list execution does not continue.
Allow Form To Dynamically Add Keyword Fields
If a form is configured to dynamically add form fields to the form, this option controls how
dynamically created keyword mapped fields affect the primary item.
When this option is selected, values entered in keyword fields that were dynamically added to
the form update the corresponding keyword on the primary item.
When this option is not selected, values entered in keyword fields that were dynamically
added to the form are not updated on the primary item.
2012 Hyland Software, Inc.
979
Workflow OnBase 12
Note: This action is not supported in the OnBase Mobile Access for BlackBerry or Mobile
Access for Windows Phone interfaces.
Displays a customizable message box. This action allows you to enter a message to display in
the User Interaction screen. Enter the text to display in the Action Fields box under the Action
Workflow Studio Actions
Space-Space Adds a space, a hyphen, and another space to separate the different symbols ( - )
Doc Date Adds the document date of the current document (%D)
User Adds the user logged into the Client processing the action.(%U)
Time Stored Adds the time the current document was stored into OnBase (%I1)
Date Stored Adds the date the current document was stored into OnBase (%D1)
Keyword Adds the value of the Keyword Type and Keyword Number (%K) of the selected
Keyword Type in the Keyword Type drop-down select list. Enter the number of
times the Keyword Value will repeat in the message in the Repeat field. This
number is based on the number of Keyword Type instances on documents.
Additional Symbols
The following symbols can be used:
Symbol Description
Note: This symbol is only applicable when used with an Institutional Database.
%C Displays the name of the user who created the current document.
%D1 Displays the date that the document was stored. This value cannot be changed.
%I1 or %T Displays the time that the document was stored. This value cannot be changed.
2012 Hyland Software, Inc.
980
OnBase 12 Workflow
Symbol Description
%K###.n Displays the Keyword Value of Keyword Type ### n times. For example, %K101.4
would display up to 4 unique Keyword Values for Keyword Type 101 for a single
document.
For some functionality, a Keyword Type drop-down list may be available to
Note: When using the Classic Client interface, double digits in the Repeat field are
not supported.
%M Extracts metadata values from items. This includes attribute values from Workview
objects or a field values from an Entity item.
%M must be followed by the metadata value you want to extract. For example, if
you want to extract the value of a WorkView attribute called Name, it would be
%MName.
The token strings can contain nested expressions. Example, a nested WorkView
attribute: %MVendor.Buyer.Name.
%R Displays the real user name (if configured) of the user who created the current
document. If a real user name is not configured, a blank space will be displayed.
%U Displays the user name of the currently logged in user who executed the task.
2012 Hyland Software, Inc.
981
Workflow OnBase 12
Symbol Description
%V### Displays the value of a configured Workflow property. For example, to display the
value for the property Color, this symbol would be configured %VColor.
Note: If a property name has spaces, using %V to display the property value alone
will not preserve the spaces, and therefore, the property will not be correctly
identified. When %V is used with a property name containing space in conjunction
with a formatting code, the property will be identified. %C(VProperty Name) would
be an example of property with spaces that will be identified correctly with the first
letter capitalized. This formatting option are available for the following actions:
Prompt User with Question Box/SYS - Prompt User with Question Box, Create Note/
Doc - Create Note on This Document/Related Document, Display Message Box/
Notify - Display Message Box, and Custom Log Entry/SYS - Custom Log Entry.
The following symbols are not supported in the Classic Client interface:
%L [life cycle ID]
%L2 [life cycle name]
%Q [queue ID]
%Q2 [queue name]
%M [item metadata value] is not supported in the Classic OnBase Client interface or the
Core-Based OnBase Client interface.
Display URL
Note: This action is not supported for the Classic Client or OnBase Mobile interfaces.
This action will automatically open a web browser, such as Internet Explorer, and navigate to
the configured URL. The action optionally allows for parameters to be appended to the end of
the URL for more specific results. The values of the parameters can be taken from a keyword
value, a property value, or a constant value. When more than one value of the configured
keyword or property exists, only the first value will be used as the parameter value. Multiple
parameters can also be configured for the same URL. If parameters are configured, the action
will append ? to the end of the URL and then format the parameters as follows:
parameter1=value1¶meter2=value2. For example, if the configured URL is http://
server/default.aspx, and the configured parameters are named parameter1 and
parameter2, the web browser will open to the following URL: http://server/
default.aspx?parameter1=value1¶meter2=value2
Enter the URL you would like the action to open. When configuring the action, a valid
communications protocol such as HTTP:// or HTTPS:// should be placed at the beginning of
the URL.
Optionally, you can set parameters to append to the URL for more specific results.
2012 Hyland Software, Inc.
982
OnBase 12 Workflow
To configure a parameter.
Calls a function in a user-defined DLL. This function takes the action number, the document
handle (internal document number) and the Document Type number as parameters. The
function must have the following format: int (CALLBACK* DLLEXITPROC)(long nActionNum, long
nDocumentHandle, long nDocumentTypeNum)
Specify the name of the DLL in the DLL Name field. The corresponding name of the function
being called goes in the Function Name field. Click Save.
The action enables/disables writing to the Workflow trace. Select Enable to use the action to
enable the trace. Select Disable to use the action to disable the trace. This action can be used
to enable Workflow Trace for the entire execution of an ad hoc task, a specific section of the
logic execution or enabled and disabled with separate ad hoc tasks.
Note: If the user is using the OnBase Client Core-based Workflow interface or the Unity
Workflow interface and has turned on tracing via the toolbar, messages are written to the
Workflow Trace regardless of whether the action is set to disable the trace
Note: When using the Workflow Timer Service messages are written to the Workflow Trace
regardless of whether the action is set to disable the trace.
Execute Program
2012 Hyland Software, Inc.
983
Workflow OnBase 12
Note:When executing this action in the Workflow Core-based interfaces, this action should not
be used if the program being executed by the action requires a User Interface
Note:This action is currently not supported in the Web Client or Java Client interfaces.
Workflow Studio Actions
Calls the application at the path specified in the command line. In the Command Line field,
enter the full path to a program executable. Click Save. The specified program launches.
This action supports the use of %U in the command line. %U will be translated to the user
name of the currently logged in user and will be applied along with the command line.
For example, if the action calls C:\k1\program.exe %U 35 and the user JANE BROWN
performs the actions, the command C:\d1\program.exe JANE BROWN 35 will be run.
Purge Cache
Deletes all documents in a local server cache. A cache location must be specified before this
action type is configured. Select the name of the cache from the Cache drop-down select list.
Specify the percentage at which you want OnBase to begin purging files in the High Water
Mark field. Enter the percentage at which OnBase should stop purging files in the Low Water
Mark field. Files are purged from oldest to newest.
Note:The high and low watermark settings configured for this action type override the original
settings established when the cache was created.
Rebalance Item
Executes load balancing for the selected item(s). This is the same functionality that is
executed when an item enters a load balancing queue. This action can be configured to
rebalance the selected items in any queue that is configured with load balancing.
Note:When the rebalance function is initiated, existing assignments are cleared and new
assignments are made based on the load-balancing queues configuration.
2012 Hyland Software, Inc.
984
OnBase 12 Workflow
You can use the Life Cycle drop-down select list to narrow the queues listed in the Load
Balancing Queue drop-down select list. The Load Balancing Queue drop-down select list will list
all queues configured for load balancing for the life cycle selected in the Life Cycle drop-down
select list. The action will be executed on the selected item(s) within the queue that is
selected from the Load Balancing Queue drop-down select list.
Workflow is designed to automatically refresh the display when a document transitions out of
the queue. This action refreshes the Workflow display when actions have changed the
document, but the document still exists in the same queue. This action is useful for updating
the Auto-Name string of the document after all other tasks have been executed.
This action removes the current item from all life cycles. The item still exists in OnBase and is
still available through normal retrieval, but no longer exists in any life cycle.
All Workflow processing halts when the Break All Processing box is checked.
Select the Remove All User Assignments option if you want all load balancing user assignments
removed from the item upon its exit from the life cycle using this action.
Caution: When using a core-based interface, items in Document Maintenance that this action is
executed upon will not be removed from the life cycle.
2012 Hyland Software, Inc.
985
Workflow OnBase 12
Select the Remove All User Assignments option if you want all load balancing user assignments
removed from the item upon its exit from the life cycle using this action.
Caution: When using a core-based interface, items in Document Maintenance that this action is
executed upon will not be removed from the life cycle.
Workflow Studio Actions
Remove Ownership
Removes ownership from an item.
Target
In the Target drop-down select list, define whether you want the action to execute on the
current document/item in the queue or a related document/item.
If you are configuring the action for related documents/items, see Related Tab on page 1007
for more information.
From the Assigned in Life Cycle drop-down select list, select the life cycle in which the item to
remove ownership from resides.
From the Queue drop-down select list, select the queue the item to remove ownership from
resides. When <Current Queue> is selected, the action will execute on an item in the selected
life cycle, regardless of the queue it is in. If the user selects a specific queue, it will only
execute on the item when it is contained within that selected queue.
Removes all user assignments for the selected document from the rule-based load balancing
queue selected in the Load Balancing Queue drop-down list for the life cycle selected in the
Assign in Life Cycle drop-down list.
Select <<Current Queue>> from the Load Balancing Queue drop-down select list to configure
the action for the specific queue that the document is in. Selecting <<Current Queue>> allows
this action to easily be copied for other queues within the configured life cycle, as the action
will always apply to the queue that the item is in. When <<Current Queue>> is selected, the
active life cycle must also be selected. If <ALL> is selected in the Assign in Life Cycle drop-
down select list, the active life cycle will automatically be selected for the action.
The Assignment Type drop-down select list allows you to select the type of assignment you
want to perform. The assignment type options are Assistant of Logged in User, Assistant of User
Specified in Keyword Value, Assistant of User Specified in Property, Current User, Default User, Get
User Name, Group or Role from Keyword, Get User Name, Group or Role from Property, In Order,
Manager of Logged in User, Manager of User Specified in Keyword Value, Manager of User Specified
in Property, Prompt for User, Group or Role, Selected User, Group or Role, and Shortest Queue.
Note: When using any of the following assignment types, when multiple values exist, all
values are used for document assignment: Assistant of User Specified in Keyword Value; Get
User Name, Group or Role from Keyword; and Manager of User Specified in Keyword Value.
2012 Hyland Software, Inc.
986
OnBase 12 Workflow
The Assistant of Logged In User option specifies that documents should be assigned to all of
the assistants of the currently logged in user as defined by the Organization Chart. If the
currently logged in user does not have any assistants, the action will not be successful with
this setting.
The Assistant of User Specified in Keyword Value option allows you to specify a Keyword Type
from which to take the user to which the Assistant belongs. Select the appropriate Keyword
Note: In order for documents to be assigned to the Assistant of Logged In User, the Assistant
must be configured as a member of the queue. If this is configured and Assistants are not
members of the queue, documents will be put into the <Unassigned> category. In order for
documents to be assigned to the Assistant of User Specified in Keyword Value or Assistant of
User Specified in Property, both the Assistant and the user specified in the Keyword value or
Property must be configured as a member of the queue. If this is configured and Assistants
and users are not members of the queue, documents will be put into the <Unassigned>
category.
The Current User option specifies that the documents should be assigned to the user currently
logged in and executing the task, assuming that the user has been assigned as a member of
the load balancing queue.
Note: If using this option in conjunction with a load-balanced queue, the option is only
available when the load-balanced queue has users as members.
The Default User option allows you to assign the document to the user specified as the Default
Recipient during membership configuration.
The In Order option will distribute documents in the order the user groups are listed in the
load balancing queue.
The Manager of Logged In User option specifies that the document should be assigned to the
manager of the currently logged in user, as specified in the Organizational Chart. Optionally,
you can specify a Required Role. When a Required Role is specified, it requires that the
manager that the document is assigned to has the specified role in the Organization Chart. If
the immediate manager is not assigned the selected role, Workflow will move up a managerial
tier until it finds a manager with the specified role. If a manager cannot be found with the
selected role, the document will be assigned the <Unassigned> status.
The Manager of User Specified in Keyword Value option allows you to specify a Keyword Type
from which to take the user to which the Manager belongs. Select the appropriate Keyword
Type that you want to take the value from to determine the user from the Get User Name from
Keyword drop-down select list. Optionally, you can specify a Required Role. When a Required
Role is specified, it requires that the manager that the document is assigned to is assigned to
the specified role in the Organization Chart. If the immediate manager is not assigned to the
selected role, Workflow will move up a managerial tier until it finds a manager with the
specified role. If a manager cannot be found with the selected role, the document will be
assigned the <Unassigned> status.
2012 Hyland Software, Inc.
987
Workflow OnBase 12
The Manager of User Specified in Property option allows you to specify a property from which to
take the user to which the Manager belongs. Enter the appropriate property name that you
want to take the value from to determine the user from the Get User name from Property field.
Optionally, you can specify a Required Role. When a Required Role is specified, it requires that
the manager that the document is assigned to is assigned to the specified role in the
Organization Chart. If the immediate manager is not assigned to the selected role, Workflow
will move up a managerial tier until it finds a manager with the specified role. If a manager
Workflow Studio Actions
cannot be found with the selected role, the document will be assigned the <Unassigned>
status.
Note: In order for documents to be assigned to the Manager of Logged In User, Manager of User
Specified in Keyword Value or Manager of User Specified in Property, the Manager must be
configured as a member of the queue. If this is configured and Managers are not members of
the queue, documents will be put into the <Unassigned> category.
The Prompt for User option will prompt the user to select the appropriate user group to assign
to documents. The user groups listed in the prompt are the user groups selected as members
of the load balancing queue.
Note: The Prompt for User option is not supported in the OnBase Mobile Access for BlackBerry
or Mobile Access for Windows Phone interfaces.
The Selected User option assigns the documents to the user selected in the Assigned User,
Group or Role drop-down select list.
The Shortest Queue option assigns documents to the user group that has the fewest number
of documents assigned to it.
Caution: When using the Assistant or Manager Assignment Type, never place these actions under
system work, timer work, load balancing work, or any other automatic function. If these types of
actions are placed into automation mode, the user logged in may not be the user that you would
want documents assignments based on.
The Assigned User, Group or Role drop-down select list is only enabled for the Selected User,
Group or Role assignment type. When Get User Name, Group or Role from Keyword is select a
Get User Name, Group or Role from Keyword field is displayed. Select the appropriate Keyword
Type from which to acquire the value. When Get User Name, Group or Role from Property is
selected, a Get User Name, Group or Role from Property field is displayed. Enter the name of the
property from which you want to acquire the value.
Note: The Assigned User, Group or Role drop-down select list is populated based on the user
group(s) assigned to load balancing queue selected in the Load Balancing Queue drop down
select list.
2012 Hyland Software, Inc.
988
OnBase 12 Workflow
Target
In the Target drop-down select list, define whether you want the action to execute on the
current document/item in the queue or a related document/item.
If you are configuring the action for related documents/items, see Related Tab on page 1007
for more information.
Additionally, you can create a new script or edit an existing script by selecting the drop-down
button next to the Script field. See Unity Projects on page 842 for more information.
This action can be used to accomplish many tasks and the available configuration settings
change depending on the type of protocol used (http(s)/ftp/file) and the method (e.g. HTTP
GET/POST or FTP upload/download).
The list of the actions functionality is:
File protocol
Import a file from the local file system into OnBase
Set the value of a property from a file in the local file system
Export the current document to a file in the local file system
Export the value of a property to a file in the local file system
Export some specific text to a file in the local file system
FTP protocol
Import a file from an FTP server into OnBase
Set the value of a property from a file on the FTP server
Export the current document to a file on the FTP server
Export the value of a property to a file on the FTP server
Export some specific text to a file on the FTP server
2012 Hyland Software, Inc.
989
Workflow OnBase 12
HTTP/HTTPS protocol
Import the response of an HTTP GET/POST into OnBase
Set the value of a property from the response of an HTTP GET/POST
Send the current document as the request body of an HTTP POST
Send the value of a property as the request body of an HTTP POST
Send some specific text as the request body of an HTTP POST
Workflow Studio Actions
Send specific HTTP headers with the request mapped to keywords, properties or
constant values
Receive specific HTTP headers from the response mapped to keywords or properties
1. Select a Protocol and Method from the drop-down select lists. See Protocols on page
996 for more information.
2. Enter a URI into the Use the following URI field or supply the property from which you
will pull the URI in the Use the URI in the following property field.
3. Configure Request Settings, Response Settings, the Options tab, the Proxy tab, and the
Authentication tab as appropriate.
Request Settings
The Request Settings dialog box is accessed by clicking the Configure button for the Request
Settings section.
2012 Hyland Software, Inc.
990
OnBase 12 Workflow
Symbol Description
Note: This symbol is only applicable when used with an Institutional Database.
%C Displays the name of the user who created the current document.
%D1 Displays the date that the document was stored. This value cannot be changed.
%I1 or %T Displays the time that the document was stored. This value cannot be changed.
%K###.n Displays the Keyword Value of Keyword Type ### n times. For example, %K101.4
would display up to 4 unique Keyword Values for Keyword Type 101 for a single
document.
For some functionality, a Keyword Type drop-down list may be available to
configure this. Select a Keyword Type from the drop-down select list, enter the
number of times you want the Keyword Value to be displayed in the Repeat field,
and click Keyword. The value in the Repeat field specifies how many instances of
the Keyword Value will be displayed. Entering an * character will pull all existing
Keyword Values for display up to 99 instances.
Note: When using the Classic Client interface, double digits in the Repeat field are
not supported.
%M Extracts metadata values from items. This includes attribute values from Workview
objects or a field values from an Entity item.
%M must be followed by the metadata value you want to extract. For example, if
you want to extract the value of a WorkView attribute called Name, it would be
%MName.
The token strings can contain nested expressions. Example, a nested WorkView
attribute: %MVendor.Buyer.Name.
2012 Hyland Software, Inc.
991
Workflow OnBase 12
Symbol Description
%R Displays the real user name (if configured) of the user who created the current
document. If a real user name is not configured, a blank space will be displayed.
%U Displays the user name of the currently logged in user who executed the task.
%V### Displays the value of a configured Workflow property. For example, to display the
value for the property Color, this symbol would be configured %VColor.
Note: If a property name has spaces, using %V to display the property value alone
will not preserve the spaces, and therefore, the property will not be correctly
identified. When %V is used with a property name containing space in conjunction
with a formatting code, the property will be identified. %C(VProperty Name) would
be an example of property with spaces that will be identified correctly with the first
letter capitalized. This formatting option are available for the following actions:
Prompt User with Question Box/SYS - Prompt User with Question Box, Create Note/
Doc - Create Note on This Document/Related Document, Display Message Box/
Notify - Display Message Box, and Custom Log Entry/SYS - Custom Log Entry.
The following symbols are not supported in the Classic Client interface:
%L [life cycle ID]
%L2 [life cycle name]
%Q [queue ID]
%Q2 [queue name]
%M [item metadata value] is not supported in the Classic OnBase Client interface or the
Core-Based OnBase Client interface.
Headers
2012 Hyland Software, Inc.
992
OnBase 12 Workflow
When using HTTP and HTTPS protocols, headers can be configured. A Headers button is
available. Upon clicking the Headers button, the Headers dialog box is displayed.
2012 Hyland Software, Inc.
993
Workflow OnBase 12
The Response Settings dialog box is accessed by clicking the Configure button for the Response
Settings section.
Workflow Studio Actions
2012 Hyland Software, Inc.
994
OnBase 12 Workflow
This option is enabled when the action is configured so that the HTTP response is archived as
a new document. When this option is selected, keyword values are applied to the new
document created, not the primary document upon which the action is executing.
Headers
When using HTTP and HTTPS protocols, headers can be configured. A Headers button is
available. Upon clicking the Headers button, the Headers dialog box is displayed.
2012 Hyland Software, Inc.
995
Workflow OnBase 12
Proxy Tab
The Proxy tab allows the user to have the action Use the default proxy settings or they can
specify a particular proxy server using the Use the following proxy server option.
Authentication Tab
The Authentication tab allows the user to configure what the user name/password should be
used for the request, if applicable.
No authentication
The action will not use any user name/password with HTTP requests. Any FTP request will use
the default anonymous user.
Use the current users credentials
The action will use the credentials the Application Server is running under.
Use the following credentials
This option allows the user to specify a particular user name and password that should be
used.
Note:The file protocol does not support the authentication settings; therefore, if you are
importing/exporting using the file protocol, the location must be accessible by the process
running the Application Server.
Protocols
File Protocol
The file protocol has two available methods: Import and Export.
Note: The file protocol does not support the actions authentication and proxy settings.
Import Method: The import method allows the action to either set the value of a Workflow
property to the contents of the specific file, or import the file as a new document in OnBase.
The Response Settings dialog allows the user to configure this.
Export Method: The export method allows the action to create a file on the Application Server.
When the user selects the export method they are able to specify the Request Settings.
FTP Protocol
The action connects to an FTP server using this protocol. The ftp protocol has two available
methods: Download and Upload
Note: The FTP protocol does not support the actions proxy settings.
Download Method: The download method allows the action to either set the value of a
Workflow property to the contents of the specific file, or import the file as a new document in
OnBase. The Response Settings dialog allows the user to configure this.
2012 Hyland Software, Inc.
996
OnBase 12 Workflow
Upload Method: The upload method allows the action to create a file on the Application Server.
When the user selects the upload method they are able to specify the Request Settings.
HTTP Protocol
The http protocol has the following methods:
GET: Requests a representation of the specified resource (at the URI). The GET method is
typically used to request a web page. It can also be used to call a web service.
Send Notification
Sends specified internal or external notification to the users specified in the notification setup.
You can select an Attachment to send with the notification. The following options are
available:
None
Allows you to send a notification without an attachment.
This Document
Sends current document along with specified notification to the users specified in the
notification setup. Any overlays or notes present on the document will be included in the
attachment.
Related Documents
Sends the selected notification with a document related to the current document as an
attachment. See Related Tab on page 1007 for more information
Batch
Attaches documents that exist in the selected Folder Type to notifications that are sent using
this action.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
If the Include current document option is selected, the current document active in the life cycle
will be attached to the notification in addition to the documents within the selected folder.
Static folders are not available for selection.
Non-document items cannot be sent as attachments to a notification.
Notification
2012 Hyland Software, Inc.
997
Workflow OnBase 12
After a notification has been added and configured, you can select it from the Notification
drop-down select list.
Note: Only notifications that are specific to the life cycle for which the action is being
configured and notifications that are not assigned to a specific life cycle are available for
selection.
Workflow Studio Actions
Note: If you are using any Core-based interface, the Hyland Distribution Service is required
for sending notifications in Workflow. If you are using the Classic Client interface, the Hyland
Distribution Service is required to support any of the Sender Address options.
Caution: If you are using IDSMail to send multiple messages at once and one of the messages is
sent to an invalid address, all messages will be ignored and not sent. If you are using MAPI
(dmmailservice.dll) to send multiple messages at once and one of the messages is sent to an
invalid address, only the message sent to an invalid address will not be sent. All other messages
will be sent.
Additionally, you can create a new notification or edit an existing notification by selecting the
drop-down menu next to the Notification field. See Notifications on page 821 for more
information.
2012 Hyland Software, Inc.
998
OnBase 12 Workflow
This field allows you to specify a priority value to assign. This priority value can be used for
sorting in the inbox and for load balancing queue assignments. Priority rank is dependent on
sorting and load balancing configurations. Numbers 1 to 999 are valid values. There are three
options to set the priority value:
You can specify a Specific Value for the priority value.
You can specify a Property that will define the priority value.
Note: The Property and Keyword options are not supported in the Classic Client interface.
Target
In the Target drop-down select list, define whether you want the action to execute on the
current document/item in the queue or a related document/item.
If you are configuring the action for related documents/items, see Related Tab on page 1007
for more information.
Transition Item
Moves an item from its current queue to another queue.
Target
In the Target drop-down select list, define whether you want the action to execute on the
current document/item in the queue or a related document/item.
If you are configuring the action for related documents/items, see Related Tab on page 1007
for more information.
The source and the destination queues are specified in the configuration. (If desired, the To
Queue and From Queue select list can be filtered by Life Cycle.) To transition items to the
destination queue from multiple queues, the source queue can be specified as <Current
Queue> allowing the same action to be used in multiple places. Both queues in a transition
must exist in the same life cycle.
2012 Hyland Software, Inc.
999
Workflow OnBase 12
The core-based interfaces also support transitioning an item based on properties. The source
and/or destination queues are found based on the configured property value. To configure a
source queue based on property value, select the Get From Queue from Property: check box
and enter the name or number of the desired Workflow property in the data entry field. The
From Queue drop-down select list will be disabled and not applicable as soon as this check box
is selected. To configure a destination queue based on property value, select the Get To Queue
from Property: check box and enter the name or ID number of the desired Workflow queue in
Workflow Studio Actions
the data entry field. The To Queue drop-down select list will be disabled and not applicable as
soon as this check box is selected. Both queues in a transition must exist in the same life
cycle. The item will not be transitioned if the configured properties are not set on the item.
Note:When Get To Queue from Property: is selected, a specific life cycle must also be selected
in the Life Cycle drop-down select list. The <ALL> option for life cycles will not function when a
property is configured as a destination queue, because multiple queues across life cycles
could have the same property.
If you want to remove the user assignment of the item that will be transitioned, select the
Remove All User Assignments option.
WorkView Category
Add to Display Message
This particular rule has application only when configuring system tasks for the class events
OnBeforeSaveObject and OnBeforeDeleteObject. This action adds the configured information
to the message displayed using the OnBeforeSaveObject or OnBeforeDeleteObject events.
You can use this action to create messages that provide meaningful information concerning
invalid data entered into an object. When this actions is executed, the message is displayed
and the object is not saved or deleted.
Select the Application and Class of the WorkView item being checked from the drop-down
select lists. This information will be used as the context for any macros used in the text
template, and by the Insert button.
Type the text you would like to be displayed into the Text to Append text box. If you need to
insert data from the current object into the template, click the Insert button and navigate the
menu to select from attribute values and system data. The appropriate macro/placeholder will
be inserted. At runtime this will be replaced by the desired data.
It is also possible to create complex templates that execute queries and iterate over the
results. See the Data Value Insertion Tags and Iterative Tags sections in the WorkView MRG or
WorkView Configuration help files for more information.
Select the Clear message text first check box if you want this to be the first or only message to
be displayed. The affects of this action are cumulative over the entire task execution, so it is
possible to build a long list of messages. Checking this box resets any previously set
messages and starts with an empty list.
2012 Hyland Software, Inc.
1000
OnBase 12 Workflow
Example:
You want to validate an object being saved to make sure one or more fields are filled in and
not blank. In addition, the objects follow-up date attribute must be at least 7 days greater
than the day this object was created. To accomplish this, you would create a system task that
will be tied to the class OnBeforeSaveObject event hook using the WorkView Configuration
Tool. System task and event association is configured in the WorkView Configuration tool.
Note: If an attribute is configured to be Unique or have a default value that uses a sequence
with WorkView Configuration, the attribute's value is not copied.
Selecting the Copy all attached documents from current object option will auto-attach the
statically linked document(s) from the current working object to the newly created object.
You can specify specific values for attributes. To configure specific values:
2012 Hyland Software, Inc.
1001
Workflow OnBase 12
Creates an association between two objects, resulting in a new object created in the specified
class. In order for a new object to be created, two objects must have relationship attributes
that relate to one another and those relationship attributes must be specified as object
assignments.
Select the Application and Association Class of the object that represents the association
between two objects that will be created.
In the First Object Assignment section, identify the first associated object by clicking the
Relationship Attribute ellipsis (...) button and selecting the appropriate relationship attribute.
Select the source of the related object. Select Current Item if the current Workflow work item
is the source of this relationship attribute. Optionally, you may specify that the object's ID is
contained in a named property. Select Get Object ID from Property and enter the property
name that will hold the object ID.
In the Second Object Assignment section, identify the object that should be associated to the
object specified in the First Object Assignment section. Click the Relationship Attribute ellipsis
(...) button and select the appropriate relationship attribute. Select Current Item if the current
Workflow work item is the source of this side of the relationship. Optionally, you may specify
that the object's ID is contained in a named property. Select Get Object ID from Property and
enter the property name that will hold the object ID.
Note: The relationship attribute identified in the first and second object assignments must be
different. In addition, only one object assignment can be configured to use the Current Item
option at one time. Both the first and the second object assignments can use the Current Item
option.
If you want to store the new objects ID in a property, enter the name of the property in the
Save new object ID in property: field.
Delete Object
Deletes a WorkView object. You can configure the action to delete the current item or you can
specify parameters to identify the object that should be deleted.
Select Current Item if you want to delete the currently displayed item.
If you want to identify a specific object that should be deleted, select Get Object ID from
Property. Specify the property that will contain the object ID of the object that should be
deleted. You can also specify the Application and Class the objects to be deleted reside in from
the drop-down select lists.
Note: You can use the Clear button to clear the Application and Class drop-down selections.
2012 Hyland Software, Inc.
1002
OnBase 12 Workflow
Field value
The Field value option allows you to select an attribute specific to the class specified or a
system attribute. See the WorkView documentation for more information about system
attributes.
Related Filters
The Filter option allows you to select a filter that is associated with the selected class to
display/use filter results data in a notification.
Note: When using a filter in fields, such as To and From, ensure the filter will yield data that
contains valid data.
System date/time
The System date/time option allows you to insert date/time data into the notification and
specifying the formatting of the date/time.
Current user
The Current user option is selected, you can insert the currently logged in user into the
notification.
Workflow property
Selecting the Workflow property option opens the Property Name Entry dialog box. Enter the
name of the Workflow property you want to insert and click OK.
2012 Hyland Software, Inc.
1003
Workflow OnBase 12
If you want to specify a value that will be logged in the Event ID column, enter the value in
the Event Type ID (optional) field. As indicated, this is optional, but using a well-defined set of
application-specific type IDs will aid later when browsing and searching audit logs.
to another extended class. An example of when you may want to do this is if you have an
extendable class for Employees with an extension class for Managers and an employee is
promoted to a management position. You would want to convert that persons object from the
Employee class to the Manager class. When classes are configured appropriately in WorkView
to transform an object from one class to another, this action can be used to perform the
conversion within Workflow. To configure this action:
1. Select the Application from the drop-down select list that the class you want to convert
objects to reside in.
2. Select the class you want to transform the current object to from the Extension options
drop-down select list. The class selected must be configured correctly to be extended
to the selected class.
See the WorkView documentation for more information about Extension Classes and
transforming objects.
1. Select the Application from the drop-down select list that you want to associate with
the action or select <Shared Resources> to select a global notification that isnt tied to
an application or class. Skip to step 3 if you selected <Shared Resources>.
2. Select the Class from the drop-down select list that you want to associate with the
action.
3. If you want to use a notification that is configured for the selected class within the
WorkView Configuration, select Send an Existing Notification and select the appropriate
notification from the drop-down select list.
If you want to create a notifications specifically for this action, select Send a Custom/
Dynamic Notification and select the appropriate options.
Field value
The Field value option allows you to select an attribute specific to the class specified or a
system attribute. See the WorkView documentation for more information about system
attributes.
2012 Hyland Software, Inc.
1004
OnBase 12 Workflow
Related Filters
The Filter option allows you to select a filter that is associated with the selected class to
display/use filter results data in a notification.
Note: When using a filter in fields, such as To and From, ensure the filter will yield data that
contains valid data.
Current user
The Current user option is selected, you can insert the currently logged in user into the
notification.
Workflow property
Selecting the Workflow property option opens the Property Name Entry dialog box. Enter the
name of the Workflow property you want to insert and click OK.
1. Select the Application from the drop-down select list in which the attribute resides.
2. Select the Class from the drop-down select list in which the attribute resides.
3. Click the ellipsis (...) button next to the Attribute field and select the appropriate
attribute.
4. Either select Constant Value and enter the static value you want to add for the attribute
or select Property and enter the name of the property that contains the value you want
to add for the attribute.
Note: When configuring a constant value, any WorkView data-setting macro can be used. See
Macros in the WorkView MRG or WorkView Configuration help files for more information.
5. Click Add.
6. Repeat steps 1 to 5 for each attribute you want to configure.
Note: If the target attribute is boolean data type and the value to be set is anything other than
"0", "1", "true" or "false", execution exception is generated.
Note: This action is available only when configuring a System Task and should be used in
conjunction with the OnBeforeExecuteFilter WorkView event.
2012 Hyland Software, Inc.
1005
Workflow OnBase 12
Allows you to add additional filter constraints and/or sorts to any filter before it is executed.
The constraints and sorts set will have a cumulative effect on the filter to be executed.
In the Constraints tab, select an Application and Class from the drop-down select lists to
identify the target filters class.
To configure constraints that are in addition to the existing constraints of the filter:
Workflow Studio Actions
1. On the Constraints tab, click the ellipsis (...) button next to the Attribute field to define
what attribute you want to and select a class attribute or system attribute that you
want to add as a constraint.
2. Select the appropriate Operator from the drop-down select list.
3. If you want to specify a static value to use in the filter, select Constant Value and enter
the value in the field.
4. If you want to use a dynamic value that is stored in a property, select Property and
enter the name of the property in the field.
5. Click Add. Repeat these steps for each attribute you would like to add as a constraint.
Note: When configuring a constraints, any WorkView data-setting macro can be used. See
Macros in the WorkView MRG or WorkView Configuration help files for more information.
1. On the Sort tab, click the ellipsis (...) button next to the Attribute field to define what
attribute you want and select a class attribute or system attribute that you want to add
as a constraint.
2. Select Ascending to sort the attribute values in an ascending order.
3. Select Descending to sort the attribute values in a descending order.
4. Click Add. Repeat these steps for each attribute you would like to add as a sort.
Note: If this action is specified as a class event, all filters based on that class will have these
options added to them before execution. If added as a filter event, only the specific filter will
be affected. If an OnBeforeExecuteFilter class event exists as well as a filter-specific event,
the class event will be executed first followed immediately by the filter event.
2012 Hyland Software, Inc.
1006
OnBase 12 Workflow
Field value
The Field value option allows you to select an attribute specific to the class specified or a
system attribute. See the WorkView documentation for more information about system
attributes.
Related Filters
Note: When using a filter in fields, such as To and From, ensure the filter will yield data that
contains valid data.
System date/time
The System date/time option allows you to insert date/time data into the notification and
specifying the formatting of the date/time.
Current user
The Current user option is selected, you can insert the currently logged in user into the
notification.
Workflow property
Selecting the Workflow property option opens the Property Name Entry dialog box. Enter the
name of the Workflow property you want to insert and click OK.
Note: This action is available only when configuring a System Task and should be used in
conjunction with the OnBeforeOpenObject WorkView event.
Suppresses the screen action from a users view in the user interface.
Select the Application and Class this action will be associated with.
Select a Screen Action you want to suppress from the drop-down select list. Click Add. Repeat
this for each screen action you want to suppress.
To remove a screen action from the list of suppressed actions, select it from the Screen Actions
to Suppress box and click Remove.
Related Tab
Related Tab for Unity Life Cycles
When a Unity Life Cycle is configured, the following options are available on the Related tab.
Related Tab
The Related tab is displayed when an action requires related document to be configured. The
Related tab allows you to configure how related documents are defined.
2012 Hyland Software, Inc.
1007
Workflow OnBase 12
Portfolio Type
Select this option to use a portfolio type to identify related items for action and select the
appropriate portfolio type from the drop-down select list.
Portfolio Relation
Select this option to use a portfolio relation to identify related items for action and select the
appropriate portfolio relation from the drop-down select list.
Workflow Studio Actions
Caution: If the primary document also meets the requirements of a related document, the
primary document is excluded from related documents results.
Document Handle
This option causes the system to use the value contained in the Document Handle keyword as
the common denominator between the current and related document. When selected, the
Document Type, Common Keyword Types, and Folder Type cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
2012 Hyland Software, Inc.
1008
OnBase 12 Workflow
After you select the related Document Type, click Common Keywords. The Related Document
Types dialog box opens. To add Keyword Types to the list, select the Keyword Type in the list
and click Add. To remove a Keyword Type from the list, select the keyword and click Remove.
The Document Types with these Keyword Types are evaluated when this action executes.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any of the multiple values contained for that Keyword Type on the
current document (as well as the other common keywords designated) for the rule to
succeed. To enable this feature for a common keyword, click the check box to the left of the
Keyword Type name after the common keyword(s) have been added.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
Folder Type
This drop-down list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values, all documents
in the related Folder Type assigned that match the Keyword Values provided will be
processed. Common Keyword Type for Folder Types are configured in Folder Type
configuration.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
2012 Hyland Software, Inc.
1009
Workflow OnBase 12
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Workflow Studio Actions
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If an action that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the action fails, but the
task list continues execution: "Relationship type is only valid for tasks executed via drag and
drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
When this option is selected, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that Related Document Query aborted: primary
document does NOT have all common keywords present.
The following is required for this option:
Common Keywords must be configured.
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Lock Related Document
When selected, the related document that the action is being performed on will be locked by
Workflow and other users will not be able to modify the related document when the action is
being executed.
2012 Hyland Software, Inc.
1010
OnBase 12 Workflow
All other actions set the last execution result to TRUE if there is at least one related document
(not locked by Records Management) regardless of the result of the action and FALSE if there
are no related documents/items (or they are locked by Records Management).
Document Category
Check In Document (Target: Current Document/Current Item)
Check Out Document (Target: Current Document/Current Item)
Create Note (Target: Current Document/Current Item)
Create PDF/TIFF File
Delete Document (Target: Current Document/Current Item)
Delete Note (Target: Current Document/Current Item)
Re-Index Document
Set Document Type
Stamp Version
2012 Hyland Software, Inc.
1011
Workflow OnBase 12
Keyword Category
Add Keyword
Workflow Studio Actions
Property Category
Copy Property (with To E-Form field or To XML Path set)
Set Keyword from Property Value
Exclude from Document Retention
System Category
Purge Document
Remove Exclusion from Document Retention
Update Document Retention Status
The following actions will not execute on related documents/items locked by Records
Management. Related documents/items that are locked are not returned as related
documents.
Document Category
Check In Document (Target: Related Document/Related Item)
Check Out Document (Target: Related Document/Related Item)
Note:If at least one related document/item was locked, the last execution result is FALSE
2012 Hyland Software, Inc.
1012
OnBase 12 Workflow
Keyword Category
Add Keyword (Target: Related Document/Related Item)
Copy Keyword to Related Document
For specific support for each interface that is Core-Based, see the description for each action.
2012 Hyland Software, Inc.
1013
Workflow OnBase 12
Workflow Studio Actions
2012 Hyland Software, Inc.
1014
WORKFLOW STUDIO RULES
The rules available depend on the type of life cycle you are configuring. Only rules that are
supported by the type of life cycle you configuring are displayed for selection and
configuration.
Finding Rules
You can limit the rules displayed in Rule Type drop-down select list. Click in the field and type
characters to find the rule you are looking for. Any rule that contains the characters entered
will be displayed in red in the drop-down select list. If only one rule meets the criteria
entered, press Enter on the keyboard to select it. In addition, you can enter comma separated
words and phrases to look for rules that contain any of the words and phrases entered.
1. In the Properties pane, on the General tab, from the Field to Check drop-down select
list, select the field to check.
2012 Hyland Software, Inc.
1015
Workflow OnBase 12
When Agenda Item is the context, the following selections are available:
2012 Hyland Software, Inc.
1016
OnBase 12 Workflow
2012 Hyland Software, Inc.
1017
Workflow OnBase 12
Note: The <, <=, >=, and > operators are not available for alphanumeric fields.
3. From the Compare To drop-down select list, select one of the following for comparison:
Workflow Studio Rules
Compare To Description
Constant value This option compares the field value to the constant value specified.
Current date/time This option compares the field value to the current date/time.
Current user name This option compares the field value to the user name of the
currently logged in user. If you want to use the configured real name
for the user, select the Use real name option.
Property This option compares the field value to the value of the specified
property.
User group name(s) of This option compares the field value to the user group(s) the current
current user logged in user.
Note: This rule evaluates false if the field to check is on a related type that does not exist, or
if the field to check is null. If the field to check is an empty string, this rule will only evaluate
to true when configured to compare to an empty string.
Tip: You can use this rule to get to the Supporting Document entity through an agenda item
being routed, so that you do not need to configure a portfolio.
Checks to see if a related entity type exists for the current item.
1. In the Properties pane, on the General tab, from the Related Entity Type drop-down
select list, select a related entity type to evaluate using this rule.
2012 Hyland Software, Inc.
1018
OnBase 12 Workflow
When Agenda Item is the context, the following selections are available:
amagendadoclog
amagendaoutline
2. If you selected Agenda Item, Agenda Item Field, Agenda Item To Meeting, Supporting
Document, amagendadoclog, or amagendaoutline from the Related Entity Type drop-
down select list, you can filter the results. Select the Filter Results check box and
perform the following:
a. From the Field drop-down select list, select one of the following:
b. In Must match:, select Constant value or Property and enter a constant value or
property.
2012 Hyland Software, Inc.
1019
Workflow OnBase 12
3. If you do not want to use the results to execute sub-tasks, clear the Use results for sub-
tasks check box.
Note: When using the results to execute sub-tasks, the rules context sets the context for
respective sub-tasks. The actions context is automatically set when you choose the type of
items that the life cycle contains. The context is displayed in the Properties pane, on the
General tab, in Context. If the direct task does not specify context, then the context specified
Workflow Studio Rules
by the most direct ancestor will be used. For example, if you nest multiple Related Item Exists
rules that each provide context, the sub-tasks will use the deepest context.
4. If you want to store the result count in a property, select the Save result count in
property: check box and enter the name of the property in the corresponding field.
5. In the Properties pane, click the Advanced tab.
6. In the Properties pane, click the Documentation tab. Enter any descriptive information
that is applicable in the Overview and Details fields.
Document Category
Check Chart Data on This Chart
2012 Hyland Software, Inc.
1020
OnBase 12 Workflow
This rule checks information on OnBase charts. Chart information includes physicians, admit
types, diagnosis and DRG codes, dispositions, facilities, unit history1, and service types,
among others.
1. From the Chart Data drop-down, select the chart data to evaluate using this rule.
2. From the Operator drop-down, select the operator to use when comparing the charts
value against the value configured for the rule. Available operators are equal to (=)
and not equal to (<>).
3. If necessary, select Allow Wildcards to enable the use of wildcards (* or ?) in the value
configured for the rule.
4. In the field below the Compare To list, type the value2 to compare against the selected
chart data field. If the chart satisfies the configured conditions, the rule is evaluated as
TRUE.
5. Click Add.
6. Repeat for each chart field you want to evaluate.
7. Click Apply.
1. To maintain a patients unit history, you must turn on chart column tracking for the Unit Name
chart data field.
2. OnBase stores a charts Patient Sex as a numeric value. If you are using this rule to check the
Patient Sex on charts, enter a numeric value using this convention: 0 for Unknown, 1for Male, 2
for Female, 3 for Other, 4 for Ambiguous, 5 for Not Applicable.
2012 Hyland Software, Inc.
1021
Workflow OnBase 12
Note: This rule applies only to queues containing SYS Workflow Chart documents, which are
used to route OnBase charts through Workflow. OnBase charts require one of the following
licenses: HL7, Medical Records Management Solution, or Signature Deficiencies for Epic.
1. Under Date Value D1, select the option to use as the first date value (D1).
Queue Entry Value Select to use the date that the chart entered this queue as D1.
The queue entry time is logged using the database servers time.
Chart Data Value Select to use one of the following chart values as D1:
Admit Date
Discharge Date
Patient Date of Birth
2012 Hyland Software, Inc.
1022
OnBase 12 Workflow
Chart Data Value Select to use one of the following chart values as D2:
Admit Date
Discharge Date
Patient Date of Birth
Relationship Description
D1 is more than N Time Select if the rule is TRUE when D1 is more than the specified
Periods before D2 number of periods before D2. When you select this option, the
Number of Periods N field and Period drop-down become
available.
For example, if you set the time period to 2 days, in order for this
rule to return true, D1 must be more than 2 days before D2.
D1 is fewer than N Time Select if the rule is TRUE when D1 is fewer than the specified
Periods before D2 number of periods before D2. When you select this option, the
Number of Periods N field and Period drop-down become
available.
For example, if you set the time period to 2 days, in order for this
rule to return true, D1 must be fewer than 2 days before D2.
D1 is fewer than N Time Select if the rule is TRUE when D1 is fewer than the specified
Periods after D2 number of periods after D2. When you select this option, the
Number of Periods N field and Period drop-down become
available.
For example, if you set the time period to 2 days, in order for this
rule to return true, D1 must be fewer than 2 days after D2.
D1 is more than N Time Select if the rule is TRUE when D1 is more than the specified
Periods after D2 number of periods after D2. When you select this option, the
Number of Periods N field and Period drop-down become
available.
For example, if you set the time period to 2 days, in order for this
rule to return true, D1 must be more than 2 days after D2.
2012 Hyland Software, Inc.
1023
Workflow OnBase 12
4. If you selected an option that uses an N comparison, the Number of Periods N field and
Period drop-down become available.
a. In the Number of Periods N field, type the number of periods to use when comparing
D1 and D2.
b. From the Period drop-down, select the unit for the time period. Available options are
Year(s), Month(s), and Day(s). If the rule is part of a life cycle that is assigned a
Work Calendar, then Business Day(s) is also available.
Workflow Studio Rules
5. Click Apply.
Target
In the Target drop-down select list, define whether you want the rule to evaluate the current
document/item in the queue or a related document/item.
If you are configuring the rule for related documents/items, see Related Tab on page 1053 for
more information.
Priority Value
This value will be used to evaluate items against. Numbers 1 to 999 are valid values. Priority
rank is dependent on sorting and load balancing configurations.
Operator
The operator selected from this drop-down menu sets how to compare the priority value
configured for the rule to the priority value of the selected document. You can select less than
(<), less than or equal to (<=), not equal to (<>), equal to (=), greater than (>), or greater
than or equal to (>=).
Check on Item in this Life Cycle
2012 Hyland Software, Inc.
1024
OnBase 12 Workflow
Select the life cycle from this drop-down list from which you would like the priority checked
for the item. Priorities are attached to life cycles for a item. It is possible to have different
priority assignments for the same item in multiple life cycles.
Checks to see if the current document is assigned to the reading group specified in the
Reading Group drop-down select list.
Note: This rule applies only to queues containing SYS Workflow Chart documents, which are
used to route OnBase charts through Workflow. OnBase charts require one of the following
licenses: HL7, Medical Records Management Solution, or Signature Deficiencies for Epic.
Allows verification of whether a document has been signed by a specific user, member of a
user group, user specified by a keyword value, or user specified by a property value. If This
User is selected, the rule will be evaluated based on whether or not the specific user selected
in the drop-down select list signed the document. If Member of this Group is selected, the rule
will be evaluated based on whether or not a user belonging to the group specified in the drop-
down select list signed the document. If User name contained in Keyword is selected, the value
of the Keyword Type drop-down select list is compared to the user name of the person who
signed the document. If there are multiple values of the specified Keyword Type, only one of
the values must match the user that signed the document in order to evaluate as true. If User
name from Property is selected, the value of the property specified in the field is compared to
the user name of the person who signed the document.
If there are multiple revisions of a document, the current revision is evaluated for a signature.
Executed In
Allows task lists to be executed based on the interface in which the action is being executed.
You can select OnBase Client Classic interface or OnBase Core-Based interfaces to determine
which interface this rule will evaluate true. Actions can then be configured for the true and
false cases.
2012 Hyland Software, Inc.
1025
Workflow OnBase 12
Note Exists
Checks for a specified Note Type attached to the current document.
You can acquire the note type from a property value by selecting Get Note Type from property
and entering the property in the field.
If you want to check if the note type exists, select the Exists option.
If you want to check if the note type does not exist, select the Does Not Exist option.
Checks to make sure documents exist in the folder type that is selected from the Folder Type
drop-down select list. Only dynamic folders will appear in the drop-down list.
Note:Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Rendition Exists
Checks to see if a rendition exists for the current document. You can check for a rendition of
any file format by selecting <Any> in the File Type drop-down select list or you can select a
specific file type.
2012 Hyland Software, Inc.
1026
OnBase 12 Workflow
Run Script
Runs a script specified in the VB Script drop-down select list. OnBase examines the value of
the ExecutionStatus property. A return value of 0 is failure, any other value is success. For this
rule to work properly, the ExecutionStatus property must be set for all possible outcomes of
the script.
Note:This rule requires that your system is licensed for Digital Signatures.
Verifies whether a document was modified after being signed. If the signature is valid, the
rule will evaluate true. If a document is invalid or has no signatures, the rule will evaluate
false.
Note:WorkView must be installed on the database in which you want to configure this rule. If
you import a life cycle into a database, that database must have WorkView installed to
successfully import the life cycle.
Note:This rule is not functional in the Classic Client or Java Client interfaces.
2012 Hyland Software, Inc.
1027
Workflow OnBase 12
Determines whether a WorkView object exists that matches the Filter Document Type
Association option configured for the rule. The user can only specify one Filter Document Type
Association per Document Type.
Note:This rule will evaluate to true if one or more objects exist that meet the criteria
configured.
Workflow Studio Rules
1. Select a Document Type from the Document Type drop-down select list.
2. If you want to specify a Filter Document Type Association for which objects must meet
the configured criteria in order for the rule to evaluate true, select the appropriate
Filter Document Type Association. The Filter Document Type Association name is
followed by (Class ClassName). Only Filter Document Type Associations associated
with the Document Type selected are displayed. If no Filter Document Type
Associations are configured for the selected Document Type or you wish to evaluate an
objects existence based on whether the current document in the life cycle is attached
to an object, select <All objects that have doc attached>.
3. Click Add.
4. Repeat the these steps for each association you want to create.
Note: Only one filter association can be configured for a specific Document Type in this action.
If you want to save the ID of the object(s) that found, select Save Object ID(s) to Property and
enter the name of the property you want to store the ID(s) in the field.
1. In the Properties pane, on the General tab, from the Field to Check drop-down select
list, select the field to check.
2012 Hyland Software, Inc.
1028
OnBase 12 Workflow
Submitters Email The e-mail address of the ePlan Review projects submitter.
Note: The <, <=, >=, and > operators are not available for alphanumeric fields.
Compare To Description
Constant value This option compares the field value to the constant value specified.
Current date/time This option compares the field value to the current date/time.
Current user name This option compares the field value to the user name of the
currently logged in user. If you want to use the configured real name
for the user, select the Use real name option.
Property This option compares the field value to the value of the specified
property.
User group name(s) of This option compares the field value to the user group(s) the current
current user logged in user.
Note: This rule evaluates false if the field to check is on a related type that does not exist, or
if the field to check is null. If the field to check is an empty string, this rule will only evaluate
to true when configured to compare to an empty string.
1. In the Properties pane, on the General tab, from the Related Entity Type drop-down
select list, select a related entity type to evaluate using this rule.
The following selections are available:
Plan Review Document This entity type is used to check for documents that are part of the
ePlan project in the selected life cycle.
2012 Hyland Software, Inc.
1029
Workflow OnBase 12
2. If you selected eplandoc or eplangroupxproject from the Related Entity Type drop-down
select list, you can filter the results. Select the Filter Results check box and perform the
following:
a. From the Field drop-down select list, select one of the following:
b. In Must match:, select Constant value or Property and enter a constant value or
property.
3. If you do not want to use the results to execute sub-tasks, clear the Use results for sub-
tasks check box.
Note: When using the results to execute sub-tasks, the rules context sets the context for
respective sub-tasks. The actions context is automatically set when you choose the type of
items that the life cycle contains. The context is displayed in the Properties pane, on the
General tab, in Context. If the direct task does not specify context, then the context specified
by the most direct ancestor will be used. For example, if you nest multiple Related Item Exists
rules that each provide context, the sub-tasks will use the deepest context.
4. If you want to store the result count in a property, select the Save result count in
property: check box and enter the name of the property in the corresponding field.
5. In the Properties pane, click the Advanced tab.
6. In the Properties pane, click the Documentation tab. Enter any descriptive information
that is applicable in the Overview and Details fields.
Keyword Category
Autofill Row Exists
This rule evaluates whether or not an AutoFill Keyword Set exists that has the same value(s)
for the specified Keyword Type(s) associated with the currently displayed document.
Autofill Keyword Set drop-down select list allows the selection of the AutoFill Keyword Set type
to check values.
2012 Hyland Software, Inc.
1030
OnBase 12 Workflow
Based on your selection in the Autofill Keyword Set drop-down select list, the First Keyword
Type to Search field will be populated with the primary Keyword Type associated with the
AutoFill Keyword Set. The value from the currently selected document will be used for the
search.
The Second Keyword Type (Optional) drop-down select list allows you to further identify the
AutoFill Keyword Set that you want to evaluate. It is optional to use a secondary Keyword
Type. The value from the currently selected document will be used for the search.
This rule checks for a specified value in an AutoFill Keyword Set that also has the same
value(s) for the specified Keyword Type(s) associated with the currently displayed document.
Autofill Keyword Set drop-down select list allows the selection of the AutoFill Keyword Set type
to check values.
Based on your selection in the Autofill Keyword Set drop-down select list, the First Keyword
Type to Search field will be populated with the primary Keyword Type associated with the
AutoFill Keyword Set. The value from the currently selected document will be used for the
search.
The Second Keyword Type (Optional) drop-down select list allows you to further identify the
AutoFill Keyword Set that you want to evaluate. It is optional to use a secondary Keyword
Type. The value from the currently selected document will be used for the search.
The Keyword Type to Check drop-down select list allows the selection of the Keyword Type that
exists within the AutoFill Keyword Set that you want to check for a specific value. The value of
this Keyword Type and the Keyword Type(s) selected to search for will result in a true or false
return.
Operator
The default operator is = (equal), which indicates that the keyword value of the document
must match the value entered in the field. The selection of operators available from the drop-
down list varies for the keyword type selected. Select the keyword type first, to ensure that
only the correct operators for the keywords data type are represented in the operator drop-
down list.
Value
The field below the Value list allows you to enter the exact value used in the comparison. After
typing the value, click Add to move it to the list box. To remove a value from the list box,
select the name and click Remove.
Allow Wildcards
2012 Hyland Software, Inc.
1031
Workflow OnBase 12
The Allow Wildcards check box is another option for rules that check keyword values. When
using wildcards, you can use the? (question mark) wildcard to replace a specific number of
characters. For example, a value of COLUMB ?? succeeds for COLUMBUS, COLUMBIA and any
other eight-character keyword value beginning with COLUMB. The * (asterisk) wildcard
represents an indefinite number of characters. COLUMB* succeeds for any length keyword
values beginning with COLUMB, such as those mentioned above and COLUMBO and
COLUMBIANA.
Workflow Studio Rules
Note:The Allow Wildcards check box is only enabled for Alphanumeric Keyword Types.
Wildcards can be used with Alphanumeric Keyword Types that have masking configured.
When masking is used, the ? wildcard must be used. The * symbol does not work for spaces
or masking symbols.
Note:If you make a selection in the Keyword Type to Check drop-down select list, add values,
then change your selection in the Keyword Type to Check drop-down select list, if the data type
of the two Keyword Type selections are not the same, all values added for the first Keyword
Type selected will be lost.
This rule will evaluate a date data type keyword. This rule checks for a specified relationship
or test value in an AutoFill Keyword Set that also has the same value(s) for the specified
Keyword Type(s) associated with the currently displayed document.
Autofill Keyword Set drop-down select list allows the selection of the AutoFill Keyword Set type
to check values.
Based on your selection in the Autofill Keyword Set drop-down select list, the First Keyword
Type to Search field will be populated with the primary Keyword Type associated with the
AutoFill Keyword Set. The value from the currently selected document will be used for the
search.
The Second Keyword Type (Optional) drop-down select list allows you to further identify the
AutoFill Keyword Set that you want to evaluate. It is optional to use a secondary Keyword
Type. The value from the currently selected document will be used for the search.
The Keyword Type to Check drop-down select list allows the selection of the Keyword Type that
exists within the AutoFill Keyword Set that you want to check for a specific value. The value of
this Keyword Type and the Keyword Type(s) selected to search for will result in a true or false
return.
For the second value, you can select Current Date or Current Date/Time to compare the first
value against. You can select Specific Value and enter a specific date to compare the first value
against. You can select a Keyword Type from the Keyword Value drop-down select list to
compare the value.
2012 Hyland Software, Inc.
1032
OnBase 12 Workflow
A comparison relationship between the two values can be configured. You can specify the
number of days, business days, hours, or minutes to use in the comparison in the Number of
Periods N field and the Period drop-down select list.
Note: Business Day(s) is only available from the Period drop-down select list if a Work Calendar
has been assigned to the life cycle.
Note: This setting is not applicable for all comparison options. When it is not applicable, the
fields will become disabled.
Select a comparison option from the drop-down select list. The options are as follows:
Option Description
D1 is more than N Time Periods before D2 This option is dependent on the number of
periods and the interval of the time period set.
The comparison checks to see if the first value
occurs in time before the second value in more
than the time period specified
For example, if you set the time period to 2 days,
in order for this rule to return true, value 1 would
be more than 2 days before value 2.
D1 is fewer than N Time Periods before D2 This option is dependent on the number of
periods and the interval of the time period set.
The comparison checks to see if the first value
occurs in time before the second value in less
than the time period specified.
For example, if you set the time period to 2 days,
in order for this rule to return true, value 1 would
be less than 2 days before value 2.
D1 is fewer than N Time Periods after D2 This option is dependent on the number of
periods and the interval of the time period set.
The comparison checks to see if the first value
occurs in time after the second value in less than
the time period specified.
For example, if you set the time period to 2 days,
in order for this rule to return true, value 1 would
be less than 2 days after value 2.
2012 Hyland Software, Inc.
1033
Workflow OnBase 12
Option Description
D1 is more than N Time Periods after D2 This option is dependent on the number of
periods and the interval of the time period set.
The comparison checks to see if the first value
occurs in time after the second value in more
than the time period specified.
Workflow Studio Rules
Target
In the Target drop-down select list, define whether you want the rule to evaluate the current
document/item in the queue or a related document/item.
If you are configuring the rule for related documents/items, see Related Tab on page 1053 for
more information.
Note:When using the Queue Entry Value option for Data Value D1, the database servers time is
used for the comparison. When using the Keyword Value option for Data Value D1, the Web
Servers time is used for the comparison.
Option Description
D1 is more than N Time Periods before D2 This option is dependent on the number of
periods and the interval of the time period set.
The comparison checks to see if the first value
occurs in time before the second value in more
than the time period specified
For example, if you set the time period to 2 days,
in order for this rule to return true, value 1 would
be more than 2 days before value 2.
2012 Hyland Software, Inc.
1034
OnBase 12 Workflow
Option Description
D1 is fewer than N Time Periods before D2 This option is dependent on the number of
periods and the interval of the time period set.
The comparison checks to see if the first value
occurs in time before the second value in less
than the time period specified.
D1 is fewer than N Time Periods after D2 This option is dependent on the number of
periods and the interval of the time period set.
The comparison checks to see if the first value
occurs in time after the second value in less than
the time period specified.
For example, if you set the time period to 2 days,
in order for this rule to return true, value 1 would
be less than 2 days after value 2.
D1 is more than N Time Periods after D2 This option is dependent on the number of
periods and the interval of the time period set.
The comparison checks to see if the first value
occurs in time after the second value in more
than the time period specified.
For example, if you set the time period to 2 days,
in order for this rule to return true, value 1 would
be more than 2 days after value 2.
Note:For any operator except <> (not equal), the rule evaluates to FALSE if the document
has no keywords of the Keyword Type being checked. This can occur if the Keyword Type is
not assigned to the Document Type to which the document belongs or if the document does
not have any keyword values for the Keyword Type. For the "<>" operator, the rule will
evaluate to TRUE for this scenario. When there are several Keyword Types, for all operators
except <>" (not equal), the rule evaluates to TRUE if there is at least one Keyword Value
that meets the condition. For <>", the rule evaluates to TRUE only if all keywords are
different from the specified Keyword Value.
2012 Hyland Software, Inc.
1035
Workflow OnBase 12
Note: This rule does not compare Keyword Type values that have different currency formats
based on actual monetary value. If the currency format of a keyword value on a document is
different from the currency format specified in the rule, the rule evaluates to FALSE for this
keyword even if the numerical value is equal, unless the operator used is <>. Using the <>
operator will evaluate to TRUE because the values are not equal. For example, if the value of
a keyword on a document is $1.00 and the rule is evaluating the Keyword Type = to 1 Euro,
Workflow Studio Rules
the result of the rule is FALSE because the currency formats differ.
Target
In the Target drop-down select list, define whether you want the rule to evaluate the current
document/item in the queue or a related document/item.
If you are configuring the rule for related documents/items, see Related Tab on page 1053 for
more information.
Keyword Type
For all rules evaluating keywords, you must provide the system with the Keyword Type to
check. For these rules, a Keyword Type drop-down select list appears.
Currency Format
When the Keyword Type selected is configured as a Specific Currency Data Type, a Currency
Format drop-down select list is enabled. Any specific currency format configured for the
system can be selected from the drop-down select list.
Operator
The default operator is = (equal), which indicates that the keyword value of the document
must match the value entered in the field. The selection of operators available from the drop-
down list varies for the keyword type selected. Select the keyword type first, to ensure that
only the correct operators for the keywords data type are represented in the operator drop-
down list.
Value
The field below the Value list allows you to enter the exact value used in the comparison. After
typing the value, click Add to move it to the list box. To remove a value from the list box,
select the name and click Remove.
Allow Wildcards
The Allow Wildcards check box is another option for rules that check keyword values. When
using wildcards, you can use the? (question mark) wildcard to replace a specific number of
characters. For example, a value of COLUMB ?? succeeds for COLUMBUS, COLUMBIA and any
other eight-character keyword value beginning with COLUMB. The * (asterisk) wildcard
represents an indefinite number of characters. COLUMB* succeeds for any length keyword
values beginning with COLUMB, such as those mentioned above and COLUMBO and
COLUMBIANA.
Note:The Allow Wildcards check box is only enabled for Alphanumeric Keyword Types.
Wildcards can be used with Alphanumeric Keyword Types that have masking configured.
When masking is used, the ? wildcard must be used. The * symbol does not work for spaces
or masking symbols.
2012 Hyland Software, Inc.
1036
OnBase 12 Workflow
Note:Comparison related to case sensitivity is determined by the case sensitive setting of the
Keyword Type on the primary document. If the primary documents Keyword Type is case
sensitive, the comparison is case sensitive.
Note:This rule will always return FALSE if one of the keywords to be compared is blank or
missing.
For more information about configuring related documents/items, see Related Tab on page
1053 for more information.
Note:This rule will always return FALSE if one of the keywords to be compared is blank or
missing.
2012 Hyland Software, Inc.
1037
Workflow OnBase 12
If you want to ensure that all instances of a Multi-Instance Keyword Set have a valid value for
the specified Keyword Type, select the Keyword present on all instances of Multi-Instance
Keyword Type Group.
When Keyword Value Exists is selected, you can evaluate either the current documents/items
or related documents/items.
Target
Workflow Studio Rules
In the Target drop-down select list, define whether you want the rule to evaluate the current
document/item in the queue or a related document/item.
If you are configuring the rule for related documents/items, see Related Tab on page 1053 for
more information.
Select Keyword Value Does Not Exist if you want the rule to evaluate true if the value does not
exist.
Property Category
Check Date Property Value
For the second value, you can select Current Date or Current Date/Time to compare the first
value against. You can select Specific Value and enter a specific date to compare the first value
against. You can select a Keyword Type from the Keyword Value drop-down select list to
compare the value.
You can enter a property in the Property Name field to compare the value with a property.
2012 Hyland Software, Inc.
1038
OnBase 12 Workflow
A comparison relationship between the two values can be configured. You can specify the
number of days, business days, hours, or minutes to use in the comparison in the Number of
Periods N field and the Period drop-down select list.
Note: Business Day(s) is only available from the Period drop-down select list if a Work Calendar
has been assigned to the life cycle.
Note: This setting is not applicable for all comparison options. When it is not applicable, the
fields will become disabled.
Select a comparison option from the drop-down select list. The options are as follows:
Option Description
D1 is more than N Time Periods before D2 This option is dependent on the number of
periods and the interval of the time period set.
The comparison checks to see if the first value
occurs in time before the second value in more
than the time period specified
For example, if you set the time period to 2 days,
in order for this rule to return true, value 1 would
be more than 2 days before value 2.
D1 is fewer than N Time Periods before D2 This option is dependent on the number of
periods and the interval of the time period set.
The comparison checks to see if the first value
occurs in time before the second value in less
than the time period specified.
For example, if you set the time period to 2 days,
in order for this rule to return true, value 1 would
be less than 2 days before value 2.
D1 is fewer than N Time Periods after D2 This option is dependent on the number of
periods and the interval of the time period set.
The comparison checks to see if the first value
occurs in time after the second value in less than
the time period specified.
For example, if you set the time period to 2 days,
in order for this rule to return true, value 1 would
be less than 2 days after value 2.
2012 Hyland Software, Inc.
1039
Workflow OnBase 12
Option Description
D1 is more than N Time Periods after D2 This option is dependent on the number of
periods and the interval of the time period set.
The comparison checks to see if the first value
occurs in time after the second value in more
than the time period specified.
Workflow Studio Rules
When Property Name is selected for the first value, the Property [D1] as DATETIME, if selected;
otherwise, as DATE. option is enabled. This option will specify that the defined property is a
date/time value. When this is not selected, the property is defined as a date value.
If the property (specified in the first field) contains an array value then each value in the array
is checked. If any of those values matches the condition the rule evaluates to true.
If the Date Value D2 property value contains an array, then the value is compared to each
value in the array.
Target
In the Target drop-down select list, define whether you want the rule to evaluate the current
document/item in the queue or a related document/item.
If you are configuring the rule for related documents/items, see Related Tab on page 1053 for
more information.
Allows you to evaluate the value of the property specified in the Property Name field.
The Operator drop-down select list allows you to select the operator to use during the
evaluation.
The Case insensitive check box allows you to specify whether or not you want the evaluation to
be case sensitive.
You can compare the property value to either a Keyword Type, a property, and/or a constant
value.
2012 Hyland Software, Inc.
1040
OnBase 12 Workflow
To use a Keyword Type value for comparison, select the Keyword type radio button and select
the appropriate Keyword Type from the drop-down select list. Click Add.
To use a property value, select the Property radio button and enter the name of the property.
To use a constant value, select the Constant value radio button and enter the value you want
to use. Click Add.
If the property contains an array of values, then the rule evaluates to true if any one of those
Property Exists
Allows you to determine if a property with the name specified in the Property Name field
exists.
System Category
Audit Sample
Moves the specified percentage of documents evaluated down one path and the remaining
documents down another path. Specify the percentage chance each document has of being
audited. A Percent to Pass of 40% in the Rule Fields section means each document has a 40%
chance of being audited.
2012 Hyland Software, Inc.
1041
Workflow OnBase 12
The value entered in the Document Count field is compared to the current count of items in the
selected queue from the Queue drop-down select list. The Operator drop-down select list
specifies the comparison operation to perform.
Select the comparison Operator from the drop-down select list. Enter the number of items for
which you want the rule evaluated in the Item Count field.
If the queue selected in the Queue drop-down select list is a load balanced queue, the Count
Items fields are enabled.
Workflow Studio Rules
Caution:When used against a notification and a notification is sent to an e-mail address that is
outside of the internal server (example: person@company.com), when checked to see if the
notification action was performed successfully, it will always return a true value.
Caution:If multiple messages are sent using IDSMail and one of the messages is sent to an
invalid e-mail address, it returns a false value.
Caution:If multiple messages are sent using MAPI (dmmailservice.dll) and one of the messages
is sent to an invalid address, but others are successfully sent, it returns a true value.
Check Ownership
Check the current ownership for an item in a selected life cycle and queue.
Select the life cycle in which you want to check for ownership from the Owned in Life Cycle
drop-down select list.
Select the Queue in which you want to check for ownership from the drop-down select list.
2012 Hyland Software, Inc.
1042
OnBase 12 Workflow
Select the type of check you want to perform from the By User drop-down select list. You can
select <Any> to check for ownership by any user. You can select <Current User> if you want to
check for ownership for the currently logged in user.
Calls a custom dll function to determine if the rule should evaluate to TRUE for the current
document. The DLL function should implement application-specific logic for your domain. The
function signature should match the following format: int (CALLBACK* DLLEXITPROC)(long
nRuleNum, long nDocumentHandle, long nDocumentTypeNum)
OnBase passes the current rule number, the current Document Handle, and the Document
Type ID to the function. The return value for the function should be TRUE for success, FALSE
for failure, or IDCANCEL to abort processing of the current document.
DLL Name
Type the name of your system DLL in the DLL Name field. This is a required field.
Function Name
Type the name of the function to call in the Function Name field. This is a required field.
Note:It can also have any name you choose, with a maximum length of 30 characters.
Target
In the Target drop-down select list, define whether you want the rule to evaluate the current
document/item in the queue or a related document/item.
If you are configuring the rule for related documents/items, see Related Tab on page 1053 for
more information.
Performs an evaluation of the item in the queue specified in the Load Balancing Queue drop-
down select list to determine if the item is currently assigned to a user. You can narrow the
queues displayed in the Load Balancing Queue drop-down select list by selecting the life cycle
the appropriate queue is within by selecting the life cycle from the Assigned in Life Cycle drop-
down select list.
If you want to check if the currently logged on user is assigned to the item or if a user group
to which the user belongs is assigned to the item, select <Current User> from the Assigned to
User, User Group, or Role drop-down select list. If you want to see if any user is assigned to the
item, select <Any>.
2012 Hyland Software, Inc.
1043
Workflow OnBase 12
Note:If the Workflow log is purged, the determination of whether items have existed in a life
cycle before may not be accurate.
Workflow Studio Rules
Target
In the Target drop-down select list, define whether you want the rule to evaluate the current
document/item in the queue or a related document/item.
If you are configuring the rule for related documents/items, see Related Tab on page 1053 for
more information.
Life Cycle
The Life Cycle drop-down list allows you to specify where the system should search for the
item.
Note: If the current queue is selected, the rule will always evaluate true.
2012 Hyland Software, Inc.
1044
OnBase 12 Workflow
Life Cycle
The Life Cycle drop-down list allows you to specify where the system should search for the
item.
Note: If the current queue is selected, the rule will always evaluate true.
Item in Workflow
Checks for the existence of the item across all life cycles in Workflow, or across multiple life
cycles/queues.
Target
In the Target drop-down select list, define whether you want the rule to evaluate the current
document/item in the queue or a related document/item.
If you are configuring the rule for related documents/items, see Related Tab on page 1053 for
more information.
2012 Hyland Software, Inc.
1045
Workflow OnBase 12
The Use related items for tasks check box is enabled when the rules Target is configured for
related items. When using this option, the On True task list will be executed using the related
item(s) as the active item(s).
Specify Anywhere in Workflow, or to look for the item in specific queues, select In One of the
Following Queue(s).
To configure life cycles and queues, click Configure. Select corresponding check box(es) next
Workflow Studio Rules
to the life cycle(s) or queue(s) in the Select Queues dialog box. When selecting a life cycle, all
queues associated with the particular life cycle are also selected. Click on a queue to de-select
it. Specific queues may also be selected without selecting a life cycle. Once life cycles/queues
have been selected, click OK. The life cycles and queues you have configured will be displayed
in the rules configuration.
Note: This action is not supported in the OnBase Mobile Access for BlackBerry or Mobile
Access for Windows Phone interfaces.
2012 Hyland Software, Inc.
1046
OnBase 12 Workflow
Displays a question box and prompts the user to select a button for his or her response. Type
the question to present to the user in the Question Text box in the rule fields section. The
question should be posed to allow for yes/no true/false answers.
Click inside the field and type the symbol or click the symbols button to add it to the Question
Text.
Select a Keyword Type from the Keyword Type drop-down list and enter the Keyword Type
instance in the Repeat field. Click Keyword and the Keyword Value will appear in the Question
Symbols Used
Space- - Adds a space, a hyphen, and another space to separate the different
Space symbols ( - ).
Doc Date %D Adds the current documents date stored value into the system.
User %U Displays the User Name of the user who is currently logged in.
Time %I1 Adds the time that the current document was stored into the system.
Stored This value cannot be modified.
Symbol Description
Note: This symbol is only applicable when used with an Institutional Database.
%C Displays the name of the user who created the current document.
%D1 Displays the date that the document was stored. This value cannot be changed.
%I1 or %T Displays the time that the document was stored. This value cannot be changed.
2012 Hyland Software, Inc.
1047
Workflow OnBase 12
Symbol Description
%K###.n Displays the Keyword Value of Keyword Type ### n times. For example, %K101.4
would display up to 4 unique Keyword Values for Keyword Type 101 for a single
document.
For some functionality, a Keyword Type drop-down list may be available to
configure this. Select a Keyword Type from the drop-down select list, enter the
Workflow Studio Rules
number of times you want the Keyword Value to be displayed in the Repeat field,
and click Keyword. The value in the Repeat field specifies how many instances of
the Keyword Value will be displayed. Entering an * character will pull all existing
Keyword Values for display up to 99 instances.
Note: When using the Classic Client interface, double digits in the Repeat field are
not supported.
%M Extracts metadata values from items. This includes attribute values from Workview
objects or a field values from an Entity item.
%M must be followed by the metadata value you want to extract. For example, if
you want to extract the value of a WorkView attribute called Name, it would be
%MName.
The token strings can contain nested expressions. Example, a nested WorkView
attribute: %MVendor.Buyer.Name.
%R Displays the real user name (if configured) of the user who created the current
document. If a real user name is not configured, a blank space will be displayed.
%U Displays the user name of the currently logged in user who executed the task.
2012 Hyland Software, Inc.
1048
OnBase 12 Workflow
Symbol Description
%V### Displays the value of a configured Workflow property. For example, to display the
value for the property Color, this symbol would be configured %VColor.
The following symbols are not supported in the Classic Client interface:
%L [life cycle ID]
%L2 [life cycle name]
%Q [queue ID]
%Q2 [queue name]
%M [item metadata value] is not supported in the Classic OnBase Client interface or the
Core-Based OnBase Client interface.
The question is displayed in the User Interaction window while a document is displayed in the
viewer. The response can then be stored as a keyword by selecting a Keyword Type from the
Key Type To Store Answer drop-down list.
Note:If the answer is stored in a numeric Keyword Type, the affirm button will store 1 as the
value, the deny button will store 0 as the value, and the abort button will not store any value.
Also, the abort button does not store any value when the answer is stored in an alphanumeric
Keyword Type.
You can type your own text into the Yes, No and Cancel edit fields or you can choose the
default responses. Whichever option you choose, the question should be worded in such a
way that the buttons clearly answer the question. The button text for these three buttons is
limited to 24 characters.
When the user selects the abort button, all Workflow processing stops for the current item. If
you would like only the current task to be aborted, check the Abort Applies Only to Current Task
List check box. The other task lists continue processing with the current item.
You can also choose to turn off the abort option, which will force the user to affirm or deny the
task, by selecting the Hide Cancel Button check box.
2012 Hyland Software, Inc.
1049
Workflow OnBase 12
For related documents/items configuration information, see Related Tab on page 1053 for
more information.
For related documents/items configuration information, see Related Tab on page 1053 for
more information.
Use related items for tasks
The Use related items for tasks check box is enabled when the rules Target is configured for
related items. When using this option, the On True task list will be executed using the related
item(s) as the active item(s).
Evaluate to true when
You can configure this rule to evaluate to true only when a defined number of related items
are found. Select the Operator Type from the drop-down that you want to use to compare the
number of related items found to the specified value. Select Constant Value and enter the
value in the field if you want to specify a static number to compare to the number of related
items found. Select Property and enter the name of the property that will contain the value
you want to use to evaluate against the number of related items found.
Tip: If you want this to evaluate to true when any related item is found, select > as the
Operator and specify 0 as a Constant Value.
Note:This rule is only supported in the Core-based OnBase Client and the Web Client
interfaces.
2012 Hyland Software, Inc.
1050
OnBase 12 Workflow
WorkView Category
Note: Requesting a numerical difference for an attribute that does not represent a number will
produce an error, as the results are undefined.
Note: If both Against value and Previous Value was Changed From is configured, the Against
value condition is checked first. If it results to true, the Previous Value was Changed From
condition is checked. Both condition checks must evaluate true in order for the rule to
evaluate true.
2012 Hyland Software, Inc.
1051
Workflow OnBase 12
Select the application from the Object class is in application drop-down select list and a class
from the Object is specific Class (optional) drop-down select list. The class selected is the class
that you wish to check the current object against. If the Object is specific class (optional) field
is left blank, the rule will check the objects class against any class in the specified application.
It may also be left blank if you are checking against a class name saved to a named property.
If you want to clear the Object is specific class (optional) selection, click Clear.
If you wish to check the current objects class against the class name saved in a property,
Workflow Studio Rules
select the Get class name from property check box and specify the name of the property to
check.
Note: Typically, the value entered will be a single class name. It is possible for a property to
contain a list of class names to check against. For example, if the named property is
propClassList and the property propClassList contains class1\class2\class3\lastclass, the
objects class will be compared to each of the 4 embedded class names. If any one of the
class names is matched, this rule will return TRUE.
If you select the Match any extensions of the specified class option, the rule will evaluate TRUE
if the current object matched the specified class name or any extensions of this class.
Note: This option is not supported if you include a list of classes via a named property.
If you select the Match any siblings of the specified class option, the rule evaluate TRUE if the
current object matches the specified class name OR any sibling of this class. A sibling class is
defined as any class extended from the same base class as the specified class.
Note: This option is not supported if you include a list of classes via a named property.
Dataset Contains
Checks a value against the values contained in the specified dataset. If the value matches a
value from the dataset, the rule evaluates to TRUE, otherwise it results in FALSE.
Choose the Application and Class of the object whose value to will be evaluated.
Choose the Dataset to test against from the drop-down select list. All datasets configured in
WorkView are provided in the drop-down select list.
Choose the Against value option for the type of value you want to check.
Select Attribute and then select the attribute you would like to check by clicking the ellipsis
(...) button and selecting the appropriate attribute for the Attribute field.
When configuring a System Task, the Previous check box is enabled. This option allows you to
get the previous value of the specified attribute from the current object. If this option is not
selected, the current value is used.
If you will be setting the checked value in a named property, select Property and specify the
name of the property in the field.
If you wish to provide a constant value to check against, select Constant and provide a value
in the field.
2012 Hyland Software, Inc.
1052
OnBase 12 Workflow
The following is an example of how this rule could be used. Datasets are configured to divide
the 50 states into regions, where each dataset is named for the region and all the states of
that region are values in the dataset. To test an object that has a State attribute to see if it is
in the Southwest region, a Dataset Contains rule can be created specifying the Southwest
dataset and the objects State attribute.
Object Is New
Used to check the objects status to determine if it is a new object. This is used in
OnBeforeSaveObject and OnBeforeOpenObject events when different validations must be
applied if the object is new or pre-existing.
If the object is new, the result of this rule is TRUE. Otherwise, it is FALSE.
Related Tab
Related Tab for Unity Life Cycles
When a Unity Life Cycle is configured, the following options are available on the Related tab.
Related Tab
The Related tab is displayed when an rule requires related document to be configured. The
Related tab allows you to configure how related documents are defined.
Portfolio Type
Select this option to use a portfolio type to identify related items for rule and select the
appropriate portfolio type from the drop-down list.
Portfolio Relation
Select this option to use a portfolio relation to identify related items for rule and select the
appropriate portfolio relation from the drop-down list.
Ad Hoc Portfolio Relation
Click Configure under this option to create a portfolio relation that is specific to this rule. This
portfolio relation cannot be assigned to portfolio types or reused in another action or rule. The
content types available are specific to the item types the rule can evaluate. See Configuring
Portfolio Relations on page 716 for more information.
Note: The Lock Related Document check box is always disabled for rules.
2012 Hyland Software, Inc.
1053
Workflow OnBase 12
Related Tab
Caution: The Related tab is displayed when an action requires related document to be configured.
The Related tab allows you to configure how related documents are defined.If the primary
document also meets the requirements of a related document, the primary document is
excluded from related documents results.
Workflow Studio Rules
Note: When a Workflow rule evaluates related documents, as soon as the rule encounters one
related document that evaluates True for the rules condition, the rule evaluates as True and
the True logic is executed. If all related documents evaluate to False, then the False logic is
executed.
Document Handle
This option causes the system to use the value contained in the Document Handle property as
the common denominator between the current and related document. When selected, the
Related Document Type and Common Keyword Types cannot be configured.
Document Type
Select a Document Type from the Related Document Type drop-down list.
Note: If you do not configure Keyword Types, Workflow will not be able to find related
documents.
Note: If all common keywords for the current document contain null values for the common
Keyword Types, Workflow will not find any related documents.
Note: If there is at least one common Keyword Type for the current document that contains a
value, but one or more of the other common Keyword Types have null values on the current
document, the rule will evaluate true if any related document matches the existing value in
the common Keyword Type.
The Search Multiple Values Independently optional check box is used for Keyword Types that
can have multiple values on the current document. If this check box is enabled, a related
document can match any one of the values contained for that Keyword Type on the current
document (as well as the other common keywords designated) for the rule to succeed. To
enable this feature for a common keyword, click the check box to the left of the Keyword Type
name after the common keyword(s) have been added. If this option is disabled, the related
document must match all values for a given Keyword Type if it contains multiple values on a
primary document.
Tip: Common keywords should be configured for a related document rule. Without common
keywords defined, the rule will not evaluate against any documents.
2012 Hyland Software, Inc.
1054
OnBase 12 Workflow
Folder Type
This drop-down select list includes all dynamically populated folder types (Dynamic Document
Types/Dynamic Document Type Group folder types). The selected folder type will contain
documents, related to the currently selected document, that will be acted on in Workflow.
Note: Only folder types configured as Workflow folders will displayed for selection in the Folder
Type drop-down select list.
Related documents can also be determined by document handle when using folder types. For
information about configuring folder types to relate documents by document handle, see
Relating Documents by Document Handle with Folders on page 182.
Associated Primary Document
Note: This option is supported only in the Core-Based Client and Web Client interfaces. The
following message is displayed to the user and the task list is completely aborted when
attempting to execute this in an interface where it is not supported: "The current
configuration for finding related documents is not implemented"
Caution: This option only applies when a Work Folder document has been dragged-and-dropped
to an ad hoc task.
Sometimes access back to the primary document in order to obtain information, for example,
copying keywords from the primary document, is needed while the task list is executing.
The option allows users to relate back to the document that was last selected from the Inbox
when dragging and dropping a document from a Work Folder to an ad hoc task.
If a rule that is configured with this relationship option is executed in any other manner
(traditional ad hoc task execution, System Work, Timer Work, Load Balancing Work or System
Tasks), the following message is displayed in the Diagnostics Console, the rule evaluates to
"False", and the remainder of the task list continues execution: "Relationship type is only valid
for tasks executed via drag and drop from the work folder"
Require All Common Keywords Present on Primary Document
Note: This option is not supported in the Classic Client Workflow interface.
Note: This option is available when searching for related documents by Document Type or by
Folder Type.
2012 Hyland Software, Inc.
1055
Workflow OnBase 12
When this option is checked, the query logic requires that all configured common keyword
values must be present in order to return matching related documents. If the primary
document does not have all of the common keywords present, the query is aborted and a
message is logged to the Workflow Trace stating that "Related Document Query aborted:
primary document does NOT have all common keywords present".
The following is required for this option:
Common Keywords must be configured.
Workflow Studio Rules
The primary document must have all of the configured common keywords present
on the document in order for the query to run.
The primary document must have a value for each of the configured common
keywords in order for the query to run.
This option is not available when searching for related documents by Document
Handle.
Note: The Lock Related Document check box is always disabled for rules.
For specific support for each interface that is Core-Based, see the description for each action.
2012 Hyland Software, Inc.
1056
WORKFLOW 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.
This section describes some best practices for the design and implementation of Workflow
solutions. Best practices have been divided into the following categories:
General Design
General Performance
Filters
Keywords and Properties
Scripting
Timers
E-Forms and User Forms
Servers
Load Balancing
Working with the Document Transfer Module
General Design
The following best practices are general design choices that are recommended.
Always design the process before configuring the solution.
Testing changes is necessary. Creating and maintaining a test environment is
important to fully test out changes before implementing them in the production
system. Once changes are created in the production system, another test should be
performed in the production system.
Always use the Workflow Search to search for rules, actions, or tasks before making any
modifications to existing logic.
Use the Core-based user interface in the OnBase Client.
Use nesting 3 levels deep or less when configuring actions and rules. This affects
memory consumption and ease of maintenance. Avoid nesting if possible.
Create naming conventions for queues. Use prefixes when naming queues.
It is preferable to transition items as part of timer work or ad hoc tasks rather than
system work or load balancing work. This is particularly true when an item might
transition multiple times before reaching its final destination.
Use the Edit Comments option to include useful notes and record change information.
2012 Hyland Software, Inc.
1057
Workflow OnBase 12
Implement a garbage collection queue. One should always delete Keyword Values that
are no longer needed outside of Workflow. Fewer records in keyword tables improve
query performance.
Put the most probable answer first. If there are a series of rules that determine which
action to take on the document, the most probable logic should be evaluated first.
This prevents unnecessary work from being performed on every document exposed
to that logic. Determining the most probable path can be accomplished by working
with the business process owner or by running reports at a later time.
Use intuitive task sequences. Use intuitive task sequences and names that are
efficient for users. A simple thing like ordering tasks from most probable to least
probable will save a lot of processing over time.
Break processing when all work is complete. In the context of a business process,
there are many logic structures that should stop processing when certain conditions
are met. There are two methods to break processing: the SYS Break Processing
action and the Break On functionality, which exists as part of every task list
configuration.
Consider breaking a potential high volume queue into multiple queues. By breaking a
high volume queue into two (2) or more queues, there will be better distribution and
potentially enable the optimizer to still use the index and avoid a full database table
scan.
Purge documents in Document Maintenance. When a document is deleted from
OnBase, it first goes into Document Maintenance. Document Maintenance is similar
to a recycling bin where documents can be recovered if necessary or completely
removed from the system. For this reason, one could still have a high volume queue
from a database perspective even if only a small number of documents are visible in
the queue via the client. By purging the documents in Document Maintenance, the
system removes all records associated with the document from the system, which
potentially eliminates high volume queues.
OnBase is a document repository, Workflow is not. Documents should not sit in a single
queue within a Workflow process for a long period of time.
Consider using a trigger document to avoid high volume queues. E-Forms can be used
to avoid high volume queues. For instance, if a business process requires documents
to re-enter Workflow at a much later date, consider using a proxy document that
rests in a queue and represents the group of documents to be brought back into a
workflow process. Typically, documents that need to re-enter Workflow at a specific
time are triggered by a future date. This date can be stored in a keyword value on
the documents required at the appropriate time and removed from Workflow. To
reinsert the documents into Workflow, simply create an E-Form having the same
trigger date keyword as the returning documents. Add this E-Form to a Workflow
queue containing a timer configured to execute once daily. When the timer executes,
the trigger date keyword is updated with the current date. Execute a related
document search for those documents with the current date. Locate and add these
documents to their respective life cycles.
2012 Hyland Software, Inc.
1058
OnBase 12 Workflow
2012 Hyland Software, Inc.
1059
Workflow OnBase 12
Doc - Print Related Document and Doc - Print This Document: When used in system
work and the documents are brought into the system using the Fax Import
Integration for Captaris RightFax or Integration for Open Text Fax Server, RightFax
Edition modules and a local printer is used, this action will not function. If you want
to use this action in system work with the Fax Import Integration for Captaris
RightFax or Integration for Open Text Fax Server, RightFax Edition modules, it is
recommended that you use a network printer. If you must use a local printer, you
Workflow Best Practices
can configure this action using a timer and the OnBase Client running as a Timer
Server.
SYS - Create or Update Agenda Item from Document: It is considered a best practice to
check the resulting property value immediately after the SYS - Create or Update
Agenda Item from Document action is executed by configuring the following rules:
SYS - Check Last Execution Result and Prop - Check Property Value. Configure the
SYS - Check Last Execution Result to verify that the SYS - Create or Update Agenda
Item from Document action occurred. Configure the Prop - Check Property Value
rule to use the property value that was set by the Property to Store Agenda Item
Primary Key in the SYS - Create or Update Agenda Item from Document action.
General Performance
The following best practices are related directly to system performance.
Break on success/failure to speed up keyword checks.
During DIP/TIP processing, add documents to Workflow on commit.
Keeping queue counts low enhances performance.
Select the option to Hide Document Count. If a user does not need a count of
documents in the queue, check the option to Hide Document Count. This saves
system overhead incurred from calculating the correct number of documents, which
becomes complex when load balancing and filters are configured.
Only use queue refresh rates when absolutely necessary. By default, the refresh queue
setting is set to 0 which disables the system from automatically refreshing the
queue count and document hit list. This setting is measured in seconds and should
be used with extreme caution if enabled. There is a significant amount of work
performed when documents are retrieved and document counts are being processed
by the system.
Disable Logging if the log entries are not needed for an audit trail. Writing to the
Workflow log happens whenever a document enters and exits a queue. If this
information is not needed, check the box to Disable Logging at the queue level.
Do not use the Refresh tree counters setting with the Core-based Workflow interface. To
achieve optimal performance, it is recommended that this option not be used with
the Core-based OnBase Client interface. Using this option with the Core-based
interface will consume a greater share of network, database, and Application Server
resources.
2012 Hyland Software, Inc.
1060
OnBase 12 Workflow
Related Documents
The following best practices are related to work folders and related documents.
The configured work folder for displaying related documents should only contain
necessary documents. The folder should only display those documents the user needs
to see every time a document is selected. Users often want all possible related
documents to display rather than those they most commonly use; therefore, it is
Filters
The following best practices are related to filters.
Do not assign multiple keywords to filter for performance.
When configuring a custom query to be used as a Filter, it is recommended that the query
be configured for Document Type and not Keyword Type. It is recommended that
Custom Queries used as Workflow filters do not use the By Keyword option. Instead,
the By Document Type option should be used whenever possible.
2012 Hyland Software, Inc.
1061
Workflow OnBase 12
Only check Display Filtered Document Count when truly necessary. Displaying the
filtered document count should only be checked if the user must know the number of
documents returned by the filter. By default, this functionality is disabled to ensure
that this best practice is implemented. The system incurs significant overhead when
calculating document counts in addition to retrieving the list of documents.
When using filters, limit the number of display and sort columns: The system must
perform extensive logic and database processing to display the documents in a
Workflow Best Practices
filtered hit list. Limit the scope of filters to 2 to 3 columns to minimize the hit on
performance. Also, when columns are configured to allow sorting, the system must
perform additional logic to determine the sort order. Ensure that the configured
display columns are truly needed and that the user will truly be sorting documents
against those columns. Consider grouping the Keyword Types used as filter columns
into a Keyword Type Group.
2012 Hyland Software, Inc.
1062
OnBase 12 Workflow
When using document processing modules and entering documents into Workflow on
commit, using a status keyword on documents can prevent documents from entering
Workflow more than once. In the event that a commit process fails, when a the
incomplete commit batch is manually committed, the entire batch is committed and
some documents may re-enter Workflow. If a status keyword is used, the status
keyword determines where in Workflow documents belong.
Timers
The following best practices are related to timer configuration and usage.
Use the Workflow Timer Service for its multi-threaded functionality. By using the
Workflow Timer Service, one can have timers executing simultaneously on the same
machine. This avoids the sequential, serial processing capabilities of the Workflow
Server OnBase Client which is limited to one thread of execution, which could
potentially cause the timers to wait for processing on the single threaded machine.
Dedicate multiple machines to monitor and execute timers, when necessary. If a
Workflow deployment is performing extensive logic behind timers, consider off
loading the timers to different machines. Many smaller Workflow deployments with
less intensive work performed behind timers may not require multiple machines.
When testing and analysis indicates that timers are consuming excessive processing
power on a machine, consider adding another machine to distribute processing load.
2012 Hyland Software, Inc.
1063
Workflow OnBase 12
Use timers to off load work. Consider sending a document to a queue where a timer
will execute from the Workflow Server. It is not necessary to keep the user waiting
until the document completes processing when no user input is expected.
Use the Workflow Timer Service for timers.
Create realistic timer work intervals.
Before deleting a queue, it is recommended to remove timers from the queue
Workflow Best Practices
configuration from the Workflow System Monitor in the OnBase Client or the Workflow
Timer Service Administrator. If timers are configured for a queue that is going to be
deleted, it is recommended to make sure that the timers associated with the queue
to be deleted are removed from the Workflow System Monitor in the OnBase Client
or the Workflow Timer Service Administrator, depending on the method being used
to monitor timers.
Configure Every timer intervals with care. When configuring an Every timer, take
special note of how frequently the timer needs to fire. Do not have the timer fire
every five (5) minutes if the business process requires that it only needs to fire
every one (1) hour.
Configure Timer Execution Windows: If one is using an Every or After timer,
consider using a Timer Execution Window to limit when the timer will actually fire.
For instance, if the timer only needs to run during business hours, configure an
Execution Window from 8 AM to 5 PM. This frees database capacity for those
processes that may already be running overnight (import processes, third party
updates, Autofill Keyword Set imports, etc).
Use a Timer in Initial Queues. Initial queues should be configured to run all system
work behind a timer in most scenarios. This ensures that all import processes are
separated from Workflow logic and enables the import machine to perform at a
higher level.
Do not let documents sit in a timer queue indefinitely. When a timer executes, the
document should leave the queue in most cases.
Use the At Certain Time timer versus Every 1 Day/24 Hours timer. When the
Workflow Server is restarted, Every timers will be reset and count down from the
original interval (1 Day/24 Hours). If an At Certain Time timer is used, when the
Workflow Server is restarted, the existing timer count will be respected.
Use After timers with care. The main point to consider with an After timer is that
an After timer configured for after four (4) minutes is actually polling (to check
elapsed time a document has been in the queue) every one (1) minute. An After
timer configured for after five (5) days is polling every five (5) minutes. Even though
the system is polling regularly, it only executes the defined tasks under the timer
when documents are returned. There are very few business cases that require an
After timer. If one is considering using an After timer, evaluate if one could use
an At Certain Time or Every timer that has Workflow logic configured to first
check has this document been in the queue for X interval (Key-Check Date
Keyword on this/Related Document) and then perform the work if true.
2012 Hyland Software, Inc.
1064
OnBase 12 Workflow
Servers
The following best practices are related to the Web Server, Application Server, or the Workflow
Server.
Consider using a mechanism for distributing the load. Load distribution tools are very
useful for optimizing Web Server performance in larger implementations. The Web
Server handles all requests from Web Clients (Workflow Client and traditional Web
Client). A large number of Workflow users and Workflow logic operating in an
insufficiently configured web environment is a significant performance hazard.
Consider having a separate Web Server for Workflow Users. Direct Workflow users to a
different web site on a different web server. Build the OnBase Web Server on two
different machines and serve user processing needs appropriately to distribute the
load.
Separate the Application Server from the Web Server. While it is possible to use the
existing Web Server as the Application Server, it is not advised. By pointing the
Application Server to the existing Web Server, all workflow logic execution is
performed by the Web Server whether requests are coming from the Web Client or
OnBase Client. In addition to executing workflow logic, the Web Server is processing
requests from non-Workflow users in the Web Client. Because the combined
processing load can be extremely heavy, the Application Server should be deployed
on a separate machine.
2012 Hyland Software, Inc.
1065
Workflow OnBase 12
Ensure the Web Server is a powerful machine. When using a single machine, the
OnBase Web Server should be equipped to handle the combined load of web users
and Workflow users. Increase the hardware resources on the machine to ensure
maximum performance.
Increase Processing Power of Web Server/Application Server/Workflow Server. In the
Web Environment, Workflow related and general OnBase processing is performed on
the Web Server; therefore, it is essential for the Web Server to be configured to
Workflow Best Practices
handle such loads. The Application Server functions very similarly to the Web Server
except that it is dedicated to handling Workflow logic alone and does not also have
to provide processing resources for custom queries, foldering, etc. The Application
Server should be a powerful machine. By increasing the power of the Application
Server, Workflow users will be able to process more work more quickly. Workflow
Servers (machines that monitor Workflow timers) should be powerful machines to
handle all timer work processing.
Off load work from machines not dedicated to handling such loads. If there is system
work or ad hoc tasks that are performing intense activities against the document,
one should off load the work to the Workflow Server. This enables the machine that
initiated the work to hand off the work and dedicate system resources to those
tasks it was designed to handle.
Recycle the Application Pool after making configuration changes in OnBase when using
Core-based Workflow. Recycling the Application Pool immediately ends all user
sessions. For this reason, it is recommended to perform this operation during non-
peak or off-hours.
Load Balancing
The following best practices are related to load balancing.
When using Match Keyword to User Name, delete the Keyword Value from the document
as it exits Workflow. When the document exits Workflow, delete any Keyword Value
that was used for load balancing purposes. Deleting the Keyword Value helps
manage the size of the keyword table, and thus controls performance over time. If
deleting the Keyword Value is not an option, as it must remain on the document for
reporting or retrieval purposes, consider purging documents in Document
Maintenance.
It is recommended that actions that require user interaction not be used as load
balancing work.
Use a Load Balance Keyword Type throughout the Workflow. If the keyword cannot be
removed when the document exits Workflow, add another keyword to the driving
Document Type called LB User. When the document enters a queue, simply copy the
user name from the keyword that must remain on the document to the LB User
keyword and configure load balancing to use the LB User keyword. When the
document exits Workflow, delete the LB User keyword.
Consider using Rules Based Load Balancing rather than Match Keyword to User Name.
When assigning work to a user whose name is defined in a keyword value, consider
using Rules Based Load Balancing instead of Match Keyword to User Name. When
implementing Rules Based Load Balancing, one can utilize the task SYS Assign to
User, which allows one to assign the document to a user whose name is defined in a
keyword. Rules Based Load Balancing is a static form of load balancing; therefore, it
is much faster than Match Keyword to User Name. When using Match Keyword to
User Name, be aware of potential performance impacts. When a solution is first
2012 Hyland Software, Inc.
1066
OnBase 12 Workflow
deployed, the database is typically small and performance issues are not exposed.
Over time, the table structures in the database grow and it is important to manage
them for optimal performance. Consider the number of users processing documents
in Workflow and the growing number of documents traveling through Workflow over
time. The number of users may be small in relation to the number of documents in
the system, but as the number of documents grows, the number of documents with
user names on them also grows. As the process continues, the keyword table
2012 Hyland Software, Inc.
1067
Workflow OnBase 12
Workflow Best Practices
2012 Hyland Software, Inc.
1068
WORKFLOW STUDIO INSTALLATION
Requirements
Supported Operating Systems
Windows XP SP3 or later service pack
Windows Server 2003 SP2 or later service pack
Windows Vista SP1 or later service pack
Windows Server 2008 SP2 or later service pack
Windows Server 2008 R2 SP1 or later service pack
Windows 7 RTM or later service pack
Memory (RAM) 2 GB 4 GB
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.
2012 Hyland Software, Inc.
1069
Workflow OnBase 12
Novell GroupWise 7 or 8
.NET Framework
Workflow requires Microsoft .NET Framework 3.5 SP1 (or later service pack), which can be
obtained from the Microsoft Download Center at http://www.microsoft.com/downloads.
Databases Supported
The following tables list the databases supported in OnBase 12.
Microsoft SQL Server Microsoft SQL Server 2000 and 2005 must be running in compatibility
2000 (SP4 mode 7 or greater. Running in compatibility mode 6.5 or lower will result
recommended) in errors during the upgrade process.
Microsoft SQL Server SQL Server 2005 drivers must be upgraded to the Feature Pack for
2005 (SP2 or later Microsoft SQL Server 2005 - December 2008 or a later feature pack.
recommended)
Microsoft SQL Server Note: On January 11, 2011 Microsoft discontinued technical support for
2008 (RTM, SP1, SP2; Microsoft SQL Server 7.0. As of release 11.0.0, Hyland Software no
SP2 recommended) longer supports SQL Server 7.0.
Microsoft SQL Server
2008 R2 (RTM, SP1; Note: You must ensure that your SQL Server database client software
SP1 recommended) version matches or exceeds the database server version. For example, if
Microsoft SQL Server your database server is SQL Server 2005, verify that the database client
2012 is SQL Server 2005 (or later). Running a previous client version, such as
SQL Server 2000, 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 1071.
2012 Hyland Software, Inc.
1070
OnBase 12 Workflow
Oracle
Note: If you are using an Oracle database, it is strongly recommended that you have a
certified Oracle Database Administrator on staff.
Oracle v 8.0.5.0 or Oracle version 8.0.5.0 can be used, but it is not recommended due to
later 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 ODBC drivers should be 8.1.7 or later. 8.1.6.x drivers have known issues
later and are not supported.
2012 Hyland Software, Inc.
1071
Workflow OnBase 12
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
Workflow Studio Installation
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).
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.
If your database server software is SQL Server 2005, the version number should
appear as 2005.[##.####.##] (or later), where 2005 is the version number and
[##.####.##] represents the service pack.
The above descriptions are examples of two commonly used database version numbering
schemes. Ensure that the supported database you use adheres to the database client/server
recommendation.
2012 Hyland Software, Inc.
1072
OnBase 12 Workflow
2012 Hyland Software, Inc.
1073
Workflow OnBase 12
If Windows UAC is enabled, the above operations will prompt for administrator privileges,
even if an administrator is currently logged on.
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.
Pre-Installation
In order to monitor and process BPMN approval process events, the Workflow Timer Service
must be installed and configured. For more information about installation, see the Workflow
Timer Service MRG.
If you are using notifications, consult the Workflow MRG for information about installing and
configuring the system to send notifications.
Installation
Overview
EXE and 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.
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.
2012 Hyland Software, Inc.
1074
OnBase 12 Workflow
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:
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.
2012 Hyland Software, Inc.
1075
Workflow OnBase 12
Launch the Hyland Workflow Studio installer by executing Hyland Workflow Studio.msi. The
MSI is usually located in the \install\Workflow Studio\ 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 \Workflow Studio\ folder and its contents must be copied to the new
location.
Workflow Studio Installation
2012 Hyland Software, Inc.
1076
OnBase 12 Workflow
3. Enter the top-level installation directory in the field provided, or click Change to browse
to it.
Note: This location does not affect components not installed under the top-level directory. If
the installer provides for the installation of multiple components, the specific installation
locations of each component can be changed later in the installation process.
Enter a Folder name in the field provided or select it from the Look in drop-down select
list, then click OK.
If the Destination Folder is not changed, the default location is used (e.g., C:\Program
Files\Hyland\ or C:\Program Files(x86)\Hyland\).
2012 Hyland Software, Inc.
1077
Workflow OnBase 12
5. Select Create Desktop shortcut(s) when applicable to create shortcuts to the installed
components on in the Windows Start | All Programs | Hyland menu, on the Windows
desktop, or in both locations, when applicable.
6. Click Install to continue with the installation, or click Cancel to cancel the installation.
7. 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.
2012 Hyland Software, Inc.
1078
OnBase 12 Workflow
Option Description
The steps regarding adding any selected components are the same as those
under the Component Selection section of the installation instructions, if
applicable to the installer.
Repair Repair errors in the most recent installation of the component, including missing
and corrupt files, shortcuts, and registry entries.
Note: This option is not available from all installers. For specific troubleshooting
information regarding an installed component, see the module reference guide
for that component.
Feature Names
To install Workflow Studio, the value of the ADDLOCAL property is Workflow_Studio.
The ADDLOCAL property is added to the installation command line, as shown here:
msiexec /i "Hyland Workflow Studio.msi" ADDLOCAL=Workflow_Studio
2012 Hyland Software, Inc.
1079
Workflow OnBase 12
Properties
When controlling the installation of components from the command line you must also
configure the settings for each component you are installing by using the properties listed in
the following table. If a property is not included, the default value is configured for that
property.
Workflow Studio Installation
Property Description
Troubleshooting
There are three main places to access log information. These include:
The Output window in Workflow Studio.
The Workflow Trace tab in the Workflow Timer Service Administrator interface.
The Error and Workflow Trace tabs in the Diagnostics Console.
These three interfaces will record errors and other activity related to Workflow Studio. There
are some configuration steps necessary for Workflow Studio to log information to the
Diagnostics Console and the Output window.
For more information about the Output window, see Output Window on page 476. For more
information about the Workflow Timer Service Administrator interface, see the Workflow
Timer Service MRG. For more information about the Diagnostics Console, see the Diagnostics
Console MRG.
2012 Hyland Software, Inc.
1080
OnBase 12 Workflow
<Logs>
<Log name="workflow-profile" enableMailSlot="true"/>
</Logs>
In a typical installation, this file is found in the following location:
Language Support
Workflow Studio will respect the regional settings of a workstation. In addition, you can set
the <DisplayLanguage> setting in wfstudio.exe.config to set the interface to a specific
language.
Note: Only the following languages have full support for generating documentation from
Workflow Studio in that language: Spanish, French, Arabic, Japanese, and Portuguese.
The following settings are available for Workflow Studio to language settings at the
application level.
DisplayLanguage
The interface is displayed in the Windows default operating system
language.
To display the interface, including the calendar, in a language different
from the default operating system language, type the language code,
such as de-DE for German or fr-FR for French. For more information on
language codes, see http://msdn.microsoft.com/en-us/library/
ms533052(VS.85).aspx.
Note: This setting is commented out by default. This means that this
setting cannot be used until you remove the <!-- preceding
<DisplayLanguage> and the --> following </DisplayLanguage>.
2012 Hyland Software, Inc.
1081
Workflow OnBase 12
Culture
The interface displays dates, time, currency, and numeric values using
the default Windows locale settings configured in Regional and Language
Options.
Workflow Studio Installation
To override the default Windows locale in the interface, set the Culture to
an ISO code such as de-CH for German (Switzerland).
Note: This setting is commented out by default. This means that this
setting cannot be used until you remove the <!-- preceding <Culture>
and the --> following </Culture>.
Contacting Support
When contacting your solution provider, please provide the following information:
The OnBase module where the issue was encountered.
The OnBase version and build (Example: 12.571) and/or the Core Services version
and build (Example: 12.6).
The type and version of the connected database, such as Microsoft SQL Server 2008
or Oracle 11g, and any Service Packs that have been installed.
The operating system that the workstation is running on, such as Windows XP or
Windows Server 2008, and any Service Packs that have been installed. Check the
supported operating systems for this module to ensure that the operating system is
supported.
The name and version of any application related to the issue.
The version of Internet Explorer, and any Service Packs that have been installed, if
applicable.
A complete description of the problem, including actions leading up to the issue.
Screenshots of any error messages.
Supplied with the above information, your solution provider can better assist you in correcting
the issue.
2012 Hyland Software, Inc.
1082
CONFIGURING THE DISTRIBUTION SERVICE
Overview
The Hyland Distribution Service is a Core Services component that integrates with several
OnBase modules, allowing e-mail 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 e-mail when it receives a
new notification. The service then sends the e-mail 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 e-mails, 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 1087.
2012 Hyland Software, Inc.
1083
Workflow OnBase 12
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
Configuring the Distribution Service
about using the Hyland Components Installer. For manual installation steps, see the following
topic.
2012 Hyland Software, Inc.
1084
OnBase 12 Workflow
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 1092.
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 1087.
Note: For increased security, encrypt the Service Accounts user name and
password in the system registry. See Encrypting the Service Account's
Credentials on page 1091.
institution (Optional)
For institutional databases, add the parameter institution="99" (where 99
is the Service Accounts institution number).
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.
2012 Hyland Software, Inc.
1085
Workflow OnBase 12
Setting Description
Configuring the Distribution Service
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 1094.
Note: Do not modify the faxSettings element. The faxImageType setting must retain its default
value for the Hyland Distribution Service to function properly.
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 logon 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.
2012 Hyland Software, Inc.
1086
OnBase 12 Workflow
Running a Command
This is the preferred method for uninstalling the Distribution Service.
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.
2012 Hyland Software, Inc.
1087
Workflow OnBase 12
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.
2012 Hyland Software, Inc.
1088
OnBase 12 Workflow
Caution: The Service Account check box should never be selected with an account that is being
used to run OnBase 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.
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.
2012 Hyland Software, Inc.
1089
Workflow OnBase 12
Note: When sending an attachment, the Distribution Service always uses the documents
Auto-Name for the attachments file name. The Global Client Setting Use Auto-Name string for
external e-mail attachments does not apply to attachments sent by the Distribution Service.
2012 Hyland Software, Inc.
1090
OnBase 12 Workflow
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.
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\ASPNET_S
ETREG. 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.
In a 64-bit environment, this files default location is
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_SET
REG,userName"
b. Replace the password value with the following:
2012 Hyland Software, Inc.
1091
Workflow OnBase 12
"registry:HKLM\SOFTWARE\Hyland\DistributionService\Identity\ASPNET_SET
REG,password"
When you are finished, the securitySettings element should resemble the following:
Configuring the Distribution Service
2012 Hyland Software, Inc.
1092
OnBase 12 Workflow
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
4. For each securitySettings element, change the datasource value to the name of the
data source that the service needs to access.
5. For each securitySettings element, change the username and password values to reflect
the service account credentials for each data source.
Users who trigger notifications must have valid e-mail 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.
2012 Hyland Software, Inc.
1093
Workflow OnBase 12
The defaultSender setting can be overridden by modules like Workflow and WorkView, which
allow you to configure the sender address for notifications.
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.
The following values are supported:
QuotedPrintableOffers full compatibility with Microsoft Outlook.
RFC2231Latest standard, not supported by Outlook.
Raw8BitDisplays unencoded file names, which may be inappropriate for names
containing non-ASCII characters.
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.
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.
Troubleshooting
The following troubleshooting information may help you diagnose and resolve issues with the
Hyland Distribution Service.
2012 Hyland Software, Inc.
1094
OnBase 12 Workflow
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.
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 e-mail
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 e-mail 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.
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 1098.
2012 Hyland Software, Inc.
1095
Workflow OnBase 12
2012 Hyland Software, Inc.
1096
OnBase 12 Workflow
"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.
Version Mismatch
If you find that messages are not being sent, but no errors are logged, then you may be using
a version of the Distribution Service that is incompatible with your current version of OnBase.
Ensure the Distribution Service is upgraded to the same version as the rest of your OnBase
solution.
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.
In a 32-bit environment, this files default location is
C:\Program Files\Hyland\Services\Distribution.
In a 64-bit environment, this files default location is
C:\Program Files (x86)\Hyland\Services\Distribution.
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" >
2012 Hyland Software, Inc.
1097
Workflow OnBase 12
label them with the generic MIME type application/octet-stream. As long as the
attachment name still ends with .html, e-mail clients should handle the E-Form
documents correctly.
For a description of configurable attributes for the ContentTypeOverride element, see
the following table:
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.
2012 Hyland Software, Inc.
1098
LICENSING FOR CUSTOMERS PREVIOUS TO 2007
The licenses listed in this section are relevant to customers who purchased Workflow software
before January 1, 2007.
Workflow Licensing
A Workflow license is required to configure life cycles as well as to perform Workflow activity.
In order to create Workflow life cycles, you must have any one of the following licenses:
Workflow Departmental Server
Workflow Enterprise Server
Document Distribution
In order to use configured life cycles, users must have one of the following licenses available:
Workflow Concurrent Client
Workflow Workstation Client
Workflow Named Client
If you plan to utilize timers in a Workflow, you must have one of the server licenses. When
using HTML forms that will be stored in OnBase as part of a Workflow you must also be
licensed for the E-Forms module.
2012 Hyland Software, Inc.
1099
Workflow OnBase 12
To access the User Settings dialog box and configure a user for combined licensing:
2012 Hyland Software, Inc.
1100