System field group for folder
The System field group for a folder contains the predefined properties and attributes that you can use for defining your folder fields.
The System field group is only visible when using the folder type fields in TotalAgility Designer. It is not visible when maintaining folders.
Refer to the following table for system-defined properties available in the System field group.
Property/Attribute Name |
Type |
Description |
---|---|---|
Created at |
Date |
Folder created date. |
Documents |
Complex |
Collection of the documents within a folder. |
Error description |
String |
Error description of the runtime folder validation. |
Folders |
Complex |
Collection of the folders within a folder. |
Has rejections |
Bool |
Determines if there are one or more documents or pages with rejected flags within the folder represented by the variable. |
Has unclassified document |
Bool |
Determines if there are any unclassified documents within the folder. |
Has unconfidently classified document |
Bool |
Determines if there are any unconfidently classified documents within the folder. |
Hierarchy has unclassified document |
Bool |
Determines if there are any unclassified documents within the folder and all its subfolders. |
Hierarchy has unconfidently classified document |
Bool |
Determines if there are any unconfidently classified documents within the folder and all its subfolders. |
Instance ID |
String |
The ID of the runtime folder. |
Last accessed at |
Date |
Last accessed date. |
Name |
String |
Name of the runtime folder. |
Name pattern custom text |
String |
Identifies a value (string) by which [CustomText] placeholder is replaced when the folder display name is generated. |
No of documents |
Long |
The number of documents in the runtime folder. |
Parent ID |
String |
The ID of the runtime parent folder. |
Rejected by failure |
Bool |
Determines if a folder is rejected due to some exception that happened during execution within Transformation Server. |
Review forced valid |
Bool |
Determines if the runtime folder is forced valid (set during folder review). |
Review valid |
Bool |
Determines if the runtime folder is valid (set during folder review). |
Type |
String |
Name of the folder type. |
Valid |
Bool |
Determines if the runtime folder is valid. |
Verified |
Bool |
Determines if the runtime folder is verified. |
Folder system properties of type collection
The following is the list of folder system properties of type collection.
Folder.Documents |
Contains a complex array with three columns:
|
Folder.Folders |
Contains a complex array with four columns:
|