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 Connections page (see Create a global endpoint in Global Connections).

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 Connections page (see Edit a global endpoint in Global Connections).

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:

  • Environment ID: Enter the Harmony environment ID for the environment containing the message queue. The environment ID is found on the Environments page.

  • Jitterbit Region: Select the Jitterbit region the organization belongs to, either APAC, EMEA, or NA (required when using agent version 10.73 or earlier). When using agent version 10.74 or later, the region of the organization currently being accessed is selected by default.

  • Organization ID: Enter the Harmony organization ID (required when using agent version 10.73 or earlier). When using agent version 10.74 or later, this field can be left empty if the Auth Token provided above is associated with the same organization that the project resides in. Otherwise, you must provide the organization ID the authentication token is associated with.

  • Environment ID: Enter the Harmony environment ID for the environment containing the message queue (required when using agent version 10.73 or earlier). When using agent version 10.74 or later, the environment of the project is used when an environment ID is not specified.

  • Connection request timeout in seconds: Enter the time (in seconds) that the connection is to remain established with the Message queue service after servicing a request. The default is 10 seconds and the maximum value allowed is 180 seconds. Changing this value is not recommended.

  • Response timeout in seconds: Enter the time (in seconds) to wait for a response from the Message queue service. The default is 10 seconds and the maximum value allowed is 300 seconds.

  • Connection timeout in seconds: Enter the time (in seconds) to wait until a new connection is fully established. The default is 10 seconds and the maximum value allowed is 300 seconds.

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