Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
This is preview documentation for a feature that's scheduled in an upcoming release.
Event connectors can trigger process flows by listening for events that are published to message queues/topics by a message broker (e.g. RabbitMQ).
When an event connector is added to Patchworks, you provide connection details for your message broker and then decide which queues/topics to associate with the connector. An event connector can have multiple queues/topics, and the same queue/topic can be used in multiple event connectors.
Once an event connector is defined, it becomes available for use in process flow trigger shapes.
This feature is in BETA. If used, please test your process flows carefully and contact support if you experience any issues.
This is preview documentation for a feature that's scheduled in an upcoming release.
Existing message queues/topics can be removed at any time. Before doing this, please consider the Need to know points detailed below.
When a queue/topic is removed from an event connector, it is detached from any process flow trigger shapes where it has been selected for that specific event connector (broker).
There's no effect on any other event connectors or process flow trigger shapes which are using the same queue.
To remove an existing queue/topic for an event connector, follow the steps below.
Step 1 Access your existing event connectors.
Step 2 Click the name of the event connector that you want to update - for example:
Step 3 Select the queues/topics option at the top of the page:
Step 4 Click the name of the queue that you want to remove:
Step 5 Click the 'trash' icon at the top of the page:
This is preview documentation for a feature that's scheduled in an upcoming release.
Renaming existing queues/topics from event connectors and reflecting those changes in your message broker is not currently supported.
Similarly, renaming existing queues/topics in your message broker and reflecting those changes in existing event connectors is not currently supported.
If an existing queue/topic name changes, you should:
Remove the queue from any Patchworks event connectors (this also removes the queue from any process flow trigger shapes).
Make the required change directly in your message broker (e.g. RabbitMQ).
This is preview documentation for a feature that's scheduled in an upcoming release.
All of your installed connectors can be viewed/updated from the manage connectors page - for example:
On this page, you can see all installed event connectors. From here you can:
To navigate to the my connectors page, select process flows > event connectors from the left-hand navigation menu.
This is preview documentation for a feature that's scheduled in an .
When or an event connector, you have the option to add new message queues/topics.
When you add a new queue/topic to an event connector, it is also added to your message broker.
You can add as many queues/topics as you want for an event connector - they will all be available for selection when this event connector is chosen as the broker in a process flow .
To add a new message queue/topic, follow the steps below.
Step 1 Access the queues/topics page for your event connector:
Step 2 Enter a name for the queue/topic, then click the create button - for example:
Step 3 The new queue/topic is added for the event connector (and is also added to your message broker):
If you're adding a new event connector, this page is displayed as part of the . Otherwise, you can and choose to update queues/topics.
This queue will now be available for selection when the event connector is chosen as the broker in a process flow .
This is preview documentation for a feature that's scheduled in an upcoming release.
When adding a new event connector, you step through a series of wizard-type pages to add general settings, authentication credentials, and required queues/topics.
New event connectors are available for selection as brokers in process flow trigger shapes as soon as they are saved successfully.
ALL messages published to selected queues/topics are passed through to the process flow.
Step 1 Log into the Patchworks dashboard, then select process flows > event connectors from the left-hand navigation menu.
Step 2 Click the add new event connector button:
Step 3 You're prompted to enter general settings for this connector:
Use the table below as a guide:
Name
Enter a name for the event connector, as it will identified throughout Patchworks.
Description
Enter a description for the event connector to provide a little more detail about its purpose.
Host
Enter the the address of the machine where your messaging broker (e.g. RabbitMQ) is running - typically this is an IP address or a domain name.
Port
Enter the network port where RabbitMQ is listening for connections. RabbitMQ uses the AMQP (Advanced Message Queuing Protocol) for communication which, by default, listens on port 5672
for non-TLS connections and on port 5671
for TLS connections.
Protocol
Select the appropriate protocol for your messaging broker.
Authentication method
Currently, basic auth
is supported.
Step 4 Click the create button.
Step 5 Enter your authentication credentials for the message broker - in this case, username and password:
Step 6 Click the update button.
Step 7 Now you can select or add which message queue/topic to associate with this event connector:
Any existing queues are listed for selection, or you can add new queues/topics.
When you add a new queue/topic here, it is added to your message broker. You can add as many as you need - any queues/topics that you add will be available for selection when this event connector is selected as the broker in a process flow trigger shape.
Step 8 Having added all required queues/topics, the event connector is ready to use in process flows.
This is preview documentation for a feature that's scheduled in an .
Existing event connectors can be removed at any time. Before doing this, please consider the points detailed below.
When an event connector is removed, it means that it's no longer available for use as a trigger in process flows - there's no effect on any associated queues/topics within your message broker.
If you remove an event connector that has been configured as a trigger in process flows, it is detached from those trigger shapes, automatically.
To remove an existing event connector, follow the steps below.
Step 1 Access your .
Step 2 Click the name of the event connector that you want to remove - for example:
Step 3 Click the 'trash' icon at the top of the general settings page:
Step 4 When prompted, confirm this action.
This is preview documentation for a feature that's scheduled in an upcoming release.
Message queues/topics are associated with event connectors. An event connector can have multiple queues/topics, and the same queue/topic can be used in multiple event connectors.
This is preview documentation for a feature that's scheduled in an upcoming release.
Event connectors can be updated at any time - you can change general settings, authentication and associated queues/topics.
To update an existing event connector, follow the steps below.
Step 1 Access your existing event connectors.
Step 2 Click the name of the event connector that you want to update - for example:
Step 3 You can now access/update general settings, authentication, and queues/topics for this event connector:
For more information about these settings please see Adding a new event connector and Message queues/topics.
Step 4 Click the update button once all required changes have been made.