Skip to Content

Jitterbit MQ (Beta) Acknowledge Activity

Introduction

A Jitterbit MQ (Beta) Acknowledge activity, using its Jitterbit MQ (Beta) connection, acknowledges messages (using an ackId) in a Jitterbit message queue and is intended to be used as a target to consume data in an operation.

To use the Acknowledge activity, you must first use the Get activity to retrieve the ackId for the message(s). The ackId must be provided in the Acknowledge activity's request schema.

Note

This connector is currently released as a beta version and is available only to a limited set of users. To participate in the beta program or provide feedback on bugs and enhancements, contact your Customer Success Manager (CSM).

Creating a Jitterbit MQ (Beta) Acknowledge Activity

An instance of a Jitterbit MQ (Beta) Acknowledge activity is created from a Jitterbit MQ (Beta) 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 Jitterbit MQ (Beta) Acknowledge activity can be edited from these locations:

Configuring a Jitterbit MQ (Beta) Acknowledge Activity

Follow these steps to configure a Jitterbit MQ (Beta) Acknowledge activity:

Step 1: Enter a Name

In this step, provide a name for the activity. Each user interface element of this step is described below.

Jitterbit MQ (Beta) Acknowledge Activity Configuration Step 1

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

  • Ack Multiple Messages: Select to acknowledge multiple messages.

    Note

    This option is overridden by data provided in the multiple field in the activity's request schema.

  • 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 are displayed. Each user interface element of this step is described below.

Jitterbit MQ (Beta) Acknowledge Activity Configuration Step 2

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

    Information

    To use the Acknowledge activity, you must first use the Get activity to retrieve the ackId for the message(s). The ackId must be provided in the Acknowledge activity's request schema.

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

    Request Schema Node/Field Description
    ackId String containing the acknowledgement ID (obtained from the Get activity); this field is used only for the acknowledgement of a single message
    deliverTag Integer of the delivery tag (configured as the deliveryTag in a Send activity); for example, if you are acknowledging multiple messages and this field is set to 3, all messages with delivery tags set to 1, 2, or 3 are acknowledged
    multiple Set to true if multiple messages are to be acknowledged, set to false if only a single message is to be acknowledged
    additionalProperties String containing any additional properties
    Response Schema Node/Field Description
    success Boolean representing the success (true) or failure (false) of the acknowledgement
    error Node containing any errors
    statusCode HTTP response status code returned
    error String containing any error messages
    additionalProperties String containing any additional properties
  • Refresh: Click the refresh icon Refresh icon or the word Refresh to regenerate schemas from the Jitterbit MQ (Beta) 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 Jitterbit MQ (Beta) 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.

Jitterbit MQ (Beta) Acknowledge activities can be used as a target with these operation patterns:

A typical use case is to use a Jitterbit MQ (Beta) Acknowledge activity in the Two-transformation Pattern. In this example, the first transformation (Acknowledge Request) creates a request structure that is passed to the Jitterbit MQ (Beta) Acknowledge activity. The second transformation (Acknowledge Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Acknowledge Response) and a message is then logged by the Write to Operation Log script:

Jitterbit MQ (Beta) Acknowledge operation

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.