Description:
This step sends messages using the RabbitMQ queue (open-source message broker software).
Inputs
- RabbitMQ – select RabbitMQ connection
- messageData – message content to be sent
- exchange – name of the exchange
- messageQueue – name of the queue
- routingKey – optional routing key
- messageParms – message parameters key=value pairs
Returns
- True – email sent successfully
- False – failed to send the email
Usage:
Before using this step in a process definition, configure a RabbitMQ connection using the following UI:
RabbitMQ is a widely used Enterprise service bus; you can get more information from their site at: https://www.rabbitmq.com/
Example:
Let’s build and execute the “clsSendRabbitMQMessageDef” example.
- Create a new process definition called “clsSendRabbitMQMessageDef” and open the definition in designer mode.
- Drag a "clsSendRabbitMQMessage" step to the canvas.
- Connect the dots between the “Start” and "clsSendRabbitMQMessage" steps, as shown above.
- Click the "clsSendRabbitMQMessage" step to configure its “Required” properties. Provide a name for the step. Select the RabbitMQ connection from the dropdown list. Provide a text message to send. Provide the exchange name. Click the Save button. Note: Click the "AI Predict" button for the Copilot to add new process steps that match your process description.
- Click the "clsSendRabbitMQMessage" step to configure its “Optional” properties. Provide the message queue and routing key. Click the button to configure the message parameters. A pop-up window is displayed for configuration. Click the Add Row (+) button to insert an empty row. Provide the key and value information. Click the Save button. You may add multiple message parameters by using the Add Row button.
- The “Logging” setting configuration is necessary for documentation and also measures the workflow progress and the percent complete. This is achieved by configuring the step state and percent fields individually, as shown in the images below. Configure the “Logging” using the following properties.
- Save the process definition, create a new instance, and then execute it. Render the process instance. Click the process step. The step should publish/send messages to the RabbitMQ service. You must access the RabbitMQ service to verify the action.
Definition Sample:
You may download the sample definition(s) from the link here and later import them (drag-and-drop) to your FlowWright Process Definition (XML file) or Form Definition (HTML file) page.
Note: Please verify and complete the process steps for any missing configurations, such as file path references and database connections, after import. Then, save the definition to confirm the changes.
Click here to download the sample file.