Field Settings
These settings determine which fields are active for a given profile. It also includes their field types and validation settings. It is possible to add multiple entries for these settings. As a result, the settings are displayed in a table.
- Class Name
-
The class name of the document. This determines which field settings are applied. Typically, settings are provided for the INVOICES class which is the base class for all invoices. However, subclasses can have different settings. If subclass settings are provided, these override the base class settings.
A common value for this setting is INVOICES.
Class Name.When adding new fields, you must use uppercase for the - Field Name
-
The name of the Invoice Processing Agility field that is used in Transformation Designer and appears on the Validation form. If you add settings for a custom field, enter the Transformation Designer field name here.
Do not change the standard field names. This causes problems with the Transformation Designer form and other configuration settings. - Validation Label
-
The field label for error descriptions on the Validation form.
- Active
-
If selected, the field is active for a profile. This means that the field is extracted and displayed in Validation.
- Required in Server
-
If selected, and no value for the field is extracted in Transformation Server, the field is invalid.
- Required in Validation
-
If selected, the field is mandatory in Validation. This means that an empty field is invalid.
It is possible to mark a field Required in Server but not as Required in Validation. This forces the user to confirm all empty fields.
You cannot select Required in Validation without selecting Required in Server first.
- Country Filter
-
The comma-separated list of country ISO-codes that marks a field mandatory for specific countries.
This setting is used in conjunction with Required In Server and Required In Validation settings. If a field is mandatory for either of these settings, and the vendor country of origin is not specified in the list, then the field reverts to optional.
- Field Type
-
The type of a field. Select one of the following types.
-
AMOUNT
-
DATE
-
TEXT
-
TABLE
-
- Force Validation
-
When selected, a field is always marked as invalid and sent to Validation for review.
- Default Value
-
The default value of a field.
- Default if Nothing Extracted
-
The default value of a field if the system does not automatically extract a value from a document.
- Substitution Rule
-
Select the field substitution rule from the list for text fields.
Substitution rules are configured in the Substitution Rules.
- Min Length
-
The minimum text field length.
- Max Length
-
The maximum text field length.
- Right Justify
-
If selected, the system pads the field using the "Pad Char" character from the left, until the "Max Length" is reached.
- Pad Character
-
The padding character applied to a text field if it does not meet the maximum length.
- Remove All Specials
-
If selected, all special characters are removed from a text field. This means that all characters that are not letters, digits, or whitespace, are removed.
Exceptions are defined in Keep Certain Specials below.
- Remove Spaces
-
If selected, spaces are removed from a text field.
- Keep Certain Specials
-
A non-delimited list of special characters that are retained if Remove All Specials is enabled.
- Remove Start End
-
If selected, all special characters are removed from the beginning and from the end of an extracted text value. The Keep Certain Specials list is not applied here. All characters that are not letters, digits, or whitespace, are removed, regardless of the special characters listed in Keep Certain Specials.
- Substring Start Position
-
The starting character used in conjunction with the "Substring Length" when trimming an extracted value. Positive numbers start from the left while negative numbers start from the right.
For example, an invoice number can only be five characters, but the extracted value is "123456789." A "Substring Start Position" value of "-5" and a "Substring Length" value of "5" means that the end result is "56789."
- Substring Length
-
The length of a substring.
- Remove Leading Zeros
-
If selected, any leading zeros are removed from an extracted text value.
- Decimal Places
-
The number of decimal places for an amount field.
- Negative Type
-
Controls the output during export if the extracted value for an amount field is less than zero.
Choose one of the following settings.
-
This value means that the minus sign appears after the amount, such as 100.00-.
-
This value means that the minus sign appears before the amount, such as -100.00.
-
The value means that the minus sign does not appear, but the related value appears in parentheses. For example, 1 (100.00)
-
- Output For Zero
-
The amount value that is output during export if a zero value is found.
- Substitute Value if Over 0
-
The amount value that is output during export for an extracted amount value that is greater than zero.
- Future Days
-
The number of days in the future that an extracted date is considered valid. For example, today is March 20 and an extracted date is March 31. If the value is set to 10, then the system marks the field invalid as the extracted date is 11 days in the future.
If future dates are not permitted, set the column value to zero. To disable the check, set the value to -1.
In Validation, the user can pass any value as long as it is a valid date.
- No. Days in Past
-
The numerical value that indicates the number of days in the past that an extracted date is considered valid.
For example, today is March 20 and an extracted date is March 9. The value is set to 10, so the system marks the field invalid as the extracted date is 11 days in the past.
If past dates are not permitted, set the value to zero. To disable the check entirely, set the column value to -1.
In Validation, the user can pass any value as long as it is a valid date.
- Date Only in Current Month
-
If selected, an extracted date that is not in the current month is marked invalid and the document is sent to Validation.
In Validation, the user can pass any value as long as it is a valid date.
- Field Mask
-
A comma-separated list of characters allowed in the extracted or user-entered value.
For example, if the content of this column is set to "ABCD,WXYZ" only values "ABCD" or "WXYZ" are permitted.
Wildcard characters are also permitted, where # represents any number, an @ represents any letter, and a ? represents either a number or a letter.
- Extraction Profile ID
-
Use this for custom fields that are set up to use the configurable extraction feature. The content of this column corresponds to an "Extraction Profile ID" value that is configured in the Extraction Profiles.
A value of zero means that no configurable extraction is required for this field.