Jitterbit MQ connection

Introduction

A Jitterbit MQ connection, created using the Jitterbit MQ connector, establishes access to the Jitterbit message queue service. Once a connection is configured, you can create instances of Jitterbit MQ activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Create or edit a Jitterbit MQ connection

A new Jitterbit MQ connection is created using the Jitterbit MQ connector from one of these locations:

• The design component palette's Project endpoints and connectors tab (see Design component palette).
• The Global Endpoints page (see Create a global endpoint in Global Endpoints).

An existing Jitterbit MQ connection can be edited from these locations:

• The design component palette's Project endpoints and connectors tab (see Design component palette).
• The project pane's Components tab (see Component actions menu in Project pane Components tab).
• The Global Endpoints page (see Edit a global endpoint in Global Endpoints).

Configure a Jitterbit MQ connection

Each user interface element of the Jitterbit MQ connection configuration screen is described below.

• Connection name: Enter a name to use to identify the connection. The name must be unique for each Jitterbit MQ connection and must not contain forward slashes / or colons :. This name is also used to identify the Jitterbit MQ endpoint, which refers to both a specific connection and its activities.

• Auth token: Enter an authentication token associated with the environment. The authentication token is generated in the Message queues page within the Authentication tokens tab.

• Optional settings: Click to expand additional optional settings:

  • Jitterbit Region: Select the Jitterbit region the organization belongs to, either APAC, EMEA, or NA. This field is required when you use agent version 10.73 or earlier. When you use agent version 10.74 or later, the system selects the region of the organization you are accessing by default.

  • Organization ID: Enter the Harmony organization ID. This field is required when you use agent version 10.73 or earlier. When you use agent version 10.74 or later, you can leave this field empty if the Auth Token is associated with the same organization that the project resides in. Otherwise, you must enter the organization ID associated with the authentication token.

  • Environment ID: Enter the Harmony environment ID for the environment containing the message queue. This field is required when you use agent version 10.73 or earlier. When you use agent version 10.74 or later, you can leave this field empty to use the project's environment.

  • Connection request timeout in seconds: Enter the maximum time (in seconds) for the connection to remain open after completing a request. This idle timeout controls how long an established connection remains open before closing. The default is 10 seconds and the maximum value is 180 seconds. Changing this value is not recommended.

  • Response timeout in seconds: Enter the maximum time (in seconds) to wait for the message queue service to return data after sending a request. If the service does not respond within this period, the request times out. The default is 10 seconds and the maximum value is 300 seconds.

  • Connection timeout in seconds: Enter the maximum time (in seconds) to wait for an initial connection to be established with the message queue service before the attempt times out. This setting applies when you open a new connection, before sending any requests. The default is 10 seconds and the maximum value is 300 seconds.

  • Retry: Select this checkbox to try to establish a connection again if the first attempt fails or times out during the execution of a Get, Get Bulk, or Get Queue Details activity. When this checkbox is selected, the following options become available:

    • Retry quantity: Enter the maximum number of connection attempts to make (from 1 to 5).

    • Retry interval (in seconds): Enter how many seconds to wait between each connection attempt (minimum 1 and maximum 5).

• Test: Click to verify the connection using the provided configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.

• Save Changes: Click to save and close the connection configuration.

• Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.

• Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal). A message asks you to confirm that you want to delete the connection.

Next steps

After a Jitterbit MQ connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions menus in Connector basics.

These activity types are available:

• Get Bulk: Retrieves a batch of messages available in a specific Jitterbit message queue and is intended to be used as a source in an operation.

• Acknowledge: Acknowledges messages in a Jitterbit message queue and is intended to be used as a target in an operation.

• Send Bulk: Sends a batch of messages to a Jitterbit message queue and is intended to be used as a target in an operation.

• Get: Retrieves a single message available in a specific Jitterbit message queue and is intended to be used as a source in an operation.

• NACK: Negatively acknowledges messages (using the ackId) and is intended to be used as a target in an operation.

• Get Queue Details: Retrieves queue details for a specific Jitterbit message queue and is intended to be used as a source in an operation.

• Send: Sends a single message to a Jitterbit message queue and is intended to be used as a target in an operation.