Welcome > 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.

Name

Name for the field. This is the ID of the field.

For name and display name conventions, see Name conventions.

Display name

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. Enter a description for the field, such as " Displays the address of the customer."

Type

Select 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, UnitPrice, are available for use in a table.

  • The Table field type does not support verification settings.

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 null

If selected, allows values to be null.

Note When you use nullable type fields, the extraction is successful at runtime, with the text box, date and dropdown fields appearing empty, and the check box appearing selected.

Formatter

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

Note 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 formatted in field2.

VERIFICATION

See Configure the verification settings for a document field.

ANALYTICS
Include in analytics

By default, the field data in a document is sent to Kofax Analytics for TotalAgility. To exclude the field data such as field value, confidence, change ratio, validity from any metric calculations, clear the check box for Include in analytics. (Default: Selected)

Mask field values

If selected, note the following:

  • When a mask field value is enabled 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.

  • When a masked field is processed in TotalAgility, the actual field values are never written to the Kofax Analytics for TotalAgility database.

Note The Mask field values property is only available if Include in analytics is selected.