Validators
You use validators to declare conditions that flag field values as acceptable or unacceptable. If the value is unacceptable, you can make sure that your document processing user knows what to fix. You can set a condition as an error, a warning, or an informational condition.
Documents with errors and warnings are held for users to verify and correct any errors in document processing applications.
Validators provide a way to check the data based on rules that are applicable to the data. For example, a document field for a date has a value of 08-23-202X. This value isn’t a valid date since the year is not correct. You can set up your project to flag the value and provide a message to the user that this is a low confidence extraction.
System-defined validators
- Low confidence validator
-
Checks the confidence level for the extraction.
Default message: If field confidence is below a threshold, you see a message that the value has low confidence and might be incorrect. You can change the message.
Default severity is informational, but you can specify warning or error.
Default threshold = 80, but you can specify a value in the range 0 - 100.
- Data type mismatch validator
- Checks that the data in a field matches the format of the field type.
Example: A field is expected to have a particular type of data, such as a number, but instead it has alphanumeric text.
Default message: The value is not the correct type, must be %type%.
Default severity is Error.
Refer to the field types to see the formats.
- Required value validator
- Checks that a required field has a value.
Example: A mandatory field has no value.
Default message: This value is required.
Default severity is Error.
Configurable system validators
- Value range validator
- Enforces a range in which the number value should be by setting a minimum, maximum, or
both.
Available for numeric fields.
- Value length validator
- Enforces a minimum and/or maximum length for the string field.
Available for string and numeric fields.
- Value check validator
- Enforces a numerical constraint (equals, not equals, greater than, less than, greater than or
equal to, less than or equal to) on the value of the field.
Available for numeric and decimal fields.
- Near to current date validator
- Enforces that the field value must be within a range that is relative to the current date. The
range is defined by a number of days and a comparison operator (greater than, less than, greater
than or equal to, less than or equal to).
Available for date fields.
- Date value check validator
- Enforces a constraint (equals to, not equal to, greater than, less than, greater than or equal
to, less than or equal to) on the field value that is relative to a specified date.
Available for date fields.
- Date value range validator
- Enforces that the field value must be within a specified date range (as defined by a minimum and
maximum date value).
Available for date fields.
- Pattern
- Enforces that the field value must match a regular expression pattern.
- Dictionary
- Enforces that the field value must match one of the values among a list of valid values.