System field group for document

The System field group for a document 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 the document type.

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

Property/Attribute Name	Type	Description
Bar codes	Data object	You can map this property to a variable of Data object type which has a "Document bar code" value.
Classification confident	Bool	Determines if the low-confidence documents should be routed to a different path.
Classification results	Complex	Collection of all classification results
Created at	Date	Document created date.
Error description	String	Error description of the runtime document validation.
Extension names	Array	List of all extensions associated with the object.
Fields	Complex	Collection of field data
File name	String	The 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	Bool	Determines if there are one or more documents or pages with rejected flags within the folder or document represented by the variable.
Image processing all pages detected blank	Bool	Determines if all the pages in a document were blank and removed.
Image processing blank pages removed count	Short	The number of pages detected as blank and removed from the document.
Instance ID	String	The ID of the runtime document.
Is locked	Bool	Determines if a document is locked.
Is read only	Bool	Determines if the runtime document is read-only.
Is reclassified	Bool	Determines if a document type is manually reclassified.
Last accessed at	Date	Last accessed date.
Locked at	Date	Document locked date.
Locked by	String	The 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	Long	The number of pages in the runtime folder.
Online learning comments	String	Online learning comments of the runtime document.
Online learning options	Short	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	Complex	Collection of page objects contained in the document.
Parent ID	String	The ID of the runtime parent folder.
Patch codes	Complex	Allows separation of documents.
Rejected	Bool	Determines if the runtime document is rejected.
Rejected by failure	Bool	Determines if a document is rejected due to some exception that 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	Bool	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	Double	Document type (extraction group) version
Valid	Bool	Determines if the runtime document is valid.
Validate all performed	Bool	Unused, can be removed.
Variant ID	String	The ID of the document variant that is applied.
Variant name	String	Name of the document variant that is applied.
Variant version	Double	Document variant version that is applied.
Verified	Bool	Determines if the runtime document is verified.

Document system properties of type collection

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

Document.ClassificationResults	Contains a complex array with three columns: Confidence (Double) Document Type Id (String) Result Type (Integer)
Document.fields	Contains a complex array with five columns: Field Id (String) Field Name (String) Table Column Index (Integer) Table Row Index (Integer) Field Value (Object)
Document.Pages	Contains a complex array with one column: Page Id (String)
Document.Barcodes	Describes the bar code structure within the document object. The structure of the data model can be similar to the following example. `{ DocBarcodes: [ { PageId: <page identifier>, PageIndex: <page index>, Barcodes: [ { <barcode type>, <barcode value> }, { <barcode type>, <barcode value> } ] }, { PageId: <page identifier>, PageIndex: <page index>, Barcodes: [ { <barcode type>, <barcode value> }, { <barcode type>, <barcode value> }, { <barcode type>, <barcode value> } ] } ] }`
Document.Patchcodes	Patch codes allow the separation of documents.