Welcome > Data module > Extraction groups > Add fields to a field group

Add fields to a field group

A field group can contain multiple fields. A child document type inherits a field group with all its fields including the properties from the parent document types, except the Monitor for Online Learning and Verification properties of the field. See Configure the general properties of a field in a document type.

To report consistent values, especially for date fields, you must assign formatters to field data types. See Field formatters .

  1. Select the field group, and click Fields Add Field.

    TotalAgility adds a new field to the field group.

  2. Complete the field properties. Field properties of a document type belong to the following categories:

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

Description

Valid

Determines if the field is valid.

ErrorDescription

Error description of the runtime document field validation.

ReviewForcedValid

Determines if the field is manually set valid (forced valid.)

Note An invalid field can be manually set valid during document review.

Verified

Determines if the field is verified.

Confidence

Holds the value for the confidence threshold of a field.

ReviewForcedValidDescription

Reason for forcing the field valid.

ExtractionConfident

Validates the extraction confidence for a document field.

Note If Required Manual Field Confirmation property of a document field is True, 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

Alternative field values based on extraction results.

Additional information for an extraction group field

When renaming or deleting an extraction group field, note the following:

  • If you rename a field and regenerate the form, the field name remains the same.

  • If you rename a field, change the field type and regenerate the form, a new field is created with the selected type and associated capture actions. If a normal form action is using this field, a message appears to inform that the renamed field is being used in certain actions and renaming the field and changing type will clear the mappings. You must reconfigure those actions to work as expected.

  • 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 which a normal form action is using, a message appears to inform 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.