The SCANFORMAT Sub-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 SCANFORMAT sub-element contains the configuration information (e.g., the file format to be used for the scanned images, the scanning device to be used, the resolution of the scanned images, etc.) for an individual scan format.

Multiple SCANFORMAT sub-elements may compose the SCANFORMATS element, allowing multiple scan formats to be available for each Express Scanning solution. One scan format is assigned per button, or per the type of document being scanned.

<SCANFORMAT formatname="TWAIN" scanmethod="TWAIN" scandevice="Default" kofaxinput="" fileformat="tiff/g4" inputpath="" colormode="b/w" papersize="letter" duplex="false" autofeed="true" showui="false" blankthreshold="0" rotation="0" resolution="200" brightness="0" contrast="0" threshold="0" forceclose="false" nativemode="false" hardwarecompress="true" />

Tag

Description

formatname

This setting is used to assign a name to the scan format.

The formatname setting is used in the BUTTON sub-element to assign a scan format to the button.

scanmethod

The setting controls the method of scanning being used.

The scanmethod setting must be set to TWAIN, Kofax, ISIS or Sweep (for example, scanmethod="TWAIN", scanmethod="Kofax", scanmethod="ISIS", or scanmethod="Sweep").

scandevice

This setting identifies the device being used to scan documents via the Express Scanning client.

The scandevice setting must be set to the name of the scanning device's driver (that is, scandevice="Scanner_Driver_Name") or to default (that is, scandevice="default") to use the workstation's default scanning device.

If you are configuring the scan format to use a TWAIN scanner (scanmethod="TWAIN"), you can also set the scandevice setting to ask. When the scandevice setting is set to ask, the user will be prompted to select a TWAIN scanner to use for the duration of the session.

If you are configuring a scan format to scan from disk, you must set the scandevice setting to File Import (scandevice="File Import").

kofaxinput

Note:

This setting is only used if you are configuring the scan format to use a Kofax scanner (scanmethod="Kofax").

This setting distinguishes between scanning a paper document and scanning from disk when using a Kofax scanner.

The kofaxinput setting must be set to scanner (kofaxinput="scanner") when scanning paper documents or disk (kofaxinput="disk") when scanning from disk.

fileformat

This setting controls the file format used to store the scanned image. The available file formats are TIFF Group IV, TIFF Group III, TIFF-RAW or JPEG.

The fileformat setting must be set to t iff/g4, tiff/g3, tiff/raw or jpeg (e.g., fileformat="tiff/g4", fileformat="tiff/g3", fileformat="tiff/raw", or fileformat="jpeg".)

Note:

If your scanner is configured to scan in color or grayscale and you are attempting to scan documents using a TIFF Group IV file format, the fileformat setting is ignored and documents are saved using the JPEG file format because the Group IV TIFF file format does not support grayscale or color images.

inputpath

Note:

This setting is only used if you are configuring the scan format to sweep a document or scan from disk.

This setting sets the default path to the document that will be swept or scanned from disk into OnBase.

The path must be written as a full path (i.e., inputpath="C:\AP_Docs\invoice.jpg").

colormode

This setting controls the color setting of the scanned image. The available color settings are black and white, grayscale and color.

The colormode setting must be set to b/w, grayscale or color (e.g., colormode="b/w", colormode="grayscale", or colormode="color").

papersize

This setting controls the expected size of the scanned image. The available document sizes are letter (8.5”x11”), legal (8.5”x14”) and card (3.5”x2”).

The papersize setting must be set to letter, legal or card (e.g., papersize="letter", papersize="legal", papersize="card").

duplex

This setting determines if the document should be scanned in duplex (dual-sided) or simplex (single-sided) mode.

To scan in duplex mode, set the duplex setting to true (i.e., duplex="true"). To scan in simplex mode, set the duplex setting to false (i.e., duplex="false").

autofeed

This setting determines if the Express Scanning client should expect multiple pages to be scanned at once via a scanner with an Automatic Document Feeder (ADF) or if it should expect pages to be scanned one at a time.

To scan multiple pages at once via a scanner with an ADF, set the autofeed setting to true (i.e., autofeed="true"). To scan one page at a time, set the autofeed setting to false (i.e., autofeed="false").

showui

This setting determines if the scanner's user interface is displayed or hidden before a document is scanned.

Note:

This setting only applies to a TWAIN scan format.

To display the scanner's user interface before scanning, set the showui setting to true (showui="true"). To hide the scanner's user interface before scanning, set the showui setting to false (showui="false").

For more information on the scanner's user interface, see your scanner's documentation.

blankthreshold

This setting determines the level at which a scanned image is determined to be blank, and thus deleted.

If the size of the image file, in bytes, is less than the value of the blankthreshold setting, then the image is determined to be blank and is deleted.

If the size of the image file, in bytes, is larger than the value of the blankthreshold setting, then the image is saved as a document.

For example, if blankthreshold="2000", then any scanned image that is less than 2000 bytes would be considered blank and would be deleted.

Tip:

A value of 1500-2500 bytes is considered normal for the blankthreshold setting.

rotation

This setting allows you to automatically rotate documents a specified amount after they are scanned.

The value of the rotation setting is the number of degrees the document is rotated clockwise.

For example, if rotation="180", then any page scanned using this scan format would be automatically rotated 180 degrees from the orientation at which it was scanned.

resolution

This setting determines the resolution in dots per inch (dpi) at which documents are scanned. By default, this value is set to 200 dpi.

Tip:

If you are planning to perform any additional processing, such as OCR or Bar Code Processing, on the document after scanning, it is considered a best practice to use a resolution of at least 300 dpi.

brightness

This setting determines the brightness of the scanned image.

This setting is scanner-dependent. By default, it is set to 0 (brightness="0").

contrast

This setting determines the contrast of the scanned image.

This setting is scanner-dependent. By default, it is set to 0 (contrast="0").

threshold

This setting determines the threshold of the scanned image.

This setting is scanner-dependent. By default, it is set to 0 (threshold="0") to use the scanner's default setting.

Likewise, if the threshold setting is not present, the scanner's default threshold setting is used.

forceclose

Note:

This optional setting is only used by scan formats configured to use the TWAIN scanning method (i.e., scanmethod="TWAIN").

This setting, when enabled, is used to force the TWAIN scanner to send a message to the Express Scanning client to indicate when the last page of the document has been scanned.

By default, this setting is set to False.

Note:

This setting should only be used with TWAIN scanners that do not automatically indicate when scanning is complete to prevent the Express Scanning client from becoming unresponsive while waiting for additional information from the scanner.

nativemode

Note:

This setting is only used by scan formats configured to use the TWAIN scanning method (i.e., scanmethod="TWAIN").

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

By default, it is set to true (nativemode="true"). This allows the scanner to transfer data to the Express Scanning client using native transfer mode.

Tip:

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

Set this setting to false (nativemode="false") to allow the scanner to transfer data to the Express Scanning client using buffered transfer mode.

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

Note:

When upgrading from an older database, existing scan formats will default to native transfer mode to ensure forward compatibility. Newly-created scan formats will default to buffered transfer mode, which should be used unless it causes problems with your scanner.

hardwarecompress

Note:

This setting is only used by scan formats configured to use the TWAIN scanning method (i.e., scanmethod="TWAIN") and the buffered data transfer mode (i.e., nativemode="true"). It is ignored by all other scan format configurations.

This setting is used to control if the scanner compresses data before passing it to the Express Scanning client.

By default, it is set to true (hardwarecompress="true"). This allows the scanner to compress the data before passing it to the Express 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).

Set this setting to false (hardwarecompress="false") to prevent the scanner from compressing the data; the scanner will pass uncompressed data to the Express Scanning client.