User Guide > Process Steps and Components > Queue Step > RabbitMQ Queue
Was this helpful?
RabbitMQ Queue
Note:  For general information about Queue Steps, see Queue Step.
You can use the RabbitMQ component for connecting to a RabbitMQ server and consume/read messages from a particular RabbitMQ topic or queue and produce/write messages to a RabbitMQ Exchange.
RabbitMQ is an open-source message-broker that implements Advanced Message Queuing Protocol (AMQP) version 0.9.1.
Note:  This component is not compatible with servers that implement AMQP 1.0.
RabbitMQ Component Properties
Property
Default Value
Description
Host Name
localhost
Host name where the RabbitMQ server is installed.
Port
5672
Port number used to connect to the RabbitMQ server.
Virtual Host
/
Virtual host name through which the communication occurs.
User Name
guest
Username to connect to the specified virtual host and exchange.
Password
guest
The password to authenticate the above username.
Supported Actions
Action
Description
Connect
Establishes a connection with the RabbitMQ server.
Note:  Connect establishes a persistent connection that can be reused by calls to GetMessage and PutMessage for the duration of the process.
Disconnect
Disconnects from the RabbitMQ server.
GetMessage
Retrieves a message object in the queue. The message content is added in the DJMessage body of the object. Message headers are saved into DJMessage properties.
PutMessage
Writes a message to the RabbitMQ exchange. The DJMessage properties are added to the RabbitMQ message as message headers.
Supported Action Parameters
Action
Parameter
Description
GetMessage
Message
Name of a DJMessage object to which the RabbitMQ message will be read.
PutMessage
Message
Name of a DJMessage object to be written to the RabbitMQ exchange. DJMessage body is copied as a Text string to the RabbitMQ message payload.
Note:  All the RabbitMQ payloads are byte arrays and contains both text and binary data.
Supported Action Properties
Action
Parameter
Description
GetMessage
Source Queue
The queue to bind to. Both point-to-point queues and topics bind to a named queue.
 
Micro Batch Read
If set to TRUE, micro batch mode is enabled. Messages continue to be read from the RabbitMQ queue until the set timeout is reached. Messages are then serialized into a JSON formatted string.
If set to FALSE, single message mode is enabled. RabbitMQ message payload is copied to the DJMessage body as a text string. Rabbit message headers are transferred to DJMessage properties.
Default is FALSE.
 
Wait Timeout (mSec)
Time to wait (milliseconds) for a message (single read mode) or batch of messages (micro batch mode) to arrive in the queue when reading messages.
Default is 1000.
PutMessage
Target Exchange
Exchange to where you are sending the messages.
 
Routing Key
The routing key combined with the exchange determines the queue(s) to be targeted by RabbitMQ.
Override Properties
You can override the values provided for the object name in the PutMessage action using the following DJMessage properties:
• exchangeName - Name of target exchange. If provided, it overrides the value set in the Target Exchange property.
• routingKey - Routing key that must be used. If provided, it overrides the value set in the Routing Key property.
Note:  : Message headers are used to assist in message routing and the RabbitMQ headers can be set as DJMessage properties. All the DJMessage properties are transferred to RabbitMQ headers.
Last modified date: 12/03/2024