Triggers

Triggers listen to integrations and create an event when a set of defined event criteria are met. An action is then creates a payload from the event and sends it to a defined channel using Rabbit MQ.

Examples of what triggers can be used for include:

• Starting a process instance when an email with a specific subject line is received.
• Sending a signal to a process when a specific message is written to a Slack channel.
• Sending a message when a file is created in Alfresco Content Services.

Modeling triggers

Triggers contain an event definition that is configured in the source component such as a connector and an action configured for the individual trigger.

Triggers are stored as JSON files in the format <trigger-name>.json and can be modeled using the GUI or the JSON Editor.

The basic properties for triggers are:

Events

Events are created when the configured event criteria are met.

The properties for trigger events are:

Events are stored as a source containing the connector and event to use and a set of inputs containing the values for the trigger event, for example using the EMAIL_RECEIVED event for the email connector:

"event": {
    "inputs": {
        "pattern": "",
        "echo": "Email pattern matched. Starting a process instance.",
        "echoError": "We hit a problem starting a process instance for that message. "
    },
    "source": "connector.email-connector-1.EMAIL_RECEIVED"
}

The following are the events that can be configured for triggers:

• When a specific application runtime bundle event occurs.
• When files and folders are created in Alfresco Content Services using the content connector.
• When an email is received using the email connector.
• When specific messages are received in a Slack channel using the Slack connector.
• When an SMS message that meets a certain pattern is received using the Twilio connector.

Actions

Actions are the trigger payload that is created and sent when an event is created. The payload for an action can include the output parameters configured for an event.

The following are the actions that can be configured for triggers:

• Any connector actions
• Start a process
• Send a signal
• Receive a message
• Send a start message
• Execute a script

Start a process

The action to start a process will begin a specific process instance when event are met. The payload for the start a process action is:

Actions are stored as a payload, for example using the start a process action for the EMAIL_RECEIVED event of the email connector:

"action": {
    "source": "command-consumer",
    "payload": {
        "payloadType": "StartProcessPayload",
        "processDefinitionKey": "Process_YjqRw3n2",
        "variables": {
            "sender": "${emailFrom}",
            "recipient": "${emailTo}",
            "subject": "${emailSubject}"
        },
        "name": "approval-process",
        "businessKey": "14240"
    }
}

Send a signal

The action to send a signal will send a named signal of global scope when an event criteria are met. The payload for a send signal action is:

Actions are stored as a payload, for example using the send a signal action for the EMAIL_RECEIVED event of the email connector:

"action": {
    "source": "command-consumer",
    "payload": {
        "payloadType": "StartProcessPayload",
        "variables": {
            "sender": "${emailFrom}",
            "recipient": "${emailTo}",
            "subject": "${emailSubject}"
        },
        "name": "Signal_0n91cib"
    }
}

Receive a message

The action to receive a message will send a named message when an event criteria are met. The payload for a receive message action is:

Actions are stored as a payload, for example using the receive a message action for the EMAIL_RECEIVED event of the email connector:

"action": {
    "source": "command-consumer",
    "payload": {
        "payloadType": "ReceiveMessagePayload",
        "name": "Message_077epax",
        "correlationKey": "00-1245"
    }
}

Send a start message

The action to send a start message will send a named message when an event criteria are met to start a process that contains a start message event. The payload for a send message action is:

Actions are stored as a payload, for example using the send a start message action for the EMAIL_RECEIVED event of the email connector:

"action": {
    "source": "command-consumer",
    "payload": {
        "payloadType": "StartMessagePayload",
        "name": "Message_077epax",
        "businessKey": "event-message",
        "variables": {
            "trigger": "${name}"
        }
    }
}

Execute a script

The action to execute a script will execute a named script that exists in the same project as the trigger.