ImageProcessingSettings Element Attributes - Data Capture Server - English - Foundation 22.1 - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

Data Capture Server Deployment Guide

Platform
OnBase
Product
Data Capture Server
Release
Foundation 22.1
License
Standard
Essential
Premier

The ImageProcessingSettings element contains configuration options that control how image processing is conducted on this instance of the Data Capture Server.

<ImageProcessingSettings Enabled="false" ConcurrentCount="0" ProcessSpecificScanQueuesOnWorkstation="false" JPEGCompressionQuality="" WorkstationSpecificScanQueueID=""/>

The following attributes are found in the ImageProcessingSettings element:

<ImageProcessingSettings> Attributes

Description

Enabled

This setting controls whether image processing is enabled on this instance of the Data Capture Server.

By default, this setting is set to false, and this instance of the Data Capture Server does not perform image processing. If this setting is set to true, the Data Capture Server Windows Service automatically polls the Awaiting Image Processing queue at regular intervals and processes any documents there.

ConcurrentCount

This setting sets the number of documents that can undergo image processing simultaneously on this instance of the Data Capture Server.

By default, this setting is set to 0, which sets the number of concurrent documents equal to the total number of CPU cores in the workstation, including hyper-threading. For virtual environments, this value is the number of cores assigned to the client VM, not the host computer.

CAUTION:

Setting this value to more than double the number of CPU cores available may cause performance degradation due to over-saturation of available resources.

For example, consider a workstation with a total number of three CPU cores, including hyper-threading. If the value for ConcurrentCount is 0, then image processing can be performed on up to three documents at the same time. If the value for ConcurrentCount is 2, then image processing can be performed on up to two documents at the same time. In this example, setting ConcurrentCount to a value greater than 6 may cause performance degradation due to over-saturation of available resources.

ProcessSpecificScanQueuesOnWorkstation

This setting controls whether the workstation is limited to processing batches in specific scan queues enabled for image processing. This setting can be used to load-balance image processing scan queues to specific workstations.

By default, this setting is set to false, which allows this instance of the Data Capture Server to process batches in all scan queues enabled for image processing. If this setting is set to true, you must specify the scan queues to be processed using the WorkstationSpecificScanQueueID setting.

Note:

If this setting is set to true, but no scan queues are specified in the WorkstationSpecificScanQueueID setting, this instance of the Data Capture Server ignores all scan queues enabled for image processing.

JPEGCompressionQuality

This setting controls the compression of images created from non-image files during the Convert Documents to Image File Format process.

Note:

This setting has no impact on image files that enter the Convert Documents to Image File Format process. It only impacts image files that are generated from non-image files during the process. For more information on the Convert Documents to Image File Format process, see the Document Imaging module reference guide.

This setting is only respected when Use JPEG compressed TIFF as default color image format is enabled. For more information on the JPEG compressed TIFF as default color image format option, see the System Administration module reference guide.

Set this setting to a value from 1 to 100. For example, JPEGCompressionQuality="80 ". Higher numbers yield higher quality images, larger file sizes, and lower compression. Lower numbers yield lower quality images, smaller file sizes, and higher compression.

If no value, a value less than 1, or a value greater than 100 is entered, the Data Capture Server uses a default compression quality value of 70.

WorkstationSpecificScan QueueID

This setting is only respected if ProcessSpecificScanQueuesOnWorkstation is set to true.

This setting specifies the ID values of the scan queues to be used for image processing. To specify the scan queues that can be used for processing, set the value to the ID values of the appropriate scan queues, separating each ID value with a vertical bar (|). For example, WorkstationSpecificScanQueueID="101|103|205".