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 is used to acknowledge the Java Message Service (JMS) messages read by a JMS consumer used in the upstream Snap. This Snap should always be used in conjunction with JMS Consumer Snap in a pipeline. The JMS Consumer Snap should have the Acknowledgement mode set to CLIENT_ACKNOWLEDGE and Processing mode set to Synchronous.

  • Expected upstream Snaps: Any Snap that provides a document output view, such as Mapper or Structure or a JSON Generator Snap. 
  • Expected downstream Snaps: Any Snap that has a document input view, such as Filter or Mapper or JSON Formatter.
  • Expected input: This Snap optionally accepts the JMS MessageID of the JMS message consumed by JMS Consumer Snap upstream. 
  • Expected output: This Snap writes the JMS MessageID received to output view if present. Errors can be routed to the error view if enabled or cause the Snap to fail during execution.


Prerequisites:

[None]


Support and limitations:Ultra pipelines: Works in Ultra Pipelines.Spark mode: Not supported in /wiki/spaces/SD/pages/1437917 modeTask Pipelines.
Account: 

Accounts are not used with this Snap.


Views:


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


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.

Recover message


Select this option to explicitly place a failed message back in the JMS Queue by calling recover rather than acknowledge.

Multiexcerpt include macro
nameSnap Execution
pageAnaplan Read


Multiexcerpt include macro
nameSnap_Execution_Introduced
pageAnaplan Read


Example


A pipeline for JMS Acknowledge may look something like this:


Configure a Mapper Snap to join upstream Snaps to JMS Acknowledge:



The sample output of the JMS Acknowledge Snap may look like this:


Insert excerpt
JMS Snap Pack
JMS Snap Pack
nopaneltrue