WorkView

Version 11.0.0
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 document’s
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.
©
2011 Hyland Software, Inc. All rights reserved.
Depending on the modules licensed, The OnBase® Information Management System software may contain portions of:
Imaging technology, Copyright © Snowbound Software Corporation; CD-R technology, Copyright © Sonic Solutions; CD-R
technology, Copyright © Rimage Corporation; OCR technology, Copyright © Nuance Corporation; Mail interface
technology, Copyright © Intuitive Data Solutions; Electronic signature technology, Copyright © Silanis Technology, Inc.;
Full text search technology, Office core assembly, ASP.NET extensions, application blocks, smart client architecture, Object
Builder, and WPF controls, Copyright © Microsoft Corporation; Full Text Indexing technology, Copyright © Verity, Inc.;
SYBASE Adaptive Server Anywhere Desktop Runtime, Copyright © SYBASE, Inc., portions Copyright © Rational Systems,
Inc.; ISIS technology, Copyright © EMC Corporation; JLex technology, Copyright © 1996-2003 by Elliot Joel Berk and C.
Scott Ananian; A2iA CheckReader, Copyright © A2iA; Terminal emulation technology, Copyright © Attachmate; User
interface controls, Copyright © Infragistics; Terminal emulation technology, Copyright © NetManage; CAD document
technology, Copyright © Open Text Corporation; ISIS scanning interface, Copyright © Pegasus Imaging Corporation; CD/
DVD burner technology, Copyright © Prassi Software Incorporated; Code obfuscation technology, Copyright ©
PreEmptive Solutions; Icon library, Copyright © Professional Icons; OSA dlls, Copyright © Sharp Electronics Corp.; JAVA
components, Copyright © Sun Microsystems; Signature pad technology, Copyright © Topaz Systems Incorporated; and User
interface tools, Copyright © Xceed Software, Incorporated.
Portions of the OnBase® software modules may be covered by one or more of the following U.S. Patents: 7,644,091 and
7,765,271. Portions contained within OnBase® are licensed by U.S. Patent Nos. 6,094,505; 5,768,416; 5,625,465 and
5,258,855.
Hyland Software® and OnBase® are registered trademarks of Hyland Software, Inc. Application Enabler™ is an
unregistered trademark of Hyland Software, Inc. EMC Centera® is a registered trademark of EMC Corporation. All other
trademarks, service marks, trade names and products of other companies are the property of their respective owners.

Attribute Detail

Document Name WorkView

Department/Group Documentation

Revision Number 11.0.0

Part Number WVRM-11.0.0- -OB

©
2011 Hyland Software, Inc.
ii
WorkView Table of Contents

Exposure
OVERVIEW .................................................................................................................1
How It Works........................................................................................................................................1
APPLICATIONS .......................................................................................................... 4
LICENSING ............................................................................................................... 5
Combined Workflow/WorkView Licensing ....................................................................................5
How Combined Licensing Works .........................................................................5
WorkView Privilege..............................................................................................................................6
ObjectPop Licensing ............................................................................................................................6
FilterPop Licensing...............................................................................................................................7

Usage
USAGE ...................................................................................................................... 9
IN THE WEB CLIENT ............................................................................................... 9
DOCUMENT VIEWER OPTIONS ............................................................................... 11
IN THE ONBASE CLIENT ........................................................................................12
Register the Workstation .................................................................................................................. 13
Clearing Excess Registrations ............................................................................. 16
Workstation Cleanup......................................................................................................................... 16
View Current Users ........................................................................................................................... 16
Clean Up ............................................................................................................... 17
OPENING AN APPLICATION ....................................................................................17
USING THE CALENDAR VIEW .................................................................................18
Choosing Display Type..................................................................................................................... 18
Selecting Filters .................................................................................................................................. 19
Split Screen View ............................................................................................................................... 19
Navigating the Calendar.................................................................................................................... 19
Opening Objects................................................................................................................................ 20
Printing Objects ................................................................................................................................. 20
USING FILTERS WITHIN WORKVIEW .................................................................... 20
Search Operators .................................................................................................. 22
Searching Columns .............................................................................................. 22
Grouping Objects ................................................................................................. 23
Creating User-Defined Filters.......................................................................................................... 24
Columns Tab ........................................................................................................ 25
User Entry Tab ..................................................................................................... 25
Fixed Constraints Tab ......................................................................................... 26
Sort Tab ................................................................................................................ 27

©
2011 Hyland Software, Inc.
iii
Table of Contents WorkView

Editing User-Defined Filters............................................................................................................ 28

Deleting User-Defined Filters.......................................................................................................... 29
USING FILTERS FROM THE CLIENT ...................................................................... 29
USING SUBFILTERS ................................................................................................ 30
USING COLUMNS ....................................................................................................31
Sorting.................................................................................................................................................. 31
Searching ............................................................................................................................................. 32
WILDCARD OPERATORS ......................................................................................... 32
OPENING OBJECTS IN RESULTS LIST .................................................................... 32
Pinning Objects.................................................................................................................................. 33
Split Screen View ............................................................................................................................... 34
Opening Objects in New Windows................................................................................................ 34
PRINTING RESULTS LISTS...................................................................................... 34
EXPORTING FILTER RESULTS TO AN EXCEL SPREADSHEET ................................ 35
DELETING OBJECTS IN RESULTS LIST .................................................................. 35
DATE AND DATE/TIME ATTRIBUTES ................................................................... 36
HYPERLINKS .......................................................................................................... 36
CREATING OBJECTS WITHIN WORKVIEW ............................................................. 36
Tabs...................................................................................................................................................... 37
Saving................................................................................................................................................... 38
Editing ................................................................................................................................................. 39
Cancelling ............................................................................................................................................ 39
Deleting ............................................................................................................................................... 39
CREATING OBJECTS FROM WITHIN OBJECTS ....................................................... 40
CREATING OBJECTS FROM THE CLIENT ................................................................41
CREATING NEW OBJECT BY COPYING EXISTING OBJECTS ...................................41
CREATING NEW OBJECT BY EXTENDING AN EXISTING OBJECT ......................... 42
EDIT MODE ........................................................................................................... 42
Relating Objects ................................................................................................................................. 43
Adding Rows ...................................................................................................................................... 43
SHORTCUT KEYS FOR OPEN OBJECTS ................................................................... 44
ASSOCIATING OBJECTS........................................................................................... 44
FIELD BUTTONS .................................................................................................... 45
Datasets ............................................................................................................................................... 46
Calendars ............................................................................................................................................. 46
Lookups............................................................................................................................................... 47
Creating Objects From Within Lookup Results .................................................. 48
Clearing a Relationship Value for an Attribute ................................................... 49
Formatted Text .................................................................................................................................. 50

©2011 Hyland Software, Inc.

iv
WorkView Table of Contents

Spell Check ........................................................................................................... 54

Inserting Horizontal Rules .................................................................................. 55
Inserting and Formatting Tables ......................................................................... 56
Modifying Table Cells ...........................................................................................................58
Inserting Hyperlinks ............................................................................................ 59
Using Find and Replace ...................................................................................... 59
Color Control ........................................................................................................ 60
WORKING WITH RELATED DOCUMENTS ................................................................61
Attaching Documents Using the Documents Tab ....................................................................... 61
Attaching an Existing Document ........................................................................ 61
Creating and Attaching New Documents ........................................................... 62
Attaching Documents Embedded in a View................................................................................. 66
Attaching an Existing Document ........................................................................ 66
Creating and Attaching New Documents ........................................................... 66
Opening Documents......................................................................................................................... 69
Deleting Documents ......................................................................................................................... 69
Using Folders...................................................................................................................................... 70
Folders Embedded Within Views ................................................................................................... 70
CREATING AN E-FORM FROM WITHIN AN OBJECT ...............................................71
USING ACTIONS ..................................................................................................... 72
USING THE DOCUMENT COMPOSITION FOR MICROSOFT WORD MODULE IN
WORKVIEW ............................................................................................................ 72

WorkView Unity Usage

USAGE .................................................................................................................... 75
Accessing WorkView in the Unity Client....................................................................................... 75
OPENING AN APPLICATION ................................................................................... 76
USING THE CALENDAR VIEW ................................................................................ 77
Choosing Display Type..................................................................................................................... 78
Selecting Filters .................................................................................................................................. 78
Navigating the Calendar.................................................................................................................... 79
Opening Objects................................................................................................................................ 79
Creating Objects within the Calendar View................................................................................... 79
Refreshing the Calendar View.......................................................................................................... 80
USING FILTERS WITHIN WORKVIEW .................................................................... 80
Enabling Search Fields ........................................................................................ 82
Search Operators .................................................................................................. 83
Datasets ................................................................................................................ 83
Filter Tabs ............................................................................................................ 84
Retrieving More Object Results .......................................................................... 85

©
2011 Hyland Software, Inc.
v
Table of Contents WorkView

Grouping Objects ................................................................................................. 86

Customizing the Filter’s Display ......................................................................... 87
Resizing Columns ..................................................................................................................87
Moving Columns ...................................................................................................................87
Choosing Columns ................................................................................................................88
Filter Settings ....................................................................................................... 88
Refreshing Filters ................................................................................................. 89
Creating User-Defined Filters.......................................................................................................... 89
Columns ............................................................................................................... 90
User Entry Attributes ........................................................................................... 91
Fixed Constraints ................................................................................................. 92
Sort Tab ................................................................................................................ 94
Editing User-Defined Filters............................................................................................................ 94
Deleting User-Defined Filters.......................................................................................................... 95
USING SUBFILTERS ................................................................................................ 95
USING COLUMNS ................................................................................................... 96
Sorting.................................................................................................................................................. 97
Searching ............................................................................................................................................. 97
Column Search Options ....................................................................................... 98
OPENING OBJECTS IN RESULTS LIST .................................................................... 99
Pinning Objects.................................................................................................................................. 99
PRINTING RESULTS LISTS..................................................................................... 100
Print Preview .................................................................................................................................... 100
EXPORTING FILTER RESULTS TO AN EXCEL SPREADSHEET ............................... 103
CREATING OBJECTS WITHIN A FILTER TAB ......................................................... 103
DELETING OBJECTS IN RESULTS LIST ................................................................. 104
RECENTLY VIEWED ITEMS ................................................................................... 105
FAVORITES ............................................................................................................ 105
Creating Favorites............................................................................................................................ 105
Viewing Favorites ............................................................................................................................ 105
Working with Favorites................................................................................................................... 106
Editing Favorites .................................................................................................107
Deleting Favorites ...............................................................................................107
Arranging Favorites .............................................................................................107
CREATING OBJECTS WITHIN WORKVIEW ............................................................ 108
Tabs.................................................................................................................................................... 109
Saving................................................................................................................................................. 110
Editing ............................................................................................................................................... 111
Cancelling .......................................................................................................................................... 111
Deleting ............................................................................................................................................. 111

©2011 Hyland Software, Inc.

vi
WorkView Table of Contents

DATE AND DATE/TIME ATTRIBUTES .................................................................. 112

HYPERLINKS ......................................................................................................... 112
CREATING OBJECTS FROM WITHIN OBJECTS ...................................................... 112
CREATING NEW OBJECT BY COPYING EXISTING OBJECTS ................................. 113
CREATING NEW OBJECT BY EXTENDING AN EXISTING OBJECT ........................ 113
EDIT MODE .......................................................................................................... 114
Relating Objects ............................................................................................................................... 115
Adding Rows .................................................................................................................................... 115
SHORTCUT KEYS FOR OPEN OBJECTS .................................................................. 115
ASSOCIATING OBJECTS.......................................................................................... 116
FIELD BUTTONS ................................................................................................... 117
Datasets ............................................................................................................................................. 117
Calendars ........................................................................................................................................... 118
Lookups............................................................................................................................................. 119
Creating Objects From Within Lookup Results .................................................120
Clearing a Relationship Value for an Attribute ..................................................121
Formatted Text ................................................................................................................................ 122
Spell Check ..........................................................................................................126
Inserting Horizontal Rules .................................................................................127
Inserting and Formatting Tables ........................................................................128
Modifying Table Cells .........................................................................................................130
Inserting Hyperlinks ...........................................................................................131
Using Find and Replace .....................................................................................131
Color Control .......................................................................................................132
WORKING WITH RELATED DOCUMENTS .............................................................. 133
Attaching Documents Using the Documents Tab ..................................................................... 133
Attaching an Existing Document .......................................................................133
Creating and Attaching New Documents ..........................................................134
Attaching Documents Embedded in a View............................................................................... 138
Attaching an Existing Document .......................................................................138
Creating and Attaching New Documents ..........................................................138
Opening Documents....................................................................................................................... 141
Deleting Documents ....................................................................................................................... 141
Using Folders.................................................................................................................................... 142
Folders Embedded Within Views ................................................................................................. 142
CREATING AN E-FORM FROM WITHIN AN OBJECT ............................................. 143
USING ACTIONS .................................................................................................... 144
USING THE DOCUMENT COMPOSITION FOR MICROSOFT WORD MODULE IN
WORKVIEW ........................................................................................................... 144
USING FILTERS FROM THE UNITY CLIENT ......................................................... 145
CREATING OBJECTS FROM THE UNITY CLIENT .................................................. 146

©
2011 Hyland Software, Inc.
vii
Table of Contents WorkView

FULL TEXT SEARCHING........................................................................................ 146

Conducting Additional Searches Within the Full Text Search Dialog Box .......147
Advanced Options ...............................................................................................148
Search Type ..........................................................................................................................148
Output Format .....................................................................................................................148
Date Options ........................................................................................................................149
Search Modes .......................................................................................................................149
Specific classes to search ....................................................................................................150

Configuration
USER RIGHTS WITHIN THE CONFIGURATION MODULE ..................................... 151
OPENING THE WORKVIEW CONFIGURATION TOOL AND CONNECTING TO A DATA-
BASE ...................................................................................................................... 152
WorkView Configuration Screen .................................................................................................. 155
Left Pane Right-Click Menu........................................................................................................... 156
Options.............................................................................................................................................. 157
SHARED OBJECTS .................................................................................................. 158
WEB SERVER CONNECTION SETUP ...................................................................... 160
APPLICATION CONFIGURATION OVERVIEW ......................................................... 162
CREATING APPLICATIONS ..................................................................................... 163
Application Right-Click Menu ....................................................................................................... 164
Cloning Applications....................................................................................................................... 165
Making Applications Read-Only ................................................................................................... 166
Configuring Application Scripts .................................................................................................... 167
Core Services Scripting (VBScript) .....................................................................167
Unity WorkView Scripting ..................................................................................167
Creating Calendars........................................................................................................................... 169
Assigning a Calendar to an Application ....................................................................................... 170
Configuring a Default Filter ........................................................................................................... 170
Configuring User-Defined Filters ................................................................................................. 171
Configuring Favorites and Recently Viewed ............................................................................... 172
Application Resources..................................................................................................................... 173
CREATING CLASSES ............................................................................................... 173
Sharing Existing Classes.................................................................................................................. 179
Deleting Classes ............................................................................................................................... 179
Deleting Data From a Class ........................................................................................................... 180
Setting the Default Document Types ........................................................................................... 181
Creating Association Classes.......................................................................................................... 182
Creating the Class ...............................................................................................183

©2011 Hyland Software, Inc.

viii
WorkView Table of Contents

Creating the Filter for an Association Class .......................................................184

Placing the Filter on a View in the View Designer For An Association Class ...184
Creating Extension Classes ............................................................................................................ 185
Transforming Existing Extended Class Object .................................................187
Allowing Users to Extend Base Objects from an Action ....................................188
Allowing Users to Create Objects Based on Extended Classes .........................188
Advanced Tab .....................................................................................................188
Extension Options ..............................................................................................189
Base Class Options ..............................................................................................................190
Extended Class Options .....................................................................................................190
Sequencing Classes .......................................................................................................................... 192
Creating External Classes ............................................................................................................... 192
External Class Requirements ......................................................................................................... 194
HSI Database User .............................................................................................194
Attributes .............................................................................................................194
Configuring External Classes ......................................................................................................... 195
Connection ..........................................................................................................195
Configuring a Linked Server ...............................................................................198
Attributes ............................................................................................................ 200
Screen ................................................................................................................. 202
Configuring the Class Title............................................................................................................. 202
Class Title Items ................................................................................................ 204
Updating Class Titles ......................................................................................... 204
CREATING ATTRIBUTES ........................................................................................205
Default Values .....................................................................................................210
Creating Sequences .............................................................................................212
Datasets ...............................................................................................................213
Editing Existing Dataset Values ........................................................................................218
Identifying Where Datasets are Used ...............................................................................219
Parent Data Sets ..................................................................................................219
External Datasets ............................................................................................... 220
Indexing ............................................................................................................. 224
Moving and Deleting Attributes ........................................................................ 225
Editing Attribute Limitations ............................................................................ 225
Determining Where Attributes Are Used .......................................................... 226
Sorting ................................................................................................................ 226
CONFIGURING FILTERS AND FILTER BARS ..........................................................226
Filters ................................................................................................................................................. 226
Configuring Filters for Document Types .......................................................... 228
View Attributes Tab ........................................................................................... 229
User Entry Constraints Tab ................................................................................231
Fixed Constraints Tab ....................................................................................... 232
Sorting Tab ......................................................................................................... 234

©
2011 Hyland Software, Inc.
ix
Table of Contents WorkView

Advanced Tab .................................................................................................... 235

Editing an Existing Filter................................................................................................................ 236
Copying an Existing Filter.............................................................................................................. 237
Filter Bars .......................................................................................................................................... 237
Editing Filter Bar Item.................................................................................................................... 240
Creating Subfilters............................................................................................................................ 240
Moving and Deleting Filters and Filter Bars ............................................................................... 242
Deleting User-Defined Filter Bars ..................................................................... 243
CREATING NOTIFICATIONS ..................................................................................243
Using ObjectPop in Notifications................................................................................................. 247
Deleting a Notification.................................................................................................................... 247
Object Events................................................................................................................................... 248
Condition Test Options.................................................................................................................. 248
Creating Message Templates.......................................................................................................... 251
Configuring Templates Options ........................................................................ 252
Using HTML in Templates ................................................................................................253
Adding Macros to a Template ...........................................................................................253
Current User............................................................................................................................253
Date/Time ..............................................................................................................................253
Filters ......................................................................................................................................255
Attributes ................................................................................................................................256
Data Value Insertion Tags .................................................................................................257
Iterative Tags ........................................................................................................................259
CREATING TIMERS ................................................................................................260
Timer Windows................................................................................................................................ 263
CONFIGURING SCREENS .......................................................................................265
The Screen Tab ................................................................................................................................ 266
Configuring the Screen Title .............................................................................. 267
The Views Tab ................................................................................................................................. 268
Saving Views With Associated Keyboard Shortcuts .......................................... 269
Redirecting Views .............................................................................................. 269
Defining the Editor Version .......................................................................................................... 271
Updating Views ................................................................................................................................ 271
WorkView Designer ........................................................................................................................ 272
Creating a View .................................................................................................. 272
Designer Window ............................................................................................... 274
View Menu ......................................................................................................... 275
View Explorer ..................................................................................................... 276
Configuring Styles .............................................................................................. 276
Generating the Style Sheet .................................................................................................280
Restoring the Default Style Sheet ...................................................................... 280

©2011 Hyland Software, Inc.

x
WorkView Table of Contents

View Controls ..................................................................................................... 280

Navigation Toolbox ............................................................................................281
Layout Controls ...................................................................................................281
WorkView Controls .............................................................................................281
Properties ........................................................................................................... 282
General ..................................................................................................................................282
Tables ....................................................................................................................................283
Separators ..............................................................................................................................284
Containers .............................................................................................................................285
Labels .....................................................................................................................................285
Line Breaks ...........................................................................................................................286
Image .....................................................................................................................................286
Hyperlink ..............................................................................................................................287
Actions ..................................................................................................................................287
Attributes ..............................................................................................................................288
Document Attribute ............................................................................................................291
Filters .....................................................................................................................................292
Inserting an Association Filter..................................................................................................295
Folders ...................................................................................................................................295
Style Collection Editor ........................................................................................................296
View Script Properties ........................................................................................................297
Attribute Script Properties .................................................................................................297
Embedded Filter Script Properties ...................................................................................298
Defining Scripts ...................................................................................................................298
Inserting Controls in the View ........................................................................... 298
Tables ....................................................................................................................................300
Images ...................................................................................................................................300
Cutting and Pasting Controls ............................................................................ 300
Deleting Controls ................................................................................................301
Configuring Actions in the Designer ..................................................................301
Redirecting Views Within the Designer ............................................................ 302
Printing a View ................................................................................................... 302
Saving a View ..................................................................................................... 302
User Group Security ........................................................................................... 303
Editing an Existing View ................................................................................... 303
The Actions Tab .............................................................................................................................. 303
Configuring an Execute VBScript Action Type ................................................ 307
Configuring a Modify Attribute Action Type .................................................... 308
Configuring an Execute List of Actions Action Type ....................................... 309
Configuring a Send Notification Action Type ....................................................310
Configuring E-Form Related Action Types .......................................................311
Configuring Extended Class Action Types ........................................................311
Configuring Display Template Actions ..............................................................311
Using HTML in Templates ................................................................................................316

©
2011 Hyland Software, Inc.
xi
Table of Contents WorkView

Adding Macros to a Template ...........................................................................................317

Current User............................................................................................................................317
Date/Time ..............................................................................................................................317
Filters ......................................................................................................................................318
Attributes ................................................................................................................................320
Data Value Insertion Tags .................................................................................................320
Iterative Tags ........................................................................................................................323
Configuring Execute Unity Scripts Actions ...................................................... 324
Assigning Actions to Specific Views .................................................................. 324
Screen Advanced Tab...................................................................................................................... 326
CLASS ADVANCED TAB ..........................................................................................327
Associating E-forms with Classes ................................................................................................. 328
Granting Appropriate Rights for E-Form Creation ........................................... 329
Associating Document Types With Classes ................................................................................ 330
Creating Keytype Maps................................................................................................................... 331
Mapping an Attribute to a Keyword Type ..........................................................331
Mapping a Static Value to a Keyword Type ...................................................... 332
Configuring Related Objects to Create Automatically............................................................... 333
Configuring Dynamic Folders for Classes ................................................................................... 335
Configuring Application and Class Level Scripts........................................................................ 337
VBScripts ............................................................................................................ 337
Unity Scripts ....................................................................................................... 339
CONTROLLING SECURITY ..................................................................................... 341
Configuring Security Attributes ..................................................................................................... 343
Assigning Security Attributes to a User Group .................................................. 345
Using Application-Defined Identity to Determine Rights ........................................................ 347
Specifying Identification Parameters ................................................................. 348
Configuring Security Attributes: Traversing Associations......................................................... 349
Understanding Syntax ........................................................................................ 349
Specifying attributes .......................................................................................... 349
Setting Up User Identification ...........................................................................................349
Specifying Class Security Attributes .................................................................................350
Specifying User Security Attributes ..................................................................................354
Creating Security Attributes ............................................................................... 357
Determining User Groups .................................................................................. 358
Configuring Related Attributes for ~Identity ............................................................................. 359
Configure a Class Security Attribute .................................................................. 360
Configure a User Group Security Attribute ....................................................... 360
Controlling Object Creation Based on Security Attributes ....................................................... 360
EXPORTING AND IMPORTING APPLICATIONS ..................................................... 361
Exporting .......................................................................................................................................... 361

©2011 Hyland Software, Inc.

xii
WorkView Table of Contents

Copying Applications ...................................................................................................................... 362

Importing .......................................................................................................................................... 363
Importing Shared and Unshared Items ............................................................. 364
CREATING A DEFAULT VALUE FOR A RELATIONSHIP ATTRIBUTE ......................365
PURGING ...............................................................................................................366
Purging History Data ...................................................................................................................... 367
Purging Inactive and Deleted Objects.......................................................................................... 369
RECOVERING DELETED ITEMS ............................................................................370
CONFIGURING FULL TEXT CATALOGS .................................................................370
Deleting Attributes from a Catalog............................................................................................... 375
Deleting Class Data from a Catalog.............................................................................................. 376
Setting A Default Full Text Catalog.............................................................................................. 376
Automatically Updating Full Text Catalogs................................................................................. 377
PREVIEWING WORKVIEW CLIENT ........................................................................377
WORKVIEW CONFIGURATION TOOLBAR AND MENUS .........................................377
File Menu .......................................................................................................................................... 377
View Menu........................................................................................................................................ 377
Window Menu.................................................................................................................................. 378
Settings Menu ................................................................................................................................... 378
Import/Export Menu ..................................................................................................................... 379
Help Menu ........................................................................................................................................ 379
Toolbar .............................................................................................................................................. 379
WORKVIEW CONFIGURATION TOOL SHORTCUT KEYS ........................................380
Menu Bar Shortcuts......................................................................................................................... 380
Additional Shortcuts........................................................................................................................ 380
WEB.CONFIG FILES ............................................................................................... 381
WorkView Settings in the Web.config File.................................................................................. 381
Setting the Maximum Display Results .............................................................. 382
Setting WorkView to Open By Default .............................................................. 383
Displaying Logged In User ................................................................................ 383
WorkView Settings in the Application Server’s web.config File .............................................. 383
SYSTEM INTERACTION ..........................................................................................384

OnBase Client WorkView Configuration

CONFIGURING THE WORKVIEW ONBASE CLIENT INTEGRATION ......................385
Mapping to WorkView Page .......................................................................................................... 385
Application Server Overview ......................................................................................................... 386
Defining the Application Server ......................................................................... 386

©
2011 Hyland Software, Inc.
xiii
Table of Contents WorkView

Installation
REQUIREMENTS ....................................................................................................389
WorkView Unity Client Interface.................................................................................................. 389
WorkView Web Client Interface ................................................................................................... 389
WorkView Configuration Tool...................................................................................................... 389
Databases Supported By WorkView............................................................................................. 390
ODBC Driver Requirements for Oracle Databases................................................................... 392
About Virtual Environments ......................................................................................................... 392
64-Bit Support Statement ............................................................................................................... 393
Load Balancing ................................................................................................................................. 393
Exceptions .......................................................................................................... 393
Windows User Account Control Statement ................................................................................ 393
Modifying Configuration Files .......................................................................... 394
Installing ActiveX Controls ................................................................................ 394
Licensing ........................................................................................................................................... 395
PRE-INSTALLATION ..............................................................................................395
INSTALLATION ......................................................................................................395
Setting X-UA-Compatible HTTP Header Version .................................................................... 397
IIS 6.x Steps ........................................................................................................ 397
IIS 7.x Steps ........................................................................................................ 398
Settings for View Editor Views .......................................................................... 398
Setting Content Expiration............................................................................................................. 399
Consideration for SSL ........................................................................................ 400
Localization....................................................................................................................................... 400
COMMAND LINES ..................................................................................................400
TROUBLESHOOTING .............................................................................................400
Windows Event Viewer .................................................................................................................. 400
Diagnostic Console.......................................................................................................................... 401
Logging for the Context Search Framework ......................................................401
OnBase Client WorkView Integration.......................................................................................... 401
Exporting to Excel .......................................................................................................................... 402
Large Views....................................................................................................................................... 402
Title Bar............................................................................................................................................. 402
View Editor....................................................................................................................................... 403
Width and Height of Labels ........................................................................................................... 403
CONTACTING SUPPORT.........................................................................................403

©2011 Hyland Software, Inc.

xiv
WorkView Table of Contents

Actions with VBScripting

EXECUTING SCRIPTS .............................................................................................405
Modifying Attribute Values............................................................................................................ 405
EXECUTING OTHER ACTIONS ..............................................................................406
DEFAULT VALUES FOR ACTIONS ..........................................................................406
SPECIFYING A TIMEOUT .......................................................................................406

Advanced Fixed Constraints

Attribute Values ............................................................................................................................... 407

Importing and Exporting Objects

IMPORTING OBJECTS THROUGH THE CONFIGURATION TOOL INTERFACE .......409
Import File ........................................................................................................................................ 410
EXPORTING OBJECTS THROUGH SCRIPTING ....................................................... 411
Example 1: testexport.vbs .............................................................................................................. 411
Syntax of ExportObjects Call ........................................................................................................ 412
<var> and <value> Descriptions ........................................................................412
IMPORTING OBJECTS THROUGH SCRIPTING........................................................ 413
Syntax of ImportObjects Call ........................................................................................................ 413
Example 2: testimport.vbs.............................................................................................................. 413
Example 3: testimport.imp ............................................................................................................. 414
FORMAT OF IMPORT/EXPORT FILE ...................................................................... 415
Example 4: Example of updating a unique key value. ............................................................... 416

FilterPop
LICENSE USAGE FOR FILTERPOP ......................................................................... 419

Configuring the Distribution Service

OVERVIEW ............................................................................................................. 421
INSTALLATION ......................................................................................................422
Installing the Distribution Service Manually................................................................................ 422
Uninstalling the Distribution Service............................................................................................ 425
Running a Command ......................................................................................... 425
Stopping the Service and Removing Files ......................................................... 425
CONFIGURATION ..................................................................................................426

©
2011 Hyland Software, Inc.
xv
Table of Contents WorkView

Configuring a Service Account ...................................................................................................... 426

Enabling the Distribution Service ................................................................................................. 429
Users Configuration Requirements............................................................................................... 429
Encrypting the Service Account's Credentials............................................................................. 430
Changing Configuration File Settings........................................................................................... 431
Adding Support for Multiple Data Sources................................................................................. 432
Sending Notifications to Global Distribution Lists ................................................................... 433
Displaying the User Who Triggered the Notification as the Sender ....................................... 433
Supporting Non-ASCII Characters in Attachment File Names............................................... 433
Configuring the Distribution Service to Save Notifications as Text Files .............................. 434
Sending Unity Forms....................................................................................................................... 434
TROUBLESHOOTING .............................................................................................434
Logging Information to the Diagnostics Console ...................................................................... 434
Access to the path...is denied ......................................................................................................... 436
Error Loading Document: Attachments Are Not Sent ............................................................. 436
Messages Are Not Sent ................................................................................................................... 437
Workstation Registration Not Found ................................................................ 437
"No Count" Is On ............................................................................................. 437
Version Mismatch .............................................................................................. 438
Message Content and Attachments Are Reversed...................................................................... 438
Unity Forms Limitations................................................................................................................. 439
Windows User Account Control Statement ................................................................................ 440

Configuring The Hyland Timer Service

INSTALLATION ...................................................................................................... 441
Requirements.................................................................................................................................... 441
Installing the Timer Service Using an Installer ........................................................................... 441
Installing the Timer Service Manually .......................................................................................... 442
Encrypting User Names and Passwords ...................................................................................... 442
CONFIGURING LOGGING SETTINGS .....................................................................444
ONBASE TIMER CONSOLE....................................................................................445
Registering a Server ......................................................................................................................... 446
Managing Timers ............................................................................................................................. 448
Refreshing Connections.................................................................................................................. 449
Timer Properties .............................................................................................................................. 449
Viewing Information in the Diagnostic Console ........................................................................ 449
STARTING THE SERVICE .......................................................................................449
UNINSTALLING .....................................................................................................450

©2011 Hyland Software, Inc.

xvi
WorkView Table of Contents

Script Examples
FILTER SCRIPT EXAMPLE ..................................................................................... 451
Example............................................................................................................................................. 451
FILL FOLDER SCRIPT EXAMPLE ........................................................................... 451
Example............................................................................................................................................. 451

System Attributes
System Attributes............................................................................................................................. 453

Macros

Licensing for Customers previous to 2007

WorkView Licensing ....................................................................................................................... 457
Combined Workflow/WorkView Licensing ............................................................................... 457
How Combined Licensing Works ..................................................................... 457

SOX Appendix
ARCHIVING THE PREVIOUS YEAR’S APPLICATION AND CREATING THE NEXT
YEAR’S WORKING COPY ........................................................................................459

WorkView Best Practices

GENERAL DESIGN .................................................................................................463
GENERAL PERFORMANCE.....................................................................................469
SCRIPTING .............................................................................................................470

©
2011 Hyland Software, Inc.
xvii
Table of Contents WorkView

©2011 Hyland Software, Inc.

xviii
 EXPOSURE

OVERVIEW 1
WorkView is a point-and-click configurable application creation tool that allows you to
create customized solutions for tracking business interactions. WorkView lets you track
business issues and interactions, such as phone calls, e-mails and other events associated
with issue resolution. OnBase documents that support an issue can be attached to the
interaction and easily referenced by users.
For example, WorkView could be used in an Accounts Payable department to track
interactions associated with invoices, e-mails, phone conversations, and other events that
transpire between the accounts payable employee and a vendor. Records of these
transactions can be easily accessed in the future by any employee, speeding up an
organization’s ability to resolve issues.
Records of interaction can be searched for and retrieved based on criteria that you define.
For example, you may wish to search for all Accounts Payable interactions with a Status
of “open” or all issues that have been created within the last week.
A centralized method of tracking business interactions reduces duplication of effort,
improves communication and reduces errors. Each time a user enters information, the
entire organization benefits by allowing access to information regarding business
transactions.

How It Works
OnBase WorkView allows organizations to build and define an application through a
point-and-click configuration tool. Before configuration, define the following:
• The business problem to be solved.
• The type of information to be recorded for each interaction.
• The user interface of the application.
• The criteria by which you wish to search, categorize or group interactions (for
example, all payment issues that have not been resolved within 2 days).

©
2011 Hyland Software, Inc.
1
 WorkView OnBase 11.0.0

The OnBase WorkView product is integrated with the OnBase document management
system. WorkView data is stored in an OnBase database. In addition to storing WorkView
data, documents stored in an OnBase database can be attached to WorkView issues and
interactions. The WorkView security is also based on the same user group security defined in
1 OnBase.
The most important part of configuration is defining what you need your application to do.
Before you begin configuration, carefully chart the business process you wish to track and the
problems that you want your WorkView application to help solve. Configuration itself is a
simple process of defining the WorkView components described below.
The following components are used during creation of an application:

• Class:A category of items to be tracked within WorkView. For example, Accounts

Payable Issues.
• Class Title: The configured class title name will appear in the screens associated with
this class.
• Attribute: Information that further defines a Class. For example, Vendor Name,
Vendor Address, Status, Accounts Payable clerk name are all potential attributes for a
class. Attributes can be used to define filter columns and criteria. For example,
Accounts payable issues can be accessed based on issue status.
• Object: A specific collection of data belonging to a Class. Each object has its own set
of attribute values. For example, a dispute over a specific invoice can be an object.
Objects are created by users in the WorkView client, not during configuration, and
consist of pertinent data.
• Filter: A query that enables a user to search for objects of a particular class. Filters can
list all objects or limit the objects that are returned based on attribute values or can
prompt users for search parameter input. For example, you may wish to search for all
objects with a status of “open.”
• Filter Bar: Groups and names a set of one or more filters. Filter bars can be used to
effectively group related filters together. Each filter bar can have multiple filters
configured. Likewise, a filter can be displayed on multiple filter bars.
• View: Used to enter and display object data within a screen. A view is identified by a
single tab within a screen.
• Screen: Collection of views for a class. Each class has only one screen. The screen
collectively holds all object data displayed within views. It can consist of multiple
tabs/views. It always has a History tab and a Documents tab.
• Filter View Attributes: Displays column headings for attributes in a filter.

©
2011 Hyland Software, Inc.
2
OnBase 11.0.0 WorkView

• Filter User Entry Attributes: Attribute search fields that users will be able to enter
values into in order to retrieve objects using filters.
• Filter Fixed Constraints: Allows administrators to limit the filter results a user receives.
An administrator can add attributes and attribute values that must match in order for 1
objects to be displayed.
• Shared Objects: Shared objects consist of Data Sets, actions, sequences, calendars,
keytype maps, timers, and notifications that can be used by any application.

Examples of application screens follow:

©
2011 Hyland Software, Inc.
3
 WorkView OnBase 11.0.0

APPLICATIONS
WorkView is useful in many areas of business and in many different ways within those areas.
Examples of WorkView solutions include:
• An Accounts Receivable department for data involving customer issues, such as
invoices and purchase orders.
• An Accounts Payable department for data involving vendor issues, such as payable
invoices and requisitions.
• A Human Resources department for data involving employee issues, such as benefits,
evaluations, and certifications, to name a few.
• A Customer Service department for issue resolution.
• IT department for issues concerning internal systems and equipment.
• Healthcare for claims and patient billing information.
• A Loan Processing department for credit report problems and appraisal issues.
• Law Enforcement to track the status and progress of unresolved cases.

©
2011 Hyland Software, Inc.
4
OnBase 11.0.0 WorkView

LICENSING
A WorkView license is required to configure WorkView, access the WorkView Client, and to
benefit from WorkView functionality integrated with other modules. Effective January 1,
2007, one of the following licenses is required:
1
• WorkView Concurrent Client SL
• WorkView Workstation Client SL (only applicable to OnBase Client)
• WorkView Named User Client SL

In addition to one of these licenses, a valid Client license and a Web Server license are
required.
WorkView licenses are released upon exiting the Web Client.
If WorkView was purchased previous to January 1, 2007, see Licensing for Customers
previous to 2007 on page 457.

Combined Workflow/WorkView Licensing

If you are running both Workflow and WorkView, combined licenses can grant access to both
of the modules.
• Workflow/WorkView Concurrent Client SL
• Workflow/WorkView Workstation Client SL (only applicable to OnBase Client)
• Workflow/WorkView Named User Client SL

Note: Each of these licenses includes the E-Forms module.

How Combined Licensing Works

Combined licenses are only consumed by users that have been assigned to use combined
licenses in the User Settings dialog box. When a user is assigned to use combined licenses, he
or she will not be able to use a license for Workflow or WorkView that is not combined. If
non-combined licenses are available for consumption, access to the modules are not granted
until a combined license becomes available.
If a user that is assigned to use a combined license who is working on a workstation registered
for the use of one of the two products licensed by the combined license, only the product
registered will be available for use.

©
2011 Hyland Software, Inc.
5
 WorkView OnBase 11.0.0

If a user is not assigned to use combined licenses, the user will only be able to consume non-
combined licenses and will not consume combined licenses even when non-combined
licenses are not available.

1 To access the User Settings dialog box and configure a user for combined licensing:

1. From the Configuration module, select Users | User Names/Passwords.

2. Select the User Name and click Settings.
3. Select the Combined Workflow / WorkView License check box.
4. Click Save.
Once a combined license has been consumed, the license is not released until the Client is
restarted. If a combined license is revoked, it will still be consumed until the Client is
restarted. If the license is switched from a combined concurrent license to a concurrent
license for one of the products, it will still consume the combined concurrent until the Client
is restarted.
Check your current licensing status by selecting Utils | Product Licenses from the
Configuration module.

WorkView Privilege
In addition to a valid WorkView Client license, users must also be granted the WorkView user
privilege in the Configuration module. To grant the WorkView privilege:

1. In the Configuration module, select Users | User Groups/Rights. The User Groups &
Rights dialog box is displayed.

2. Select the appropriate user group and click Privileges. The Assigning User Group
Privileges for <User Group> dialog box is displayed.

3. Select the WorkView option under the Client Based Products section.

ObjectPop Licensing
ObjectPop uses a Concurrent Client license and a WorkView Concurrent license when an
object is opened by a single user. The same license will be used for multiple opened objects
until the standard timeout has been reached and the license is released.

©
2011 Hyland Software, Inc.
6
OnBase 11.0.0 WorkView

FilterPop Licensing
When a user logs in to FilterPop a Concurrent Client license is consumed. A WorkView
license will not be consumed until an object is opened from the filter. The same license will be
used for multiple opened objects until the standard timeout has been reached and the license 1
is released.

©
2011 Hyland Software, Inc.
7
 WorkView OnBase 11.0.0

©
2011 Hyland Software, Inc.
8
 USAGE

USAGE
WorkView is a point-and-click-configurable application generator that allows you to
create custom applications that meet your specific business needs. The type of
information that is tracked and displayed is completely configurable.

IN THE WEB CLIENT

The WorkView client depends entirely on the configuration, so every configuration will 2
yield unique results. This section will cover the possible components of the WorkView
client. You may or may not have all of the components described.

In order to access the WorkView client, you will need to log into the Web Client if
WorkView is not launched automatically. After successfully logging in, select WorkView
from the drop-down select list.

©
2011 Hyland Software, Inc.
9
 WorkView OnBase 11.0.0

When the WorkView client is opened, a screen similar to following is displayed:

©
2011 Hyland Software, Inc.
10
OnBase 11.0.0 WorkView

DOCUMENT VIEWER OPTIONS

Depending on your configuration, you may be able to specify how documents opened from
within a WorkView object’s Documents tab are displayed. To access document viewer options
for WorkView:

1. In the Web Client, select User from the context drop-down select list.
2. Select Viewer Options from the mode drop-down select list.

3. If you want documents to open in the same position on the screen, select Remember
Position.

4. If you want the same viewer to be used for each document that is opened, select Reuse
Existing. This option will use the open viewer to display the newly accessed document,
replacing the document that was currently being displayed.
5. When finished, click Save.

©
2011 Hyland Software, Inc.
11
 WorkView OnBase 11.0.0

IN THE ONBASE CLIENT

In order to launch the WorkView client from the OnBase Client interface, you must register
your workstation for the WorkView Concurrent Client SL or WorkView Workstation Client SL
license.
After you register your workstation for a WorkView product, a toolbar button becomes
available. Customize your toolbar to display the WorkView button. To add the Workview
button to the toolbar:

1. From the OnBase Client, select User | Toolbars | Customize Toolbar.

2. Select the WorkView button option and click Add>>.
2 3. Click Save. The following WorkView button is displayed in the toolbar.

To launch WorkView within the OnBase Client, click on the WorkView toolbar button or
select File | Open | WorkView.

©
2011 Hyland Software, Inc.
12
OnBase 11.0.0 WorkView

Register the Workstation

To register the workstation:

1. From the OnBase Client, click Admin | User Management | Workstation Registration.
The Products Registered for Workstation dialog box is displayed.

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:

Column Name Description

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.

©
2011 Hyland Software, Inc.
13
 WorkView OnBase 11.0.0

Column Name Description

Description Displays a short description of the individual workstation.

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.
2 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.

Tip: It is considered a best practice to register a processing workstation as a Named Client

rather than a Concurrent Client. This ensures that the processing workstation always has
access to the processing module; a workstation registered as a Concurrent Client cannot
access the processing module if another workstation is currently registered for it.

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.

3. When you have finished registering the workstation, click Exit.

©
2011 Hyland Software, Inc.
14
OnBase 11.0.0 WorkView

4. Verify registration—Select 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.

©
2011 Hyland Software, Inc.
15
 WorkView OnBase 11.0.0

Clearing Excess Registrations

The number of workstations you can register for a given module is dependent upon the
number of licenses you have purchased for that module. If you attempt to register a specific
module on more workstations than you have licenses for, the excess workstations will be
unable to use the module. When a user logs on to a workstation with one or more excess
product registrations, a warning will be displayed to inform them what modules will not work
on that workstation.
You can remove excess product registrations the same way you would remove a functional
product registration. From the Workstation Registration dialog box, select the workstation
that has excess product registrations.
Any products that are registered in excess of the licensing limit will contain the [Excess
2 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.
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.

View Current Users

View Current Users allows a user to view information about other OnBase users, including
the time a user logged onto the system and the type of license being consumed by that user’s
workstation.

©
2011 Hyland Software, Inc.
16
OnBase 11.0.0 WorkView

To view current user information, select Admin | User Management | View Current Users.
The Users Currently Logged In dialog box is displayed.

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.

OPENING AN APPLICATION
In order to access information, an application must be opened. If only one application is
configured, the application opens when the WorkView client is launched. If multiple
applications are configured the last application accessed in a previous WorkView session will
open. To open a different application, click the down arrow located in the top right-hand
corner of the screen and select an application. The name of the selected application is
displayed at the top of the pane. If the application name has more characters than can be
displayed on the screen at one time, ellipses will display at the end of the line. Hover over the
name to view the entire application name.

Note: If user rights for the last accessed application were revoked by the System
Administrator, a message stating You do not have rights to access this application will display.

©
2011 Hyland Software, Inc.
17
 WorkView OnBase 11.0.0

USING THE CALENDAR VIEW

The Calendar View can be accessed by clicking on the Calendar View button.

Note: If an application does not have a calendar associated, the Calendar View button is not
displayed for the application.

The Calendar View presents objects arranged by a designated date attribute. The following is
an example of a Calendar View:
2

Choosing Display Type

You can choose to display the calendar by month, week, or day. The following buttons are
available:

Button Description

Clicking this button will display the entire month for the calendar.
Month

Clicking this button will display an entire week for the calendar.
Week

©
2011 Hyland Software, Inc.
18
OnBase 11.0.0 WorkView

Button Description

Selecting a day in the calendar and clicking this button will

Day display the selected day.

Selecting Filters
To define the objects displayed, you must specify the filter you want to use. By default, all
filters that are associated with a calendar will be used.
To specify the filter(s) used:

1. Click on the Filters drop-down arrow in the upper left corner of the screen. A list of all of
the available filters is displayed.
2
2. Select the filter(s) you want to initiate. You can initiate all filters by selecting All.
3. Click the Execute Filter check mark. The objects found are displayed in the calendar on
the days to which they are associated.

To exit the dialog box without executing a filter, click the X button in the upper right hand
corner.

Split Screen View

You can view the calendar and an open object within the main screen by initiating the split
screen calendar view. To toggle between the full screen calendar view and split screen calendar
view, click the Split Screen/Full Screen Calendar button. When in the split screen view,
objects opened will display in the bottom half of the page. When in full screen mode, objects
will open in separate windows.

Navigating the Calendar

You can move to the previous or next month or week (depending on your configuration) by
clicking on the previous and next arrow buttons found at the top of the screen. The previous
and next buttons are the following:

©
2011 Hyland Software, Inc.
19
 WorkView OnBase 11.0.0

When viewing the calendar using the month view, you can also skip to previous and next
years of the same month displayed. The previous and next year buttons are the following:

Opening Objects
Any object displayed on a calendar can be opened by double-clicking on it. In addition, you
2 can view all of the descriptive information available for an object by hovering over it in the
calendar.

Printing Objects
You can print an open object by clicking the Print button.

Note: If you use File | Print, CTRL + P, or right-click and select Print, the entire object’s
contents will not be printed. Use the Print button to print objects.

USING FILTERS WITHIN WORKVIEW

Filters can be used to find specific objects within a class. Depending on how a filter is
configured, it will either perform a search when the filter is selected, or it will prompt you for
input.
To access a filter, click on a filter bar, and select a filter. Filter bars are used to group related
filters together. If there are more than 20 filter bars configured, a drop-down select list of
available filter bars is displayed. Select the filter bar you want to access from the drop-downs
select list.

©
2011 Hyland Software, Inc.
20
OnBase 11.0.0 WorkView

If filters are configured to display only specific results, you will be unable to specify search
criteria, and results will automatically display when the filter is selected. Depending on your
configuration, filters may display the number of objects that can be retrieved using each filter.
When this is available, the number of objects is displayed in parentheses next to the filters’
names in filter bars. Filters that require user input will never display an object count within the
filter bar’s count.
If filters are configured for user input, an input field displays when the filter is selected. Enter
the search parameters and click the Find button. In addition, some filters may have datasets
configured for the input fields. You can use the dataset to select a value to search upon.
The following is an example of a user input field for a filter:

If an attribute using a boolean data type is used for user input, a drop-down menu is displayed
and allows you to search by true or false values.
If you want to search for multiple values for the same attribute, click on the attribute name
and another field for the attribute will display. Use the AND and OR operators to specify the
appropriate search parameters.

©
2011 Hyland Software, Inc.
21
 WorkView OnBase 11.0.0

The following search operators are available for alphanumeric data type attributes used for
data entry in filters: =, <>, null, and !null. All other data type attributes used for data entry in
filters have the following operators available: =, <, >, <=, >=, >, null, and !null.

Search Operators

Operator Description

= Searches for an exact attribute match.

< Searches for attribute values that are less than the specified value.

> Searches for attribute values that are greater than the specified value.
2 <= Searches for attribute values that are less than or equal to the specified
value.

>= Searches for attribute values that are greater than or equal to the
specified value.

<> Searches for attribute values that are not equal to the specified value.

null Searches for all attribute values that do not contain a value.

!null Searches for all attribute values that contain any value.

Note: If you do not enter any values into the user input fields and attempt to search, the
following message will display: You are about to execute an unconstrained query. This may
take a while. Are you sure you want to continue with the search? The amount of time needed
to complete an unconstrained search is dependent on the number of objects in the class being
searched. Click Yes to continue the search or No to cancel the search.

Searching Columns
Once a filter is executed, you can search columns by entering information in the field at the
top of the filter. The following is an example of the search field:

You can click on the column in the search results to change the column searched. Click the
Search button to search for the entered criteria. To return to the initial search results list, click
the Clear Search button.

©
2011 Hyland Software, Inc.
22
OnBase 11.0.0 WorkView

Grouping Objects
The results list for a filter can be grouped by attribute value. Results can be grouped by an
attribute that is configured as a View Attribute that is used as a column in the filter. To group
filter results:

1. In the filter toolbar, click on the Group By down arrow. A list of attributes that can be
used for grouping is displayed.

2
Note: Depending on how an attribute is configured, it may not be available in the Group By
list.

2. Select the attribute you would like to group by. Objects are grouped by the values of the
selected attribute:

3. Click on the Expand arrow next to the group to view the objects within the group.

©
2011 Hyland Software, Inc.
23
 WorkView OnBase 11.0.0

Creating User-Defined Filters

Depending on your configuration, you may be able to define your own filters. User-defined
filters are specific to the user who configured them. Other users will not be able to see this
type of filter. When this is available, a filter bar looks like the following example:

To create a filter:
2 1. Click Configure filters. The Configure Filter screen is displayed.

2. From the Config Option drop-down select list, select Create New Filter.
3. Enter a Filter Name for the filter.
4. Select the class you want to associate the filter with from the Associated Class drop-down
select list.
5. Configure the Columns, User Entry, Fixed Constraints, and Sort tabs appropriately.
6. Click Save when all tabs are configured appropriately. The newly created filter will display
in the filter bar.

©
2011 Hyland Software, Inc.
24
OnBase 11.0.0 WorkView

Columns Tab
The Columns tab allows you to configure how filter search results will be displayed. Only the
attributes added to this tab will be displayed. If this tab is not configured, no data will be
displayed. If this is the only tab configured, all objects within the associated class will display
for this filter.

To configure the Columns tab:

1. Select the attribute(s) in the left column that you want to use to display object results.
2. Click Add.
3. To change the Column Heading that is displayed, click under the Column Heading column
in the attribute row. Enter the text you want to display as the heading.
4. Repeat steps 1-3 for each attribute you want to configure.

User Entry Tab

The User Entry tab allows you to configure the attribute search fields that users will be able to
enter values into to retrieve objects. One or many attribute search fields can be configured.

©
2011 Hyland Software, Inc.
25
 WorkView OnBase 11.0.0

To create user entry constraints:

1. Select the attribute(s) you want to allow users to search for specific values.
2. Click Add.
3. If you want to use a Data Set associated with an attribute, click under the Dataset column
in the attribute row to select Yes. Select No if you do not want to use a Data Set. The
Dataset drop-down menu is only available when a Data Set is assigned to the selected
attribute.
4. To change the value you would like to use as the prompt for the user entry attribute field
that is displayed, click under the Prompt column in the attribute row. Enter the text you
want to display as the heading.
2 5. Repeat steps 1-4 for each attribute you want to configure.

Fixed Constraints Tab

The Fixed Constraints tab configuration automatically limits the results a user receives in the
filter. Add attributes and attribute values that must match in order for objects to be displayed.
When a constraint is added to a filter, objects will only be found if they meet the criteria of
the constraint. One or many fixed constraints can be configured for a filter.

To create a fixed constraint:

1. Select the attribute(s) you want to allow users to search for specific values.
2. Click Add.

©
2011 Hyland Software, Inc.
26
OnBase 11.0.0 WorkView

3. Click under the Operator column in the attribute row. and select a mathematical operator
from the drop-down menu. The following operators are available: =, <, >, <=, >=, <>,
NULL, and NOT NULL. The NULL operator searches for attributes that do not have
any value. The NOT NULL operator searches for attributes that have any value. If
NULL or NOT NULL is selected, any value in the value field is ignored and listed in the
field as a blank string when it is added.
4. Click under the Value column in the attribute row and enter the value that the attribute
must meet in order for objects to be displayed.
5. Repeat steps 1-4 for all constraints you want to add.
In addition, complex fixed constraints can be configured. This can be accomplished by using
a combination of parentheses and AND/OR operators to construct complex queries.
Parentheses can be used to group constraint items together. To specify a parenthesis before a
2
constraint item, click the attribute row under the ( column. To specify a parenthesis after a
constraint item, click the attribute row under the ) column.
The Connector column allows you to specify how values are searched using the fixed
constraint items. AND is selected by default. If AND is selected, multiple fixed constraints
must be met in order for objects to be returned in the filter’s results. If OR is selected, one of
the fixed constraints items must be met in order for objects to be returned in the filter’s
results. You can use a combination of the AND and OR operators, coupled with the use of
parentheses in order to yield the desired results.

Sort Tab
The Sort tab allows you to specify what attribute(s) are used to sort, and if objects are sorted
in ascending or descending order according to the selected attribute(s),when filter results
display.

©
2011 Hyland Software, Inc.
27
 WorkView OnBase 11.0.0

To configure attributes for sorting:

1. Select the attribute(s) you want to allow users to sort.

2. Click Add.
3. To change the sorting order click the attribute row below the Order column.
4. Repeat steps 1-3 for each attribute you want to configure.

Editing User-Defined Filters

To editing an existing user-defined filter:

2 1. Click Configure filters. The Configure Filter screen is displayed.

2. From the Config Option drop-down select list, select Edit Existing Filter.
3. Select the appropriate filter from the Filter Name drop-down select list.
4. Edit the filter appropriately.
5. Click Save to save the filter using the existing name or click Save As to specify another
name to create a new filter.

Note: Clicking the Clear button clears all configured options.

©
2011 Hyland Software, Inc.
28
OnBase 11.0.0 WorkView

Deleting User-Defined Filters

1. Click Configure filters. The Configure Filter screen is displayed.

2
2. From the Config Option drop-down select list, select Edit Existing Filter.
3. Select the appropriate filter from the Filter Name drop-down select list.
4. Click the Delete button.
5. Click OK to confirm the deletion.

USING FILTERS FROM THE CLIENT

Filter queries can be run from open documents in the Client. The filters available for a
document are dependent on the filters associated with the Document Type to which the
document belongs. To run a filter query from an open document:

1. In the Client, open a document.

2. Right-click on the document and select WorkView | Execute Filter. The Execute Filter
dialog box will display. Alternately, in the Web Client, filters can be executed from PDF
and OLE documents by selecting Process | WorkView | Execute Filter from the menu.
3. Select the appropriate filter from the list of filters configured for the associated
Document Type.
4. Click OK. The results will display. Double-click on an object to open it.

Alternately, filters can be executed from documents within folders in WorkView. To execute a
filter from a folder:

1. Open a WorkView object.

2. Select the Documents tab.

©
2011 Hyland Software, Inc.
29
 WorkView OnBase 11.0.0

3. Select a folder.
4. Select a document, right-click and select Execute Filter.
5. Select the appropriate filter from the list of filters configured for the associated
Document Type.
6. Click OK. The results will display. Double-click on an object to open it.

USING SUBFILTERS
In some filters, you will be able to use a subfilter to further narrow down results. When a
subfilter is available, a small down arrow is displayed in the top right hand corner of the filter's
2 header. A subfilter allows you to view all objects that are related to the selected object within
another related filter. To use subfilters:

1. In a filter results list, select an object that you would like to view all related objects for.
2. Click the down arrow on the filter's header. When the arrow is hovered over a tooltip
displaying Execute Subfilter: Filter Name identifies the filter that will be executed when
the arrow is clicked upon.
3. A new filter will display all objects that are related to the selected object.
4. Repeat steps 1 to 3 for each subfilter you would like to use.

Any time that an object selected is unrelated to the first object selection, all of the subfilters
will clear.

Note: Only two filters can be displayed at once. If more than two filters are used to display a
set of objects, the additional filters that are above the displayed filters in the subfilter hierarchy
will collapse. The collapsed filters can be accessed at any time by clicking on the small left
arrow in the upper right hand corner of the filter's header.

©
2011 Hyland Software, Inc.
30
OnBase 11.0.0 WorkView

In the following example, a Departments filter has been accessed. The Technical Support
department was selected and the subfilter (Employee Class) was launched, displaying all of
the employees within the Technical Support department. An employee (Jim Technical) was
selected and the subfilter (Issues Class) was launched displaying all of the issues linked to the
selected employee.

USING COLUMNS
Filter results columns provide additional functionality. You can sort the results using the
column headers and you can search to further narrow down results using the column headers
and a search field.

Note: Depending on how an attribute is configured, it may not be possible to select the
attribute’s header for sorting.

Sorting
The filter results can be sorted alphabetically or in numeric order (depending on the data type
sorted) by simply clicking on one of the filter column headers. Results will be sorted
according to the column selected. If an "up" arrow is displayed next to the heading, results are
displayed in ascending order (A-Z or 1-100). If a "down" arrow is displayed next to the
heading, results are displayed in descending order (Z-A or 100-1).

Note: When numeric values are entered into an alphanumeric field, values will not be sorted
by numeric value.

©
2011 Hyland Software, Inc.
31
 WorkView OnBase 11.0.0

Searching
When a column header is clicked, a column search field displays at the bottom of the results.
To search, enter the search parameter in the field and click the Search icon to the right of the
field. Results will be a subset of the results that were displayed. If an object exists and it was
not in the original results list, the object will not display if searched for using this method.

2 WILDCARD OPERATORS
You can search using wildcard operators in the keyword field. A wildcard is a special character
or character sequence, which is used to match text in a comparison. This allows the display of
results containing all related values.
The * wildcard character can be used to replace several characters of a text string at the
beginning or end of a string. For example, the text string "OLS*" will find all instances of
both "Olsen" and "Olson".
The ? wildcard character behaves differently depending on what type of database your system
uses.
If your system uses a SQL Server database and the search is performed in a filter field, the ?
character can be used to replace a single character in the text string. For example, the text
string "Sm?th" will find all instances of both "Smith" and "Smyth".
If your system uses an Oracle database and the search is performed in a filter field, the ?
character used in a text string replaces one character. For example, the text string r?d would
return red and rod, but would not return read. The ? character functions is the same way that
* does when used at the end of a string For example, the text string Harr? would return Harry,
Harrison, or Harrison, W.

Note: The ? wildcard is not supported when searching using a column search field.

The following attribute data types do not support wildcards: Date, Date/Time, Integer, Text,
Floating Point, and Currency.

OPENING OBJECTS IN RESULTS LIST

©
2011 Hyland Software, Inc.
32
OnBase 11.0.0 WorkView

Any time a filter search or a column search is performed, a list of objects that match the
search parameters are displayed. To open any object listed in the results, double-click on it.

Note: Only one instance of an object can be opened at a time in a session.

2
Pinning Objects
You can pin objects to open in a certain location every time an object within the same class is
opened. Each class can be pinned to open objects in different locations. To pin an object to
open in a specific screen location:

1. Open an object.
2. Move the object to the screen position in which you want all objects of the same class to
open.
3. Click the Pin Object Window button.

4. Every time an object within the same class as the current object is opened, it will open in
the pinned position.

To unpin an object, click the Unpin Object Window button.

Note: If you want to change the position of a pinned object, you must unpin it, move the
window, and pin it again.

©
2011 Hyland Software, Inc.
33
 WorkView OnBase 11.0.0

Split Screen View

Filter results can be displayed in a split screen view, which allows the filter results list to be
displayed in the top pane of the screen, while selected objects are displayed in the bottom
pane of the screen. When the split screen view is in use, objects will not display in separate
windows and only one object can be opened at a time within the bottom pane. To access the
split screen view, click the Split Screen Filter Results button. To return to the full screen view,
click the Full Screen Filter Results button.

2 Note: This button is not available if objects are pinned.

Opening Objects in New Windows

In the event that you want to open multiple objects while in the split screen view, you must
open objects using the Open in New Window button.

To open an object in a new window, select the object in the results list and click the button.
The object will open in a new window.

PRINTING RESULTS LISTS

The results listed from a filter can be printed in a printer friendly format. To print the results:

1. Click the Print List button, in the upper right-hand corner of the screen.

2. The Windows Print dialog box is displayed. Select the appropriate printer and printer
settings. Click Print.

©
2011 Hyland Software, Inc.
34
OnBase 11.0.0 WorkView

EXPORTING FILTER RESULTS TO AN EXCEL SPREADSHEET

You can export filter results to Microsoft Excel. To export the filter results to Excel, click the
Export to Excel button.

The results will be opened in an Excel spreadsheet.

Note: You must have Microsoft Excel installed on the workstation to use this feature.

2
DELETING OBJECTS IN RESULTS LIST
You can delete objects from a results list. To delete an object:

1. Select the object you want to delete in the list.

2. Click the Delete Object button.

A prompt displays asking Are you sure you want to delete this object?
3. Click OK to delete the object. Click Cancel to not delete the object.

In some configurations, you will be able to select multiple objects to delete at once. When this
is possible, check boxes will be displayed next to each object. The following is an example of
a filter configured for multiple objects to be deleted at once:

©
2011 Hyland Software, Inc.
35
 WorkView OnBase 11.0.0

To delete multiple objects:

1. Select the check boxes next to the objects you wish to delete. If you want to select all
objects, click on the arrow in the left corner by the filter’s name and select Select All. All
check boxes will be selected. If you want to clear the selected check boxes, click on the
arrow next to the filter’s name and select Select None.

Note: The Select All and Select None options are not available in subfilters.

2. Click the Delete Object button. A prompt displays asking Are you sure you want to delete
this object? If the object that is being deleted has dependencies, the following message is
is displayed: The selected object contains dependent objects. Are you sure you want to
2 delete this selected object and all dependent objects? Upon clicking OK, the object is
deleted and all of its associations to other objects are removed.
3. Click OK to confirm the deletion.

DATE AND DATE/TIME ATTRIBUTES

When entering data into fields that contain date and data/time information, the formatting of
these attributes is controlled by regional settings of your workstation.

HYPERLINKS
Clicking on a hyperlink within an object will open the specified URL in a new window.
Hyperlinks are generally denoted by underlined text.

CREATING OBJECTS WITHIN WORKVIEW

In order to create objects within a class, you must select the appropriate class from the Create
drop-down menu.

©
2011 Hyland Software, Inc.
36
OnBase 11.0.0 WorkView

Once you select the appropriate class, the screen and its associated views will display.

Tabs
Each screen has tabs. Each tab is a view. Each view has its own set of fields where
information can be entered or viewed. Views can contain not only fields for entry, but they
can contain embedded filters, for easy object retrieval, and folder contents, for easy document
retrieval. Tabs may vary by class.
Every screen has a History tab and displays if a user has rights to view the history. This tab
records the history of an object if the class and/or attributes are configured for tracking.
There are two sections to the History tab: Object History and Event Log.

©
2011 Hyland Software, Inc.
37
 WorkView OnBase 11.0.0

Object History contains the following:

• Transaction ID: unique sequential number assigned to a history event.
• Transaction Date: the date and the time that the action was performed.
• User Name: the user who performed the action.
• Attribute Name: name of attribute.
• Start Value:the value for the named attribute when the object was opened.
• End Value: the value for the named attribute after the attribute change was saved.

The Event Log contains the following:

2 • Event ID: identifies the event that occurred.
• Event Date: identifies the date and time that the event took place.
• User Name: identifies the user that initiated the event.
• Event Description: may display additional information about the event.

The History tab can be sorted by clicking on the column headers.

In addition, Object History entries can be opened to view all information pertinent to a
transaction by double-clicking on an Object History item in the History tab.
Every screen has a Documents tab that contains a Static Folder. Depending on your
configuration, additional dynamic folders may be available.

Saving
When you have completed entering data into the tabs of the screen, click one of the save
buttons.

Caution: When multiple users have the same WorkView object open, each user can change a different
attribute within that object and will not overwrite other users' changes. By design and to optimize
performance, if multiple users attempt to change the same attribute within the same object, the last
saved change is kept, allowing the possibility for other changes to be overwritten. WorkView maintains
the history of these changes so that any attributes that may have been updated are visible through the
object history.

©
2011 Hyland Software, Inc.
38
OnBase 11.0.0 WorkView

The Save button saves the current object, but leaves the object open. The Save and Close
button saves the object and closes the window. The Save and New button saves the current
object and creates another object within the class. Depending on your configuration, this
button may not be available for all object classes.

Note: If there are required fields that are configured for an object, you will not be able to save
the object until all required fields contain valid data. If you attempt to save an object and all of
the required fields are not populated, each required field that needs populated will be
highlighted in yellow.

Note: If invalid data is entered into a field, the field will be highlighted in orange upon saving.
2
For shortcut key information see page 44.

Editing
In most instances, you can edit and save changes in open objects.

Note: Depending on your configuration, you may not be able to save changes to existing
objects.

Cancelling
If you have made changes to an object, but have decided not to keep the changes, you can
cancel them by clicking the Cancel and Close button.

The changes are cancelled and the object closes.

Deleting
To delete an object, click Delete Object. Depending on your configuration, if the selected
object is directly related to another object, a prompt stating This object contains dependent
objects. Are you sure you want to delete this object and all dependent objects? is displayed.
Clicking Yes allows you to delete all related objects in addition to the selected object.
For shortcut key information see page 44.

©
2011 Hyland Software, Inc.
39
 WorkView OnBase 11.0.0

CREATING OBJECTS FROM WITHIN OBJECTS

Depending on how screens and views were configured by your administrator, you may be
able to add a new object within an object. This can be accomplished if an Add button is
available on an embedded filter in a view.

Depending on your configuration, you may be prompted with the following dialog box upon
clicking this button.

Select the appropriate class and click OK to continue.

Note: Depending on your configuration, when an object is added via the Add button and
Save and New is clicked, subsequent objects created and saved are also added to the original
object’s embedded filter. When Save and New is clicked, the next new object is added to the
embedded filter.

Depending on how your administrator configured your view, a Create Object button may be
available. If this is available, you can create objects using this button.

When this button is used, the object will automatically be displayed in the filter embedded
within the view upon creation.

©
2011 Hyland Software, Inc.
40
OnBase 11.0.0 WorkView

CREATING OBJECTS FROM THE CLIENT

Objects can be created from an open document in the Client. Objects can only be created
from documents that belong to properly configured Document Types. Depending on how
the Document Type is configured, keyword values may be populated automatically into
attribute fields. To create an object from an open document:

1. In the Client, open a document.

2. Right-click on the document and select WorkView | Create Object or Create WorkView
Object. The Create Object dialog box will display. Alternately, in the Web Client, objects
can be created from PDF and OLE documents by selecting Process | WorkView | Create
Object from the menu.
2
3. Select the appropriate object type from the list of object types configured for the
associated Document Type.
4. Click OK. The new object will display.
5. Enter information into the object and save the object.

Note: The document from which the object was created will only be attached to the object if
it was configured to auto-attach. If it was configured to auto-attach, the document will be
placed in the Static Folder located on the Documents tab of the object.

CREATING NEW OBJECT BY COPYING EXISTING OBJECTS

You can create objects with duplicate information in WorkView. To create a copy of an
object, click the Copy Object button.

A copy of the original object is created.

Note: If there are fields that are automatically populated on an object, such as sequence
number, the new object will have a new number populated in the field. In addition, a new
object id will be assigned to the copied object.

©
2011 Hyland Software, Inc.
41
 WorkView OnBase 11.0.0

CREATING NEW OBJECT BY EXTENDING AN EXISTING OBJECT

Depending on your configuration, you may be able to extend an existing object to a new
object. For example, you may have a Customer object and that customer becomes a Platinum
Customer. You could then extend that existing Customer object to an Platinum Customer
object. The new object would inherit all appropriate information from original object and
may allow you to add additional information, as configured by your administrator. Then, a
filter configured to show all Platinum Customers would automatically display that customer in
the results.
If your system is configured for this functionality the following dialog box will be displayed
under the following conditions:
2 • An action is initiated from an object or when Add is clicked in an embedded filter in
an object
• There is more than one class to which an object can be extended:

When this dialog box is encountered, select the class you want to extend the object to and
click OK. Once OK is clicked, the new extended object is created.

Note: If you are extending an object and the base class has a default value configured, the
default value will be used in the extended object.

EDIT MODE

©
2011 Hyland Software, Inc.
42
OnBase 11.0.0 WorkView

Some filters that are embedded within a view offer editing objects and the objects associated
with the filter. When this is available, an Edit button is displayed.

To enter edit mode, click the Edit button. Once in Edit mode, the filter will look similar to the
following:

2
Text in enabled fields can be edited directly within the filter when in Edit Mode and the
changes will be reflected in the object.
To return to normal mode, click the Normal button.

Relating Objects
In edit mode, you can click the lookup button next to a field to open all of the objects of the
related class. Selecting an object within the list will add that object to the original filter list
embedded in the object, taking the place of the originally displayed object within the filter. If
the value of the attribute making the relationship to the object is not equal to the value
supplied in the object, upon saving, the new selection will be cleared from the list.

Adding Rows

1. Rows can be added to the embedded filter by clicking the Create Object button.

2. Adding a new row creates a new object. Complete all fields for the new object.
3. Objects can be related to the new object when the lookup button is clicked and the
related object is selected from the displayed list. All related fields will be populated.

©
2011 Hyland Software, Inc.
43
 WorkView OnBase 11.0.0

Note: System attributes are read-only and cannot be modified.

SHORTCUT KEYS FOR OPEN OBJECTS

The following shortcut keyboard keys are available for an open object:

Shortcut Action

2 CTRL + S Performs the Save action.

CTRL + E Performs the Save and Close action.

CTRL + N Performs the Save and New action.

CTRL + D Performs the Delete Object action.

ASSOCIATING OBJECTS
Some class views may allow you to associate multiple objects of another class to the displayed
object. When this is possible, Add to List, Remove from List, and Create Object buttons may
be displayed, based on your configuration.

If these buttons are not displayed, the object view is not configured for multiple object
associations.

©
2011 Hyland Software, Inc.
44
OnBase 11.0.0 WorkView

To associate multiple objects to another object:

1. Click Add to List.

2. Depending on your configuration, the Information on page has been changed. Save
Changes? message may be displayed. To continue, click OK. A Filter Results list is
displayed with a Select column.

2
Note: By default, only objects that are not already associated with the parent object are listed.
To view all objects in the list, select the Display all objects check box.

3. Select the check boxes that correspond to the objects that you want to associate with the
currently opened object.
4. Click the Add Checked Object to List button. The selected objects will display in the
currently opened object’s embedded filter.

Note: If an object is deleted from the system and it exists as an association, when it is
accessed from the association box, it will be displayed with **DELETED** on its views.

To remove the association between objects:

1. Select the appropriate associated object.

2. Click Remove from List.
3. The Are you sure you want to delete this object? message is displayed. Click OK to
remove the object from the list.

Note: This action does not delete the object; it simply removes it from the list.

FIELD BUTTONS

©
2011 Hyland Software, Inc.
45
 WorkView OnBase 11.0.0

Some fields have buttons that accompany them. The buttons are the Globe button, the
Calendar button, and the Dataset button. Each button accesses information to aid in the data
entry process.

Datasets

Fields with Datasets will have the Dataset button ( ) to the right of the field. Clicking on
this button will display the dataset configured for the attribute the field represents. In the
example below, the dataset was configured to only include departments that were pertinent to
the business’s process. Clicking on the Dataset button displays the dataset and any value could
be selected to populate the field.
2

Alternately, you can type a partial value and press F6. If one dataset value matches the partial
value entered, it will populate the field with the complete value stored in the system. For
example, if you have a dataset that contains all of the departments in an organization and you
type in “Hu” and press F6, Human Resources would populate the field. If more than one
dataset value matches the partial value entered, the available dataset values that match the
partial value entered in the field are displayed for selection. You can select the appropriate
value by clicking on it or using the up and down arrow keys on the keyboard and press Enter
when the appropriate value is selected.

Note: If there is only one value configured for a dataset, clicking the Dataset button or
pressing F6 will populate the field with the value.

Calendars

©
2011 Hyland Software, Inc.
46
OnBase 11.0.0 WorkView

Fields that are linked to attributes of the Date or Date/Time data types will have the Calendar
button ( ) to the right of the field. To use a Calendar button:

1. Click on the Calendar button. A Date Selector… dialog box displays.

2. The arrows to the left and right of the displayed month can move between months. Select
2
the appropriate month.
3. Click on the appropriate date. The date populates in the date field.

Note: Date formatting is determined by regional settings.

Lookups

Fields with lookup properties will display the Globe button ( ) to the right of the field. This
button signifies that the field has capabilities to “lookup” values that reside in another related
attribute and use those values to populate the field. To use a lookup:

1. Click the Globe button. A Filter Results dialog box will display.

©
2011 Hyland Software, Inc.
47
 WorkView OnBase 11.0.0

Note: Depending on your configuration, you may have to enter search value and click Find
before the results will display.

2. Double-click on the appropriate object that you want to use to populate the field with.
The field will populate.

Creating Objects From Within Lookup Results

When you click on a lookup button, a filter is displayed containing all of the objects that
match the parameters of the lookup. At the top of the results list, a Create Object button is
2 displayed.

Note: This button is not available if you are looking up objects that exist in an external class.

To create a new object that will be used in the object from which you initiated the lookup:

1. Click Create Object. A new object is displayed.

2. Enter the appropriate information.
3. Click Save and Close. It is useful to add objects this way when you need a specific object
added that will be used for the current lookup field. The appropriate value from the
newly created object will automatically populate the selected field in the view from which
the lookup was initiated.

Note: If you double-click on the gray field, the related object will open for display and editing
if the currently logged in user has rights to the related object’s screen and view. Changes will
automatically be reflected. If a gray field is blank, an object is not related or the object that is
related has no value for that attribute, and therefore, a related object will not display.

©
2011 Hyland Software, Inc.
48
OnBase 11.0.0 WorkView

Note: If you add related fields using different attributes within the same class, only the first
related attribute field will be accompanied by a Globe button. The other attribute fields will be
populated with the information from the object selected from the related attribute field, using
the Globe button. If you can enter text in a lookup field, you can enter partial values, press F6,
and have the field populate automatically. If there is more than one value that matches the
partial value entered, a list of matching values will display for selection. If you cannot enter
text into a lookup field, that field is not enabled with this feature.

Below is an example of a view that would work as described above:

Clearing a Relationship Value for an Attribute

If a value is set for a relationship attribute within a view and you want to remove the value
from the view, you can clear the relationship between the related object and the currently
opened object. To clear a relationship value:

1. Open the object.

2. Click on the attribute’s lookup button that you would like to clear.

©
2011 Hyland Software, Inc.
49
 WorkView OnBase 11.0.0

3. Click the Clear Relation button.

4. Save the object.

Formatted Text
2 Fields that allow text to be formatted display the Edit Text button ( ). Upon clicking this
button, the Edit dialog box is displayed:

The following buttons are available to format text in this dialog box:

Button Description

Update AttributeName: Updates the attribute specified in the button name.

Click on this button when you have completed formatting text.

Bold: Makes the selected characters within the Edit dialog box bold.

Italic: Makes the selected characters within the Edit dialog box italicized.

©
2011 Hyland Software, Inc.
50
OnBase 11.0.0 WorkView

Button Description

Underline: Underlines the selected characters within the Edit dialog box.

Strikethrough: Strikes through the selected characters within the Edit dialog
box.

Subscript: Moves the selected characters within the Edit dialog box below
the line.

Superscript: Moves the selected characters within the Edit dialog box above 2
the line.

Cut: Cuts the selected characters and copies them to the clipboard.

Copy: Copies the selected characters to the clipboard.

Paste: Pastes the contents of the clipboard into the Edit dialog box.

Undo: Undoes the last action in the Edit dialog box.

Redo: Redoes the last undone action in the Edit dialog box.

Left Justify: Aligns the selected text to the left margin.

Center Justify: Centers the selected text.

©
2011 Hyland Software, Inc.
51
 WorkView OnBase 11.0.0

Button Description

Right Justify: Aligns the selected text to the right margin.

Justify: Aligns the selected text so that the left and right margins have equal
spacing.

Increase Indent: Moves the indent of the paragraph 10 characters spaces to

the right.

2 Decrease Indent: Moves the indent of the paragraph 10 characters spaces

to the left.

Unordered List: Applies a bulleted list format to the selected paragraph.

Ordered List: Applies a numbered list format to the selected paragraph.

Insert Rule: Opens the Insert horizontal rule dialog box, allow you to
insert a horizontal line into the Edit dialog box.

Font Color: Applies selected color to text selected in the Edit dialog box.

Font Highlight: Applies a highlight of the selected color to the text selected in
the Edit dialog box.

Display Table Menu: Clicking this button and selecting Insert new table
opens the Insert table dialog box, which allows you to insert a table into the
Edit dialog box.
Once a table is inserted, selecting the table and clicking on this button
presents a menu of options to apply to the selected table.

Toggle Borders: Toggles on and off border lines for tables that have a width
of 0. If the width is greater than 0, this button will not toggle the borders off.

©
2011 Hyland Software, Inc.
52
OnBase 11.0.0 WorkView

Button Description

Insert Link: Opens the Hyperlink dialog box, which allows you to insert a
hyper link within the Edit dialog box.

Remove Link: Removes hyperlink properties of the text selected in the Edit
dialog box.

Find and Replace: Opens the Find/Replace dialog box, which allows you to
search for specific text. This dialog box also allows you to replace the found
text with specified text.

Clean Word Formatting: When this button is clicked, text typed after the 2
cursor will be in the default font.

Word Count: Opens a dialog box reporting the number of words, the number
of characters, and the number of characters minus spaces within the Edit
dialog box.

Paste as HTML: Allows you to copy HTML code to the clipboard and paste it
into the Edit dialog box as formatted text.

Zoom: Allows you to specify the percent of magnification for the Edit dialog
box.

Check Spelling: This button launches the Spell Check Dialogue.

When the Edit dialog box is open, the button on the object toggles to Exit. Clicking the
button again closes the Edit dialog box.

©
2011 Hyland Software, Inc.
53
 WorkView OnBase 11.0.0

Spell Check
When the Check Spelling button is clicked the following dialog box is launched:

The first incorrectly spelled word will be highlighted. You can click Ignore to keep the word
the same. You can also click Ignore All to ignore all instances of the word highlighted. If you
want to change the misspelled word, Suggestions are listed. Select the word you want to use
to change the misspelled word and click Change. You can click Change All to change all
instances of the word to the selected suggested word. Upon clicking Ignore, Ignore All,
Change, or Change All, the next misspelled word will be highlighted.

©
2011 Hyland Software, Inc.
54
OnBase 11.0.0 WorkView

Inserting Horizontal Rules

Horizontal lines can be added to the field. To add a horizontal line to the field:

1. Click Insert Rule. The Insert horizontal rule dialog box is displayed.

2. Select the options for the line.

3. Click OK.

The following options are available:

Option Description

Width Specifies the width of the line in the percent of the width of the
field.

Size Number of pixels wide the line is.

Align Allows you to select Default, Left, Right, or Center

alignment.

Color Allows you to select a color for the line. See Color Control on
page 60 for more information.

Solid line (no shading) Reserved for future functionality.

©
2011 Hyland Software, Inc.
55
 WorkView OnBase 11.0.0

Inserting and Formatting Tables

To insert a table:

1. Click the Display Table Menu and select Insert new table. The Insert table dialog box is
displayed.

2. Select the appropriate options.

3. Click OK.

The following options are available:

Option Description

Rows Number of rows in the table.

Cols Number of columns in the table.

Align Allows you to select Default, Left, Right, or Center

horizontal alignment.

Border Size Number of pixels wide of the border lines.

Width Specifies the width of the table in the percent of the width of the
field or in number of pixels.

©
2011 Hyland Software, Inc.
56
OnBase 11.0.0 WorkView

Option Description

Cell padding The space, measured in pixels, between the cell borders and
the contents of the cell.

Cell spacing The space, measured in pixels, between the cell borders.

Background color Color of table background. See Color Control on page 60 for
more information.

Border color Color of table and cell borders. See Color Control on page 60 for
more information.

Once a table is created, you can modify it. To modify a table, you must place the cursor within
the table before the table menu is available. To access the table menu, click the Display Table
Menu button. The following options are available.
2

Option Description

Insert new table Inserts a table within the selected cell.

Insert column right Inserts a column to the right of the selected cell.

Insert column left Inserts a column to the left of the selected cell.

Insert row above Inserts a row above the selected cell.

Insert row below Inserts a row below the selected cell.

Delete row Deletes the row to which the selected cell belongs.

Delete column Deletes the column to which the selected cell belongs.

Increase colspan Merges the selected cell with the cell to the right. If there is not
another cell to the right, no action is performed.

Descrease colspan Unmerges cells and place a cell to the left of the cell’s content.

Increase rowspan Merges the selected cell with the cell below it. If there is not
another cell below it, no action is performed.

Decrease rowspan Unmerges cells and place a cell about the cell’s content.

Modify cell properties Opens the Modify cell properties dialog box.

Modify table properties Opens the Modify table properties dialog box and allows you
to modify the selected table. This dialog box offers the same
options as the Insert Table dialog box except the Rows and
Cols fields are disabled.

©
2011 Hyland Software, Inc.
57
 WorkView OnBase 11.0.0

MODIFYING TABLE CELLS

The following is the Modify cell properties dialog box:

The following are the cell formatting options available:

Option Description

Horizontal alignment Allows you to select Default, Left, Right, or Center

horizontal alignment.

Vertical alignment Allows you to select Default, Top, Middle, Bottom, or

Baseline vertical alignment.

Width Specifies the width of the cell in the percent of the width of the
table or in number of pixels.

Height Specifies the height of the cell in the percent of the height of the
table or in number of pixels.

No wrap When this is checked, the text in the cell will not be wrapped.

Background color Color of cell background. See Color Control on page 60 for more
information.

©
2011 Hyland Software, Inc.
58
OnBase 11.0.0 WorkView

Option Description

Border color Color of cell borders. See Color Control on page 60 for more
information.

Inserting Hyperlinks
To insert a hyperlink:

1. Click the Insert Link button. The Hyperlink dialog box is displayed.

2. Select the Type of hyperlink you want to insert.

3. Enter the URL information for the link.
4. Click OK.

Using Find and Replace

In some circumstances you may want to search for text and replace it will other text. To find
and replace text:

1. Click the Find and Replace button. The Find/Replace dialog box is displayed.

2. Enter the text you want to find in the Find what field.
3. If applicable, enter the text that you want to replace the text specified in the Find what
field in the Replace with field.

©
2011 Hyland Software, Inc.
59
 WorkView OnBase 11.0.0

4. If you want the search to be case sensitive, select the Match case check box.
5. If you want the text to match the search criteria exactly, select the Match whole word
check box.
6. Click Find Next.
7. If you want to replace all instance of the found text, click Replace All. Otherwise, click
Replace.

8. Repeat steps 6 and 7 until all text has been replaced.

Color Control
The color selection control offers many color. Clicking on the Color button accesses the
2 following control:

©
2011 Hyland Software, Inc.
60
OnBase 11.0.0 WorkView

At the top of the control there are buttons labeled -4, -3, -2, -1, 0, 1, 2, 3, and 4. Clicking on
any of the these buttons changes the color shade for available colors. Clicking on a negative
value changes the colors to darker shades. Clicking a positive value changes the colors to
lighter tints. For example, if -4 is clicked, the following options are available:

WORKING WITH RELATED DOCUMENTS

Attaching Documents Using the Documents Tab

You can attach related OnBase documents to objects in the WorkView client in two different
ways. You can attach existing documents to a WorkView object or you can create, import, and
attach a new document to a WorkView object.

Attaching an Existing Document

©
2011 Hyland Software, Inc.
61
 WorkView OnBase 11.0.0

To attach an existing OnBase document to an object:

1. With WorkView and the appropriate object open, search to find related document(s) in
the Web Client.
2. Either select and right-click on a document in a results list (any file formatted document),
or right-click on an open document (image and text documents only) and drag the
document from the Web Client to the Documents tab of the appropriate opened object
window. The document will attach to the object in the Static Folder in the Document tab
that will display in the object as shown in the following example:

Note: In order to attach an existing document to an object, the Web Client’s document
2 retrieval mode should be set to Hide In-Window Viewer so the document search results list
and documents open in another separate window.

Creating and Attaching New Documents

©
2011 Hyland Software, Inc.
62
OnBase 11.0.0 WorkView

To create and attach a new document:

1. Open the OnBase object to which you want to attach a document.

2. Click on the Documents tab.
3. Click Attach Document.

©
2011 Hyland Software, Inc.
63
 WorkView OnBase 11.0.0

The Attach Document dialog box is displayed.

4. Browse to the appropriate file.

©
2011 Hyland Software, Inc.
64
OnBase 11.0.0 WorkView

5. Select the appropriate Document Type from the drop-down select list. You can narrow
the list of Document Types listed by selecting a specific Document Type Group from the
Document Type Groups drop-down select list. Depending on your configuration,
<WorkView Class Defaults> may be selected by default as the Document Type Group.
This selection will make a pre-configured subset of Document Types available from the
Document Types drop-down select list.

6. Ensure that the file type identified in the File Type drop-down select list is the correct
format for the document to be attached.

©
2011 Hyland Software, Inc.
65
 WorkView OnBase 11.0.0

7. Enter the appropriate Keyword Type values.

8. Click the Import button. The document will be attached to the object and will be
available for retrieval in OnBase.

Attaching Documents Embedded in a View

In some instances, a related document control will be embedded within the view. It would
look similar to the following:

2
Attaching an Existing Document
To attach an existing OnBase document within a view:

1. Click Attach. A drop-down of the folders associated with the view and the documents
within the folders are displayed. The folders displayed are determined by the
configuration.

2. Select the appropriate document.

3. The auto-name string of the document will be displayed in the field.

Depending on your configuration, the document itself may be embedded within the view.

Creating and Attaching New Documents

To import and attach a new document within a view:

1. Click Import.

©
2011 Hyland Software, Inc.
66
OnBase 11.0.0 WorkView

The Attach Document dialog box is displayed.

2. Browse to the appropriate file.

©
2011 Hyland Software, Inc.
67
 WorkView OnBase 11.0.0

3. Select the appropriate Document Type from the drop-down select list. You can narrow
the list of Document Types listed by selecting a specific Document Type Group from the
Document Type Groups drop-down select list. Depending on your configuration,
<WorkView Class Defaults> may be selected by default as the Document Type Group.
This selection will make a pre-configured subset of Document Types available from the
Document Types drop-down select list.

4. Ensure that the file type identified in the File Type drop-down select list is the correct
format for the document to be attached.

©
2011 Hyland Software, Inc.
68
OnBase 11.0.0 WorkView

5. Enter the appropriate Keyword Type values.

6. Click the Import button. The document will be attached to the object and will be
available for retrieval in OnBase.

7. The auto-name string of the document will be displayed in the field.

Depending on your configuration, the document itself may be embedded with the view.
2
Opening Documents
To open an attached document, click on the Static Folder in the Documents tab. Click on a
document.
To open an attached document from an embedded related document control in a view if it is
not already displayed, double-click on the auto-name string for the document.

Deleting Documents
To delete an attached document, select the Static Folder in the Documents tab. Select the
appropriate document and click the Delete Document button at the top of the window.

Also, when documents are purged from the system in the OnBase Client, documents are
removed from the Documents tab.

©
2011 Hyland Software, Inc.
69
 WorkView OnBase 11.0.0

Using Folders
Folders created and available for classes are dynamic. Dynamic folder names are configurable.
Dynamic folders contain documents that meet the configured specifications and are related to
the associated object. These documents will automatically be pulled into the dynamic folder
within an object’s Documents tab. When a dynamic folder is configured, a Static Folder will
also be displayed in the Documents tab, in addition to the configured dynamic folder(s). The
Static Folder is used to hold documents that are manually attached to an object. Any
document, regardless of whether or not it exists in a dynamic folder, can be attached to an
object manually. The following is an example of an object using a dynamic folder.

To view documents within a dynamic folder, click on the appropriate dynamic folder in the
Documents tab. Click on a document.

Folders Embedded Within Views

In some instances, folders may be embedded within a view. Some views will display the exact
contents as the Documents tab. When this occurs, the folders will function exactly as they do
in the Documents tab.
Some views will display the contents of specific folders in a hit list. When this is the case, you
can double-click on a document to open it in the document viewer.
If you have modify rights, you can also attach documents and delete documents from an
embedded static folder or when a static folder is selected within an embedded list of folders
within a view. Click the Attach Document button to attach a document.
To delete a document, select the document and click the Delete Document button.

©
2011 Hyland Software, Inc.
70
OnBase 11.0.0 WorkView

CREATING AN E-FORM FROM WITHIN AN OBJECT

If an E-form has been associated with a class, it is possible to create an E-Form from within
an open object. To create an E-Form from an open object:

1. Click the Create EForm button.

Caution: If the object has not been saved prior to creating the E-Form, the object will be saved to
allow for proper keyword mapping.
2
2. The EForm Selection dialog box displays. Select the appropriate E-Form from the list.

3. If you want to view and/or edit the E-Form before saving it, select the View EForm
Before Creating check box.

Note: This check box may be selected by default.

4. Click OK.
5. If you selected the View EForm Before Creating check box, the E-Form will display. Edit
the E-Form as needed and click the submission button.
6. Upon successful E-Form creation, a Form Creation Successful message will display.

©
2011 Hyland Software, Inc.
71
 WorkView OnBase 11.0.0

USING ACTIONS
If actions are configured for a screen or a particular view, a button will be displayed on the
right-hand side of the object screen corresponding to each action that is configured or an
Actions drop-down select list is available at the top of an object containing all of the
configured actions. To execute a configured action, simply click on the corresponding button.
When an action button is clicked, the data in the object is automatically saved. Actions are
completely configurable and vary by system.
The following object is an example using buttons:

USING THE DOCUMENT COMPOSITION FOR MICROSOFT WORD

MODULE IN WORKVIEW

©
2011 Hyland Software, Inc.
72
OnBase 11.0.0 WorkView

If the Document Composition module is properly installed, licensed, and configured, you can
create Form Letters from an object, using the object’s attribute values to generate the Form
Letter. If Document Composition is installed for your system, the Create Form Letter button
is available.

To create a form letter from the current object’s attribute values:

1. Click the Create Form Letter button within the object. The Create Form Letter dialog box
is displayed.
2. Select the appropriate Template from the drop-down select list.
2
3. Click Create.

For more information about Document Composition functionality, see the Document
Composition documentation.

©
2011 Hyland Software, Inc.
73
 WorkView OnBase 11.0.0

©
2011 Hyland Software, Inc.
74
 WORKVIEW UNITY USAGE

USAGE
WorkView is a point-and-click-configurable application generator that allows you to
create custom applications that meet your specific business needs. The type of
information that is tracked and displayed is completely configurable.
The WorkView client depends entirely on the configuration, so every configuration will
yield unique results. This section will cover the possible components of the WorkView
client. You may or may not have all of the components described.

Accessing WorkView in the Unity Client

3
In order to access the WorkView client, you will need to log into the Unity Client. After
successfully logging in, select the Applications menu and select the appropriate
application.

©
2011 Hyland Software, Inc.
75
 WorkView OnBase 11.0.0

When the WorkView client is opened, a screen similar to following is displayed:

OPENING AN APPLICATION
In order to access information, an application must be opened. After initially accessing
WorkView, you can open different applications. To open a different application, click the
Home tab, select the Applications menu and select the appropriate application. You can also
open an application in a new window. To open an application in a new window, click on the
Open in New Window button next to the application in the Applications menu. The following
is an example of this button:

©
2011 Hyland Software, Inc.
76
OnBase 11.0.0 WorkView

USING THE CALENDAR VIEW

The Calendar View can be accessed by clicking on the Calendars button.

If a calendar is configured for the application, the Calendar view displays objects arranged by
a designated date attribute in a Calendar tab. The following is an example of a Calendar View:

Note: The WorkView calendar’s first day of the week is determined by your Windows settings.

©
2011 Hyland Software, Inc.
77
 WorkView OnBase 11.0.0

In the month view, you can click on the month or year in the header to access different
months and years. The following is an example of the selection options once the date header
is clicked:

In this example, you can select a different month and you can use the arrows to the left and
right of the year to select a different year.
Also, you can access the day view for a day at any time by clicking on the blue date header bar
at the top of a day.
You can double-click on an object with the calendar to open it.
The Calendar tab can be closed by right-clicking on the tab and selecting Close Tab. If there
are multiple tabs open, you can close all tabs except for the Calendar tab by right-clicking on
the tab and selecting Close Other Tabs. You can also open the calendar in another window by
right-clicking on the Calendar tab and selecting Open in New Window.

Choosing Display Type

You can choose to display the calendar by month, week, or day.
To display the calendar in a monthly view, click the Month button in the Calendar tab’s
toolbar.
To display the calendar in a weekly view, click the Week button in the Calendar tab’s toolbar.
To display the calendar in a daily view, click the Day button in the Calendar tab’s toolbar.

Selecting Filters
To determine the objects displayed, you must specify the filters you want to use. By default,
all filters that are associated with a calendar will be used. You can deselect filters for display.

©
2011 Hyland Software, Inc.
78
OnBase 11.0.0 WorkView

Filters that are currently used for display in the calendar are highlighted, as shown in the
following example where the Issues Tech filter is selected:

You can deselect filters by clicking on them. When a filter is not used for display in the
calendar, it will not be highlight, as shown in the previous example where the Departments 3
filter is not selected.
You can enable filters that are not being used for display by clicking on them.

Navigating the Calendar

You can click on an arrow on either side of the date/date range to move the next or previous
date or date range, depending on the calendar view displayed.
If you click on the header for a day, it will take you a single day view of the day selected.

Opening Objects
Any object displayed on a calendar can be opened by double-clicking on it. In addition, you
can view all of the descriptive information available for an object by hovering over it in the
calendar.

Creating Objects within the Calendar View

Depending on your configuration, you may be able to create an object within the calendar
view. To create an object from a calendar, complete one of the following actions:
• Select the day on the calendar to which you want to associate an object and click
Create in the ribbon toolbar.

• Right-click on day to which you want to associate an object and select Create Object.
• Double-click on a day.

©
2011 Hyland Software, Inc.
79
 WorkView OnBase 11.0.0

If there is more than one object type associated with the calendar, a dialog box is displayed
allowing you to select what object you want to create. The following is an example:

3
Select the object you want to create and click OK.

Refreshing the Calendar View

You can refresh the calendar view at any time to display any new objects that have been
entered into the system. To refresh the calendar view, click the Refresh button in the ribbon
toolbar.

USING FILTERS WITHIN WORKVIEW

Filters can be used to find specific objects within a class. Depending on how a filter is
configured, it will either perform a search when the filter is selected, or it will prompt you for
input.

Note: Filter results are limited to 2000 results.

To access a filter, click the Filters button. Filter bars are displayed in the left pane. Filter bars
are used to group related filters together. To access filters within a filter bar, you must click
the down arrow button:

©
2011 Hyland Software, Inc.
80
OnBase 11.0.0 WorkView

Upon clicking the down arrow button, filters within the filter bar are displayed. the following
is an example of a filter bar expanded:

Depending on your configuration, filters may display the number of objects that can be
retrieved using each filter. When this is available, the number of objects is displayed in
parentheses next to the filters’ names in filter bars. Filters that require user input will never
display an object count.
If filters are configured for user input, an input field displays when the filter is selected. Enter
the search parameters and click the Search button. In addition, some filters may have datasets
3
configured for the input fields. You can use the dataset to select a value to search upon.
In addition, you can reset the constraint values by clicking the Reset and clear all constraints
button.

The following is an example of a user input field for a filter:

©
2011 Hyland Software, Inc.
81
 WorkView OnBase 11.0.0

Note: If an attribute using a boolean data type is used for user input, a check box is displayed.
Selecting the check box searches for true values. Searching for an unchecked check box when
the field is enabled, searches for false values. See Enabling Search Fields on page 82 for more
information about enabling search fields.

If you want to search for multiple values for the same attribute, click on the attribute name or
press F6 with the cursor in the attribute field and another field for the attribute will display.
Use the AND and OR operators to specify the appropriate search parameters.

The following search operators are available for alphanumeric data type attributes used for
data entry in filters: = and <>.

Enabling Search Fields

You can enable and disable constraint search fields. One of two icon is displayed next to a
constraint search field. The following icon distinguishes a field as enabled for searching:

The following icon distinguishes a field as disabled for searching:

When a field is disabled, the field is not used in the search criteria, regardless of the field’s
contents. This means, if you want to search for objects that have an attribute with no value,
you must leave the field blank and enable the field. This type of search would yield only
objects that have no value for the blank, disabled field.
You can toggle a field between disabled and enabled by clicking on the displayed icon.
If all constraint search fields are disabled and a search is performed, an unconstrained search
is performed.
If you enter a value into a field that is not consistent with the data type of the field’s attribute,
the field will be outlined in red to indicate the value entered is not valid.

©
2011 Hyland Software, Inc.
82
OnBase 11.0.0 WorkView

Search Operators

Operator Description

= Searches for an exact attribute match.

< Searches for attribute values that are less than the specified value.

Note:This operator is not available for alphanumeric and boolean

attribute fields.

> Searches for attribute values that are greater than the specified value.

Note:This operator is not available for alphanumeric and boolean

3
attribute fields.

<= Searches for attribute that are less than or equal to the specified value.

Note:This operator is not available for alphanumeric and boolean

attribute fields.

>= Searches for attribute values that are greater than or equal to the
specified value.

Note:This operator is not available for alphanumeric and boolean

attribute fields.

<> Searches for attribute values that are not equal to the specified value.

Note:This operator is not available for boolean attribute fields.

Note: If you do not enter any values into the user input fields and attempt to search, the
following message will display: You are about to execute an unconstrained query. Are you
sure you want to continue? The amount of time needed to complete an unconstrained search
is dependent on the number of objects in the class being searched. Click Yes to continue the
search or No to cancel the search.

Datasets

©
2011 Hyland Software, Inc.
83
 WorkView OnBase 11.0.0

Fields with datasets will provide a drop-down select list containing all of the values for
selection. Alternately, you can type a partial value. If a dataset value matches the partial value
entered, it will populate the field with the complete value stored in the system. If more than
one dataset value matches the partial value entered, the first value matching the partial value
populates the field.

Filter Tabs
When a filter is accessed, it is opened in a tab. You can have multiple filters open at a time.
Each accessed filter will have its own tab. In the following example, there are two filter tabs:

You can access a filter by clicking on its tab. The filter tabs can be closed by right-clicking on
a tab and selecting Close Tab. If there are multiple tabs open, you can close all tabs except for
the selected tab by right-clicking on the tab and selecting Close Other Tabs. You can also open
a filter in another window by right-clicking on the filter’s tab and selecting Open in New
Window.

©
2011 Hyland Software, Inc.
84
OnBase 11.0.0 WorkView

Retrieving More Object Results

Filter results display the number of objects found in the bottom right hand corner of the
Unity Client window. The following is an example:

If more than 2000 objects are returned by a filter, only the first 2000 are displayed. When
there are more than 2000 objects returned, a Retrieve all records button is displayed next to
the number of records returned that allows you to retrieve the remaining objects that are not
displayed. Upon clicking the Retrieve all records button, the following is displayed while
records are being retrieved for display:

Blocks of 2000 objects are retrieved at a time. If you click Cancel in this dialog, the currently
loading 2000 objects will be loaded and displayed.

©
2011 Hyland Software, Inc.
85
 WorkView OnBase 11.0.0

Note: The Retrieve all records feature is not available for filters retrieving external classes.
Only 2000 objects will be displayed in filter results.

Grouping Objects
The results list for a filter can be grouped by attribute value. Results can be grouped by an
attribute that is configured as a View Attribute that are used as columns in the filter. To group
filter results:

1. In the filter results list, click on a column header and drag it to the top of the filter results
list. A group by area is displayed, as seen in the following example:
3

2. Release the column header in this area. Objects are grouped by the values of the selected
attribute, as seen in the following example:

3. Click on the expand arrow next to the group to view the objects within the group.

©
2011 Hyland Software, Inc.
86
OnBase 11.0.0 WorkView

Customizing the Filter’s Display

You can customize the filter’s display by resizing columns and changing the order of the
columns.

RESIZING COLUMNS
To resize a column, place your cursor over the column border that you would like to resize.
The cursor becomes an arrowed line, as see in the following example:

3
Click and drag the column’s edge to the desired width.

MOVING COLUMNS
You can also move columns. You can change the order of columns by clicking on the a
column header and dragging it to the location you prefer. Arrows will display above and
below the column headers, indicating the new location of column header. The following is an
example:

In addition, you can move columns underneath one another. You can stack columns by
clicking on a column header and dragging it on top of the column you want to display it
under. Arrows will display on the left and right sides of the column header under which the
moved column will be displayed. The following is an example:

©
2011 Hyland Software, Inc.
87
 WorkView OnBase 11.0.0

CHOOSING COLUMNS
You can customize the columns displayed in the filter list by completing one of the following
actions:
• Click Display Column Chooser in the ribbon.
• Right-click on the filter results and select Filter Settings | Display Column Chooser.

A box allowing you to select the columns is displayed. The columns displayed are the
columns currently configured for the filter’s display. The following is an example:

Uncheck any columns you don’t want to display. When you are finished, click OK.

Filter Settings
Filter display customizations can be saved for future filter use. Once a filter display is
customized appropriately, you can save the filter’s settings by completing one of the following
actions:
• Click Save Filter Settings in the ribbon.
• Right-click on the filter results and select Filter Settings | Save Filter Settings.

A message stating User overrides saved. is displayed. Click OK.

Once customized filter settings have been saved, you can reset the display to the default filter
settings by completing one of the following actions:
• Click Reset Filter Settings in the ribbon.
• Right-click on the filter results and select Filter Settings | Reset Filter Settings.

©
2011 Hyland Software, Inc.
88
OnBase 11.0.0 WorkView

Refreshing Filters
You can refresh a filter tab at any time to display any new objects that have been entered into
the system. When a filter is refreshed, the filter is executed. This means if user entry
constraints change between the refresh and the initial filter execution, the results will reflect
the currently entered user entry constraints. To refresh filter results, perform one of the
following actions:
• Press F5 on the keyboard.
• Click the Refresh button in the ribbon toolbar.
• Click the Refresh button in the filter bar.

Creating User-Defined Filters 3

Depending on your configuration, you may be able to define your own filters. User-defined
filters are specific to the user who configured them. Other users will not be able to see this
type of filter. When this is available, a filter bar looks like the following example:

To define a filter:

1. Click the Create Filter button. The Filter Configuration screen is displayed.

2. Enter a Filter Name for the filter.

©
2011 Hyland Software, Inc.
89
 WorkView OnBase 11.0.0

3. Select the class you want to associate the filter with from the Class drop-down select list.
4. Configure the Columns, User Entry, Fixed Constraints, and Sort options appropriately.
5. Click Save when all options are configured appropriately. The newly configured filters
will display in the filter bar.

Columns
Configuring Columns allows you to configure how filter search results will be displayed. Only
the attributes added as a column will be displayed. If this is not configured, no data will be
displayed. If this is the only filter option configured, all objects within the associated class will
display for this filter.

To configure Columns:

1. In the Filter Configuration dialog box, click the Columns button.

2. Double-click on the attribute in the left column that you want to use to display object
results.
3. You can change the heading by double-clicking in the attribute’s Heading column. Enter
the text you want displayed.
4. You can define horizontal alignment of the attribute’s field by selecting Left, Right, or
Center from the drop-down select list displayed when you click in the attribute’s
Horizontal Alignment column.

5. Repeat steps 2 to 4 for each attribute you want to configure.

©
2011 Hyland Software, Inc.
90
OnBase 11.0.0 WorkView

You can move a configured column up and down in the list by selecting the attribute and
clicking the up and down buttons on the right side of the screen to place the attribute in the
correct position in the list. You can delete configured attributes by clicking the delete button
with the red x next to the attribute.

User Entry Attributes

Configuring User Entry attributes allows you to configure the attribute search fields that users
will be able to enter values into in order to retrieve objects. One or many attribute search
fields can be configured.

To configure user entry constraints:

1. Click the User Entry button.

2. Double-click on the attribute in the left column that you want to use to use for
constraints.
3. If you want to use a Data Set associated with an attribute, you can enable data set usage
by double-clicking in the attribute’s DataSet column. Check the check box to enable data
set usage. Uncheck the check box to disable it.
4. To change the value you would like to be used as the prompt for the user entry attribute
field that is displayed, double-click in the attribute’s Prompt column. Enter the text you
want displayed.
5. Repeat steps 2-4 for each attribute you want to configure.

©
2011 Hyland Software, Inc.
91
 WorkView OnBase 11.0.0

You can move a configured user entry attribute up and down in the list by selecting the
attribute and clicking the up and down buttons on the right side of the screen to place the
attribute in the correct position in the list. You can delete configured attributes by clicking the
delete button with the red x next to the attribute.

Fixed Constraints
Configuring Fixed Constraints automatically limits the results a user receives in the filter. Add
attributes and attribute values that must match in order for objects to be displayed. When a
constraint is added to a filter, objects will only be found if they meet the criteria of the
constraint. One or many fixed constraints can be configured for a filter.

To create a fixed constraint:

1. Click the Fixed Constraints button.

2. Double-click on the attribute in the left column that you want to use to use for
constraints.
3. Under the Operator column in the attribute row, select the correct operator from the
drop-down select list. The following operators are available: =, <, >, <=, >=, <>,
NULL, and NOT NULL. The NULL operator searches for attributes that do not have
any value. The NOT NULL operator searches for attributes that have any value. If
NULL or NOT NULL is selected, any value in the value field is ignored and listed in the
field as a blank string when it is added.

©
2011 Hyland Software, Inc.
92
OnBase 11.0.0 WorkView

4. Double-click under the Value column in the attribute row and enter the value that the
attribute must meet in order for objects to be displayed.
5. Repeat steps 1 through 4 for all constraints you want to add.
In addition, complex fixed constraints can be configured. This can be accomplished by using
a combination of parentheses and AND/OR operators to construct complex queries.
Parentheses can be used to group constraint items together. To specify a parenthesis before a
constraint item, click the attribute row under the ( column. To specify a parenthesis after a
constraint item, click the attribute row under the ) column. The parenthesis button toggle the
parenthesis off and on.
The Connector column provides a drop-down select list that allows you to specify how values
are searched using the fixed constraint items. AND is selected by default. If AND is selected,
multiple fixed constraints must be met in order for objects to be returned in the filter’s
3
results. If OR is selected, one of the fixed constraints items must be met in order for objects
to be returned in the filter’s results. You can use a combination of the AND and OR
operators, coupled with the use of parentheses in order to yield the desired results.
You can move a configured fixed constraint attribute up and down in the list by selecting the
attribute and clicking the up and down buttons on the right side of the screen to place the
attribute in the correct position in the list. You can delete configured attributes by clicking the
delete button with the red x next to the attribute.

©
2011 Hyland Software, Inc.
93
 WorkView OnBase 11.0.0

Sort Tab
Sort attributes allow you to specify what attribute(s) are used to sort, and if objects are sorted
in ascending or descending order according to the selected attribute(s), when filter results
display.

To configure attributes for sorting:

1. Click the Sort button.

2. Double-click on the attribute in the left column that you want to use to use for sorting.
3. To change the sorting order click the attribute row below the Order column and select
the sort type from the drop-down select list.
4. Repeat steps 2-3 for each attribute you want to configure.

Editing User-Defined Filters

To edit an existing user-defined filter:

1. Click the Configure Filter button next to the filter you want to edit.

The Filter Configuration dialog box is displayed.

©
2011 Hyland Software, Inc.
94
OnBase 11.0.0 WorkView

2. Make the appropriate changes.

3. When finished, click Save to overwrite the existing filter or click Save As... to save the
edited filter as a new filter. If you click Save As..., enter a name for the new filter and click
OK.

Deleting User-Defined Filters

To delete an existing user-defined filter.

1. Click the Delete Filter button next to the filter you want to delete.

3
2. A message stating Are you sure you want to delete the Filter? is displayed. Click Yes to
delete the filter and click No to cancel the deletion.

USING SUBFILTERS
In some filters, you will be able to use a subfilter to further narrow down results. When a
subfilter is available, a plus sign is displayed next to each filter results, and when expanded,
related objects are displayed. The following is an example:

©
2011 Hyland Software, Inc.
95
 WorkView OnBase 11.0.0

A subfilter allows you to view all objects that are related to the selected object within another
related filter. The following is an example:

You can open an item’s subfilter contents in a new window by selecting the item in the filer
and either clicking the Open in New Window button or right-clicking and selecting Subfilter |
Open <name of class> in new Window. The subfilter contents is displayed in a new window.

You can open an item’s subfilter contents in a new window by selecting the item in the filer
and either clicking the Open in New Window button or right-clicking and selecting Subfilter |
Open <name of class> in new Window. The subfilter contents is displayed in a new tab.

You can collapse all subfilters that are expanded by clicking the Collapse All button or right-
clicking and selecting Subfilter | Collapse All.

USING COLUMNS
Filter results columns provide additional functionality. You can sort the results using the
column headers and you can search to further narrow down results using the column headers
and a search field.

©
2011 Hyland Software, Inc.
96
OnBase 11.0.0 WorkView

Sorting
The filter results can be sorted alphabetically or in numeric order (depending on the data type
sorted) by simply clicking on one of the filter column headers. Results will be sorted
according the column selected. If an "up" arrow is displayed next to the heading, results are
displayed in ascending order (A-Z or 1-100). If a "down" arrow is displayed next to the
heading, results are displayed in descending order (Z-A or 100-1).

Note: When numeric values are entered into an alphanumeric field, values will not be sorted
by numeric value.

Searching 3
You can quickly search for values within a column. This is accomplished in the line directly
underneath columns headers.

When you single-click under a column header, you will be able to select values that you want
to display. The following options are available:
• (Custom): This option opens the Custom Filter Selection dialog box, which allows you
to configured conditions for the search.
• (Blanks): This option displays objects that have a blank value for the column being
searched.
• (NonBlanks): This option displays objects that have a value for the column being
searched.
• <Value>: All values currently displayed in the results are displayed and can be
selected to only show objects with the selected value.

When you double-click under the column header to type values to search on.
The search row can be disabled in one of the two following ways:
• Click the Disable Search button in the ribbon.
• Right-click in the filter search results list and select Disable Search.

©
2011 Hyland Software, Inc.
97
 WorkView OnBase 11.0.0

The search row can be enabled in one of the two following ways:
• Click the Enable Search button in the ribbon.
• Right-click in the filter search results list and select Enable Search.

Note: Search enabling is set for each filter tab separately.

Column Search Options

The following are search type options available when searching on a column. You can access
the search type option drop-down select list by single clicking under a row. The following
options are available.
3
Option Description

Equals Displays all objects that exactly match the value provided.

Not equals Displays all objects that do not match the value provided.

Less than Displays all objects with values less than the value provided.

Less than or equal to Displays all objects with values less than or equal to the value
provided.

Greater than Displays all objects with values greater than the value provided.

Greater than or equal to Displays all objects with values greater than or equal to the
value provided.

Contains Displays all objects that contain the value provided.

Does not contain Complement of Contains.

Like (wildcards) Displays matching objects when the value provided contains
wildcards (* and ?).

Not like (wildcards) Complement of Like.

©
2011 Hyland Software, Inc.
98
OnBase 11.0.0 WorkView

Option Description

Match (regular expression) Displays all objects matching the value provided, where the
value provided is a regular expression.
A regular expression is a specially formatted search string that
uses symbols to represent complex matching patterns.
For example, a vertical bar ( | ) can be used to separate
alternatives. The string failed|error would return all rows
containing either failed or error.
For information about regular expressions, consult a
programming reference guide.

Does not match (regular Complement of Matches Regular Expression.

expresssion) 3
Starts with Displays all objects that start with the value provided.

Does not start with Complement of Starts with.

Ends with Displays all objects that end with the value provided.

Does not end with Complement of Ends with.

OPENING OBJECTS IN RESULTS LIST

Any time a filter search or a column search is performed, a list of objects that match the
search parameters are displayed. To open any object listed in the results, double-click on it.

Pinning Objects
You can pin objects to open in a certain location every time an object within the same class is
opened. Each class can be pinned to open objects in different locations. To pin an object to
open in a specific screen location:

1. Open an object.
2. Move the object to the screen position in which you want all objects of the same class to
open.

©
2011 Hyland Software, Inc.
99
 WorkView OnBase 11.0.0

3. Click the Pin Object Window button.

4. Every time an object within the same class as the current object is opened, it will open in
the pinned position.

To unpin an object, click the Unpin Object Window button.

3
Note: If you want to change the position of a pinned object, you must unpin it, move the
window, and pin it again.

PRINTING RESULTS LISTS

The results listed from a filter can be printed in a printer friendly format. To print the results,
you can either:
• Right-click in the results list and select Print.
• Click the Print button in the Filter ribbon toolbar.
• With an item selected in the filter results, press CTRL + P on the keyboard.

Print Preview
You can also create a print preview before printing a results list. To create a print preview,
you can either:
• Right-click in the results list and select Print Preview.
• Click the Print Preview button in the Filter ribbon toolbar.

©
2011 Hyland Software, Inc.
100
OnBase 11.0.0 WorkView

The following is an example of a Print Preview dialog box:

©
2011 Hyland Software, Inc.
101
 WorkView OnBase 11.0.0

When you click the Margin button, the following margin options are available:

Option Description

Units This drop-down select list allows you to select the unit of
measure used to define the margin width. Options include
Pixels, Inches, Centimeters, and Points.

Top This field defines the width of the top margin.

Left This field defines the width of the left margin.

Bottom This field defines the width of the bottom margin.

3 Right This field defines the width of the right margin.

Portrait This option defines the page orientation as portrait.

Landscape This option defines the page orientation as landscape.

When you click the Title button, the following options are available:

Option Description

Title Defines the title of the report, displayed at the top of the page.

Footer Defines the footer of the report, displayed at the bottom of the
page.

After making any changes to the margins or title, click Update Preview to view the updates to
the display.
The following option buttons are available within Print Preview from the toolbar:

Button Description

Print Prints the displayed information. This action can also be initiated
by pressing CTRL + P on the keyboard.

Increase the size of the Zooms in. This action can also be initiated by pressing CTRL +
content = on the keyboard.

Decrease the size of the Zooms out. This action can also be initiated by pressing CTRL +
content - on the keyboard.

100% Displays the page at 100%. This action can also be initiated by
pressing CTRL + 1 on the keyboard.

©
2011 Hyland Software, Inc.
102
OnBase 11.0.0 WorkView

Button Description

Page Width Displays the page fit to the width of the page. This action can
also be initiated by pressing CTRL + 2 on the keyboard.

Whole Page Displays the entire page within the viewer. This action can also
be initiated by pressing CTRL + 3 on the keyboard.

Two Pages When there is more than on page that is being previewed,
clicking this button will display the pages two across. This action
can also be initiated by pressing CTRL + 4 on the keyboard.

EXPORTING FILTER RESULTS TO AN EXCEL SPREADSHEET 3

You can export filter results to Microsoft Excel. To export the filter results to Excel, click the
Export to Excel button.

The results will be opened in an Excel spreadsheet.

Note: You must have Microsoft Excel installed on the workstation to use this feature.

Alternately, you can right-click on a filter results list and select Export to Excel.

CREATING OBJECTS WITHIN A FILTER TAB

Depending on your configuration, you may be able to create an object within a filter tab. To
create an object from a filter tab, complete one of the following actions:
• Select the day on the calendar to which you want to associate an object and click
Create in the ribbon toolbar.

• Right-click on day to which you want to associate an object and select Create <name
of class filter is displaying>.

The object displayed for creation is of the same class that the top-level filter displays.

©
2011 Hyland Software, Inc.
103
 WorkView OnBase 11.0.0

DELETING OBJECTS IN RESULTS LIST

You can delete objects from a results list. To delete an object:

1. Select the object you want to delete in the list.

2. Click the Delete button, press Delete on the keyboard, or right-click on the object you
want to delete and select Delete Selected.

3
A prompt displays asking Are you sure you want to delete the selected Object(s)?
3. Click Yes to delete the object. Click No to not delete the object.

4. If a deleted object has a dependency, the following dialog box is displayed.

This dialog box states that the object(s) listed in the dialog box have dependencies and
upon deleting an object in this dialog box, all of its dependencies are also deleted. To
delete and object from this dialog box, double-click on the object to select it for deletion.
If you want to select all objects listed, you can click the Select All column header. Click
Delete selected to complete the deletion. Click Cancel to cancel the deletion.

©
2011 Hyland Software, Inc.
104
OnBase 11.0.0 WorkView

You can select multiple objects to delete at once. You can select multiple objects in the
following ways:
• Select a row, hold down Shift on the keyboard, and click on another row to select all
rows in between.
• Hold down Ctrl on the keyboard and click on the rows you want to select.
• Click on a row, drag the cursor to the last row you want selected, and release the
mouse click.

Selected rows are highlighted in yellow.

RECENTLY VIEWED ITEMS 3

If your administrator has configured an application to display recently viewed objects, you
can access recently viewed objects easily. To access recently viewed objects, click the Recently
View button within the application’s ribbon, then select the object from the list that you
would like to open.

FAVORITES
Creating Favorites
If an object is accessed a lot, it can be created as a favorite for easy access if your
administrator has configured favorites for the application.
To create a favorite, perform one of the following actions:
• In a filter results list, right-click on the object you want to make a favorite and select
Add to Favorites.
• Select an object in a filter results list and click the Add to Favorites button in the Filter
ribbon.

Upon successfully adding an object as a favorite, a message in the bottom right hand corner
of your screen will display the message Favorite added.

Viewing Favorites
Once favorites are created, you can access favorites to open objects. To view favorites, in the
application’s ribbon, click the Favorites button. The Favorites panel will display. Click on a
object in the panel to view the object.

©
2011 Hyland Software, Inc.
105
 WorkView OnBase 11.0.0

Working with Favorites

You can arrange, rename, or delete favorites. To edit favorites, click the Edit Favorites button
in the Favorites panel.

The Edit Favorites dialog box is displayed.

©
2011 Hyland Software, Inc.
106
OnBase 11.0.0 WorkView

Editing Favorites
You can edit the display name of a favorite object. To edit the display name:

1. In the Edit Favorites dialog box, select the favorite you want to edit.
2. Click Edit.

3. In the Display Name field, edit the text to reflect the name you want displayed.
4. Click Save.
5. Click Save again.

Deleting Favorites
To delete a favorite:

1. In the Edit Favorites dialog box, select the object you want to delete.
2. Click Delete. A message asking Are you sure you want to delete this item? is displayed.
3. Click Yes to complete the delete action. Click No to cancel the deletion.
4. Click Save.

Arranging Favorites
You can arrange the list of favorites by selecting the favorite you want to move and clicking
Move up or Move down to place the item in the appropriate place in the list. Click Save when
you are done.

©
2011 Hyland Software, Inc.
107
 WorkView OnBase 11.0.0

CREATING OBJECTS WITHIN WORKVIEW

In an application ribbon, there is a Create section. If you have rights to create objects, buttons
are displayed for each object you have rights to create. If you have rights to create more that
seven object types, a Create drop-down menu is displayed. Upon clicking the Create drop-
down menu the remaining object types available for creation are displayed. The following are
two examples of the Create section.

©
2011 Hyland Software, Inc.
108
OnBase 11.0.0 WorkView

Once you select the appropriate class, the screen and its associated views will display.

Tabs
Each screen has tabs. Each tab is a view. Each view has its own set of fields where
information can be entered or viewed. Views can contain not only fields for entry, but they
can contain embedded filters, for easy object retrieval, and folder contents, for easy document
retrieval. Tabs may vary by class.
Every screen has a History tab and displays if a user has rights to view the history. This tab
records the history of an object if the class and/or attributes are configured for tracking.
There are two sections to the History tab: Object History and Event Log.

©
2011 Hyland Software, Inc.
109
 WorkView OnBase 11.0.0

Object History contains the following:

• Transaction ID: unique sequential number assigned to a history event.
• Transaction Date: the date and the time that the action was performed.
• User Name: the user who performed the action.
• Attribute Name: name of attribute.
• Start Value:the value for the named attribute when the object was opened.
• End Value: the value for the named attribute after the attribute change was saved.

The Event Log contains the following:

3 • Event ID: identifies the event that occurred.
• Event Date: identifies the date and time that the event took place.
• User Name: identifies the user that initiated the event.
• Event Description: may display additional information about the event.

The History tab can be sorted by clicking on the column headers.

In addition, Object History entries can be opened to view all information pertinent to a
transaction by double-clicking on an Object History item in the History tab.
Every screen has a Documents tab that contains a Static Folder. Depending on your
configuration, additional dynamic folders may be available.

Saving
When you have completed entering data into the tabs of the screen, click one of the save
buttons.

Caution: When multiple users have the same WorkView object open, each user can change a different
attribute within that object and will not overwrite other users' changes. By design and to optimize
performance, if multiple users attempt to change the same attribute within the same object, the last
saved change is kept, allowing the possibility for other changes to be overwritten. WorkView
maintains the history of these changes so that any attributes that may have been updated are visible
through the object history.

©
2011 Hyland Software, Inc.
110
OnBase 11.0.0 WorkView

The Save button saves the current object, but leaves the object open. The Save and Close
button saves the object and closes the window. The Save and New button saves the current
object and creates another object within the class. Depending on your configuration, this
button may not be available for all object classes.

Note: If there are required fields that are configured for an object, you will not be able to save
the object until all required fields contain valid data. If you attempt to save an object and all of
the required fields are not populated, each required field that needs populated will be
highlighted in yellow.

Note: If invalid data is entered into a field, the field will be highlighted in orange upon saving.
3

Editing
In most instances, you can edit and save changes in open objects.

Note: Depending on your configuration, you may not be able to save changes to existing
objects.

Cancelling
If you have made changes to an object, but have decided not to keep the changes, you can
cancel them by clicking the Cancel and Close button.

The changes are cancelled and the object closes.

Deleting

To delete an object, click Delete Object. Depending on your configuration, if the selected
object is directly related to another object, a prompt stating This object contains dependent
objects. Are you sure you want to delete this object and all dependent objects? is displayed.
Clicking Yes allows you to delete all related objects in addition to the selected object.

©
2011 Hyland Software, Inc.
111
 WorkView OnBase 11.0.0

DATE AND DATE/TIME ATTRIBUTES

When entering data into fields that contain date and data/time information, the formatting of
these attributes is controlled by regional settings of your workstation.

HYPERLINKS
Clicking on a hyperlink within an object will open the specified URL in a new window.
Hyperlinks are generally denoted by underlined text.

3 CREATING OBJECTS FROM WITHIN OBJECTS

Depending on how screens and views were configured by your administrator, you may be
able to add a new object within an object. This can be accomplished if an Add button is
available on an embedded filter in a view.

Depending on your configuration, you may be prompted with the following dialog box upon
clicking this button.

Select the appropriate class and click OK to continue.

Note: Depending on your configuration, when an object is added via the Add button and
Save and New is clicked, subsequent objects created and saved are also added to the original
object’s embedded filter. When Save and New is clicked, the next new object is added to the
embedded filter.

©
2011 Hyland Software, Inc.
112
OnBase 11.0.0 WorkView

Depending on how your administrator configured your view, a Create Object button may be
available. If this is available, you can create objects using this button.

When this button is used, the object will automatically be displayed in the filter embedded
within the view upon creation.

CREATING NEW OBJECT BY COPYING EXISTING OBJECTS

3
You can create objects with duplicate information in WorkView. To create a copy of an
object, click the Copy Object button.

A copy of the original object is created.

Note: If there are fields that are automatically populated on an object, such as sequence
number, the new object will have a new number populated in the field. In addition, a new
object id will be assigned to the copied object.

CREATING NEW OBJECT BY EXTENDING AN EXISTING OBJECT

Depending on your configuration, you may be able to extend an existing object to a new
object. For example, you may have a Customer object and that customer becomes a Platinum
Customer. You could then extend that existing Customer object to an Platinum Customer
object. The new object would inherit all appropriate information from original object and
may allow you to add additional information, as configured by your administrator. Then, a
filter configured to show all Platinum Customers would automatically display that customer
in the results.
If your system is configured for this functionality the following dialog box will be displayed
under the following conditions:

©
2011 Hyland Software, Inc.
113
 WorkView OnBase 11.0.0

• An action is initiated from an object or when Add is clicked in an embedded filter in

an object
• There is more than one class to which an object can be extended:

3
When this dialog box is encountered, select the class you want to extend the object to and
click OK. Once OK is clicked, the new extended object is created.

Note: If you are extending an object and the base class has a default value configured, the
default value will be used in the extended object.

EDIT MODE

Some filters that are embedded within a view offer editing objects and the objects associated
with the filter. When this is available, an Edit button is displayed.

To enter edit mode, click the Edit button. Once in Edit mode, the filter will look similar to the
following:

©
2011 Hyland Software, Inc.
114
OnBase 11.0.0 WorkView

Text in enabled fields can be edited directly within the filter when in Edit Mode and the
changes will be reflected in the object.
To return to normal mode, click the Normal button.

Relating Objects
In edit mode, you can click the lookup button next to a field to open all of the objects of the
related class. Selecting an object within the list will add that object to the original filter list
embedded in the object, taking the place of the originally displayed object within the filter. If
the value of the attribute making the relationship to the object is not equal to the value
3
supplied in the object, upon saving, the new selection will be cleared from the list.

Adding Rows

1. Rows can be added to the embedded filter by clicking the Create Object button.

2. Adding a new row creates a new object. Complete all fields for the new object.
3. Objects can be related to the new object when the lookup button is clicked and the
related object is selected from the displayed list. All related fields will be populated.

Note: System attributes are read-only and cannot be modified.

SHORTCUT KEYS FOR OPEN OBJECTS

The following shortcut keyboard keys are available for an open object:

Shortcut Action

CTRL + S Performs the Save action.

CTRL + E Performs the Save and Close action.

CTRL + N Performs the Save and New action.

©
2011 Hyland Software, Inc.
115
 WorkView OnBase 11.0.0

Shortcut Action

CTRL + D Performs the Delete Object action.

ASSOCIATING OBJECTS

Some class views may allow you to associate multiple objects of another class to the displayed
object. When this is possible, Add to List, Remove from List, and Create Object buttons may
be displayed, based on your configuration.
3

If these buttons are not displayed, the object view is not configured for multiple object
associations.
To associate multiple objects to another object:

1. Click Add to List.

2. Depending on your configuration, the Information on page has been changed. Save
Changes? message may be displayed. To continue, click OK. A Filter Results list is
displayed with a Select column.

Note: By default, only objects that are not already associated with the parent object are listed.
To view all objects in the list, select the Display all objects check box.

©
2011 Hyland Software, Inc.
116
OnBase 11.0.0 WorkView

3. Select the check boxes that correspond to the objects that you want to associate with the
currently opened object.
4. Click the Add Checked Object to List button. The selected objects will display in the
currently opened object’s embedded filter.

Note: If an object is deleted from the system and it exists as an association, when it is
accessed from the association box, it will be displayed with **DELETED** on its views.

To remove the association between objects:

1. Select the appropriate associated object.

2. Click Remove from List.
3
3. The Are you sure you want to delete this object? message is displayed. Click OK to
remove the object from the list.

Note: This action does not delete the object; it simply removes it from the list.

FIELD BUTTONS
Some fields have buttons that accompany them. The buttons are the Globe button, the
Calendar button, and the Dataset button. Each button accesses information to aid in the data
entry process.

Datasets

©
2011 Hyland Software, Inc.
117
 WorkView OnBase 11.0.0

Fields with Datasets will have the Dataset button ( ) to the right of the field. Clicking on
this button will display the dataset configured for the attribute the field represents. In the
example below, the dataset was configured to only include departments that were pertinent to
the business’s process. Clicking on the Dataset button displays the dataset and any value
could be selected to populate the field.

3
Alternately, you can type a partial value and press F6. If one dataset value matches the partial
value entered, it will populate the field with the complete value stored in the system. For
example, if you have a dataset that contains all of the departments in an organization and you
type in “Hu” and press F6, Human Resources would populate the field. If more than one
dataset value matches the partial value entered, the available dataset values that match the
partial value entered in the field are displayed for selection. You can select the appropriate
value by clicking on it or using the up and down arrow keys on the keyboard and press Enter
when the appropriate value is selected.

Note: If there is only one value configured for a dataset, clicking the Dataset button or
pressing F6 will populate the field with the value.

Calendars

©
2011 Hyland Software, Inc.
118
OnBase 11.0.0 WorkView

Fields that are linked to attributes of the Date or Date/Time data types will have the Calendar
button ( ) to the right of the field. To use a Calendar button:

1. Click on the Calendar button. A Date Selector… dialog box displays.

2. The arrows to the left and right of the displayed month can move between months.
3
Select the appropriate month.
3. Click on the appropriate date. The date populates in the date field.

Note: Date formatting is determined by regional settings.

Lookups

Fields with lookup properties will display the Globe button ( ) to the right of the field. This
button signifies that the field has capabilities to “lookup” values that reside in another related
attribute and use those values to populate the field. To use a lookup:

1. Click the Globe button. A Filter Results dialog box will display.

©
2011 Hyland Software, Inc.
119
 WorkView OnBase 11.0.0

Note: Depending on your configuration, you may have to enter search value and click Find
before the results will display.

2. Double-click on the appropriate object that you want to use to populate the field with.
The field will populate.

Creating Objects From Within Lookup Results

When you click on a lookup button, a filter is displayed containing all of the objects that
match the parameters of the lookup. At the top of the results list, a Create Object button is
3 displayed.

Note: This button is not available if you are looking up objects that exist in an external class.

To create a new object that will be used in the object from which you initiated the lookup:

1. Click Create Object. A new object is displayed.

2. Enter the appropriate information.
3. Click Save and Close. It is useful to add objects this way when you need a specific object
added that will be used for the current lookup field. The appropriate value from the
newly created object will automatically populate the selected field in the view from which
the lookup was initiated.

Note: If you double-click on the gray field, the related object will open for display and editing
if the currently logged in user has rights to the related object’s screen and view. Changes will
automatically be reflected. If a gray field is blank, an object is not related or the object that is
related has no value for that attribute, and therefore, a related object will not display.

©
2011 Hyland Software, Inc.
120
OnBase 11.0.0 WorkView

Note: If you add related fields using different attributes within the same class, only the first
related attribute field will be accompanied by a Globe button. The other attribute fields will be
populated with the information from the object selected from the related attribute field, using
the Globe button. If you can enter text in a lookup field, you can enter partial values, press F6,
and have the field populate automatically. If there is more than one value that matches the
partial value entered, a list of matching values will display for selection. If you cannot enter
text into a lookup field, that field is not enabled with this feature.

Below is an example of a view that would work as described above:

Clearing a Relationship Value for an Attribute

If a value is set for a relationship attribute within a view and you want to remove the value
from the view, you can clear the relationship between the related object and the currently
opened object. To clear a relationship value:

1. Open the object.

2. Click on the attribute’s lookup button that you would like to clear.

©
2011 Hyland Software, Inc.
121
 WorkView OnBase 11.0.0

3. Click the Clear Relation button.

4. Save the object.

Formatted Text
3 Fields that allow text to be formatted display the Edit Text button ( ). Upon clicking this
button, the Edit dialog box is displayed:

The following buttons are available to format text in this dialog box:

Button Description

Update AttributeName: Updates the attribute specified in the button name.

Click on this button when you have completed formatting text.

Bold: Makes the selected characters within the Edit dialog box bold.

Italic: Makes the selected characters within the Edit dialog box italicized.

©
2011 Hyland Software, Inc.
122
OnBase 11.0.0 WorkView

Button Description

Underline: Underlines the selected characters within the Edit dialog box.

Strikethrough: Strikes through the selected characters within the Edit

dialog box.

Subscript: Moves the selected characters within the Edit dialog box below
the line.

Superscript: Moves the selected characters within the Edit dialog box above 3
the line.

Cut: Cuts the selected characters and copies them to the clipboard.

Copy: Copies the selected characters to the clipboard.

Paste: Pastes the contents of the clipboard into the Edit dialog box.

Undo: Undoes the last action in the Edit dialog box.

Redo: Redoes the last undone action in the Edit dialog box.

Left Justify: Aligns the selected text to the left margin.

Center Justify: Centers the selected text.

©
2011 Hyland Software, Inc.
123
 WorkView OnBase 11.0.0

Button Description

Right Justify: Aligns the selected text to the right margin.

Justify: Aligns the selected text so that the left and right margins have equal
spacing.

Increase Indent: Moves the indent of the paragraph 10 characters spaces to

the right.

3 Decrease Indent: Moves the indent of the paragraph 10 characters spaces

to the left.

Unordered List: Applies a bulleted list format to the selected paragraph.

Ordered List: Applies a numbered list format to the selected paragraph.

Insert Rule: Opens the Insert horizontal rule dialog box, allow you to
insert a horizontal line into the Edit dialog box.

Font Color: Applies selected color to text selected in the Edit dialog box.

Font Highlight: Applies a highlight of the selected color to the text selected in
the Edit dialog box.

Display Table Menu: Clicking this button and selecting Insert new table
opens the Insert table dialog box, which allows you to insert a table into the
Edit dialog box.
Once a table is inserted, selecting the table and clicking on this button
presents a menu of options to apply to the selected table.

Toggle Borders: Toggles on and off border lines for tables that have a width
of 0. If the width is greater than 0, this button will not toggle the borders off.

©
2011 Hyland Software, Inc.
124
OnBase 11.0.0 WorkView

Button Description

Insert Link: Opens the Hyperlink dialog box, which allows you to insert a
hyper link within the Edit dialog box.

Remove Link: Removes hyperlink properties of the text selected in the Edit
dialog box.

Find and Replace: Opens the Find/Replace dialog box, which allows you to
search for specific text. This dialog box also allows you to replace the found
text with specified text.

Clean Word Formatting: When this button is clicked, text typed after the 3
cursor will be in the default font.

Word Count: Opens a dialog box reporting the number of words, the number
of characters, and the number of characters minus spaces within the Edit
dialog box.

Paste as HTML: Allows you to copy HTML code to the clipboard and paste it
into the Edit dialog box as formatted text.

Zoom: Allows you to specify the percent of magnification for the Edit dialog
box.

Check Spelling: This button launches the Spell Check Dialogue.

When the Edit dialog box is open, the button on the object toggles to Exit. Clicking the
button again closes the Edit dialog box.

©
2011 Hyland Software, Inc.
125
 WorkView OnBase 11.0.0

Spell Check
When the Check Spelling button is clicked the following dialog box is launched:

The first incorrectly spelled word will be highlighted. You can click Ignore to keep the word
the same. You can also click Ignore All to ignore all instances of the word highlighted. If you
want to change the misspelled word, Suggestions are listed. Select the word you want to use
to change the misspelled word and click Change. You can click Change All to change all
instances of the word to the selected suggested word. Upon clicking Ignore, Ignore All,
Change, or Change All, the next misspelled word will be highlighted.

©
2011 Hyland Software, Inc.
126
OnBase 11.0.0 WorkView

Inserting Horizontal Rules

Horizontal lines can be added to the field. To add a horizontal line to the field:

1. Click Insert Rule. The Insert horizontal rule dialog box is displayed.

2. Select the options for the line.

3. Click OK.

The following options are available:

Option Description

Width Specifies the width of the line in the percent of the width of the
field.

Size Number of pixels wide the line is.

Align Allows you to select Default, Left, Right, or Center

alignment.

Color Allows you to select a color for the line. See Color Control on
page 132 for more information.

Solid line (no shading) Reserved for future functionality.

©
2011 Hyland Software, Inc.
127
 WorkView OnBase 11.0.0

Inserting and Formatting Tables

To insert a table:

1. Click the Display Table Menu and select Insert new table. The Insert table dialog box is
displayed.

2. Select the appropriate options.

3. Click OK.

The following options are available:

Option Description

Rows Number of rows in the table.

Cols Number of columns in the table.

Align Allows you to select Default, Left, Right, or Center

horizontal alignment.

Border Size Number of pixels wide of the border lines.

Width Specifies the width of the table in the percent of the width of the
field or in number of pixels.

©
2011 Hyland Software, Inc.
128
OnBase 11.0.0 WorkView

Option Description

Cell padding The space, measured in pixels, between the cell borders and
the contents of the cell.

Cell spacing The space, measured in pixels, between the cell borders.

Background color Color of table background. See Color Control on page 132 for
more information.

Border color Color of table and cell borders. See Color Control on page 132
for more information.

Once a table is created, you can modify it. To modify a table, you must place the cursor within
the table before the table menu is available. To access the table menu, click the Display Table
Menu button. The following options are available.
3

Option Description

Insert new table Inserts a table within the selected cell.

Insert column right Inserts a column to the right of the selected cell.

Insert column left Inserts a column to the left of the selected cell.

Insert row above Inserts a row above the selected cell.

Insert row below Inserts a row below the selected cell.

Delete row Deletes the row to which the selected cell belongs.

Delete column Deletes the column to which the selected cell belongs.

Increase colspan Merges the selected cell with the cell to the right. If there is not
another cell to the right, no action is performed.

Descrease colspan Unmerges cells and place a cell to the left of the cell’s content.

Increase rowspan Merges the selected cell with the cell below it. If there is not
another cell below it, no action is performed.

Decrease rowspan Unmerges cells and place a cell about the cell’s content.

Modify cell properties Opens the Modify cell properties dialog box.

Modify table properties Opens the Modify table properties dialog box and allows you
to modify the selected table. This dialog box offers the same
options as the Insert Table dialog box except the Rows and
Cols fields are disabled.

©
2011 Hyland Software, Inc.
129
 WorkView OnBase 11.0.0

MODIFYING TABLE CELLS

The following is the Modify cell properties dialog box:

The following are the cell formatting options available:

Option Description

Horizontal alignment Allows you to select Default, Left, Right, or Center

horizontal alignment.

Vertical alignment Allows you to select Default, Top, Middle, Bottom, or

Baseline vertical alignment.

Width Specifies the width of the cell in the percent of the width of the
table or in number of pixels.

Height Specifies the height of the cell in the percent of the height of the
table or in number of pixels.

No wrap When this is checked, the text in the cell will not be wrapped.

Background color Color of cell background. See Color Control on page 132 for
more information.

©
2011 Hyland Software, Inc.
130
OnBase 11.0.0 WorkView

Option Description

Border color Color of cell borders. See Color Control on page 132 for more
information.

Inserting Hyperlinks
To insert a hyperlink:

1. Click the Insert Link button. The Hyperlink dialog box is displayed.

2. Select the Type of hyperlink you want to insert.

3. Enter the URL information for the link.
4. Click OK.

Using Find and Replace

In some circumstances you may want to search for text and replace it will other text. To find
and replace text:

1. Click the Find and Replace button. The Find/Replace dialog box is displayed.

2. Enter the text you want to find in the Find what field.
3. If applicable, enter the text that you want to replace the text specified in the Find what
field in the Replace with field.

©
2011 Hyland Software, Inc.
131
 WorkView OnBase 11.0.0

4. If you want the search to be case sensitive, select the Match case check box.
5. If you want the text to match the search criteria exactly, select the Match whole word
check box.
6. Click Find Next.
7. If you want to replace all instance of the found text, click Replace All. Otherwise, click
Replace.

8. Repeat steps 6 and 7 until all text has been replaced.

Color Control
The color selection control offers many color. Clicking on the Color button accesses the
3 following control:

©
2011 Hyland Software, Inc.
132
OnBase 11.0.0 WorkView

At the top of the control there are buttons labeled -4, -3, -2, -1, 0, 1, 2, 3, and 4. Clicking on
any of the these buttons changes the color shade for available colors. Clicking on a negative
value changes the colors to darker shades. Clicking a positive value changes the colors to
lighter tints. For example, if -4 is clicked, the following options are available:

WORKING WITH RELATED DOCUMENTS

Attaching Documents Using the Documents Tab

You can attach related OnBase documents to objects in the WorkView client in two different
ways. You can attach existing documents to a WorkView object or you can create, import, and
attach a new document to a WorkView object.

Attaching an Existing Document

©
2011 Hyland Software, Inc.
133
 WorkView OnBase 11.0.0

To attach an existing OnBase document to an object:

1. With WorkView and the appropriate object open, search to find related document(s) in
the Web Client.
2. Either select and right-click on a document in a results list (any file formatted document),
or right-click on an open document (image and text documents only) and drag the
document from the Web Client to the Documents tab of the appropriate opened object
window. The document will attach to the object in the Static Folder in the Document tab
that will display in the object as shown in the following example:

Note: In order to attach an existing document to an object, the Web Client’s document
3 retrieval mode should be set to Hide In-Window Viewer so the document search results list
and documents open in another separate window.

Creating and Attaching New Documents

©
2011 Hyland Software, Inc.
134
OnBase 11.0.0 WorkView

To create and attach a new document:

1. Open the OnBase object to which you want to attach a document.

2. Click on the Documents tab.
3. Click Attach Document.

©
2011 Hyland Software, Inc.
135
 WorkView OnBase 11.0.0

The Attach Document dialog box is displayed.

4. Browse to the appropriate file.

©
2011 Hyland Software, Inc.
136
OnBase 11.0.0 WorkView

5. Select the appropriate Document Type from the drop-down select list. You can narrow
the list of Document Types listed by selecting a specific Document Type Group from the
Document Type Groups drop-down select list. Depending on your configuration,
<WorkView Class Defaults> may be selected by default as the Document Type Group.
This selection will make a pre-configured subset of Document Types available from the
Document Types drop-down select list.

6. Ensure that the file type identified in the File Type drop-down select list is the correct
format for the document to be attached.

©
2011 Hyland Software, Inc.
137
 WorkView OnBase 11.0.0

7. Enter the appropriate Keyword Type values.

8. Click the Import button. The document will be attached to the object and will be
available for retrieval in OnBase.

Attaching Documents Embedded in a View

In some instances, a related document control will be embedded within the view. It would
look similar to the following:

3
Attaching an Existing Document
To attach an existing OnBase document within a view:

1. Click Attach. A drop-down of the folders associated with the view and the documents
within the folders are displayed. The folders displayed are determined by the
configuration.

2. Select the appropriate document.

3. The auto-name string of the document will be displayed in the field.

Depending on your configuration, the document itself may be embedded within the view.

Creating and Attaching New Documents

To import and attach a new document within a view:

1. Click Import.

©
2011 Hyland Software, Inc.
138
OnBase 11.0.0 WorkView

The Attach Document dialog box is displayed.

2. Browse to the appropriate file.

©
2011 Hyland Software, Inc.
139
 WorkView OnBase 11.0.0

3. Select the appropriate Document Type from the drop-down select list. You can narrow
the list of Document Types listed by selecting a specific Document Type Group from the
Document Type Groups drop-down select list. Depending on your configuration,
<WorkView Class Defaults> may be selected by default as the Document Type Group.
This selection will make a pre-configured subset of Document Types available from the
Document Types drop-down select list.

4. Ensure that the file type identified in the File Type drop-down select list is the correct
format for the document to be attached.

©
2011 Hyland Software, Inc.
140
OnBase 11.0.0 WorkView

5. Enter the appropriate Keyword Type values.

6. Click the Import button. The document will be attached to the object and will be
available for retrieval in OnBase.

7. The auto-name string of the document will be displayed in the field.

Depending on your configuration, the document itself may be embedded with the view.
3
Opening Documents
To open an attached document, click on the Static Folder in the Documents tab. Click on a
document.
To open an attached document from an embedded related document control in a view if it is
not already displayed, double-click on the auto-name string for the document.

Deleting Documents
To delete an attached document, select the Static Folder in the Documents tab. Select the
appropriate document and click the Delete Document button at the top of the window.

Also, when documents are purged from the system in the OnBase Client, documents are
removed from the Documents tab.

©
2011 Hyland Software, Inc.
141
 WorkView OnBase 11.0.0

Using Folders
Folders created and available for classes are dynamic. Dynamic folder names are configurable.
Dynamic folders contain documents that meet the configured specifications and are related to
the associated object. These documents will automatically be pulled into the dynamic folder
within an object’s Documents tab. When a dynamic folder is configured, a Static Folder will
also be displayed in the Documents tab, in addition to the configured dynamic folder(s). The
Static Folder is used to hold documents that are manually attached to an object. Any
document, regardless of whether or not it exists in a dynamic folder, can be attached to an
object manually. The following is an example of an object using a dynamic folder.

To view documents within a dynamic folder, click on the appropriate dynamic folder in the
Documents tab. Click on a document.

Folders Embedded Within Views

In some instances, folders may be embedded within a view. Some views will display the exact
contents as the Documents tab. When this occurs, the folders will function exactly as they do
in the Documents tab.
Some views will display the contents of specific folders in a hit list. When this is the case, you
can double-click on a document to open it in the document viewer.
If you have modify rights, you can also attach documents and delete documents from an
embedded static folder or when a static folder is selected within an embedded list of folders
within a view. Click the Attach Document button to attach a document.
To delete a document, select the document and click the Delete Document button.

©
2011 Hyland Software, Inc.
142
OnBase 11.0.0 WorkView

CREATING AN E-FORM FROM WITHIN AN OBJECT

If an E-form has been associated with a class, it is possible to create an E-Form from within
an open object. To create an E-Form from an open object:

1. Click the Create EForm button.

Caution: If the object has not been saved prior to creating the E-Form, the object will be saved to
allow for proper keyword mapping.
3
2. The EForm Selection dialog box displays. Select the appropriate E-Form from the list.

3. If you want to view and/or edit the E-Form before saving it, select the View EForm
Before Creating check box.

Note: This check box may be selected by default.

4. Click OK.
5. If you selected the View EForm Before Creating check box, the E-Form will display. Edit
the E-Form as needed and click the submission button.
6. Upon successful E-Form creation, a Form Creation Successful message will display.

©
2011 Hyland Software, Inc.
143
 WorkView OnBase 11.0.0

USING ACTIONS

If actions are configured for a screen or a particular view, a button will be displayed on the
right-hand side of the object screen corresponding to each action that is configured or an
Actions drop-down select list is available at the top of an object containing all of the
configured actions. To execute a configured action, simply click on the corresponding button.
When an action button is clicked, the data in the object is automatically saved. Actions are
completely configurable and vary by system.
The following object is an example using buttons:

USING THE DOCUMENT COMPOSITION FOR MICROSOFT WORD

MODULE IN WORKVIEW

©
2011 Hyland Software, Inc.
144
OnBase 11.0.0 WorkView

If the Document Composition module is properly installed, licensed, and configured, you can
create Form Letters from an object, using the object’s attribute values to generate the Form
Letter. If Document Composition is installed for your system, the Create Form Letter button
is available.

To create a form letter from the current object’s attribute values:

1. Click the Create Form Letter button within the object. The Create Form Letter dialog box
is displayed.
2. Select the appropriate Template from the drop-down select list.
3
3. Click Create.

For more information about Document Composition functionality, see the Document
Composition documentation.

USING FILTERS FROM THE UNITY CLIENT

Filter queries can be run from open documents in the Unity Client. The filters available for a
document are dependent on the filters associated with the Document Type to which the
document belongs. To run a filter query from an open document:

1. In the Unity Client, from an open a document or document search result list, right-click
on the document and select WorkView | Execute Filter. The Execute Filter dialog box will
display.
2. Select the appropriate filter from the list of filters configured for the associated
Document Type.
3. Click Submit. The results will display. Double-click on an object to open it.

©
2011 Hyland Software, Inc.
145
 WorkView OnBase 11.0.0

CREATING OBJECTS FROM THE UNITY CLIENT

Objects can be created from an open document in the Unity Client. Objects can only be
created from documents that belong to properly configured Document Types. Depending on
how the Document Type is configured, keyword values may be populated automatically into
attribute fields. To create an object from an open document:

1. In the Unity Client, from an open a document or document search result list, right-click
on the document and select WorkView | Create Object. The Create Object dialog box will
display.
2. Select the appropriate object type from the list of object types configured for the
3 associated Document Type.
3. Click Submit. The new object will display.
4. Enter information into the object and save the object.

Note: The document from which the object was created will only be attached to the object if
it was configured to auto-attach. If it was configured to auto-attach, the document will be
placed in the Static Folder located on the Documents tab of the object.

FULL TEXT SEARCHING

Note: This feature requires the Context Search Framework license.

If a registered application has a full text catalog configured for it, you can full text search for
WorkView objects. The following is an example of a full text indexing search field.

To conduct a full text search:

Note: By default, the first configured catalog that a user has rights to is searched.

1. Select the appropriate full text catalog by clicking on the down arrow on the right side of
the field and select the catalog you want to search in.
2. Enter the search criteria in the field.

©
2011 Hyland Software, Inc.
146
OnBase 11.0.0 WorkView

3. Click the Search button. The Full Text Search dialog box is displayed with the results of
your search.

4. You can click on a link of a results list item to open the object.

Conducting Additional Searches Within the Full Text Search Dialog Box
From within the Full Text Search dialog box, you can perform additional searches in selected
catalogs.
To conduct as simple search:

1. Select the catalog you want to search from the drop-down select list.
2. Enter the search criteria in the field.
3. Click the Search button.
4. You can click on a link of a results list item to open the object.

©
2011 Hyland Software, Inc.
147
 WorkView OnBase 11.0.0

Advanced Options
Within the Full Text Search dialog box, there are advanced search options that can be
accessed by clicking the Advanced Options link. Upon clicking the Advanced Options link, the
following options are displayed.

3
SEARCH TYPE
The following are the available search types:

Option Description

All Allows you to perform any type of search

Any Allows you to perform a search using words or phrases. You can
use quotations marks (“) to enclose words to create search
phrases. Place a plus sign (+) in front of a word or phrase that is
required. Place a minus sign (-) in front of a word or phrase to
exclude it.

Boolean Allows you to perform boolean searches using AND and OR, for
example.

OUTPUT FORMAT
The following results formatting are available:

Option Description

Summary This option displays results in a summarized paragraph format.

This is the default format.

Columns This option displays results broken up by column.

Table This option displays results in a tabular format.

©
2011 Hyland Software, Inc.
148
OnBase 11.0.0 WorkView

DATE OPTIONS
The following search date options are available:

Option Description

Include Date
Note:This option is not available when using the Table format.

When this check box is selected, the created and modified dates
are included for the objects in the results list.

Created from/through When this check box is selected, you can select a date range to
search for WorkView objects created during that time period.
3
Modified from/through When this check box is selected, you can select a date range to
search for WorkView objects modified during that time period.

SEARCH MODES
The following search modes are available:

Option Description

Use stemming for all words When this mode is selected, all grammatical variations of
(~) specified words entered will be included in the search results.
For example, you can search for “apply” and the results will
contain variations such as applying, applies, and applied. When
this search mode is selected, place the ~ character after the
word you want to perform a stemming search on.

Search using synonyms (&) When this mode is selected, all synonyms of specified words
entered will be included in the search results. When this search
mode is selected, place the & character after the word you want
to perform a synonym search on.

Fuzzy searching When this mode is selected, all similar words close to specified
(misspellings) (%) words entered will be included in the search results. When this
search mode is selected, place the % character after the word
you want to perform a fuzzy search on. This is helpful to look for
words when spelling may not be accurate.

©
2011 Hyland Software, Inc.
149
 WorkView OnBase 11.0.0

Option Description

Less/More When the Fuzzy searching (misspellings) (%) option is

selected, this option is enabled. You can select on the sliding
scale less or more of fuzzy search threshold. The more the
threshold, the more hits that will be generated. The scale is from
0-7. The number selected on the scale is the number of
characters that can be incorrect and still return an object. A 0
threshold will require an exact match for the word entered.

SPECIFIC CLASSES TO SEARCH

If multiple classes have been configured for a catalog, you can select to search specific classes
within the catalog in the Specific classes to search section. You can select one or more classes
3 by clicking on each class you want to include in the search. You can click Select All to select
all classes. You can click Clear All to clear the current class selections.

©
2011 Hyland Software, Inc.
150
 CONFIGURATION

Note: Before using the WorkView Configuration tool, ensure that all User Groups, Users,
Keyword Types, Document Type Groups, and Document Types that your system
requires are configured in the Configuration module.

USER RIGHTS WITHIN THE CONFIGURATION MODULE

In order for users to have access to WorkView functionality, they must have rights to the
appropriate applications, screens, views, filters and filter bars. These rights are all set in
4
the WorkView Configuration tool.
In order for users to configure WorkView, the appropriate user groups must have the
WorkView Configuration product right set in the Configuration module. The
MANAGER and ADMINISTRATOR users always have this right regardless of the
setting in the Configuration module.
In order to configure user group rights within the WorkView Configuration tool, the user
logged into the WorkView Configuration tool must have the Usergroup Security and/or
the User Configuration configuration right granted in the Configuration module.
In addition, if you want to allow a user to configure user rights for all user groups, grant
the User Group Administrator option in the User Settings dialog box. If this option is not
granted, but the other rights have been granted, the user will only be able to configure
rights for his or her own user group.
The user logging into the WorkView Configuration tool must have the Configuration
product right.

©
2011 Hyland Software, Inc.
151
 WorkView OnBase 11.0.0

OPENING THE WORKVIEW CONFIGURATION TOOL AND

CONNECTING TO A DATABASE
WorkView applications are designed and maintained using the WorkView Configuration tool.
To begin configuration, double-click on the icon placed on your desktop during installation.

If there is not a shortcut, navigate to the executable or select Start | All Programs | Hyland |
4 WorkView. A typical installation will place the executable in C:\Program
Files\Hyland\WorkView.

The New Connection dialog box displays. Select the appropriate Datasource (ODBC
connection) and enter the appropriate Username, and Password. Click OK.

If WorkView has not previously been used with the database, you are prompted with
WorkView has not been installed in this database. Would you like to create all WorkView
tables now (may take awhile)? Click Yes to build the new database tables. Click No to abort
the process. You must click Yes in order to continue using WorkView with the current data
source. While WorkView is connecting to the database, a Connecting, please wait… message
displays.

Note: In order for a user to logon to the WorkView Configuration tool, the user must belong
to a user group that has the WorkView Configuration product right, set in the Configuration
module. See the Configuration module help files for further information.

©
2011 Hyland Software, Inc.
152
OnBase 11.0.0 WorkView

In addition you may be asked to update WorkView upon successfully logging in. Select Yes
when asked to update.
If you have views in your system that were configured in the WorkView View Editor, a
message stating Classic/Original views have been found in the WorkView Database. Views
created using the “Classic/Original” editor will not be supported and must be converted to
the “View Designer” format as soon as possible. # classes still have Classic/Original views
associated with them: When this message is displayed, your views need to be converted using
the WorkView Designer. Click OK and the message The recent update requires that existing
views are updated with the Designer’s View Updater. The Designer will be started after this
message is closed. Please refer to WorkView documentation for more details. is displayed.
Click OK. See Updating Views on page 271 for more information.

Note: You can connect to another datasource in WorkView Configuration at any time by 4
selecting File | New Connection.

If WorkView has not been previously installed in the database, you are prompted with the
System paths configuration dialog box. Information created in WorkView will be placed in
the directories specified in this dialog box.

Enter or browse to the appropriate paths for the following.

©
2011 Hyland Software, Inc.
153
 WorkView OnBase 11.0.0

Path Description

Style sheet path Stores configured WorkView views.

Resource path Stores all scripts, images, or other files that can be used as a WorkView
resource.

Backup resource This is used internally by WorkView to store backup copies of resource files
path (e.g., VB scripts stored in WorkView). WorkView will automatically
reference files from this directory if problems are encountered while
accessing the primary directories.

Note: Paths should be UNC paths and the server must have access to these paths. All paths
4 are relative to the Web Server machine. Example: \\machinename\foldername

These paths can be edited at any time by selecting Settings | System paths… from the menu
bar.

Caution: If you change any of the system paths, restart the IIS Admin Service.

Caution: If you change the Style sheet path and style sheets exist in the new directory, not deleting
the existing style sheets may result in adverse effects.

Caution: If you are managing multiple databases for use with WorkView, using the same path in
multiple database configurations will have an adverse effect.

©
2011 Hyland Software, Inc.
154
OnBase 11.0.0 WorkView

WorkView Configuration Screen

The WorkView Configuration screen is shown below. The example screen shows no
configured applications. This is how the configuration screen appears when opened for the
first time. Shared objects are shown to the left in the WorkView Hierarchy window.

©
2011 Hyland Software, Inc.
155
 WorkView OnBase 11.0.0

Once an application, its classes, filters, and filter bars are configured, the WorkView
Configuration screen will look similar to the following:

Note: Descriptions for classes, filter bars, and filters are displayed in parenthesis next to the
name of the class, filter bar, and filter names.

Left Pane Right-Click Menu

When an application or class is not selected, right-click on left pane of the screen to access the
following menu:

©
2011 Hyland Software, Inc.
156
OnBase 11.0.0 WorkView

Option Description

New Application Launches the creation of a new application within WorkView.

Refresh Tree Refreshes the display of the configuration tree in the left pane of the
screen.

Refresh Web Clears the Web Server’s cache. This option can be useful if changes
Server made during configuration are not reflected in the WorkView client.
Changes will be reflected after the Web Server has been refreshed.

Options
You can set several configuration tool defaults in the Options For <ODBC Source> dialog box. 4
To access this dialog box, select Settings | Options... from the menu.
The following options are available:

Option Description

Track Changes The default for all elements created in WorkView that use Track Changes
will use this setting.

Track Memo The default for all elements created in WorkView that use Track Memo
Changes Changes will use this setting.

Document Type The document type selected will display in the Document Type drop-
down select list by default when attaching a document to an object.

Class Script Allows you to specify the default script that can be used at the class level.

Use ObjectName When this option is selected, changes made to relationship attributes will
instead of ObjectID be formatted in the following way within the History tab of the affected
for relationship object for the Start Value and End Value items: ObjectID -
attributes ObjectName - value.
When this option is not selected, changes made to a relationship attribute
will be recorded in the History tab as only the ObjectID for the Start
Value and End Value items.

©
2011 Hyland Software, Inc.
157
 WorkView OnBase 11.0.0

SHARED OBJECTS
Shared objects are WorkView components that are available to all applications. These include:
• Datasets: Sets of values that limit what can be entered as an attribute value in an
attribute field in filters and views. Datasets appear in a drop-down select list when
users enter attribute values. For example, a Dataset for Issue Status could include
values of Open and Closed or a Dataset could contain all 50 states in the U.S. See
page 213 for more information.
• Actions:Allow you to add buttons to execute commands. See page 303 for more
information.

4 • Sequences: Auto-incremented default values that can be used for attribute field
values. See page 212 for more information.
• Calendars: Allows users to view objects as they relate to a date. Calendars use filters to
control the objects displayed in a calendar.
• Keytype Maps: Allows the mapping of an attribute to a Keyword Type or mapping of
a static value to a Keyword Type. Keytype mappings can be used for filters, E-form
correlations, Document Type correlations, and Dynamic Folders.
• Timers: Determines when notifications configured as a shared object (Global
Notifications) are sent.
• Notifications: Notifications that are configured as shared objects, called Global
Notifications, are e-mail messages that can be configured with timers to schedule
when e-mail messages are sent to notify users.

Shared objects can be viewed by expanding <Shared Objects> in the left pane, and then
expanding the appropriate shared objects category.
In addition, you can identify where shared objects are used within the system. To identify
where a shared object is used:

1. Select a <Shared objects> category in the left pane.

2. Select a shared object in the right pane.
3. Right-click and select Used By. A usage dialog box is displayed that will show where the
shared object is used in the system.

Note: This option is not available for timers.

Each shared object type has specific information that is reported on:

©
2011 Hyland Software, Inc.
158
OnBase 11.0.0 WorkView

• For datasets, this feature reports on the attributes that use the selected dataset. The
information is formatted in the following way ClassName::AttributeName
(ApplicationName)
• For actions, this feature reports on the screen and other actions that use the selected
action.
• For sequences, this feature reports on the attributes that use the selected sequence.
The information is formatted in the following way ClassName::AttributeName
(ApplicationName)
• For calendars, this feature reports on the applications that use the selected calendar.
• For Keytype Maps, this feature reports on the class document folders that use the
selected Keytype Map. 4
• For notifications, this feature reports on the timers and classes that use the selected
notification.

©
2011 Hyland Software, Inc.
159
 WorkView OnBase 11.0.0

WEB SERVER CONNECTION SETUP

Once in the WorkView Configuration tool, you must set the appropriate Web Server settings.
To configure Web Server settings:

1. Select Settings | Web server… from the menu. The Web server connection settings for
[datasource] dialog box is displayed. [datasource] represents the ODBC source you are
connected to.

©
2011 Hyland Software, Inc.
160
OnBase 11.0.0 WorkView

2. Determine whether or not the connection is local or remote. A local connection should
be used if the OnBase Web Server is running on the same machine that the WorkView
Configuration connection is being made. Otherwise, a remote connection should be
used. If using a remote connection, specify the Server name and Datasource.

Note: If your web server is configured to use a port other than port 80, you must specify the
port. After the name of the web server, place a colon (:) followed by the port number.
Example: machinename:8080. In order to enter a port number, you must have Remote
selected.

3. If you want to incorporate SSL (Secure Socket Layer) in your WorkView configuration,
select the Use SSL option. 4
4. Enter the name of the virtual directory that contains the Web Server files. See the Web
Server documentation for further information. If you are using the Use SSL option, the
path will begin with https://. If you are using SSL, ensure that the machine name in the
web.config file and machine name specified in this path match the value in the Issued to
column of the Security Certificate to avoid security alerts from displaying to users.

Note: If the certificate specifies a full path with a domain (example:

myserver.mydomain.com), Remote must be selected to specify the domain.

5. Specify the Application server path.This path should point to the service.asmx file
located on the Application Server. If you want to configure Unity scripts within the
WorkView Configuration tool, this must be set. This enables a user to launch Unity
Configuration from within WorkView Configuration.
6. Click OK.

These settings can be changed at any time by selecting Settings | Web server… and
completing the above instructions.

Note: If WorkView detects that a remote connection’s server name is the same as the local
machine’s name that is configuring WorkView, the connection will be automatically changed
to Local.

Note: The Web Server specified must match the Web Server specified in the server’s
web.config file.

©
2011 Hyland Software, Inc.
161
 WorkView OnBase 11.0.0

Note: If an IIS restart is performed while the WorkView Configuration Tool is open, the
configuration tool will need to be closed and reopened to continue configuring.

APPLICATION CONFIGURATION OVERVIEW

There are several components that must be created and configured in order to completely
configure an application. These include:
• Create Application. See Creating Applications on page 163 for more information.
• Create Classes. See Creating Classes on page 173 for more information.
4 • Create Attributes. See Creating Attributes on page 205 for more information.
• Create Filters and Filter Bars. See Configuring Filters and Filter Bars on page 226 for
more information.
• Create Screens and Views. See Configuring Screens on page 265 for more
information.
• Configure Filter View Attributes. See View Attributes Tab on page 229 for more
information.

In addition to the required components, the following optional components can add to the
functionality and ease of use of an application. These include:
• Configure Class Titles. See Configuring the Class Title on page 202 for more
information.
• Configure Actions. See The Actions Tab on page 303 for more information.
• Configure Data Sets. See Datasets on page 213 for more information.
• Configure Sequences. See Creating Sequences on page 212 for more information.
• Configure Filter User Entry Attributes. See User Entry Constraints Tab on page 231
for more information.
• Configure Filter Fixed Constraints. See Fixed Constraints Tab on page 232 for more
information.
• Configure Calendars. See Creating Calendars on page 169 for more information.
• Configure Notifications. See Creating Notifications on page 243 for more
information.
• Configure Timers. See Creating Timers on page 260 for more information.

©
2011 Hyland Software, Inc.
162
OnBase 11.0.0 WorkView

• Configure Document Type Associations. See on page 329 for more information.

CREATING APPLICATIONS
The first step in configuring WorkView is to create applications. To create an application,
select File | New Application in the WorkView Configuration tool.
For each application, users can create classes, attributes, filters, filter bars, screens, and views.
The right pane displays the application configuration screen, shown below.

To configure an application:

1. Enter the name of the application in the Application name: field. The name entered must
be unique.

Note: The semicolon character (;) cannot be used in the Application name: field.

2. Click Save. An Application ID will be assigned to the application automatically. Each

application has a unique Application ID number assigned to it.
3. The User Group Security dialog box will display.

©
2011 Hyland Software, Inc.
163
 WorkView OnBase 11.0.0

4. Select the appropriate user group(s).

5. Click Add.
6. Click Save.

Caution: If a user is assigned to more than one user group, the least restrictive rights are applied to the
user.

Application Right-Click Menu

After an application is created, the following right-click menu is available when you right-click
4 on the application in the tree in the left pane:

Option Description

Refresh tree This option refreshes the display to show

changes made to the application.

Verify Application This option verifies that there are no

configuration problems with the selected
application. If a problem is detected, a
dialog box will display describing the
problem(s).

Clone application/data Creates an exact copy of the selected

application and objects, allowing you to
assign a new name to the new cloned
application.

Make read-only Updates user group security, making the

application and the objects within the
application read-only and unavailable for
updates.

Delete Application This option deletes the application from

WorkView.

Security Attributes Opens the Security attribute

configuration dialog box. See
Configuring Security Attributes on page
343 for more information.

©
2011 Hyland Software, Inc.
164
OnBase 11.0.0 WorkView

Option Description

Display class diagram When there is a check mark next to this

selection, the class diagram is displayed
for the application upon clicking on
Classes. When there is no check mark
next to this selection, the class diagram is
not displayed and upon selecting Classes,
the right pane displays a message stating
Class diagram has been suppressed
via the application context menu.

Cloning Applications
4
You can make a complete copy of an application, including its classes, filters, filter bars, and
data within the same database. To clone an application:

1. Select the application you want to clone in the left pane, right-click, and select Clone
application/data. The Clone application and data dialog box is displayed.

2. Enter the name of the new application. The name entered must be unique.
3. Click OK. The new application is displayed in the left pane. A CloneData.log file is saved
to the C:\ directory of the server containing information about the cloning process.

Caution: Rights granted to the filter bars, filter bar items, actions, screens, views, and classes in the
original application are also copied to the newly created application.

Caution: If you are using the WorkView Integration for Microsoft Outlook 2007 module, you must
configure user rights for global sections.

©
2011 Hyland Software, Inc.
165
 WorkView OnBase 11.0.0

The new application will be an exact copy of the original application. It will also have a copy
of the data within the application. Document Type Associations will also be transferred to the
cloned application. Attached documents will be duplicated and attached to corresponding
new objects in the cloned application. You may want to delete data from one of the
applications at the class level. See Deleting Data From a Class on page 180 for more
information.

Caution: Security Attributes and History are not cloned.

Making Applications Read-Only

4 You can make an application read-only that you want to allow viewing rights for, but you do
not want to allow rights for creation or modification of objects within the application. To
make an application read-only:

1. Right-click on the application in the left pane and select Make read-only. A dialog box
stating Are you sure you want to make this application read-only for all users?
WARNING: Making this application read-only is irreversible. is displayed.

2. Click Yes to confirm.

Caution: Making an Application read-only, does not remove Action buttons from the Screen/Views.
If Action buttons are configured to change values on an object, they will still function properly, thus
causing the read-only Application to not be read-only.

Similarly, if any Class event scripts are configured to entry points such as
rm_CheckIncludeScreenAction, rm_AddFilterConstraints, rm_CheckNotification, rm_FilterXXXX,
rm_FillDocumentFolder, rm_InitApplication, rm_InitSession and have logic to modify object values,
this script code should be removed or the Application will not be read-only.

After selecting to make an Application read-only, the Workview Administrator must manually go
through and remove any Action buttons/Class event script logic that causes values to change.

©
2011 Hyland Software, Inc.
166
OnBase 11.0.0 WorkView

Configuring Application Scripts

Core Services Scripting (VBScript)
There are two types of scripts that can be executed at the application level. The
rm_InitApplication function allows you to execute a script the very first time the application is
opened and is only executed once per Web Server start. The rm_InitSession function allows
you to execute a script the first time an application is opened for a user’s session.
To configure a vbscript at the application level:

1. Select an application from the left pane.

2. Select the Advanced tab.
3. Click VBScript. A prompt stating There is currently no script defined for this application. 4
Do you want to start with the default? is displayed. Click Yes to start with the default
skeleton script. Click No to start with a blank script editor window.
4. Add the appropriate scripting.
5. Click Save.

Unity WorkView Scripting

There are two types of scripts that can be executed at the application level. The
OnWorkViewLoadApplicationGlobal function allows you to execute a script the very first time
the application is opened and is only executed once per Web Server start. The
OnWorkViewLoadApplicationSession function allows you to execute a script the first time and
application is opened for a user’s session.

Note: In order to use Unity scripting, you must be license with the Unity Automation API
license.

To configure a Unity script at the application level the first time:

1. Select an application from the left pane.

2. Select the Advanced tab.
3. Click Unity Script. The Unity Configuration dialog box is displayed.
4. Add the appropriate scripting.
5. Save and publish the script.

©
2011 Hyland Software, Inc.
167
 WorkView OnBase 11.0.0

After a script has be saved and published for an application, a dialog box similar to the
following is displayed upon clicking Unity Script:

The Available scripts box lists the scripts that are still available for configuration for the
current application.
You can edit an existing script by selecting it and clicking Edit Script. In addition you can
make a script inactive or active by selecting it and clicking either Make Inactive or Make
Active. Only one of these buttons will be available based on the current active status of the
script.
If you want to create a new script. click Create New Script to access the Unity Configuration
dialog box.

Note: For more information on Unity Scripting, see Unity Scripting in the Hyland SDK.

Caution: Unity scripts will not be exported. Unity scripts need to be manually added to imported
applications.

©
2011 Hyland Software, Inc.
168
OnBase 11.0.0 WorkView

Creating Calendars
Calendars provide views that show objects as they relate to specific dates. Calendars are
assigned at the application level. Calendars are shared objects that can be shared across many
applications.
In order to configure a calendar view successfully, the following must be configured before
creating a calendar:
• The application using the calendar must have a class with a Date data type attribute.
• The class title is configured for the classes using a calendar.
Any filter to be used with calendars must meet the filter calendar requirements:
• The filter must be associated with a class that has a Date data type attribute. 4
• The Date data type attribute must be selected as a View Attribute.
• The Date data type attribute must be the first attribute listed in the View Attribute tab.
See page 229 for more information about the View Attributes tab.

1. You can initiate calendar creation in one of two ways:

From the application creation screen:
• Either select an existing application or create a new one.
• Click Create calendar.

Note: This button is enabled only after a class has been configured for the selected
application.

From the shared objects screen

• Expand the <Shared objects> node.
• Click Calendars.
• Right-click in the right pane and select Add new...
2. The calendar configuration screen is displayed.
3. Enter a Calendar name for the calendar.
4. Select the period of time you want displayed from the Default period drop-down select
list. You can select either a Monthly period or a Weekly period.
5. If you want the calendar to be available for selection in all applications, select the Allow
other applications to use this calendar check box.

©
2011 Hyland Software, Inc.
169
 WorkView OnBase 11.0.0

Note: If this is configured from <Shared Objects>, this option is selected by default and
cannot be edited.

6. Select an appropriate filter from the drop-down select list at the bottom of the screen or
create a new filter to use.
7. Click Add. Filters added to a calendar are available from the calendar view. These filters
will determine what objects are displayed on the calendar view.
8. The User Group Security dialog box is displayed. Select the appropriate user group(s) that
should have rights to the filter.
9. Click Save.
4 10. Repeat steps 6 to 9 for each filter you want to make available from a calendar view.
11. When you have finished adding filters, click Save.
12. The User Group Security dialog is displayed. Select the appropriate user group(s) that
should have rights to the calendar.
13. Click Save.

After a calendar is configured, it can be assigned to an application. In addition, you can edit
the selected calendar by clicking Edit calendar.

Assigning a Calendar to an Application

Once a calendar is configured, you can assign it to one or more applications. In order for a
calendar to work correctly with an application, the filters assigned to the selected calendar
must be associated with a class within the application.
To assign a calendar to an application:

1. Select the application.

2. Select the appropriate calendar from the Calendar drop-down select list. Calendars listed
display their ID numbers in parenthesis.

Note: This drop-down select list is disabled until a class is configured for the application.

3. Click Save.

Configuring a Default Filter

For each application, you can configure a default filter that displays when an application is
selected in the client.

©
2011 Hyland Software, Inc.
170
OnBase 11.0.0 WorkView

To assign a default filter to an application:

1. Select the application.

2. Select the Advanced tab.
3. Select the appropriate filter from the Filter name drop-down select list. Filters listed
display their ID numbers in parenthesis.

Note: This drop-down select list is disabled until a class is configured for the application.

4. Click Save.

4
Configuring User-Defined Filters
You can configure WorkView to allow users to configure their own filters. This is configured
at the application level. To allow user-defined filters:

1. Select the application in which you want to allow user-defined filters.

2. Select the Advanced tab.
3. Select a filter bar from the Filterbar name: drop-down select list.

Note: Only one user-defined filter bar can be configured for an application.

If a filter bar is selected that already has filter bar items configured for it, a message
stating This Filterbar is designated as the owner of all user-defined filters for the current
application. You may edit only its title, description, and user groups. Only filters created
by the user at runtime will be attached to this bar. is displayed. Click OK. When this is
displayed, you must remove already configured filter bar items in the Filter Bar
configuration screen.
If you create a new filter bar, the following message is displayed: This Filterbar is
designated as the owner of all user-defined filters for the current application. You may
edit only its title, description and user groups. Only filters created by the user at runtime
will be attached to this bar. Click OK and configure the filter bar with the appropriate
title, description, and user group(s).
4. Click Save.

©
2011 Hyland Software, Inc.
171
 WorkView OnBase 11.0.0

Note: Only attributes that are assigned to a user's view are available to the user when creating
user-defined filters.

Note: If a user-defined filter bar is modified in the Workview Configuration tool, the user-
defined filters that had been defined will be removed and will have to be re-configured by the
users.

Configuring Favorites and Recently Viewed

4
Note: Favorites and recently viewed items are only applicable to the WorkView Unity Client
and the WorkView Integration for Microsoft Outlook 2007 module.

First, if you are going to enable favorites, ensure that the classes you are accessing have class
titles configured. Class titles generate the object’s autoname, which is used for the initial
favorite item name.
As an administrator, you can configure applications to display favorites. You can specify the
number of favorites you want listed. This is configured per application. In order to use
favorites or recently viewed items, you must configure the maximum number of items
allowed in each list.
To set the maximum number of favorites:

1. Select an application.
2. Select the Advanced tab.
3. Enter the maximum number of favorites you want a user to have in the Maximum
number of favorite items to keep field.

Note: If the maximum is set to 0, the feature will be unavailable for the application in the
client.

4. Click Save.

As an administrator, you can configure applications to display recently viewed items. You can
specify the number of recently viewed objects you want listed. This is configured per
application.

©
2011 Hyland Software, Inc.
172
OnBase 11.0.0 WorkView

To set the maximum number of recently viewed items:

1. Select an application.
2. Select the Advanced tab.
3. Enter the maximum number of recently viewed items you want a user to have in the
Maximum number of recently viewed items to keep field.

Note: If the maximum is set to 0, the feature will be unavailable for the application in the
client.

4. Click Save.
4
Note: Reset IIS when you are done configuring these features in order for your changes to be
reflected in the client.

Changes made in the WorkView Configuration tool will be reflected in the WorkView
Integration for Microsoft Outlook 2007 module’s configuration options for favorites and
recently view items and vice versa.

Application Resources
Each application has a Resources node. The Resources node contains items relevant to the
selected application. Within this node are the following categories: Datasets, Actions,
Sequences, Calendars, Keytype Maps. Selecting a category displays items related to the
application selected within that category.

CREATING CLASSES
Classes are the next tier below the main Application level. Classes are used to group related
attributes together and define objects. You can view all of the configured classes for an
application by either:
• Clicking the Classes… button on the application configuration screen, or
• Expanding the tree under the appropriate application in the left pane and click on the
Classes item.

©
2011 Hyland Software, Inc.
173
 WorkView OnBase 11.0.0

If no classes are configured, a message is displayed in the right pane stating No classes
assigned to application. The class screen, similar to the following screen, will display in the
right pane once classes are configured, unless the class diagram is suppressed.

If the class diagram is suppressed, Class diagram has been suppressed via the application
context menu is displayed in the right pane. If the class diagram is suppressed, the class right-
click menu will only be available when a class is right-clicked on in the left pane.
This screen shows all configured classes for the selected application, as well as a list of
Attributes and the Data Type for each Attribute within each class. The attribute id is next to
each attribute, and the attribute length is displayed next to the data type, if applicable.
You can hide the attributes in this view by right-clicking in the right pane and selecting Hide
Attributes. You can show attributes again by repeating this step.

An extension class box will look like the following:

©
2011 Hyland Software, Inc.
174
OnBase 11.0.0 WorkView

An association class box will look like the following:

An external class box will look like the following:

To move a class in the display, left-click on the class and drag it to the appropriate location on
the screen.
If an arrow is present between two classes, a configured relationship exists. The arrow starts
at the class containing the relationship attribute. The arrow points to a class containing the
attribute depended upon.

©
2011 Hyland Software, Inc.
175
 WorkView OnBase 11.0.0

To create a new class:

1. From the class screen, right-click outside of the class box(es) or right-click on the Classes
node in the tree and select New class | Normal class. The class configuration screen
displays:

2. Enter a class name in the Class name: field. There can be no spaces or symbols in this
name. The value entered in the Class name: field will populate the Display name: field.
The maximum number of characters that can be used in these two fields is 254
characters.
3. Edit the name you want displayed for this class in the Display Name: field. This value will
be displayed in the Client Applications menu.
4. Decide if you want to allow direct creation by selecting Yes or No from the Allow Direct
Creation drop-down menu. If you select YES, objects can be created for this class from
the WorkView Create menu. If you select NO, object creation will not be available from
the Create menu. The Save and New button will also be disabled on objects within the
class. Not allowing direct creation is often used when an object should not exist unless it
is associated with another object. For example, you may not want Issue objects to be
created unless they are linked to a Vendor object. Then you would configure Issue
objects to be created through a filter in the Vendor object and be automatically linked to
the selected vendor.

©
2011 Hyland Software, Inc.
176
OnBase 11.0.0 WorkView

5. If you want to allow tracking of changes made to objects within the class on the object’s
History tab, select the Track changes check box, which is selected by default. If you do
not want to allow changes to be tracked on the object’s History tab, deselect the option.
6. If you want to allow tracking of changes made in attributes of the Text data type on the
object’s History tab, select the Track memo changes check box, which is selected by
default. If you do not want to allow changes made to attributes of the Text data type to be
tracked on the object’s History tab, deselect the option. In order to use this feature, you
must also select the Track Changes option.

Note: Attributes will only be viewable in the History tab if the current user has rights to see
the attribute in a view. If the attribute does not belong to a view that the user has access to,
the History tab will not display the attribute. 4
Note: If there is not a need for tracking, suppressing tracking can save database storage space.

Caution: The Track changes and Track memo changes check boxes in this screen will control all
attributes associated with the class. If you want to track changes to a specific attribute, select the Track
changes check box for the appropriate attribute. See page 205 for further information.

Note: Before saving, you can configure the Class Title (more information available on
page 202), Attributes (more information available on page 205), and the Screen (more
information available on page 265). You can also configure each class individually after you
have created all necessary classes.

7. If you are finished creating the class, click Save.

8. The User Group Security dialog box will display. Assign the appropriate user group(s) to
the class and assign the user group(s) the appropriate rights for objects within the class
(View, Create, Modify, Delete, and View History). These rights will control whether a user
can view, create, modify, delete objects and/or view history within the class. Click Save.
A Class ID will automatically be assigned and a new configuration screen will appear.

©
2011 Hyland Software, Inc.
177
 WorkView OnBase 11.0.0

Note: In order to attach or detach documents to/from an object, users must have the Modify
right for a class.

9. Repeat steps 2 through 8 to add multiple classes. Click Done when you are finished.

When a new class is created, it displays in the New classes for application ‘application name’
box at the bottom of the left pane.
If a user is assigned to more than one user group, the least restrictive privileges will be
allowed.
Once a class is created, it can be edited by right-clicking on the appropriate class box and
selected Edit class. Likewise, user group permissions can be edited by right-clicking on the
appropriate class box and selecting User Groups.

©
2011 Hyland Software, Inc.
178
OnBase 11.0.0 WorkView

Once a class has been created you can associate or extend the class. For more information
about creating association classes, see Creating Association Classes on page 182. For more
information about extending classes, see Creating Extension Classes on page 185.
To arrange class boxes in rows and columns, right-click outside of the class boxes and select
Reset positions.

If you want to print the classes as they are displayed, either right-click in the white space of
the right pane and select Print Schema or click the Print class schema button.
When you are done configuring classes for an application, you can exit the class dialog box by
right-clicking anywhere in the pane and selecting Return to application or select the
application within the tree.

Note: The Return to application option is only enabled when you have used the Classes... 4
button within the Application screen to access class configuration.

Sharing Existing Classes

You can also share an existing class with another application. If more than one application is
linked to a class, both the applications will be, in essence, “sharing” class information.
To share an existing class into an application:

1. Right-click on the class screen and select Add existing class. A pop-up menu appears.
2. Select the appropriate class from the pop-up menu. The existing class will appear in the
class screen for the selected application.

To cancel a class share, click anywhere outside of the pop-up menu.

Deleting Classes
Classes can be deleted
• By selecting the appropriate class in the class screen, right-clicking, and selecting
Delete Class.

• By right-clicking on a class in the left pane and selecting Delete Class.

Note: If a class belongs to more than one application, the class will only be deleted from the
selected application and will remain in all other applications to which it belongs. If an
extension class exists for the selected class, the originating class cannot be deleted.

In order to delete a class, all relationships to the class must also be removed.

©
2011 Hyland Software, Inc.
179
 WorkView OnBase 11.0.0

Deleting Data From a Class

In some instances, especially when using cloning to create classes, you may want to delete all
of the data within a class. Data can be deleted from any class that is not of the External Class
type. To delete data from a class:

1. Expand the application in which the class resides in the left pane.
2. Select Classes in the left pane.
3. In the right-pane, right-click on the class and select Delete data only or in the left pane,
right-click on a class and select Delete data only.
4. Click Yes to confirm the data deletion.
4 5. Click Yes again to confirm.

Caution: This operation will remove all data for the selected class from the database. Only use this
function if you are completely sure you do not need the data.

©
2011 Hyland Software, Inc.
180
OnBase 11.0.0 WorkView

Setting the Default Document Types

You can select a subset of Document Types that will be available for selection by default
when importing a new document as an attachment of an object in WorkView. To configure
default Document Types:

1. In the WorkView Configuration tool, select the class for which you want to configure
default Documents Types.
2. Right-click and select Document Types... The Default Document Type Selection dialog
box is displayed.

3. Select the Document Types that you want to make available as default in the Available
Document Types box.

4. Click Add>>.
5. Click Save.

©
2011 Hyland Software, Inc.
181
 WorkView OnBase 11.0.0

When default Document Types are configured, <WorkView Class Defaults> is displayed and
selected for the Document Type Groups drop-down select list in the Attach Document dialog
box. The Document Types that are available from the Document Types drop-down select list
are only the Document Types configured as default when <WorkView Class Defaults> is
selected.

Creating Association Classes

Association classes allow you to make an association between two classes. This association
allows you to create a one to many relationship between objects in the two associated classes.
This is useful when you have an object, for example an issue, and you need to associate
multiple objects to the issue object, for example assigning multiple employees to the selected
4 issue. Using an association class for this benefit requires multiple configuration steps. First,
you must create the association class. Second, create a filter for the association class,
displaying the necessary attributes. Lastly, you must place the filter on the appropriate class
view. This view will exist in one of the classes that belongs to the association classes. As an
example, an Issues view could be created with a filter that displays all of the Employees
associated with the issue object by using an Association class.

©
2011 Hyland Software, Inc.
182
OnBase 11.0.0 WorkView

Creating the Class

To create an association class:

1. Complete one of two actions:

• Right-click on the class box that you want to associate with another class and select
Associate class.

• Right-click outside of a class box or right-click on the Classes node in the tree and
select New class | New association class...
• Right-click on a class in the left pane and select Associate class.
2. The Create Association Class dialog box is displayed. If you have selected Associate class
in step one, the First class drop-down select list is populated with the class you right- 4
clicked upon. Otherwise, select one of the appropriate classes to be associated from the
First class drop-down select list.

3. Select the other class from the Second class drop-down select list that you want to
associate to the class selected in the First class drop-down select list.
4. The Association class name field will automatically be populated with the name of the
first class and the name of the second class, separated by an X. For example, if you
associated an Employees class with an Issues class, your associated class name would
automatically display as EmployeesXIssues. This naming convention enables you to easily
determine which classes belong to a given association class. If you prefer, you can rename
the class anything you want.

©
2011 Hyland Software, Inc.
183
 WorkView OnBase 11.0.0

Note: The view will pull information from classes that it is associated with and can be
retrieved through a filter. Attributes, E-Forms, Document Types, and Folders cannot be
configured for an association class.

Creating the Filter for an Association Class

Next, you must make a filter for your association class. The following configuration options
must be set in order to use this filter for an association on a view:
• The filter must be assigned to the association class.
• One of the View Attributes from one of the associated classes should be displayed on
4 a given association filter.
• No User Entry Constraints or Fixed Constraints should be configured for a filter used
in a class association.
• Only attributes from one of the classes that make up the associated class should be
used as a View Attribute for the filter. If there is a need for each of the classes that
make up the associated class to be used in a filter, separate filters should be
configured.
For more information about creating filters, see Configuring Filters and Filter Bars on page
226.

Placing the Filter on a View in the View Designer For An Association Class
To place an association filter on a view:

1. In the Designer, select the view.

2. Click the Filters tab.

©
2011 Hyland Software, Inc.
184
OnBase 11.0.0 WorkView

3. Double-click on the filter you want to insert into the view. The Select a filter for <Class
Name> dialog box is displayed.

4. Select the filter that you want to use when using the Allow Add to List feature.
5. Click OK.

The Allow Add To List and Allow Add To List Filter properties are available for association
filters. See Filters on page 292 for more information.

Creating Extension Classes

Extension classes are branches of any other class. Extension classes share attributes and can
share E-Form associations, and folder associations. Extension classes keep a relationship to
the class they were based upon. You can add additional attributes to the extension class.
These attributes will only be available in the extended class. When you add an attribute to the
class from which an extension class was extended, that attribute will be available in any
subsequent extended class. Data that is added to a base class will be appropriately reflected in
all extension classes configured for the base class. Likewise, data that is added to an extension
class will be appropriately reflected in the base class and all of its extension classes.

Note: External classes cannot be extended.

©
2011 Hyland Software, Inc.
185
 WorkView OnBase 11.0.0

To create an extension class:

1. Complete one of three actions:

• Right-click on the class box that you want to extend to another class and select
Extend class.

• Right-click outside of a class box or right-click on the Classes node in the tree and
select New class | New extension class...
• Right-click on a class in the left pane and select Extend class.
2. The Create extension class dialog box displays. If you selected Extend class, the class
that you right-click on will be displayed in the New class is extension of drop-down select
4 list. Otherwise, select the appropriate class from the drop-down select list.

Note: External classes will not be available for selection from the New class is extension of
drop-down select list.

3. Enter the name for the extension class in the New class name field.
4. If you want the E-Form associations to be inherited by the extension class, select the
Inherit E-Form associations option.

5. If you want the folder associations to be inherited by the extension class, select the
Inherit folder associations option.

©
2011 Hyland Software, Inc.
186
OnBase 11.0.0 WorkView

6. Click OK. After an extension class is created, the class box that is displayed for it is similar
to the following:

An extension class box displays the name of the class from which the class was extended
in the title bar. It also displays the attributes that originated from another class in a 4
shaded area. Attributes that are only specific to the extended class appear in an area that
is not shaded.
7. To finish the creation of the extension class, navigate to the Attributes screen and click
Build DB Table.

8. Click Yes.
9. Click OK.

Transforming Existing Extended Class Object

In some cases, you may want to convert an object from one extended class to another
extended class. An example of when you may want to do this is if you have an extended class
for Employees and an extended class for Managers and an employee is promoted to a
management position. You would want to convert that person’s object from the Employees
class to the Managers class. In order to allow users to convert objects from one extended
class to another, you must configure extended classes in a particular way. To accomplish this:

1. On the extended class you will be converting from configure an action with the Modify
object class (picklist selection) action type. See The Actions Tab on page 303 for
information about configuring actions.
2. On the extension classes you would like to allow conversion to, you must select the Valid
transform choice for all sibling classes option. See Extension Options on page 189 for
more information concerning this option.

©
2011 Hyland Software, Inc.
187
 WorkView OnBase 11.0.0

Allowing Users to Extend Base Objects from an Action

You can configure a class’s screen to allow a base class to be extended to related extended
classes using a configured action. Multiple extended classes can be configured for user
selection in the client. To accomplish this:

1. On the base class configure an action with the Modify object class (picklist selection)
action type. See The Actions Tab on page 303 for information about configuring actions.
2. On the extension classes you would like to allow extension to from a selection list, you
must select the Valid transform choice for all sibling classes option. See Extension
Options on page 189 for more information concerning this option.

4 Allowing Users to Create Objects Based on Extended Classes

If you want to allow users the option to create objects based on either the base class or the
extended class within an embedded filter, the following must be configured:

1. Select the Can extend on create option for the base class.
2. For each extended class that you want to make available for selection, select the Valid
base class extend-on-create choice option.

See Extension Options on page 189 for more information concerning these options.

Advanced Tab
When working with extension classes, the Advanced tab for the class has two additional
options: Inherit E-form correlations from base class and Inherit dynamic folder correlations
form base class.

The Inherit E-form correlations from base class option allows E-Form associations to be
inherited by the extension class from the base class.
The Inherit dynamic folder correlations form base class option allows folder associations to
be inherited by the extension class from the base class.

©
2011 Hyland Software, Inc.
188
OnBase 11.0.0 WorkView

Extension Options
When a class has been extended, there are options for both the base class and the extended
class related to the extension. These options are available on the Extension options tab. This
tab is only available for classes that are either a base class to an extended class or are an
extended class. To access the extension options:

1. Select the appropriate class.

2. Select the Extension options tab.

There are two sets of options on this tab. The Base class options are only enabled for base
classes. The Extended class options are only enabled for extended classes.

©
2011 Hyland Software, Inc.
189
 WorkView OnBase 11.0.0

BASE CLASS OPTIONS

Option Description

Abstract (only extension of This option removes the selected base class from the selection
this class can be directly list when creating objects from within an embedded filter.
created)
Note:When this option is selected, the Can extend on create
is selected and disabled for editing.

Can extend on create Allows the ability for an external object to be created from within
an embedded filter providing a select list of available classes
4 associated with the base class. This setting works in conjunction
with the Valid base class extend-on-create choice. Only the
base class and linked extension classes with this setting will be
available from the select list.

EXTENDED CLASS OPTIONS

Option Description

Base class name Displays the name of the class the selected extension class is
based on.

Valid base class extend-on- This option makes the selected extension class available for
create choice selection during object creation from an embedded filter. When
the Add button is clicked from an embedded filter within a view,
the user will be prompted with a dialog box asking for a
extended class selection. The base class and any extended
classes with this option set will be available for selection. The
class that is selected will be used for object creation.This option
works in conjunction with the Can extend on create base
class option.

©
2011 Hyland Software, Inc.
190
OnBase 11.0.0 WorkView

Option Description

Valid transform choice for all This works in conjunction with the Modify object class
sibling classes (picklist selection) action type.
When this action type is configured on an extended object and
the action is initiated in the client, the user will be prompted with
a dialog box asking for a extended class selection. Extended
classes that are extended from the same base class as the
current object’s class and that have this option set are available
for selection. The originally opened object will be transformed to
the new extended class that was selected from the list. The
object will only be available for retrieval for the newly selected
extended class and will no longer be retrieved for the original
extended class. 4
When this action type is configured from a base object and the
action is initiated in the client, the user will be prompted with a
dialog box asking for an extended class selection. Classes
extended from the base class that have this option selected are
available for selection. The extended class selected will be
created and inherit the values from the base class. The base
class will remain available for retrieval and editing. The newly
extended object will also be available for retrieval and editing.

©
2011 Hyland Software, Inc.
191
 WorkView OnBase 11.0.0

Sequencing Classes
You can specify the order in which your configured classes are displayed under the Create
menu in the WorkView Client. To specify the sequence in which classes are listed:

1. Navigate to the class screen that contains the class boxes within an application.
2. Right-click anywhere in the pane and select Resequence. The Sequencing dialog box is
displayed.

3. Sequence the classes by selecting each class you want to move and use the Move up and
Move down buttons to position the class appropriately.

4. Click OK.

Creating External Classes

External classes allow you to connect and pull information from an external database. Data in
external classes is read-only and cannot be deleted or updated from within WorkView. The
external data can be used in various ways in WorkView including filters, filter criteria, sorting,
and relationship lookups in other classes.

©
2011 Hyland Software, Inc.
192
OnBase 11.0.0 WorkView

To create an external class:

1. Right-click outside of a class box or right-click on the Classes node in the tree and select
New class | New external class... The New external class dialog box is displayed.

2. Enter a name for the class in the Class name field.

3. Select either Local or Linked Server or ODBC Connection as a means to connect to the
external database.

Note: Once you select a connection type and click OK, you will not be able to change the
connection to the other type. You will need to reconfigure the class to make this type of
change.

Note: The Local or Linked Server option is only available for selection when the OnBase
database is SQL Server.

©
2011 Hyland Software, Inc.
193
 WorkView OnBase 11.0.0

4. Enter the required information for the connection type.

5. Click OK.

Note: External classes do not appear on the Create menu in the WorkView client. Objects in
an external class are only created by pulling data from the specified table in the specified
external database.

External Class Requirements

Once an external class has been created, several requirements are necessary.
4 HSI Database User
The following requirements must be met for the database that WorkView will externally
connect to:
• The hsi user must have access rights to the database that you want to connect to.
• You must permit db_datareader in the Database Role to the hsi user.

Attributes
There must be only one Integer data type attribute that has a Unique setting in the Index
drop-down select list. This attribute must be linked to a column in the external database table
that has unique integer formatted data.
In addition, all attribute data types should match the data format existing in the database
column to which they are linked.

©
2011 Hyland Software, Inc.
194
OnBase 11.0.0 WorkView

Configuring External Classes

When an external class is created, a screen especially designed to configure external classes is
displayed. The following is an example of this screen:

Connection
The Connection... button in the external class configuration screen accesses the Edit
connection settings dialog box. This dialog box has identical options as the New external
class dialog box. The difference between these two dialog boxes is that the Edit connection
settings dialog box does not allow the type of connection to be changed. Whatever
connection type is not selected initially will be disabled.
The following fields are in both the New external class dialog box and the Edit connection
settings dialog box:

Field Description

Class Name Name used for class. Not editable in the Edit
connection settings dialog box. The class
name can be changed in the class
configuration screen.

©
2011 Hyland Software, Inc.
195
 WorkView OnBase 11.0.0

Field Description

Local or Linked Server

Select this option if the WorkView
Configuration tool is on the same server
as the database you want to connect to
and you are able to connect directly to the
server on which the external database
resides. This option is the preferred
method of connecting to a database and
provides greater functionality between
the two options. You can specify
4 identifying information for a linked
server by clicking on the ellipsis (...)
button and entering the appropriate
information. See page 198 for more
information concerning linked server
configuration.

Note:This option is not supported in Oracle

databases and will be disabled.

Server
Enabled when the Local or Linked Server
option is selected. This specifies either the
local server or allows you to specify settings for
a linked server by clicking on the ellipses
button and entering the appropriate
information.

Database
Enabled when the Local or Linked Server
option is selected. This field should contain the
name of the database to which WorkView will
connect. Depending on the type of database,
this field may be blank.

©
2011 Hyland Software, Inc.
196
OnBase 11.0.0 WorkView

Field Description

Table name Enabled when the Local or Linked Server

option is selected. This field should contain the
name of the table from which you want to pull
information. When using a SQL Server
database, the table name must be prefaced
with the db_owner. For example if the
db_owner is dbo and the table name is
TableName, this field would contain
dbo.TableName.

Truncate timestamp for date queries This check box should be selected when an
external database uses the SQL_DATE
datatype for columns. When selected, all 4
WorkView DATE types within the class are
assumed to match this database specific
datatype.

ODBC Connection
Select this option when you want to connect to
a database via a ODBC connection. This
option does not allow sorting or filter criteria to
be utilized using the associated external class.

Datasource
Enabled when the ODBC Connection option
is selected. This drop-down select list displays
all of the configured ODBC connections on the
workstation. Select the appropriate ODBC
source to connect to the appropriate database.

Username
Enabled when the ODBC Connection option
is selected. This field should contain the
username for the database used during ODBC
source configuration.

Password
Enabled when the ODBC Connection option
is selected. This field should contain the
correct password associated with the
username entered in the Username field.

©
2011 Hyland Software, Inc.
197
 WorkView OnBase 11.0.0

Configuring a Linked Server

A linked server can be configured if the user attempting the configuration has administrative
database rights for the database to which he or she wishes to connect. In order to configure a
new linked server, click on the ellipsis (...) button in the Edit connection settings dialog box.
The New linked server dialog box is displayed.

In order to successfully link to a database, all of the parameters must be specified correctly.
The following is a list of the parameters and a description for each.

Field Description

Linked server name Enter the workstation name of the server on

which the database resides.

Note:This field is limited to 254 characters.

©
2011 Hyland Software, Inc.
198
OnBase 11.0.0 WorkView

Field Description

Provider Select the method through which the

connection will be made. The available
selections are ODBC (MSDASQL), Oracle
(MSDAORA), or SQL Server (SQLOLEDB).

Source Enter the database name to which the

connection will be made.

User ID Enter the user name of the user that can obtain
direct access to the database.

Password Enter the password for the user entered in the

User ID field.
4
Once parameters are specified, click OK. If you do not have administrative privileges for the
database, you will not be able to connect to the configured linked server. The following is an
example of an error that is received when a user does not have appropriate database
privileges:

Note: If an error is encountered after clicking OK, the entered linked server information is not
saved.

©
2011 Hyland Software, Inc.
199
 WorkView OnBase 11.0.0

Attributes
External classes also have different attribute configuration screens than other classes, and
therefore, have slightly different configuration steps that must be completed. To configure
attributes for an external class:

1. In the external class configuration screen, click Attributes... The attribute creation screen
is displayed.

©
2011 Hyland Software, Inc.
200
OnBase 11.0.0 WorkView

2. Click Create new attribute. The attribute configuration screen is displayed.

3. Enter a name for the attribute in the Attribute name field.

4. Enter the value you want to use for the display in the Display name field.
5. Select an appropriate data type from the Data Type drop-down menu. The data type must
match the type of data that will be pulled from the external database column.
6. Enter the column name that you want to pull data from in the external database in the
External data column field. The column must reside in the table specified when the
connection was configured. See page 195 for more information.
7. One Integer data type attribute must have the Unique value selected in the Index drop-
down menu. Only one attribute can have this setting.

©
2011 Hyland Software, Inc.
201
 WorkView OnBase 11.0.0

8. Click Save.
9. Repeat steps 1-8 for each attribute you want to add.
10. When you are finished adding attributes, click Done.
11. Click Build DB view.

Note: Build DB view is only available if Local or Linked Server connection type is used. An
ODBC connection does not require this step.

12. Click Yes.

13. Click Yes again.
4 14. Click OK.
15. Click Done.
16. Click Save.

Note: The Default value and Dataset options are not available for attributes configured for an
external class.

Note: The Relationship and Document data types are not available for attributes configured in
an external class.

Screen
Once attributes are configured for the class, views can be created to display the information
that is pulled from the external database to users. In addition, actions can be configured for
screens. Screens are configured for external classes the same way that they are configured for
all other classes. See page 265 for information.

Configuring the Class Title

The configured class title name will appear in the views associated with this class if the screen
does not have a screen title configured. The class title will always be used in the calendar view
to identify objects.

©
2011 Hyland Software, Inc.
202
OnBase 11.0.0 WorkView

To configure a class title:

1. From the class configuration screen, click Class Title. The class title configuration screen
displays.

2. Create a title for your class using text and the available options. Double-click on an
option to add it to the title. If you double-click on the Attribute value option, a list of
available attributes will display for selection. The maximum number of character for the
class title is 255 characters. Attributes with a length greater than 255 or of the Text data
type are not available for selection. The Legend lists the options and the characters that
represent these options in the Class title field.
3. Click Save.
4. Upon clicking Save, a confirmation dialog will display asking Do you want to update all
existing objects of this class with the new title? If you click Yes, all existing objects
within the class will be updated with the new class title. If you click No, only newly
created objects will be affected by the new class title.
5. Click Save again.

©
2011 Hyland Software, Inc.
203
 WorkView OnBase 11.0.0

Note: Class titles are displayed in calendar views to identify objects.

Class Title Items

The following items are available to use to build a class title:

Item Description

Separator Inserts a space, followed by a hyphen, followed by another

space.

Class name Inserts the name of the class.

4 Date created Inserts the date the object was created.

Date last modified Inserts the date the object was last modified.

Created by user Inserts the username of the of user that created the object.

Last modified by user Inserts the username of the user that modified the object.

Created by real name Inserts the real name of the user that created the object.

Last modified by real name Inserts the real name of the user that modified the object.

Object ID Inserts the Object ID of the object.

Attribute value When this item is double-clicked, a list of available attributes is

available for selection. Double-click on an attribute to insert it
into the Class title field. The value of the attribute associated
with the object will be inserted into the class title.

Updating Class Titles

In some cases you may want to update the class title for an object. To change a class title:

1. Click Class Title

2. Change the Class title field appropriately.
3. Click Save.
4. Upon clicking Save, a confirmation dialog will display asking Do you want to update all
existing objects of this class with the new title? If you click Yes, all existing objects
within the class will be updated with the new class title. If you click No, only newly
created objects will display the new class title.

©
2011 Hyland Software, Inc.
204
OnBase 11.0.0 WorkView

CREATING ATTRIBUTES
Attributes are data items within a class. Attributes can be thought of in terms of “fields” or
database “columns”. Launch attribute creation in one of two ways:
• Expand an application, its classes, and an individual class in the left pane. Select
Attributes, or
• In the class configuration screen, click the Attributes button.

The attributes screen displays.

©
2011 Hyland Software, Inc.
205
 WorkView OnBase 11.0.0

To create an attribute:

1. Click Create new attribute. The attributes configuration screen displays.

2. Enter the name of the attribute in the Attribute Name: field. No spaces or symbols can
exist in this name. The maximum number of characters that can be used in this field is 99
characters.
3. Enter the value you would like displayed for the attribute in the Display Name: field. The
maximum number of characters that can be used in this field is 99 characters. If you tab
from the Attribute Name: field to the Display Name: field, the value from the Attribute
Name: field will automatically populate the Display Name: field. This value can contain
spaces and symbols. This value will populate the Heading value when creating filters.

©
2011 Hyland Software, Inc.
206
OnBase 11.0.0 WorkView

4. Select the appropriate data type for the attribute from the Data Type: drop-down menu.
A list of available data types and their descriptions follow.

Data Type Description

Alphanumeric Alphanumeric data up to the maximum

characters allowed by the database. Can
use up to 8000 characters in a SQL Server
database and up to 4000 characters in an
Oracle database.
In a SQL Server database, if you choose
to set the maximum number of characters
above 4000 characters, all characters over
4000 entered in the Client will be “invisible” 4
to the user in the field unless the text is
highlighted. This is general functionality of
alphanumeric fields in HTML.

Caution:It is not recommended for

attribute lengths to be changed if a value
exists on an object for the attribute.

Integer Numeric data containing any value

between -2147483648 and 2147483647.

Date Date data. Formatting is controlled by the

regional setting.

Text Alphanumeric data. Only allows wild card

searching.

Relationship Used to lookup data (set in the Designer).

You must specify a Related Class.

Boolean Used for true or false values.

Currency Formatted as a monetary amount. The

maximum field length is 20 characters.
Formatting is controlled by the regional
setting.

Date/Time Date and time data. Formatting is

controlled by the regional setting.

©
2011 Hyland Software, Inc.
207
 WorkView OnBase 11.0.0

Data Type Description

Floating Point Numeric values that have several possible

locations for the decimal point placement
or have more than 2 decimal places.
(Examples include interest rates and
ratios.)

Note:Values that have more that 6

decimal places will be rounded to 6
decimal places.

Document Stores direct links between a WorkView

4 object and a specific document within
OnBase.

Note:This attribute type is only supported

in the View Designer.

Formatted Text Allows user to format text entered into field

in the Client. Adds the Edit Text button to
a field which opens the Edit dialog box.

Note:Data entered within a field of this

type is not searchable within Workview
filters.

5. If applicable, enter the maximum length for the attribute.

6. If you selected Relationship for the data type, select the class you want the attribute to be
related to from the Related Class drop-down menu. If you want the attribute to exist only
when the object that the attribute value was taken from in the related class exists, select
the Dependent on related class check box. Also, if this option is selected, when an object
is deleted that is related to another object, a prompt stating This object contains
dependent objects. Are you sure you want to delete this object and all dependent
objects? displays. Clicking Yes allows you to delete all related objects in addition to
the
selected object. An example of when deleting dependent objects might be useful is if you
have Vendor objects and Contact objects. Each Vendor has a Contact. When you delete a
Vendor from OnBase, there is a good chance that you might want to delete the Vendor’s
Contact information from OnBase. Using this feature, the Contact object is automatically
deleted when the related Vendor object is deleted.

©
2011 Hyland Software, Inc.
208
OnBase 11.0.0 WorkView

7. As an option you can configure a default value for the attribute (more information found
on page 210) and a Data Set that can be used for the attribute (more information found
on page 213). You can also configure attributes with indexing specification (more
information found on page 224). Indexing is automatically set for attributes using the
Relationship data type. The Advanced button, for default values, provides the following
default value options, which differ depending on attribute type.
• Alphanumeric: Separator, Logged-in user name, Logged-in user’s real name, Existing
sequence
• Integer: Existing sequence
• Date: Current date, First day of current month, Last day of current month, Last
business day
4
• Currency: Existing sequence
• Date/Time: Current date, First day of current month, Last day of current month, Last
business day
• Floating Point: Existing sequence
• Text: Separator, Logged-in user name, Logged-in user’s real name, Existing sequence

Note: The Default value field is disabled for the Document and Relationship data types.

Note: If you attempt to assign a Data Set that contains values that do not match the attribute’s
data type, the following message will be displayed: Warning! The selected dataset contains
one or more values that are invalid for the current attribute data type. WorkView does not
prohibit you from using Data Sets with invalid values in relation to attribute data types.

Note: If you select a Data Set, you will only be able to select a value from it in the Default
Value field.

8. If you want to allow tracking of changes made to the selected attribute in objects on
objects’ History tab, select the Track changes check box, which is selected by default. If
you do not want to allow changes to be tracked for the specific attribute on the objects’
History tab, deselect the option.

Note: Attributes will only be viewable in the History tab if the current user has rights to see
the attribute in a view. If the attribute does not belong to a view that the user has access to,
the History tab will not display the attribute.

©
2011 Hyland Software, Inc.
209
 WorkView OnBase 11.0.0

Note: The Track changes check box in this screen will control only the selected attribute. If
you want to track changes to all attributes within a class, select the Track changes check box
for the appropriate class. See page 177 for further information.

9. Click Save.
10. Repeat steps 1 through 8 for each attribute you want to add to the selected class.
11. When all attributes are created, click Done.
12. Click Build DB Table. You are prompted with Are you sure you want to create the
database tables for this class? message. Click Yes to build the database tables, or click No
to cancel the process.
4
Note: You must build the DB table before configuration is complete.

13. Click Save. In some instances you will receive a Datatype constraint message dialog box.
When this occurs, the data type that has been selected cannot be used in a filter constraint
or for sorting. Click Yes to continue and save the attribute configuration. Click No if you
want to reconfigure the attribute with a different data type.

When a new attribute is created, it is displayed in the Attributes for class ”class name” box at
the bottom of the left pane with an asterisk (*) beside of it to denote it is a newly created
attribute.
If the database tables are not up-to-date, the following message will display: The database
table for this class needs to be created! Do you want to do this now? When you select Yes
and the database table is successfully updated, the following message displays: Database table
for this class successfully created.

Default Values
To configure a default value, you can do one of two things:
• You can enter the value in the field manually, or
• You can click the Advanced button and use the available label buttons to create the
appropriate value.

Note: The maximum number of characters a default value can be is 100.

©
2011 Hyland Software, Inc.
210
OnBase 11.0.0 WorkView

Note: When using a boolean attribute, a default value of 0 is false and a default value of 1 is
true. If a value of 1 is not specified, the default boolean attribute value is automatically NULL
when an object is created.

The Advanced button provides options for configuring the default values. These options
include:

Button Description

Separator Adds a space, a hyphen, and another

space to separate the different symbols (-).

Logged in user name Uses the user currently logged in as the 4

default value. If you use %U[objectName]
as the default value for a relationship
attribute, the default value will use the
configured class title to match with the
user name.

Current date Uses the current date as the default value.

First day of current month Uses the first day of the current month as
a default value.

Last day of current month Uses the last day of the current month as a
default value.

Last business day Uses the pervious business day of current

month (Monday – Saturday) as a default
value.

Existing sequence Allows you to use an existing sequence for

the default value. Select the appropriate
sequence from the pop-up menu that
displays.

Note: You can also create a new sequence by clicking the Insert new sequence button. For
more information see page 212.

©
2011 Hyland Software, Inc.
211
 WorkView OnBase 11.0.0

Creating Sequences
Sequences can be created to produce an incremental default value for attributes. To create a
sequence, do one of the following actions:
• Expand <Shared Objects> in the left pane, select Sequences, right-click in the right
pane, and select Add new… , or
• In the attribute configuration screen, click Advanced, then New Sequence.

Either of these actions will display the sequence configuration screen.

In the sequence configuration screen:

1. Enter the name of the sequence in the Sequence Key Name: field.
2. Enter the value you want the sequence number to start on.
3. If you want the sequence to be available for selection in all applications, select the Allow
other applications to use this sequence check box.

Note: If this is configured from <Shared Objects>, this option is selected by default and
cannot be edited.

4. Click Save. A Sequence ID will automatically be assigned.

5. Click Done.

©
2011 Hyland Software, Inc.
212
OnBase 11.0.0 WorkView

Datasets
Datasets that are already configured are available for selection in the Dataset drop-down
select list on the attribute screen. Application specific datasets are listed first, then shared
dataset, separated by ------- characters.
You can create Datasets that are available for attributes. To create a Dataset, do one of the
following:
• Expand <Shared Objects> in the left pane, and select Datasets. Right-click in the
right pane and select Add new… , or
• Select Create new dataset | Add new dataset in the attributes configuration screen.

Alternately, you can edit an existing dataset by clicking Edit dataset in the attributes
configuration screen.
4
The Data Set configuration screen displays.

©
2011 Hyland Software, Inc.
213
 WorkView OnBase 11.0.0

The Allow other applications to use this dataset check box makes the dataset available for use
in all applications. If this option is not selected, the dataset will only be available in the
application(s) it is currently used in and will be removed from the list of datasets listed in the
<Shared Objects> Datasets node. The dataset will be listed under Resources for the
applications it is used in. If a dataset is not shared and it is only used in one class, if the class is
deleted, the dataset is also deleted.
The Move up and Move down buttons can move a set value up or down in the list of values
within the same Parent ID. The Sort items button will sort all values within the same Parent
ID alphabetically. If more than one Parent ID exists, each set of values will be sorted
alphabetically within their Parent ID.

4 Note: You cannot arrange values from one Parent ID within values of another Parent ID.
Values are grouped by the Parent ID to which they belong.

Tip: If the entire data set value is too long to be displayed in the list box, hover over the item
in order to see the value in its entirety.

There are four ways to enter Data Set information into OnBase for an attribute:
• Manually adding each value one at a time.
• Manually add a list of values.
• Importing values from a .txt file.
• Importing values that exist in a Data Set within OnBase.

To manually add each value one at a time:

1. If appropriate, select a Parent Dataset. For more information on parent data sets, see
page 219.
2. Enter a name for the Data Set in the Dataset Name: field.
3. Enter a value and assign Parent Data (if appropriate) from the drop-down menu. Parent
Data specifies what values are available when a specific parent data set value is selected.
4. Click Add.
5. Repeat steps 2-3 to add multiple values in the Data Set.
6. When you are finished configuring the Data Set, click Save.

©
2011 Hyland Software, Inc.
214
OnBase 11.0.0 WorkView

To manually add values in a list:

1. Enter a name for the Data Set in the Dataset Name: field. This field cannot contain any
spaces or symbols.
2. Click Add list. The Dataset List dialog box displays.

3. Select the appropriate Parent ID value. For more information on parent data sets, see
page 219.
4. Enter the list of values to be included in the Data Set in the large box. Enter only one
value on each line, followed by a return.
5. Click OK. The values will populate in the Data Set screen.
6. When you are finished configuring the Data Set, click Save.

Note: When entering a list of values, all of the values must belong to the same Parent ID.

©
2011 Hyland Software, Inc.
215
 WorkView OnBase 11.0.0

To import Data Set values from a .txt file:

1. Enter a name for the Data Set in the Dataset Name: field.
2. Click Import from File. The Import Dataset File dialog box displays.

3. Enter the path to the .txt import file, including the file name, or click Browse to browse
to the file.
4. Enter the Delimiter character used to signify the beginning and end of values in the .txt
file.
5. Enter the Separator character used to separate the values in the .txt. If this field is left
blank, each value has to be separated by a new line.
6. Select the appropriate Parent ID that applies to the values included in the import file. For
more information on parent data sets, see page 219.
7. Click OK. The values from the import .txt file will populate in the Dataset screen.
8. When you are finished configuring the Data Set, click Save.

©
2011 Hyland Software, Inc.
216
OnBase 11.0.0 WorkView

To import values existing in a Data Set within OnBase:

1. Enter a name for the Data Set in the Dataset Name: field.
2. Click Import from DB. The Import Database Dataset dialog box will display.

3. Select the appropriate Datasource from the drop-down menu.

4. Click Connect. The available Data Sets will populate in the Dataset keyword drop-down
menu.
5. Select the Data Set that you want to import values from the drop-down menu.
6. Select the appropriate Parent ID that applies to the values included in the data set. For
more information on parent data sets, see page 219.
7. Click OK. The values from the Data Set within OnBase will populate in the Dataset
screen.
8. When you are finished configuring the Data Set, click Save.

©
2011 Hyland Software, Inc.
217
 WorkView OnBase 11.0.0

EDITING EXISTING DATASET VALUES

You can edit existing dataset values to make necessary changes. To edit a dataset value:

1. In the Data Set configuration screen, double-click on the dataset value you want to edit.
The Edit Dataset Value dialog box is displayed.

2. Enter the new value in the Enter new value field.

3. If you want to update objects that use the old dataset value to reflect the newly updated
value, select the Update existing objects with new value check box.
4. Click Save.
5. Click Save in the Data Set configuration screen.

©
2011 Hyland Software, Inc.
218
OnBase 11.0.0 WorkView

IDENTIFYING WHERE DATASETS ARE USED

If you want to identify what attributes are using a particular dataset, you can access that
information within the Datasets <Shared objects> screen. To retrieve this information:

1. Select the appropriate dataset.

2. Right-click on the dataset and select Used By. The Dataset usage dialog box is displayed.

This dialog box will display each attribute to which the dataset is currently assigned. The
information is listed in this format:
Class::Attribute (Application)
Class is the Class in which the attribute resides. Attribute is the name of the attribute to which
the dataset is assigned. Application is the application in which the Class resides.

Parent Data Sets

Parent data sets are used to create nested data sets. This means that a group of data set values
can be associated with a value from another data set. In the client, using parent data sets, the
data set values available for one field would depend on the data set value selected in another
field. For example, if you have a data set that contains all of the departments in a company,
you can link the employees that belong to specific departments. If you have a Human
Resources department and you have Sally, Sandy, and Sue as employees, you can configure
your data set to only show Sally, Sandy, and Sue in the Employees data set when Human
Resources is selected in the Departments data set.
In order to use nested data sets, you must select a Parent Dataset for the data set you want to
want link to values. The Parent Dataset is set in the Data Set configuration screen. Only one
Parent Dataset can be selected for a data set. The Data Set ID number is displayed in
parenthesis next to the Data Set name.

©
2011 Hyland Software, Inc.
219
 WorkView OnBase 11.0.0

Once a Parent Dataset is selected, the values stored in that selected data set are listed in the
Parent ID and Parent Data fields. Parent ID and Parent Data fields are used to associate data
set values with a Parent Dataset value. In our Human Resources example, you would need to
do the following in order to achieve the necessary data set nesting:
• While configuring the Employees data set, the Departments data set needs to be
selected as the Parent Dataset.
• For the following data set values, a Parent ID/Parent Data value must be set to
Human Resources: Sally, Sandy, and Sue.
• Both attributes linked to the Employees and Departments data sets must be placed on
the appropriate views.

4 External Datasets
You can create External Datasets that are available for attributes. External Datasets pull
values from an external database into WorkView. To create an External Dataset, do one of
the following:
• Expand <Shared Objects> in the left pane, and select Datasets. Right-click in the
right pane and select Add New External Dataset, or
• Select Create new dataset | Add new external dataset in the attributes configuration
screen.

Alternately, you can edit an existing dataset by clicking Edit dataset in the attributes
configuration screen.

©
2011 Hyland Software, Inc.
220
OnBase 11.0.0 WorkView

The External Dataset screen is displayed:

The following fields make up this screen:

Field Description

Dataset Name Name used for dataset.

©
2011 Hyland Software, Inc.
221
 WorkView OnBase 11.0.0

Field Description

Local or Linked Server

Select this option if the WorkView Configuration tool is
on the same server as the database you want to connect
to and you are able to connect directly to the server on
which the external database resides. This option is the
preferred method of connecting to a database and
provides greater functionality between the two options.
You can specify identifying information for a linked
server by clicking on the ellipsis (...) button and entering
the appropriate information. See page 198 for more
4 information concerning linked server configuration.

Note:This option is not supported in Oracle databases and will

be disabled.

Server
Enabled when the Local or Linked Server option is selected.
This specifies either the local server or allows you to specify
settings for a linked server by clicking on the ellipses button and
entering the appropriate information.

Database
Enabled when the Local or Linked Server option is selected.
This field should contain the name of the database to which
WorkView will connect. Depending on the type of database, this
field may be blank.

Note:This field is limited to 60 characters.

ODBC Connection
Select this option when you want to connect to a database via a
ODBC connection. This option does not allow sorting or filter
criteria to be utilized using the associated external class.

Datasource
Enabled when the ODBC Connection option is selected. This
drop-down select list displays all of the configured ODBC
connections on the workstation. Select the appropriate ODBC
source to connect to the appropriate database.

©
2011 Hyland Software, Inc.
222
OnBase 11.0.0 WorkView

Field Description

User name
Enabled when the ODBC Connection option is selected. This
field should contain the username for the database used during
ODBC source configuration.

Password
Enabled when the ODBC Connection option is selected. This
field should contain the correct password associated with the
username entered in the Username field.

Note:This field is limited to 63 characters.

4
Table name This field should contain the name of the table from which you
want to pull information. When using a SQL Server database,
the table name must be prefaced with the db_owner. For
example if the db_owner is dbo and the table name is
TableName, this field would contain dbo.TableName.

Column name This fields should contain the name of the column within the
specified table that contains the values you want to use in the
dataset.

Cache Items When this option is selected, values pulled from the external
database will be cached on the server for faster dataset value
access on the client side.

Caution: Values will remain cached until IIS is restarted

or the application pool is recycled on the server;
therefore, when this option is selected, immediate
changes to values in the external database will not be
reflected in the client until the IIS is restarted or the
application pool is recycled on the server.

©
2011 Hyland Software, Inc.
223
 WorkView OnBase 11.0.0

Field Description

Test Connection When this button is clicked, the connection to the database
configured is tested.
If the Password is not entered, enter the password for the
specified User name and click Test Connection.
Upon successful connection, the External Dataset Preview
dialog box is displayed, listing all of the values contained in the
specified table and column.

Indexing
Configuring an attribute with an indexing specification can help to decrease search time by
creating index values that can be searched quickly.

Note: The Allow Duplicate and Unique indexing settings should be used only for attributes
that are frequently searched.

©
2011 Hyland Software, Inc.
224
OnBase 11.0.0 WorkView

This can be accomplished from the Index drop-down menu. The following options are
available:

Option Description

None No special indexing settings are specified.

Searching will not be optimized for the
attribute.

Allow Duplicates Speeds up searching time. The values for

an attribute may not always be unique;
therefore, duplicates are permitted.

Unique Speeds up searching time. The values for

an attribute must be unique. When this 4
setting is set for an attribute, users will not
be able to create an object using a value in
an attribute configured to be unique that
already exists within the class.

Note: Indexing is automatically set for attributes using the Relationship and Text data type.

Moving and Deleting Attributes

You can move attributes up and down on the list using the Move Up and Move Down buttons
on the attributes screen. To modify an attribute, double-click on the attribute’s name. You can
also delete attributes on the attributes screen by selecting the appropriate attribute and
clicking Delete.

Note: You cannot delete an attribute if it is a part of a Keytype Map.

Editing Attribute Limitations

The following are limitations when editing existing attributes:
• For a relationship attribute that is included on a filter or a view, the data type or related
class cannot be edited for the attribute.
• For an attribute that is on a view, the data type cannot be edited; however, Date &
Date/Time data types can be interchanged when the attribute is included on a view.

©
2011 Hyland Software, Inc.
225
 WorkView OnBase 11.0.0

• The length of an attribute cannot be reduced to a value less than the largest value in
the database for the attribute.
• An attribute included in a class that has objects created but the attribute is NOT
included on view and the value is NULL in the database, the data type can be
changed. Date and Date/Time attribute data types can be interchanged when values
for those attributes exist in the database.

Determining Where Attributes Are Used

If you want to find out where attributes are used within the system, select the attribute and
click Used by. The Attribute in use dialog box is displayed. The following is an example of this
dialog box.
4

Sorting
Attribute names can be sorted alphabetically. To sort attribute names alphabetically, click Sort.
Upon clicking Sort, the Move up and Move down buttons are disabled. Upon closing out of
the WorkView Configuration tool and reopening it, the Move up and Move down buttons are
enabled again.

CONFIGURING FILTERS AND FILTER BARS

Filters
Filters can be configured in order to access specific information in the WorkView client.
Filters can be used in views or in filter bars. Filters can be created from the filters screen or
they can be created during the filter bar creation process.

©
2011 Hyland Software, Inc.
226
OnBase 11.0.0 WorkView

To create a filter, do one of the following:

• In the left pane, select the appropriate application and click Create filter.
• In the left pane, expand the appropriate application. Click on Filters. Click Create new
filter, or
• In the filter bar configuration screen, click Create new filter.

The filter configuration screen displays. This screen consists of the five following tabs: Filter,
View Attributes, User Entry Constraints, Fixed Constraints, and Sorting.

To configure a filter:

1. In the Filter tab, enter the name in the Filter Name: field.

Note: No two filters within the same application can have the same Filter Name.

2. Enter a brief description of the filter in the Filter Description: field.

3. Select the appropriate class you want associated with the filter from the Associated Class:
drop-down menu.
4. In the View Attributes tab, enter the appropriate view options. See page 229 for further
details.
5. In the User Entry Constraints tab, enter the appropriate entry parameters. This step is
optional. See page 231 for further details.

©
2011 Hyland Software, Inc.
227
 WorkView OnBase 11.0.0

6. You can create constraints for a filter in order to limit search results in the Fixed
Constraints tab. This step is optional. See page 232 for further details.

7. You can specify the sorting order for a filter in the Sorting tab. This step is optional. See
Sorting Tab on page 234 for further details.
8. When you have completed the configuration for a filter, click Save, then Done.

Note: Text, Formatted Text, and Alphanumeric data type attributes with a length greater than
255 cannot be used in User Entry Constraints, Fixed Constraints, and Sorting.

Configuring Filters for Document Types

4 If you want filters to be available from an open document in OnBase client, you must
associate filters with the appropriate document type. In addition, Document Type
Associations configured for filters are used to configure the Doc - WorkView Object Exists
rule and the Doc - Update WorkView Object From This Document and Doc - Create WorkView
Object From This Document actions in the Workflow module. To associate filters with
document types:

1. From the Filter tab of the filter you want to associate with a document type, click the
Document Types... button.

Note: If you click the Document Types... button before saving the filter, the filter will be
saved. If you click Save after returning to the Filter tab, the following message displays: The
specified filter name and description is already in use. This message just means the filter has
already been successfully saved with the Filter Name and Filter Description provided.

2. Enter the name that you want displayed as the filter in the OnBase Client.
3. Select the document type from the drop-down menu from which you want the filter to
be available.
4. Select the appropriate keytype map from the drop-down menu. For more information
see page 331.
5. Click Add.
6. Click Save.
7. Click Save again.

©
2011 Hyland Software, Inc.
228
OnBase 11.0.0 WorkView

Tip: Once a filter association is saved, the next time you enter this screen, the Document
Type Association ID is listed in the Name column within parentheses

Note: You cannot have a document type association with the same name as another
document type association within the same filter.

Note: You cannot have the same combination of a keytype map and a document type for
multiple associations.

View Attributes Tab 4

The View Attributes tab allows you to configure how filter search results will be displayed.
Only the attributes added to this tab will be displayed. If this tab is not configured, no data
will be displayed. If this is the only tab configured, all objects within the associated class will
display for this filter.

The View Attributes tab allows you to configure the way the filter search results will be
displayed. To configure the view attributes:

1. On the View Attributes tab, double-click on the appropriate attribute in the Available
attributes box to select it.

2. Double-click on all of the attributes that you would like to use as a view attribute.
3. Click Add selected.

©
2011 Hyland Software, Inc.
229
 WorkView OnBase 11.0.0

4. If you want to edit an attribute’s heading, select it in the right hand box and click Heading.
The current heading text will be highlighted. Type the new desired text. The typed text
will replace the highlighted text.

Note: The heading for a view attribute must be unique in the filter.

You can specify the alignment of an attribute by selecting it and clicking Settings. The
Settingsdialog box is displayed.

Select the appropriate option to align the attribute displayed in the filter.
5. Repeat step 4 for any attribute headings you want to edit.
6. If you are done configuring the filter, click Save.

Note: The order of the attributes can be edited by selecting attributes and clicking Move up or
Move Down. In addition, you can click Sort to sort the attribute list alphabetically. Likewise,
you can click Remove Sort to restore the original attribute list order.

©
2011 Hyland Software, Inc.
230
OnBase 11.0.0 WorkView

User Entry Constraints Tab

The User Entry Constraints tab allows you to configure the attribute search fields that users
will be able to enter values into in order to retrieve objects. One or many attribute search
fields can be configured.

To create user entry constraints:

1. On the User Entry Constraints tab, click the gray attribute box, labeled <click here to
select>, on the bottom left-hand side of the tab.

2. Double-click on the appropriate attribute.

Note: Text and Formatted Text attributes are not available for selection.

3. Select a mathematical operator from the drop-down menu. The following operators are
available: =, <, >, <=, >=, <>, NULL, and NOT NULL. The =, <>, NULL, and NOT
NULL operators are the only operators available for alphanumeric, text, and boolean
data type attributes. The NOT NULL operator searches for attributes that have any
value.
4. If you want to use a Data Set associated with an attribute, select Yes from the Dataset
drop-down menu. Select No if you do not want to use a Data Set. The Dataset drop-
down menu is only available when a Data Set is assigned to the selected attribute.
5. Enter the value you would like to be used as the prompt for the user entry attribute field.
6. Click Add.
7. Repeat steps 1 through 6 for all entry attributes you want to add.
8. If you are done configuring the filter, click Save.

©
2011 Hyland Software, Inc.
231
 WorkView OnBase 11.0.0

Note: The order of the attributes can be edited by selecting attributes and clicking Move up or
Move Down.

Fixed Constraints Tab

The Fixed Constraints tab allows administrators to limit the filter results a user receives. An
administrator can add attributes and attribute values that must match in order for objects to
be displayed. When a constraint is added to a filter, objects will only be found if they meet the
criteria of the constraint. One or many fixed constraints can be configured for a filter.

To create a fixed constraint:

1. On the Fixed Constraints tab, click the gray attribute box, labeled <click here to select>,
on the bottom left-hand side of the tab.
2. Double-click on the appropriate attribute.

Note: Text and Formatted Text attributes are not available for selection.

3. Select a mathematical operator from the drop-down menu. The following operators are
available: =, <, >, <=, >=, <>, NULL, and NOT NULL. The =, <>, NULL, and NOT
NULL operators are the only operators available for alphanumeric, text, and boolean
data type attributes. The NULL operator searches for attributes that do not have any
value. The NOT NULL operator searches for attributes that have any value. If NULL or
NOT NULL is selected, any value in the value field is ignored and listed in the field as a
blank string when it is added.

©
2011 Hyland Software, Inc.
232
OnBase 11.0.0 WorkView

4. Enter the value that the attribute must meet in order for objects to be displayed.
Additionally, if an attribute using a data set is selected in step 2, a drop-down select list
containing the values within the data set is available.
5. Click Add.
6. Repeat steps 1 through 5 for all constraints you want to add.
7. If you are done configuring the filter, click Save.

In addition, complex fixed constraints can be configured. This can be accomplished by using
a combination of parentheses and AND/OR operators to construct complex queries.
Parentheses can be used to group constraint items together. To specify a parenthesis before a
constraint item, select the check box before the gray attribute box. To specify a parenthesis
after a constraint item, select the check box after the value field.
4
The AND/OR operator drop-down select list allows you to specify how values are searched
using the fixed constraint items. AND is selected by default. If AND is selected, multiple
fixed constraints must be met in order for objects to be returned in the filter’s results. If OR is
selected, one of the fixed constraints items must be met in order for objects to be returned in
the filter’s results. You can use a combination of the AND and OR operators, coupled with
the use of parentheses in order to yield the desired results.
You can move the constraints up or down in the list by using the Move up and Move down
buttons.
To edit a fixed constraint:

1. Select the fixed constraint item that you want to edit from the list box.

©
2011 Hyland Software, Inc.
233
 WorkView OnBase 11.0.0

2. Change the parameters of the item.

3. Click Modify.

See Appendix B for more information about value options.

Sorting Tab
The Sorting tab allows administrators to specify what attribute(s) are used for sorting, and if
objects are sorted in ascending or descending order according to the selected attribute(s),
when filter results display.

To specify the default sorting order:

1. On the Sorting tab, click the gray attribute box, labeled <click here to select>, on the
bottom left-hand side of the tab.
2. Double-click on the appropriate attribute.

Note: Text and Formatted Text attributes are not available for selection.

3. Select Ascending or Descending from the drop-down menu.

4. Click Add.

Note: Only one instance of each attribute can be in a filter Sort tab.

5. Repeat steps 1 through 4 for each attribute you want to sort.

©
2011 Hyland Software, Inc.
234
OnBase 11.0.0 WorkView

Note: The order of the attributes sorted can be edited by selecting attributes and clicking
Move up or Move Down.

Advanced Tab
The Advanced tab allows you to specify more options for filter results.

If a filter is created for a normal or extended Class, all related classes are available for selection
in the Display as class drop-down select list.
If a filter is created for an Association Class, the associated classes are available for selection
in the Display as class drop-down select list. The class selected in the list will be the class that
objects returned by the filter will display as when a user opens the object. If <<None>> is
selected for an Associated Class filter, only the History and Documents tabs will display for
opened objects.

Note: When an association filter is used as an embedded filter or subfilter, the Display as class
setting is ignored and the appropriate class is displayed when the object is opened from within
the embedded filter or subfilter. For example, if you have three classes: Employee, Issue, and
EmployeeXIssue and you configure an embedded filter of Class ‘EmployeeXIssue’ on a view
for an Employee to display all ‘Issues’ that are associated to that ‘Employee’, when you open
an object from the embedded filter, the Display as class setting is ignored and the object that
is opened is the ‘Issue’ object and not the ‘EmployeeXIssue’ object regardless of the Display
as class setting.

©
2011 Hyland Software, Inc.
235
 WorkView OnBase 11.0.0

When a class is selected in the Display as class drop-down select list, the Return distinct items
option is available. When this option is selected, only unique objects are displayed.
Uniqueness is determined by the View Attributes configured for the filter.
If the Group Like Constraints check box is selected for a filter configured with User Entry
Constraints, when multiple values for the same attribute are included in the search,
parenthesis enclose multiples values of the same attribute to group those together, although
the parenthesis are not visible in the interface. For example, if you have a Name attribute and
Department attribute and you specify two values for the Name attribute and one for that
Department attribute, the search will be structured in the following way:

This search would return objects with the Name Sam and the Department Accounting or
objects with the Name Sally and the Department Accounting. In this way, the parenthesis are
grouping values of the same attribute to create more complex searches.
If the Ability to select multiple rows option is selected, a column containing check boxes is
added to the filter in the Web Client, allowing multiple objects to be selected and deleted at
once.

Editing an Existing Filter

To edit an existing filter from the Application screen, select the appropriate filter and click
Edit filter.

To edit an existing filter from the Filters screen, double-click on the appropriate filter.

©
2011 Hyland Software, Inc.
236
OnBase 11.0.0 WorkView

Copying an Existing Filter

You can copy an existing filter to create a new filter. To copy a filter:

1. Right-click on the filter you want to make a copy of and select Copy filter. A copy of the
filter is displayed.
2. Configure the filter. At a minimum, you must specify a different name for the filter in or
order to save it.
3. Click Save.

Filter Bars
Filter bars can be considered containers for one or more filters. When a filter bar is available 4
in the WorkView client and it is selected, all filters configured for a filter bar are displayed. To
create a filter bar:

1. In the left pane, expand the appropriate application.

2. Select Filter Bars. The filter bars screen displays in the right pane.

3. Click Create new filter bar. The filter bar configuration screen displays.

©
2011 Hyland Software, Inc.
237
 WorkView OnBase 11.0.0

Note: This button will be disabled until a class is created within the application.

4. Enter a name for the filter bar in the Filter bar title: field.
5. Enter a brief description of the filter bar in the Filter bar description: field. The
maximum number of characters is 100.

Note: No two filter bars within the same application can have the same Filter Bar Title.

©
2011 Hyland Software, Inc.
238
OnBase 11.0.0 WorkView

6. Select a filter from the Filter drop-down menu. You can also create a new filter by
clicking Create new filter under the drop-down menu. See Filters on page 226 for further
information about creating filters.
7. Enter the name you want displayed for the filter in the Filter Bar Item field and a
description of the item in the Description field. The maximum number of characters is
100.

Note: No two filter bar items within the same filter bar can have the same name.

8. Click Add.
9. The User Group Security dialog box displays. Select the appropriate user group(s) for the
filter bar item from the Available groups box. 4
10. Click Add>>.
11. Click Save.
12. Repeat steps 6 through 11 to add multiple filters to the filter bar.
13. When you are done adding filters to the filter bar, click Save.
14. The User Group Security dialog box displays. Select the appropriate user group(s) for the
filter bar from the Available groups box.
15. Click Add>>.
16. Click Save.
17. If you want to add multiple filter bars, repeat steps 4 through 16.
18. Click Done.

Caution: If a user is assigned to more than one user group, the least restrictive privileges will be
allowed.

Note: You can edit a filter bar by double-clicking on it in the screen shown in step 2 above.

Tip: If the entire filter bar item name is too long to be displayed in the list box, simply hover
over the item in order to see the name in its entirety.

Use the Move Up and Move Down buttons to put the filter bar items in the order you want
them displayed in the WorkView Client.

©
2011 Hyland Software, Inc.
239
 WorkView OnBase 11.0.0

Editing Filter Bar Item

You may want to edit a filter bar item within a filter bar. In order to edit a filter bar item:

1. Double-click on the filter bar item. The Filter bar item dialog box is displayed.

2. Edit the filter bar item as appropriate.

3. Click Save.

Creating Subfilters
Subfilters can be thought of as filters within filters. In order to create a subfilter for a filter,
there must be a direct relationship to the filter from the originating filter, either through an
association class or a relationship attribute. Subfilters allow you to narrow down filter results
based on related attributes among linked classes in the WorkView client.
An example of subfilter use would be the following instance: There is a Departments class, an
Employees class, and an Issues class. The Employees class has a relationship attribute of
Department Name that is related to the Departments class. The Issues class has a relationship
attribute of Employee Name that is related to the Employees class. In this example, a filter
for the Employees class could be a subfilter of a filter for the Departments class and a filter
for the Issues class could be a subfilter of a filter for the Employees class.

©
2011 Hyland Software, Inc.
240
OnBase 11.0.0 WorkView

Subfilters are configured during filter bar configuration. To configure a subfilter:

1. Navigate to the appropriate filter bar or create a new filter bar. See page 237 for more
information about creating filter bars.
2. In the filter bar configuration screen, select the filter that you want to create a subfilter
for and click Subfilters.

The Subfilter configuration dialog box is displayed.

©
2011 Hyland Software, Inc.
241
 WorkView OnBase 11.0.0

3. Select the appropriate filter from the drop-down select list. Only the filters that are
directly related to the originating filter are listed. If a subfilter is selected, the drop-down
select list available will update to reflect only the filters that are related directly to the last
subfilter configured.
4. Enter a label for the filter bar item.
5. Click Add.
6. If you want to create another subfilter, select the subfilter you created.
7. Complete steps 3 to 5.
8. Repeat steps 6 and 7 for each subfilter you want to create.
9. Click Save.

Note: Subfilters can be nested using relationship attributes. Once a filter associated with an
Association class is added, you cannot nest filters any further.

Moving and Deleting Filters and Filter Bars

You can move filter bars up and down on the list using the Move Up and Move Down buttons
on the filter bars screen. The order in which you see the filter bars displayed is the order in
which they will be displayed in the WorkView client. You can also delete filter bars on this
screen by selecting the appropriate filter bar and clicking Delete.

©
2011 Hyland Software, Inc.
242
OnBase 11.0.0 WorkView

Note: Filters cannot be deleted if they are assigned to a filter bar.

Deleting User-Defined Filter Bars

When you delete a filter bar that is configured as a user-defined filter bar, it is removed from
the Advanced tab of the application and <<None>> is selected in the Filterbar name drop-
down select list. In addition, any user-defined filters that were associated with the filter bar are
also deleted.

CREATING NOTIFICATIONS
Notifications can send information to users via e-mail. Notifications can be sent via timers or
4
they can be attached to specific classes. Notifications can be triggered by a timer, an object
event, or an action. If you want to create a notification for use with timers, the notification
must be configured as a global object.

Note: In order to use notifications, you must have the Hyland Distribution Service properly
installed, configured, and running.

Note: Notifications configured in <Shared Objects> only are sent via a timer or a class level
action.

To create a global notification:

1. Expand <Shared Objects>.

2. Select Notifications. The notification screen is displayed.

©
2011 Hyland Software, Inc.
243
 WorkView OnBase 11.0.0

3. In the right pane, right-click and select Add new.

4. Select a Notification type from the drop-down select list.

5. Enter a Notification Name.
6. Enter a Description

©
2011 Hyland Software, Inc.
244
OnBase 11.0.0 WorkView

7. Configure the correct conditions for the notification to be sent in the Condition test
section. See Condition Test Options on page 248 for more information.
8. When Test filter count is selected in the Condition test section, the Iterations drop-down
select list is enabled. The Iterations drop-down select list allows e-mail messages to be
sent based on the number of objects on a filter. Select the appropriate option.
Once: Sends one e-mail message when the notification is initiated.
Per source object:Sends one e-mail for each object within the selected filter’s results. For
example, if 100 objects are returned in the filter, 100 e-mail messages would be sent.
Per unique source value: Sends one e-mail message for every unique object in filter
results of the selected filter. Uniqueness is determined by the first attribute listed on the
Sort tab of the filter during configuration. If you have 2 objects with the Name attribute 4
value of John Adams and one object with the Name attribute value of Sarah Adams, 2 e-
mail message would be sent.
9. Select a Delivery Method. You can select All at once or Per recipient. If Per Recipient is
selected, an e-mail will be sent out for every recipient individually. If All at once is
selected, one e-mail will be sent to all recipients at once.
10. Click Message Template. See Creating Message Templates on page 251 for more
information.

Note: Entry in the To field is required. Addresses can be separated by a comma or a semi-
colon.

11. Enter the appropriate text.

12. Click Save.
13. Click Save again.
14. Click Done

To create a notification specific to a class:

1. Select the class to which you want to attach a notification.

2. Click the Notifications tab.

©
2011 Hyland Software, Inc.
245
 WorkView OnBase 11.0.0

3. Click Create new notification.

4. Select a Notification type from the drop-down select list.

5. Enter a Notification Name.
6. Enter a Description

©
2011 Hyland Software, Inc.
246
OnBase 11.0.0 WorkView

7. Select the appropriate Object event. See Object Events on page 248 for more
information.
8. Configure the correct conditions for the notification to be sent in the Condition test
section, if appropriate. See Condition Test Options on page 248 for more information.
9. Select a Delivery Method.
10. Click Message Template. See Creating Message Templates on page 251 for more
information.
11. Enter the appropriate text.
12. Click Save.
13. Click Save again.
14. Click Done
4

Note: Notifications created at the class level are not available globally.

Using ObjectPop in Notifications

Notifications can contain URL links that directly open objects using the ObjectPop
functionality. Links can be static or dynamically generated based on the object from which
the notification is generated.
To provide a static link to a specific object, the following format should be followed: http://
<myServer>/<myVirtualdirectory>/workview/
objectPop.aspx?objectid=<objectID>&classid=<classID>
To provide a dynamic link to the object from which the notification is generated, the
following format should be followed: http://<myServer>/<myVirtualdirectory>/
workview/objectPop.aspx?objectid=<<objectID>>&classid=<classID>
The <<objectID>> attribute forces WorkView to grab the objectID of the current object
being created, modified, or deleted. It then attaches this value in the URL
In addition, macros can be used to generate ObjectPop links in notifications, see Data Value
Insertion Tags on page 257 for more information.

Deleting a Notification
To delete a global notification, right-click on the notification and select delete.

Note: If a notification is assigned to a timer., it cannot be deleted. You must remove the
notification from all timers that it is associated with before you can delete the notification.

©
2011 Hyland Software, Inc.
247
 WorkView OnBase 11.0.0

To delete a class-specific notification, select the notification and click Delete.

Object Events
Object events are only available when configuring a notification at the class level. The
following options are available

Option Description

On new A notification is sent when a new object within the Class is

created.

On change A notification is sent when a change is made to the attribute

4 values in an existing object within the Class.

On delete A notification is sent when an object is deleted from the linked

Class.

Condition Test Options

You can set up notifications to only be sent when they meet a certain condition.

Note: The only condition test settings available for global notifications are the Test filter
count and Always options.

Note: The Always option is not available for notifications configured at the class level.

The following condition tests are available:

Option Description

Always The notification is always sent at the interval or specific time

configured at the timer level.

<No secondary test> When this is selected, no conditions, other than those specified
at the Object event level, will need to be met for the notification
to be sent.

Test with script A script must have been added to the Class under the
Advanced tab for use with this option. The configured
notification will be sent based on the criteria stated in the script
and the object event conditions selected.

©
2011 Hyland Software, Inc.
248
OnBase 11.0.0 WorkView

Option Description

Attribute value is Sends a notification when the value of the selected attribute
currently matches the comparison criteria.

Attribute value was set to Sends a notification when the value of the selected attribute was
changed to match the comparison criteria.

Attribute value was changed Sends a notification when the selected attribute value is
changed. Whether or not a notification is sent is dependent
upon the object event(s) selected.
If an object is created with On new selected, and the field for
the specified attribute has a value, a notification is sent;
otherwise, a notification is not sent.
If an object is modified with On change selected, and the field
4
for the specified attribute is changed, a notification will be sent;
otherwise, a notification is not sent.
If an object is deleted with On delete selected, and the field for
the specified attribute contained a value, a notification is sent;
otherwise, a notification is not sent.

Test object against filter This option should be used in conjunction with an Object event
setting. This option will compare the currently created, changed,
or deleted object with the results of a filter. If the condition is set
equal to 0, a notification will be sent when the object is not found
in the selected filter’s results. When this condition is set equal to
1, a notification will be sent when one object is found in the
selected filter’s results. If no value is specified, a value of 1 is
assumed.

Filter for dependant objects This option should be used in conjunction with an Object event
setting. This option requires that the current class has a
relationship attribute linked to another class and that a filter has
been created using this relationship attribute. This option will
compare the currently created, changed, or deleted object with
the results of the selected filter. The Message Template can
be configured to send meaningful messages concerning the
results of the selected filter in relationship to the current object.
When this condition is set equal to 0, a notification will be sent
when no objects are found. When this condition is set equal to 1,
a notification will be when an object is found.

©
2011 Hyland Software, Inc.
249
 WorkView OnBase 11.0.0

Option Description

Test filter count Sends a notification only when the count returned by the
selected filter matches the comparison criteria.
When configuring a shared object notification, all filters
configured for the system are available for selection.
When configuring a class specific notification, only the filters
related to the notification’s class are available for selection.

Note: If any changes are made to a notification and you are using a timer with the
notification, restart the Hyland Timer Service.

4
Note: Any changes to notifications at the class level require a restart of IIS.

©
2011 Hyland Software, Inc.
250
OnBase 11.0.0 WorkView

Creating Message Templates

Message templates can be created by clicking Message Templates when configuring
notifications. The Notification Template dialog box is displayed:

In the Notification Template dialog box, you can enter plain text or HTML code. HTML code
can be used to format the message. HTML provides more flexibility and creativity with
message layout and formatting.
You must specify who to send the notification to in the To field. You can specify an attribute
to pull values from a filter containing e-mail addresses using <<@~FilterName>>
<<Attribute>>;<<@End>>

Note: Entry in the To field is required. Addresses can be separated by a comma or a semi-
colon.

You can provide the information you want to display as the sender of the message in the
From field. If a value is not specified here, the Hyland Distribution Service’s default sender is
used.

©
2011 Hyland Software, Inc.
251
 WorkView OnBase 11.0.0

You can add a subject line to the message by entering information into the Subject field.
You can pull in attribute values and filter results. There are several ways you can insert
information into the message template. The following template tags can be used in the
Message Template to pull information from WorkView directly into an e-mail notification.
If you want to display the data insertion wizard, select the Display data insertion wizard
option. When this option is selected, a pane is displayed within the dialog box that allows you
to select data macros into the message. By selecting a macro from the wizard pane, properly
coded tags are inserted into the message. The following is an example of this:

Date/Time macros (See Date/Time on page 253 for more information), Filters macros (See
Filters on page 255 for more information), and Attributes macros (See Attributes on page 256
for more information), are available for selections. Clicking on the arrow buttons at the
bottom of the pane allow access to each of the category tabs. Click on the category tab that
you want to access. Double-click on a macro to insert it into the message.

Configuring Templates Options

©
2011 Hyland Software, Inc.
252
OnBase 11.0.0 WorkView

USING HTML IN TEMPLATES

HTML can be used for notification message templates and display templates.
If the template body starts with <html> tag (immediately after the top of template macros, if
applicable), for notifications, the message will be sent as an HTML formatted message and,
for display templates, the results will be displayed in HMTL. The rest of the template should
be created with HTML tags as needed. An example of an HTML formatting is:
<html><body>
<<#~Issues Tech>>
</body>
</html>
4
ADDING MACROS TO A TEMPLATE
Within the Notification Template dialog box and Template Editor dialog box, there are
features that allow you to add template macros easily to the template. The following types of
macros can be added to a template from the Notification Template dialog box.
Current User
To add a current user macro, right-click in the dialog box and select Insert | System |
Current User. The <<%U>> macro is inserted. For more information about this macro, see
the table under the Data Value Insertion Tags section of this manual.
Date/Time
To add a date/time macro, select Insert | System | Date/Time. The <<%D>> macro is
inserted. For more information about this macro, see the table under the Data Value Insertion
Tags section of this manual.

©
2011 Hyland Software, Inc.
253
 WorkView OnBase 11.0.0

In addition, you can insert date/time macros with optional formatting. To insert date/type
macros with formatting:

1. Right-click on the dialog box and select View | Date/Time. The Date/Time pane displays.

Note: If you already have the Data pane open, click on the Date/Time tab at the bottom of
the pane.

2. Double-click on the formatting option you prefer. The macro will be inserted, with the
formatting specifications.

For more information about date/time formatting, see the table under the Data Value
Insertion Tags section of this manual
To close the pane, click the X in the upper right-hand corner of the pane or select View |
Date/Time again.

©
2011 Hyland Software, Inc.
254
OnBase 11.0.0 WorkView

Filters
Filter macros that display filter results can be inserted into a template. To insert a filter:

1. Right-click on the dialog box and select View | Filters. The Filters pane is displayed.

Note: If you already have the Data pane open, click on the Filters tab at the bottom of the
pane.

2. Expand All Filters.

3. Double-click on the filter that you would like to insert. An option box is displayed.

4. If you want the filter results displayed in the template constrained upon the attribute
values of the object that initiated the notification or action, select the Constrain Filter to
Parent Object option.

©
2011 Hyland Software, Inc.
255
 WorkView OnBase 11.0.0

5. If you want the filter to be formatted into a table, select the Insert As Pre-Formatted
HTML Table option.

Note: For notification message templates, when the cursor is in the To, From or Subject
fields, the Insert As Pre-Formatted HTML Table option is disabled.

6. Click OK.

To close the pane, click the X in the upper right-hand corner of the pane or select View |
Filters again.

Attributes
4 Attribute macros that display attribute values can be inserted into a template. To insert an
attribute:

1. Right-click on the dialog box and select View | Attributes. The Attributes pane is
displayed.

Note: If you already have the Data pane open, click on the Attributes tab at the bottom of the
pane.

2. Double-click on the attribute that you want to insert into the template.
To close the pane, click the X in the upper right-hand corner of the pane or select View |
Attributes again.

©
2011 Hyland Software, Inc.
256
OnBase 11.0.0 WorkView

DATA VALUE INSERTION TAGS

The following tags will insert data into templates.

Tag Description

<<%U>> Inserts the username of the logged in user initiating the

notification into the text of the notification.

<<AttributeName>> You can place the value of an attribute for a single object into a
notification using this option. A tag can reference a simple
attribute owned by the class, or it may reference attributes from
objects related to the class. Example: <<Vendor.Buyer.Name>>

<<+AttributeName>> Inserts the attribute value of the object as a URL link that opens 4
the object.

<<++related.attrName>> Inserts the related attribute value for the object as a URL link
that opens the related object.

<<#+FilterName>> Runs the filter independent of object constraints and inserts it

into the template as an HTML table with the first attribute listed
for the filter results formatted as a URL link to the object. The
template body should include the <html> tag.

©
2011 Hyland Software, Inc.
257
 WorkView OnBase 11.0.0

Tag Description

<<%D[optional Inserts a date value. There are several formatting options

formatting]>> available that can be placed in brackets. They include:
• %m - Month (1-12)
• %d - Day (1-31)
• %y - Year (e.g. 1999)
• %2[m,d,y] - Force two digit display
• %H - Hour (0-23)
• %h - Hour (1-12)
4 • %M - Minute
• %S - Second
• %p - AM / PM
• %b - Abbreviated month name (e.g. JAN)
• %B - Full month name (e.g. January)
• %a - Abbreviated weekday name (e.g. SUN)
• %A - Full weekday name (e.g. Sunday)
• %w - Weekday (0-6, Sunday == 0)
• %j - Day of year (0 - 366)
• %! - Date formatted according to locale settings
• %% - Percent sign

Note: These same formatting codes can be used to

modify the output of date attribute tags. For example
<<DateOfBirth[%a %b %d, %y]>> will display in the
form SUN JAN 1, 2006.

<<#~FilterName>> Runs the filter independent of object constraints and inserts it

into the template as an HTML table. The template body should
include the <html> tag.

<<#FilterName>> Runs the specified filter constrained to the current object. The
results are formatted in the form of an HTML table which is
inserted into the template. The template body should include the
<html> tag.

©
2011 Hyland Software, Inc.
258
OnBase 11.0.0 WorkView

ITERATIVE TAGS
Iterative tags, or looping tags, start with <<@. These tags process all text starting immediately
after the tag until immediately before a corresponding <<@end>> tag for each object in a set.
The resulting blocks of text are filtered for macros based on each object and the text is
appended to the results. The set of objects is usually defined by a filter results set. The result
will be a block of text being filtered and inserted into the notification for each filter result hit.

Note: Iterative blocks can be nested. When doing so, care should be taken to make sure each
start marker has a correctly placed end marker.

Tag Description
4
<<@@>> <<Attribute>> <p> This code will insert all of the attribute values returned from a
<<@End>> filter when using a filter as a condition. Use of <<@@>>
requires that the filter from which you want to pull values is
already in use. You must also use the <<@End>> tag after
using the <<@@>> option. HTML can be used to format the
values into a table.

<<@@>> <<@@>> is a special case of an iterative tag. In the case of a

timer triggered notification, there is often have a logical
reference to filter results that were obtained as part of the
notification’s condition test. To iterate over this result set, the
<<@@>> tag is used (with the required <<@end>> tag to mark
the end of the block.)

<<@~FilterName>> Runs the filter independent of objects and allows you to pull
values from the specified filter.

<<@FilterName>> Calls the specified filter. In order to successfully use this option,
you must also specify the attributes for which you want values
displayed in the following format:
<<ClassName.AttributeName>> You can use HTML to
format the values into a table.

©
2011 Hyland Software, Inc.
259
 WorkView OnBase 11.0.0

CREATING TIMERS
Timers are used to control when globally available notifications are sent. To configure a timer:

1. Expand <Shared Objects>.

2. Select Timers.

©
2011 Hyland Software, Inc.
260
OnBase 11.0.0 WorkView

3. In the right pane, right-click and select Add new.

4. Enter a Timer name.

©
2011 Hyland Software, Inc.
261
 WorkView OnBase 11.0.0

5. Click Manage notifications. The Manage timer notifications dialog box is displayed.

6. Select the appropriate notification(s) from the Available Notifications list and click
Add>>.

Note: Only notifications configured at the global level will be available from in this dialog
box.

©
2011 Hyland Software, Inc.
262
OnBase 11.0.0 WorkView

7. Select when you want the timer to kick off. You can select a specific day of the week, At
certain time, or at a certain Interval. You can also select a combination of day(s) of the
week and certain times or day(s) of the week and interval.

Caution: If you use a combination of options, they must not contradict each other or the timer will
not initiate.

Tip: When At certain time is selected, you do not have to specify values for every field. For
example, if you want to kick the timer off the 15th of every month at midnight, you can select
12:00:00 AM and 15 from the Day drop-down select list and not specify any other field
values. Drop-down fields let you specify <All> in order to not set a specific parameter.
4
If you configure a date that falls on a non-business day, you can specify that the timer be
fired on the Previous business day or the Next business day in the Business day
adjustment drop-down select list.

If you are using the Interval option, you can further configure specific window of time
when you want the timer to fire. See Timer Windows on page 263 for more information.
8. If you want the timer to only work for a specific length of time, select the day you would
like the timer to expire. Ensure that the check box beside the Expiration date drop-down
select list is selected and the appropriate date is selected.
9. Click Save.
10. Click Done.

Note: If you edit an existing timer that has already fired during the day with the Hyland Timer
Service running and you edit it to fire at a later time that day, a message asking Do you want
the timer to fire today? displays. If you want the timer to fire again that day, click Yes.
Otherwise, click No. You must restart the Hyland Timer Service after making changes.

You can edit a notification from this screen by selecting it and clicking Edit notification.

Timer Windows

Note: If you set a timer window, the timer will only kick off during the configured window(s).

©
2011 Hyland Software, Inc.
263
 WorkView OnBase 11.0.0

To configure specific windows of time within a specified interval:

1. Click New next to the Timer Windows box.

2. Select the appropriate parameters. You can select specific Days of Week, a specific Time,
or a specific Date.

Note: A Time is always configured.

©
2011 Hyland Software, Inc.
264
OnBase 11.0.0 WorkView

Note: When configuring the Date section, you are not required to set a parameter for every
field.

If you configure a date that falls on a non-business day, you can specify that the timer be
fired on the Previous business day or the Next business day from the Business day
adjustment drop-down select list.

3. Click Save when finished.

4. Repeat these steps for each window of time you want to configure.
5. Click Save when finished.

To edit an existing window, select it and click Edit. 4

To delete an existing window, select it and click Delete.

CONFIGURING SCREENS
Screen configuration can be launched in one of two ways:
• Click the Screen button in the class configuration screen, or
• Expand an application, its classes, and an individual class in the left pane. Select
Screen.

The screen configuration screen displays in the right pane. This screen consists of three tabs:
Screen, Views, Actions and Advanced.

©
2011 Hyland Software, Inc.
265
 WorkView OnBase 11.0.0

The Screen Tab

A screen contains all views for a class. Each class has only one screen.

To configure a screen:

1. On the Screen tab, enter the name of the screen in the Screen Name: field. This name
cannot have any spaces or symbols. The maximum number of characters that can be used
in this field is 99 characters.
2. Enter the name to be displayed for this screen in the Display Name: field. The maximum
number of characters that can be used in this field is 255 characters.
3. Click Save.
4. Assign the appropriate user rights to view screens. Click User groups …, select
appropriate user group(s), click Add, and then Save. Only users belonging to the assigned
user group will be able to view or add objects from the screen.

Caution: If a user is assigned to more than one user group, the least restrictive privileges will be
allowed.

5. Configure a screen title for the screen (Optional).

6. When you have completed configuring the screen, click Save.

©
2011 Hyland Software, Inc.
266
OnBase 11.0.0 WorkView

Configuring the Screen Title

The configured screen title name will appear in the views associated with the screen. If a
screen title is not configured, the class title will be used to label the views, if configured.
To configure a screen title:

1. From the screen configuration screen, click Screen Title. The screen title configuration
screen displays.

2. Create a title for your screen using text and the available options. Double-click on an
option to add it to the title. If you double-click on the Attribute value option, a list of
available attributes will display for selection. Attributes with a length greater than 255 or
of the Text data type are not available for selection. The Legend lists the options and the
characters that represent these options in the Screen title field. This title will display on
each view within a screen. Click Save.
3. Click Save again.

©
2011 Hyland Software, Inc.
267
 WorkView OnBase 11.0.0

The Views Tab

Reminder: In April of 2007, OnBase Release 6.4 introduced the new WorkView Designer
functionality to the OnBase WorkView module. The WorkView Designer replaced the classic
View Editor, which was deprecated in Release 6.4. All WorkView applications created in
release 6.4 and subsequent releases must use the WorkView Designer. Ensure that you use the
WorkView Designer when creating current and future WorkView applications. For more
information, please refer to the “Defining the Editor Version” and “WorkView Designer”
sections of the WorkView Module Reference Guide.

4 Note: Because the classic View Editor has been deprecated, ongoing WorkView development
and testing is exclusively focused on the WorkView Designer. Future releases of OnBase are
not guaranteed to support views created with the classic View Editor. It is strongly
recommended that, as part of any OnBase upgrade, you use the WorkView Designer to
reconfigure all existing views that were created with the View Editor. When designing your
upgrade project plan, set aside time to update and test your WorkView views.

Views can consist of fields, filters, and folders, and are used to view and add information to
objects within a class.

You can arrange configured views by selecting views and using the Move up and Move down
buttons.

©
2011 Hyland Software, Inc.
268
OnBase 11.0.0 WorkView

You can edit views by double-clicking on the view. You can delete views by selecting them
and clicking Delete.

Note: If a view is used as a redirected view for an extension class, the view cannot be deleted
until it is deleted from the class.

You can assign user groups to the view by selecting it and clicking the User groups button and
selecting the appropriate group(s).
You can rename a view by selecting the view and clicking Rename. Enter the new view name
in the field and click OK.

Note: If multiple views are configured with the same name, the first view listed that the user 4
has rights to will be the view displayed. All other subsequent views with the same name will
not be available. This is useful when you want two similar views, but one view has sensitive
information that is only for a particular user group.

For more information about configuring views, see WorkView Designer on page 272 and The
Actions Tab on page 303 for more information.

Saving Views With Associated Keyboard Shortcuts

Keyboard shortcuts can be useful when you have multiple views in a screen. By creating
keyboard shortcuts for the view tabs, you can switch between tabs directory from the
keyboard. In order to create keyboard shortcuts that will access a view tab in the WorkView
client, the view must be saved in a specific way. To create a keyboard shortcut, when entering
the name of the view when initially saving the view, place an & (ampersand) character before
a character. Any tab saved in this way can be accessed in the WorkView client by pressing
CTRL + the character directly after the & character. Likewise, you can use this method when
renaming views.

Note: Ensure that the character selected does not already represent a shortcut command for
an existing View or a Windows command.

In the WorkView client, when a view has been configured with a keyboard shortcut, the
character that is used for the shortcut will be underlined.

Redirecting Views
When creating a view from an extended class, you have the option to Redirect view from base
class. This option allows you to use a view configured for the class from which the extended
class originated for the extension class.

©
2011 Hyland Software, Inc.
269
 WorkView OnBase 11.0.0

Note: Redirected views can only be redirected if the base and extension classes both use the
same editor version for views.

To redirect a view:

1. On the Views or Views (classic) tab click Create new view and select Redirect view from
base class. When this option is selected the Redirect view from base class dialog box is
displayed.

2. Select the appropriate view from the Redirected view drop-down select list. All valid base
class views for this class will be listed.
3. Enter an appropriate label for the view in the View title field. The value entered in the
View title: field will populate the Description: field.

4. Enter a description of the view in the Description field.

5. Click OK.

Note: Views can only be edited from the originating class. Redirected views cannot be edited
from an extension class.

©
2011 Hyland Software, Inc.
270
OnBase 11.0.0 WorkView

Defining the Editor Version

The View Designer should be selected for configuration. To select the View Designer as the
active editor for a class:

1. On the class configuration screen, click Screen.

2. On the Screen tab, select View Designer.
3. Click Save
4. Click Save again.

Updating Views
If your system has views created in previous versions of OnBase, you must update those 4
views. To update views:

1. Select Designer | Launch designer.

2. Select Tools | View Updater.

3. Click Check for updates.

4. Click Update Views.

©
2011 Hyland Software, Inc.
271
 WorkView OnBase 11.0.0

5. A message stating Are you sure you want to update these views? Once the processing
begins, it cannot be stopped. is displayed. Click OK to continue. Click Cancel to abort the
process.
6. After updating is complete, close the View Updater dialog box and open each view to
verify that the views are rendering properly in both the Designer and Client.

Backups are created for the views that are modified by the update process. These backups are
placed in the configured WorkView backup directory in \View Updater Backups\<current
date>.

Note: If at any time you import a view that was created prior to version 11.0, you must run
4 the View Updater must be run.

WorkView Designer
To launch the Designer, select Designer | Launch designer from the menu. Alternately,
within the Views tab, click Create new view to launch the Designer.

Note: When the WorkView Designer window is open, you cannot access the WorkView
Configuration Tool window. You must close the Designer to access the standard WorkView
Configuration Tool window.

Creating a View
To create a view:

1. You can initiate the creation of a view in two ways:

• Click the Create new view button from the Views tab.
• Right click on the appropriate class within the View Explorer of the Designer and
select New View.

©
2011 Hyland Software, Inc.
272
OnBase 11.0.0 WorkView

Note: When you create a view from within the Designer, you may be prompted with a dialog
box asking This class is configured to use Original/Classic views. Do you want to switch the
class to use the newer View Designer views? Click Yes to change the active editor to View
Designer. Click No to keep the editor version as Classic/Original. See Defining the Editor
Version on page 271 for more information.

The Name View dialog box is displayed.

2. Enter a name for the view.

3. Click OK. The view is now ready to design.

©
2011 Hyland Software, Inc.
273
 WorkView OnBase 11.0.0

Designer Window
The Designer window will look similar to the following when a view is created:

The screen is made up on several sections. These are:

• Attributes tab: Contains all of the configured attributes for the class to which the
current view is linked.
• Filters tab: Contains all of the configured filters for the class to which the current view
is linked.
• Actions tab: Contains a screen action set with the manually placed option
• Folderstab: Contains a Static Folder, All Folders, and folders configured for the class
to which the current view is linked.
• Properties toolbox: Contains all of the properties that can be configured for the
currently selected item in the View window
• View Explorer toolbox: Contains all applications with their respective classes and
views.

©
2011 Hyland Software, Inc.
274
OnBase 11.0.0 WorkView

• Layout toolbox: Contains controls that format the layout of the view.
• Navigationtoolbox: Contains controls to move view elements.
• View window: This is the editable space in the middle of the screen.

View Menu
The View menu has the following options:

Option Description

Show PlaceHolder Text When this option is toggled on, placeholder text displayed in the
Designer’s view window. When toggled off, the placeholder text
is hidden and is representative of what will be seen in the Client. 4
Default to Show Labels When this option is toggled on, the Show Label property for
attribute controls is set to True by default.

Note:This setting is reset after the Designer is closed.

Launch Web Client Launches the WorkView Client.

Reset Window Positions Resets the window positions to the default layout.

Actions Window Toggles the display of the Actions tab.

Attributes Window Toggles the display of the Attributes tab.

Classes Window Toggles the display of the View Explorer.

Filters Window Toggles the display of the Filters tab.

Layout Window Toggles the display of the Layout toolbox.

Navigation Window Toggles the display of the Navigation toolbox.

Properties Window Toggles the display of the Properties toolbox.

Folders Window Toggles the display of the Folders tab.

©
2011 Hyland Software, Inc.
275
 WorkView OnBase 11.0.0

View Explorer
The View Explorer toolbox contains all applications, their classes, and the classes’ views. To
view the classes within an application, expand the plus sign. There are several right-click
menus that are available when right-clicking on a class:

Option Description

New View Creates a new view for the selected class.

Redirect View Redirects view. Opens the Redirect View dialog box. This
option is only available for extended classes.

View Sequence Opens the View Sequence dialog box that allows you to define
4 the view tab sequence of the class’s screen.

Save Screen Reserved for future functionality.

To view the views within a class, expand the plus sign. There are several right-click menus
that are available when right-clicking on a view:

Option Description

Edit Opens the selected view for editing.

Delete Deletes the selected view.

Description Allows you to enter a description for the selected view.

User Groups Opens the Assign User Groups dialog box to assign user
rights to the selected view.

Copy Makes a copy of the selected view. You will be prompted to

confirm the copy. Upon clicking Yes, a New View dialog box
will be displayed where you should enter the name of the new,
copied view and click OK.

Configuring Styles
You can create a style sheet that will be used for specifying the fonts, formatting, and
background colors for controls. By using styles, a consistent look can be achieved easily for
views. A default style sheet is included.
The default style sheet can be edited to create a custom style sheet. The style sheet can be
customized in the Default Editor or the Style Sheet Editor. The Default Editor provides a
standard text editor for .css editing. The Style Sheet Editor provides an interface to create and
edit styles without any knowledge of .css syntax.

©
2011 Hyland Software, Inc.
276
OnBase 11.0.0 WorkView

To customize the style sheet using the Default Editor:

1. Select Tools | Edit Style Sheet | Default Editor. The Style Sheet Editor dialog box is
displayed.

2. Make the appropriate changes to the style sheet.

3. When changes are complete, click OK.

©
2011 Hyland Software, Inc.
277
 WorkView OnBase 11.0.0

To customize the style sheet using the Style Sheet Editor, select Tools | Edit Style Sheet |
Style Sheet Editor in the Designer. The Style Sheet Editor dialog box is opened for editing.

Within this dialog box, properties of existing blocks can be edited or new blocks can be
created.
To edit properties of a block:

1. Select the block.

2. Edit the properties appropriately.
3. Click the Save Block button.

©
2011 Hyland Software, Inc.
278
OnBase 11.0.0 WorkView

To create a new block:

1. Click New Block.

2. A block named New Block is displayed in the left pane.

3. Edit the properties as appropriate.
4. Change the name of the block to a descriptive name by selecting Edit | Block Name. The
name will become editable.
5. Edit the name. 4
Note: In order for a name to be recognized and displayed in the Select a style class list, it
must begin with a period.

6. Click the Save Block button.

You can also delete blocks by select the block and clicking the Delete Block button.

You can clone blocks to create copies of blocks. Using a cloned block allows you to take all of
the properties of an existing block and modify the cloned block to meets your needs. To clone
a block:

1. Select the block to be cloned.

2. Select Edit | Clone block.
3. Edit the properties as appropriate.
4. Change the name of the block to a descriptive name by selecting Edit | Block Name. The
name will become editable.
5. Edit the name.

©
2011 Hyland Software, Inc.
279
 WorkView OnBase 11.0.0

Note: In order for a name to be recognized and displayed in the Select a style class list, it
must begin with a period.

6. Click the Save Block button.

GENERATING THE STYLE SHEET

Once all appropriate changes are made, the style sheet must be generated to save the changes.
4 Once the style sheet is generated, changes are saved and the style is available for selection in
the Designer. To generate the style sheet, click the Generate style sheet button.

Restoring the Default Style Sheet

The default style sheet can be restored, removing edits to the style sheet. The default style
sheet is found in the configured Resource folder and is named styles.css. If a customized
style sheet exists, it also will be found in the configured Resource folder and is named
customStylesheet.css. When the default style sheet is restored, the customStylesheet.css file
is deleted and the styles.css file is used. To restore the default style sheet:

1. Select Tools | Restore Default Style Sheet.

2. A message stating Restoring the default style sheet will delete all the custom changes
made to the style sheet - Do you really want to restore the default style sheet? is
displayed. Click Yes to continue the restore. Click Cancel to quit the restore. All style
sheet edits are removed the default style sheet is restored.

View Controls
View controls are components that define how the view will look and what data will be
displayed on the view. See Layout Controls on page 281 and WorkView Controls on page 281
for information about types of controls available.

©
2011 Hyland Software, Inc.
280
OnBase 11.0.0 WorkView

Navigation Toolbox
The Navigation toolbox allows you to move controls within a view. Controls can be moved
Up or Down within the view. Controls within table cells can be moved Up, Down, Left, or
Right within the table. To move a control, select the control and click the appropriate
navigation button.

Layout Controls
Views can be made up of several layout controls which define how a view looks. They
include:
• Container : This control groups other controls together. The main editable area is a
container that groups all of the other controls. You can place containers within other
containers. 4
• Table: This control is a table containing cells in which other controls can be placed for
proper formatting and spacing.
• Separator : This control is a line used to separate other layout controls.
• Label: This control allows you to add static text to a view.
• Line Break: This control creates a blank line in between controls.
• Image: This control inserts an image into the view.
• Hyperlink: This control inserts a hyperlink into the view.

WorkView Controls
WorkView controls are controls that are specific to WorkView data. The controls include:
• Attributes: This control type allows you add fields on the view that will contain
attribute values. Attribute controls are available for selection in the Attributes tab.
When configured, a Document attribute is also available that has different properties
than a standard attribute. This attribute control allows you to add a related document
to the view.
• Filters: This control type allows you to place filters within a view. Filter controls are
available for selection in the Filters tab.

Note: User-defined filters are not available for selection.

• Actions: This control type allows you to add configured actions to the view.
• Folders:This control type allows you to place a static folder or a configured dynamic
folder within a view.

©
2011 Hyland Software, Inc.
281
 WorkView OnBase 11.0.0

Note: If a control is placed into a table cell that already contains a control, the new control
will be placed in an empty cell within the table. If no empty cell exists, a new row will be
created in the table and the control will be placed in the new row.

Properties
The Properties toolbox contains all configurable properties for the selected control within the
view. Depending on the type of control that is selected, the toolbox displays different
properties. The drop-down select list displays the currently selected control. You can use the
drop-down select list to select the control for which you want to set property values.

4 Note: Property options override values specified in the .css file.

The Properties toolbox has several buttons that control the display of the toolbox.

Button Description

The Categorized button sorts the contents of the Properties

toolbox into categories

The Alphabetical button sorts the contents of the Properties

toolbox alphabetically.

The Properties button displays the properties of the selected

control in the Properties toolbox.

The Scripts button displays the script options for the selected
control in the Properties toolbox.

GENERAL
The following properties are available for all controls.

Property Description

Background Color Specifies the color used for the background of the selected
control.

Name The identifying name of the control.

©
2011 Hyland Software, Inc.
282
OnBase 11.0.0 WorkView

TABLES
The following properties define a table’s appearance.

Property Description

Border Color Specifies the border color. Any hex value can be specified.

Border Style Specifies the style of border in the table. The following styles are
available: none, dotted, dashed, solid, doubled, groove, ridge,
inset, and outset.

Border Type Specifies where borders will display in the table. The following
types are available: all, columns, exterior, or rows.

BorderWidth Specifies the width of the border, measured in pixels.

4
CellPadding Specifies the amount of space between the border of a cell and
the text contained within the cell. (0-1000)

CellSpacing Specifies the amount of space between individual cell border

lines. (0-1000)

Columns Clicking on the ellipsis button opens the TableColumn

Collection Editor dialog box, allowing you to format columns
within the selected table.
Within the TableColumn Collection Editor dialog box, the
following can be defined:
HorizontalAlignment: Aligns controls horizontally within the
column.
Name: Name of the column.
VerticalAlignment: Aligns controls vertically within the
column.
Width: Defines the width of the column. The value entered can
be in percent of the table or in pixels. If entering a percentage,
include the percent sign (%) after the value.
Columns can be moved within the table using the arrow buttons.
You can add a column by clicking Add. A column can be deleted
by selecting a column and clicking Remove.

Height Defines the height of the table. The value entered can be in
percent of the screen or in pixels. If entering a percentage,
include the percent sign (%) after the value.

©
2011 Hyland Software, Inc.
283
 WorkView OnBase 11.0.0

Property Description

Rows Clicking on the ellipsis button opens the TableRow Collection

Editor dialog box, allowing you to format rows within the
selected table. Row height can be configured in the TableRow
Collection Editor dialog box.
Within the TableRow Collection Editor dialog box, the
following can be defined:
Height: Defines the height of the row. The value entered can be
in percent of the table or in pixels. If entering a percentage,
include the percent sign (%) after the value.
Name: Name of the row.

4 Rows can be moved within the table using the arrow buttons.
You can add a row by clicking Add. A row can be deleted by
selecting a row and clicking Remove.

Text Reserved for future functionality.

Width Defines the width of the table. The value entered can be in
percent of the screen or in pixels. If entering a percentage,
include the percent sign (%) after the value.

SEPARATORS
The following properties define a separator’s appearance:

Property Description

Height Specifies the height of the selected separator control. The value
entered can be in percent of the screen or in pixels. If entering a
percentage, include the percent sign (%) after the value. The
space will have a line at the top of the control, followed by the
blank space.

Text Reserved for future functionality.

Width Specifies the width of the selected separator control. The value
entered can be in percent of the screen or in pixels. If entering a
percentage, include the percent sign (%) after the value.

©
2011 Hyland Software, Inc.
284
OnBase 11.0.0 WorkView

CONTAINERS
The following properties define a container’s parameters:

Property Description

Align Specifies how the label will be aligned within the container. The
label can be aligned left, right, justify, or center.

Height Appearance section - Specifies the height of the selected

container control. The value entered can be in percent of the
screen or in pixels. If entering a percentage, include the percent
sign (%) after the value. The space will have a label and a line at
the top of the control, followed by the blank space.
Label Section - Specifies the height of the label area of the
4
container control. The value entered can be in percent of the
container or in pixels. If entering a percentage, include the
percent sign (%) after the value.

Style Allows you to select a style from the Select a style class dialog
box to format the Label text.

Text Specifies the text used at the top of the container to identify its
contents.

Text Align Specified how the text will be aligned within the label area
defined. The text can be aligned left, right, justify, or center.

Width Appearance section - Specifies the width of the selected

container control. The value entered can be in percent of the
screen or in pixels. If entering a percentage, include the percent
sign (%) after the value.
Label Section - Specifies the width of the label area of the
container control. The value entered can be in percent of the
container or in pixels. If entering a percentage, include the
percent sign (%) after the value.

LABELS
The following properties define a label’s appearance:

Property Description

Height Specifies the height of the selected label control. The value
entered can be in percent of the screen or in pixels. If entering a
percentage, include the percent sign (%) after the value. The
label will be followed by blank space.

©
2011 Hyland Software, Inc.
285
 WorkView OnBase 11.0.0

Property Description

Style Allows you to select a style from the Select a style class dialog
box to format the Label text.

Text Specifies the text that the label will display.

Text Align Specifies how the label will be aligned. The label can be aligned
left, right, justify, or center. This setting affects how the text will
be aligned within the control, which is dependent on the width of
the control set in the Width setting.

Width Specifies the width of the selected label control. The value
entered can be in percent of the screen or in pixels. If entering a
4 percentage, include the percent sign (%) after the value.

LINE BREAKS
The following properties define a line break’s parameters:

Property Description

Height Specifies the height of the selected line break control. The value
entered can be in percent of the screen or in pixels. If entering a
percentage, include the percent sign (%) after the value. The
space will be blank space.

Text Reserved for future functionality.

Width Specifies the width of the selected line break control. The value
entered can be in percent of the screen or in pixels. If entering a
percentage, include the percent sign (%) after the value.

IMAGE
The following properties define how an image control is displayed in the view:

Property Description

Height Specifies the height of the selected image control. The value
entered can be in percent of the screen or in pixels. If entering a
percentage, include the percent sign (%) after the value.

Text Reserved for future functionality.

Width Specifies the width of the selected line break control. The value
entered can be in percent of the screen or in pixels. If entering a
percentage, include the percent sign (%) after the value.

©
2011 Hyland Software, Inc.
286
OnBase 11.0.0 WorkView

HYPERLINK

Property Description

Style Allows you to select a style from the Select a style class dialog
box to format the Text property text.

Text Specifies the text that will display in the hyperlink.

Width Specifies the width of the selected hyperlink control. The value
entered can be in percent of the screen or in pixels. If entering a
percentage, include the percent sign (%) after the value.

Name Name of hyperlink control.

4
URL This is the URL that will be initiated in the client when the
hyperlink is clicked.

ACTIONS
The following properties define an action control’s appearance and functionality:

Property Description

Action ID System property. Not editable by user. Only displayed for

Server-Side actions.

Action Name System property. Not editable by user. Only displayed for
Server-Side actions.

Height Specifies the height of the selected action control. The value
entered can be in percent of the screen or in pixels. If entering a
percentage, include the percent sign (%) after the value. The
control will have a button followed by blank space if the button
does not take up the full height of the control.

Help Text Displays specified text when the selected action control button is
hovered over in the Client.

Note:Up to 256 characters is supported. Characters entered

beyond 256 characters will be truncated.

Styles See Style Collection Editor on page 296 for more information.

Text Defines the text displayed on the button.

©
2011 Hyland Software, Inc.
287
 WorkView OnBase 11.0.0

Property Description

Width Specifies the width of the selected action control. The value
entered can be in percent of the screen or in pixels. If entering a
percentage, include the percent sign (%) after the value.

ATTRIBUTES
The following properties define an attribute field’s appearance and functionality:

Property Description

DisplayType This property is only displayed when the attribute is of the

4 boolean data type. Defines the form field type used for the
attribute. The only option available is Checkbox.

Height Specifies the height of the selected attribute control’s field. The
value entered can be in percent of the screen, table cell, or
container in which the field resides or in pixels. If entering a
percentage, include the percent sign (%) after the value.

Help Text Displays specified text when the selected attribute control is
hovered over in the Client.

Note:Up to 256 characters is supported. Characters entered

beyond 256 characters will be truncated.

Label Specifies the text that will be displayed above the attribute field.

©
2011 Hyland Software, Inc.
288
OnBase 11.0.0 WorkView

Property Description

Lookup Button This property is only available for Relationship data type
attributes configured to be dependent on another class, Date
data type attributes, and attributes that use a dataset.
When this property is used for a Relationship attribute, it
allows users to populate the field with a value from another
class. When set to True, a lookup button is placed next to the
field, allowing values to be pulled from a related object.
When the first relationship attribute for a related class is inserted
into a view, the Select a filter for <Attribute Name> dialog
box is displayed. Select the filter for which you want to look up
related objects.The filter selected will be used for all subsequent
relationship attributes inserted into the view for the same related 4
class. In order to use another relationship attribute field to look
up objects using a different filter, the Lookup Button property
must be set to True and you must define the filter that should be
used in the Lookup Filter property. Click the ellipsis button for
the Lookup Filter property to access the Select a filter for
<Attribute Name> dialog box
If a field is set with the Lookup Button property set to True,
but not the Read Only property, users can enter partial values,
press F6 and have the corresponding value populate the field. If
multiple values exist that match the characters entered in the
field, a dialog box will display the matching values for selection.

Note:If you select a filter that has user entry constraints and the
field assigned as a lookup field is an attribute assigned as one of
the constraints, users will need to enter values and perform a
search before they can select an object.

Note:There can only be one Lookup Button configured per

attribute relationship on a view.

Tip: If you want users to be able to double-click on a

related attribute field to view the related object, but you
do not want them to perform lookups and change the
value of the field, set the Lookup Button property to
False after configuring the appropriate filter for the
Lookup Filter property. This will remove the lookup
button, but still allow the field to be double-clicked for
easy access to the related object.

©
2011 Hyland Software, Inc.
289
 WorkView OnBase 11.0.0

Property Description

Lookup Button (continued) When this property is set to True for a Date attribute, the
Calendar button is displayed in the Client. When it is set to
False, the button is removed from the view.
When this property is set to True for an attribute that uses a
dataset, a drop-down select list is available in the Client for
value selection. When it is set to False, the drop-down select list
is not available in the Client.

Lookup Filter This property is only available for Relationship data type
attributes configured to be dependent on another class and is
the filter for which you want look up related objects. This

4 property is populated with the filter selected in the Select a

filter for <Class Name> dialog box. To change the selection,
click the ellipsis button to access Select a filter for <Class
Name> dialog box and make your new selection.

Multiline When this property is set to True, the attribute field is a multiline
field. This property is not available for the following attribute
types: Relationship, Boolean,.Date. Document, or Date/Time.
You can not set a Currency or Floating attribute type to True.

Read Only Makes a field read-only in the client and does not allow the field
to be edited. True set the field to read-only. False permits
editing in the field.

Required When this is set to True, entering a value in the Client for the
field is required.

Show Label When this is set to True, the configure Label is displayed.
When this is set to False, the configured Label is hidden.

Styles See Style Collection Editor on page 296 for more information.

Tab Index Specifies the order in which fields acquire the cursor when the
Tab key is pressed. Enter the appropriate numeric value that
corresponds to the tab order number in the tabbing sequence. If
you do not want a field included in the tabbing order, specify a
negative numeric value. Ensure that you do not use the same
value for multiple attribute fields.

Width Specifies the width of the selected attribute control’s field. The
value entered can be in percent of the screen or in pixels. If
entering a percentage, include the percent sign (%) after the
value.

©
2011 Hyland Software, Inc.
290
OnBase 11.0.0 WorkView

DOCUMENT ATTRIBUTE
The following properties define how a related document attribute control is displayed in the
view:

Property Description

Allow Attach When set to True, displays an Attach button in the related
document control. The Attach button allows you to attach a
document to the object within the view in the Client. A link to the
document will be provided within the control.

Allow Import When set to True, displays an Import button in the related
document control. The Import button allows you t o import a
new document into OnBase and attach a document to the object 4
within the view in the Client.

Auto Display When set to True, displays the document specified in the
control in the client when the object is opened. This setting is not
functional when the View Type attribute is set to
EmbeddedTab.

Height Specifies the length of the related document control on the view.
When used in conjunction with the EmbeddedTab View Type
property value, the Height setting defines how tall the
embedded document viewer will be in the view. A value must be
specified for this setting when using the EmbeddedTab View
Type.

Help Text Displays specified text when the selected related documents
control is hovered over in the Client.

Note:Up to 256 characters is supported. Characters entered

beyond 256 characters will be truncated.

Label Specifies the text that will be displayed above the document or
document auto-name string.

Select From This property is only editable when the Allow Attach property
is set to True. Specifies what folder the Attach button will open
for document selection. Static, All Folders, and folders
specifically defined at the class level are available for selection.
If SpecificFolder is selected, the appropriate folder must be
selected in the Specified Folder property.

Show Label When this is set to True, the configure Label is displayed.
When this is set to False, the configured Label is hidden.

©
2011 Hyland Software, Inc.
291
 WorkView OnBase 11.0.0

Property Description

Specified Folder When SpecificFolder is selected from the Select From

property, a drop-down list of all folders specified for the class is
available for selection.

Styles See Style Collection Editor on page 296 for more information.

View Type Specifies how the document will be displayed. If

FloatingWindow is selected, a new window will open to
display the document. If EmbeddedTab is selected, the
document viewer is embedded within the view. When the
EmbeddedTab option is selected, a value must be specified for
the Height setting.
4
Note:Users must have rights to view the Document Types that
embedded documents belong to in order to view documents
embedded within the view.

Width Specifies the width of the selected related document control.

The value entered can be in percent of the screen or in pixels. If
entering a percentage, include the percent sign (%) after the
value.

FILTERS

Caution: When embedding filters into a view, ensure the attributes assigned to the filters are in
alignment with the desired security model. If a filter is placed on a view, users will have rights to see
the filter’s results, including all attributes configured for the filter.

The following properties define a filter’s appearance and functionality:

Property Description

Allow Add to List This option is only available for Association filters. Adds the Add
to List button to the embedded filter in a view, which allows
objects to be associated with an object in the Client.

Allow Add to List Filter This option is only available for Association filters. Specifies the
filter used to return the object to associate with an object using
the Add to List button. Clicking the ellipsis button opens the
Select a filter for <Class Name> dialog box that allows you
to select the filter used to display objects for selection. The filters
that are available in this dialog are filters related to the
association class.

©
2011 Hyland Software, Inc.
292
OnBase 11.0.0 WorkView

Property Description

Allow Create Allows creation of an object of the class linked to the filter when
set to True. An Add button will be added to the view if this
check box is selected.

Allow Delete If you want to allow the deletion of objects, set this option to
True. A Delete button will be added to the view.

Allow Edit If you want to allow the editing of objects associated with the
object, set this option to True. When this option is enabled, an
Edit button displays in the embedded filter within the view. This
option is only available if the selected filter has a relationship
attribute selected as a View Attribute. If this option is enabled
you will be prompted with the Select Filters for Related
Attributes dialog box.
4

Select the check box next to the attribute and select the filter to
be used for the relationship attribute lookup. If check boxes for
multiple attributes are selected, the last attribute listed that is
selected is the attribute that will be used for the lookup.

Auto save current object If you want to save the current object where you were entering
before adding new object information automatically before adding an object to the filter,
set this option to True. The current object will be saved when
the Add or Edit buttons are clicked in an embedded filter. In the
client, if any of the required fields are not filled out by a user in
the current object, a message stating all the required fields need
to be completed is displayed and a new object will not be
opened. If you do not select this option when adding an object to
the filter list through the view, a dialog box will display asking if
you want to save the object. If OK is clicked the current object
containing the filter will be saved. If Cancel is clicked, the
current object will not be saved and you will not be able to add a
new object.

©
2011 Hyland Software, Inc.
293
 WorkView OnBase 11.0.0

Property Description

Constrain to Parent If you want only the objects displayed in the filter to be directly
related to the current object, set this setting to True. This setting
only affects filters when a relationship or association between
two classes exists. When a relationship to another classes
exists for a filter, this setting will default to True. When there is
no relationship, it defaults to False.
When this option is set to True and the filter embedded on a
view has a relationship attribute to the class to which the view
belongs, when a new object is added to an embedded filter and
Save and New is clicked, subsequent objects will be added to
the embedded filter within the parent object.
4 Embedded Filters When the ellipsis button is clicked, the Select Filters for
Related Attributes dialog box is opened. Upon clicking OK,
the Allow Edit property is set to True. For more information
about this dialog box, see the Allow Edit property description.

FilterControl System property. Not editable by user.

Height Specifies the length of the filter box on the view.

Help Text Displays specified text when the selected filter control is
hovered over in the Client.

Note:Up to 256 characters is supported. Characters entered

beyond 256 characters will be truncated.

Scripts Opens the Script Collection Editor dialog box.

Styles See Style Collection Editor on page 296 for more information.

Text Specifies the text that is displayed at the top of the filter.

Type Name System property. Not editable by user.

Width Specifies the width of the selected filter control. The value
entered can be in percent of the screen or in pixels. If entering a
percentage, include the percent sign (%) after the value.

©
2011 Hyland Software, Inc.
294
OnBase 11.0.0 WorkView

Inserting an Association Filter

To insert an association filter within a view:

1. Select the view and double-click on the appropriate association filter. The Select a filter
for <Class Name> dialog box is displayed.

2. Select the filter you want to use to display objects for selection.
3. Click OK.

FOLDERS
The following properties define a folder control’s appearance:
4
Property Description

Height Specifies the length of the folder box on the view.

Help Text Displays specified text when the selected folder control is
hovered over in the Client.

Note:Up to 256 characters is supported. Characters entered

beyond 256 characters will be truncated.

Styles See Style Collection Editor on page 296 for more information.

Text Specifies the text that is displayed at the top of the folder control.

Width Specifies the width of the selected folder control. The value
entered can be in percent of the screen or in pixels. If entering a
percentage, include the percent sign (%) after the value.

©
2011 Hyland Software, Inc.
295
 WorkView OnBase 11.0.0

STYLE COLLECTION EDITOR

The collection of styles is available for advanced configuration for many control types. Styles
are HTML formatting labels, and the Designer maintains some of these as individual
properties. For example, Height and Width of an HTML component are maintained directly
in the Properties toolbox. The styles collection form can be used for advanced configurations
where the administrator has special formatting that is required and needs to specify additional
styles for the item. To access and use collections:

1. Within a Styles property, click the ellipsis button. The Styles Collection Editor dialog box
is displayed.

2. Click Add.
3. Enter the Name of the property.
4. Enter a Value for the property.
5. Repeat steps 2-4 for each property you want to add.
6. Click OK.

©
2011 Hyland Software, Inc.
296
OnBase 11.0.0 WorkView

VIEW SCRIPT PROPERTIES

The following script events are available for a view:

Event Description

OnClick This event is triggered when a user clicks on the tab of a view in the
Client.

OnLeave This event is triggered when a view is left.

OnLoad This event is triggered when a view is loaded for an object.

ATTRIBUTE SCRIPT PROPERTIES

4
The following script events are available for attribute fields:

Event Description

OnBeforeLookup This event is used to apply constraints to the objects accessed

when a lookup is initiated on a relationship attribute field. For
example, you could have an Object with a Department attribute and
an Employee attribute. Clicking the lookup icon for Employee can
now limit the filter results to only Employees with the Department
attribute shown on the original Object using this event.

OnBeforeOpenRelatedObject This event is used to call a default view for a related object when a
relationship attribute field is double-clicked. If a view other than the
default first tab is desired to display upon opening an object, the
following call has to be made in the script:
event.srcElement.RelatedView = "name of view"

OnChange This event is triggered when the value of an attribute field is

changed.

OnEnter This event is triggered when the cursor enters an attribute field.

OnLeave This event is triggered when the cursor leaves an attribute field.

©
2011 Hyland Software, Inc.
297
 WorkView OnBase 11.0.0

EMBEDDED FILTER SCRIPT PROPERTIES

The following script events are available for embedded filters:

Event Description

OnBeforeLookup This event is used to apply constraints to the objects accessed

when the filter is in edit mode and a lookup is initiated on a
relationship attribute field. For example, you could be editing a list
of objects with a Department attribute and an Employee attribute.
Clicking the lookup icon for Employee on a row can now limit the
filter results to only Employees with the Department attribute
shown for the same row. Alternatively, with access to the parent

4 view’s data, constraints can be set using data from it.

OnBeforeOpenObject This event sets the initial/default view that will open when an object
is opened from the filter results list via a double-click.

OnBeforeRelatedLookup This event is called when the user clicks any lookup button inside
the filter when in Edit mode. This gives the administrator the
chance to add filter constraints based on the parent object or data
from the current filter row.

OnBeforeOpenRelatedObject This event is used to call a default view for a object when the row is
double-clicked. If a view other than the default first tab is desired to
display upon opening an object, the following call has to be made
in the script: event.srcElement.RelatedView = "name of view",
where “name of view” is the name of the desired view.

DEFINING SCRIPTS
To define a script that will run when an event is triggered in the Client:

1. Select the event in the Properties toolbox.

2. Click the ellipsis button. The ScriptEditor dialog box opens.
3. Enter the script.
4. Click OK.

Inserting Controls in the View

The View window contains the view. Upon creation of a view, the editable region of the view
window is Beige. Configuration of a view must be completed within the editable region,
which is the main container of the view.

©
2011 Hyland Software, Inc.
298
OnBase 11.0.0 WorkView

To insert a control into the view:

1. Select the main container so that the black dotted outlines the main control as seen in the
following example:

2. Double-click on the appropriate control. The control will be added to the view. If there
are controls already on the view, the control will be added to the bottom of the view. You
can arrange controls by using the Navigation toolbox.

©
2011 Hyland Software, Inc.
299
 WorkView OnBase 11.0.0

TABLES
Upon inserting a table control into a view, the following dialog box is displayed:

4
This dialog box allows you to specify how many rows and columns you want to include in the
new table.

IMAGES
Upon inserting an image control into a view, the following dialog box is displayed:

Browse to the image that you want to embed in the view and click Submit.

Cutting and Pasting Controls

If you want to move a control by cutting and pasting:

1. Select the control.

2. Click Cut.

3. Place the cursor where you want to place the cut control.

©
2011 Hyland Software, Inc.
300
OnBase 11.0.0 WorkView

4. Click Paste.

Deleting Controls
If you want to delete a control select the control and click the Delete button.

Alternately, you can select the control and press the Delete keyboard key.

Note: You cannot delete the main container.

4

Configuring Actions in the Designer

The Actions tab contains two types of action controls: Client-Side and Server-Side.
Client-Side actions are configured on a per control basis within the Designer. To configure a
Client-Side action control:

1. In the Client-Side section of the Actions tab, click Add JavaScript Action. A button is
placed on the view.
2. In the Properties toolbox, click the Scripts button.

3. Click the ellipsis button next to the OnClick property. The ScriptEditor opens.
4. Add the script you want the button within the view to initiate.
5. Click OK.

The Server-Side actions are actions configured at the screen level for the class with the
<<Manually placed>> options selected. See Assigning Actions to Specific Views on page 324
for more information about the <<Manually placed>> option. To add a Server-Side action to
a view:

1. In the Server-Side section of the Actions tab, select the appropriate action.
2. Click Add Server-Side Action. A button is added to the view.

©
2011 Hyland Software, Inc.
301
 WorkView OnBase 11.0.0

Redirecting Views Within the Designer

To redirect a view for an external class to a view of the base class:

1. In the View Explorer, select the extended class for which you would like to redirect a
view, right-click and select Redirect View. The Redirect View dialog box is displayed.

2. Enter the Name for the redirected view.

3. Select the view to which you would like to redirect the view.
4. Click OK.

Printing a View
You can print the layout of a view. To print a view:

1. Select File | Print. The Print dialog box is displayed.

2. Select the appropriate printer and click Print.

Note: In order to print the view with all of its components, Internet Explorer must be
configured to specifically print them. In Internet Explorer, select Tools | Internet Options
and select the Advanced tab. Select Print background colors and images and click OK.

Saving a View
After you are done designing a view, you must save it. To save a view, select File | Save. If it
is the first time you are saving the view, you must assign user group security. For more
information see User Group Security on page 303.

©
2011 Hyland Software, Inc.
302
OnBase 11.0.0 WorkView

User Group Security

In order for users to have access to views in the WorkView client, you must grant the
appropriate user group rights to the view. To assign user group rights:

1. Upon initially saving a view or by right-clicking on a view in the View Explorer and
selecting User Groups, the Assign User Groups dialog box is displayed.
2. Select the appropriate user group(s) and click Add.
3. Click Save.

Editing an Existing View

To edit an existing view:
4
1. In the View Explorer toolbox, expand the appropriate application.
2. Expand the appropriate class.
3. Select the appropriate view.
4. Right-click on the view and select Edit. The view will open for editing.

The Actions Tab

The Actions tab allows you to add buttons to execute commands to the class’s screen.

©
2011 Hyland Software, Inc.
303
 WorkView OnBase 11.0.0

The name of actions available in the drop-down select list are followed by a dash and then the
description configured for the action. If no description was configured, nothing will follow
the name of the action in the drop-down.
To create action command buttons:

1. From the Actions tab, click Create new action. The action configuration dialog box
displays.

2. Enter a name for the action in the Action Name: field.

3. Enter a brief description of the action in the Description field.
4. Select the appropriate action type from the Action Type: drop-down menu. The following
choices are available:

Option Description

Execute VBScript Executes specified VBScript. For more

information, see Configuring an Execute
VBScript Action Type on page 307.

©
2011 Hyland Software, Inc.
304
OnBase 11.0.0 WorkView

Option Description

Modify attribute Modifies specified attribute. For more

information, see Configuring a Modify Attribute
Action Type on page 308.

Execute list of other actions Executes list of other configured actions. For
more information, see Configuring an Execute
List of Actions Action Type on page 309.

[Create and] display E-form Create an E-Form and allows you to edit the E-
Form before creation is complete. For more
information, see Configuring E-Form Related
Action Types on page 311.

[Create and] auto-save E-form Creates and automatically saves and E-Form
4
to OnBase. For more information, see
Configuring E-Form Related Action Types on
page 311.

Modify object class Click Extended Class and select the

appropriate extension class that you would like
to extend objects to. This action extends
properly configured objects to objects in the
selected extension class. The object will still
exist in the originating class. For more
information, see Configuring Extended Class
Action Types on page 311.

Send Notification Sends an assigned WorkView notification. For

more information, see Configuring a Send
Notification Action Type on page 310.

Caution:When using an action to send a

notification, the rules defined for sending the
notification at the notification level are not
respected. Using an action button to initiate a
notification will send the notification regardless
of whether the rules defined for the notification
are met.

Modify object class (picklist selection) Allows you to change the class of an existing
object belonging to an extension class to
another extension class that shares the same
base class. For more information, see
Configuring Extended Class Action Types on
page 311.

©
2011 Hyland Software, Inc.
305
 WorkView OnBase 11.0.0

Option Description

Display template Enables Administrators to configure and

associate templates to an action. For more
information, see Configuring Display Template
Actions on page 311.

Execute Unity Script Executes specified Unity script. For more

information on configuring Unity scripts, see
Unity Scripting in the Hyland SDK.

5. Configure the action appropriately. See the following sections for more information
about configuring specific action types: Configuring an Execute VBScript Action Type
on page 307, Configuring a Modify Attribute Action Type on page 308, Configuring an
4 Execute List of Actions Action Type on page 309, Configuring a Send Notification
Action Type on page 310, Configuring E-Form Related Action Types on page 311,
Configuring Extended Class Action Types on page 311 or Configuring Display Template
Actions on page 311.
6. If you want the action to be available for selection in all applications, select the Allow
other applications to use this action check box.

Note: If this is configured from <Shared Objects>, this option is selected by default and
cannot be edited.

7. Click Save.
8. Select the appropriate action from the drop-down menu.
9. Click Add.
10. Click Save.
11. The User Group Security dialog box will display.

Caution: Granting users rights to an action allows them to perform all functions of the script
associated with the action, regardless of any other security settings within WorkView.

12. Select the appropriate user group(s).

13. Click Add.
14. Click Save.

©
2011 Hyland Software, Inc.
306
OnBase 11.0.0 WorkView

Note: You can assign or remove user groups to/from an action by clicking User Groups... and
changing the user group assignments appropriately.

Further information about configuring actions can be found in the Actions Appendix.
When an action is configured for a screen, a button is created on the screen to be used to
execute the configured command. An action button will only be available if the currently
logged in user has rights to the specific action.
Arrange the actions in the order you want them displayed in the WorkView Client by
selecting actions and using the Move Up and Move Down buttons.
To delete an action, select the action and click Delete.
4
Configuring an Execute VBScript Action Type
To configure the Execute VBScript action type:

1. Click the Edit Script button. If a script has not be defined, a message stating There is
currently no script defined for this class. Do you wish to start with the default? Click Yes
to start with a default script. Click No to start with no script defined.
2. Enter the appropriate script in the Edit Script dialog box, and click OK. You can go to
specific lines of the script by entering the row number in the Go to Line field and clicking
Go.

3. If you want to denote the script as one that produces output, select the Script produces
output option. This option is only available for the Execute Script action type. This is
useful for scripts that produce reporting output to Word or Excel.

Note: The contents of the Edit Script dialog box cannot be deleted and saved as a blank
script. To delete the script, you must delete the action to which a script belongs.

©
2011 Hyland Software, Inc.
307
 WorkView OnBase 11.0.0

Configuring a Modify Attribute Action Type

To configure the Modify Attribute action type:

1. Click Configure Command. The Modify Attribute dialog box is displayed. The Application
and Class fields are read-only and they display the current Application class of the
currently selected Class.

Tip: You can manually edit the Command field. To open the command field, press Ctrl and
Shift and click in a gray area of the dialog box.

2. Select the Attribute you want to modify with the action.

3. Enter the Value you want to assign to the selected Attribute.

©
2011 Hyland Software, Inc.
308
OnBase 11.0.0 WorkView

4. Click Add.
5. Repeat steps 2-4 for each Attribute and Value you want to include in the action.

Note: Do not specify more than one value for an attribute. Only one value will be kept per
attribute.

6. Click Save when finished.

7. The appropriate Command is displayed in the field.

Configuring an Execute List of Actions Action Type

To configure the Execute list of actions action type:
4
1. Click Configure Command. The Execute List of Actions dialog box is displayed.

©
2011 Hyland Software, Inc.
309
 WorkView OnBase 11.0.0

Tip: You can manually edit the Command field. To open the command field, press Ctrl and
Shift and click in a gray area of the dialog box.

2. Select the Action you want to include in the list of actions to execute.
3. Click Add.
4. Repeat steps 2 and 3 for each action you want to add to the list.

Note: Use the Move up and Move down buttons to arrange the actions in the appropriate
order of execution.

4 5. When finished, click OK.

6. The appropriate Command is displayed in the field.

Configuring a Send Notification Action Type

To configure the Send notification action type:

1. Click Configure Command. The Modify Notification dialog box is displayed.

Tip: You can manually edit the Command field. To open the command field, press Ctrl and
Shift and click in a gray area of the dialog box.

2. Select the Notification you would like to associate with the action.
3. Click OK.
4. The appropriate Command is displayed in the field.

©
2011 Hyland Software, Inc.
310
OnBase 11.0.0 WorkView

Configuring E-Form Related Action Types

To configure the [Create and] display E-form or [Create and] auto-save E-form action types:

1. Click E-form Association and select the appropriate E-Form association.

2. The appropriate Command is displayed in the field.
3. Click Save.

Configuring Extended Class Action Types

To configure the Modify object class action type:

1. Click Extended class and select the appropriate extension class that you would like to
extend objects to. Only those extension classes related to the application the current class
4
is a part of are available.
2. The appropriate Command is displayed in the field.
3. Click Save.

To configure the Modify object class (picklist selection):

1. Configure extension classes appropriately. See Transforming Existing Extended Class

Object on page 187, Allowing Users to Extend Base Objects from an Action on page
188, and Extension Options on page 189 for more information.
2. Select Modify object class (picklist selection) from the Action type drop-down select list.
3. Click Save.

Configuring Display Template Actions

Templates can be used to display data in a consistently formatted display. Templates created
using the WorkView Configuration tool are saved in a TEMPLATES folder within the
configured WorkView resource folder.

©
2011 Hyland Software, Inc.
311
 WorkView OnBase 11.0.0

To configure a new Display template action:

1. Click the Configure Template button. The Filter Template Configuration dialog box is
displayed.

2. Enter a name for a new template in the Enter a template file name: field.

©
2011 Hyland Software, Inc.
312
OnBase 11.0.0 WorkView

3. In the Display content as filetype: drop-down select list, select the format that you want
the information to be displayed in. You can select Word Document, HTML, or Text
Document.

The Command field is not editable and it will display the command used to display the
template in the correct format
4. Click the Template Message Editor button. The Template Editor dialog box is displayed.
5. If a template of that name does not exist, a message stating Template file does not exist.
Would you like to create it? displays. Click Yes to continue and create the file. A message
stating File created successfully. is displayed. Click No to cancel the template creation.
6. Enter the text that will generate the formatted output. If you want to use the data
insertion wizard, select the Display data insertion wizard check box. When this option is
selected, a pane is displayed within the dialog box that allows you to select data macros
4
into the template. By selecting a macro from the wizard pane, properly coded tags are
inserted into the template. The following is an example of this:

For more information on data insertion options, see Using HTML in Templates on page
253.
7. Click Save when you are done configuring the template.
8. Click Save again.

©
2011 Hyland Software, Inc.
313
 WorkView OnBase 11.0.0

9. Click Save a final time to save the action. The User Group Security dialog box is
displayed.
10. Select the user group(s) to which you want to assign the action.
11. Click Add>>.
12. Click Save.
13. Ensure the correct action is selected from the drop-down select list and click Add.
14. Click Save.

©
2011 Hyland Software, Inc.
314
OnBase 11.0.0 WorkView

To configure a Display template action using an existing template:

1. Click the Configure Template button. The Filter Template Configuration dialog box is
displayed.

2. Click the Browse For Existing Templates button.

©
2011 Hyland Software, Inc.
315
 WorkView OnBase 11.0.0

3. Browse to an existing template with a .tmp extension. Select it and click Open. The name
of the template is automatically populated in the Filter Template Configuration dialog
box.

Caution: Do not open and edit Microsoft Word templates

4. In the Display Content AS Filetype: drop-down select list, select the format that you want
the information to be displayed in. You can select Word Document, HTML, or Text
Document.

The Command field is not editable and it will display the command used to display the
template in the correct format
4 5. If you want to edit the loaded template, click the Template Message Editor button. Make
the appropriate changes and click Save.
6. Click Save again.
7. Click Save a final time to save the action. The User Group Security dialog box is
displayed.
8. Select the user group(s) to which you want to assign the action.
9. Click Add>>.
10. Click Save.
11. Ensure the correct action is selected from the drop-down select list and click Add.
12. Click Save.

USING HTML IN TEMPLATES

HTML can be used for notification message templates and display templates.
If the template body starts with <html> tag (immediately after the top of template macros, if
applicable), for notifications, the message will be sent as an HTML formatted message and,
for display templates, the results will be displayed in HMTL. The rest of the template should
be created with HTML tags as needed. An example of an HTML formatting is:
<html><body>
<<#~Issues Tech>>
</body>
</html>

©
2011 Hyland Software, Inc.
316
OnBase 11.0.0 WorkView

ADDING MACROS TO A TEMPLATE

Within the Notification Template dialog box and Template Editor dialog box, there are
features that allow you to add template macros easily to the template. The following types of
macros can be added to a template from the Notification Template dialog box.
Current User
To add a current user macro, right-click in the dialog box and select Insert | System |
Current User. The <<%U>> macro is inserted. For more information about this macro, see
the table under the Data Value Insertion Tags section of this manual.
Date/Time
To add a date/time macro, select Insert | System | Date/Time. The <<%D>> macro is
inserted. For more information about this macro, see the table under the Data Value Insertion 4
Tags section of this manual.
In addition, you can insert date/time macros with optional formatting. To insert date/type
macros with formatting:

1. Right-click on the dialog box and select View | Date/Time. The Date/Time pane displays.

Note: If you already have the Data pane open, click on the Date/Time tab at the bottom of
the pane.

2. Double-click on the formatting option you prefer. The macro will be inserted, with the
formatting specifications.

©
2011 Hyland Software, Inc.
317
 WorkView OnBase 11.0.0

For more information about date/time formatting, see the table under the Data Value
Insertion Tags section of this manual
To close the pane, click the X in the upper right-hand corner of the pane or select View |
Date/Time again.
Filters
Filter macros that display filter results can be inserted into a template. To insert a filter:

1. Right-click on the dialog box and select View | Filters. The Filters pane is displayed.

Note: If you already have the Data pane open, click on the Filters tab at the bottom of the
pane.
4

2. Expand All Filters.

©
2011 Hyland Software, Inc.
318
OnBase 11.0.0 WorkView

3. Double-click on the filter that you would like to insert. An option box is displayed.

4
4. If you want the filter results displayed in the template constrained upon the attribute
values of the object that initiated the notification or action, select the Constrain Filter to
Parent Object option.

5. If you want the filter to be formatted into a table, select the Insert As Pre-Formatted
HTML Table option.

Note: For notification message templates, when the cursor is in the To, From or Subject
fields, the Insert As Pre-Formatted HTML Table option is disabled.

6. Click OK.

To close the pane, click the X in the upper right-hand corner of the pane or select View |
Filters again.

©
2011 Hyland Software, Inc.
319
 WorkView OnBase 11.0.0

Attributes
Attribute macros that display attribute values can be inserted into a template. To insert an
attribute:

1. Right-click on the dialog box and select View | Attributes. The Attributes pane is
displayed.

Note: If you already have the Data pane open, click on the Attributes tab at the bottom of the
pane.

2. Double-click on the attribute that you want to insert into the template.
To close the pane, click the X in the upper right-hand corner of the pane or select View |
Attributes again.

DATA VALUE INSERTION TAGS

The following tags will insert data into templates.

Tag Description

<<%U>> Inserts the username of the logged in user initiating the

notification into the text of the notification.

©
2011 Hyland Software, Inc.
320
OnBase 11.0.0 WorkView

Tag Description

<<AttributeName>> You can place the value of an attribute for a single object into a
notification using this option. A tag can reference a simple
attribute owned by the class, or it may reference attributes from
objects related to the class. Example: <<Vendor.Buyer.Name>>

<<+AttributeName>> Inserts the attribute value of the object as a URL link that opens
the object.

<<++related.attrName>> Inserts the related attribute value for the object as a URL link
that opens the related object.

<<#+FilterName>> Runs the filter independent of object constraints and inserts it

into the template as an HTML table with the first attribute listed
for the filter results formatted as a URL link to the object. The
4
template body should include the <html> tag.

©
2011 Hyland Software, Inc.
321
 WorkView OnBase 11.0.0

Tag Description

<<%D[optional Inserts a date value. There are several formatting options

formatting]>> available that can be placed in brackets. They include:
• %m - Month (1-12)
• %d - Day (1-31)
• %y - Year (e.g. 1999)
• %2[m,d,y] - Force two digit display
• %H - Hour (0-23)
• %h - Hour (1-12)
4 • %M - Minute
• %S - Second
• %p - AM / PM
• %b - Abbreviated month name (e.g. JAN)
• %B - Full month name (e.g. January)
• %a - Abbreviated weekday name (e.g. SUN)
• %A - Full weekday name (e.g. Sunday)
• %w - Weekday (0-6, Sunday == 0)
• %j - Day of year (0 - 366)
• %! - Date formatted according to locale settings
• %% - Percent sign

Note: These same formatting codes can be used to

modify the output of date attribute tags. For example
<<DateOfBirth[%a %b %d, %y]>> will display in the
form SUN JAN 1, 2006.

<<#~FilterName>> Runs the filter independent of object constraints and inserts it

into the template as an HTML table. The template body should
include the <html> tag.

<<#FilterName>> Runs the specified filter constrained to the current object. The
results are formatted in the form of an HTML table which is
inserted into the template. The template body should include the
<html> tag.

©
2011 Hyland Software, Inc.
322
OnBase 11.0.0 WorkView

ITERATIVE TAGS
Iterative tags, or looping tags, start with <<@. These tags process all text starting immediately
after the tag until immediately before a corresponding <<@end>> tag for each object in a set.
The resulting blocks of text are filtered for macros based on each object and the text is
appended to the results. The set of objects is usually defined by a filter results set. The result
will be a block of text being filtered and inserted into the notification for each filter result hit.

Note: Iterative blocks can be nested. When doing so, care should be taken to make sure each
start marker has a correctly placed end marker.

Tag Description
4
<<@@>> <<Attribute>> <p> This code will insert all of the attribute values returned from a
<<@End>> filter when using a filter as a condition. Use of <<@@>>
requires that the filter from which you want to pull values is
already in use. You must also use the <<@End>> tag after
using the <<@@>> option. HTML can be used to format the
values into a table.

<<@@>> <<@@>> is a special case of an iterative tag. In the case of a

timer triggered notification, there is often have a logical
reference to filter results that were obtained as part of the
notification’s condition test. To iterate over this result set, the
<<@@>> tag is used (with the required <<@end>> tag to mark
the end of the block.)

<<@~FilterName>> Runs the filter independent of objects and allows you to pull
values from the specified filter.

<<@FilterName>> Calls the specified filter. In order to successfully use this option,
you must also specify the attributes for which you want values
displayed in the following format:
<<ClassName.AttributeName>> You can use HTML to
format the values into a table.

©
2011 Hyland Software, Inc.
323
 WorkView OnBase 11.0.0

Configuring Execute Unity Scripts Actions

To configure a Unity script action:

1. Click the Configure Unity Script button. The Unity Configuration dialog box is displayed.
2. Configure the script.
3. Save the script.

Note: For more information on Unity Scripts, see Unity Scripting in the Hyland SDK.

Assigning Actions to Specific Views

4 You can assign actions to specific views. When an action is assigned to a specific view, it is
only available when the assigned view’s tab is selected in the WorkView client. To assign an
action to a view:

1. Select an action within the Actions tab.

©
2011 Hyland Software, Inc.
324
OnBase 11.0.0 WorkView

2. Click Associate view. The Associate view dialog box is displayed.

3. Select the appropriate view that you would like to associate with the actions from the
Associated view drop-down select list. If you select <<Manually placed>> from the
drop-down select list, the action will be available for selection in the Actions tab of the
WorkView Designer as a Server-Side action.
4. Click Save. The associated view will be displayed next to the action name in the Actions
tab.

©
2011 Hyland Software, Inc.
325
 WorkView OnBase 11.0.0

Screen Advanced Tab

The Advanced tab for screens allows you to configure options specific to the selected class
screen.

The following options are available in this tab:

Option Description

Hide creation header Select this option if you do not want the user name of the user
who created the object and creation date displayed on objects of
the class.

Use real name in creation Select this option if you want the user’s real name to be
header displayed in the creation header of objects for the selected
class.

Note:If a real name is not configured for a user and this option
is selected, the user name will be used in the creation header.

Display Static document When this option is checked, the count of the documents
count on Documents tab contained in the Static Folder in the Documents tab of an
object is displayed in parentheses on the Documents tab.

Use Dropdown to list screen Allows screen actions to be displayed in a drop-down menu on
actions views.

©
2011 Hyland Software, Inc.
326
OnBase 11.0.0 WorkView

CLASS ADVANCED TAB

The Advanced tab allows you to configure advanced options for classes. These include E-
Form associations, Document Type associations, folders, and scripts.

©
2011 Hyland Software, Inc.
327
 WorkView OnBase 11.0.0

Associating E-forms with Classes

You can associate an existing E-Form Document Type with a class. If you need to associate a
new E-Form with a class, you must create a Document Type that is linked to the E-Form in
the Configuration module. To associate an E-Form Document Type with a class:

1. From the class Advanced tab, click E-Forms...

2. Enter the name of the E-Form association in the first field.

3. Select the appropriate Document Type from the first drop-down menu.
4. Select the appropriate keytype map from the drop-down. If a keytype map is not
available, you can create one. For more information about keytype maps, see page 331.
5. Click Add.
6. Repeat steps 2 through 5 for each E-Form Document Type you want to associate with
the selected class.
7. Click Save.
8. Click Save again.

©
2011 Hyland Software, Inc.
328
OnBase 11.0.0 WorkView

Tip: Once an E-Form association is saved, the next time you enter this screen, the Document
Type Association ID is listed in the Name column within parentheses.

Note: You cannot have an E-Form association with the same name or Document Type as
another E-Form association within the same class.

Granting Appropriate Rights for E-Form Creation

In order for a user to be able to create an E-Form within WorkView, the following conditions
need to be met:
• Must be licensed for the E-Forms module. 4
• Must have the HTML Forms Product Right.
• Must have rights to the E-Form’s Document Type that is associated with a class.

©
2011 Hyland Software, Inc.
329
 WorkView OnBase 11.0.0

Associating Document Types With Classes

If you want to allow direct creation of objects from open documents in the OnBase client via
a right-click menu option, you must associate a Document Type with the appropriate class.
Document Type Associations created at the class level are also used to configure the Doc -
Create WorkView Object From This Document and the Doc - Update WorkView Object From
This Document actions in the Workflow module. Document Type Associations are also used
in the WorkView Integration for Microsoft Outlook 2007 module. To associate a document
type with a class:

1. From the class Advanced tab, click Document types...

2. Enter a name of the Document Type Association you want displayed in the OnBase
4 client for selection in the first field.

3. Select the appropriate Document Type from the drop-down menu.

4. Select the appropriate keytype map from the drop-down. If a keytype map is not
available, you can create one. For more information about keytype maps, see page 331.

Note: A name, Document Type, and keytype map are required to associate a Document Type
with a class.

5. Select the Auto-attach check box if you want the originating document to automatically
be attached to the newly created object.
6. Click Add.

©
2011 Hyland Software, Inc.
330
OnBase 11.0.0 WorkView

7. Repeat steps 2 through 5 for each Document Type you want to associate with the
selected class.
8. Click Save.
9. Click Save again.

Tip: Once a Document Type association is saved, the next time you enter this screen, the
Document Type Association ID is listed in the Name column within parentheses.

Creating Keytype Maps

A keytype map can consist of multiple mappings. Each mapping must either map an attribute 4
to a keyword type or map a static value to a keyword type. Keytype mappings can be used for
filters, E-form correlations, document type correlations, and dynamic folders.
Keytype maps can be accessed by double-clicking on Keytype Maps under the <Shared
Objects> node.

Mapping an Attribute to a Keyword Type

Keytype maps can associate an attribute to a keyword type in the OnBase system. When a
keytype map is configured for a document type within WorkView, the keyword type value
within the keyword type that is mapped to an attribute will automatically populate the
associated attribute when an object is created from an open document within the OnBase
client. In addition they decide what documents are included in a dynamic folder within an
object.

Note: Multiple keyword types can be mapped to multiple attributes for a single document
type.

Example: A document in the FI-Invoices document type has the value John Adams for the
Customer Name keyword type. The Customer Name keyword type is associated with the
Name attribute in the Customer class in WorkView. The FI-Invoices document type is
associated with the Customer class. When an object is created from the open document, the
John Adams value automatically populates the Name attribute for the newly created object.

To create a keytype map to associate keyword types to attributes:

1. From within the document type association configuration screen, click Create keytype
map or right-click and select Add new... from the Keytype Maps shared objects screen.

2. Enter the name of the keytype map in the Keyword map name: field.

©
2011 Hyland Software, Inc.
331
 WorkView OnBase 11.0.0

3. Click on <Click here to select>. A list of available attributes associated with the selected
class (displayed in the WorkView object: field) are displayed.
4. Double-click on the appropriate attribute.
5. Select the keyword type that you want to map to the selected attribute from the drop-
down menu.

Note: If you are creating the Keytype Map from the Document Type Association
configuration screen, the Keyword Types available will be dependent on the Document
Type(s) selected.

6. Click Add.
4 7. Repeat steps 3 through 6 to add multiple mappings.
8. Click Save.
9. Click Save again.

Mapping a Static Value to a Keyword Type

Keytype maps can also be used to configure static values for Keyword types used in filters.
Also, macros can be entered for static values to automatically generate appropriate values.
Operators can be used to specify if the filter results should show objects with attribute values
that are equal to, greater than, less than, less than or equal, greater than or equal, or not equal
to the specified static value.
To create a keytype map to provide static values for Keyword Types:

1. From within the Document Type Association configuration screen, click Create keytype
map.

2. Enter the name of the keytype map in the Keyword map name: field.
3. Select the Keyword Type you want to map to the selected attribute from the drop-down
menu.

Note: If you are creating the Keytype Map from the Document Type Association
configuration screen, the Keyword Types available will be dependent on the Document
Type(s) selected.

4. Enter a static value or macro.

5. Select the appropriate operator from the drop-down menu.
6. Click Add.

©
2011 Hyland Software, Inc.
332
OnBase 11.0.0 WorkView

7. Repeat steps 3 through 6 to add multiple mappings.

8. Click Save.
9. Click Save again.

Configuring Related Objects to Create Automatically

Objects can be configured to be created automatically when another related object is created
from an open document in the web client. Special configuration steps must be performed to
achieve this. These steps include:

1. Create or locate a document type in the web client that contains Keyword Types that will
contain all necessary values for the automatically created object. 4
2. Create or locate two objects that are related to each other. One of the objects should
have one Relationship data type attribute related to the other object. This attribute should
be used to identify the automatically created object. For more information about
Relationship attributes see page 205.

3. Both objects must be associated with the same Document Type. For more information
about associating Document Types with Classes see page 329.
4. The Relationship attribute must also be mapped to a Keyword Type within a Document
Type. For more information about mapping attributes see page 331.
5. The automatically created object must have all of its attributes mapped to Keyword
Types within the same Document Type. The identifying attribute related to the other
object must also be mapped to the same Keyword Type. If an attribute is not mapped
correctly, the value will be blank.

When the related object is created, the existing objects for the object that can be automatically
created are checked. If no object exists with the same identifying value, a new object will be
created automatically, pulling the mapped keyword values from the document.

©
2011 Hyland Software, Inc.
333
 WorkView OnBase 11.0.0

An example of when this could be used is when you have a Vendor Invoice Document Type
in the Web Client and you want to create issues that are automatically attached to the
corresponding vendor from documents. In our example below, there is a Vendor Invoice
Document Type in the web client and an Issue object and Vendor object in WorkView. The
Issue object has a Vendor attribute that is both related to the Vendor ID attribute of the
Vendor object and mapped to the Vendor ID keyword type of the Vendor Invoice Document
Type. The Vendor object’s attributes are all mapped to the Keyword Types in the Vendor
Invoice Document Type.

When an Issue object is created from an open Vendor Invoice document in the Web Client,
by right-clicking and selecting WorkView | Create Object, a check will be made for an existing
Vendor object matching the Vendor ID Keyword Type value. If no existing Vendor object
matches the value, a new Vendor object is created, pulling all of the mapped Keyword Type
values from the originating document into the new object. The created Vendor object will
then be related to the newly created Issue object.

©
2011 Hyland Software, Inc.
334
OnBase 11.0.0 WorkView

Configuring Dynamic Folders for Classes

If you want documents to automatically be attached to objects based on keytype map criteria,
you must create a folder associated with a class. If a document matches the keytype map
criteria associated with a folder, the document will automatically be placed in the appropriate
folder on the object’s Documents tab or embedded within a view.
Example: Ifyou associate a keytype map to a folder that maps a Vendor Name attribute in the
VendorsWorkView class to be equal to the Vendor keyword type in the VND-Invoice OnBase
document type, every time the attribute and keyword type values match, the matching
document will automatically be attached to the matching object.
To configure a folder for a class:

1. From the appropriate class Advanced tab, click Folders... 4

©
2011 Hyland Software, Inc.
335
 WorkView OnBase 11.0.0

2. Click Create new folder.

3. Enter an appropriate name for the folder in the Folder name: field.

©
2011 Hyland Software, Inc.
336
OnBase 11.0.0 WorkView

4. Select the type of query.

The Keyword-only query selection allows you to search across document types for all
documents that match the selected keytype mapping. You can edit the currently selected
keytype map by clicking Edit or you can create a new keytype map by clicking Create
keytype map.

The Document type query selection allows you to specify individual Document Types
that you want search on and the keytype map you want to associate with the Document
Type. Using this option allows you to search specific Document Types, each with specific
criteria. Select the appropriate Document Type from the first drop-down menu. Select
the appropriate keytype map from the second drop-down menu. If you need to create a
new keytype map, click Create keytype map. Click Add. You can arrange or delete any
configured item by clicking the Move up, Move down, and Delete buttons. 4
The Fill folder via script selection allows you to fill a dynamic folder with documents
when used in conjunction with a class event script. The class event script must have an
entry point named rm_FillDocumentFolder when using VBScript.
5. Click Save.

You can use the Move Up and Move Down buttons to put the folders in the order you want
them to be displayed in the Client.
For more information about configuring keytype mapping see page 331.
To edit an existing folder configuration, double-click on the folder name in the screen shown
in step 1.

Configuring Application and Class Level Scripts

You can associate scripts at the application or class level. A class level script will run on an
object or filter of the class upon opening the object in the client. Class level scripts can
control what a user can and cannot do within an object. For example, a class level script can
require a date field to be populated on an object before other fields are completed.

VBScripts
You can use the default script, or you can customize your own script. To associate a VBScript
at the class level:

1. Select the class you want to associate a script with.

2. Click the Advanced tab.
3. Click VBScript...

©
2011 Hyland Software, Inc.
337
 WorkView OnBase 11.0.0

4. A message stating There is currently no script defined for this class. Do you want to start
with default? displays. Click Yes to use the default script. Click No to create your own
script. The Edit Script dialog box displays.
5. If you want to edit the default script or create your own script, enter the information into
the box.
6. Click OK.
7. Click Save.

If you want to go to a specific line of the script, enter a number in the Go to line field and
click Go within the Edit Script dialog box.
If you want to remove a script from the class:
4
1. Click Remove Script in the Edit Script dialog box.
2. You are asked Are you sure you want to unhook this script from the class and delete it?
Click Yes to remove the script. Click No to cancel. Upon successful removal, a message
stating Class script has been removed is displayed.

Scripting can be used to validate data within the class. For example, if you want to prohibit
users from modifying objects based on parameters, you can use scripting to accomplish this.
Another example of when scripting at the class level is useful is when you do not want to
allow anyone to delete objects within the class. The following script can accomplish this:
Function rm_ValidateDelete
rm_ValidateDelete = "Sorry, you are not allowed to delete
objects!"
End Function

Function rm_ValidateData
rm_ValidateData = "Sorry, you are not allowed to create/
modify objects!"
End Function
By using scripting, you can prohibit users from completing actions as well as provide
descriptive messaging to users advising them of their inability to perform a task.

©
2011 Hyland Software, Inc.
338
OnBase 11.0.0 WorkView

Unity Scripts
To associate a Unity script at the class level:

1. Select the class you want to associate a script with.

2. Click the Advanced tab.
3. Click Unity Script. The Unity Configuration dialog box is displayed.
4. Configure the script.
5. Save the script.

Note: For more information about Unity scripts, see Unity Scripting in the Hyland SDK.
4
After a script has be saved and published for a class, a dialog box similar to the following is
displayed upon clicking Unity Script:

The Available scripts box lists the scripts that are still available for configuration for the
current application.
You can edit an existing script by selecting it and clicking Edit Script. In addition you can
make a script inactive or active by selecting it and clicking either Make Inactive or Make
Active. Only one of these buttons will be available based on the current active status of the
script.

©
2011 Hyland Software, Inc.
339
 WorkView OnBase 11.0.0

If you want to create a new script. click Create New Script to access the Unity Configuration
dialog box.

Note: For more information on Unity Scripting, see Unity Scripting in the Hyland SDK.

Caution: Unity scripts will not be exported. Unity scripts need to be manually added to imported
applications.

©
2011 Hyland Software, Inc.
340
OnBase 11.0.0 WorkView

CONTROLLING SECURITY
You can control all user permissions from a centralized dialog box. To access this dialog box,
select Settings | Master security... The Master security configuration dialog box is displayed.

This dialog box allows you to control all aspects of WorkView for user group permissions. To
assign rights to a user group:

1. Select the appropriate User group from the drop-down select list.
2. Select the Application for which you would like to grant modify access to.
3. To allow access to the application, select Group has access rights. If this is not selected,
users cannot open an application.

©
2011 Hyland Software, Inc.
341
 WorkView OnBase 11.0.0

4. On the right side of the screen, select the item you want modify rights to. The Available
box will update based on the selection.
5. Select the appropriate items and click >>Add.

Note: When adding a calendar, you will be prompted to grant rights to all related filters. If
you click No, a message will display stating User will see an empty calendar unless rights are
given to at least one calendar filter.

6. Select the item for which you want to grant rights. Rights check boxes are displayed.
7. For Classes, select the appropriate check boxes to grants rights: View, Modify, Create,
Delete, View History. The View right allows you to view objects. The Modify right allows
4 you to modify objects. The Create right allows you to create objects. The Delete right
allows you to delete objects. The View History right allows you to view the History tab of
objects. No check does not grant the right. A black check mark, grants the right, and the
grey check mark will ignore any change that was made and revert the previous setting.

Note: In order to attach or detach documents to/from an object, users must have the Modify
right for a class.

8. When finished, click Close.

If you want to grant all rights for all elements of an application:

1. Click Add access to entire application.

2. Click Yes to confirm that you want to grant all rights for the selected user group.
3. If you want to grant rights to all objects, such as actions and calendars, shared with other
applications, click Yes.

If you want to deny all rights for all elements of an application:

1. Click Remove access to entire application.

2. Click Yes to confirm that you want to deny all rights for the selected user group.
3. If you want to deny rights to all objects, such as actions and calendars, shared with other
applications, click Yes.

©
2011 Hyland Software, Inc.
342
OnBase 11.0.0 WorkView

If you would like to copy the entire access granted to the current user group to another user
group:

1. Click Copy access to group.

2. Select the appropriate user group to which you would like to copy rights.
3. Click Yes to confirm that you would like to grant the rights to the user group.
4. If you want to grant the same rights for shared objects, such as actions and calendars,
click Yes.

Configuring Security Attributes

Security attributes can restrict user rights at a more granular level. Security attributes are used
to limit the objects returned using filters based on specific attribute values and allows user
4
rights to be defined on a per object basis. Configuring security attributes is a two step process.
Security attributes are configured application level. First, you must create security attributes
for each class requiring security. Second, you must assign security attribute values and access
rights to specific user groups.

©
2011 Hyland Software, Inc.
343
 WorkView OnBase 11.0.0

When you configure security attributes by application, you are only able to configure security
attributes for one application at a time. To configure security attributes for an application.

1. In the left pane, right-click on the application and select Security Attributes. The Security
attribute configuration dialog box is displayed.

2. Select the Class tab.

3. Select the appropriate Class from the drop-down. This should be the class in which the
attribute(s) for which you want to configure security attributes reside(s).
4. Enter a descriptive name for the security attribute in the Attribute field. You can also
select an attribute from the drop-down select list. This list will contain attributes that
have already been added for the application.

©
2011 Hyland Software, Inc.
344
OnBase 11.0.0 WorkView

5. Enter the path to the attribute in the Source field. The path is how WorkView identifies
an attribute’s data. It may be the name of the attribute if within a standard class or it may
be relationshipattributename.attributename if the attribute is a relationship attribute.
Attributes can be nested. For example if you want to grant access to objects to a certain
employee, of a certain role, within a certain department, you could nest the classes so that
the appropriate right would be granted. Example:
Department.ManagementStatus.Employee.ID

Note: This field may be populated automatically for relationship attributes when an attribute
is selected in the drop-down select list.

6. Click Add. Repeat these steps for each security attribute you want to add. 4
7. Configure user group assignments. See Determining User Groups on page 358 for more
information.

Assigning Security Attributes to a User Group

To assign security attributes to a user group:

1. In the Security attribute configuration dialog box, select the User group tab.

©
2011 Hyland Software, Inc.
345
 WorkView OnBase 11.0.0

2. Select the User group that you want to assign security attribute values to from the drop-
down select list.
3. Select the name of the security attribute from the Attribute drop-down select list. The
security attributes created within the Attribute field on the Class tab are available for
selection.
4. Enter the value that should determine the user group access rights in the Value field. For
example, you can allow the Tech Support user group rights to see objects that have the
Department attribute value equal to Technical Support and nothing else.
5. Click Add. The User Group Attribute Rights dialog box is displayed.

Note: Rights set in this dialog box do not grant rights that are not granted at the class level.
They can however limit rights.

6. Assign the appropriate rights (View, Modify, Create, Delete and/or View History).
7. Click OK.
8. Repeat steps 2-7 for each value you want to specify.
9. When finished, click OK.

Note: You can define multiple values for multiple users if needed.

Note: If a user belongs to more than one user group, the least restrictive settings will be
respected.

©
2011 Hyland Software, Inc.
346
OnBase 11.0.0 WorkView

Tip: You can use ~User or ~U to specify that you want the security attribute to be tested
against the username of the user currently logged in. You can use the asterisk character (*) to
specify that you want to match any value that is not specified as a value. These values will
adhere to the same security setting. For example, if you want to allow users rights to View
every object that is not connected to their login names, but you want to allow View, Create,
and Modify rights for those objects connected to their login names, you would create a
security attribute value equal to ~User allowing View, Create, and Modify rights. You would
then create a security attribute value equal to *, giving the View right.

Using Application-Defined Identity to Determine Rights

For each application, you can define identity parameters based on an attribute value that will 4
be matched to the OnBase login values. Setting up application-defined identity requires a
specific syntax for the value. Syntax should include the class the attribute belongs to and the
attribute name to which you want to compare the logged in user name. The following is an
example:

class.loginname

For example, an application containing an Employee class with an object and for each
employee, their OnBase user name is stored in an attribute called Loginname. The identity
specified would be:

Employee.Loginname

When the application loads, the Employee class is queried for a Loginname that matches the
current logged in user. The matching objectid becomes the user’s identity for the application.
The functionality described in our first example can be extended for cases where the
application maintains user groups, by Department, as one of its own classes using an
association class that associates Department to Employees. Example:

Employee.Logginname:EmployeeXDepartment.

In this instance, the application identity becomes a list of objectid values identifying the user
group objects to which the user is assigned.

©
2011 Hyland Software, Inc.
347
 WorkView OnBase 11.0.0

Specifying Identification Parameters

In order to allow security permissions based on an application-defined user, you must identify
the class of the attribute you want user identity to be based on within WorkView. User
identification specification is defined on an application by application basis. User
identification can be defined when configuring by application or when configuring globally.
To specify user identity when configuring by application:

1. In the Security attribute configuration dialog box, select the Mode tab.

2. Select the Advanced mode.

3. Specify the string you want to use to specify identity in the field. Click on the drop-down
arrow and all classes within the current application are displayed. You can expand a class
and all attributes will be displayed. Select the appropriate attribute and a properly
formatted definition will display in the field. See Using Application-Defined Identity to
Determine Rights on page 347 for more information.
4. Click Save.

©
2011 Hyland Software, Inc.
348
OnBase 11.0.0 WorkView

5. Click OK.

Configuring Security Attributes: Traversing Associations

In some instances a more complex approach must be taken using security attributes to create
the desired results. Security attributes can be used to evaluate relationships between one or
more Association classes to determine security attribute control. In order to use class
association levels to determine security rights using security attributes, three main steps are
required. First, you must create security attributes. Second, you must configure user
identification for applications. Lastly, you must assign security attribute values to specific user
groups.

Understanding Syntax 4
In order to use security attributes with association classes, it is important to understand the
necessary syntax.
In this scenario, there are five classes involved: Tasks, Certifications, Risks, Departments, and
Employees.
An Employee can be assigned to one or more Departments, and access rights for most
objects are assigned based on Department. Tasks and Risks are associated with each other
(there is a many-to-many relationship between them). Finally, Certifications is directly related
to Task; for any Task, it can have none, one or many Certifications attached to it.
Each Task will be assigned to 1 or more Departments. All members of all assigned
Departments have modify rights to the Task, all of its associated Risks, and to its related
Certificates. We will call these Employees "Owners" of the data. All other non-Owner users
will have read-only rights to these objects.
To illustrate syntax, and example scenario will be used. When a colon (:) is used, this signifies
that an association class will follow. When a class name is followed by a period and then an
attribute name, it specifies an attribute name and specifies the class the attributes resides in.

Specifying attributes

SETTING UP USER IDENTIFICATION

This example shows that we will be expanding the DepartmentXEmployees class based on
the value of the loginname attribute within the Employees class and the security rights will be
based on the rights of the Departments returned.
The application identity specification for this scenario would be:
:Employee.Loginname:DepartmentXEmployee

©
2011 Hyland Software, Inc.
349
 WorkView OnBase 11.0.0

The following is an example of the configuration screen:

At runtime, this will be translated into a list of Department objects to which the Employee
belongs. This assumes Loginname contains the OnBase login name for each Employee. This
list of Departments is saved in a session variable as the "identity objects" for subsequent
reference.

SPECIFYING CLASS SECURITY ATTRIBUTES

A Class Security Attribute must be created for each class to be secured (Tasks, Risks and
Certificates). We will name these security attributes "Owner". The following Owner attributes
need to be created:
Tasks class - Owner = :TasksXDepartment
Certificates class - Owner = Tasks:TasksXDepartment
Risks class - Owner = :RisksXTasks:TasksXDepartment

©
2011 Hyland Software, Inc.
350
OnBase 11.0.0 WorkView

The following screens are examples of the configuration screens for this example:

©
2011 Hyland Software, Inc.
351
 WorkView OnBase 11.0.0

©
2011 Hyland Software, Inc.
352
OnBase 11.0.0 WorkView

TasksXDepartment and RisksXTasks are the names of the association classes created by the
WorkView Configuration tool to associate these classes.
Given a specific Tasks object, the owner specification will be resolved into a list of
Departments associated with the task (denoted by objectID's).
For a Certificate, its parent Tasks object is resolved and from this a list of Departments
associated with the Task is returned (denoted by objectID's).
Risks are a bit more complicated. For any specific Risks object, the Owner token is resolved
by first acquiring a list of all associated Tasks (via ":RisksXTasks"). For each of the resulting
tasks in the first step, a list of associated Departments is created, each being appended into
one master list of Departments that are considered "Owners".
All three of these class specifications results in a list of Departments who "own" the data.

©
2011 Hyland Software, Inc.
353
 WorkView OnBase 11.0.0

SPECIFYING USER SECURITY ATTRIBUTES

In this case, we are not applying access rights based on a user's OnBase user group, but rather
their department within the application. For this example, we will define 2 User Security
Attributes, both assigned to "All Usergroups" and both named "Owner":
<All>
Owner = ~Identity Rights = View, Create, Modify, Delete
Owner = * Rights = View

©
2011 Hyland Software, Inc.
354
OnBase 11.0.0 WorkView

The following are examples of configuration screens for this example:

©
2011 Hyland Software, Inc.
355
 WorkView OnBase 11.0.0

At runtime, the ~Identity macro is replaced with the list of Identity objects; in our example a
list of the Departments to which the logged-in user belongs. When determining access rights
for any of the objects above, its list of owner Departments is built. If any of these
Departments intersect with the user's list of Departments, the specified rights are assigned. In
this case, if the current user is an owner of the data, he or she is given all rights to the object.
If the current user is NOT an owner of the data, the next User Security Attribute is evaluated.
The "*" denotes an automatic match and provides a default value, which provides read-only
access.
If the second Owner attribute was removed, the result would be that users could see only data
that they own, and all other data is hidden from them.

©
2011 Hyland Software, Inc.
356
OnBase 11.0.0 WorkView

Creating Security Attributes

To create security attributes:

1. Select the appropriate application, right-click and select Security Attributes. The Security
attribute configuration dialog box is displayed.

2. On the Class tab, select the appropriate Class from the drop-down. This should be the
class in which the attribute(s) for which you want to configure security attributes
reside(s).
3. Enter a descriptive name for the security attribute in the Attribute field. You can select
attributes with the selected class from the drop-down select list.
4. Enter the path to the attribute in the Source field. The path is how WorkView identifies
an attribute. The path for security attributes of this complexity require a certain syntax.
The syntax must be the name of the class, followed by a period; the name of the attribute,
followed by a colon; and the name of the association class that the attribute belongs to,
whatever is appropriate. Example: :TasksXDepartments

©
2011 Hyland Software, Inc.
357
 WorkView OnBase 11.0.0

5. Click Add.
6. Repeat steps 4-6 to add more security attributes.

Determining User Groups

In order to effectively determine what user is logged in to OnBase in relation to a WorkView
attribute, a configured security attribute must be associated with a identity or username
macro.
To assign access rights that specify the logged in user:

1. In the Security attribute configuration dialog box, select the User group tab.

2. Select the User group that you want to assign security attribute values to from the drop-
down select list.
3. Enter the name of the security attribute that will contain a value that is equal to the
identification value in the Attribute field.

©
2011 Hyland Software, Inc.
358
OnBase 11.0.0 WorkView

4. Enter ~Identity in the Value field. ~Identity will use the identity object found using the
identification string configured in the Mode tab. Alternately, you can enter
~Identity.RelatedAttribute to specify the value of an attribute related to the identity
object. When you specify a related attribute associated with ~Identity, you can grant the
currently logged in user access to all objects that have the value of the related attribute
associated with ~Identity. For example, if you want to grant access to all objects related
to a user’s department, you could use ~Identity.Department and then define a
corresponding Class Security Attribute to identify the department to which an object
belongs. For information about how to set up the Class Security Attribute to identify
objects related to attribute values associated with the identity string Configuring Related
Attributes for ~Identity on page 359.
5. Click Add. The User Group Attribute Rights dialog box is displayed. 4

6. Assign the appropriate rights (View, Modify, Create, and/or Delete).

7. Click OK.
8. Repeat steps 2-7 for each value you want to specify.
9. When finished, click OK.

Note: If a user belongs to more than one user group, the least restrictive settings will be
respected.

Configuring Related Attributes for ~Identity

In order to configure ~Identity.RelatedAttribute values successfully, a few additional
configuration steps must be completed.

©
2011 Hyland Software, Inc.
359
 WorkView OnBase 11.0.0

Configure a Class Security Attribute

The first step is to define a Class Security Attribute for the attribute related to ~Identity. For
our example, we will set up an class security attribute for ~Identity.Department. First, set the
Class Security Attribute to the attribute that will be related to ~Identity. To configure a Class
Security Attribute related to ~Identity:

1. Specify a value for the Attribute name that is descriptive. This name will be used when
configuring the User Group Security Attribute. For our example, we will use Dept.
2. Set the Value equal to the appropriate attribute. For example, Employee.Department.
3. Click Add.

4 For more information about configuring Class Security Attributes see Configuring Security
Attributes on page 343.

Configure a User Group Security Attribute

Once the Class Security Attribute is specify, the User Group Security Attribute needs to be
configured to work with ~Identity.RelatedAttribute. To configure a User Group Security
Attribute for a attribute related to ~Identity:

1. Select the appropriate User group.

2. Enter the Attribute that you specified during the configuration of the Class Security
Attribute. For our example, this is Dept.
3. For the Value, enter the appropriate ~Identity.RelatedAttribute. For our example, this is
~Identity.Department.

4. Click Add.

For more information about configuring User Group Security Attributes see Determining
User Groups on page 358.

Controlling Object Creation Based on Security Attributes

When using security attributes, objects are only able to be created from an embedded filter
within a view when the security attribute is configured using ~Identity.
If a security attribute uses *, creation of objects from the Create menu is allowed.

©
2011 Hyland Software, Inc.
360
OnBase 11.0.0 WorkView

EXPORTING AND IMPORTING APPLICATIONS

WorkView has the capability to allow you to import and export applications from one
WorkView system to another.

Exporting

Caution: Unity scripts will not be exported. Unity scripts need to be manually added to imported
applications.

To export an application to an .exp file:

4
1. Select Import/Export | Export application... from the menu.

2. Select the appropriate application to export from the Export application: drop-down
menu.
3. Enter the directory and appropriate .exp file in the Export file: field manually or click
Browse to find the appropriate directory. If you browse to the directory, you must still
specify a file name for the .exp file.
4. Click OK. A Successfully exported application to file message displays when the
application has been successfully exported.

Caution: Notifications configured as shared objects are not exported.

Upon export of an application, a log is archived to the SYS Verification Report Document
Type. The description is WorkView - Application Export.

©
2011 Hyland Software, Inc.
361
 WorkView OnBase 11.0.0

Copying Applications
You can also copy applications from one database to another. In order to copy applications
you must have both the database that the applications originate in and the database that the
applications will be copied into connected to the WorkView Configuration tool at the same
time.

Note: Before copying an application that contains a Document Type Association, you must
configure the Document Types and Keyword Types used in the Document Type Association
within the destination database in the Configuration module before copying the WorkView
application. If you do not create the appropriate Document Types and Keyword Types within
the destination database before copying, errors will occur during and the copy will not be
4 successful.

To copy an application from one database to another.

1. With both databases open in the WorkView Configuration tool, select the window
containing the database that the application to be copied originates in.
2. Select Import/Export | Copy application... from the menu. The Copy application dialog
box displays.

3. Select the appropriate application to be copied from the Source application: drop-down
menu.
4. Select the appropriate database to copy the application into from the Destination
database: drop-down menu.

5. Click OK. When the application has successfully been copied, a Successfully copied
application to specified database message is displayed.

©
2011 Hyland Software, Inc.
362
OnBase 11.0.0 WorkView

Note: This does not copy data within an application.

Note: Appropriate user rights need to be configured in the destination database.

Importing

Caution: Unity scripts need to be manually added to imported applications.

Note: Before importing an application that contains a Document Type Association, you must 4
configure the Document Types and Keyword Types used in the Document Type Association
within the destination database before importing the WorkView application. If you do not
create the appropriate Document Types and Keyword Types within the destination database
before importing, errors will occur during the import and the import will not be successful.

To import an application:

1. Select Import/Export | Import application... from the menu.

2. Select the appropriate .exp file.
3. Click Open.
4. A message asking Do you want to share items that are sharable in existing applications
with items marked as sharable in the import file? is displayed. If you want to use the
existing shared items and not the shared items in the import file, click Yes. If you want
the items marked as sharable in the import file to be created as new items, click No. To
abort the import process, click Cancel.
The Import Application Name Change dialog box is displayed.

©
2011 Hyland Software, Inc.
363
 WorkView OnBase 11.0.0

5. Enter the name of the application in the New Application Name: field. The name of the
application must be unique.
6. When the application has imported successfully, an Application imported successfully!
message will display.

Note: Appropriate user rights need to be configured for the imported application.

Upon import of an application, a log is archived to the SYS Verification Report Document
Type. The description is WorkView - Application Import.
If a WorkView export file has been modified since the file was exported, a message will
4 display stating The contents of the import file appear to have been modified from their
original state (Hash code check has failed). Do you wish to continue? is displayed. Click Yes
to continue the import. Ensure that the file has been correctly modified using Notepad. If
another editor was used to edit the file, the application may not be imported successfully.
Click No to cancel the import.
If a missing configuration item is detected, the Verify import file dialog box will display with
information concerning the imported file’s missing dependencies concerning Document
Types and Keyword Types. This will occur when a Document Type or Keyword Type is in
the import file, but there is a Keyword Type or Document Type that does not exist in the
destination database. Click OK to continue the import. Click Cancel to cancel the import.

Importing Shared and Unshared Items

An item is defined as a dataset, an action, a sequence, a calendar, a keytype map, a timer, or a
notification. Importing a WorkView application handles identical names of items in the
following ways:
• If an item is shared, it will use a shared item of the same name already in the
destination system.
• If an item with the same name is not in the destination system, a new item is created.
• If an imported item is not shared, a new item is created in the destination system.
• If an imported item is not shared and an item exists in the destination system with the
same name, a new item with a unique ID number is created in the destination system.

©
2011 Hyland Software, Inc.
364
OnBase 11.0.0 WorkView

CREATING A DEFAULT VALUE FOR A RELATIONSHIP ATTRIBUTE

Relationship attributes can be configured to contain default values that must be matched to
both the logged in user and an attribute value in the related object. In this instance, both the
logged in user name and related attribute value must match. For example, an employee,
named Jane Harper, is logged in. When Jane Harper is logged in, the administrator wants the
EmployeeInformation object with the EmployeeName attribute value of “Jane Harper” to
automatically be related to any CustomerIssue object Jane Harper creates. If configured to do
so, when a new object is created, one of its fields will be populated with a value from an
object associated with the currently logged in user. This is useful when you want the user
logged in to be automatically associated with an object.
The special configuration steps consist of configuring class attributes and configuring views
to display appropriate attribute values.
4
To create attributes that will relate to one another using the logged in user:

1. Create two classes or use two existing classes. For example, EmployeeInformation and
CustomerIssue.

2. In the class containing the information to be related (EmployeeInformation), create an

attribute that identifies the object (EmployeeName). Ensure that this attribute is
Alphanumeric with a length that accommodates the longest user name in the system.

3. Click Save.
4. In the class (CustomerIssue) to be related to the class described in step 2
(EmployeeInformation), create an attribute that is of the Relationship data type. The
attribute’s name does not have to be identical to the attribute to be used for the
relationship. In our example, the name of this attribute will be Employee.
5. Select the appropriate class from the Related class: drop-down select list. In our example
EmployeeInformation would be selected.

6. Click Advanced...
7. Select the Logged-in user name option. %U displays in the Default value: field.
8. Enter [name of attribute] corresponding with the attribute that should be used to link
the two class objects together after the %U. In our example, the field would contain:
%U[EmployeeName].

9. Click Save.
10. Click Save again.

©
2011 Hyland Software, Inc.
365
 WorkView OnBase 11.0.0

To configure a view to display the correctly related attribute values:

1. In a view of the class containing the information to be linked (EmployeeInformation),

ensure that the attribute that will be used in the relationship field is inserted
(EmployeeName).
2. In the view of the class to be related, insert a field for the related attribute. In our
example, a field would be inserted for the EmployeeName attribute within the related
class.
For more information about configuring views, see page 272.
In order for a value to populate the related attribute field in the WorkView client, an object
with a value equal to the currently logged in user must exist. If no object meeting this
4 requirement exists, the field will not be automatically populated.

PURGING
You can purge history or certain types of objects from the database. This is a way to remove
unwanted and unnecessary information from the database.

©
2011 Hyland Software, Inc.
366
OnBase 11.0.0 WorkView

Purging History Data

History data can be deleted from the database. History data deleted is based upon application,
class, and date. To purge history data:

1. Select Settings | Purge | History data... The Purge History dialog box is displayed.

2. Select the Application from which you want to purge history data from the drop-down
select list.
3. Select the Class from which you want to purge history data from the drop-down select
list. If you want to delete all history data from all of the classes within the selected
application, select <All>.

©
2011 Hyland Software, Inc.
367
 WorkView OnBase 11.0.0

4. Select a date from the calendar. All history data existing before the selected date will be
purge.
5. If you want to log the purged information, enter or browse to a .log file.

Note: You can enter the name of the file in the Save As file dialog that is displayed when you
click Browse.

6. Click OK.
7. Click Yes to continue. Click No to cancel the purge. Upon completion, a Completed
message will display.
8. Click OK.
4
In addition to the log being available in the specified directory, the log is archived into the
OnBase system and can be retrieved in the SYS Verification Reports Document Type. The
description is WorkView - History Purge.

©
2011 Hyland Software, Inc.
368
OnBase 11.0.0 WorkView

Purging Inactive and Deleted Objects

Inactive or deleted objects can be purged. Deleted objects are objects that have been deleted
from WorkView, but were referenced by relationship attributes. Inactive objects are objects
that were created, but were never saved. These objects remain in the database. Purging objects
is not specific to a single class or application. Inactive and deleted objects will be removed
from the entire database. Once purged, data from these objects cannot be viewed. To purge
all inactive and deleted objects from the database:

1. Select Settings | Purge | Inactive/deleted objects... The Purge Inactive/Deleted Objects

dialog box is displayed.

2. Select Inactive if you want the inactive objects purged from the database.
3. Select Deleted if you want the deleted objects purged from the database.
4. If you want to log the purged information, enter or browse to a .log file.
In addition to the log being available in the specified directory, the log is archived into the
OnBase system and can be retrieved in the SYS Verification Reports Document Type.
The description is WorkView - Object Purge.

Note: You can enter the name of the file in the Save As file dialog that is displayed when you
click Browse.

5. Click OK.

©
2011 Hyland Software, Inc.
369
 WorkView OnBase 11.0.0

6. Click Yes to continue. Click No to cancel the purge. Upon completion, a Completed
message will display.
7. Click OK.

RECOVERING DELETED ITEMS

Deleted objects can be recovered within the WorkView Configuration tool. To recover
objects:

1. Select Settings | Undelete Object(s). The Undelete Object(s) from filter dialog box is
displayed.
4

2. Enter the FilterId number associated with the filter that would retrieve the object in the
WorkView Client if it had not been deleted.
3. Click OK. A filter results list is displayed of the objects that have been deleted that meet
the specified filter’s criteria.
4. Open an object that you want to recover.
5. Click Save or Save and Close. A message stating Object has been successfully
undeleted! is displayed.
6. Click OK.
7. Repeat steps 4-6 for each object that you want to recover.

CONFIGURING FULL TEXT CATALOGS

Note: This feature requires the Context Search Framework license.

Note: This feature is only available in the WorkView Unity Client and WorkView Integration
for Microsoft Outlook 2007 interfaces.

©
2011 Hyland Software, Inc.
370
OnBase 11.0.0 WorkView

You can configure catalogs to allow objects to be full text searched. Only class and attributes
configured in a full text catalog can be full text searched. Full text catalogs are configured
within the WorkView Configuration tool. To configure a full text catalog:

1. Right-click on the class that you would like to full text index and select Full text
attributes... The Class Full Text Index Configuration: dialog box is displayed.

©
2011 Hyland Software, Inc.
371
 WorkView OnBase 11.0.0

2. Click Configure catalogs. The Catalog Selection Form dialog box is displayed.

©
2011 Hyland Software, Inc.
372
OnBase 11.0.0 WorkView

3. Click New. The Catalog Form dialog box is displayed.

4. Enter a Catalog name.

5. Select a directory to store the catalog information and enter this directory in the Catalog
Index Path field. You can click Browse to browse to a directory. Each catalog created will
have its own directory.

Note: It is recommended that a UNC path be used.

6. Ensure DT Search is selected from the Full Text Indexing System (Handler) drop-down
select list.
7. Click Save.
If the directory you selected already exists, a message stating WARNING! Specified
directory already exists but is empty. Are you sure you want to use this directory? is
displayed.
If the directory already contains full text information, a message stating WARNING! The
specified directory already contains a set of index files. If you choose to use this specific
directory, any files that exist will be OVERWRITTEN and the data lost. NOTE: Each
catalog must have its own dedicated directory; full text index directories may not be
shared. Are you sure you want to use this directory? is displayed.

8. Click Yes to continue or No to cancel.

©
2011 Hyland Software, Inc.
373
 WorkView OnBase 11.0.0

9. With the catalog selected, click Groups. The Assign User Groups dialog box is displayed.

Caution: If a user group is given rights to a full text catalog, the user group has rights to view any
indexed information in the catalog, regardless of rights to applications and classes. Indexed
information is displayed in search results.

10. Select the appropriate users and click Add>>.

11. Click Save.
12. Click Done.
13. In the Class Full Text Index Configuration dialog box, with the appropriate catalog
selected from the Catalog drop-downs select list, double-click on the attributes that you
want to use for full text searching.

©
2011 Hyland Software, Inc.
374
OnBase 11.0.0 WorkView

14. You can change the Field Name displayed during advanced full text searching by selecting
the attribute and clicking Edit. The Field Name Form dialog box is displayed.

15. Enter the name for the field and click Save.
16. Repeat steps 14 and 15 for each attribute you want to configure.
17. Use the Move up and Move down buttons to order attributes in the order you want them
displayed in the full text search results.
18. After you are done configuring attributes for full text indexing, click Save.
19. When finished configuring attributes, click Index Now. A message stating Would you like
to load all existing objects in this class into full text index now? is displayed.

20. Click Yes to continue the full text index catalog. Click No to cancel.
21. When the index is complete, click OK.
22. Click Done.

Deleting Attributes from a Catalog

In some instances, you may want to delete attributes from a catalog configuration. When an
attribute is deleted from a catalog, future indexing for the class in the catalog will not include
deleted attributes. To delete an attribute from a catalog configuration:

1. In the Class Full Text Index Configuration dialog box, select the catalog from which you
want to delete an attribute.
2. Select the attribute you want to delete.
3. Click Delete. The Delete Confirmation dialog box is displayed asking Are you sure you
want to delete the selected item?

©
2011 Hyland Software, Inc.
375
 WorkView OnBase 11.0.0

4. Click Yes to complete the attribute deletion. Click No to cancel the deletion.
5. Click Save. If you have deleted all of the attributes for a class within a catalog, a message
stating There are no Attributes specified for FullText indexing. Would you like to remove
all data from the current Class? is displayed. Click Yes to delete class data. Click No to
keep the existing indexed data.

If an index was performed including the attribute before the attribute was deleted, the data
for that attribute is still included in the class full text indexed data. In order to delete existing
attribute data from a catalog, you must delete class data from the catalog and perform a new
index to create class data with the appropriate attributes. For more information on deleting
class data, see Deleting Class Data from a Catalog on page 376.
4 Deleting Class Data from a Catalog
In some instances, you may not want data associated with a deleted attribute included in the
searchable full text data. When you want data deleted from a catalog for the deleted
attribute(s), you must delete the class index data and re-index the catalog for the class. To
delete class data:

1. In the Class Full Text Index Configuration dialog box, select the catalog from which you
want to delete the selected class’s data.
2. Click Delete Class Data.
3. A message stating All index data for the current Class will be deleted. Are you sure you
want to continue? is displayed. Click Yes to delete the data. Click No to cancel the
deletion.
4. A message stating Class index data deleted. is displayed. Click OK.

In order to successfully full text search the class in the selected catalog, you will need to index
the class.

Setting A Default Full Text Catalog

You can set a full text catalog that will be searched by default for an application. To set a
catalog as the default catalog:

1. Right-click on a class that belongs to the application that you would like to set a default
full text catalog for and Full text attributes... The Class Full Text Index Configuration:
dialog box is displayed.
2. Select the catalog you want to use as the default from the Catalog drop-down select list.
3. Click Set As Default Catalog.

©
2011 Hyland Software, Inc.
376
OnBase 11.0.0 WorkView

Automatically Updating Full Text Catalogs

You can configure your system to automatically update the full text catalog data when an
object is added, changed, or deleted. In order for full text catalogs to automatically update, the
Hyland Full Text Indexing Service must be installed and running. When the Hyland Full Text
Indexing Service is running, every 120 seconds, the full text catalog change queue within the
database will be polled for objects that needs to be updated in the catalog. The service will
automatically update the catalog.

PREVIEWING WORKVIEW CLIENT

If you want to open the WorkView client to preview your configuration, select File | Open
WorkView… or click the Open WorkView button. WorkView will open. This will refresh the
4
WorkView cache to show updated changes.

WORKVIEW CONFIGURATION TOOLBAR AND MENUS

File Menu

Option Description

New This option accesses the New Connection dialog box, used to log a user into
connection a data source.

Close This option closes the connection to a data source.

connection

New application This option launches the creation of a new application within WorkView.

Open This option opens the WorkView client.

WorkView…

Exit This option exits the WorkView Configuration application.

View Menu

Option Description

List When checked and a Shared Object is selected, the content in the right
pane will be displayed in a list.

©
2011 Hyland Software, Inc.
377
 WorkView OnBase 11.0.0

Option Description

Icons When checked and a Shared Object is selected, each object in the right
pane will be displayed with an icon.

Toolbar When checked, the toolbar is displayed at the top of the screen.

Status Bar When checked the status bar is displayed at the bottom of the screen.

Window Menu

Option Description
4 Cascade This option stacks opened, maximized windows on top of one another
diagonally from the upper left-hand corner of the screen to the bottom
right-hand corner.

Tile This option horizontally tiles open, maximized windows.

Arrange icons Currently not available.

# Window Any windows that are opened are listed here. The window that has a
check mark next to it is the active window.

Settings Menu

Option Description

Configure Accesses the Server(s) connection settings dialog box that allows you
servers… to edit the current web and application server settings.

System paths… Accesses the System path configuration dialog box that allows you to
configure paths for style sheets, resources, and backups.

Options... Allows you to set configuration defaults.

Master security... Accesses the Master security configuration dialog box that allows you
to you configure user rights in a central location.

Purge Accesses purging options.

©
2011 Hyland Software, Inc.
378
OnBase 11.0.0 WorkView

Import/Export Menu

Option Description

Import class data... Selecting this option opens the Import data dialog box. This option
allows you to import data into a class. See Importing Objects Through the
Configuration Tool Interface on page 409 for more information.

Import Allows you to import an .exp file into the database the WorkView
application... Configuration tool is currently connected.

Export Allows you to export an application from the database the WorkView
application... Configuration tool is currently connected to an .exp file.

Copy Application Copies an application from one database to another database. Both 4
databases must be connected to the WorkView Configuration tool at the
same time. If there is only one database connected to the WorkView
Configuration tool, this option will be disabled.

Help Menu

Option Description

Contents... Opens the help files with the Contents tab displayed.

Search... Opens the help files with the Search tab displayed.

Index... Opens the help files with the Index tab displayed.

About WorkView Accesses the About WorkView Config dialog box, which gives
Config… information pertaining to the WorkView Configuration tool.

Toolbar

Button Description

New Connection This option accesses the New Connection dialog box, used to log a user
into a data source.

New Application This option launches the creation of a new application within WorkView.

Open WorkView This option opens the WorkView client.

Print class schema When the Classes node is selected within an application, this button is
enabled and print the class diagram.

©
2011 Hyland Software, Inc.
379
 WorkView OnBase 11.0.0

Button Description

About Accesses the About WorkView Config dialog box, which gives
information pertaining to the WorkView Configuration tool.

WORKVIEW CONFIGURATION TOOL SHORTCUT KEYS

Instead of using your mouse, you can use keyboard shortcuts to accomplish tasks in the
WorkView Configuration Tool.

Menu Bar Shortcuts

4 Press the ALT key to display all ALT key shortcut options. Shortcuts are represented by
underlined letters in the menu bar.
After pressing ALT, use shortcuts by pressing the appropriate keys. When your cursor is
positioned on the drop-down menu, you can use your arrow keys to move vertically and
horizontally through menu options. When your cursor is positioned on a vertical drop-down
menu, you can choose a shortcut within that menu by typing the underlined character.

Additional Shortcuts
There are some additional shortcuts available in the WorkView Configuration Tool, described
in the following table.

Shortcut Description

CTRL + N Opens the New Connection dialog box. See page 151 for more
information.

CTRL + A Opens the screen to create a new application. See page 163 for more
information.

CTRL + W Opens an instance of the WorkView client.

Up Arrow When a node is selected in the left pane, moves the focus up the tree.

Down Arrow When a node is selected in the left pane, moves the focus down the tree.

Left Arrow When a node is selected in the left pane, collapses the selected node.

Right Arrow When a node is selected in the left pane, expands the selected node.

Tab When a node is selected in the left pane, the focus is shifted to the right
pane.

©
2011 Hyland Software, Inc.
380
OnBase 11.0.0 WorkView

Note: These additional shortcuts are functional when the cursor is active in the left pane of
the WorkView Configuration Tool.

WEB.CONFIG FILES

WorkView Settings in the Web.config File

The Web Server’s web.config file controls various features in the Web Client. Within this file
is a WorkView section that controls WorkView specific functionality. The following is an
example of this section: 4
<!-- WorkView Vars -->
<add key="WVMaxResults" value="1000"/>
<add key="WVFilterCount" value="false"/>
<add key="defaultWVView" value="min"/>
<add key="DisplayUserNameAndDate" value="false"/>
<add key="showWVFilterName" value="true"/>
<add key="displayCreatedEForms" value="true"/>
<add key="ScreenToolbarTitles" value="on"/>

<ContextInfo>
<name><![CDATA[WorkView]]></name>
<displayName><![CDATA[WorkView]]></displayName>
<displayOrder>2</displayOrder>
<path><![CDATA[NavPanel/WorkViewUp.gif]]></path>
<enabled>true</enabled>
<!--Turns WorkView Context Button on-off-->
</ContextInfo>
</Context>

<ControlBar>
<name><![CDATA[ViewerOptions]]></name>

©
2011 Hyland Software, Inc.
381
 WorkView OnBase 11.0.0

<displayName><![CDATA[Viewer Options]]></displayName>
<path><![CDATA[UserViewerOptions.aspx]]></path>
<icon><![CDATA[pvconfig.gif]]></icon>
<enabled>true</enabled>
The WVMaxResults setting allows you to specify the maximum number of objects displayed
for unconstrained filter results.
The WVFilterCount setting allows you to turn on or turn off the counts displayed for filters.
Filters that have user entry constraints configured do not have filter counts displayed
regardless of this setting. If true, counts will be displayed in the filter bar displays. Filter
counts shown reflect the number of objects filters return based on filter configuration. If
4 false, counts will not be displayed. By default, counts are turned off.

Caution: If the WVFilterCount setting is enabled, it may negatively impact performance.

The defaultWVView setting allows you to specify how the WorkView objects open. If the
value is equal to min, objects will open in a smaller window. If the value is set to max, objects
will open up maximized to the size of the screen.
The showWVFilterName setting controls whether or not the name of the filter is displayed for
filters embedded in views. If set to true, filter names will display within views. If set to false,
filter names will not display within views.
The displayCreateEForms setting allows you to specify that the View EForm Before Creating
option is selected by default when users create E-Forms from within a WorkView object.
The ScreenToolbarTitles setting allows you to turn on the button titles within objects by
default. To turn on button titles, this setting must be set to on. To turn off button titles, this
setting must be set to off.
The <ContextInfo> element named WorkView controls the display of the WorkView toolbar
button. If the <enabled> value is equal to true, the button is displayed. If the <enabled>
value is equal to false, the button will not be displayed.
The <ControlBar> element named ViewerOptions enables the Viewer Options mode drop-
down list within the User context drop-down list in the Web Client when <enabled> is set to
true. In order to use the settings available with this option, user must have cookies enabled.
In addition, if a user deletes their cookies after the options available in the Web Client have
been set, the settings will be cleared and will need to be reconfigured.

Setting the Maximum Display Results

You can specify the maximum number of results displayed at one time in filter results. This is
specified in the server’s web.config file. Within this file, you will find the following entry:

©
2011 Hyland Software, Inc.
382
OnBase 11.0.0 WorkView

<!-- WorkView Vars -->

<add key="WVMaxResults" value="1000" />
Set the value to equal the maximum number of results that you want displayed at one time.

Setting WorkView to Open By Default

If users have no need to access the retrieval functionality in the Web Client and the
functionality it provides, WorkView can be configured to open directly by default. To do so,
the following needs to be set in the Web.config file of the Web Server.
<DefaultContextInfo>
<defaultContext>WorkView</defaultContext>
<defaultControlBar></defaultControlBar> 4
<defaultContextID>(valid Application ID)</
defaultContextID>
</DefaultContextInfo>
The defaultContext setting should be set with the WorkView value.
The defaultControlBar setting should be left empty.
The defaultContextID should be set to the application ID of the application that should be
selected by default. If no application ID is specified, WorkView will open with no application
selected by default.

Displaying Logged In User

The username and the date and time of the current log in can be displayed under the
application name in the client. To display this information, the DisplayUserNameAndDate
web.config setting must be set to true.

<add key="DisplayUserNameAndDate" value="true"/>

WorkView Settings in the Application Server’s web.config File

The WebServerBaseUrl setting should be set to the root of the Web Server you want to use
with ObjectPop. For example: http://servername/AppNet

Note: If WebServerBaseUrl is not set, the server defined in the WorkView Configuration tool
under Settings | Configure Servers will be used.

©
2011 Hyland Software, Inc.
383
 WorkView OnBase 11.0.0

SYSTEM INTERACTION
When using the WorkView Unity Client interface, Application Enabler can be used to
retrieve and create WorkView objects. The Unity Client - WorkView Retrieval and Unity Client
- WorkView Object Creation contexts are available for configuration in Application Enabler.
For more information about this context, see the Application Enabler documentation.

©
2011 Hyland Software, Inc.
384
 ONBASE CLIENT WORKVIEW
CONFIGURATION

CONFIGURING THE WORKVIEW ONBASE CLIENT INTEGRATION

WorkView can be launched from within the OnBase Client interface if configured to do
so. The WorkView OnBase Client Integration enables you to launch the WorkView Core
Services based client. This integration must meet all WorkView requirements in order to
work correctly.
In order for the OnBase Client to work with WorkView successfully, the following items
must be configured correctly:
• Mapping Pages. See Mapping to WorkView Page on page 385 for more
5
information.
• Configuring the Application Server. See Application Server Overview on page
386 for more information.

Mapping to WorkView Page

To configure the OnBase Client WorkView integration:

1. In the Configuration module, select Utils | WorkView Integration. The WorkView

Integration dialog box is displayed.

2. Enter the URL path to the WorkView server in the WorkView Server URL field. The
format of the URL should be http://machinename/appnet/workview.

©
2011 Hyland Software, Inc.
385
 WorkView OnBase 11.0.0

Note: The URL specified in this field must use the same path, using the same format, as the
dmsVirtualRoot value in the Web Server’s web.config file. For example, if the dmsVirtualRoot
value is http://machinename/appnet, then the URL specified must be http://machinename/
appnet/workview.

3. Click Save.

Application Server Overview

The Application Server is required to allow this module to communicate with OnBase. This is
5 required to ensure consistent functionality across all interfaces so that there is no difference
when accessing OnBase using the OnBase Client, Web Client, or Desktop.

Note: You do not need a separate license in order to use the Application Server.

Defining the Application Server

To use the WorkView Client interface in the OnBase Client, you must define the Application
Server.

To configure the Application Server:

1. In the Configuration module, select Utils | Application Server. The Application Server
Configuration dialog box is displayed.

©
2011 Hyland Software, Inc.
386
OnBase 11.0.0 WorkView

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 resetting the Application Server, 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.
5

©
2011 Hyland Software, Inc.
387
 WorkView OnBase 11.0.0

©
2011 Hyland Software, Inc.
388
 INSTALLATION

REQUIREMENTS

WorkView Unity Client Interface

If you will use WorkView with the Unity Client, refer to the Unity Client Module
Reference Guide for current Unity Client requirement.

WorkView Web Client Interface

This module is only supported in Internet Explorer 7, Internet Explorer 8, and Internet
Explorer 9. Unlike the Web Client, WorkView does not support Firefox browsers.
WorkView requires access to a licensed OnBase Web Server. Refer to the Web Server
Technical and Administrative documentation for additional Web Server Requirements.

Note: The workstation where WorkView applications will be configured using the
WorkView Configuration tool requires Microsoft® .NET Framework 4.0 Extended/Full
Profile. 6
WorkView Configuration Tool
The WorkVew Configuration Tool requires the OnBase Application Server.

©
2011 Hyland Software, Inc.
389
 WorkView OnBase 11.0.0

Databases Supported By WorkView

Databases Description

Microsoft SQL Server SQL Server 2000 and 2005 must be running in compatibility mode
2000 (SP4 recommended) 7 or greater. Running in compatibility mode 6.5 or lower will result
Microsoft SQL Server in errors during the upgrade process.
2005 (SP2 or later
recommended) Note:You must ensure that your SQL Server database client
software version matches or exceeds the database server version.
Microsoft SQL Server
For example, if your database server is SQL Server 2005, verify
2008 (RTM and SP1; SP1
that the database client is SQL Server 2005 (or later). Running a
recommended) previous client version, such as SQL Server 2000, will result in
system instability and memory issues.

Oracle 8i: 8.1.7.7 or later ODBC drivers should be 8.1.7 or later. 8.1.6.x drivers have known
issues and are not supported.

Note:It is strongly recommended that you have a certified Oracle

Database Administrator on staff if you are using an Oracle
Database.

©
2011 Hyland Software, Inc.
390
OnBase 11.0.0 WorkView

Databases Description

Oracle 9i: Release 1 and Oracle driver version 10.2.0.3 is recommended.

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

Note:It is strongly recommended that you have a certified Oracle

Database Administrator on staff if you are using an Oracle
Database.

Oracle 10g: Release 1 Oracle driver version 10.2.0.3 is recommended.

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

Note:It is strongly recommended that you have a certified Oracle

Database Administrator on staff if you are using an Oracle
Database.

©
2011 Hyland Software, Inc.
391
 WorkView OnBase 11.0.0

Databases Description

Oracle 11g: Release 1 All Oracle 11g drivers can be used.

Oracle 11g Release 2 has
not yet been tested Note:It is strongly recommended that you have a certified Oracle
Database Administrator on staff if you are using an Oracle
Database.

ODBC Driver Requirements for Oracle Databases

Oracle 9.x requires ODBC driver version 9.2.0.80 or later.
Oracle 10.x requires ODBC driver version 10.2.0.3 or later.

About Virtual Environments

Hyland Software develops, tests, and supports the OnBase suite of products on specific
Operating Systems, not specific hardware configurations. When OnBase is operated in a
virtual environment (such as Citrix, VMware, Hyper-V, or Windows Remote Desktop) there
may be limitations or subtle differences imposed by the environment. The customer and the
virtual environment vendor are responsible for any interactions or issues that arise at the
6 Hardware or Operating System layer as a result of their use of a virtual environment.
When it appears that an OnBase performance-related issue 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
provided by the virtual environment’s vendor. As with any implementation, Hyland Software
strongly recommends that any customer deploying an 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 OnBase in a Citrix and Microsoft Windows Remote Desktop
Environment reference guide, available from your solution provider.

©
2011 Hyland Software, Inc.
392
OnBase 11.0.0 WorkView

64-Bit Support Statement

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

Load Balancing
WorkView supports load balancing across multiple Web Servers and Application Servers.
Load balancers must support either IP-based or cookie-based load balancing (also referred to
as layer-3, layer-4, and layer-7 load balancing). Load balancers also must be configured to use
persistent session (or sticky session) load balancing. For information about configuring your
load balancer, refer to its documentation. For information about configuring OnBase
modules for load balancing, refer to the Web Server modules reference guide.

Exceptions
6
WorkView in the Unity Client does not support load balancing across multiple Web Servers
or multiple Application Servers.

Windows User Account Control Statement

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

©
2011 Hyland Software, Inc.
393
 WorkView OnBase 11.0.0

If Windows UAC is enabled, the above operations will prompt for administrator privileges,
even if an administrator is currently logged on.

Modifying Configuration Files

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

Installing ActiveX Controls

When ActiveX controls are deployed through the Web browser on a system with UAC
enabled, the user is prompted to install each control:

The prompt is displayed the first time each ActiveX control is needed. Users who are logged
on as administrators can click Yes to install the specified ActiveX control. Once the control is
installed, the user is not prompted again for that control.
If the user is logged on as a standard user rather than an administrator, then an administrator
must provide his or her credentials before the control can be installed. To avoid this scenario,
deploy the Web ActiveX controls using the Hyland Client Side Components installer. For
information about using this installer, see the Core Enterprise Installers module reference
guide.

©
2011 Hyland Software, Inc.
394
OnBase 11.0.0 WorkView

Licensing
See Licensing on page 5 for licensing requirements.

PRE-INSTALLATION
The OnBase Web Server and Application Server must be running and connected to the
database using WorkView. In addition, the Impersonated Identity account configured in the
Web Server’s web.config file within the <identity> element must be granted the Full Control
rights for the directory storing the style sheets. See the Web Server documentation for further
information.

INSTALLATION
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
6
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.

©
2011 Hyland Software, Inc.
395
 WorkView OnBase 11.0.0

ClickOne 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 user’s profile, ensuring that it
cannot interfere with other applications installed on the workstation.
ClickOnce deployments also have the following advantages:
• Previously installed versions of the module can be easily and automatically updated to
the latest version with little or no user interaction.
• The module is installed on a per-user basis and does not require administrator
privileges for local installation.
• There can be multiple instances of the module deployed, allowing for different
versions of the module to be installed on a per-user basis, to match the version
requirements of the workstation it is being installed to.

For more information on Microsoft’s ClickOnce technology see

http://msdn.microsoft.com/en-us/library/142dbbz4(VS.80).aspx.
User Account Control (UAC) — If Windows User Account Control (UAC) is enabled, the
installer must be run with elevated administrator privileges, even if an administrator is
currently logged on. This can be accomplished by right clicking on the installer executable and
6 selecting Run as Administrator from the right-click menu. MSI files cannot be run using the
Run as Administrator option. Instead, you must launch the MSI package using the command
line. For more information on installing files through the command line, refer to your
Microsoft support information or see http://technet.microsoft.com/en-us/library/
cc759262(WS.10).aspx.
WorkView can be installed using the Hyland Server Side Components Installer. For more
information about this method of installation, see the Core Enterprise Installers
documentation.
The following instructions describe how to manually install WorkView.

1. Copy the wvconfig.exe file to a location accessible by users who will need to configure
applications.
2. Place the rmmgmtsvc.dll file in a system path configured in Environment Variables, for
example c:\Windows\System32. After placing this file in a correct path, it must be
registered with the following command from the directory it resides:
regsvr32 rmmgmtsvc.dll

3. From the install folder of the build, open the Hyland.Scripting folder and double-click
the Hyland.Scripting.msi executable.

©
2011 Hyland Software, Inc.
396
OnBase 11.0.0 WorkView

4. Copy the contents of the /apps/WorkView folder within the build to the same directory
that the wvconfig.exe file was copied.

Note: If Windows User Account Control (UAC) is enabled, setting WorkView Configuration
as Run as Administrator can alleviate issues that can occur when importing, exporting, cloning
or copying WorkView applications. For details on UAC, refer to your Microsoft support
information or see http://technet.microsoft.com/en-us/library/cc709691(WS.10).aspx.

Setting X-UA-Compatible HTTP Header Version

When using WorkView, the X-UA-Compatible HTTP Header version must be set to 7. The
following are steps for IIS 6 and IIS 7 to make this required configuration change. If you are
using older views created in the View Editor, there are other considerations for this setting.

IIS 6.x Steps

1. On the Web Server machine, open Internet Information Services (IIS) Manager.
2. In the left pane, navigate to the Web Server’s virtual directory.
3. Right-click the virtual directory and select Properties.
4. Click the HTTP Headers tab. 6
5. Under Custom HTTP Headers, double-click X-UA-Compatible: IE=9.

6. Set the Custom Header Value to IE=7.

7. Click OK.

©
2011 Hyland Software, Inc.
397
 WorkView OnBase 11.0.0

IIS 7.x Steps

1. On the Web Server machine, open Internet Information Services (IIS) Manager.
2. In the left pane, navigate to the Web Server’s virtual directory.
3. Under IIS in the center pane, double-click HTTP Response Headers.

4. Double-click the X-UA-Compatible header.

5. Set the Value to IE=7.
6. Click OK.

Settings for View Editor Views

When using old views created in the View Editor, the following X-UA-Compatible header
settings must be applied depending on your Internet Explorer version:
• If all users in system are using Internet Explorer 7, the X-UA-Compatible header must
be set to IE=7.

©
2011 Hyland Software, Inc.
398
OnBase 11.0.0 WorkView

• If users in the system are using a combination of Internet Explorer 7 and Internet
Explorer 8, the X-UA-Compatible header must be set to IE=EmulateIE7. In addition,
WorkView must be set up in a separate virtual directory from the Web Server. Other
applications associated with the Web Server will not function using the
IE=EmulateIE7 setting.

Caution: When using Internet Explorer 9 in conjunction with old views created in the View Editor,
Internet Explorer 9 is not supported.

Setting Content Expiration

The following directories must be configured for 7 days content expiration:
..\Appnet\Workview\HTCs
..\Appnet\Workview\images
..\Appnet\Workview\scripts
..\Appnet\Workview\stylesheets

Note: When using the Server Side Installer to install WorkView, the content expiration setting
is set to 7 days automatically. 6
To set content expiration for these directories, complete the following:

1. Right-click on My Computer and select Manage.

2. Expand Services and Applications.
3. Expand Internet Information Services.
4. Expand Web Sites.
5. Expand your OnBase web site.
6. Expand appnet.
7. Expand WorkView.
8. Select the appropriate directory, right-click, and select Properties.
9. Select the HTTP Headers tab.
10. Select the Enable Content Expiration.
11. Select Expire after and enter 7 days.
12. Click Apply.

©
2011 Hyland Software, Inc.
399
 WorkView OnBase 11.0.0

13. Click OK.

14. Repeat steps 8-13 for each directory you need to configure content expiration.

Consideration for SSL

If you are using SSL, you must disable the Enable Content Expiration option for the Virtual
Directory. If this is not disabled, attribute fields will not be displayed.

Localization
The WorkView Configuration tool can be localized into English, Japanese, or Portuguese
currently. In order to localize the configuration tool, the workstation must be set with the
proper regional setting and the language .dll file must be installed into the same folder where
wvconfig.exe is installed, for example c:\Program Files\Hyland\WorkView. The language .dll
files are the following:
• ResourceDllENU.dll
• ResourceDllJPN.dll
• ResourceDllPTB.dll

If a workstation is set to a regional setting other than English, Japanese, or Portuguese, the
6 configuration tool will default to English.

COMMAND LINES
If you are going to support multiple versions of WorkView, you can use a command line
switch to force the WorkView Configuration tool’s executable to load the associated .dll files
installed in the same directory as the tool’s executable, rather than the .dll files installed in the
system directory. To achieve this, apply the -MULTIPLEVERSIONS switch to the end of the
WorkView Configuration tool’s shortcut Target field. Using this method, multiple versions of
the WorkView Configuration tool can be used simultaneously.

TROUBLESHOOTING
Windows Event Viewer
You can troubleshoot issues with WorkView by viewing the error logging available. Error
logging is available in the Windows Event Viewer. To view the WorkView error logging:

1. In Windows, select Start | Control Panel.

2. Double-click on Administrative Tools.

©
2011 Hyland Software, Inc.
400
OnBase 11.0.0 WorkView

3. Double-click on Event Viewer.

4. Select OnBase Log in the left pane.
5. Errors are displayed in the right pane. Double-click on any error to view details.

Diagnostic Console
Using the vbscript-profile in the Diagnostic Console, you can log VB script execution events
in WorkView. Logged information corresponds to the Script Trace tab of the Diagnostic
Console.

Logging for the Context Search Framework

If you are licensed for the Context Search Framework, you can log activity and errors
associated with this module on the Full Text tab of the Diagnostics Console. In order to log
information to this tab, the fulltext-profile option has to have the enableFile attribute set to
true in the Hyland.Core.FullText.NTService.exe.config file.

You can also define the level of logging in the following LogVerbosity setting:
<setting name="LogVerbosity" serializeAs="String">
<value>0</value>
</setting> 6
When the value is set to 0, only critical errors are logged to the Full Text tab of the
Diagnostics Console.
When the value is set to 1, most messages are displayed in the Full Text tab of the Diagnostics
Console.
When the value is set to 2, additional logging for troubleshooting is enabled.

OnBase Client WorkView Integration

Problem: You cannot open the WorkView Integration in OnBase and you receive an Internet
Explorer script error stating Access is denied.
Resolution: In the Configuration, select Utils | WorkView Integration. Make sure that the
URL specified in the WorkView Server URL field uses the same server location, specified in
the same format as the location specified for dmsVirtualRoot in the Web Server’s web.config
file. For example, if the dmsVirtualRoot value is http://machinename/appnet, then the URL
specified must be http://machinename/appnet/workview.

©
2011 Hyland Software, Inc.
401
 WorkView OnBase 11.0.0

Exporting to Excel
A warning message is displayed when attempting to export to Excel from a WorkView filter
on a computer with Office 2007 installed:
The file you are trying to open, '[filename].xls', is in a different format than specified by the
file extension. Verify that the file is not corrupted and is from a trusted source before
opening the file. Do you want to open the file now?
If the user chooses to open the file, the content opens, but not in a readable format.
The alert is a security feature in Excel 2007 called Extension Hardening. It ensures the file
content being opened matches the extension type specified in the shell command attempting
to open the file. This alert prompt is by design.
Client desktops can change this behavior of Extension Hardening by setting the following
registry key:
Key: HKEY_CURRENT_USER\Software\Microsoft\Office\12.0\Excel\Security
Value: (DWORD)"ExtensionHardening" = [0 = Disable check (user will not be prompted
with alert); 1 = Enable check and prompt (default; user will be prompted); 2 = Enable check,
no prompt deny open (the file will not be opened)]
To prevent users from seeing this message, the ExtensionHardening value can be set to 0 as
described above.
6
Large Views
When a view exceeds 4096 KB in size, the Web Server’s maximum request length must be
adjusted. To adjust this setting, in the web.config file edit the maxRequestLength setting to a
larger number.

Title Bar
If the Web Server name is displayed in the title bar in front of the WorkView title, you can
configure Internet Explorer to remove the server name from the title bar. Perform the
following steps on the problem workstation(s) to resolve:

1. Open Internet Explorer.

2. Select Tools | Internet Options.
3. Select the Security tab.
4. Select your OnBase Web Server's zone (i.e. Trusted Sites).
5. Select Custom Level.
6. Scroll to the Miscellaneous section.

©
2011 Hyland Software, Inc.
402
OnBase 11.0.0 WorkView

7. Enable Allow script-initiated windows without size or position constraints.

8. Click OK and then restart Internet Explorer.

View Editor
If you are using the View Editor, you must have Internet Explorer 7 installed and the
web.config file for the Web Server set to IE7.

Width and Height of Labels

In order to make views in accordance with HTML standards, labels do not respect width or
height settings. This may affect previously configured views. When views do not display as
they previously did due to the width and height of labels not being respected, you can either
create a new style or edit the existing style; the style applied to the label must contain the
following:
{
display: inline-block;
}

CONTACTING SUPPORT 6
When contacting your solution provider, please provide the following information:
• The OnBase module where the issue was encountered.
• The OnBase version and build (Example: 11.0.0.571) and/or the Core Services
version and build (Example: 11.0.0.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.

©
2011 Hyland Software, Inc.
403
 WorkView OnBase 11.0.0

Supplied with the above information, your solution provider can better assist you in
correcting the issue.

©
2011 Hyland Software, Inc.
404
 ACTIONS WITH VBSCRIPTING

EXECUTING SCRIPTS
You can use VBScripts to execute actions. The following examples are related to
VBScripting.
The following is an example of the syntax needed for the Action command field:
scriptID:103;scriptEntryPoint:MyScriptRoutine;scriptLangu
age:vbscript

Modifying Attribute Values

Attributes within WorkView can be updated through actions. The following lines are
examples of syntax needed for the Action command field:
Example 1:
205:CLOSED
or
Status: CLOSED
Example 2:
205:CLOSED;206:Completed;207:%D;208:%U
or
Status: CLOSED; Reason: Completed; DateClosed: %D;
ModifiedBy: %U
The first example will set the value for the attribute with the Attribute ID number 205 to
CLOSED. A
The second example will set the value for the attribute with the Attribute ID number 205
to “CLOSED”. It will do the following:
• set the value for the attribute with the Attribute ID number of 206 to
“Completed”.
• set the value for the attribute with the Attribute ID number 207 to the current
date.
• set the value for the attribute with the Attribute ID number 208 to the user
currently logged in.

©
2011 Hyland Software, Inc.
405
 WorkView OnBase 11.0.0

Note in this example, attributes/value pairs are separated by semi-colons (;).

Note: Attribute ID numbers or Attribute names can be used to identify the attribute to be
updated.

EXECUTING OTHER ACTIONS

Multiple configured actions can be executed in one action. The following lines are examples
of syntax needed for the Action command field:
actions:1001,1002,1004
In this example actions with the Action IDs of 1001, 1002, and 1004 will execute when this
action button is clicked. Note in this example, Action ID numbers are separated by commas
(,).

DEFAULT VALUES FOR ACTIONS

Default values can be used when configuring actions. Macros can be used for default values.
See Appendix F on page 455 for more information about macros.

SPECIFYING A TIMEOUT
To specify a timeout length, enter the following line to a script:
const rm_ScriptTimeout=#
The number value that this line is equal to will be the length of time that is allowed before a
A timeout occurs. The value is measured in milliseconds. The value must be less than or equal to
the maximum value that is set in the database. If this line is not entered into a script, the
database value will be respected. If no maximum length is specified in the database, the
default value is 20 seconds.

©
2011 Hyland Software, Inc.
406
 ADVANCED FIXED CONSTRAINTS

The following can be used in the Fixed Constraints tab when configuring a filter. These
codes can be used as the value for the attribute.

Attribute Values

Code Description

~User Logged on user name (for example: "MANAGER").

~Realname Logged on user’s real name.

~Today The current date.

~FirstOfMonth First day of current month.

~LastOfMonth Last day of current month.

~LastBusinessDay Last business day. If the day of the week is Sunday, Saturday will be
used as the last business day.

~[attrname] This can be used only for filters embedded on a view. This macro,
also known as Dynamic Fixed Constraint, gets the named attribute's
value from the currently displayed object and uses that value as the
filter constraint. If a filter with this constraint is executed from the filter
bar, the query will return no results.

B
Any of the date related fixed constraints can be used as a "base" for the following:

Code Description

~Today+7 7 days from the current date.

~Today-14 14 days before the current date.

~LastOfMonth+32:%m-01-%Y Last day of current month + 32, and then the first of whatever
month that falls in. (if any day in June, should always be 8/1).

©
2011 Hyland Software, Inc.
407
 WorkView OnBase 11.0.0

©
2011 Hyland Software, Inc.
408
 IMPORTING AND EXPORTING
OBJECTS

In addition to importing new data, WorkView also supports object updates and deletions
when a unique key can identify a data value.

Caution: The importing of unique attributes with values 256 characters are larger is not
supported.

Data can be imported through a user interface in the WorkView configuration tool.
Both exporting and importing objects can also be controlled via VB scripts.

IMPORTING OBJECTS THROUGH THE CONFIGURATION TOOL

INTERFACE
Data can be importing into OnBase to automatically create objects.

Caution: When using the Import Class Data feature on a class that contains relationship attributes
related to another class, ensure that the parent class object data exists in the database prior to
running the import on the class that contains the relationship references.

To import objects from within the WorkView Configuration Tool:

1. Select Import/Export | Import class data. The Import data dialog box displays.

C
2. Browse to the import index file that contains the data you want to bring into
OnBase.
3. If you want to test your import before bringing data into OnBase, select the Test
mode only check box.

4. If you want to test the data being imported against the class level script, select the
Use validation scripts when importing option.

5. Click OK. An dataImport.log will display. This file will display any problems that were
encountered. If a file was successfully processed into OnBase, the following message
is displayed in the dataImport.log file: rmImport of file <file path name>, Mon Jun
21 16:16:10 2004

©
2011 Hyland Software, Inc.
409
 WorkView OnBase 11.0.0

Upon data import, a log is archived into the OnBase system in the SYS Verification Reports
Document Type. The description is WorkView - Data Import.

Note: If you do not delete the dataImport.log file after importing in data, the file will
accumulate processing information for subsequent imports.

Import File
In order to import data directly into objects, the import file must be formatted in a particular
way. The following is an example of an import file:

[1054]

>Name Department Phone Email

+William Taft DEV x5200 wtaft@company.com

+John Adams QA x5201 jadams@company.com

+William McKinley Sales x5202 wmckinley@company.com

[1053]

>VendorNumber VendorName Buyer.Name

+1111111 Vendor for 1111111 William Taft

+2222222 Vendor for John Adams

2222222

+3333333 Vendor for William McKinley

C 3333333

[1054]

>Name*

-William McKinley

In order to import data into an object, you must specify the class the object will belong to. In
the example, classes identified with numbers 1054 and 1053 will have data imported into
them.

©
2011 Hyland Software, Inc.
410
OnBase 11.0.0 WorkView

Next, the attributes that values will be imported into must be specified. The line defining the
attributes is prefixed with >. Each attribute should be separated by a single tab. The attribute
named should match the name of the attribute in WorkView exactly and is case sensitive.
If the attribute name is following by *, the attribute is specified as the primary attribute that
uniquely identifies objects. This attribute will be used to determined what objects are created,
deleted, or updated, depending on the specifications of the import file.
If values are added, each line of data should be prefixed with +. If data is being deleted, each
line should be prefixed with -. If data is being updated, data should be prefixed with =.

EXPORTING OBJECTS THROUGH SCRIPTING

The script necessary for exporting objects begins by connecting to the datasource and
accessing WorkView module (OnBase.RelationshipManagement).
The ExportObjects API is then called with two strings as input. The first is the filename of
the export file to be created. The second is a list of several parameters to pass to the Export
routines. This second argument lists the classes separated by commas and any other
parameters that may be of interest. An example of exporting information to a file can be
found in testexport.vbs (Example 1).

Example 1: testexport.vbs
Option Explicit

const dataSource = "OBERDemo"

const userName = "MANAGER"
const password = "PASSWORD"
C
Dim dsm
set dsm = CreateObject( "DMCorex.OBXDataSourceManager" )

Dim ds
set ds = dsm.GetDataSourceByName( dataSource )
ds.Open

Dim session

©
2011 Hyland Software, Inc.
411
 WorkView OnBase 11.0.0

set session = ds.NewSession( userName, password )

session.Connect

Dim relMgmt
set relMgmt = session.CreateServicesModule(
"OnBase.RelationshipManagement" )

Dim admin
set admin = relMgmt.Admin
admin.ExportObjects
"file:testexport.exp;classes:TestClass,AnotherClass,Class3;s
tartdate:10/15/
2003;trackmods:1;includeobjectinfo:1;includeobjectid:1"

session.Disconnect

In Example 1, all information that was entered or modified after the start date (10/15/2003)
in the classes "TestClass", "AnotherClass", and "Class3" is exported.

Syntax of ExportObjects Call

The following is an example of an ExportObjects call:
admin.ExportObjects
"file:<exportfilename>;<exportparameters>"

C <exportfilename> is the file to which the data is exported.

<exportparameters> specifies exactly what is to be exported
and has the following format:
<var>:<value>;<var>:<value>;…

<var> and <value> Descriptions

<var> <value>

classes Comma separated list of class names to export.

startdate All creations/modification after this date will be exported.

©
2011 Hyland Software, Inc.
412
OnBase 11.0.0 WorkView

<var> <value>

Trackmods Used to include the tracking information. Outputs the history of

each from the specified start date.

IncludeObjectInformation Use to include the object properties such as creation date/time

and the user who created the object etc.

IncludeObjectID Used to include the object identifier in the export.

IMPORTING OBJECTS THROUGH SCRIPTING

To import information into OnBase you must call the ImportObjects method. An example of
this can be found in testimport.vbs (Example 2).

Syntax of ImportObjects Call

The following is an example of and ImportObjects call:
admin.ImportObjects <importfilename>
<importfilename> is the file containing the import data (see Format of import/export file
section for format).
There is a sample import file that comes with testimport.vbs called testimport.imp (Example
3).

Example 2: testimport.vbs
Option Explicit

const dataSource = "OBERDemo" C

const userName = "MANAGER"
const password = "PASSWORD"

Dim dsm
set dsm = CreateObject( "DMCorex.OBXDataSourceManager" )

Dim ds
set ds = dsm.GetDataSourceByName( dataSource )
ds.Open

©
2011 Hyland Software, Inc.
413
 WorkView OnBase 11.0.0

Dim session
set session = ds.NewSession( userName, password )
session.Connect

Dim relMgmt
set relMgmt = session.CreateServicesModule(
"OnBase.RelationshipManagement" )

Dim admin
set admin = relMgmt.Admin

admin.ImportObjects "file:testimport.imp"

session.Disconnect

Example 3: testimport.imp
[TestClass]
>Attr1Attr2*Attr3
+Wah110/10/2003
+Weh311/10/2003

C [AnotherClass]
>Column1Number2Keything*Bigdata
+Fred11Bleh
+Ralph22Bler

[Class3]
>keycol*Bigdata
+11value1
+12value2
+13value3

©
2011 Hyland Software, Inc.
414
OnBase 11.0.0 WorkView

+14value4
=25value5

Note: Though the columns may not line up visually, the data does line up. In the first section
[TestClass] on the first + entry Attr1 is “Wah”, Attr2 = 1, and Attr3 = “10/10/2003” (even
though that string looks like it is under Attr2). It is the number of tabs which determines the
column into which the data will go.

FORMAT OF IMPORT/EXPORT FILE

The format of the export and import files is as follows:

[classname1]
; Comment line
>col1name* {tab} col2name* {tab} …
+col1data {tab} col2data {tab} …
+col1data {tab} col2data {tab} …
=col1mod {tab} col2mod {tab} …
-col1del {tab} col2del {tab} …

[classname2]
…
Key:Variables Optional
Required( [ + = -) {Characters}
C

Code Description

[] Provides the current class name.

> Is an attribute definition. It names the attributes of the class. If

a * is to the right of one of these names it means it is a
primary key.

+ Is an addition command. It will add a new entry into the

instance tables of the currently active class (the last class
found in [] and having defined columns).

©
2011 Hyland Software, Inc.
415
 WorkView OnBase 11.0.0

Code Description

- Is a delete command. It will remove an entry with the

specified key. If the key is in the second column a tab must
be placed before the key value to line it up with the column
name found in “>”.

= Is a modify command. The item with the matching primary

key column will be updated with the new information in the
remaining columns.

; Is a comment line. Explanation text can be placed on these

lines.

It is important to note that rows must have the proper number of tabs in them. It is not
important that they visually line up. It is more important that the count of tabs remains
correct. If you set your tab width large enough everything should line up.
Values of attributes are matched to columns based on the number of tabs found. For
example, in the preceding format if you left “col1mod” blank and just had a {tab}, the import
process would match by “col2mod” and only update columns which were filled in. Of course,
the column being sought has to be a key so the column definition on the > line(col2name)
would require an asterisk (*) by it.
The classes and applications have to be set up in the WorkView Configuration tool to support
the columns referred to in the import files. If an attribute does not exist that is referred to in
an import file there will be an error while running the VBScript.
Since columns marked as keys are only used to find objects to update, there is another way to
change the value in a primary key column. You must add an additional column with the same
column name but do not include the * modifier to indicate it as a unique key.
For example, you might want to modify the record of class “class” with key value “Key” equal
to 1 to change “Key” to 2 and not modify the other column “Val”. The import file might look
C something like Example 4.

Example 4: Example of updating a unique key value.

[class]
>ValKey*Key
=12

©
2011 Hyland Software, Inc.
416
 FILTERPOP

FilterPop allows you to create a URL that opens WorkView filter results. This allows a
URL to be sent to users and provides a direct link to WorkView objects that meet specific
criteria.
To create a FilterPop URL:

1. In Internet Explorer, go to the following location: http://<ServerName>/

<VirtualDirectory>/Workview/filterPop.aspx where <ServerName> is the name of
the server on which WorkView is installed and <VirtualDirectory> is the virtual
directory on which WorkView is installed.
2. Login using a valid username and password for the current ODBC source configured
for the Web Server. Upon logging in, the following screen is displayed:

3. From the Select an Application drop-down select list, select the application for which
you would like to return filter results.

Note: Only the applications that the currently logged in user has rights to are available for
D
selection.

©
2011 Hyland Software, Inc.
417
 WorkView OnBase 11.0.0

4. If you want to use a pre-existing filter that has already been configured, select the Select a
Filter radio button and select the filter from the drop-down select list that is displayed.
When using this option and the filter selected is configured with User Entry Constraints,
the user will be able to use the filter to search for objects. Only objects matching the
constraints specified when the FilterPop URL is created will be returned in the results
regardless of the criteria entered by the user.
If you want to create an ad hoc query for a specific class, select the Select a Class drop-
down select list and select the appropriate class from the drop-down select list that is
displayed.

Note: External Classes are not supported when using the Select a Class option. External
classes are not displayed for selection from the Select a Class drop-down select list.

Note: Only classes that the currently logged in user has rights to and filters assigned to those
classes will be available for selection.

5. Specify the attribute values that you want to use to constrain the filter results. All
attributes associated with the selected class or the class associated with the selected filter
are displayed.

©
2011 Hyland Software, Inc.
418
OnBase 11.0.0 WorkView

6. Click Get URL. A URL is generated.

7. You can click Copy URL to copy the generated URL. In addition, you can click Execute
Object List to view the results of the generated URL

D
Note: If a user does not have rights to a class to which a filter belongs that is accessed from a
FilterPop URL, the filter will not be displayed to the user, regardless of the FilterPop URL
configuration.

LICENSE USAGE FOR FILTERPOP

When a user logs in to FilterPop, only a Concurrent Client license is consumed. A WorkView
license will be consumed when an object is opened from the filter.

©
2011 Hyland Software, Inc.
419
 WorkView OnBase 11.0.0

©
2011 Hyland Software, Inc.
420
 CONFIGURING THE DISTRIBUTION
SERVICE

OVERVIEW
The Hyland Distribution Service is an OnBase 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.

E
As an OnBase Core Services component, the Distribution Service requires certain Core
DLLs, specifically from NT Services. Distribution Service may run on a machine separate
from that of the Application Server, if necessary.

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 426.

©
2011 Hyland Software, Inc.
421
 WorkView OnBase 11.0.0

INSTALLATION
The Hyland Distribution Service can be installed either manually or using the Hyland
Components Installer. Be sure to install the OnBase Core on the same server as the Hyland
Distribution Service. The Hyland Distribution Service requires the OnBase Core to be able to
send e-mails with attachments.

Installing the Distribution Service Manually

If necessary, you can manually install the Distribution Service and configure it by editing its
XML configuration file.

1. Ensure a matching version of the OnBase Core is installed on the server. The Core can
be installed using the Hyland Server Side Components installer. See the Core Enterprise
Installers module reference guide for more information.
2. From your OnBase Core Services directory, open the
..\apps\NTServices\Hyland.Core.Distribution folder.

3. Copy the contents of the Hyland.Core.Distribution folder and paste them in a logical
location on the server. For example: C:\Program Files\Hyland\Services\Distribution in
a 32-bit environment, or C:\Program Files (x86)\Hyland\Services\Distribution in a 64-
bit environment.
4. From the Command Prompt, navigate to the location of your Distribution Service
executable For example, type:
cd "C:\Program Files\Hyland\Services\Distribution"
5. From this location, run the following command:
Hyland.Core.Distribution.NTService.exe /install
E This will add the Distribution Service to your Windows Services console.
6. Navigate to the location where you copied the files in step 3.
7. With a text editor, open the Hyland.Core.Distribution.NTService.exe.config file.

©
2011 Hyland Software, Inc.
422
OnBase 11.0.0 WorkView

8. In the <Hyland.Core.Distribution> section, configure the values for the following

securitySettings. Be sure to remove the brackets from the values you are adding, but keep
the quotation marks. For example, provide the value for password as "PASSWORD"
not "[PASSWORD]"

Setting Description

pollSettings interval This is the interval that the Distribution Service uses to poll OnBase for
notifications. The default value is 120 (seconds). Change this value to
the number of seconds you consider an acceptable delay for sending
notifications. For example, if five minutes is an acceptable delay,
change the value to 300 (5 mins. x 60 secs/min.). If notifications need
to be sent within a minute of being created, change the value to 60 (1
min. x 60 secs/min).

Datasource This is the ODBC connection to the OnBase database. When creating
the ODBC connection in a 64-bit environment, use the 32-bit version of
the ODBC Administrator Console instead of the default console
residing in system32 (odbcad32.exe). The 32-bit version typically
resides in C:\Windows\SysWow64.

Note:To add support for multiple data sources, see Adding Support for
Multiple Data Sources on page 432.

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 426.

password The password of the Service Account.

Note:For increased security, encrypt the Service Account’s user name

and password in the system registry. See Encrypting the Service
Account's Credentials on page 430. E

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.

©
2011 Hyland Software, Inc.
423
 WorkView OnBase 11.0.0

9. Under smtpSettings, modify the following settings:

Setting Description

smtpServer Set to your organization’s SMTP server.

defaultSender This value is displayed as the sender of the notification by default. If

you enter a valid e-mail address, undeliverable notifications will be sent
to this address. For example, enter
Administrator@yourdomain.com. When notifications are delivered
to users, the From field will display Administrator@yourdomain.com.
Any notifications that could not be delivered will be sent to this address.

Tip:Change the defaultSender value to USER (all uppercase) to

display the e-mail address of the OnBase user who triggered the
notification. For more information and requirements, see Displaying the
User Who Triggered the Notification as the Sender on page 433.

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 433.

Note: The faxSettings element is not in use.

10. Open Services from the Administrative Tools in the Windows Control Panel, and
double-click Hyland Distribution Service.
11. Click the Log On tab.
12. Enter the correct logon information for the user account that will be used to run the
E Distribution Service. Click OK.
13. Start the service.

Note: For troubleshooting purposes, it is recommended you run only one instance of the
Distribution Service on the system.

©
2011 Hyland Software, Inc.
424
OnBase 11.0.0 WorkView

Uninstalling the Distribution Service

There are several methods for uninstalling the Distribution Service. If you installed the
Distribution Service manually, you can either run a command from a command prompt, or
manually stop the service and remove the files.
If you installed the Distribution Service using the Hyland Server Side Components installer,
then you can use the Add or Remove Programs utility in the Windows Control Panel to
remove Hyland Server Components.

Running a Command
This is the preferred method for uninstalling the Distribution Service.

1. From a command prompt, navigate to the location of your Distribution Service

executable (for example, C:\Program Files\Hyland\Services\Distribution).
2. From this location, run the following command:
Hyland.Core.Distribution.NTService.exe /uninstall

Stopping the Service and Removing Files

1. Using a Run dialog box, run services.msc.

To do this, select Start | Run, type services.msc and click OK. The Services console is
displayed.
2. Stop the Distribution Service.
3. Use the Task Manager to ensure the executable is no longer running.
You may now delete the Distribution Service’s physical files.
4. From a Run dialog box, run regedt32.exe.
Select Start | Run, type regedt32.exe and click OK. The Registry Editor window is E
displayed.
5. Navigate to HKLM\SYSTEM\CurrentControlSet\Services.
6. Delete the Hyland.Core.Distribution.NTService registry key.
7. Restart the computer.

©
2011 Hyland Software, Inc.
425
 WorkView OnBase 11.0.0

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.

To configure a Service Account:

1. From the Configuration module, select Users | User Names / Passwords.

The User Names & Passwords dialog box is displayed.

©
2011 Hyland Software, Inc.
426
OnBase 11.0.0 WorkView

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.

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. A Service Account also
grants the user name full rights and privileges in OnBase. Deselecting the Service Account check box
for the existing user allows them to retain all previous rights and privileges that were previously
assigned to them. Options in the User Settings dialog box are cleared when the Service Account check
box is selected and must be re-applied when the check box is deselected.

©
2011 Hyland Software, Inc.
427
 WorkView OnBase 11.0.0

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

Note: When selecting the Service Account check box, all options not applicable to a Service
Account are disabled.

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.

©
2011 Hyland Software, Inc.
428
OnBase 11.0.0 WorkView

5. Click Save.

Enabling the Distribution Service

To use the Distribution Service to send users e-mail notifications or to distribute e-mails, you
must enable it through Global Client Settings. (This step is not necessary if the Distribution
Service is used only by WorkView.)
The Distribution Service can be used to send e-mail distributions while using the Document
Distribution module and is optional.
The Distribution Service is optional if you want to send notifications for the following
modules in the OnBase Client: Document Knowledge Transfer, Workflow, and Physical
Records Management. The Distribution Service is required for all other modules that are able
to send notifications (such as Document Knowledge Transfer or Workflow in the Web
Client).
To enable e-mail automation using the Distribution Service:

1. From the Configuration module, select Users | Global Client Settings.

2. Click the Email tab.
3. Select the Use E-mail Distribution Service for automated e-mails check box or, if you are
configuring the Distribution Service for Document Distribution, select the Use E-mail
Distribution Service for Document Distribution check box.

4. Click Save.

Note: When sending an attachment, the Distribution Service always uses the document’s
Auto-Name for the attachment’s 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.
E
Users Configuration Requirements
The following procedure describes the steps necessary to configure the Distribution Service
for system notifications. Ensure users who will receive notifications have e-mail accounts
configured in their User Settings.

1. From the Configuration module, select Users | User Names/Passwords.

2. Select the user name and click Settings.
3. In the Users E-mail field, type the user’s e-mail address.

©
2011 Hyland Software, Inc.
429
 WorkView OnBase 11.0.0

Encrypting the Service Account's Credentials

By default, the Service Account’s user name and password are entered in
Hyland.Core.Distribution.NTService.exe.config in clear text. Although these credentials
cannot be used to log on to any OnBase client application, it is considered a security best
practice to encrypt them in the Windows registry using the aspnet_setreg utility. The
Distribution Service can then be configured to refer to the encrypted registry keys to retrieve
the Service Account’s user name and password.

Note: Full details on creating encrypted account registry keys are available in the Microsoft
article: “How to use the ASP.NET utility to encrypt credentials and session state connection
strings” available at: http://support.microsoft.com/kb/329290/

1. From a command line, change the directory to the location where the aspnet_setreg.exe
utility resides. A copy of aspnet_setreg.exe is available in the ..\utilities\MISC
subdirectory of the Core Services build.
For example, if the utility is in C:\Program Files\Hyland\Web Server\Utilities, then
enter:
cd C:\Program Files\Hyland\Web Server\Utilities
2. Enter the following command, where username is the user name of the Service Account,
and password is the password.
aspnet_setreg.exe
-k:SOFTWARE\Hyland\DistributionService\Identity
-u:"username" -p:"password"
3. Open a Run dialog box and enter regedt32.
4. Grant the Windows account that will run the Distribution Service Read permissions to
E 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_SETREG.
When run in a 64-bit environment, the aspnet_setreg utility automatically stores the
encrypted credentials in this key.

©
2011 Hyland Software, Inc.
430
OnBase 11.0.0 WorkView

5. Open the Hyland.Core.Distribution.NTService.exe.config file.

• In a 32-bit environment, this file’s default location is
C:\Program Files\Hyland\Services\Distribution.
• In a 64-bit environment, this file’s 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\Iden
tity\ASPNET_SETREG,userName"
b. Replace the password value with the following:
"registry:HKLM\SOFTWARE\Hyland\DistributionService\Iden
tity\ASPNET_SETREG,password"
When you are finished, the securitySettings element should resemble the following:

7. Save the configuration file.

8. Restart the Hyland Distribution Service using the Windows Services console.
E
Changing Configuration File Settings
You can change settings like the data source, SMTP server, and default sender by editing the
Distribution Service’s configuration file. To modify these settings, do the following:

1. Open the Hyland.Core.Distribution.NTService.exe.config file.

• In a 32-bit environment, this file’s default location is
C:\Program Files\Hyland\Services\Distribution.
• In a 64-bit environment, this file’s default location is
C:\Program Files (x86)\Hyland\Services\Distribution.
2. Change the settings as needed.

©
2011 Hyland Software, Inc.
431
 WorkView OnBase 11.0.0

3. Restart the Distribution Service. The new settings are respected.

Adding Support for Multiple Data Sources

If your solution uses multiple data sources, then the Hyland Distribution Service can be
configured to access each data source.

1. Open the Hyland.Core.Distribution.NTService.exe.config file.

• In a 32-bit environment, this file’s default location is
C:\Program Files\Hyland\Services\Distribution.
• In a 64-bit environment, this file’s default location is
C:\Program Files (x86)\Hyland\Services\Distribution.
2. Copy the following element, which is located under <Hyland.Core.Distribution>:

3. For each data source that the service needs to access, paste a copy of the element directly
under the existing element. For example, if the service needs to access two data sources,
then there should be two securitySettings elements, each with its own closing tag
(</securitySettings>).
In the following example, support has been added for two data sources:

4. For each securitySettings element, change the datasource value to the name of the data
source that the service needs to access.
5. For each securitySettings element, change the username and password values to reflect
the service account credentials for each data source.

©
2011 Hyland Software, Inc.
432
OnBase 11.0.0 WorkView

Note: To conserve system resources, increasing the pollSettings interval value is

recommended. The default value is 120 (seconds). Change this value to the number of
seconds you consider an acceptable delay for sending notifications. For example, if five
minutes is an acceptable delay, change the value to 300 (5 mins. x 60 secs/min.).

6. Save the file.

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

Sending Notifications to Global Distribution Lists

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

Displaying the User Who Triggered the Notification as the Sender

The defaultSender setting in the Distribution Service’s configuration file controls the name
or address displayed as the sender of automated notifications. You can configure the
Distribution Service to display the e-mail address of the user who triggered the notifications
by setting defaultSender to USER.

Note: USER must be entered in all uppercase characters.

Users who trigger notifications must have valid 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.
E
The defaultSender setting can be overridden by modules like Workflow and WorkView,
which allow you to configure the sender address for notifications.

Supporting Non-ASCII Characters in Attachment File Names

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

©
2011 Hyland Software, Inc.
433
 WorkView OnBase 11.0.0

The following values are supported:

• QuotedPrintable—Offers full compatibility with Microsoft Outlook.
• RFC2231—Latest standard, not supported by Outlook.
• Raw8Bit—Displays 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.

Configuring the Distribution Service to Save Notifications as Text Files

In some instances, you might want to output e-mail notifications to text files to be processed
by a third-party mail application. When this method for distributing notifications is necessary,
complete the following steps:

1. Create a directory to store the text files. This directory should be accessible locally, in a
mapped drive or through an UNC path to a shared directory. The path name must be
fully qualified. It must start with \\Name, where Name is the name of the machine name,
or X:\, where X is any drive letter.
2. Modify the Hyland.Core.Distribution.NTService.exe.config file for the Distribution
Service so that the smtpServer entry specifies this directory name. One file per
notification will be written to the target directory specified.

Sending Unity Forms

E If you plan to send Unity Forms using the Distribution Service, please see Unity Forms
Limitations on page 439.

TROUBLESHOOTING
The following troubleshooting information may help you diagnose and resolve issues with the
Hyland Distribution Service.

Logging Information to the Diagnostics Console

You can use the Diagnostics Console to troubleshoot Distribution Service issues. Diagnostics
information is logged under the Timer / Distribution Service tab in the Diagnostic Console.

©
2011 Hyland Software, Inc.
434
OnBase 11.0.0 WorkView

If Distribution Service information should be logged to the Diagnostics Console, logging

must be enabled in Hyland.Core.Distribution.NTService.exe.config. To enable logging, set the
enableMailSlot attribute for the timer-profile log to true.

Note: In previous versions of OnBase, the path and enableFile configuration settings were
used to log events to a file. The preferred method of logging events to a file is using service
logs created by the Diagnostics Service. For more information, see the Diagnostics Service
reference guide or the Diagnostics Console help files.

Under Hyland.Core.Distribution, modify the verbose level to control the amount of

information that is logged. In the threadSettings element, set the verboseLevel attribute to
the appropriate value, as described below:
• 0 - Logs service start, stop, and error messages to the Error Viewer log.
• 1 - Logs notifications sent by the service to the Timer/Distribution Service log.
• 2 - Logs all trace messages that are sent to the Error Viewer log.
When the verboseLevel is set to 2, each of the steps in connecting to and sending an 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.

©
2011 Hyland Software, Inc.
435
 WorkView OnBase 11.0.0

Access to the path...is denied

If you try to manually install or uninstall the Hyland Distribution Service on a server with
Windows User Account Control (UAC) enabled, an “Access denied” message may be
displayed.

To address this issue, run the Command Prompt as an Administrator. Under Start |
Accessories,right-click on Command Prompt and select Run as administrator.
For more information about how the User Account Control can affect OnBase deployments,
see Windows User Account Control Statement on page 440.

Error Loading Document: Attachments Are Not Sent

When the Hyland Distribution Service sends e-mails with attachments, the body of the e-
mails may say the following:
• ERROR LOADING DOCUMENT: Document Number: [#]
This error may occur because the account running the Hyland Distribution Service lacks
E privileges to the document on the OnBase disk group.
To resolve this issue, perform the following steps on the server where the Hyland
Distribution Service is installed.

1. Using a Run dialog box, run services.msc.

To do this, select Start | Run, type services.msc and click OK. The Services console is
displayed.
2. Double-click Hyland Distribution Service from the list of services.
3. Click the Log On tab.
4. Under Log on as, select This account.

©
2011 Hyland Software, Inc.
436
OnBase 11.0.0 WorkView

5. Type a valid domain user name and password that has access to the OnBase disk groups.
This user account will be used to run the service.
6. Click OK to save your changes and close the properties dialog box.
7. Restart the Hyland Distribution Service.

Messages Are Not Sent

Messages may not be sent for multiple reasons. The following are general steps to
troubleshoot the issue. Steps to address specific issues are provided in the following topics.

1. Ensure the Hyland.Core.Distribution.NTService.exe.config file is configured correctly.

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

Workstation Registration Not Found

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

"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.

©
2011 Hyland Software, Inc.
437
 WorkView OnBase 11.0.0

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.

Message Content and Attachments Are Reversed

Some e-mail clients do not properly handle content types for attachments with certain file
formats. As a result, documents with these file formats are sent as the message text instead of
as attachments, and the actual message text is sent as the attachment. If users receive e-mails
where the message and the attachment are reversed, you may need to configure the
Distribution Service to override the content type for those attachments’ file formats.

Note: E-Forms are one example of documents with a file format that may be handled
incorrectly. By default, the Distribution Service’s 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 file’s default location is
C:\Program Files\Hyland\Services\Distribution.
• In a 64-bit environment, this file’s default location is
C:\Program Files (x86)\Hyland\Services\Distribution.
2. Locate the following element:
<securitySettings datasource="DMS" username="SVCACCT"
password="PASSWORD" >
E

©
2011 Hyland Software, Inc.
438
OnBase 11.0.0 WorkView

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" >
<ContentTypeOverride fileType="24" mimeType="application/
octet-stream" />
</securitySettings>
The above example will override the default behavior for E-Form attachments and label
them with the generic MIME type “application/octet-stream.” As long as the attachment
name still 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 attachment’s file format number, as shown in the upper-

right corner of the File Format Configuration dialog box.
For E-Forms, this number is 24. You can specify different file
format numbers to override the content type assigned to other
file formats.

mimeType The generic MIME type to label attachments that have the
specified file format.

Unity Forms Limitations

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

©
2011 Hyland Software, Inc.
439
 WorkView OnBase 11.0.0

Windows User Account Control Statement

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

©
2011 Hyland Software, Inc.
440
 CONFIGURING THE HYLAND TIMER
SERVICE

The Hyland Timer Service manages timers. In order to manage timers you must complete
the following tasks:
• Configure timers in the appropriate module.
• Ensure that the Hyland.Core.Timers.NTService.Exe.config specifies the
appropriate Datasource, Username, and Password values.

Note: The user specified must be a user configured as a Service Account. See User
Names & Password topic in the Configuration documentation for more information.

• Ensure that the Hyland Timer Service has been started.

Additionally, timers linked to notifications will need the Hyland Distribution Service to
be installed and running.

INSTALLATION

Note: If Windows User Account Control (UAC) is enabled, setting TimerConfig.exe as

Run as Administrator can alleviate issues with failure to launch the Timer Service. For
details on UAC, refer to your Microsoft support information or see http://
technet.microsoft.com/en-us/library/cc709691(WS.10).aspx.

Requirements
The Timer Service workstation requires the Microsoft® .NET Framework 4.0 Full
F
Profile to be installed.

Installing the Timer Service Using an Installer

The Timer Service can be installed using the Hyland Server Side Components Installer.
For more information about this method of installation, see the Core Enterprise
Installers documentation.

©
2011 Hyland Software, Inc.
441
 WorkView OnBase 11.0.0

Installing the Timer Service Manually

1. Copy the NTServices folder and paste it to a logical location on the server (for example,
C:\Program Files\Hyland\Services)
2. From the command prompt, run \Timers\Hyland.Core.Timers.NTService.exe /i from the
directory where the executable resides. The directory would be the following in a typical
installation: C:\Program Files\Hyland\Services\Timers
3. Open the NTServices folder (that you added in step 1) and open the Timers directory.
4. With a text editor, open the Hyland.Core.Timers.NTService.Exe.config file.
5. In the <Hyland.Core.Timers> section, configure the values for the following
securitySettings:
• Datasource - this is the ODBC name for the Web Server.
• username - this must be a user that has rights to all documents that could be e-mailed
in a system notification. This also requires that the Service Account check box be
checked.
• password - the password for the username. This must be a Service Account

Note: Ensure that you remove the brackets from the values you are adding, but keep the
quotation marks.
For example, password="PASSWORD", not password="[PASSWORD]"

6. Open Services in Administrative Tools in the Windows Control Panel, and double-click
the Hyland Timer Service.
7. Click the Log On tab.
8. Enter the correct Log in information for the user account that will be used to run the
F Timer Service. Click OK.
9. Start the service.

Encrypting User Names and Passwords

By default, the Service Account’s user name and password are entered in
Hyland.Core.Timers.NTService.exe.config in clear text. Although these credentials cannot be
used to log on to any OnBase client application, it is considered a security best practice to
encrypt them in the Windows registry using the aspnet_setreg utility. The Timer Service can
then be configured to refer to the encrypted registry keys to retrieve the Service Account’s
user name and password.

©
2011 Hyland Software, Inc.
442
OnBase 11.0.0 WorkView

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/
To encrypt the user name and password:

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\TimerService\Identity -u:"username" -
p:"password"
3. Open a Run dialog box and enter regedt32.
4. Grant the Windows account that will run the Timer Service Read permissions to the
HKLM:SOFTWARE\Hyland\TimerService\Identity\ASPNET_SETREG registry key.

In 64-bit environments, grant the Windows account Read permissions to the following
key:
HKLM:SOFTWARE\Wow6432Node\Hyland\TimerService\Identity\ASPNET_SETREG.
The aspnet_setreg utility automatically stores the encrypted credentials in this key when
run in a 64-bit environment.
5. Open the Hyland.Core.Timers.NTService.exe.config file. This file’s default location is
C:\Program Files\Hyland\Services\Timers.

6. Modify the <Datasources> element to retrieve the encrypted credentials from the
registry. F
7. Replace the UserName value with the following:
“registry:HKLM\SOFTWARE\Hyland\TimerService\Identity\ASPNET_SETREG,userName
”
8. Replace the Password value with the following:
“registry:HKLM\SOFTWARE\Hyland\TimerService\Identity\ASPNET_SETREG,password
”
9. Save the configuration file.
10. Restart the Hyland TImer Service using the Windows Services console.

©
2011 Hyland Software, Inc.
443
 WorkView OnBase 11.0.0

CONFIGURING LOGGING SETTINGS

To enable logging to a log file, in the <Logs> section of the
Hyland.Core.Timers.NTService.exe.config file set EnableFile=“true” for the timer-profile log
element. Ensure enableMailSlot is also set to true. If only enableMailSlot is set to true, then
Timer Service events are written only to the Diagnostics Console, if it is running.
Using logging will log what timers executed and when they executing. Logging also records
how long a timer took to execute.
Logs will be written to c:\windows\system32\LogFiles\Hyland\timer-profile.

©
2011 Hyland Software, Inc.
444
OnBase 11.0.0 WorkView

ONBASE TIMER CONSOLE

You must also register the server from which timers will be run and assign the appropriate
timers to the server. These tasks are accomplished in the OnBase Timer Console. To access the
OnBase Timer Console, double-click on TimerConfig.exe file. In a typical installation, this file
will be in the following directory: C:\Program Files\Hyland\Services\Timers\TimerCfg.
The console will open.

Note: When timers are added or modified, the Hyland Timer Service must be restarted.

©
2011 Hyland Software, Inc.
445
 WorkView OnBase 11.0.0

Registering a Server
In order for the Timer Console to recognize a server, the server must be registered. To
register a server:

1. In the left pane, right click and select Add Server Registration... The Server Registration
dialog box is displayed.

2. Enter the server’s computer name in the Server Address field.

3. Enter an appropriate Port Number.

©
2011 Hyland Software, Inc.
446
OnBase 11.0.0 WorkView

4. Enter a descriptive name to be used for display in the console in the Name field.
5. Click Save. The registered server will display. Under the server the datasource currently
associated with the server is displayed.

©
2011 Hyland Software, Inc.
447
 WorkView OnBase 11.0.0

Managing Timers
In order for timers to be kicked off by the Hyland Timer Service, they must be assigned to the
service. To assign timers to the service:

1. Select the datasource under the server name.

2. Right-click on the datasource and select Manage Timers. The Assign Timers dialog box is
displayed. The timers will be displayed within the dialog box. The module to which the
timers are associated will be displayed in parentheses next the timer name.

3. Select the timer(s) you want to assign to the service and click Add>>.

©
2011 Hyland Software, Inc.
448
OnBase 11.0.0 WorkView

4. Click Save. The timers assigned will now be displayed under the datasource.
5. Restart the Hyland Timer Service.

Note: After closing the console and re-opening, the assigned timer will be displayed under the
node labeled with the name of the module to which they belong.

Refreshing Connections
To refresh the Timer Console’s tree, select File | Refresh connections(s). The tree will
refresh. This can be helpful if your server is not currently running the Hyland Timer Service.
When you start the service, you can refresh the tree to show the server’s datasources.

Timer Properties
When you select a timer within the tree, the timer’s properties are displayed, in tabular form,
in the right pane. The Status tab provides information about the timer’s execution within the
Hyland Timer Service. Clicking Reset will reset the Performance Statistics fields.
The Settings tab displays the configuration of the selected timer.
The Windows tab displays the windows that are configured for the timer. You can select a
window within the Timer Windows box to configure each window.

Viewing Information in the Diagnostic Console

Information is logged in the Timer / Distribution Service tab in the Diagnostic Console
concerning the Hyland Timer Service based on your configuration settings for logging for the
Distribution Service.

STARTING THE SERVICE F

To start the Hyland Timer Service:

1. Select Start | Control Panel.

2. Double-click on Administrative Tools.
3. Double-click on Services.
4. Right-click on the Hyland Timer Services and select Start.

©
2011 Hyland Software, Inc.
449
 WorkView OnBase 11.0.0

UNINSTALLING
To manually uninstall the Hyland Timer Service, from the command prompt, run
\Timers\Hyland.Core.Timers.NTService.exe /u from the directory where the executable
resides. In a typical installation, the directory would be: C:\Program
Files\Hyland\NTServices\Timers.

©
2011 Hyland Software, Inc.
450
 SCRIPT EXAMPLES

FILTER SCRIPT EXAMPLE

The following is an example of a script that is used in a filter for the displayMessage
attribute.

Example
dim ctr
ctr=1

Function rm_Filter1026(rmViewData)

if ctr <> 10 then

rm_Filter1026 = "ID: " & rmViewData.ID & " (" & ctr & ")"
end if
ctr = ctr +1

End Function

FILL FOLDER SCRIPT EXAMPLE

The following script is an example of a script that would be used in conjunction with the
Fill folder via script Dynamic Folders option.
G
Example
Function rm_FillDocumentFolder
if rmFolder.FolderName = "Script-based Folder" then
Dim DocumentQuery
Set DocumentQuery = rmSession.CreateQuery()
DocumentQuery.AddDocumentTypeByID (762)

©
2011 Hyland Software, Inc.
451
 WorkView OnBase 11.0.0

Dim queryResults
Set queryResults = DocumentQuery.Execute()
Dim Document
If Not (queryResults is Nothing) Then
Set Document = queryResults.GetNextDocument
Do While Not (Document is Nothing)
rmDocumentCollection.AddDocument(Document)
Set Document = queryResults.GetNextDocument
Loop
End If
Dim DocumentQuery2
Set DocumentQuery2 = rmSession.CreateQuery()
DocumentQuery2.AddDocumentTypeByID (776)
Set queryResults = DocumentQuery2.Execute()
If Not (queryResults is Nothing) Then
Set Document = queryResults.GetNextDocument
Do While Not (Document is Nothing)
rmDocumentCollection.AddDocument(Document)
Set Document = queryResults.GetNextDocument
Loop
End If
end if
G rm_FillDocumentFolder = 0
End Function

©
2011 Hyland Software, Inc.
452
 SYSTEM ATTRIBUTES

System attributes are available automatically in the following tabs: View Attributes, User
Entry Constraints, Fixed Constraints, and Sorting. The following system attributes are
available.

System Attributes

System Attribute Description

objectID This is the object number within WorkView.

objectName This is the class title.

objectInstanceID Reserved for future functionality.

createdBy User who first created object.

createdDate Date when object was first created.

revisionID Reserved for future functionality.

revisionDate Date change was made to object.

revisionBy User who made change to object.

className Class to which the object belongs.

displayMessage Class script coded to create string returned in a filter. The attribute
is only available for the top level object.

Note:The displayMessage column will only be displayed if the

associated Class has an rm_Filterxxxx script hook. H

©
2011 Hyland Software, Inc.
453
 WorkView OnBase 11.0.0

©
2011 Hyland Software, Inc.
454
 MACROS

The following macros can be used for values in keytype mapping and default values.

Macro Description

%D This is today's date (or current system date).

The following are examples of how this macro
can be used in equations:
%D[+14] is today + 14 days.
%D[-30] is today less 30 days.
%D[+395:%m-01-%y] is today, plus 395
days. The date is formatted to the first of the
calculated month. The format pattern forces the
day to 01, but uses the date's actual month and
year. 4 digit year is used.

%DT This is today's date (or current system date). or

current date/time (depending on data type of
variable).

Note:Time is stored as 00:00:00.

%DF This is the first day of the current month.

Note:Time is stored as 00:00:00.

%DL This is the last day of the current month. An

example of how this macro can be used in a
equation is the following:
I
%DL[+1] sets the value to the first of next
month.

Note:Time is stored as 00:00:00.

©
2011 Hyland Software, Inc.
455
 WorkView OnBase 11.0.0

Macro Description

%DB This is the last business day of the current

month.

Note:Time is stored as 00:00:00.

%R This is the real name of the logged in user.

%S[SeqName] This is the next value from the sequence

specified in the brackets. Some examples of
how this macro can be used are the following:
%S[SeqName:%X] formats the value in
HEX (char type field required).
%S[SeqName:C-%ld-AA] formats the value
to include static characters. %ld is
representative of where the next sequence
value will appear in the value. For example, if
the next sequence value is 1001, the value will
be C-1001-AA.

%U This is the user name of the logged in user.

©
2011 Hyland Software, Inc.
456
 LICENSING FOR CUSTOMERS
PREVIOUS TO 2007

The licenses listed in this section are relevant to customers who purchased WorkView
software before January 1, 2007.

WorkView Licensing
WorkView requires the following:
• A WorkView Server license
• A Web Server license
• A Client module license
• Either a WorkView Concurrent Client license, a WorkView Workstation Client
license (only applicable to OnBase Client), or a WorkView Named Client license

Combined Workflow/WorkView Licensing

If you are running both Workflow and WorkView, combined licenses can grant access to
both of the modules.
• Workflow/WorkView Concurrent Client
• Workflow/WorkView Workstation Client (only applicable to OnBase Client)
• Workflow/WorkView Named User Client

How Combined Licensing Works

Combined licenses are only consumed by users that have been assigned to use combined
licenses in the User Settings dialog box. When a user is assigned to use combined
licenses, he or she will not be able to use a license for Workflow or WorkView that is not
J
combined. If non-combined licenses are available for consumption, access to the
modules are not granted until a combined license becomes available.
If a user that is assigned to use a combined license who is working on a workstation
registered for the use of one of the two products licensed by the combined license, only
the product registered will be available for use.

©
2011 Hyland Software, Inc.
457
 WorkView OnBase 11.0.0

If a user is not assigned to use combined licenses, the user will only be able to consume non-
combined licenses and will not consume combined licenses even when non-combined
licenses are not available.
To access the User Settings dialog box and configure a user for combined licensing:

1. From the Configuration module, select Users | User Names/Passwords.

2. Select the User Name and click Settings.
3. Select the Combined Workflow / WorkView License check box.
4. Click Save.
Once a combined license has been consumed, the license is not released until the Client is
restarted. If a combined license is revoked, it will still be consumed until the Client is
restarted. If the license is switched from a combined concurrent license to a concurrent
license for one of the products, it will still consume the combined concurrent until the Client
is restarted.

©
2011 Hyland Software, Inc.
458
 SOX APPENDIX

ARCHIVING THE PREVIOUS YEAR ’S APPLICATION AND

CREATING THE NEXT YEAR ’S WORKING COPY

Caution: Before beginning, back up the database, disk groups, and WorkView data.

Before you begin, it is recommended to purge inactive objects. To purge inactive objects:

1. Select Settings | Purge | Inactive/deleted objects. The Purge Inactive/Deleted Objects

dialog box is displayed.
2. Select the Inactive check box.
3. If you want to create a log file, specify a path where the log file should be stored in the Create
Log File field.

4. Click OK.
5. Click Yes to proceed.
6. When the purge is complete, click OK.

In addition, it is recommended that all calendars, actions, and datasets be specific to the
application that is being cloned. To ensure that a resource is application specific ensure that the
Allow other applications to use this <<resource>> check box is not selected for the specific
resource.
Creating an application for next year’s data involves three main components:
• Clone last year’s application. Cloning an application creates an exact copy of that
application.
K
• Make the application read-only. Making an application read-only does not allow changes
to the application.
• Purge the data from classes in the newly created application. Purging data from the new
application’s classes prepares the application for new data entry relevant to the new year.

©
2011 Hyland Software, Inc.
459
 WorkView OnBase 11.0.0

In order to create a new application for the next year, follow these steps.

1. Select the application you want to clone in the left pane, right-click, and select Clone application/
data. The Clone application and data dialog box is displayed.

2. Enter the name of the new application.

Note: The cloning function can take quite a bit of time.

3. Click OK. The new application is displayed in the left pane.

Caution: Rights granted to the views in the original application are also copied to the views in the
newly created application.

4. Right-click on last year’s application in the left pane and select Make read-only.
5. Click Yes to confirm.
6. Expand the application you have just created through cloning in the left pane.
K 7. Select Classes in the left pane.
8. If appropriate for a class, in the right-pane, right-click on the class and select Delete data only or
in the left pane, right-click on a class and select Delete data only.

Caution: All data will be deleted from the class. Use caution when deleting class data. If a class is
related to another class based on relationship attributes, needed data may be lost inadvertently.

Click Yes to confirm the data deletion.

Click Yes again to confirm.
9. Repeat steps 8-10 for each class within the application.

©
2011 Hyland Software, Inc.
460
OnBase 11.0.0 WorkView

10. After the cloning process is complete, any scripts that use ID numbers will need to be updated to
reflect the newly cloned application’s ID numbers. The ID numbers for the application, classes,
filters, attributes, etc. for the newly cloned application all have new ID numbers. A CloneData.log
file is created during the cloning process in the C:\ directory of the server. This file provides
information concerning the mapping of the old ID numbers in the originating application to the
new ID numbers of the new cloned application.
11. Lastly, security attributes, global timers, and global notifications are not cloned with the
application. These items need to be reconfigured.

©
2011 Hyland Software, Inc.
461
 WorkView OnBase 11.0.0

©
2011 Hyland Software, Inc.
462
 WORKVIEW BEST PRACTICES

L
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 organization’s 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
WorkView solutions. Best practices have been divided into the following categories:
• General Design
• General Performance
• Scripting

GENERAL DESIGN
• Always design the WorkView process before configuring the solution. Design the
application including classes, attributes, view layouts, etc on paper/whiteboard to
get an overview of what the solution will look like and how it best solves the
business problem.
• Test all changes. Creating and maintaining a test environment is important to
fully test changes before implementing them in a production system. Once
changes are created in a production system, another test should be performed in
the production system.
• Use good naming conventions for Filters. It is best to create a naming convention
for filters in your application. Filter names should be prefixed with the class name
to allow for easy identification.
• Add description to all items when possible. Adding description to configuration
items allows for easy troubleshooting and maintenance. These items include
actions, notifications, filter bars, filters, and views.

©
2011 Hyland Software, Inc.
463
 WorkView OnBase 11.0.0

• Configure intuitive Attribute Display Names. When creating attributes, the attribute’s
name is also copied to the “Display name” field. The value in the “Display name”
field should be configured to make sense to users. For example, if attribute name is
“TotalAmountDue” the Display name will also reflect this value when you tab out of
L the attribute name field. A more user friendly text should be entered in to the display
name field. For example, “Total Amount Due” or “Total Due”. In addition, please
note that the attribute’s display name is also added as Filter Column Heading text.
• Configure default values when configuring Attributes. Whenever possible, default
values should be configured for attributes. This makes data entry easier for users as
they do not have to enter those values. For example, you may want to create default
values for items like “Date Created” using the current date or date & time.
• Configure datasets when possible for set values. Depending on your business needs,
it may be necessary to configure datasets for attributes where possible. Datasets can
ensure that users enter the correct values in fields and allows for consistency.
• Create multiple views when there are many items to be added to a View. If there are
many items to be added to a view, it is sometimes best to create multiple views. This
will prevent users from having to scroll down a long view with several attributes,
embedded filters, folders, etc.
• Use the Copy View functionality when configuring several Views for the same Class.
Some WorkView solutions require that you create multiple Views for users based on
roles. For example, “Employee Info” View created for all Employees with limited
View items and “Employee Info - Mgr” View created for Managers that contain salary
information, disciplinary comments and dates, etc. Using the copy functionality not
only allows for consistency across Views but also makes it easier and faster to create
them.
• Configure View names with Keyboard shortcuts. When creating views, add keyboard
shortcuts to the view names to allow for easy navigation.
• Assign Screen Actions to relevant Views. If there are several views created for a screen
and several screen actions are available, it may be necessary to assign actions to
specific views. For example, you may want to assign the “Display Task Report” action
to the “Tasks” view instead of the default view.
• Add elements in a table when possible. When creating a view, add items such as
labels, attribute fields, etc in tables to ensure that they are aligned properly.
• Add Help Text to field properties. When creating a view, add help text to items on the
view. This allows users to know what a particular field is for and any other
information you may wish to display.

©
2011 Hyland Software, Inc.
464
OnBase 11.0.0 WorkView

• Disable lookup buttons for items you do not want users to change. If you do not want
users to change values in certain fields such as Date, DateTime, Dataset or
relationship with lookup, disable the lookup buttons in addition to making the field
read-only. Note that users can change values for fields marked as read-only if the
fields have lookup buttons. L
• Set fields that users should never change to read-only. This ensures that users will
not able to change those fields or values that are set automatically by WorkView or by
the Administrator.
• Configure CSS blocks with descriptive names. When configuring CSS blocks in
WorkView, make sure the name of the field is descriptive.
• Ensure users have rights to view images added using CSS. When you add company
logo, background images, etc to a view using CSS ensure that all users have access to
the file through UNC or URL.
• Denote required fields with red asterisk. Depending on your environment and
business case, you may need to add a label next to fields that are marked as required.
This allows users to see which fields must be entered at a glance, otherwise they will
be prompted to supply values for the fields when they attempt to save the object or
navigate to a different view. The red asterisk can be achieved by creating a block in
CSS editor.
• Do not change Attribute name value in the Designer. You may change display name
of attributes on a view but do not change the actual name of the attribute. It is
considered best practice if this value is the same as the attribute’s name found in the
attribute configuration window. This also allows administrators to easily identify
attributes when troubleshooting or performing view maintenance, etc.
• Use Line Break and Separator to arrange and group like items together. When
configuring a view, it may be necessary to group items together using line breaks and
separators. For example, you may wish to add all customer information fields at the
top of a view, then a separator between that and issue information fields.
• Group Filter Bar Items by Filter Bar. Similar items should be grouped together in one
filter bar rather than grouping all items or unrelated items in one filter bar.

©
2011 Hyland Software, Inc.
465
 WorkView OnBase 11.0.0

• Configure Subfilters when possible or when users will need to see dependent
Objects. When users need to see dependent items attached to a parent object, it is
recommended that subfilters be configured for the parent filter. This allows users to
see any related/child items without necessarily having to open the parent object to
L look for items in an embedded filter. For example, if users will need to view “Notes”
objects associated with a particular “Issue”, they may first open the “Issue” object
then look at the items in the embedded “Notes” filter. By configuring a subfilter for
“Notes”, the users do not have to open the parent “Issue” object – they can just
execute the subfilter for “Notes” from the filter result window and see a list of items
attached to the current “Issue” object.
• Use the Copy Filter functionality when configuring several Filters for the same Class.
Some WorkView solutions require that you create multiple filters for the same class.
Sometimes these filters have the same view attributes. By creating a “template” filter
and copying that for new filters, you will save time configuring filters and also have a
consistent view attributes setting.
• Use Attributes that are unlikely to change when configuring a Filter Document Type
Association. When configuring a filter Document Type Association that displays
WorkView objects that have an OnBase document attached, it is a best practice to use
an attribute that is unlikely to change when configuring the keytype map. For example,
if configuring Keytype map for an Employee Filter Document Type Association, it’s
best to use “EmployeeID” or “SSN” attribute as a map attribute instead of
“Department” or “LastName” which are likely to change.
• Use Datasets when configuring User Entry Constraint Filter if available. For a better
user experience enable Datasets when configuring User Entry Constraint Filter for
attributes that have Datasets.
• Configure Default Filter for Applications. If a filter will need to be accessed frequently
by all users within an application, the filter can be configured as the Default Filter.
This will be displayed by default when users access the application.
• Use the “Add existing class” feature if a class already exists in another application. If
you have several applications in your WorkView database that will have a common
class in them, use the “Add existing class” feature to share the class across the
applications. You may also need to create a “Shared Application” that will house all
shared classes. For example, you have several applications that will have the
“Employee”, “Customers” classes. You can share these classes across multiple
applications allowing you to only maintain information in one place.
• Configure class Display Name with singular noun. When a class is created, the class
name is copied into the Display Name field by default. If the class name is
“Employees”, the display name will also be displayed as “Employees”. This should be
changed to a singular noun “Employee”.

©
2011 Hyland Software, Inc.
466
OnBase 11.0.0 WorkView

• Configure Class Titles for all Classes. Class titles are displayed in Internet Explorer’s
title bar and on the computer’s task bar. Class titles should be configured preferably
with an attribute value from the object. This allows users to easily locate items when
multiple windows are open. For example, if 5 employee objects from the
“Employees” class are open, a user will have to look at possibly all 5 windows to L
locate the correct employee. By configuring the class title with a value of
“EmployeeName”, it will be much easier to find item for “John Smith” among 5 open
windows. In addition, class titles are used as object names which are displayed in
WorkView calendars, favorites, recently viewed items, Collaboration Workspace, etc.
• Backup the database before using the “Purge” feature. Before purging history data
and inactive/deleted objects, it is highly recommended that you backup your
WorkView database. Please note that once items are purged they cannot be recovered.
• Backup database/Class data before deleting Class data. Before using the Delete Class
Data feature in WorkView Configuration, be sure to backup the database and class
data for the class you are performing the action on. Please note that this operation
cannot be undone.
• Use UNC paths for WorkView System Paths. It is highly recommended that system
paths (Style Sheet, Resource, and Backup) for WorkView be configured using UNC
paths.
• Do not point WorkView system paths to a path that has existing files. When
configuring WorkView system paths, do not point the paths to a location that already
has existing files for example, style sheets, templates, etc. Doing so can cause
undesired results.
• Copy and reconfigure WorkView system path when database snapshot is taken. In
some environments, it is a common practice to copy the production database and
make it a clone/test/development database. The WorkView system path should also
be copied. After this is done, the WorkView system path in the clone database should
be changed to point to the clone/test path. Note that you must not point system path
from multiple WorkView databases to the same path. Doing so may lead to undesired
results.
• Share Actions and other items when possible. Depending on your business needs and
number of applications available in your database, you may need to share items such
as actions, catasets, etc so they can be used by several applications.
• Use drop-down list to display actions. If a Screen has a long list of actions or if screen
real estate is a concern, enabling the Use drop-down to list Screen Actions option is
highly recommended.

©
2011 Hyland Software, Inc.
467
 WorkView OnBase 11.0.0

• Use descriptive names for shared items. When creating shared items like datasets,
actions, notifications, timers, keytype maps, sequences and calendars, use descriptive
names whenever possible. For example a calendar configured for the “Help Desk”
application could be called “Help Desk Calendar” instead of just “Calendar”. Note
L that when importing an application and you choose to use existing shared items, if an
existing item for example, calendar, has the same name as another item being
imported, the new application will use the existing item. Using a descriptive name for
shared items will minimize the chances of this occurring.
• Edit Template resources in Notepad. When editing resources for templates, the edit
should be done in Notepad or any text editor that will not add additional formatting.
Microsoft Word®, for example, adds additional text/formatting that can cause the
template to not be displayed correctly.
• Configure Default Document Type for Classes. When users will need to attach
documents to a class, it is highly recommended that you configure Default Document
Types for the class. This adds a “WorkView Defaults” Document Type Group and
lists the Default Document Types for users when doing an import. If this is not
configured, (depending on rights) users may have to scroll through a long list of
Document Types.
• Enable the “Display Static document count on Documents tab” option. In situations
where users need to act on objects based on whether or not a document is attached, it
is recommended that the Display Static document count on Documents tab is
selected. This reduces the number of mouse clicks it takes for users to see if a
document is attached to an object. Also, if Dynamic Folders are configured for the
class, a query is done when the user clicks the Documents tab. By enabling the Static
Document count display, unnecessary queries will not be made to the database when
users only need to see the static documents.
• Enable the “Use objectname instead of objected for relationship attributes” option.
This option controls how items are displayed in the History tab for relationship
attributes. If the option is not enabled, ObjectID will be displayed in the History tab
when a relationship attribute value is changed to a different object.
• Verify user rights to configured items. When finished with configuring a WorkView
solution, verify rights using the Master Security feature. Also, login as a test user
belonging to different User Groups to ensure it functions as expected for that user or
user group.
• Add the WorkView server URL as a Trusted Site. Client machines that will access
WorkView should add the server URL as a Trusted Site.

©
2011 Hyland Software, Inc.
468
OnBase 11.0.0 WorkView

• Import a few items to ensure items are imported correctly. When importing several
objects using the Import Class Data feature it is best practice to import a handful of
objects and verify that values are imported and mapped correctly.
• Test all items after performing an Import/Clone/Copy. It is recommended that
administrators test their solution after importing, cloning, or copying a WorkView
L
application to ensure it functions as expected.

GENERAL PERFORMANCE
• History changes should not be tracked unless necessary. When configuring an
attribute, the Track changes checkbox should be unchecked if there’s no business
need for seeing changes to that attribute. This is especially true of Text, Formatted
Text, and Alphanumeric attributes greater than 255 characters.
• When configuring a Dynamic Folder, use the Document Type Query option. When
creating a Dynamic Folder, use the Document Type Query option when possible. This
limits document search to the specified Document Type(s) rather than every single
Document Type that a keyword is associated with.
• Considerations should be given to server performance when setting WVMaxResults
key in web.config. When configuring the WVMaxResults key in the OnBase Web
Server’s web.config, care should be taken not to set this to a very high value. Setting
this to a very high value may cause users to experience slow response times when
executing filters.
• Configure lookup Filters with User Entry Constraints. If a lookup filter on a
relationship attribute is likely to return a very long list of results, it is recommended
that you configure a User Entry Constraint so that users can search for specific items
instead of returning a long list of items.
• Purge inactive items after performing a “Test mode only” Class data import
operation. After performing a Test mode only import, although objects are not
activated (displayed on filters), they are created in the database and marked as inactive.
Use the Purge inactive/deleted items feature to purge inactive items from the
database. This will free up some space that is used by the inactive items created during
the test import.
• Allocate appropriate database space for attributes. When configuring attributes,
allocate the number of spaces that will fit the data users will enter. For example, if the
“ZipCode” only will have a maximum of 15 characters, do not allocate 100 characters
for the “ZipCode” field.

©
2011 Hyland Software, Inc.
469
 WorkView OnBase 11.0.0

SCRIPTING
• Avoid scripting. Always use existing functionality and contact Hyland Software if a
feature that requires scripting is reoccurring. Do not script what OnBase can already
L do. OnBase has a rich native functionality. Prior to writing a script, ensure that
existing functionality cannot already accomplish the task.
• Use names instead of IDs in scripts. When writing scripts, refer to items (attribute,
class, filter, application, action, etc) by name rather than ID. This ensures that the
same item is referenced if you export/import or clone the application.
• Add detail header comments to scripts. When writing application, class, or action
level scripts add application, class, and action name to the header of the script. Adding
this information in the script will make it easier to troubleshoot issues.
• Use the HasValue property to determine if a value is null. When performing a query in
the Unity API, use the HasValue property to check if value exists when getting
AttributeValue or FilterColumnValue. Doing this ensures that an exception is not
thrown and that expected results are returned.
• Specify action name when executing a rm_CheckIncludeScreenAction(rmAction)
script. The rm_CheckIncludeScreenAction(rmAction) script is executed for every
single action available on a screen. For example, if your screen has 10 actions and your
script is to change an attribute’s value the script will be executed 10 times – 10 entries
will also be added to the History tab for that attribute. To limit this, always specify a
particular action by Name before continuing with execution.
• Remove scripts from Applications, Classes, and Actions if not needed. If scripts are no
longer needed for an application, class, or action the script should be removed using
the Remove Script button located on the Script Editor window. Note that an empty
function will be executed whenever a new object is created for example:
Function rm_NewInstance
rm_NewInstance = ""
End Function

©
2011 Hyland Software, Inc.
470