Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

On this Page

Table of Contents
maxLevel2
excludeOlder Versions|Additional Resources|Related Links|Related Information
 

Snap type:Read
Description:

This Snap performs an acknowledge, reject or a recover action on the received message from the Rabbitmq server via the RabbitMQ Consumer used in the upstream. The Snap should always be used in conjunction with the RabbitMQ Consumer Snap within a pipeline. The RabbitMQ Consumer Snap should have the Acknowledgement mode set to PIPELINE_CONTROL.

ETL Transformations & Data Flow

 The Snap extracts the delivery tag from the the Consumer and performs selected acknowledge function. On the RabbitMQ Consumer Snap, select the PIPELINE_CONTROL option when using the RabbitMQ Acknowledge Snap in a pipeline.

  • The RabbitMQ Consumer Snap writes the messages to the output view along with headers containing a delivery tag which is then forwarded to the RabbitMQ Acknowledge Snap. 
  • The RabbitMQ Acknowledge Snap may be positioned anywhere in the pipeline following the Consumer Snap. The RabbitMQ Acknowledge Snap should be configured with necessary acknowledgement mode based on the message processing. 

Input & Output

  • Input:  
    This Snap optionally accepts the delivery tag of the RabbitMQ message consumed by the Consumer Snap upstream. 
  • Output

This Snap writes the delivery tag received to output view if present. Errors can be routed to the error view if enabled or otherwise cause the Snap to fail during execution.

Mode

Prerequisites:
  • Access to the RabbitMQ Server.
  • Privileges to perform various actions on the Queues such as receive and send messages.
Limitations and Known Issues:
  • When using the RabbitMQ Acknowledge Snap, the pipeline can be configured with a single RabbitMQ Consumer Snap only (more than one RabbitMQ Consumer Snaps cannot be configured within the same pipeline).
  • The pipelines cannot be validated if a child pipeline contains either a RabbitMQ Acknowledge Snap or a Consumer Snap within it. 
  • When configuring with the Acknowledge Snap, since the message processing is sequential,  a single message only will be processed at a time in the pipeline and second message is processed only when the current message is either acknowledged or recovered or rejected.
Configurations:

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See RabbitMQ Account for information on setting up this type of account.

 Views

InputThis Snap has exactly one document input view.
OutputThis Snap has at most document output view.
ErrorThis Snap has at most one document error view and produces zero or more documents in the view.


Troubleshooting:The section describes typical issues you may encounter while using this Snap, and instructions on how to workaround them:

Settings

Label

Required. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

Acknowledge type

Required. Specifies the appropriate acknowledge type of the message to be performed. The message type options available are: Acknowledge, Reject and Recover.

Note

On the RabbitMQ Consumer Snap, select the PIPELINE_CONTROL option when using the RabbitMQ Acknowledge Snap within a pipeline.

Acknowledge Message: The Consumer performs a successful acknowledgement of the message to the RabbitMQ server and removes that message from the queue.

Reject Message: The Consumer 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 would be dropped from the queue automatically.

Recover Message: The Consumer notifies the RabbitMQ server to re-queue the message to be available in the next read.

Default value: Acknowledge Message 

Multiexcerpt include macro
nameSnap Execution
pageAnaplan Read


Multiexcerpt include macro
nameSnap_Execution_Introduced
pageAnaplan Read


Examples



Expand
titleRabbitMQ Acknowledge Snap performs a basic acknowledge function

 The pipeline reads the delivery tag from the RabbitMQ Consumer Snap and forwards it to the Acknowledge Snap for an appropriate acknowledge operation.

The RabbitMQ Consumer Snap is set with the PIPELINE_CONTROL option as a Message Acknowledge Mode:

Image Modified

The delivery tag as passed using the Mapper Snap:

Image Modified

The Acknowledge Snap with Acknowledge type as Acknowledge Message performs a successful acknowledgement on pipeline execution:

Image Modified  

  


Expand
titleRabbitMQ Acknowledge Snap performing multiple modes of message acknowledgement

In the below pipeline, the received messages from the RabbitMQ server are consumed and acknowledged as configured. 

The pipeline is configured to perform:

  • an acknowledgement of the message
  • re-queue the recovered message
  • reject the message and route it to the Dead lettered queue.

 

Downloads 


Attachments
oldfalse
patterns.*slp, .*zip


Insert excerpt
RabbitMQ Snap Pack
RabbitMQ Snap Pack
nopaneltrue