Configuring Scanning Options at the Document Type Level - 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

Several scanning-specific options can be configured at the Document Type level using settings in the DocType sub-element of the Front Office Scanning configuration file. They only affect documents that are scanned (not documents that are created from an image template or E-Forms).

These settings require that your Front Office Scanning client be configured to have multiple input buttons (i.e., the multiplebuttons setting in the ScanOptions element is set to true).

A brief summary of the options is displayed below. For specific information on the options, see The DocTypes Element.

Setting

Description

Potential Values

SkipADF

This setting enables the Front Office Scanning client to ignore the error message that is displayed when no documents are loaded into the scanner's ADF.

When skipadfcheck is set to true, the error message is ignored.

When skipadfcheck is set to false, or if no value is present, an error message is displayed when no documents are loaded into the scanner's ADF.

Note:

This setting must be set to true when using a Kofax VRS TWAIN driver.

AutoFeed

This setting allows you to enable autofeed mode for your scanner (if it is not automatically enabled) when scanning is initiated by clicking the input button associated with this Document Type button.

If autofeed is set to true, autofeed mode is enabled for your scanner.

If autofeed is set to false, autofeed mode is not enabled for your scanner.

ShowUI

This setting determines if the TWAIN driver user interface is displayed at the time of scanning when scanning is initiated by clicking the input button associated with this Document Type button.

If showui is set to true, then the TWAIN driver user interface is displayed when a document is scanned.

If showui is set to false, or no value is present, then the TWAIN driver user interface is not displayed when a document is scanned.

Duplex

This setting determines if duplex or simplex scanning is used when scanning is initiated by clicking the input button associated with this Document Type button.

If duplex is set to true, this input button scans documents using duplex scanning.

If duplex is set to false, this input button scans documents using simplex scanning.

PaperSize

This setting sets the size of the page being scanned for the Front Office Scanning client.

Acceptable values are Legal, Letter, Card, A3, A4, A5, A6 and B5.

Brightness

This setting controls the brightness level of the scanner when scanning is initiated by clicking the input button associated with this Document Type button.

Set the brightness setting to a value between -1000 and 1000. The value is scaled by the scanner to fit within its supported range.

Contrast

This setting controls the contrast level of the scanner when scanning is initiated by clicking the input button associated with this Document Type button.

Set the contrast setting to a value between -1000 and 1000. The value is scaled by the scanner to fit within its supported range.

Orientation

This setting controls the angle to which the scanner will rotate pages when scanning is initiated by clicking the input button associated with this Document Type button.

Acceptable values for the orientation setting are 0, 90, 180, or 270.

Tip:

The values for orientation and rotation are cumulative. For example, if you set both orientation and rotation to 90, pages are rotated a total of 180 degrees.

Rotation

This setting controls the how much the scanner automatically rotates pages when scanning is initiated by clicking the input button associated with this Document Type button

The value entered for the rotation setting works in addition to the value specified for orientation setting and allows you to rotate images using smaller degree units.

Acceptable values for the rotation setting are between - 360 and 360.

Tip:

The values for orientation and rotation are cumulative. For example, if you set both orientation and rotation to 90, pages are rotated a total of 180 degrees.

BackRotation

This setting controls the how much the scanner automatically rotates the reverse side of pages when duplex scanning is initiated by clicking the input button associated with this Document Type button

The backrotation setting is used when the back of an page scanned in duplex needs to be rotated in the differently than the front of the page.

Acceptable values for the backrotation setting are between - 360 and 360.

If the Backrotation setting is not configured for a document scanned in duplex, the rotation setting controls how the reverse side of the image is rotated.

Note:

If the duplex setting is not set or is set to false, the backrotation setting is ignored.

Note:

If the duplex setting does not match the duplex setting in the TWAIN user interface, the backrotation setting does not operate as expected.

Threshold

This setting sets the threshold level of the scanner.

This setting can be used for scanning documents or when converting E-Forms to images if the resulting images are configured to be bi-tonal (i.e., the pixeltype setting is set to bw.)

Set the threshold setting to a value between 0 and 255. The value is scaled by the scanner to fit within its supported range.

BlankThreshold

This setting allows you to specify the minimum file size an image must be in order not to be considered blank.

Set the blankthreshold setting to the number of bytes a page must be in order not to be considered blank. By default, this setting is set to 0, which indicates that no images are discarded.

  • If the file size of the page is equal to or greater than the blankthreshold value, it is recognized as a valid page.

  • If the file size of the page is less than the blankthreshold value, it is discarded.

NativeMode

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

Note:

This setting overrides the NativeMode setting in the ScanOptions section of the configuration file.

By default, the NativeMode setting 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.

HardwareCompress

This setting is used to control how the scanner formats data when transferring it to the Front Office Scanning client in native transfer mode (i.e., when the nativemode setting is set to true).

Note:

This setting overrides the HardwareCompress setting in the ScanOptions section of the configuration file.

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.

For information on additional options that affect scanned documents that can be set at the Document Type level, see Configuring General Document Options at the Document Type Level.