JMS Acknowledge Activity¶

Introduction¶

A JMS Acknowledge activity, using its JMS connection, sends a bulk acknowledgment of JMS messages and is intended to be used as a target in an operation.

Create a JMS Acknowledge Activity¶

An instance of a JMS Acknowledge activity is created from a JMS connection using its Acknowledge activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Creating an Activity Instance in Component Reuse.

An existing JMS Acknowledge activity can be edited from these locations:

• The design canvas (see Component Actions Menu in Design Canvas).
• The project pane's Components tab (see Component Actions Menu in Project Pane Components Tab).

Configure a JMS Acknowledge Activity¶

Follow these steps to configure a JMS Acknowledge activity:

• Step 1: Enter a Name and Select an Action
  Provide a name for the activity and select the action for the transacted session.

• Step 2: Review the Data Schemas
  Any request or response schemas generated from the endpoint are displayed.

Step 1: Enter a Name and Select an Action¶

In this step, provide a name for the activity and select an action for the transacted session. Each user interface element of this step is described below.

• Name: Enter a name to identify the activity. The name must be unique for each JMS Acknowledge activity and must not contain forward slashes / or colons :.

• Action: Select an action for the JMS session, one of Commit or Roll Back.

• Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

• Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

• Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Review the Data Schemas¶

Any request or response schemas generated from the endpoint are displayed. Each user interface element of this step is described below.

• Data Schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

  Note

  Data supplied in a transformation takes precedence over the activity configuration.

  The request and response data schemas consist of these nodes and fields:

  Request Schema Node/Field	Description
  acknowledgeRequest	Node representing the acknowledge request
  acknowledgeId	String with the acknowledge ID

  Response Schema Node/Field	Description
  acknowledgeResponse	Node representing the response
  success	Boolean representing the success (true) or failure (false) of the acknowledgment
  errorDetails	Node representing the error details
  errorMessage	String containing any applicable error message

• Refresh: Click the refresh icon or the word Refresh to regenerate schemas from the JMS endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

• Back: Click to temporarily store the configuration for this step and return to the previous step.

• Finished: Click to save the configuration for all steps and close the activity configuration.

• Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next Steps¶

After configuring a JMS Acknowledge activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity Actions Menu in Connector Basics.

JMS Acknowledge activities can be used as a target with these operation patterns:

• Transformation Pattern
• Two-transformation Pattern (as the first or second target)

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.