Skip to Content

Microsoft Azure Service Bus connector for Jitterbit Integration Studio

Summary

The Microsoft Azure Service Bus connector establishes access to Microsoft Azure Service Bus.

The Microsoft Azure Service Bus connector provides an interface for creating a Microsoft Azure Service Bus connection, the foundation used for generating instances of Microsoft Azure Service Bus activities. These activities, once configured, interact with Microsoft Azure Service Bus through the connection.

The Microsoft Azure Service Bus connector is accessed from the design component palette's Project endpoints and connectors tab (see Design component palette).

Connector overview

This connector is used to first configure a Microsoft Azure Service Bus connection. Activity types associated with that connection are then used to create instances of activities that are intended to be used as sources (to provide data in an operation) or targets (to consume data in an operation).

Together, a specific Microsoft Azure Service Bus connection and its activities are referred to as a Microsoft Azure Service Bus endpoint:

Microsoft Azure Service Bus activity types

  • Get Queue Message: Retrieves all messages in a Microsoft Azure Service Bus queue and is intended to be used as a source in an operation.

  • Unlock Topic Message: Unlocks messages in a Microsoft Azure Service Bus topic and is intended to be used as a target in an operation.

  • Delete Queue Message: Deletes messages from a Microsoft Azure Service Bus queue and is intended to be used as a target in an operation.

  • Consume Topic: Consumes messages from a Microsoft Azure Service Bus topic and is intended to be used as a source in an operation.

  • Renew Topic Message Lock: Renews message locks in a Microsoft Azure Service Bus topic and is intended to be used as a target in an operation.

  • Delete Topic Message: Deletes messages from a Microsoft Azure Service Bus topic and is intended to be used as a target in an operation.

  • Send Message: Sends messages to a Microsoft Azure Service Bus queue or topic and is intended to be used as a target in an operation.

  • Consume Queue: Consumes messages from a Microsoft Azure Service Bus queue and is intended to be used as a source in an operation.

  • Renew Queue Message Lock: Renews message locks in a Microsoft Azure Service Bus queue and is intended to be used as a target in an operation.

  • Get Topic Message: Retrieves messages from a Microsoft Azure Service Bus topic and is intended to be used as a source in an operation.

  • Unlock Queue Message: Unlocks messages from a Microsoft Azure Service Bus queue and is intended to be used as a target in an operation.

Note

This connector is a Connector SDK-based connector, which may be referred to by Jitterbit when communicating changes made to connectors built with the Connector SDK.

Prerequisites and supported API versions

To use the Microsoft Azure Service Bus connector, the use of an agent version 11.26 or later is recommended. These agent versions automatically download the latest version of the connector when required.

When using agent version 10.87 / 11.25 or earlier, an excessive number of INFO logs are generated in a short time period, leading to disk space issues as a result of the size of the catalina.out file. This known issue is resolved for agent version 11.26 and later.

An upgrade to agent version 11.26 or later is recommended. As an alternative, this issue can be resolved in agent version 10.87 / 11.25 or earlier by adding the following settings to the logback.xml file located in C:\Program Files\Jitterbit Agent\tomcat\shared\lib (Windows) or /opt/jitterbit/tomcat/shared/lib (Linux):

<logger name="com.azure.core.amqp" level="ERROR"/>
<logger name="com.azure.messaging.servicebus" level="ERROR"/>
<logger name="com.azure.core.implementation" level="ERROR"/>

The Microsoft Azure Service Bus connector uses the Microsoft Azure Service Bus Client for Java v3.6.7. Refer to the API documentation for information on the schema nodes and fields.

Prior to using the Consume queue and Consume topic activities, certain prerequisites must be met.

Troubleshooting

If you experience issues with the Microsoft Azure Service Bus connector, these troubleshooting steps are recommended:

  1. Click the Test button in the connection configuration to ensure the connection is successful and to ensure the latest version of the connector is downloaded to the agent (unless using the Disable Auto Connector Update organization policy).

  2. Check the operation logs for any information written during execution of the operation.

  3. Enable operation debug logging (for cloud agents or for private agents) to generate additional log files and data.

  4. If using private agents, ensure you are using agent version 11.26 or later and check the agent logs for more information.

  5. For additional troubleshooting considerations, see Operation troubleshooting.