The ScanOptions Element - Front Office Scanning - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Premier - external - Standard - Essential - Premier - Standard - Essential

Front Office Scanning

Platform
OnBase
Product
Front Office Scanning
Release
Foundation 23.1
License
Premier
Standard
Essential

The ScanOptions element contains advanced configuration options for configuring the scanner(s) used by the Front Office Scanning client.

<ScanOptions promptForFirstDevice="true" promptForPrintMon="prompt" scanner="" multiplebuttons="true" onestep="false" batchscan="false" imagescale="" nativemode="" hardwarecompress="" bitdepth="8" />

The following settings are found in the ScanOptions element:

ScanOptions Element Settings

Description

promptForFirstDevice

This setting allows you to specify if users are prompted to select a scanner when the Scan button is clicked.

  • If promptForFirstDevice is set to true, then the Select Scanner dialog box is displayed each time a user clicks the Scan button.

  • If promptForFirstDevice is set to false, then the scanner specified by the scanner setting is automatically selected. If no scanner is specified by the scanner setting, then the default scanner is selected.

promptForPrintMon

Note:

This setting requires that at least one Document Type is configured to use the Virtual Print Driver as a source of image templates (i.e., the templatesource setting in the DocType sub-element is set to printmon).

This setting allows you to specify which action will be taken when a document is awaiting Document Type assignment in the Working window and a new document is printed using the Virtual Print Driver.

  • If promptForPrintMon is set to appendDoc and a document awaiting Document Type assignment is in the Working window, then the virtually printed document is automatically appended to the document in the Working window. This is the default setting.

    Note:

    If promptForPrintMon is set to appendDoc and there is no document in the Working window, you are prompted to choose whether to use the virtually printed document to create a new document for upload or to save the virtually printed document as a template for another Document Type.

  • If promptForPrintMon is set to newDoc, then the virtually printed document is automatically saved as a template for another Document Type.

  • If promptForPrintMon is set to prompt, then you are prompted to choose whether to use the virtually printed document to create a new document for upload or save the virtually printed document as a template for another Document Type.

Note:

Setting promptForPrintMon to newDoc or prompt requires that your Front Office Scanning client is configured to have multiple input buttons (i.e., the multiplebuttons setting in the ScanOptions element is set to true).

Note:

If a PDF document is awaiting Document Type assignment in the Working window, then the virtually printed document is automatically saved as a template for another Document Type, regardless of the value set for the promptForPrintMon setting.

scanner

This setting allows you to specify a default scanner to use when a user is not prompted to select a scanner when scanning a document (i.e., the promptForFirstDevice setting is set to false).

Set the scanner setting to the name of the scanner or TOPAZ device that should be automatically used when a user clicks the Scan button.

Alternatively, to allow signatures to be created using a mouse pointer on workstations or a stylus on tablets, set the scanner setting to touchscreen.

If no value is present for the scanner setting, then the workstation's default TWAIN scanner is selected by default.

Note:

For individual Document Types, unless this setting's value is set to the name of a TOPAZ device to be used for a signature on file, this setting is overridden by the scanner setting in the DocTypes element.

multiplebuttons

This setting allows you display multiple input buttons in the Scan/Create Document window.

Note:

In order to create documents from image templates or to create an E-Form, the multiplebuttons setting must be set to true.

  • If multiplebuttons is set to false, the only available input button is the Scan button.

  • If multiplebuttons is set to true, multiple input buttons are displayed in t he Scan/Create Document window. When set to true, one input button is displayed for each Document Type button.

    When multiple input buttons are configured to be displayed, each input button is configured individually to use the settings needed for the specific document it is being used to scan/create.

In order to use the functionality offered by this setting, additional configuration is required. For more information, see Configuring Input Buttons.

onestep

Note:

This setting is used only when the Front Office Scanning client is configured to use multiple input buttons (i.e., the multiplebuttons setting is set to true).

When multiple input buttons are displayed in the Scan/Create Document window, an input button is displayed for each corresponding Document Type button.

  • If onestep is set to false, or if no value is present, a user clicks the input button to scan/create a document and then clicks a Document Type button to assign the document to the proper Document Type.

  • If onestep is set to true, the user clicks the input button to scan/create a document, and, once the document is scanned/created, the document is automatically assigned to the Document Type associated with the Document Type button that corresponds to the input button (i.e., the user does not have to click a Document Type button to assign the document to a Document Type).

The onestep setting in the ScanOptions element affects all input buttons on a global level. To configure the onestep function on an individual input button level, use the onestep setting in the DocType sub-element. For more information, see The DocTypes Element.

Note:

When this option is enabled, documents cannot be assigned to a Document Type other than the Document Type associated with the Document Type button that corresponds to the input button that was used to create the document.

Note:

The batchscan and onestep settings should not both be enabled. If both settings are enabled, the batchscan setting overrides the onestep setting.

In order to use the functionality offered by this setting, additional configuration is required. For more information, see Configuring Input Buttons.

batchscan

This setting allows you to enable batch scanning or the ability to create multiple documents from a single, multi-page image document.

  • If batchscan is set to true, then batch scanning and the ability to create multiple documents from an imported multi-page image is enabled.

  • If batchscan is set to false, then standard scanning/importing is used (i.e., each document that is scanned/imported, regardless of the number of pages, is treated as an individual document.

Note:

The batchscan and onestep settings should not both be enabled. If both settings are enabled, the batchscan setting overrides the onestep setting.

imagescale

This setting allows you to specify how pages are displayed, by default, in the Working window.

  • If imagescale is set to fitwidth, then documents in the Working window are displayed as Fit to Width by default.

  • If imagescale is set to fitheight, then documents in the Working window are displayed as Fit to Height by default.

  • If imagescale is set to fitimage, then documents in the Working window are displayed as Fit in Window by default.

  • If imagescale is set to fullsize, then documents in the Working window are displayed as their actual size.

Tip:

At any time documents can be displayed differently by clicking one of the Fit to... toolbar buttons or by selecting one of the View | Scale to... option in the Main Menu.

For more information on these display options, see The Front Office Scanning Toolbar.

Note:

The imagescale setting in the ScanOptions element sets the default behavior for how pages are displayed in the Working window for all pages/documents in the Front Office Scanning client. The imagescale setting can also be specified in the DocType element to determine how pages are displayed in the Working window once they are assigned to a Document Type. The imagescale setting in the DocType element overrides the imagescale setting in the ScanOptions element.

nativemode

Note:

This option requires that documents are being scanned into the Front Office Scanning client and that the scanner setting in the ScanOptions element is set to the name of the scanner used by the workstation.

This setting is used to control how information is passed from the scanner to the Front Office Scanning client.

By default, it is set to false. This allows the scanner to transfer data to the Front Office Scanning client using buffered transfer mode.

Tip:

Buffered transfer mode is the preferred method of transferring data from the scanner to the Front Office Scanning client.

Setting the nativemode setting to true allows the scanner to transfer data to the Front Office Scanning client using native transfer mode.

While not the preferred method of transferring data, native transfer mode is required for some older TWAIN devices.

Note:

If your Front Office Scanning client is configured to have multiple input buttons (i.e., the multiplebuttons setting in the ScanOptions element is set to true), then this option may be overridden at the Document Type level if the nativemode setting is set for the Document Type button.

hardwarecompress

Note:

This option requires that documents are being scanned into the Front Office Scanning client and that the scanner setting in the ScanOptions element is set to the name of the scanner used by the workstation. It is only used when the scanner is configured to transfer data to the Front Office Scanning client in native transfer mode (when the nativemode setting is set to true).

This setting is used to control how the scanner formats data when transferring it to the Front Office Scanning client in native transfer mode.

By default, the hardwarecompress setting is set to true. This allows the scanner to compress data before transferring it to the Front Office Scanning client.

If the hardwarecompress setting is set to true, but the scanner is not capable of compressing data, then the setting is ignored (i.e., it is treated as if it is set to false).

Setting the hardwarecompress setting to false prevents the scanner from compressing data; uncompressed data is passed from the scanner to the Front Office Scanning client.

Note:

If your Front Office Scanning client is configured to have multiple input buttons (i.e., the multiplebuttons setting in the ScanOptions element is set to true), then this option may be overridden at the Document Type level if the hardwarecompress setting is set for the Document Type button.

bitdepth

Note:

This option requires that documents are being scanned into the Front Office Scanning client and that the scanner setting in the ScanOptions element is set to the name of the scanner used by the workstation.

This setting sets the number of bits per pixel for each color plane (specified by the pixeltype setting) when scanning is initiated by clicking the input button associated with this Document Type button.

Acceptable values for the bitdepth setting are 1, 4, or 8.

Tip:

The higher the bitdepth, the more accurate the images will be.

Note:

If your Front Office Scanning client is configured to have multiple input buttons (i.e., the multiplebuttons setting in the ScanOptions element is set to true), then this option may be overridden at the Document Type level if the bitdepth setting is set for the Document Type button.