Versions Compared

Old Version 10

changes.mady.by.user Chandna Mitra

Saved on

compared with

New Version 11

changes.mady.by.user Kalpana Malladi

Saved on

Key

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

On In this Pagearticle

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

Snap type:

Read

Description:

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

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:


    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:
    Max:
    • Mapper
    • Structure
    • JSON Generator 
    		This Snap optionally accepts the JMS MessageID of the JMS message consumed by JMS Consumer Snap upstream. 
    Expected output:
    OutputDocumentMin:
    Max:
    • Filter
    • Mapper
    • JSON Formatter
    		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:Works in Ultra Task 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
    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.


    Field

    		Field Type

    Description


    Label



    		StringSpecify a unique 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


    		Checkbox

    Select this option to explicitly place a

    failed

    message back in the JMS

    Queue by calling recover rather than acknowledge. Multiexcerpt include macroname

    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 reads the messages again for further processing additional times.


    Snap Execution

    pageAnaplan Read Multiexcerpt include macronameSnap_Execution_IntroducedpageAnaplan Read


    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