WorkView Javascript Client Side API Documentation - OnBase/WorkView/Foundation-24.1/WorkView/WorkView-Javascript-Client-Side-API-Documentation - 2025-10-15
WorkView
Platform
OnBase
Product
WorkView
Release
Foundation 24.1
License
Premier
ft:locale
en-US
Documentation Notice
Overview
Understanding WorkView
How It Works
Applications
Licensing
Simplified Licensing
WorkView Privilege
Installation
Overview
General Requirements
Operating System Requirements
Web Browser Requirements
Additional Requirements and Limitations
WorkView Designer
Firefox Limitations
All Supported Browser Limitations
Server and Core Services Hardware Requirements
Screen Resolution
Database Requirements
Databases Supported
Microsoft SQL Server
Oracle
Database/File Servers
jQuery
Load Balancing
Exceptions
Licensing
Pre-Installation
Installation
Installing the Full-Text Service
Understanding Connection Strings
Name
ConnectionString
SQL Server Connection String Tokens
Oracle Connection String Tokens
ProviderName
Connection String Examples
SQL Server Examples
Oracle Examples
Controlling the Installer from the Command Line
Silent Installation Using setup.exe
Feature and Property Names
Feature Names
Property Names
Installation Locations
Configuration Options
DATASOURCE
DB_SERVICE_USER
DB_SERVICE_PASS
NTSERVICE_USE_DOMAIN_ACCOUNT
NTSERVICE_USER
NTSERVICE_PASS
Compressing Indexing
Consideration for HTTPS Binding
Upgrade Considerations
WorkView Upgrade Considerations
Upgrading from OnBase Version 13
Upgrading from an OnBase Version Previous to Version 14
Upgrading to OnBase Version Foundation 24.1
Inability to Import Export Files Generated Prior to Version 16
Encrypted Attribute in Databases created Prior to Version 18
Limited Support for Document Composition
LOB Classes
System Attributes
Mobile Apps
On Demand Diagnostics (ODD)
Oracle Databases
Set Multiple Property Values from WorkView Action
Portfolio Relations
RP-2.0 Template Reports
Application Server
Application Server Web.config Settings
webServerBaseUrl
Troubleshooting
On Demand Diagnostics (ODD)
Configuring Message Sources
Viewing Troubleshooting Messages
Setting the Log to Refresh Automatically
Assigning Access for Users
Windows Event Viewer
Logging for the Context Search Framework
Large Views
Title Bar
Fixing WorkView Indexes
Width and Height of Labels
Width of Line Breaks, Separators, and Containers
External Connection Issues (Classes and Datasets)
Composite-Key Based External Classes
Errors Opening WorkView Items
Contacting Support
Installing Hyland ActiveX Controls
Hyland ActiveX Controls Installers Overview
Installer Options
Installer Prerequisites
Installer User Permissions
Windows User Account Control Statement
Hyland ActiveX Integration Controls
Running the Installer
Controlling Installation from the Command Line
Change, Repair, or Remove an Installation
Studio Installation
Requirements
General Requirements
Pre-Installation
Installation
Installer Options
Installing OnBase Studio
Connection Strings in Web.config
Name
ConnectionString
SQL Server Connection String Tokens
Oracle Connection String Tokens
ProviderName
Connection String Examples
SQL Server Examples
Oracle Examples
Change, Repair, or Remove an Installation
Running the Installer From the Command Line
Feature Names
Properties
Installing the 64-bit Studio
Post-Installation
Using the System Browser for IdP
Upgrade Considerations
Studio Upgrade Considerations
Troubleshooting
Editing the Configuration File
Enabling Diagnostics Console Logging
Trusted Certificates
Language Support
Database Timeout During Configuration Import
Contacting Support
Legacy Licensing Information
WorkView Legacy Licensing
Licensing
The Information Management Concurrent Client License
Combined Workflow/WorkView Licensing
How Combined Licensing Works
ObjectPop Licensing
FilterPop Licensing
Licensing for Customers previous to 2007
WorkView Licensing
Combined Workflow/WorkView Licensing
How Combined Licensing Works
WorkView Configuration
WorkView Configuration Overview
User Rights Within the Configuration Module
Launching OnBase Studio
Connecting to a Repository for WorkView
Refreshing Repositories
Expanding and Collapsing Items in the Repository Pane
Viewing Items in the Designer Pane
Using Repositories in OnBase Studio
Searching the Repositories Pane
Configuring System Properties
Configuring System Paths
Configuring System Defaults
Password Protecting Application Configuration
Unlocking an Application Configuration
Removing Passwords
General Ribbon Group
Application Configuration Overview
Creating Applications
Deleting Applications
Creating Calendars
Assigning a Calendar to an Application
Configuring a Default Filter
Configuring User-Defined Filters
Configuring Favorites and Recently Viewed
Configuring Application User Groups
Creating Classes
Configuring a Standard Class
Sharing Existing Classes
Deleting Classes
Deleting Data From a Class
Sequencing Classes
Configuring Class User Groups
Advanced Tab
Configuring Custom Headers
Rules Options
Understanding Association Classes, Advanced Associations, and Relationship Attributes
Creating Reverse Relationship Lookups
Creating Advanced Associations
Class Configuration
Attribute Configuration
Filter Configuration
View Configuration
Creating Association Classes
Creating the Class
Creating the Filter for an Association Class
Placing the Filter on a View in the View Designer For An Association Class
Creating Extension Classes
Transforming Existing Extended Class Object
Allowing Users to Extend Base Objects from an Action
Allowing Users to Create Objects Based on Extended Classes
Extension Options
Base Class Options
Extended Class Options
Creating External Classes
Configuring External Class Connections
Local or Linked Server Connection
ODBC Connection
Configuring a Linked Server
External Classes Populated with Unity Scripts
External Classes Populated Using a WCF Service
External Classes Populated Using the LOB Broker
Defining the Date Format for LOB Broker Class Results
Configuring Web Services
Modifying External Class Connection
Configuring an External Class for Modification or Viewing History
External Class Index Requirements
Index Attributes
Configuring the Auto Name and Screen Name for a Class
Configuring the Auto Name
Modifying Auto Names
Configuring the Screen Name
Auto Name and Screen Title Items
Improving Performance with External Classes
Designing Class Layout
Moving Classes
Creating Classes
Hiding Attributes
Copying the Diagram as an Image
Creating Attributes
Customizing the Attributes Tab
Default Values
Creating Calculated Attributes
Functions
Macros
Supported Operators
Creating Sequences
Configuring Data Sets
Entering Values for Data Sets
Editing Existing Data Set Values
Deleting Data Set Values
Parent Data Sets
External Data Sets
Configuring Filter Data Sets
Configuring Filter Data Sets for Multi Attribute Auto Complete
Indexing
Deleting Attributes
Editing Attribute Limitations
Sorting and Moving Attributes
Configuring Masking for Attributes
Configuring Masking
Mask Pattern Definitions
Creating Custom Mask Pattern Characters
Configuring Module Associations
Defining the Sequence of Module Associations
Editing User Group Access
Configuring External Class Attributes
Configuring Class Scripts
Configuring Filters and Filter Bars
Filters
Configuring Filters for Document Types
Display Columns Tab
User Prompts Tab
Fixed Constraints Tab
Sorting Tab
Previewing Filter Results
Advanced Tab
Configuring Filters for WCF Service Classes
Creating Filters for LOB Broker Classes
Editing an Existing Filter
Copying an Existing Filter
Filter Bars
Adding Filter Bar Items
Adding Filter Bar Items from a Filter Bar
Adding Filter Bar Items from a Filter
Editing Filter Bar Items
Understanding Sub Filters
Adding Multiple Levels of Sub Filters
Moving and Deleting Filters and Filter Bars
Deleting User-Defined Filter Bars
Configuring Constraint Sets
Creating Notifications
Using Filters in Notification Fields
Using Related Filters in Notification Fields
Using the Current User in Notification Fields
Using the Current Date/Time in Notification Fields
Creating the Body of the Message
Using HTML in Templates
Data Value Insertion Tags
Iterative Tags
Creating a Template to Display in Microsoft Excel
Object Status
Condition Test Options
Using ObjectPop in Notifications
Creating Objects Using ObjectPop
Using Unity Pop in Notifications
Deleting a Notification
Unity Viewer Subscription Notification Requirements
Configuring Views
Editing Views
Deleting Views
Saving Views With Associated Keyboard Shortcuts
Creating Views from Template
Checking for Vestigial Related Class IDs
Component Maintenance
Class Maintenance
Miscellaneous Maintenance
Filter Maintenance
Updating Views
Attribute Value Maintenance
Executing Maintenance Configurations
Functions
Macros
Supported Operators
WorkView Designer
Duplicating Views
Creating Actions
Using an Existing Action
Configuring Actions
Configuring a Modify Attribute Action Type
Configuring an Execute List of Other Actions Action Type
Configuring a Send Notification Action Type
Configuring Form Related Action Types
Configuring Extended Class Action Types
Configuring Display Template Actions
Using HTML in Templates
Data Value Insertion Tags
Iterative Tags
Creating a Template to Display in Microsoft Excel
Printing Using Display Templates
Configuring Execute Unity Scripts Actions
Deleting Actions
Configuring Email Links
Configuring Copy Hyperlink Button
Creating Objects Using a URL
Opening Object URLs
Object Creation URLs
Displaying Filter URLs
Creating Custom Screens
Defining Custom Screen Titles
Editing User Group Access to Screens
Class Mappings
Associating Document Types With Classes
Editing Document Type Associations
Deleting Document Type Associations
Creating Objects Using Cascading Document Type Associations
Associating Forms with Classes
Granting Appropriate Rights for Form Creation
Editing Form Associations
Deleting Form Associations
Configuring Folder Types
Changing the Default Folder Type Association
Editing Folder Type Associations
Deleting Form Associations
Setting the Default Document Types
Creating Keyword Type Maps
Using More Than and Lesser Than Operators in Keyword Type Maps
Configuring Dynamic Folders for Classes
Creating a Keyword-Only Query Folder
Creating a Document Type Query Folder
Creating a Folder Filled Via a Script
Configuring Related Objects to Create Automatically
Controlling Security
Configuring Security Attributes
Defining the Order of Security Attributes
Using Application-Defined Identity to Determine Rights
Specifying User Security Attributes Example
Using the Base Identity Object
Controlling Object Creation Based on Security Attributes
Configuring Related Attributes for ~Identity
Configure a Class Security Attribute
Configure a User Group Security Attribute
Renaming Security Attributes
Viewing Security Attribute Configurations
Removing Security Attributes
Exporting and Importing Data
Exporting Data from OnBase Studio
Exporting Application Data
Exporting Class Data
Importing XML Data
XML Import File Structure
Import Data from Different Locales
Import Process
Importing Data Using a Microsoft Excel File
Microsoft Excel Import File Structure
Import Process
Importing Data Using a CSV File
CSV Import File Structure
Import Process
Importing and Exporting Applications and Classes
Creating a Default Value for a Relationship Attribute
Configuring Full Text Catalogs
Deleting Attributes from a Catalog
Deleting Class Data from a Catalog
Re-indexing Catalogs
Setting A Default Full Text Catalog
Automatically Updating Full Text Catalogs
Previewing WorkView Client
WorkView OnBase Studio Shortcut Keys
Menu Bar Shortcuts
Additional Shortcuts
WorkView Security with Workflow
Using Events
Configuring Application Events
WorkView Class and Filter Events
Creating Unity Scripts for Events
Unity Script Project Properties
References Tab
Properties Tab
Versions Tab
Permissions Tab
Workflow System Events
Creating System Events
Configuring System Events
Mapping Properties
Task List Options
Break On
Additional Options
Documentation
WorkView Event Categories
General Workflow Support
GetExtendOnCreateClasses
GetTransformClasses
OnCreateObject
Workflow Support
OnBeforeSaveObject
Workflow Support
OnAfterSaveObject
Workflow Support
OnBeforeDeleteObject
Workflow Support
OnBeforeOpenObject
Workflow Support
OnAfterDocumentAttached
Workflow Support
OnAfterDocumentDetached
Workflow Support
OnBeforeExecuteFilter
Workflow Support
Finding Configuration Items in WorkView
Finding Dependencies
Validating Database Table for Applications
Purging History
Purging Inactive and Deleted Objects
Purging All Inactive and Deleted Objects
Purging Objects Selectively
Recovering Deleted Items
Web.config Files
WorkView Settings in the Web.config File
Setting the Maximum Display Results
Setting WorkView to Open By Default
Integrating WorkView with Perceptive Content
System Interaction
Application Enabler
Workflow
Collaboration
E-Forms, Unity Forms, and Image Forms
Reporting Dashboards
WorkView Rest API
WorkView View Designer
WorkView View Designer
Designer Interface
Toolbox Tab
Creating a View or Screen
View/Screen Properties
General
Scripts
Styles
Inserting Controls in the View
Labels, Panels, Line Breaks, Separators, Snippets, Attributes, and Filters
Control Properties Pane
Properties for All View Elements
General Tab
CSS Class
Styles
Action Button
General Tab
Configuring the Script for Client Side API Script Button
Styles Tab
Card
Styles Tab
Container
General Tab
Styles Tab
Folder
General Tab
Styles Tab
Header Section
Styles Tab
Hyperlink
General Tab
Advanced Tab
Styles Tab
IFrame
General Tab
Advanced Tab
Styles Tab
Image
General Tab
Styles Tab
Inserting Images Using the .css
Label
Styles Tab
Labels/Header Sections/Panels/Tables
General Tab
Line Break
List Box
Advanced Tab
Options
Toolbar
Constrain to Parent
Add To List
Panel
Styles Tab
Separator
Snippet
Styles Tab
Table
General Tab
Rows Tab
Columns Tab
Styles Tab
Attributes
General Tab
Scripts Tab
Styles Tab
Data Set Properties
Document Attribute Properties
Relationship Attributes
General Tab
Styles Tab
Filters
Advanced Tab
Options
Edit Mode
Edit Mode Configuration
Option: Read Only
Option: Required
Option:Related Attribute Lookup Filter
Option: Can Create From Lookup
Option: Shows As Filter
Option: Show as Dropdown
Toolbar
Constrain to Parent
Add To List
Inserting an Association Filter
System Tasks Tab
Scripts Tab
Embedded Filter Script Properties
Styles Tab
Cutting and Pasting Controls
Deleting Controls
Saving a View
Layout Pane
Renaming Controls
Deleting Controls
Global Script Resource
Configuring Styles
Globally Updating Label Styles
Custom Action Rule System
Custom Action Rule System
Configuring Rules
Modifying Rules
Moving Groups or Operations
Deleting Groups or Operations
Configuring Events
OnLoad
OnFocus
OnBlur
OnChange
OnClick
Configuring Conditions
Compare Field Value
Is User in Group
Configuring Actions
Constrain Selected Filter
Change Button State
Change Field Visibility
Change Filter Visibility
Change Folder Visibility
Set Read-only
Set Required
WorkView Triggers
Triggers Overview
Trigger Terminology
Configuring Triggers
Steps for the Average, Count, Max, Min, and Sum Actions
Steps for the Evaluate Action
Steps for the Set Action
Calculation Equation Tools
Functions
Macros
Supported Operators
Conditions
Advanced Trigger Options
Live Updates
Inheritance
Editing Target Attribute
Disabling Triggers
Application Creation Excelerator
Application Creation Excelerator Overview
Creating an ACE File
Generating an ACE Template
Creating Applications for Import
Importing Applications Using ACE
Studio Administration
Studio Administration Overview
Connecting to Repositories
Configuring Repository Properties
Configuring the Environment Value Management URL
Configuring the Administration Portal Web Application URL
Refreshing Repositories
Expanding and Collapsing Items in the Repository Pane
Viewing Items in the Designer Pane
Unity Projects
Creating a Unity Script Project
Unity Script Project Properties
References Tab
Properties Tab
Versions Tab
Permissions Tab
Creating a Unity Library Project
Unity Library Project Properties
References Tab
Versions Tab
Permissions Tab
Opening an Existing Unity Project
Managing Unity Projects
Configuring the Default Diagnostic Level for a Unity Script
Monitoring Unity Project Usage
Monitoring Unity Script Performance Statistics
Clearing Script Performance Statistics
Deleting Unity Projects
Recovering a Deleted Unity Project
Exporting a Unity Script or Unity Library
Exporting an Assembly
Importing an Assembly
Unity Integrations
Creating a New Integration
Unity Integration Properties
Renaming an Integration
Deleting an Integration
Reactivating a Deleted Integration
Configuring Portfolio Types
Configuring Portfolio Relations
Wizard Options
Relating Documents to Content Composer Bundles
Relating Documents to Documents
Configuring a Document Type Relationship
Configuring a Workflow Filter Relationship
Relating Documents to Entity Items
Relating Documents to WorkView Objects
Custom Keyword Type Mapping
Relating Entity Item to Documents
Relating Message Items to Content Composer Bundles
Relating Message Items to Documents
Relating Message Items to WorkView Objects
Relating WorkView Objects to Content Composer Bundles
Relating WorkView Objects to Documents
Relating WorkView Objects to WorkView Objects
Creating Portfolio Types
Searching in Studio
Search Options
Search Results
Exporting Search Results
Output Tab
Shortcuts
The Reset Server Cache Button
Studio Options
General
Doctor
Workflow
Action/Rule Categories
WorkView
Script Editors
Managing Locks
Output Window
Controlling the Interface Display
Using the Quick Access Toolbar
Spell Check
Using Change Control
Exporting
Export Considerations
Exporting a Configuration
Importing
Import Considerations
Importing a Configuration
Auto Resolution
Save and Load Decisions
Save Decisions
Load Decisions
Filtering Change Tracking Columns
Operators
Drop-Down Lists
Custom Filter Selection
Studio - WorkView Item Generators
Configuring Item Generators
Creating Generators
Generating Documents
Generating WorkView Objects
Creating Generator Sets
Executing Generators and Generator Sets
Administrating Generator Batches
OnBase Client WorkView Configuration
Configuring the WorkView OnBase Client Integration
Mapping to WorkView Page
Application Server Overview
Defining the Application Server
Reverse Proxy Configuration
Overview
Application Request Routing Configuration
URL Rewrite Configuration
System Attributes
Using System Attributes
Macros
Using Macros
Report Processor
Using the Report Processor
Report Processor Tags
General Settings
Attributes and other Data Values
System Variables
Execution Flow Control
Iterators and other Looping Blocks
Filters
Documents
Math and Calculations
Name-Value Maps
Iterate Name Value Map Matrix
Post Processing
Importing Report Results into OnBase
Charting
FilterPop
Using FilterPop
Embedding Filters in an iFrame
License Usage for FilterPop
Configuring the Distribution Service
Configuration Overview
Using the Distribution Service with Document Distribution
Configuration
Configuring the Email Sending Unity Scheduler Task
Creating Tasks
Configuring Tasks
Enabling the Distribution Service
Enable Email Automation
Send Attachments
Users Configuration Requirements
Configuring Test Mode
Adding Support for Multiple Data Sources
Configuring EML Transfer Encoding
Configuring the Distribution Service to Save Notifications as E-Mail (EML) Files
Sending Notifications in HTML Format
Sending Unity Forms
Configuring a Temporary File Cache
Configuring Retry Settings
Configuring Maximum Recipients
Configuring Default Sender Options
Displaying the User Who Triggered the Notification as the Sender
Configuring Attachment Options
Configuring Email Server Settings
Generating and Sending Test Notifications
Viewing Reports in the Unity Management Console
Troubleshooting
Logging Information to the Diagnostics Console
Messages Are Not Sent
Workstation Registration Not Found
"No Count" Is On
Version Mismatch
Message Content and Attachments Are Reversed
Unity Forms Limitations
Windows User Account Control Statement
Using WorkView with Microsoft Exchange Online accounts
WorkView Data Provider
WorkView Data Provider Configuration
Adding a WorkView Data Provider Type
Best Practices
WorkView Best Practices
General Design
General Performance
Scripting
Workflow
WorkView Javascript Client Side API Documentation
WorkView Javascript Client Side API Documentation Overview
Screen
Screen.ClassID
Returns
Screen.ClassName
Returns
Screen.CloseObject()
Parameters
Screen.CreatedDate
Returns
Screen.CurrentUser
Returns
Screen.CurrentView
Returns
Screen.DisplayMessageBox()
Parameters
Additional Information/Limitations
Screen.DisplayStatusMessage()
Parameters
Additional Information/Limitations
Screen.Modified
Returns
Screen.ObjectID
Returns
Additional Information/Limitations
Screen.ObjectSource
Returns
Additional Information/Limitations
Screen.RefreshObject()
Parameters
Additional Information/Limitations
Screen.RevisionBy
Returns
Screen.RevisionDate
Returns
Screen.rmCreatedBy
Returns
Screen.rmObjectName
Returns
Screen.SaveObject()
Parameters
Additional Information/Limitations
Screen.ScreenID
Returns
Additional Information/Limitations
Screen.SourceID
Returns
Screen.Views()
Parameters
Returns
Additional Information/Limitations
View
Screen.CurrentView.Buttons()
Parameters
Returns
Screen.CurrentView.Fields()
Parameters
Returns
Screen.CurrentView.Filters()
Parameters
Returns
Screen.CurrentView.Filters().Refresh()
Parameters
Screen.CurrentView.Filters().AddConstraint(attribute, operator, value, connector, grouping)
Parameters
Screen.CurrentView.Filters().ClearConstraints()
Parameters
Screen.CurrentView.ViewID
Returns
Additional Information/Limitations
Screen.CurrentView.TabID
Returns
Additional Information/Limitations
Screen.CurrentView.isActive
Returns
Additional Information/Limitations
Screen.CurrentView.Text
Returns
Screen.CurrentView.Reset()
Additional Information/Limitations
Screen.CurrentView.Focus()
Additional Information/Limitations
Screen.CurrentView.Folders()
Parameters
Returns
Additional Information/Limitations
Screen.CurrentView.Load()
Additional Information/Limitations
Screen.Views("<View Name>").Buttons()
Parameters
Returns
Screen.Views("<View Name>").Fields()
Parameters
Returns
Additional Information/Limitations
Screen.Views("<View Name>").Filters()
Parameters
Returns
Screen.Views("<View Name>").ViewID
Returns
Additional Information/Limitations
Screen.Views("<View Name>").TabID
Returns
Additional Information/Limitations
Screen.Views("<View Name>").isActive
Returns
Screen.Views("<View Name>").Text
Returns
Screen.Views("<View Name>").Reset()
Additional Information/Limitations
Screen.Views("<View Name>").Focus()
Additional Information/Limitations
Screen.Views("<View Name>").Folders()
Parameters
Returns
Additional Information/Limitations
Screen.Views("<View Name>").Load()
Additional Information/Limitations
Buttons
Screen.CurrentView.Buttons("<Button Name>").Disable
Returns
Screen.CurrentView.Buttons("<Button Name>").Collapse
Returns
Screen.CurrentView.Buttons("<Button Name>").Hidden
Returns
Screen.CurrentView.Buttons("<Button Name>").Name
Returns
Additional Information/Limitations
Screen.CurrentView.Buttons("<Button Name>").Label
Parameters
Returns
Screen.CurrentView.Buttons("<Button Name>").HelpText
Parameters
Returns
Screen.Views("<View Name>").Buttons("<Button Name>").Disable
Returns
Screen.Views("<View Name>").Buttons("<Button Name>").Collapse
Returns
Screen.Views("<View Name>").Buttons("<Button Name>").Hidden
Returns
Screen.Views("<View Name>").Buttons("<Button Name>").Name
Returns
Additional Information/Limitations
Screen.Views("<View Name>").Buttons("<Button Name>").Label
Parameters
Returns
Screen.Views("<View Name>").Buttons("<Button Name>").HelpText
Parameters
Returns
Field
Screen.CurrentView.Fields("<Attribute Name>").Value
Returns
Screen.CurrentView.Fields("<Attribute Name>").Name
Returns
Screen.CurrentView.Fields("<Attribute Name>").AttributeID
Returns
Additional Information/Limitations
Screen.CurrentView.Fields("<Attribute Name>").MaxLength
Returns
Screen.CurrentView.Fields("<Attribute Name>").DataType
Returns
Screen.CurrentView.Fields("<Attribute Name>").ReadOnly
Returns
Screen.CurrentView.Fields("<Attribute Name>").Required
Returns
Screen.CurrentView.Fields("<Attribute Name>").ShowLabel
Returns
Screen.CurrentView.Fields("<Attribute Name>").Multiline
Returns
Screen.CurrentView.Fields("<Attribute Name>").Modified
Returns
Screen.CurrentView.Fields("<Attribute Name>").reset()
Screen.CurrentView.Fields("<Attribute Name>").focus()
Screen.CurrentView.Fields("<AttributeName>").ShowImport
Returns
Screen.CurrentView.Fields("<Attribute Name>").ShowLookupButton
Returns
Additional Information/Limitations
Screen.CurrentView.Fields("<Attribute Name>").Hidden
Returns
Screen.CurrentView.Fields("<Attribute Name>").Collapse
Returns
Screen.CurrentView.Fields("<Attribute Name>").FormattedValue
Returns
Additional Information/Limitations
Screen.CurrentView.Fields("<Attribute Name>").HasValue
Returns
Additional Information/Limitations
Screen.CurrentView.Fields("<Attribute Name>").Label
Parameters
Returns
Screen.CurrentView.Fields("<Attribute Name>").HelpText
Parameters
Returns
Screen.CurrentView.Fields("<Attribute Name>").Placeholder
Parameters
Returns
Additional Information/Limitations
Screen.Views("<View Name>").Fields("<Attribute Name>").Value
Returns
Screen.Views("<View Name>").Fields("<Attribute Name>").Name
Returns
Screen.Views("<View Name>").Fields("<Attribute Name>").AttributeID
Returns
Additional Information/Limitations
Screen.Views("<View Name>").Fields("<Attribute Name>").MaxLength
Returns
Screen.Views("<View Name>").Fields("<Attribute Name>").DataType
Returns
Screen.Views("<View Name>").Fields("<Attribute Name>").ReadOnly
Returns
Screen.Views("<View Name>").Fields("<Attribute Name>").Required
Returns
Screen.Views("<View Name>").Fields("<Attribute Name>").ShowLabel
Returns
Screen.Views("<View Name>").Fields("<Attribute Name>").Multiline
Returns
Screen.Views("<View Name>").Fields("<Attribute Name>").Modified
Returns
Screen.Views("<View Name>").Fields("<Attribute Name>").reset()
Screen.Views("<View Name>").Fields("<Attribute Name>").focus()
Screen.Views("<View Name>").Fields("<Attribute Name>").ShowLookupButton
Returns
Additional Information/Limitations
Screen.Views("<View Name>").Hidden
Returns
Screen.Views("<View Name>").Fields("<Attribute Name>").Hidden
Returns
Screen.Views("<View Name>").Fields("<Attribute Name>").Collapse
Returns
Screen.Views("<View Name>").Fields("<Attribute Name>").FormattedValue
Returns
Additional Information/Limitations
Screen.Views("<View Name>").Fields("<Attribute Name>").HasValue
Returns
Additional Information/Limitations
Screen.Views("<View Name>").Fields("<Attribute Name>").Label
Returns
Screen.Views("<View Name>").Fields("<Attribute Name>").HelpText
Returns
Screen.Views("<View Name>").Fields("<Attribute Name>").Placeholder
Returns
Additional Information/Limitations
Screen.CurrentView.Fields("<Attribute Name>").DatasetID
Returns
Screen.CurrentView.Fields("<Attribute Name>").ParentDatasetID
Returns
Screen.Views("<View Name>").Fields("<Attribute Name>").DatasetID
Returns
Screen.Views("<View Name>").Fields("<Attribute Name>").ParentDatasetID
Returns
Screen.CurrentView.Fields("<Attribute Name>").FilterID
Returns
Additional Information/Limitations
Screen.CurrentView.Fields("<Attribute Name>").ClassID
Returns
Screen.CurrentView.Fields("<Attribute Name>").CancelLookup
Returns
Screen.CurrentView.Fields("<Attribute Name>").AddConstraintEx()
Parameters
Additional Information/Limitations
Screen.CurrentView.Fields("<Attribute Name>").ClearConstraints()
Screen.CurrentView.Fields("<Attribute Name>").RelatedObjectID
Returns
Additional Information/Limitations
Screen.Views("<View Name>").Fields("<Attribute Name>").FilterID
Returns
Additional Information/Limitations
Screen.Views("<View Name>").Fields("<Attribute Name>").RelatedView
Returns
Screen.Views("<View Name>").Fields("<Attribute Name>").ClassID
Returns
Screen.Views("<View Name>").Fields("<Attribute Name>").CancelLookup
Returns
Screen.Views("<View Name>").Fields("<Attribute Name>").AddConstraintEx()
Parameters
Additional Information/Limitations
Screen.Views("<View Name>").Fields("<Attribute Name>").ClearConstraints()
Screen.Views("<View Name>").Fields("<Attribute Name>").RelatedObjectID
Returns
Additional Information/Limitations
Filter
Screen.CurrentView.Filters("<Filter Name>").RelatedView
Returns
Screen.CurrentView.Filters("<Filter Name>").CancelOpenRelatedObjects
Returns
Screen.CurrentView.Filters("<Filter Name>").Collapse
Returns
Screen.CurrentView.Filters("<Filter Name>").Hidden
Returns
Screen.CurrentView.Filters("<Filter Name>").Name
Returns
Screen.CurrentView.Filters("<Filter Name>").SelectedItem["<Filter Column Heading>"]
Returns
Screen.CurrentView.Filters("<Filter Name>").SetButton
Parameters
Additional Information/Limitations
Screen.CurrentView.Filters("<Filter Name>").GetButton
Parameters
Additional Information/Limitations
Screen.CurrentView.Filters("<Filter Name>").Buttons
Returns
Additional Information/Limitations
Screen.CurrentView.Filters("<Filter Name>").Label
Parameters
Returns
Screen.CurrentView.Filters("<Filter Name>").HelpText
Parameters
Returns
Screen.Views("<View Name>").Filters("<Filter Name>").RelatedView
Returns
Screen.Views("<View Name>").Filters("<Filter Name").AddConstraintEx()
Parameters
Additional Information/Limitations
Screen.Views("<View Name>").Filters("<Filter Name>").Collapse
Returns
Screen.Views("<View Name>").Filters("<Filter Name>").Hidden
Returns
Screen.Views("<View Name>").Filters("<Filter Name>").Name
Returns
Screen.Views("<View Name>").Filters("<Filter Name>").SetButton
Parameters
Additional Information/Limitations
Screen.Views("<View Name>").Filters("<Filter Name").GetButton
Parameters
Additional Information/Limitations
Screen.Views("<View Name>").Filters("<Filter Name>").Buttons
Returns
Additional Information/Limitations
Screen.Views("<View Name>").Filters("<Filter Name>").Label
Parameters
Returns
Screen.Views("<View Name>").Filters("<Filter Name>").HelpText
Parameters
Returns
Folder
Screen.CurrentView.Folders("<Folder Name>").Collapse
Returns
Screen.CurrentView.Folders("<Folder Name>").Hidden
Returns
Screen.CurrentView.Folders("<Folder Name>").Name
Returns
Screen.CurrentView.Folders("<Folder Name>").Buttons
Returns
Additional Information/Limitations
Screen.CurrentView.Folders("<Folder Name>").Label
Parameters
Returns
Screen.CurrentView.Folders("<Folder Name>").HelpText
Parameters
Returns
Screen.Views("<View Name>").Folders("<Folder Name").Collapse
Returns
Screen.Views("<View Name>").Folders("<Folder Name").Hidden
Returns
Screen.Views("<View Name>").Folders("<Folder Name").Name
Returns
Screen.Views("<View Name>").Folders("<Folder Name").Buttons
Returns
Additional Information/Limitations
Screen.Views("<View Name>").Folders("<Folder Name").Label
Parameters
Returns
Screen.Views("<View Name>").Folders("<Folder Name").HelpText
Parameters
Returns
Toolbar Buttons
Screen.CurrentView.Filters("<Filter Name>").Buttons[i].Collapse
Returns
Screen.CurrentView.Filters("<Filter Name>").Buttons[i].Hidden
Returns
Screen.CurrentView.Filters("<Filter Name>").Buttons[i].Name
Returns
Screen.CurrentView.Filters("<Filter Name>").Buttons[i].ToolTip
Returns
Screen.Views("<View Name>").Filters("<Filter Name>").Buttons[i].Collapse
Returns
Screen.Views("<View Name>").Filters("<Filter Name>").Buttons[i].Hidden
Returns
Screen.Views("<View Name>").Filters("<Filter Name>").Buttons[i].Name
Returns
Screen.Views("<View Name>").Filters("<Filter Name>").Buttons[i].HelpText
Returns
Toolbar Button Example Code
WorkView Web Client and Client Usage
Usage
In the Web Client
Document Viewer Window Options
In the Client
Registering a Workstation
Verifying and Revoking Workstation Registrations
Clearing Excess Workstation Registrations
Workstation Cleanup
View Current Users
Opening an Application
Using the Calendar View
Choosing Display Type
Selecting Filters
Split Screen View
Navigating the Calendar
Opening Objects
Using Filters Within WorkView
Search Operators
Searching Columns
Grouping Objects
Creating Objects from Filter Results
Conducting Full Text Searches
Creating User-Defined Filters
Columns Tab
User Entry Tab
Fixed Constraints Tab
Sort Tab
Editing User-Defined Filters
Sharing User-Defined Filters
Receiving Shared Filters
Deleting User-Defined Filters
Creating Objects from the Web Client
Using Filters From the Web Client
Using Subfilters
Using Columns
Sorting
Searching
Wildcard Operators
Opening Objects in Results List
Split Screen View
Opening Objects in New Windows
Printing Results Lists
Exporting Filter Results to an Excel Spreadsheet
Deleting Objects in Results List
Date and Date/Time Attributes
Hyperlinks
WorkView Web Viewer
The WorkView Web Viewer
Object Elements
Saving
Printing Objects
Editing
Refreshing
Viewing Object History
Viewing Documents
Resizing the Object Window
Subscribing to Notifications
Deleting
Date and Date/Time Attributes
Hyperlinks
Loading Filter Results Within Objects
Navigating Filter Results Within Objects
Creating Objects From Within Objects
Creating New Object by Copying Existing Objects
Creating New Object by Extending an Existing Object
Viewing the Embedded Filter in Full Screen Mode
Opening a Document from an Embedded Filter
Edit Mode
Relating Objects
Adding Rows
Associating Objects
Filtering Embedded Filter Results
Customizing Embedded Filters
Object Buttons and Fields
Navigating Between Objects
Navigating Previously Opened Object
Data Sets
Radio Buttons
List Boxes
Calendars
Required Fields
Currency Fields
Masked Fields
Lookups
Clearing a Relationship Value for an Attribute
Formatted Text
Using Links in Formatted Text Fields
Resizing Controls
Updating Relationships within a Filter
Accessing Folders
Working with Related Documents
Attaching Documents
Creating and Attaching New Documents
Attaching Documents Embedded in a View
Attaching an Existing Document
Creating and Attaching New Documents
Opening Documents
Deleting Documents
Using Folders
Folders Embedded Within Views
Creating a Form from Within an Object
Using Actions and Ad Hoc Tasks
Running a System Task from an Embedded Filter
Shortcut Keys for Open Objects
Shortcut Keys for Embedded Filters
WorkView Unity Client Usage
Usage
Accessing WorkView in the Unity Client
User Options
Using the Calendar View
Choosing Display Type
Selecting Filters
Navigating the Calendar
Opening Objects
Creating Objects Within the Calendar View
Refreshing the Calendar View
Using Filters Within WorkView
Conducting Full Text Searches
Enabling Search Fields
Search Operators
Data Sets
Filter Tabs
Retrieving More Object Results
Grouping Objects
Customizing the Filter Display
Resizing Columns
Moving Columns
Auto Size Column Widths
Choosing Columns
Displaying Attribute Summary Information
Filter Settings
Configuring Filter Settings
Viewing Filter Results in the Dashboard
Refreshing Filters
Executing Ad Hoc Tasks from Filter Results
Changing the Order of Tasks
Creating User-Defined Filters
Columns
User Entry Attributes
Fixed Constraints
Sort Tab
Editing User-Defined Filters
Ordering User-Defined Filters
Sharing User-Defined Filters
Receiving Shared User-Defined Filters
Deleting User-Defined Filters
Using Subfilters
Using Columns
Sorting
Searching
Column Search Options
Opening Objects in Results List
Printing Results Lists
Print Preview
Exporting Filter Results to an Excel Spreadsheet
Creating Objects within a Filter Tab or Lookup Results List
Deleting Objects in Results List
Shortcut Keys for Filters
Recently Viewed Items
Favorites
Creating Favorites
Viewing Favorites
Working with Favorites
Editing Favorites
Deleting Favorites
Arranging Favorites
Creating Objects Within WorkView
Using Filters From the Unity Client
Creating Objects from the Unity Client
Full Text Searching
Advanced Options
Search Type
Date Options
Search Modes
Specific classes to search
WorkView Unity Viewer
The WorkView Unity Viewer
Object Elements
Saving
Printing Objects
Editing
Refreshing
Viewing Object History
Viewing Documents
Sending Object Link Through Email
Copying Object Link to the Clipboard
Subscribing to Notifications
Deleting
Date and Date/Time Attributes
Hyperlinks
Loading Filter Results Within Objects
Navigating Filter Results Within Objects
Creating Objects From Within Objects
Creating New Object by Copying Existing Objects
Creating New Object by Extending an Existing Object
Opening an Embedded Filter in a New Window
Opening a Document from an Embedded Filter
Retrieving All Results for an Embedded Filter
Viewing the Embedded Filter in Full Screen Mode
Edit Mode
Relating Objects
Adding Rows
Associating Objects
Filtering Embedded Filter Results
Customizing Embedded Filters
Object Buttons and Fields
Navigating Between Objects
Navigating Previously Opened Object
Data Sets
Radio Buttons
List Boxes
Calendars
Required Fields
Currency Fields
Masked Fields
Lookups
Clearing a Relationship Value for an Attribute
Formatted Text
Using Links in Formatted Text Fields
Resizing Controls
Updating Relationships within a Filter
Accessing Folders
Working with Related Documents
Attaching Documents
Creating and Attaching New Documents
Attaching Documents Embedded in a View
Attaching an Existing Document
Creating and Attaching New Documents
Opening Documents
Deleting Documents
Using Folders
Folders Embedded Within Views
Closing Objects
Creating a Form from Within an Object
Using Actions
Executing Workflow Tasks in an Open Object
Changing the Order of Tasks
Running a System Task from an Embedded Filter
Shortcut Keys for Open Objects
Shortcut Keys for Embedded Filters