Skip to main content

Business Rules Validation

Business Rules Validation allows users to perform validations of the extracted and calculated data. It typically runs at the end of the extension chain and the main purpose of it is to prevent confirmations (or block automation) of invalid documents.

Installation​

Business Rules Validation extension is available in the Rossum store. To install the extension, follow these steps:

  1. Login to your Rossum account.
  2. Navigate to Extensions → Rossum Store.
  3. Search for Business Rules Validation extension and "Add" it.

A default "Rossum Store extension settings" page will open where you can configure the extension to your liking.

Basic usage​

By default, the extension has the following configuration:

{
  "checks": [
    {
      "rule": "has_value({document_id})",
      "message": "Invoice number is mandatory."
    }
  ],
  "variables": {}
}

This configuration will ensure that document ID (invoice number) is not empty. Other checks (rules) can be added. Visit Configuration examples page for more examples.

Available configuration options​

info

Head over to Configuration examples page for collection of the most common real-world configurations.

{
  // List of business rules. All rules in this list are evaluated in order.
  "checks": [
    {
      // Rule to be evaluated (visit Expression Engine for more details).
      "rule": "has_value({document_id})",

      // Message to be shown if the rule is violated.
      "message": "Invoice number is mandatory.",

      // Type of the message (optional, default: "error").
      "type": "error",

      // Whether the rule violation blocks automation (optional, default: false). Note that error
      // messages automatically block automation.
      "automation_blocker": true,

      // Whether the rule is active (optional, default: true).
      "active": true,

      // List of queue IDs where the rule is active (optional).
      "queue_ids": [123, 456],

      // The condition that has to be met in order for validation to be applied (optional).
      // Do not confuse with the rule. This option only controls whether the rule is applied or not.
      "condition": "has_value({document_id})"
    }
  ]
}