Welcome > Capture > Extraction groups > Field groups > System field groups

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 types.

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

Property/Attribute Name

Type

Description

Instance ID

String

ID of the runtime document.

Name

String

Name of the runtime document.

Type

String

Name of the document type.

Parent ID

String

ID of the runtime parent folder.

No of Pages

Number

Number of documents in the runtime folder.

Valid

Boolean

Determines if the runtime document is valid.

Error Description

String

Error description of the runtime document validation.

Review Valid

Boolean

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

Review Forced Valid

Boolean

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

Verified

Boolean

Determines if the runtime document is verified.

Rejected

Boolean

Determines if the runtime document is rejected.

Rejection Reason

String

Rejection reason of the runtime document.

Is Read Only

Boolean

Determines if the runtime document is read only.

Online Learning Options

Boolean

Online learning options of the runtime document.

Online Learning Comments

String

Online learning comments of the runtime 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.

Classification Confident

Boolean

Routes low confidence documents to a different path.

Has Rejections

Boolean

When this value is true, it means that there are one or more documents or pages with rejected flag within folder or document represented by the variable.

Rejected by Failure

Boolean

When this value is true, it means that document is rejected due to some exception happened during execution within Transformation Server.

Fields

Collection

Collection of field data

Classification Results

Collection

Collection of all classification results

Created at

Date

Document created date.

Extension Names

String

List of all extensions associated with the object.

Last Accessed at

Date

Last accessed date.

Pages

Collection

Collection of page objects contained in the document.

Type Id

String

Document type ID.

Type Version

Number

Document type (extraction group) version

Separation Proceeded

String

Unused, can be removed.

Source Field Id

String

Source file ID.

Source File Type

String

Source file mime type.

Validate All Performed

Boolean

Unused, can be removed.

Review Forced Valid Reason

String

Forced valid reason.

Original Id

String

Original document ID.

Original Type Id

String

Initial classified document type ID.

Original Type Id Before Redirect

String

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

Is Reclassified

Boolean

Flag representing if a document type is manually reclassified.

Is Locked

Boolean

Flag representing if a document is locked.

Locked At

Date

Document locked date.

Locked By

String

User that locked the document.

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.

Variant Name

String

Name of the document variant that is applied.

Variant Id

String

ID of the document variant that is applied.

Variant Version

Number

Document variant version that is applied.

Image Processing

All Pages Detected Blank

Boolean

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

Image Processing

Blank Pages Removed Count

Number

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

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)

See also: