Connectors are reusable project assets that enable a process to interact with external systems. You can use connectors to retrieve, generate, update, and store content in the repository, send emails, and work with external services. A connector is created at the project level and can be reused throughout the application when you need the same integration in multiple processes. Reusing an existing connector helps keep project configuration consistent and reduces duplicate setup.
Within a project, you can:
- create connectors,
- reuse existing connectors across processes,
- delete connectors from a process,
- delete connectors from a project.
| Property | Description |
|---|---|
| Events | vents are used as part of defining event criteria in a trigger. When the event criteria specified in a trigger are met, an action is started. Certain connectors can be used for defining event criteria. For example, the email service event MESSAGE_RECEIVED can be used to monitor inbound emails. If a pattern defined in the trigger is met then a trigger action is started. See Triggers for further details on creating event criteria based on connectors. |
| Actions |
Actions are the operations a connector can take, for example sending a message on Slack and creating a channel in Slack are two different actions. A connector instance can execute any number of actions, however each service task can only execute one. Each action has a set of input parameters and output parameters. Input parameters are values sent from the process for the connector to execute, and output parameters are the values the connector sends back to the process after it has executed. The values sent as input and output parameters are defined using the Mapping type property on the service task and process variables. |
| Configuration Parameters |
Configuration parameters are the environment variables specific to each connector instance. Environment variables refer to the configuration settings for a connector, for example the instance of Slack to create a channel in or the SMTP server to use to send emails from. Multiple instances of the same connector within a project are only required if different configuration parameters are going to be set for the connector tasks used in the process. Note: Properties marked as
Secure shouldn’t have their values entered
whilst modeling.
|
| Multi-Instance |
Multi-instance allows for the element to be repeated within a process. For more information see Understanding Multi-Instance Activities. |
| Errors |
Connectors have a set of errors defined in their configuration. These errors are thrown when the error occurs in the execution of a connector action and can be caught by error boundary events or error start events. This allows connector errors to be handled as business errors. When an error boundary event is attached to a service task that contains a connector, a list of errors that can be thrown by that connector can be selected as the error to catch. Error start events will see a list of errors from the connectors in the project. |