Rule

Rule object represents arbitrary business rules added to schema objects.

Trigger condition

The trigger_condition is a TxScript formula which controls the execution of the list of actions in a rule object.

There are two possible evaluation modes for this condition:

• simple mode: when the condition does not reference any datapoint, or only reference header fields. Example: len(field.document_id) < 10.
• line-item mode: when the condition references a line item datapoint (a column of a multivalue table). Example: field.item_amount > 100.0.

In line item mode, the condition is evaluated once for each row of the table, which means multiple actions can potentially be executed. In this case, a deduplication mechanism prevents the creation of duplicate messages (show_message action), duplicate blockers (add_automation_blocker action), and identical emails from being sent (send_email action).

Rule actions

Object defines rule actions to be executed when trigger condition is met.

Note that just after document import, the initial validation is performed and rules are then executed: the trigger conditions are first evaluated on the latest anntoation content, and then actions registered on validation and annotation_imported events are both executed.

Action Show message

Action: show_message

Event: can be triggered on validation event only.

Payload:

Action Add automation blocker

Action: add_automation_blocker

Event: can be triggered on validation event only.

Payload:

Note: at most one action of type add_automation_blocker can be set up for one rule object.

Action change status

Action: change_status

Event: can be triggered on annotation_imported event only.

Payload:

Note: at most one action of type change_status can be set up for one rule object.

Action Change queue

This action moves the annotation to another queue with or without re-extraction of the data (see the reimport flag).

Action: change_queue

Event: Can be configured to trigger on annotation_imported, annotation_confirmed or annotation_exported.

Payload:

Note: at most one action of type change_queue can be set up for one rule object.

Action Add label

Action: add_label

Event: can be triggered on validation event only.

Payload:

Note: at most one action of type add_label can be set up for one rule object.

Action Remove label

Action: remove_label

Event: can be triggered on validation event only.

Payload:

Note: at most one action of type remove_label can be set up for one rule object.

Action Add / Remove label

Action: add_remove_label

Event: can be triggered on validation event only.

Payload:

The affected labels are added to the annotation when the condition is satisfied, and removed otherwise.

Note: at most one action of type add_remove_label can be set up for one rule object.

Action Show / hide field

Action: show_hide_field

Event: can be triggered on validation event only.

Payload:

The affected schema field is visible when the condition is satisfied, and is hidden otherwise.

Action Show field

Action: show_field

Event: can be triggered on validation event only.

Payload:

Note: at most one action of type show_field can be set up for one rule object.

Action Hide field

Action: hide_field

Event: can be triggered on validation event only.

Payload:

Note: at most one action of type hide_field can be set up for one rule object.

Action Add validation source

Adds rules validation source to a datapoint.

Action: add_validation_source

Event: can be triggered on validation event only.

Payload:

Note: at most one action of type add_validation_source can be set up for one rule object.

Action send email

In line item mode of execution, deduplication mechanism will prevent multiple identical emails from being sent, and at most five emails can be sent by a single action.

Action: send_email

Event: Can be configured to trigger on annotation_imported, annotation_confirmed or annotation_exported.

Payload:

If email_template is defined, the rest of the attributes are ignored.

If email_template is not defined, then the payload can contain the following attributes:

Action Exclude from training

This action sets training_enabled to false on the annotation, excluding it from being used for AI training.

Action: exclude_from_training

Event: Can be configured to trigger on annotation_confirmed or annotation_exported.

Payload: none.

Note: at most one action of type exclude_from_training can be set up for one rule object.