Field Type
As discussed in Pattern Creation and Editing, when creating a Pattern, Field Type can be declared to create the expectation that data being received into the Field fits a format expectation and can be presented accordingly via the API.
The available Field Types and their respective formats are:
Field Type | Description | Examples of Accepted Values |
|---|---|---|
Text | No type format is assumed; any text value is accepted as a value, so no validation will be performed | "Quarterly Report" |
Notes | Similar to text, but allows for longer inputs and is intended for manual entry. The document view will display a character count for this Field so users know how long the Field can be. No validation will be performed | "Kevin - Can you confirm the extracted values from this document and Review accordingly?" |
Numeric | Validation will be performed to ensure the entry is a value that contains numbers, optional commas, an optional decimal point, and optional parentheses to denote the accounting style of negative value | 15.92 (90) -1,000.25 |
Money | Validation will be performed to ensure the entry is a value that contains the same validation criteria as "Numeric" as well as optional special characters for currency | $2,950,000.00 (9,000.00￥) -75.99 |
Percent | Validation will be performed to ensure the entry is a value that contains the same validation criteria as "Numeric" in addition to a special character for percentage | 99.98% (10)% -15.5% |
Date | Validation will be performed to ensure the entry is a value that maps to a valid date. The document view in the application will map this value to the ISO-8601 format and will also provide a "date-picker" that will show the date in a calendar view and will allow date selection directly from the calendar | 01/01/2019 November 15, 2022 20 July 2018 19/09/2000 |
Boolean | Validation will be performed to ensure the entry is a true or false value. The boolean type is nearly exclusively used with the Anchor Tool's checkbox detection feature | Checked checkbox, unchecked checkbox |
Picklist | Validation will be performed to ensure the entry is a value that matches against a user-defined list. The document view will show this Field value as a dropdown listing out the possible values. If an unlisted value is extracted via automation or smart capture, then a validation error will occur | List: [Buy, Reduce, Hold] Accepted Value: Buy |
If extracted or inputted data doesn’t meet the type definition as outlined above, a validation message will display:
This validation error can be resolved by removing the Record or by editing the record with the correct value/ format, which will be evaluated once you click away from the entry box. If this live evaluation determines that your entry matches the Field Type, then the validation error for that Field will clear.
