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 begin

Before you edit the properties of an AI table field, verify the following steps are complete.

  • User-defined 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.

Procedure
  1. 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.

  2. If not already selected, select an AI table field from the list of fields.

    The properties are displayed.

  3. Optional. Edit the Table name and Description settings for the entire table.
  4. 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.

  5. 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 Settings > Field formatters 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.

    You can apply only two types of validators to field properties: global and inline.

    Apply global validators to a field by following these steps:

    1. 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.

    2. 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.

    3. 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.

    4. Optional. Apply global validators to additional fields.

    5. Select Save.

    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.

  6. Optional. Repeat step 5 for other AI table columns.
  7. Select Save.

    The properties are closed and you are returned to the list of fields.

  8. Optional. Repeat these steps to edit other AI table fields and other document types.
Next steps
More info