The CONFIGURATION Element - Express Scanning - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Essential - Premier - Standard - external - Premier - Essential - Standard

Express Scanning

Platform
OnBase
Product
Express Scanning
Release
Foundation 23.1
License
Premier
Essential
Standard

The CONFIGURATION element contains general configuration information about the Express Scanning client.

<CONFIGURATION apptitle="Express Scanning" idlemessage="Select a Document" exitlabel="Exit" exittooltip="Click to exit Express Scanning" timeout="5" printmonitor="true" printstartup="C:\OnBase Printer Spool" />

Tag

Description

apptitle

This setting controls the text that is displayed in the Express Scanning window's title bar.

Variables, such as %location% and %username%, can be used in the value to display the workstation's configured location and the user's OnBase user name in the title bar.

For example, apptitle="Express Scanning- %username% - %location%" might display as Express Scanning - John Adams - Remote Office if an OnBase user named John Adams was using Express Scanning on a workstation in a remote office.

Other variables can be defined at the workstation level. For more information, contact your solution provider.

Note:

For more information on configuring a workstation's location, see The LOCATIONS Element.

idlemessage

This setting controls the text that is displayed in the Document Viewer when the Express Scanning client is idle.

exitlabel

This setting controls the text that is used to label the Exit button.

exittooltip

This setting controls the text that is displayed as a tooltip when the user places the pointer on top of the Exit button.

timeout

This setting controls the number of minutes of inactivity allowed before the Express Scanning client automatically closes.

For example, setting timeout=5 will allow five minutes of inactivity before the Express Scanning client is automatically closed.

Setting timeout=0 prevents the Express Scanning client from timing out and closing automatically.

encodedupload

The encodedupload setting controls whether documents uploaded to OnBase via Express Scanning are uploaded using an encoded transfer or a raw, binary transfer.

  • If encodedupload is set to true, or if no value is present, Express Scanning uploads documents to OnBase using an encoded transfer.

  • If encodedupload is set to false, Express Scanning uploads documents to OnBase using a raw, binary transfer.

printmonitor

Note:

This setting is only used if your OnBase solution is also licensed for the Virtual Print Driver and you are configuring a Print to OnBase solution.

This setting controls if Express Scanning is to be used to Print to OnBase(i.e., capture documents printed by the Virtual Print Driver and upload them to OnBase).

To use Express Scanning to print to OnBase, set the printmonitor setting to true (printmonitor="true").

Note:

The printmonitor setting must be set to true regardless of whether the Print to OnBase solution is configured to be used in interactive or non-interactive mode.

To prevent the Express Scanning client from printing to OnBase, set the printmonitor setting to false (printmonitor="false") or remove the printmonitor setting from the master configuration file.

Note:

For more information on configuring a Print to OnBase solution, see Configuring a Print to OnBase Solution.

printstartup

This setting controls the directory that the Hyland Express Scanning Listener Service searches for documents to upload on startup.

When this setting is set to the Virtual Print Driver's print spool folder, for instance, it can be used to upload documents that were printed via the Virtual Print Driver when the service was not running.

The directory must be written as a full path (i.e., printstartup="C:\OnBase Printer Spool").

Note:

If the printstartup setting is set to a valid directory, the Hyland Express Scanning Listener Service will attempt to upload documents in this directory on startup, regardless of the value of the printmonitor setting.