Edit AI table field properties
Use the procedure in this topic to edit AI table field properties, including formatting and validation for each column.
Before you edit the properties of an AI table field, verify the following steps are complete.
-
Configurable document types have one or more AI table fields already configured.
-
Field formatters and field validators are configured, if needed.
For more information about adding 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 an AI table field, select its menu and select Properties.
In both cases, a list of configured fields is displayed for the selected document. Each AI table column is listed so you can configure the formatting and validation separately for each column.
-
-
If not already selected, select an
AI table field from the list of fields.
The properties are displayed.
- Optional. Edit the Table name and Description settings for the entire table.
-
Optional. Edit the following
Advanced settings as needed.
Setting
Description
Lines after each table
The number of text lines after a table that are provided as additional information to AI to help find the table. (Default: 2)
Lines before each table
The number of text lines before a table that are provided as additional information to AI to help find the table. (Default: 2)
Number of Pages to consider
Starting from the beginning of a document, the number of pages to search for the table. (Default: 10)
The minimum value is 0 which means all pages are searched.
-
Select a column and configure the following settings.
Setting
Description
Column name
Edit the existing column name.
See Field name guidelines for more information.
Description
Edit the existing description for the column.
For more information about useful descriptions, see Guidelines for descriptions.
Formatter It is possible to further refine a field by applying a formatter. (Default: No formatter)
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.
By default, the following formatters are available:
- No formatter:
-
If selected, it does not take any text, characters, or digits from the document for formatting.
- Default Amount Formatter:
-
Contains the default currency and typical decimal symbol formatting.
- Default Date Formatter:
-
Contains basic date formatting, such as the date order and date output format.
When the field Type is set to Date, the Default Date Formatter is selected automatically.
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.
Validation rules
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. If the extraction result does not meet these rules, it is invalid and the configured validation message is displayed.
Field validation is applied to field data when extraction is performed for both test documents and training documents. If an extracted field does not meet the validation requirements, a validation message is displayed when you move the pointer over the field on an image or its extraction data circle. Field validators are limited to regular expression and date validation.
The color of the extraction data circle does not indicate if there are validation errors. It is possible to have a green extraction data circle and an extraction result that fails validation. After extraction or testing, move the pointer over the circle to see if there is a validation message.
Validators are added using the DocAI Studio menu. Alternatively, you can import validators that were created in Tungsten TotalAgility Advanced Studio.
For more information on adding field validators, refer to the Tungsten TotalAgility Advanced Studio Help.
You can apply both local and global validators to this field. Local validators are added to a document type and available only within that document type. For more information, see Add local field validators.
Global validators are added from the DocAI Studio menu. For more information on adding field validators, refer to the Tungsten TotalAgility Advanced Studio Help.
Apply validators by following these steps:
-
In the Validators section select Add field validator.
The Add field validator window is displayed.
-
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 and you are returned to the field properties window.
-
Select Save.
-
In the Validators section select Add field validator.
The Add field validator window is displayed and the Local tab is selected.
-
Optional. On the Local tab, select each validator you want to add to this field.
Each selected field is added to the Selected items list.
-
Optional. Select the Global tab and select each validator you want to add to this field
Each selected global validator is listed in the Selected items list.
-
Select Done to save your field validators.
After extraction is performed for a training or test document, or during production, any validation errors for a table are indicated in a few ways. If a table column has one or more validation errors in its cells, the error icon is displayed next to the column header.
If a cell has a validation error, the cell is highlighted red and the error icon is displayed next to the incorrect extraction value. Move the pointer over this icon to view the validation message.
- Optional. Repeat step 5 for other AI table columns.
-
Select
Save.
The properties are closed and you are returned to the list of fields.
- Optional. Repeat these steps to edit other AI table fields and other document types.