Configure the general properties of a field in a document type

  1. Enter a Name for the field. This is the ID of the field.
    For name and display name conventions, see Name conventions.
  2. Enter a Display Name for the document field.

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

  3. Enter an optional Description for the field.
  4. Select the Type of field, such as Text, Boolean, Choice, Table, Date or Number.
    • When you inherit a choice field, you can change the default choice and add further choices. But you can delete only the additional choices that have been added.

    • 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. Configure the data for a choice field similarly to configuring the data for a drop-down list. See Configure data for a drop-down list for more information.

      A table includes a list of column fields that can contain a text, boolean, date, number and choice type. A set of predefined column fields are available for use in a table, such as Position, Quantity, Description, UnitPrice, and so forth.

      Note The Table field type does not support verification settings.

  5. Enter a Default Value for the field.

    If you are using devices, you can add macros to insert information from the scan job. See Macros for devices.

  6. To allow values to be null, click Yes for Allow Null.
    Note When you use nullable type fields, at runtime the extraction is successful with the text box, date and drop-down fields appearing empty and the check box appearing selected.
  7. Apply either single field formatter (Date, Percentage, Amount or Business Rule) or multiple field formatter (Business Rule) to a field by consuming the Formatter. See Field formatters for more information.
  8. To use multiple fields as an input to a formatter:
    1. Consume the Business Rule formatter in the Formatter box.
    2. Click Configure.
    3. In the Business Rule page, on the Consume list, click Fields.
    4. For each field, either consume a field formatter or provide a static value.
    5. Click OK.

    Note If a field, such as field1 has a dependant 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 field 2.

  9. To configure a field in a document for online learning, click Yes for Monitor for Automatic Online Learning.

    Note The Monitor for Online Learning and Verification properties that are set for a field in a parent document type are not inherited to the child document type.

  10. To display the field on the form at design time and runtime, click Yes for Display Field for Verification. (Default: No)
    Note The Table type does not support verification.
  11. To mask the field on the form, click Yes for Mask Hidden Field's Image Location. (Default: No)

    Note This setting is only available when Display Field for Verification is set to No.

  12. Select one of the following verification modes:
    • Confirm: In this mode, if the data compared with the image is correct, the user presses a key to accept the data. Once you select this option, set the User may change Field Value option to allow or restrict editing a field after the field is accepted (confirmed). (Default: Yes; the user can edit the field)
    • Blind Double Keying: In this mode, the field is displayed with no value and the user must enter a value using the image as a reference. This value is compared with the original value from the last module that ran before verification. If the values do not match, a message appears. Once you select this option, set the Show Field Values if No Match option to allow a double-keyed field display values if there is a mismatch. (Default: No; field values are not displayed.)

      Note Only use Blind Double Keying for advanced users who will use this information as a guideline and who understand the importance of keying from the image rather than matching the original value.

    • Read-Only: In this mode, the field is set to read-only. You cannot edit the field.
  13. 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, click No for Include In Analytics.
    Note The Mask Field Values property is not available if Include in Analytics is set to No.
  14. Click Yes for Mask Field Values. (Default: No)
    • 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.

  15. Click Save.