Configuration File

This attribute specifies how a station connects to the server. Its value can be either true or false. If the value is true, the station will establish a local connection to the server whenever possible. If the value is false, RPC is used to establish a connection. Interaction between the server and the station is faster if a local connection is established. If you update from an earlier version that does not have this attribute, the attribute will be created and its value will be set to true. If the earlier already has this attribute, its value will not be changed.

Location in Configuration.xml: <OCRServer> → <QueueManager> → <OCRStations> → <OCRStation>

The console has a Deskew option. Deskewing corrects the skew angle of an image during preprocessing. Text can be deskewed based on either horizontal or vertical text lines.

• The IsSearchSkewByHorizontalTextEnabled attribute of the <ImageProcessingParams> element enables deskewing based on horizontal text lines.
• The IsSearchSkewByVerticalTextEnabled attribute of the <ImageProcessingParams> element enables deskewing based on vertical text lines.

The IsSearchSkewByHorizontalTextEnabled and IsSearchSkewByVerticalTextEnabled attributes can be either true or false. The default value is true. Both attributes cannot be set to false if the Deskew option in the console is enabled. If both attributes are set to false and the Deskew option is enabled, the "Incorrect deskew parameters" error message will appear. If the Deskew option is disabled, these parameters will be ignored.

Location in Configuration.xml: <OCRServer> → <QueueManager> → <Workflows> → <WorkflowSettings> → <InputSettings> → <DefaultJob> → <ImageProcessingParams>

This attribute is used to preserve the page breaks when saving results to DOC, RTF, and DOCX. It can be either true or false. The default value is false.

Location in Configuration.xml: <OCRServer> → <QueueManager> → <Workflows> → <WorkflowSettings> → <InputSettings> → <DefaultJob> → <ExportParams> → <ExportFormat>

This attribute specifies the time interval before a document which has arrived at the Verification Station of one of the operators becomes available to the other verifiers.

The value of the attribute must be a positive integer. The default value is 120 (measured in minutes).

Location in Configuration.xml: <OCRServer> → <QueueManager>

This attribute is used to specify when the processes that perform the main jobs on a Processing Station should be restarted. The value of this attribute is the amount of pages that must be processed in order to trigger a reset. The default value is 5,000 pages. The OCRProcessor.exe processor has to be reset from time to time to insure round-the-clock reliability of the server.

Note. Processed pages are expected to be A4-sized pages. When larger pages are processed, the value of the counter increases proportionally to the size of these pages. If pages with barcodes are used to split documents, the number of pages with barcodes is multiplied by two and added to the total page count.

Location in Configuration.xml: <OCRServer> → <QueueManager> → <OCRStations> → <OCRStation>

When processing a job, ABBYY FineReader Server splits documents into portions (also termed slices), each of which is processed by a separate processor core. The PagesSlice attribute of the <DefaultJob> element specifies how many pages from a job will be processed by one processor core. By default, the document is split into 25-page slices. The minimum slice size is 5 pages.

Here are three examples of how ABBYY FineReader Server handles multi-page documents.

• A station with a quad-core processor receives a document of 100 pages. The document is split into 4 slices containing 25 pages each (as per the default settings). One of the four slices is assigned to each of the four processor cores, and the processing of each slice takes the same amount of time, let's say a minute.
• The same 100-page file is assigned to a station with a 32-core processor. It is split into four slices of 25 pages each, just like in the previous example, and each of these slices is assigned to a core, taking a minute to process while the remaining 28 cores stay idle.
• A station with a quad-core processor receives a 20-page document. It is processed by one core since it is smaller than the default slice of 25 pages. It could be processed much faster if it was divided into four parts.

You can significantly increase the productivity of ABBYY FineReader Server by changing this attribute to take document size and the number of processing cores into account.

Note. Decreasing the slice size increases the number of slices, thus increasing the time spent on transferring slices. Tests have shown that the optimal slice size is 25 pages.

If your workflow uses a document separation script, document slicing will be forbidden and the PagesSlice attribute will be automatically set to -1. Removing the document separation script from the workflow will allow document slicing and reset the PagesSlice attribute to its default value of 25.

You can forbid document slicing by setting the PagesSlice attribute either to -1 or to 0:

• -1 forbids document slicing only if a document separation script is detected in the workflow properties. If no document separation script is detected, the setting will be changed from -1 to 25 and documents will be sliced.
• 0 always forbids document slicing. To turn slicing back on, you will need to change the value of the PagesSlice attribute manually.

Location in Configuration.xml: <OCRServer> → <QueueManager> → <Workflows> → <WorkflowSettings> → <InputSettings> → <DefaultJob>

When saving processing results to PDF, an export profile is used. An export profile is a collection of settings that affect the quality and size of the output file and the speed of processing. An export profile can be specified in the Scenario attribute of the ExportFormat tag. The following profiles are available: Balanced, MaxSpeed, MaxQuality, and MinSize. The default profile is Balanced.

Location in Configuration.xml: <OCRServer> → <QueueManager> → <Workflows> → <WorkflowSettings> → <InputSettings> → <DefaultJob> → <ExportParams> → <ExportFormat>

If an input PDF document contains a text layer of sufficiently good quality and the output format is set to PDF, the input file can be exported without any editing or verification. To do so, select the No verification mode and the Do not modify files with high quality text layer option in workflow settings. The SkipRecognizePdfsWithTextLayer attribute will be set to true if this option is enabled, and false if it is disabled. The default setting is false.

Location in Configuration.xml: <OCRServer> → <QueueManager> → <Workflows> → <WorkflowSettings> → <InputSettings> → <DefaultJob> → <ExportParams> → <ExportFormat>  

The SkipRecognizePdfsWithTextLayerCoefficient attribute determines the text layer quality detection method for input PDF documents. Quality is measured in percent.

• Setting this attribute to -1 sets the quality detection method to Fast.
• If the Thorough detection mode is selected, the attribute's value will default to 5. You can manually assign any value from 0 to 100 to this attribute.

Note. The SkipRecognizePdfsWithTextLayerCoefficient attribute is ignored if Extract text from pictures is selected in the workflow properties.

Location in Configuration.xml: <OCRServer> → <QueueManager> → <Workflows> → <WorkflowSettings> → <InputSettings> → <DefaultJob> → <ExportParams> → <ExportFormat>

The ProhibitHiddenTextDetection attribute is used for specifying the processing settings for input documents. This attribute can be set to either true or false. The default setting is true.

• When this attribute is set to true, the basic processing settings are used and text in pictures contained in input documents will not be recognized.
• When this attribute is set to false, the program will recognize text in pictures and create a text layer in the output document.

Location in Configuration.xml: <OCRServer> → <QueueManager> → <Workflows> → <WorkflowSettings> → <InputSettings> → <DefaultJob> → <RecognitionParams>

The TiffMaxBrokenLastLinesCount attribute allows the processing of damaged TIFF files. Its value determines the number of lines in a TIFF file starting from the last line that should be ignored when calculating the quality of the document. The default value is 1.

If this attribute is set to 0, TIFF files in which damaged lines are detected will not be processed. When the program encounters a damaged file, it will record an error in the task log. Setting this attribute to 1 or greater allows errors in the corresponding number of lines at the end of a document. The program will attempt to process TIFF files with errors, but a warning message will be displayed.

Location in Configuration.xml: <OCRServer> → <QueueManager> → <Workflows> → <WorkflowSettings> → <InputSettings> → <DefaultJob> → <ImageProcessingParams>

The EnablePeriodicCrawling attribute allows scheduling regular checks for new files in Document Library workflows. Setting this attribute to true has the same effect as selecting the Crawl the library for new files every: N units of time option on the 1. Input tab of Workflow Properties dialog box. The default setting is false.

Location in Configuration.xml: <OCRServer> → <QueueManager> → <Workflows> → <WorkflowSettings> → <InputSettings>

The CrawlingInterval attribute specifies the time period between checks for new files in Document Library workflows. The value of this attribute designates the time interval between checks. The default value is 7,200,000 (measured in milliseconds).

Location in Configuration.xml: <OCRServer> → <QueueManager> → <Workflows> → <WorkflowSettings> → <InputSettings>

The BackgroundColorDetectionType specifies the fill color for blank areas that appear after an image is deskewed. Possible values:

• Auto (default value). The fill color is selected automatically based on the image.
• FillBlack. Black fill color is used.
• FillWhite. White fill color is used.
• Custom. The fill color specified by the user is used. The user can specify RGB values ranging from 0 to 255 for red, green, and blue.

Note. Any RGB numbers specified by the user will be ignored if BackgroundColorDetectionType is set to a value other than Custom.

Note. In the case of grayscale images, the specified fill color will also be converted to grayscale.

Location in Configuration.xml: <OCRServer> → <QueueManager> → <Workflows> → <WorkflowSettings> → <InputSettings> → <ImageProcessingParams> →<BackgroundColorDetectionParams>

Pages of multi-page documents arrive at the Indexing Station in sets of n pages. The IndexingStationPagesSlice attribute specifies the number of pages in each set. Possible values:

• 1 and greater. By default, the attribute is set to 5, i.e. no more than the first five pages of a document are fed to the Indexing Station. The operator then has a choice of loading the next set of 5 pages or the entire document.
• -1. Documents are always fed to the Indexing Station in their entirety.

Location in Configuration.xml: <OCRServer> → <QueueManager> → <Workflows> → <WorkflowSettings> → <InputSettings> → <DefaultJob> → <IndexingSettings>

If the output format settings indicate that output files must be sent to an e-mail inbox, the output files will not be sent to addresses in the To field by default. A setting that can enable sending files to addresses from the To field and specify a list of address exceptions has been added to the <ExportFormat> element.

• The ReplyToAddressesInToList attribute can be set to true in order to send files to addresses in the To field. Its default value is false.
• If you do not want files to be sent to specific addresses, add these addresses to the ExcludedAddresses child element. This child element has the string type and will only work if ReplyToAddressesInToList is enabled.

These parameters will only work if EmailSelectionMethod="ReplyToSender", which is the same as enabling the Reply to all option.

Location in Configuration.xml: <OCRServer> → <QueueManager> → <Workflows> → <WorkflowSettings> → <InputSettings> → <DefaultJob> → <ExportParams> → <ExportFormat>

The TextExtractionMode attribute enables/disables special processing for technical drawings. The attribute may be set to false or true:

• false disables special processing for technical drawings; only the basic processing settings will be used.
• true enables special processing for technical drawings.

Location in Configuration.xml: <OCRServer> → <QueueManager> → <Workflows> → <WorkflowSettings> → <InputSettings> → <DefaultJob> → <RecognitionParams>

The AllowedBarcodes can be used to restrict the set of barcode types that the program will use for document separation. Be default, all barcode types are allowed and there is  no AllowedBarcodes attribute in the configuration file. To restrict document separation to specific barcode types, add them to the configuration file, enclosing their names in the <AllowedBarcodes> </AllowedBarcodes> tags. For example:

<AllowedBarcodes>Code39</AllowedBarcodes>
<AllowedBarcodes>Datamatrix</AllowedBarcodes>

For the names of supported barcodes, please refer to Scripting Objects > BarcodeTypeEnum.

Important!

• Do not use the ВТ_ prefix in the names of constants.
• Do not specify Unknown as the value of the AllowedBarcodes attribute.

When you add a list of allowed barcodes to the configuration file, barcode detection will work as follows:

• If Any type is selected for the type of barcode on the 3. Document Separation tab of the Workflow Properties dialog box, the program will only look for the barcode types you specified in the configuration file.
• If a specific type of barcode on the 3. Document Separation tab of the Workflow Properties dialog box, the program will look for this  type of barcode and for the barcode types you specified in the configuration file.

Location in Configuration.xml: <OCRServer> → <QueueManager> → <Workflows> → <WorkflowSettings> → <InputSettings> → <DefaultJob> → <RecognitionParams>

The MaxJobsCount attribute sets the number of jobs allowed in the processing queue. We recommend specifying a value that is twice the number of Processing Stations in the group whose jobs are queued.

The default value of the attribute is 50. This setting covers most FineReader Server configurations, which have up to 25 Processing Stations. If your configuration uses more than 25 Processing Stations, increase the number of jobs allowed in the queue accordingly to prevent Processing Stations from standing idle.

Location in Configuration.xml: <OCRServer> → <QueueManager>