Versions Compared

Key

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

In this article

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

Overview

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.


Info

Acknowledgment Modes:

  • Client Acknowledge: When a message is read, the client acknowledges the message.

  • Auto Acknowledge: The messages are acknowledged automatically (by user) after the message is read.

Learn more about Message Acknowledge Modes.

Snap Type

Read

Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Task Pipelines.

Snap Views

TypeFormatNumber of ViewsExamples of Upstream and Downstream SnapsDescription
InputDocumentMin:1
Max:1
  • Mapper
  • Structure
  • JSON Generator 
This Snap optionally accepts the JMS MessageID of the JMS message consumed by JMS Consumer Snap upstream. 
OutputDocumentMin:0
Max:1
  • Filter
  • Mapper
  • JSON Formatter
This Snap writes the JMS MessageID received to output view if present. 
Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:

  • Stop Pipeline Execution: Stops the current pipeline execution when the Snap encounters an error.

  • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the rest of the records.

  • Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap Settings

Field

Field Type

Description


Label

Default Value: JMS Acknowledge
Example
JMS Acknowledge

StringSpecify a unique name for the Snap. 

Recover message

Default Value: Deselected


Checkbox

Select this option to explicitly place a message back in the JMS queue to recover messages.

Info

If the Snap fails to read the JMS messages for processing, you can recover those messages by selecting the Recover message checkbox so that the Snap can read the messages additional times for further processing.


Snap Execution

Default Value: Validate & Execute
Example
: Execute only


Dropdown list

Select one of the three modes in which the Snap executes. Available options are:

  • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.

  • Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.

  • Disabled: Disables the Snap and all Snaps that are downstream from it.


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