Description file

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, different file sets are used to form a batch.

Note: In addition to document images, you can also import and process files in office formats.

The program uses the following types of description file:

  1. Captiva QuickScan
    All the image files listed in the description file are added to the batch. The order of the image files in the batch is the same as in the description file.
  2. Capture Software for Kodak
    The image files that are located in the folder of the Kodak batch are added to the batch in the ascending order of the file names. The path to the folder from which images are added is specified in the Batch key of the Properties section of the *.ini description file:
[Properties]
BatchPath=\\computer\HotFolder\PathInHF"
    

Images from subfolders are also added to the batch.
Note: Registration parameters cannot be added to description files of this type.

  1. Empty file
    This file serves as a marker showing that a new batch must be created. The contents of the file are irrelevant, only the name is important. Images are added from the Hot Folder in alphabetical order. When a file with the name corresponding to the mask specified in the File name field is found, the system will create a new batch. Thus, if the *.dat mask was specified and the Hot Folder contains the following files:
    • Contract1.jpg
    • Contract2.jpg
    • Contract3.dat
    • Contract4.jpg
    • Contract5.jpg
    • Contract6.dat

a batch will be created for Contract1.jpg and Contract2.jpg files (when Contract3.dat is found), and another batch will be created for Contract4.jpg and Contract5.jpg files (when Contract6.dat is found).

  1. XML file
    This is an XML file that contains a documented structure. An XML file is used when the other three types cannot be used but a custom description file can be generated. The image files listed in the description file are added to the batch.

File structure

An XML document must contain a root element, Batch, with the following child elements: RegistrationParams, Documents, and Images.

The Images element must include Image elements, whose number corresponds to the number of pages in the batch that is being created.

The Batch element has the following tags:

  • Priority - the priority of the batch: Lowest, Low, Normal, High or Highest (This tag can be omitted. If priority is not specified, the priority specified in the import profile is used.)
  • Name - a desired batch name
  • TypeName - the name of the batch type (Applies if the Default batch type is specified in the import profile. If the Scanning Station output folder is used as a Hot Folder, the name specified in the tag must be the same as the name of the batch type on the Scanning Station. In this case, a batch of the specified type will be created.)
  • Attachments - batch attachments
  • SourceID - the string identifier of the batch source
  • Description - a description of the batch
  • RegistrationParams - the list of the batch registration parameters (Registration parameters from the description file are added to the registration parameters specified in the import profile.)
  • Documents - the list of documents (excluded from the automatic document assembly)
  • Images - the list of separate pages (included in the automatic assembly)

The Document element has the following tags:

  • Index (mandatory attribute) - the index of the document in the batch (numbering starts from zero)
  • Priority - the priority of the document: Lowest, Low, Normal, High or Highest (This tag can be omitted.)
  • Name - the name of the document
  • Barcode - the barcode value
  • RegistrationParams - the list of document registration parameters
  • Attachments - document attachments
  • Images - the list of document pages

The Parameter element (child of the RegistrationParams element) has the following tags:

  • Name (attribute) - the name of the registration parameter
  • Value - the value of the registration parameter

The Image element has the following tags:

  • Index (mandatory attribute) - the index of the page (the corresponding document for pages of the Images element) in the document (the documents of the batch). Numbering starts from zero.
  • PageIndex (attribute) - the page number in a multipage import file (numbering starts from zero)
  • SourcePath (attribute) - the path to a folder with source images
  • SourceFile (attribute) - the source file with the page image (path relative to SourcePath)
  • SourceFilePageIndex (attribute) - the page number in a multipage source file (numbering starts from zero)
  • SourceDetails (attribute) - a description of the source (name of scanner)
  • Attachments - page attachments
  • Value - the path to the import file specified for a page relative to the Hot Folder

The Attachment element has the following tags:

  • Name - the name of the attachment (If no name is specified, the name of the source file will be used.)
  • Value - the path to the attachment (Paths relative to the HotFolder root can be specified.)

We recommend setting up the scanning program so that scanned images are placed into the Hot Folder itself or into its first-level subfolders. When creating a batch, the program will add to it all the images listed in the Image elements of the corresponding description file. The images will be added in the order in which they are arranged in the description file.

The order of the image files in the batch is the same as in the description file.

11/10/2020 12:08:04 PM


Please leave your feedback about this article