Field Details

The Details window displays the field details when a simple field Project Tree - Field icon is selected in the Project Tree and has several options.

General

This group has the following options:

Field populated by

This option determines how a field is populated during processing. It can be populated by a locator configured for this class or a fixed value. If you select <fixed value>, the Field fixed value field is available to type the fixed value. The value for this option is set to <none> by default.

The Go to locator details link enables you to open the locator properties for the selected locator method so that you can tweak the extraction settings for that particular locator.

Display name

This option contains the display information of the field when it is used in script or the user modules (Correction, Validation, Verification, Thin Client Correction, Thin Client Validation, or Thin Client Verification.) By default, this field is automatically populated with the field name. It is useful to create a meaningful name that describes the field content. When creating a default validation form, this display name is attached to the field by a field label that uses that field property on the validation form or the verification form. This display name supports the project localization. When you click the Localize button, the Translations window is displayed, where you can provide translations for the display name.

Tip If you reference fields in a script it is very helpful to create a field name that matches the script naming conventions. For field names that contain disallowed characters, a default script name is mapped and must be used in script to refer to the field. Keep in mind that if you have several fields that you refer to by their default script names it is difficult to distinguish between those fields. Therefore, the best practice is to use a meaningful field name using only allowed characters, and also provide a field display name to be shown on the validation or verification form that is allowed special characters such as blanks, and can be translated into various languages as needed.
Field formatting method

Select an existing formatter from the list. The selected formatter is applied to this field after extraction. It is also applied in Validation each time a user confirms this field by pressing Enter. If you want to create a new formatter, click the Formatters button.

Always CAPITAL letters

Select this option to change all field content to upper case. If this option is enabled, the Validation user can only key in upper case letters. This option is cleared by default.

Use for statistics

Recognition accuracy statistics are available at field level. The statistics database contains information about this recognition accuracy. Use this option to gather statistical information about the selected field. This option is selected by default.

Training

This group has the following options:

Show in training dialog

Use this option for a field that is mapped to a group locator subfield to determine whether the field is displayed for training on the Edit Document window or whether it is hidden and cannot be trained. By default this option is always selected for fields mapped to a group locator. However, if fields are mapped to a non-group locator, this option is disabled by default.

Monitor for automatic learning

This option is only available for trainable locator fields when online learning and Automatic training after Validation are enabled. Select this option if you want the field to be monitored for automatic training. If this field is incorrectly extracted and the Validation or Thin Client Validation user has to manually correct its physical coordinates, the document is flagged for online learning. This option is cleared by default.

If a Validation user corrects a field by changing its text, no field coordinates are provided, and as a result, that field does not qualify its document for automatic training. If however, the Validation user updates a field and the field coordinates change, using either auto-complete or the lasso, the document is added to a dynamic knowledge base for automatic training.

Note Even if this option is selected, it is not inherited by any child classes. This means that inherited fields are not automatically flagged for online learning.
Thresholds for validation

This group has the following options:

Minimum confidence for locator

A locator’s best alternative is assigned to the field when the minimum confidence reaches at least this value. The value for this option is set to 10% by default.

Minimum confidence for valid

A field is only marked as valid if the confidence of the best alternative is higher than this value. The value for this option is set to 80% by default.

Minimum distance to second best alternative

A field is considered to be valid only, if the distance between the best and the second best alternative of the assigned locator is greater than or equal to this value. The value for this option is set to 10% by default.

Require manual field confirmation

Select this option if manual field confirmation is always required during validation. If this option is selected, the minimum validation confidence and distance thresholds are not be used.

Always valid

Select this option if manual field confirmation is never required during validation. If this option is selected, the minimum validation confidence and distance thresholds are not be used.

You can also use this option for any fields that you do not include on the validation form. This prevent these hidden and invisible fields from becoming invalid and causing problems during validation.

Reread Options

This group enables zone recognition for a field using a specialized recognition profile. For example, recognizing an amount using a numeric profile. As prerequisites, extraction needs to have a valid field location from a locator and a recognition profile. For rereading a zone is placed over the field result on the document to perform recognition again with the selected recognition profile. The result of this zone recognizer replaces the original result if the minimum reread confidence is reached.

This group has the following options:

Recognition profile

By default, rereading is not performed. To enable this option, select a profile from the list. This profile is used if it is necessary to reread the document.

Note In addition, the <FieldName>_AfterFieldReread script event is available to control what value is overwritten as field result.
Minimum confidence to accept reread result

A reread value is only accepted if the threshold value specified here is reached. The value for this option is set to 70% by default.

User Interactive Modules

This group has the following options:

Display field in Correction

Select this option to display this field in the Correction module. This option is cleared by default.

Field is displayed in whole field correction mode

Select a value from this list to determine when a field is switched to whole field correction mode. The value for this option is set to When required by default. This means that users manually switch fields to whole field correction mode when needed.

Number of unconfident characters (N)

Type how many unconfident characters are required to switch this field into whole field correction mode automatically. This option is disabled unless the "Field is displayed in whole field correction mode" option is set to "If N characters unconfident" is selected. The value for this option is set to 0 by default.

Proportion (%)

Type the proportion or use the slider to specify the percentage of unconfident characters needed to switch the field to whole field correction mode automatically. This option is disabled unless the "Field is displayed in whole field correction mode" option is set to "If proportion of characters unconfident" is selected. The value for this option is set to 0 by default.

Display field in Verification

Select this option to display this field in the Verification module. This option is cleared by default.

Confirm

Select this option if you want users to compare the extracted data against the image and verify that the contents of a field are correct by pressing a single key. This option is selected by default.

User may not change field value

Select this option if you do not want users to edit any inconsistent data. The document can only be rejected and reviewed by a Quality Control user. This option is disabled unless the "Confirm" option is selected. This option is cleared by default.

Blind double keying

Select this option if you want users to retype an entire field using only the image as reference. This option is cleared by default.

Show field values if no match

Select this option to display the extracted value and the typed value if there is a difference. This option is disabled unless the "Blind double keying" option is selected. This option is cleared by default.

Read-only

Use this option to display a field in the Verification module that is only meant to provide context or reference purposes. For example, if a user is validating a customer number, it might be helpful to include the name of the customer. This option is cleared by default.

The following buttons are available:

Localize

Click Localize to open the Translation window, where you can provide a translation for the display name.

Formatters

Click Formatters to open the Project Settings - Formatting tab window where you can create a new formatter.