Using Triggers

Trigger REST operations can be found here

When an event occurs, all triggers of that type will perform actions of their related objects:

Trigger Event Types

Trigger objects can have one of the following event types:

Trigger Events Occurrence Diagram

To show an overview of the Trigger events and when they are happening, this diagram was created.

Trigger Condition

A subset of MongoDB Query Language. The annotation will get converted into JSON records behind the scenes. The trigger gets activated if at least one such record matches the condition according to the MQL query rules. A null condition matches any record, just like {}. Record format:

{
"field": {
"{schema_id}": string | null,
},
"required_field_missing": boolean,
"missing_fields": string[],
}

Example trigger condition with AND operator:

{
  "$and": [
    {
      "field.vendor_id": {
        "$and": [
          {"$exists": true},
          {"$regex": "Meat ltd\\."}
        ]
      }
    }
  ]
}

Example on how to check if any of the required fields are missing:

{
  "$and": [
    {"required_field_missing": true}
  ]
}

This example shows how to use the AND operator to check for multiple conditions. In this case, the trigger will be activated if the vendor ID exists and matches the regex pattern "Milk( inc\.)?" and if the required field is missing.

{
  "$and": [
    {
      "field.vendor_id": {
        "$and": [
          {"$exists": true},
          {"$regex": "Milk( inc\\.)?"}
        ]
      }
    },
    {"required_field_missing": true}
  ]
}

Example checking for specific document type:

{
  "$or": [
    {
      "field.document_type": {"$eq": "invoice"}
    }
  ]
}

Example checking field value range:

{
  "$or": [
    {
      "field.vendor_id": {
        "$or": [
          {"$regex": "Milk( inc\\.)?"},
          {"$regex": "Barn( inc\\.)?"}  
        ]
      }
    }
  ]
}

Example checking for high amount:

{
  "$or": [
    {
      "number_of_pages": {
        "$gt": 10
      }
    }
  ]
}

Supported MQL subset based on the trigger event type:

All trigger event types:

{}

Only annotation_imported, annotation_confirmed, and annotation_exported trigger event types:

{
"$and": [
{"field.{schema_id}": {"$and": [{"$exists": true}, REGEX]}}
]
}

Only annotation_imported trigger event type:

{
"$and": [
{"field.{schema_id}": {"$and": [{"$exists": true}, REGEX]}},
{"required_field_missing": true},
{"missing_fields": {"$elemMatch": {"$in": list[str[schema_id]]}}
]
}

Only validation trigger event type:

{
"$or": [
{"field.document_type": {"$in": list[str[document_type]]},
{"field.language": {"$in": list[str[language]]},
{"field.currency": {"$in": list[str[currency]]},
{"number_of_pages": {"$gt": 10},
{"filename": REGEX}
]
}

{
"$or": [
{"field.document_type": {"$in": list[str[document_type]]},
{"field.language": {"$in": list[str[language]]},
{"field.currency": {"$in": list[str[currency]]},
{"number_of_pages": {"$gt": 10},
{"filename": {"$or": [REGEX, REGEX]}
]
}

(*) A field is considered missing if any of the two following conditions is met

• the field has ui_configuration of type captured or null and no value was extracted for it and rir_confidence score is at least 0.95

• the field has ui_configuration of other types (data, manual, formula, ...) and has an empty value

(**) The $not option for REGEX is not valid for the validation trigger.

Triggering Email Templates

Email template REST operations can be found here.

To set up email template trigger automation, link an email template object to a trigger object and set its automate attribute to true. Currently, only one trigger can be linked. To set up the recipient(s) of the automated emails, you can use built-in placeholders or direct values in the to, cc, and bcc fields in email templates.

Only some email template types and some trigger event types can be linked together:

Email templates of type rejection and rejection_default will also reject the associated annotation when triggered.

Every newly created queue has default email templates. Some of them have a trigger linked, including an email template of type email_with_no_processable_attachments which can not have its trigger unlinked or linked to another trigger. To disable its automation, set its automate attribute to false.

Triggering Validation

Delete Recommendation REST operations can be found here.

To set up validation trigger automation, specify the rules for validation and set its enabled attribute to true.

This trigger is only valid for the validation trigger event.

Hooks and Triggers Workflow

Sometimes it may happen that there is a need to know, what triggers and hooks and when are they run. That can be found in this workflow.