Field validation business rules

Field validation business rules are supported for all fields. The business rules are internally registered as user exits via the SetFieldValidate user exit.

Validation business rules must support the following input and output variables:

Variable Name

Type

Description

Input

Output

OrganizationId

String

Invoice Processing organization ID as displayed on the Settings > Organizations form

Allowed icon

Not Allowed icon

SessionId

String

Kofax TotalAgility session ID that performs the validation

Allowed icon

Not Allowed icon

DocumentId

String

Kofax TotalAgility document ID

Allowed icon

Allowed icon

Value

String

Field value

Allowed icon

Allowed icon

Valid

Boolean

Whether or not a field is valid

Allowed icon

Allowed icon

ErrorMessage

String

Error message if the field is not valid

Allowed icon

Allowed icon

For example, you can create a business rule to check if an invoice number already exists for a vendor, based on values from a custom table or service. If the invoice number does exist then the field is marked as invalid and an error message is displayed.

To reduce complexity and effort, a business unit template is available for field validation so you can copy it and modify it for your own business needs.

Related topics: