Using Contexts - Application Enabler - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

Application Enabler

Platform
OnBase
Product
Application Enabler
Release
Foundation 23.1
License
Standard
Essential
Premier

There are many applications that work with Application Enabler. Each can work in different ways. The following are system interaction contexts used for certain mouse and keyboard events with Application Enabler.

Note:

Contexts that trigger indexing or upload actions cannot be used with Multi-Instance Keyword Type Groups.

When a context is chosen, only the configured Application Enabler functionality available for the context's module will execute using the selected mouse or keyboard event. Contexts are configured on a screen-by-screen basis for specific mouse and keyboard events.

When configuring contexts, you select the OnBase client that will be used to execute the context, and then the action that will be performed. These clients and actions are described in the following sections:

For Application Enabler to function, settings in the Unity Client's configuration file must be configured. These settings can be configured manually. Some can also be configured during the Unity Client's ClickOnce installation process.

The following attributes in the <ApplicationEnabler> tag are related to the Application Enabler module.

Attribute

Corresponding ClickOnce Option

Description

EnableHandlingUnityClientEvents

Unity Features - Application Enabler

When set to true, the Unity Client can receive scrape events from Application Enabler.

When set to false, the Unity Client cannot receive scrape events from Application Enabler.

Note:

You must manually add this attribute to the <ApplicationEnabler> tag. When this attribute is not present, it is treated as true.

DefaultConfigFile

Default Configuration File

To automatically load a saved configuration when the Unity Client is opened, specify the full path to the file. The path to the configuration file can be a local path, UNC path, URL (HTTP or HTTPS), or a URN.

When a default configuration is specified, the configured screen is enabled on startup. To start Application Enabler, click AppEnabler.

Note:

When a URL is specified for a file, the file is downloaded to a temporary directory from its specified location and the temporary file is opened. Any time the configuration file on the server is modified, you must restart IIS or reset the cache of the OnBase Application Server for changes to take effect.

Note:

To specify a custom temporary directory, create environment variable ONBASETEMP in the Windows Environment Variables configuration window, and enter the desired path in the Variable value field.

UsePersistentWindowForRetrieval

None

When set to true, the Application Enabler - Retrieve Documents context uses the same window each time it is triggered. The window's size and position are also retained.

When set to false, the Application Enabler - Retrieve Documents context uses a new window each time it is triggered. The window's size and position are not retained.

UsePersistentWindowForCustomQuery

None

When set to true, the Application Enabler - Run Custom Query context uses the same window each time it is triggered. The window's size and position are also retained.

When set to false, the Application Enabler - Run Custom Query context uses a new window each time it is triggered. The window's size and position are not retained.

UsePersistentWindowForEformCreation

None

When set to true, the Application Enabler - Create New E-Form context uses the same window each time it is triggered. The window's size and position are also retained.

When set to false, the Application Enabler - Create New E-Form context uses a new window each time it is triggered. The window's size and position are not retained.

UsePersistentWindowForFolderRetrieval

None

When set to true, the Application Enabler - Retrieve Folders context uses the same window each time it is triggered. The window's size and position are also retained.

When set to false, the Application Enabler - Retrieve Folders context uses a new window each time it is triggered. The window's size and position are not retained.

UsePersistentWindowForWorkflowRetrieval

None

When set to true, the Application Enabler - Retrieve in Workflow context uses the same window each time it is triggered. The window's size and position are also retained.

When set to false, the Application Enabler - Retrieve in Workflow context uses a new window each time it is triggered. The window's size and position are not retained.

Note:

In order for this attribute to work correctly with Workflow Retrieval, you must enable Allow multiple instances of the Workflow layout in the Unity Client's Workflow User Options.

Note:

Persistent windows are shared among all contexts. For example, the Application Enabler - Retrieve Documents and Application Enabler - Run Custom Query contexts are configured to use the same Unity Client window each time they are triggered. If you trigger the Application Enabler - Retrieve Documents context and then trigger the Application Enabler - Run Custom Query context, the Application Enabler - Run Custom Query context will use the same window that the Application Enabler - Retrieve Documents context previously used.

CAUTION:

Using the Reset Cache option in OnBase Configuration or the Reset Server Cache option in OnBase Studio may have a negative impact on system performance. Requests to the Application Server will be forced to wait until the cache is rebuilt before they can be processed. Depending on the size of the OnBase system, as well as the current server load, the performance impact of resetting the cache may be severe. To avoid performance issues, only reset the cache of the Application Server during off-peak hours. For more information about the Reset Cache option in OnBase Configuration, see the System Administration documentation. For more information about the Reset Server Cache option in OnBase Studio, see the Studio documentation.