System field groups

The System field group contains the predefined properties and attributes that you can use for defining your document fields.

The System field group is only visible when consuming document type fields in TotalAgility Designer. It is not visible when maintaining document type.

Refer to the following table for system-defined properties available in the System field group.

Property/Attribute Name

Type

Description

Classification confident

Boolean

Determines if the low confidence documents should be routed to a different path.

Classification results

Collection

Collection of all classification results

Created at

Date

Document created date.

Error description

String

Error description of the runtime document validation.

Extension names

String

List of all extensions associated with the object.

Fields

Collection

Collection of field data

File name

String

File name of the email attachment. After ingesting an email attachment into TotalAgility, use the file name in a process, for example, as an input to a capture activity. At runtime, the file name of the email attachment is retrieved.

Has rejections

Boolean

Determines if there are one or more documents or pages with rejected flag within folder or document represented by the variable.

Image processing all pages detected blank

Boolean

Determines if all the pages in a document were blank and removed.

Image processing blank pages removed count

Number

Number of pages detected as blank and removed from the document.

Instance ID

String

ID of the runtime document.

Is locked

Boolean

Determines if a document is locked.

Is read only

Boolean

Determines if the runtime document is read only.

Is reclassified

Boolean

Determines if a document type is manually reclassified.

Last accessed at

Date

Last accessed date.

Locked at

Date

Document locked date.

Locked by

String

User that locked the document.

Mime type

String

Holds a string value that can be used in any process, for example, in a decision, or as an input/output to an activity.

At runtime, the MIME type of the associated document is used wherever this property has been used.

Name

String

Name of the runtime document.

No of pages

Number

Number of documents in the runtime folder.

Online learning comments

String

Online learning comments of the runtime document.

Online learning options

Boolean

Online learning options of the runtime document.

Original ID

String

Original document ID.

Original type ID

String

Initial classified document type ID.

Original type ID before redirection

String

Original document type used to redirect to the current document type, set in the Transformation Designer.

Pages

Collection

Collection of page objects contained in the document.

Parent ID

String

ID of the runtime parent folder.

Rejected

Boolean

Determines if the runtime document is rejected.

Rejected by failure

Boolean

Determines if a document is rejected due to some exception happened during execution within Transformation Server.

Rejection reason

String

Rejection reason of the runtime document.

Review Forced Valid

Boolean

Determines if the runtime document is forced valid (set during document review).

Review forced valid reason

String

Forced valid reason.

Review Valid

Boolean

Determines if the runtime document is valid (set during document review).

Separation proceeded

String

Unused, can be removed.

Source file ID

String

Source file ID.

Source file type

String

Source file mime type.

Type

String

Name of the document type.

Type ID

String

Document type ID.

Type version

Number

Document type (extraction group) version

Valid

Boolean

Determines if the runtime document is valid.

Validate all performed

Boolean

Unused, can be removed.

Variant ID

String

ID of the document variant that is applied.

Variant name

String

Name of the document variant that is applied.

Variant version

Number

Document variant version that is applied.

Verified

Boolean

Determines if the runtime document is verified.

Document/folder system properties of type collection

The following is the list of document/folder system properties of type collection.

Document.ClassificationResults

Contains complex array with 3 columns:

  • Confidence (Double)

  • Document Type Id (String)

  • Result Type (Integer)

Document.fields

Contains complex array with 5 columns:

  • Field Id (String)

  • Field Name (String)

  • Table Column Index (Integer)

  • Table Row Index (Integer)

  • Field Value (Object)

Document.Pages

Contains complex array with 1 column:

Page Id (String)

Folder.Documents

Contains complex array with 3 columns:

  • Document Id (String)

  • Document Display Name (String)

  • Document Type Name (String)

Folder.Folders

Contains complex array with 4 columns:

  • Folder Id (String)

  • Folder Display Name (String)

  • Folder Type Name (String)

  • Number Of Subfolders (Integer)