Skip to main content

xSuite Interface Windows Prism 5.x – Online Help

Input System "Xtract"

The "Xtract" input system is used to read batches that have been exported to the file system by the IRISXtract application. Unlike other file-based input systems, xSuite Interface does not generate a separate status file for Xtract batches. Instead, xSuite Interface uses the status file already created by Xtract and changes the file extension.

The file extension reflects the internal processing state of xSuite Interface:

  • .xSI.working

  • .xSI.finished

  • .xSI.error

  • .xSI.suspended

  • .xSI.canceled

By default, only the page-related image files are read in as attachments to the documents in a batch. The various types of accompanying index files are not read in by default. If any of these files are also to be included, specify this explicitly in the .IncludeIndexFile[] property below. The following files are generally supported:

  • prop.txt (batch-, transaction-, document-, and page-related)

  • para.dat (batch-, transaction-, document-, and page-related)

  • result.xml (document related)

Batch- and transaction-related files are redundantly attached to each document in the batch.

Several of the page-related files (P{page}.txt and P{page}.dat) might exist, all of which are assigned to the document in question. In order to make the files prop.txt and para.dat, which have the same name at different levels, distinguishable for later processing, these files are implicitly given a name prefix. The name prefix identifies the level: batch_, unit_, doc_ and page_.

The content of the index files must be read downstream with a suitable index data reader:

  • File prop.txt: general CSV index data reader

  • File para.dat: XtractDat index data reader

  • File result.xml: general XML index data reader

Page-level index data refers to a file attachment, but the xSuite Interface data model provides for document-level index data only. However, by using the .ReadPageIndex[] property, this index data can be attached to file attachments in the form of free metadata.

Property

Description

InputSystem.SignalFolder*

Path of the directory monitored for signal files

The signal files flag the new batch to be read in.

InputSystem.DataFolder*

Path of the root directory in which the batch folders corresponding to the signal files with the data to be read in are located

InputSystem.SignalFileExt

File extension of the signal file, which identifies a batch, which is exported in finished form from Xtract and, as such, is to be read in by xSuite Interface

Default value: exported

InputSystem.IncludeIndexFile[]

Flags for the types of index files to be taken as file attachments (optional):

  • BatchProp: "prop.txt" at batch level

  • BatchPara: "para.dat" at batch level

  • UnitProp: "prop.txt" at operation level

  • UnitPara: "para.dat" at operation level

  • DocProp: "prop.txt" at document level

  • DocPara: "para.dat" at document level

  • PageProp: "P{Page}.txt" at page level

  • PagePara: "P{Page}.dat" at page level

  • ResultXml: "result.xml" at document level

InputSystem.ReadPageIndex[]

Names of fields from the page-related index files P{page}.txt and P{page}.dat, whose values are read and adopted as metadata of the file attachments (optional)

The field "Attachment" receives special treatment: if this field is read in and has the value true, the current as well as all following file attachments in the document are provided with the name suffix attach (e.g., P00000002FC.attach.jpg). In this way, pages that are marked as attachment pages in Xtract are also marked as such by name in xSuite Interface.