Edit field properties
Use this procedure to edit field properties for user-defined and predefined document types. For user-defined document types, the fields must exist before you can edit their settings. For AI table fields, refer to Edit AI table field properties.
The system applies formatting and validation to field data during extraction for training documents and testing for test documents. The formatted value is returned to the list of field extraction values. The original value before formatting is available in the field details displayed when you move the pointer over the extraction data circle or the field on the document image. If validation fails, the validation message is also displayed in the field details.
For validation, you can apply global and inline validators only in the field properties.
Validators in the global category are created via the DocAI Studio menu. Alternatively, you can import validators that were created in Tungsten TotalAgility Advanced Studio. For more information on creating global validators, refer to the Tungsten TotalAgility Advanced Studio Help.
Field validation rules are assigned to fields as they are created. For single-field validators, they are listed in the Validators list and on the Local tab of the Add field validators window for the corresponding field. These validators cannot be edited from the field settings, but you can delete them from the field. Deleting the validator from a field deletes the entire field validation rule.
Before you edit the properties of an extraction field, verify the following steps are complete.
-
User-defined document types have one or more fields already configured.
-
Field formatters and global or local field validators are configured, if needed.
For more information about adding global formatters and validators, refer to the Tungsten TotalAgility Advanced Studio Help.
-
On the
Fields menu, select a document and then do one of the
following:
-
Select List of configured fields.
-
For a field, select its menu and select Properties.
In both cases, a list of configured fields is displayed for the selected document. Basic information is provided for each field and includes the field type, its location, whether it is a bar code, any warnings, if it is trained, and extracted. Additional field properties are displayed on the right.
-
-
If not already selected, select a non-table field from the list of fields.
Basic field properties are displayed above the General tab.
-
Edit the following basic field settings for all field types.
Setting
Description
Availability
Name
Edit the existing field name.
See Field name guidelines for more information.
All field types
Type
Select the type of field that you are creating. (Default: Text)
There are three values for this setting.
-
Text
-
Date
-
Number
The selected field type determines additional field constraint settings.
All field types
-
-
Additional field settings are displayed when any of the following fields types are
selected: Suggested fields
,
Copilot fields
, bar code fields
, and database fields
Dynamic setting for suggested fields
Setting
Description
Keywords
Edit the existing keywords and add additional keywords as needed, separating each keyword with a semicolon.
Dynamic settings for Copilot fields
Setting
Description
Description
Edit the existing description for the content you are extracting.
For more information about useful descriptions, see Guidelines for descriptions.
Is this value located within a table?
If selected, the field is expected to be found in a table cell. (Default: No)
Dynamic setting for bar code fields
Setting
Description
Is bar code
If selected, the field is assumed to be a bar code, and the following setting is enabled:
- Bar code type:
-
When extracting a bar code, select the specific bar code type from the list to ensure the best extraction results. If the bar code type is known when the bar code is added, its type is selected automatically. If the bar code type is unknown, use Select All.
Dynamic setting for database fields
Setting
Description
Fuzzy lookup field
This is a read-only field.
- Fuzzy lookup field:
-
Displays the lookup field in the following syntax:
<Fuzzy Lookup>:<Field Name>
-
For all simple field types, it is possible to further refine a field by
applying a formatter. (Default: No formatter)
Field formatting is applied to field data when extraction is performed for both training documents and test documents. The original value is displayed when you move the pointer over the extraction data circle or the field on the image. Do on the following:
-
Select a formatter from the list.
The values in this list depend on what field formatters are created in the DocAI Studio menu, or imported from Tungsten TotalAgility Advanced Studio.
-
Alternatively, select Edit inline formatting rule to add an inline formatter that is available for this field only.
See Inline formatters for more information.
Formatters do not work for bar codes.
-
- If a field is required during production, select Is mandatory. (Default: Cleared)
-
The following Field constraint settings depend on the selected value for
Type. Follow the steps for the relevant value from
the table below.
Setting
Description
Text
Configure the following settings as required.
- Minimum character length:
-
The minimum number of characters allowed for a field. Select to enter a minimum character length. If an extracted result is shorter than the minimum length, the field is marked as invalid. (Default: Cleared)
- Maximum character length:
-
The maximum number of characters allowed for a field. Select to enter a maximum character length. If the extracted result is longer than the maximum length, the field is marked as invalid. (Default: Cleared)
- Define allowed characters:
-
Select to enter a list of allowed characters. This list is literal, so no separator character is necessary. (Default: Cleared)
- Define restricted characters:
-
Select to enter a list of restricted characters. This list is literal, so no separator character is necessary. (Default: Cleared)
Date
Configure the following settings as required.
- Reference date:
-
Select a reference date. All dates are compared to this date to ensure they fit within a specific date range. (Default: Today)
- Period before reference date:
-
Select this setting to provide the number of days that a date is valid before the reference date. It restricts a date found on a document to be within the past N days before the reference date. If a date falls outside the specified date range, it is invalid. (Default: Cleared)
- Period after reference date:
-
Select this setting to provide the number of days that a date is valid after the reference date. It restricts a date on a document to be within N days after the reference date. If a date falls outside this range, it is invalid. (Default: Cleared)
Number
No additional steps are necessary for fields of this type.
-
Select the
Validation tab. Any existing field validation rules are
listed with the type Local.
Validators are not supported for bar code fields.
Configure the following settings.
Setting
Description
Require manual field confirmation
If selected, this field is flagged as invalid and requires manual confirmation. (Default: Cleared)
Always valid
If selected, this field is always valid, even when no result is extracted. (Default: Cleared)
Validators
A list of validation rules applied to this field.
You can apply only two types of validators to field properties: global and inline.
Apply global validators to a field by following these steps:
-
In the Validators table, select Add.
An editable validation rule is added where you can select a validator from the list or add an inline validator.
-
Select the list.
The Add field validators window is displayed. If any field validation rules are configured for this field, they are listed in the Local tab.
Select the Global tab, and then select each validator you want to add to this field.
Each selected validator is added to the Selected items list.
-
Select Done to save your field validators. The field properties window is displayed.
The list of validators is updated to include your selected global validators.
-
Optional. Apply global validators to additional fields.
-
Select Save.
-
-
Select Save.
Extraction is performed for your training document and all configured formatting and validators are applied.
Use the extraction data circle tooltip or the extracted value on the image to view details about the extracted values. If formatting is applied to a field, the original extraction value is included in this information, as is a validation message, if appropriate.
If you apply formatting and the result is not as expected, test the field formatter using the extracted value as input. The test should succeed. If it fails, review the formatter settings and update as necessary.
- Optional. Repeat these steps to apply validation and formatting to more fields on this and other document types.
- Optional. Save your solution.
-
Optional. Add additional extraction fields.
-
Optional. Delete fields in bulk.