Edit field properties, formatters, and validators

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

All field types

Description

Edit the existing description for the content you are extracting.

For more information about useful descriptions, see Guidelines for descriptions.

Copilot Auto Extract fields only

Is this value located within a table?

If selected, the field is expected to be found in a table cell. (Default: No)

Copilot Auto Extract fields only

Keywords

Edit the existing keywords and add additional keywords as needed, separating each keyword with a semicolon.

Suggested fields only

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 lassoed, the type is selected automatically. If the bar code type is unknown, use Select All.

Bar code fields only

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.

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.

All field types except bar code fields

Select this setting if a value for this field is required during production. (Default: Cleared)

All field types

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.

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 Settings > Field validators 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 Settings > Field validators menu. For more information on adding field validators, refer to the Tungsten TotalAgility Advanced Studio Help.

Apply validators by following these steps:

1. In the Validators section select  Add field validator.

   The Add field validator window is displayed.

2. 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 and you are returned to the field properties window.

4. Select Save.

1. In the Validators section select  Add field validator.

   The Add field validator window is displayed and the Local tab is selected.

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

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

4. Select Done to save your field validators.