Add field validation rules
Use the procedure in this topic to add field and AI table column validators that are added in the selected document type. These validators are limited to predefined business rules.
If you want to add validators that are available for multiple document types and use other validation methods, add them from the DocAI Studio menu or in Tungsten TotalAgility Advanced Studio.
For more information about field validators and business units, refer to the Tungsten TotalAgility Advanced Studio Help.
-
Select the
Fields menu.
The Extraction page is displayed
-
Select a document to view its fields.
A list of fields configured for that document type are displayed in the Fields pane.
-
Select
Field validation rules.
The Field validation rules window is displayed for the selected document type and any existing validation rules are listed.
-
Select
Add a field validation rule.
A new validation rule is available.
-
Select the empty drop-down list for the validation rule and enter the following
information.
If you select the edit icon, this adds an inline validator instead.
Setting
Description
Name
Enter a unique and descriptive name for the local validation. (Mandatory)
Business rule
From the DocAI Studio category, select a single-field or multi-field validator from the list of predefined validator business rules. (Mandatory).
Rule inputs - Single-field validator rules:
-
The system assigns this field validation rule to the selected field. You can view the rule in the field properties on the Local tab. The validation rule applies only to this field. To apply the same rule to another field, create a new field validation rule with the same business rule.
- Multi-field validator rules:
-
The system assigns this field validation rule to all selected fields. You can view the rule in the list of field validation rules for the document type. The rule does not appear in the field properties.
Rule makes uncertain extraction results valid
If selected, any uncertain extraction results are marked as valid. (Default: Cleared)
-
Select
Add to add the field validator.
The Add field validator window closes and the validation rule is added to the list in the Field validation rules window.
For single-field validators, DocAI Studio automatically adds the validation rule to the referenced field, which appears in the field properties. For multi-field validators, DocAI Studio adds the validation rule to each referenced field, but the rule does not appear in the field properties. Multi-field validation rules are maintained in the Field validation rules window only.
- Optional. Select Edit field validation rule to edit the rule or to delete a field validation rule.
-
Optional. To reorder validators in the list, use the and icons.
Validators execute in the order displayed. A validator only executes if all preceding validators have passed.
- Optional. Repeat these steps to more validation rules to this or another document type.
-
Select
Save.
The Field validation rules window closes and the validators are applied to the corresponding fields.
- Test field extraction to see if your field validation rules behave as expected.