Input 

The Snap does not require input data. Input documents may be used to evaluate any JavaScript expression in the File property.

Upstream Snap is optional. You can connect any Snap with a document output view, such as Mapper or Copy Snaps upstream of this Snap.

Output

Message consumed from RabbitMQ server as a binary document.

• File Writer

• CSV Parser

• JSON Parser

• XML Parser

Error

Learn more about Error handling in Pipelines.

String

Specify a unique name for the Snap.

Default Value: RabbitMQ Consumer
Example: RabbitMQ Consumer

String/Expression

Specify the name of the RabbitMQ exchange bound to the queue. If you do not specify a value for exchange, the default exchange provided by RabbitMQ is considered.

Default Value: N/A
Example: DemoExchange

Dropdown list

The type of RabbitMQ exchange used to push messages. Available options are:

• direct: Routes the messages to the queues only on matching with the routing key.

• fanout: Routes the messages to the queues that are bound to it regardless of the routing keys and patterns.

• headers: Routes the messages to the queues based on header values as specified in the binding. Provide the x-match and Header Properties if selected.

• topic: Routes the messages to the queues based on the routing key and the binding pattern.

Default Value: direct
Example: fanout

Checkbox

Select this checkbox to enable the exchange to be durable.

Default State: Selected

String/Expression

Conditional. Specify the name of the RabbitMQ queue from which messages have to be consumed. If there is no queue with the given queue name on RabbitMQ, then a new queue is created, and the consumer starts listening. If the exchange name and routing key are specified, the queue is bound to the exchange with that routing key.

Default Value: N/A
Example: DemoQueue

Checkbox

Select this check box to indicate that the RabbitMQ autoDelete property associated with the existing queue is set to true.

Default Value: Deselected
Example: Selected

String/Expression

Specify the routing key to be used for binding the queue with the exchange.

Default Value: N/A
Example: ZYA123&$

Dropdown list

Select one of the following modes for processing messages:

Synchronous: In synchronous mode, the consumer processes messages from the destination one at a time until a STOP is read or the Message Count is reached.

Asynchronous: In asynchronous mode, the consumer reads the messages from the destination whenever the message arrives until a 'STOP' is read or the Message Count is reached. The consumer registers a messagelistener asynchronously. It does not block, but calls (the processmessage) immediately once a message is available.

Default Value: Synchronous
Example: Asynchronous

Dropdown list

Select one of the following modes of message acknowledgement for non-transacted sessions:

• AUTO_ACKNOWLEDGE -  the session acknowledges the receipt of a message when a call to receive method or when the message listener returns successfully.

• PIPELINE_CONTROL- the client has the power when to acknowledge the message.  

Default Value: AUTO_ACKNOWLEDGE
Example: PIPELINE_CONTROL

Acknowledge type

Dropdown list

Appears on selecting Auto_Acknowledgment from the Message Acknowledge Mode dropdown list.

Select one of the following acknowledge types for the message.

• Acknowledge Message: Successful acknowledgment of the message by the Snap to the RabbitMQ server and removal of that message from the queue.

• Reject Message: Notifies the RabbitMQ server to mark the particular message as ‘dead lettered’ and route the message to the ‘Dead Lettered Exchange.’ However, if the ‘Dead Lettered Exchange’ is not configured on the RabbitMQ server, the message is dropped from the queue automatically.

• Recover Message: Notifies the RabbitMQ server to requeue the message to be available in the queue.

Default value: Acknowledge Message 
Example: Reject Message

Dropdown list

Specify the x-match value to be submitted for binding. The available options are:

• any: If selected, even one matching header value is sufficient

• all: If selected, mandates that all the values should match 

Default Value: all
Example: any

Use this fieldset to define header properties to bind the queue with an exchange as arguments.  

String/Expression

Specify the name of the header that is being used for the binding.

Default Value: N/A
Example: org

String/Expression

Specify the header value for the corresponding header key.

Default Value: N/A
Example: snap

Use this field set to define custom argument properties to ensure all declarations for the queues use the same configuration/options/arguments.  

Argument key

String/Expression

Specify the name of the argument used for declaration. Learn more about Optional Arguments in RabbitMQ documentation.

Default value: N/A
Example: x-max-len-bytes, x-max-priority, x-queue-type

Argument value

String/Expression

Specify the value corresponding to the argument key.

Default value: N/A
Example: 1048576, 2, quorum

Integer/Expression

Controls the number of messages to be consumed from the destination queue before the consumer is stopped. A negative integer value, that is, the default value of -1, causes the consumer to run indefinitely.

• -1: (Default behavior) The consumer Snap runs in an infinite loop and keeps consuming messages from the destination—the pipeline runs infinitely and reads all the messages until you stop that pipeline.

• 0: The consumer Snap reads all the messages from the destination and then stops. For example, if there are 10 messages in the destination queue, all 10 messages are read before it stops.

• >0: The consumer Snap reads the specified number of messages before stopping. For example, if there are 20 messages in the queue and you have specified 4 as the value, then only 4 messages are read before it stops.

Default value: -1
Example: 5

Integer

Specify the maximum number of connection attempts in case of a connection failure. The Snap retries for the configured number of attempts for establishing the connection.

Default Value: 3
Example: 4

Integer

Specify the time taken in seconds to wait before retrying for another connection.

Default Value: 10
Example: 5

Integer

Specify the maximum wait time, in seconds, for the Snap to complete execution. If the specified time is exceeded, the Snap stops processing. The default value 0 indicates no timeout.

Dropdown list

Indicates how the Snap must be executed. Available options are:

• Validate & Execute: Performs limited execution of the Snap (up to 50 records) during Pipeline validation; performs full execution of the Snap (unlimited records) during Pipeline execution.

• Execute only: Performs full execution of the Snap during Pipeline execution; does not execute the Snap during Pipeline validation.

• Disabled: Disables the Snap and, by extension, its downstream Snaps.

Default Value: Validate & Execute
Example: Execute only