Field details
The field details are displayed when a
simple
field
is selected in the
Project Tree.
The following options are available.
- 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 Fixed field 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. By default, this field is automatically populated with the field name. It is useful to create a meaningful name that describes the field content.
This display name supports the project localization. When you click the Translation 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. - Field formatting method
-
Select an existing formatter from the list. The selected formatter is applied to this field after extraction.
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.
This option is cleared 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 a user has to manually correct its physical coordinates, the document is flagged for online learning.
If a 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 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.This option is cleared by default.
- 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.
- 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.
The following buttons are available:
- Formatters
-
Click Formatters to open the Project Settings - Formatting tab window where you can create a new formatter.