System field group
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 |
---|---|---|
InstanceID |
String |
ID of the runtime document. |
Name |
String |
Name of the runtime document. |
Type |
String |
Name of the document type. |
ParentID |
String |
ID of the runtime parent folder. |
NoOfPages |
Number |
Number of documents in the runtime folder. |
Valid |
Boolean |
Determines if the runtime document is valid. |
ErrorDescription |
String |
Error description of the runtime document validation. |
ReviewValid |
Boolean |
Determines if the runtime document is valid (set during document review). |
ReviewForcedValid |
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. |
RejectionReason |
String |
Rejection reason of the runtime document. |
IsReadOnly |
Boolean |
Determines if the runtime document is read only. |
OnlineLearningOptions |
Boolean |
Online learning options of the runtime document. |
OnlineLearningComments |
String |
Online learning comments of the runtime document. |
MimeType |
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. |
ClassificationConfident |
Boolean |
Routes low confidence documents to a different path. |
HasRejections |
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. |
RejectedByFailure |
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 |
ClassificationResults |
Collection |
Collection of all classification results |
CreatedAt |
Date |
Document created date. |
ExtensionNames |
String |
List of all extensions associated with the object. |
LastAccessedAt |
Date |
Last accessed date. |
Pages |
Collection |
Collection of page objects contained in the document. |
TypeId |
String |
Document type id. |
TypeVersion |
Number |
Document type (extraction group) version |
SeparationProceeded |
String |
Unused, can be removed. |
SourceFieldId |
String |
Source file id. |
SourceFileType |
String |
Source file mime type. |
ValidateAllperformed |
Boolean |
Unused, can be removed. |
ReviewForcedValidReason |
String |
Forced valid reason. |
OriginalId |
String |
Original document id. |
OriginalTypeId |
String |
Initial classified document type id. |
OriginalTypeIdBeforeRedirection |
String |
Original document type used to redirect to the current document type, set in Transformation Designer. |
IsReclassified |
Boolean |
Flag representing if a document type is manually reclassified. |
IsLocked |
Boolean |
Flag representing if a document is locked. |
LockedAt |
Date |
Document locked date. |
LockedBy |
String |
User that locked the document. |
FileName |
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. |
VariantName |
String |
Name of the document variant that is applied. |
VariantId |
String |
ID of the document variant that is applied. |
VariantVersion |
Number |
Document variant version that is applied. |
ImageProcessingAllPagesDetectedBlank |
Boolean |
Flag representing if all the pages in a document were blank and were removed. |
ImageProcessingBlankPagesRemovedCount |
Number |
Number of pages detected as blank and removed from the document. |