Skip to Content

JMS Send Activity

Introduction

A JMS Send activity, using its JMS connection, sends messages to a JMS queue or topic and is intended to be used as a target in an operation.

Create a JMS Send Activity

An instance of a JMS Send activity is created from a JMS connection using its Send 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 Send activity can be edited from these locations:

Configure a JMS Send Activity

Follow these steps to configure a JMS Send activity:

Step 1: Enter a Name and Specify Settings

In this step, provide a name for the activity and specify the settings for the messages being sent. Each user interface element of this step is described below.

JMS Send Activity Configuration Step 1

Tip

Fields with a variable icon Variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

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

  • Destination Type: Select the destination of the messages being sent, one of Queue or Topic.

    • Queue: Select to send a message to a queue.

    • Topic: Select to send a message to a topic.

  • Queue Name / Topic Name: Depending on the Destination Type, enter the name of the queue or topic where the message is to be sent.

    Note

    When using IBM MQ as the JMS provider, the Queue Name or Topic Name must match the name of an existing queue or topic in the IBM MQ instance or an error will occur. When using Active MQ as the JMS provider, a queue or topic will be created if there is not an existing queue or topic with a name matching the entered name.

  • Message Type: Specify the message type to be used, one of Text or Byte.

  • Delivery Mode: Specify the delivery mode to be used, one of Persistent or Non-persistent. If Persistent is selected, messages are persisted to a disk or database so that they will survive a broker restart. If Non-persistent is selected, all in-transit messages are lost during a broker restart.

  • Priority: Enter the priority of the message using whole numbers from 0 (lowest) to 9 (highest). The default value is 4.

  • Time to Live (Milliseconds): Enter the time in milliseconds that the messages should live in the queue or topic. The default value is 0, meaning the message will live in the queue or topic indefinitely.

  • 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.

JMS Send Activity Configuration Step 2

  • 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
    sendMessageRequest Node representing the message request
    messageBody The body of the JMS message
    replyTo The reply destination
    JMSCorrelationID The correlation ID (if a correlation ID is not entered, one is automatically generated at runtime)
    customMessageProperties Node representing the custom message properties
    customMessagePropertyString Node representing the contents of the custom message properties that are in the form of a string
    item Node representing the message with custom properties
    name The name of the custom property
    value The value of the custom property
    customMessagePropertyInteger Node representing the custom message properties that are in the form of an integer
    item Node representing the contents of the custom message properties
    name The name of the custom property
    value The value of the custom property
    customMessagePropertyFloat Node representing the custom message properties that are in the form of a float
    item Node representing the contents of the custom message properties
    name The name of the custom property
    value The value of the custom property
    customMessagePropertyDouble Node representing the custom message properties that are in the form of a double
    item Node representing the contents of the custom message properties
    name The name of the custom property
    value The value of the custom property
    customMessagePropertyBoolean Node representing the custom message properties that are in the form of a boolean
    item Node representing the contents of the custom message properties
    name The name of the custom property
    value The value of the custom property
    Response Schema Node/Field Description
    sendMessageResponse Node representing the response
    isSent Boolean representing the status of the message with true indicating that the message was sent
    JMSCorrelationID String containing the correlation ID
    errorDetails Node representing the error details
    errorCode String containing any applicable error code
    errorMsg String containing any applicable error message

  • Refresh: Click the refresh icon 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 Send 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 Send activities can be used as a target with these operation patterns:

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.