Add fields to a field group

Add fields and define validation rules for a field in a document type.

For best practices on naming convention, sequence, and adding and removing fields, refer to the Extraction and Classification Group design > Fields section in the Kofax TotalAgility Best Practices Guide.

Navigate to Capture > Extraction groups.

The Extraction groups page appears.
Open the extraction group and select the field group.
Do either of the following to add a field to the field group:
- 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.
- On the Field list on the Design bar, select a field type. Available field types are Text, Boolean, Choice, Table, Date, and Number.
  
  The selected field type is added to the field group.
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 extraction group tree.
Click Save.

System-defined properties of a document type field

A document type field contains some system-defined properties which are only visible when consuming a document type field in a process or activity; they are not visible when maintaining document 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 document field validation.
Extraction confident	Bool	Determines if the field extraction is confident. If the Required manual field confirmation property of a document field is enabled, then Extraction Confident and IsValid properties are set to False. TotalAgility ignores ExtractionConfidence when validating fields for a Scan create new job form, or a form based on Scan activity because ExtractionConfidence is False for all fields in a newly scanned document.
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 document 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.

Delete an extraction group field

If you delete a field and regenerate the form, the field and the capture actions associated with the field are deleted.

If you try to delete a field that a normal form action is using, a message appears to inform you that the field is being used in certain actions, and deleting the field will clear the mappings. You must reconfigure those actions to work as expected.

Navigate to Capture > Extraction groups.

The Extraction groups page appears.
On the Extraction group tree, click  for the field to delete.

On confirmation, the selected field is deleted.