Hyland.Canvas.Client - Unity Client - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Essential - Premier - Standard - external - Standard - Premier - Essential

Unity Client

Platform
OnBase
Product
Unity Client
Release
Foundation 23.1
License
Standard
Premier
Essential

The ServiceMode attribute is available in the Hyland.Canvas.Client element in the Unity Client configuration file.

This element controls whether the Unity Client runs in Service Mode or Interactive Mode.

When enabled is set to true, the Unity Client runs in Service Mode. This means that:

  • Closing the Unity Client with the X in the top right corner minimizes it to the system tray, where it continues to run. The embedded document viewer is closed and you are prompted to save any changes.

  • The Log Out button is not available from the Unity Client File menu. The ability to log out of OnBase is available by right-clicking the Unity Client system tray icon.

  • When allowExit is true, the Exit OnBase option is available from the system tray. When allowExit is false, the Exit OnBase option is not available from the system tray.

  • When autoLaunch is true, the Unity Client will launch in Service Mode when Windows starts.

    When autoLaunch is false, the Unity Client will not launch in Service Mode when Windows starts.

    Note:

    The Set Registration action does not update the registry with changes to the autoLaunch setting. If the autoLaunch setting is changed, to update the registry key, do one of the following:

    • Reinstall the Unity Client and enable or disable the Prevent Client from launching on system startup setting.

    • Manually add or remove the registry key on the affected workstation.

  • The sendSessionID attribute is treated as false for Pop-Based Application Enabler contexts that use this attribute.

  • The following features are available:

Feature Name

Description

Unity Client

When enabled is set to true, the Launch Unity Client option is available from the system tray. Double-clicking the system tray icon will launch the Unity Client.

When enabled is set to false, the Launch Unity Client option is not available from the system tray. Double-clicking the system tray icon will launch the Application Enabler toolbar if the ApplicationEnabler feature is enabled.

Application Enabler

When enabled is set to true, the Application Enabler module can be used.

When enabled is set to false, the Application Enabler module cannot be used.

Unity Client Automation API

When enabled is set to true, the Unity Client Automation API, which is used by third-party applications to automate the Unity Client, can be used.

When enabled is set to false, the Unity Client Automation API cannot be used.

Virtual Print Driver

When enabled is set to true, the Virtual Print Driver module can be used.

When enabled is set to false, the Virtual Print Driver module cannot be used.

Unity Pop

Whether Unity Pop is enabled.

When enabled is set to true, Unity Pop is enabled.

When enabled is set to false, Unity Pop is not enabled.

Note:

To specify what type of Unity Pop item is sent (Unity Pop link or Unity Pop file), refer to the emailLinkAs setting in appSettings.

When enabled is set to true and the -deferredlogin command line switch is applied:

  • After the Unity Client starts, users are not prompted to log on. The Unity Client is minimized to the Windows system tray. Double-clicking the shortcut a second time will open the Client login.

  • Users are required to log on to the Unity Client when performing the first Unity Client context with Application Enabler. Triggering subsequent contexts does not require users to log on to the Unity Client.

  • Users are not required to log on to the Unity Client when performing OnBase Client, Web Client, and Pop-Based Application Enabler contexts.

    For more information about the -deferredlogin command line switch, refer to the Application Enabler module reference guide.

When enabled is set to false, the Unity Client runs in Interactive Mode. This means that:

  • The Unity Client cannot be minimized to a system tray icon.

  • If Application Enabler is not licensed, any context event scraping is in Demo Mode.