You are here: Setting up the system > Defining output > Output data

Output data

The following data is available for output from your solutions. Most of the variables listed here are used in XML output for example.

Specification

ID

The GUID of the specification.

CreateTime

The system date and time when the specification was created.

ChangeTime

The system date and time when the specification was modified last.

Name

The name of the specification.

CompoundDocument/Batch

Name

The name of the specification that the compound document, or batch, is based on.

ID

The compound document, or batch, GUID.

CreateTime

The system date and time when the compound document, or batch, was created.

ChangeTime

The system date and time when the compound document, or batch, was modified last.

Members

Count

The number of members included in the compound document/batch. A member can be a document or a compound document for example.

Document

Name

The name of the document specification the document is based on.

QueueName
The name of the queue, if any, that the document belongs to.

ID

The document GUID.

CreateTime

The system date and time when the document was created (scanned/read from file).

ChangeTime

The system date and time when the document was last modified.

NoOfAppendices

The number of appendices the document has.

AutoPageGroupStatus

ClosedThe automatic document separation status:

0 = Incomplete document

1 = Uncertain document

2 = Certain document

3 = Separator document

EmailFrom

The sender of the email. This attribute is only available if the input source is email.

EmailTo

The recipient of the email. This attribute is only available if the input source is email.

EmailSubject

The subject of the email. This attribute is only available if the input source is email.

EmailCC

Additional recipients of the email. This attribute is only available if the input source is email.

EmailMessage

The message body of the email. This attribute is only available if the input source is email.

Pages

Count

The number of Page members in the parent (Pages).

Page

IsAppendix

Specifies whether the page is an appendix.

PageNoInDocument

The page number within the document.

PageFlip

Specifies whether the page is flipped.

HasPageName

Specifies whether there is a file associated with the page.

OriginalFileName

The original path and file name of the page's source file.

PageFileName

The current path and file name of the page.

PageNoInFile

The page number within a multi-page file such as a multi-TIFF file. This value is set to zero if the file does not have multiple pages.

PageFileType

ClosedThe type of page file:

0 = Unknown

2 = PDF

3 = MS Word

4 = Text

5 = XML

10000 = Image*

10001 = TIFF image

10002 = TIFF image with G4 compression

10003 = TIFF image with G3 compression

10004 = TIFF image with LZW compression

10005 = TIFF image with JPEG compression

10100 = BMP image

10200 = JPEG image

10300 = MO:DCA image

10400 = DCX image

10500 = PNG image

10600 = JPEG2000 image

10700 = RAS image

10800 = GIF image

10900 = DjVu image

*Image type 10000 can be used in conjunction with the next setting, PageFileTypeVariant, to describe a user-defined image type.

PageFileTypeVariant

Describes additional information that can be necessary when accessing the file, for example, the PDF version.

ImprinterString

The endorser made by the scanner.

SheetNoWithinBatch

The page number within the batch.

CopyOfOriginalFile

The location of the original file (before it was enhanced).

Fields

Count

The number of Field members in the parent (Fields).

Field

FieldName

The name of the field specification the field is based on.

FieldNo

The number of the field.

FieldValue

The value of the field (as a string).

Scan

Name

The name of the specification.

ID

The GUID of the specification.

ScannerName

The name of the scanner.

DPI

The resolution of the scanner in dots per inch.

Brightness

The brightness of the scanner.

Vendor

The manufacturer of the scanner.

Contrast

The contrast of the scanner

Bit depth

The number of bits used to define each pixel.

Description

A description of the scanner.

Driver

The driver used to run the scanner.

AuditTrail

Count

The number of member Records in the parent (AuditTrail).

Records

User

The user who performed the production task or made the change.

DateTime

The system date and time when the change was made.

Task

The production task being performed at the time the change was made.

Details

Count

The number of member Structs in the parent (Details).

Structs

PropertyNumber

ClosedDescribes the type of change made, such as document status.

Document properties 510000-510999

510001 Document status

510002 Document type

510003 Document info  

510004 Batch info

510005 Document no in structure

510006 Document content

510007 Input type

510008 E-mail from

510009 E-mail to

510010 E-mail CC

510011 E-mail subject

510012 E-mail message

509999 Page created

509998 Page changed

509997 Page deleted

509996 Field created

509995 Field changed

509994 Field deleted

Batch Properties 500000-500999

500001 Batch Status

Field properties 520000-520999

520001 Field Status

520002 Value

520003 Field number

520004 Field index

520005 Page number

520006 Position

520007 Complementary value

520008 Error message

520009 Handwritten detected

520010 Document validated OK

520011 Position available

520012 Fast verification done

520013 Mass verification done

520014 Virtual

520015 Confirm document

520016 Mass verify

520017 Retype

520018 Override rules

519999 Created

519899 Internal content data

519898 Custom property changed

Page properties 530000-530999

530001 Page Status

530002 Page number in document

530003 Back page

530004 Filename

530005 Page number in file

530006 Original filename

530007 Original page number in file

530008 Filetype

530009 Filetype variant

530010 Page blob

530011 Blob type

530012 Blob type variant

530013 Sheet within batch

530014 Imprinter string

530015 Is appendice

530016 Is scanned

529999 Created

529899 Internal content data

529898 Custom property changed

Persistent boinstant properties -201-300

-201 Source type

-202 Sender name

-1 Status

 

Cause

ClosedThe cause:

0 = Unknown

1 = User

2 = Internal

3 = Validation

4 = Plugin

Type

ClosedThe value type:

0 = Undefined

1 = Boolean

2 = Integer

3 = Double

4 = String

5 = Inherited

6 = Blob

7 = Date and time

8 = Position (rectangle coordinates)

Value

The current value of the parent of the current AuditTrail.

PreviousValue

The value prior to the change.

InvoiceData (Included when document specifications are based on Invoice document templates.)

Invoice

All data from the Invoice extraction, which contains

  • Supplier
  • Buyer
  • Fields
  • Tables

Fields

Describes a collection of fields. Contains Field elements.

Field

Describes a field. Note: Date fields are formatted YYYYMMDD.

Tables

Contains Table elements.

Table

Describes a table. Contains TableRow elements.

System

Contains Field elements that describe system fields. One example of this is remarks that users added to invoices.

PartyType

Describes a supplier or buyer.

Output: Overview

Specifying XML output