Add a field group
You can add field groups to a folder type.
A folder type has a pre-installed System field group. The System field group is only visible when consuming folder type fields in the TotalAgility Designer. You cannot see the group when maintaining folder types. The System field group has the following system-defined properties:
-
Select the
Root Folder and click
Field group on the Design bar.
Alternatively, click adjacent to the Root Folder.
By default, TotalAgility adds Field Group 1. To change the default name, double-click Field Group 1 or enter a different name from properties panel.
-
Select the field group and configure its properties.
Name
A name for the field group.
Resource access
The resource or resource group that can access this field group at runtime.
- Add more fields to the field group as needed. See Add fields to a field group in a folder type for more information.
- Save and release the folder type.
System field group
Refer to the following table for the system-defined properties in the System field group.
Name |
Type |
Description |
---|---|---|
InstanceID |
String |
Returns the unique ID of the folder. |
Name |
String |
Returns the name of the folder. The name is based on the template defined. |
Type |
String |
Returns the name of the folder type. |
ParentID |
String |
Returns the ID of the parent folder (if this folder is a child folder). |
NoOfDocuments |
Number |
Returns the number of documents in the current folder. |
Documents |
Collection of document class |
Returns the documents in the current folder. |
Folders |
Collection of folder class |
Returns the child folders. |
Valid |
Boolean |
Indicates if the folder is valid. |
ErrorDescription |
String |
Describes an error generated during folder validation. |
ReviewValid |
Boolean |
Indicates if the folder is structurally valid. |
ReviewForcedValid |
Boolean |
Indicates if the folder has been forced review valid. |
Verified |
Boolean |
Indicates if folder has been verified. |
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. |
NamePatternCustomText |