› Capture › Extraction groups › Fields › Properties of a field in a document type › General

General

Configure the general properties of a field in a document type.

General

Name

A name for the field. This is the ID of the field.

For the name and display name conventions, see Name conventions.

When modifying a field, 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 the type will clear the mappings. You must reconfigure those actions to work as expected.

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

For best practices on adding fields to a field group, see "Sequence and field groups" and "Adding and removing document fields" in the Kofax TotalAgility Best Practices Guide.

Display name

A display name for the document field, such as Address.

When you build a form that uses a document field, the display name appears in the generated form, both at design time and runtime.

Description

Optional. A description for the field, such as " Displays the address of the customer."

Type

The type of field, such as Text, Boolean, Choice, Table, Date, or Number.

Note the following for a Choice field:

  • When you select Choice, a combo box appears on the generated form. See Properties of a capture combo box for information about customizing combo boxes.

  • When you inherit a choice field, you can change the default choice and add further choices but cannot delete inherited choices. You can only delete the additional choices that you have added.

  • Configure the data for a choice field similar to configuring the data for a dropdown list. See Add data for a dropdown list.

Note the following for a Table field:

  • A table can include column fields of Text, Boolean, Date, Number, and Choice type.

  • A set of predefined column fields, such as Position, Quantity, Description, and UnitPrice, are available for use in a table.

  • The Table field type does not support verification settings.

Data source
The data source of the document field type.

  • Static (default): Add the static choice values for validation.

  • Lookups: Select the lookup values for validation. See Manage a lookup.

Restrict to choice list values
If selected, validates the document field value against the choice field values.
This property is only available for a Choice field type.
Default value

A value that will be used if no value is specified. If using devices, you can add macros to insert information from the scan job. See Macros for devices.

Allow empty field

If the field value is empty, formatting does not mark the field as invalid.

When you use empty type fields, the following happens on extraction:

  • The text box, date, and dropdown fields appear empty, and the check box appears selected.

  • The fields with empty values are not validated against the list of choices.

The Allow empty field property is not available for a Choice field type.

Static choice values
The static choice values to use in a field type. This property is only available for a Choice field type.
Formatter

Select the field formatter (Date, Percentage, Amount, or Business rule). See Field formatters for more information.

If a field, such as field1 has a dependent formatter mapped to it and relies on the inputs of another field, such as field2, you can still format field1 but the formatted value of field1 may not be passed to the formatter in field2.

Analytics

Include in analytics

By default, the document field data, such as field value, confidence, change ratio, and validity from any metric calculations, is sent to Kofax Analytics for TotalAgility. If clear, the field data is excluded. (Default: Selected)

Include history of field changes
If selected, includes the history of changes in the field. If clear, the field changes are excluded. (Default: Clear)
Mask field values

If selected for a field, the field data in Kofax Analytics for TotalAgility is displayed with an asterisk for each character.

When a masked field is processed in TotalAgility, the extraction metrics for confidence, IsValid, and Change Ratio are reflected in the Kofax Analytics for TotalAgility views. But the actual field values are never written to the Kofax Analytics for TotalAgility database.

The "Include history of field changes" and "Mask field values" properties are only available if "Include in analytics" is selected.