Skip to main content
A description file is an auxiliary file that defines how a batch is formed when images are added from a Hot Folder. Depending on the format of the description file, ABBYY FlexiCapture uses different file sets to form a batch.
In addition to document images, you can also import and process files in office formats.

Description file types

ABBYY FlexiCapture supports four types of description file.

Captiva QuickScan

All the image files listed in the description file are added to the batch, in the same order as in the description file.

Capture Software for Kodak

The image files in the Kodak batch folder are added to the batch in ascending order of file name. Specify the path to the folder in the Batch key of the Properties section of the .ini description file:
Images from subfolders are also added to the batch.
You cannot add registration parameters to description files of this type.

Empty file

This file is a marker that a new batch must be created. Only the file name matters. The contents are irrelevant. Images are added from the Hot Folder in alphabetical order. When ABBYY FlexiCapture finds a file whose name matches the mask specified in the File name field, it creates a new batch. For example, if you specify the *.dat mask and the Hot Folder contains these files:
  • Contract1.jpg
  • Contract2.jpg
  • Contract3.dat
  • Contract4.jpg
  • Contract5.jpg
  • Contract6.dat
ABBYY FlexiCapture creates one batch for Contract1.jpg and Contract2.jpg (when it finds Contract3.dat), and another for Contract4.jpg and Contract5.jpg (when it finds Contract6.dat).

XML file

This is an XML file with a documented structure. Use it when the other three types cannot be used but you can generate a custom description file. The image files listed in the description file are added to the batch.

File structure

An XML description file must contain a root Batch element with the following child elements: RegistrationParams, Documents, and Images. The Images element must include one Image element for each page in the batch being created.

Batch element

Document element

Parameter element

The Parameter element is a child of the RegistrationParams element.

Image element

Attachment element

Set up your scanning software so that scanned images are placed into the Hot Folder itself or into its first-level subfolders. When ABBYY FlexiCapture creates a batch, it adds all the images listed in the Image elements of the corresponding description file, in the order in which they appear in the description file.