The Local Configuration File - 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

A local configuration file must exist on each workstation that will be used to perform Express Scanning. The local configuration file contains a pointer to the master configuration file and information identifying the location the workstation is to be associated with.

In addition, the local configuration file may contain general configuration information, logon information, and scan format information if this information is specific to this workstation only, or if this workstation needs to override configuration information from the master configuration file.

The first time a user logs onto Express Scanning, the Express Scanning client will prompt the user to browse to the location of the master configuration file and to select a location. Once the path to the master configuration file and the location of the workstation have been determined, the local configuration file is automatically created on the workstation, and this information is saved.

The user will not be prompted to enter this information again unless the local configuration file is deleted. A user can change this information by manually changing the local configuration file or by using a command line switch.

The local configuration file is located in the workstation's C:\ProgramData\ExpressScan folder and is named express.local.config.xml by default. To set a different default location for the local configuration file, see the -LOCALPATH section in the Express Scanning module reference guide or the Command Line Switches documentation.

Note:

Although the file is automatically created, any configuration information other than the pointer to the master configuration file and the location of the workstation (e.g., general configuration information, logon information or scan format information) must be added to the file manually.

A sample local configuration file is displayed below:

<EXPRESSSCANNING masterconfig="C:\Express Scanning\express.master.config.xml" location="LOCATION_1" />

Tag

Description

masterconfig

This setting identifies the location of the master configuration file.

This setting must be set to the full path, UNC, or URL of the master configuration file. For example, if your master configuration file resides on a server at this network location, \\server1\ES\master.config.xml, then the masterconfig setting must be set to masterconfig="\\server1\ES\master.config.xml".

Similarly, if your master configuration file resides on an HTTP(S) server at this location, https://servername/master.config.xml, then the masterconfig setting must be set to masterconfig="https://servername/master.config.xml".

location

This setting determines the location used by the Express Scanning workstation.

This setting must be set to the name of the location to which the workstation will belong. For example, if you would like to assign a workstation to a location named AP-All Users, then the location setting must be set to AP-All Users (location="AP-All Users").

A location may have many workstations assigned to it, but each workstation can only be assigned to one location.

To incorporate workstation-specific configuration information into the local configuration file, you can add CONFIGURATION, LOGIN, or SCANFORMATS elements to your local configuration file within its EXPRESSSCANNING parent element.

The example below has workstation-specific general configuration information (a CONFIGURATION element) added to the local configuration file. Note that the CONFIGURATION sub-element has been highlighted:

For more information on the functionality of and the features of the CONFIGURATION, LOGIN, and SCANFORMATS sub-elements, see: