Add fields to a field group
A field group in a folder type can contain multiple fields.
A child folder type inherits a field group with all fields including the properties from the parent folder type. However, the verification settings defined for a field group in a parent folder type are not inherited to the child folder type.
To report consistent values, especially for date fields, you must assign formatters to field data types. See Field formatters.
-
Navigate to
.
The Folders page appears.
- Open the folder.
-
Expand the folder and select the field group for which to add fields and click
Field on the Design bar.
Alternatively, click adjacent to the field group.
TotalAgility adds a new field, Field1 of type Text, to the field group. You can change the field type name by double-clicking the field or when configuring the general properties of the field.
- Select the field. In the properties panel, configure the field properties.
-
Add more fields as required.
You can search for a specific field in the folder tree.
-
To delete a field, click
for the field to delete.
On confirmation, the selected field is deleted.
- Save or release the folder.
System-defined properties of a folder type field
A folder type field contains some system-defined properties which are only visible when consuming a folder type field in a process or activity; they are not visible when maintaining folder types.
Property/Attribute Name |
Type |
Description |
---|---|---|
Confidence |
Double |
Holds the value for the confidence of a field. |
Date value |
Date |
Holds the date value for the fields of date type. |
Double value |
Double |
Holds the double value for the fields of number type. |
Error description |
String |
Error description of the runtime folder field validation. |
Extraction confident |
Bool |
Determines if the field extraction is confident. If the Required manual field confirmation property of a folder field is enabled, then Extraction confident and Valid properties are set to False. TotalAgility ignores extraction confidence when validating fields for a Scan create new job form, or a form based on Scan activity because the extraction confidence is false for all fields in a newly scanned folder. |
Field alternatives |
Complex |
Alternative field values based on extraction results. |
Forced valid |
Bool |
Determines if the field is manually set valid. (forced valid) |
Height |
Double |
Holds the value for the height of the field, that is, the height of the field zone on the image. |
Left |
Double |
Holds the value for the left coordinate of the field. |
Page Index |
Double |
Holds the value for the page index of the field, that is, the index of the field from which field was extracted |
Preserve |
Bool |
Determines whether to preserve field data during extraction or during reclassifying the folder to another type that has the same field name. |
String tag |
String |
Stores the string data. |
Suppress training |
Bool |
Determines whether to suppress training for this field. |
Tag |
Double |
Stores an integer data. |
Top |
Double |
Holds the value for the top coordinate of the field. |
Training needed |
Bool |
Determines if the training is needed for the field. |
Use for statistics |
Bool |
Determines if the field value and metrics participate in statistics. |
Valid |
Bool |
Determines if the field is valid. |
Valid value |
String |
Holds the formatted and validated value of the field. |
Value |
String |
Holds the text value of the field. |
Verified |
Bool |
Determines if the field is verified. |
Width |
Double |
Holds the value for the width of the field, that is, the width of the field zone on the image. |