Skip to Content

Jira Service Management Connector

Summary

The Jira Service Management connector establishes access to Jira Service Management.

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

The Jira Service Management connector is accessed from the design component palette's Connections tab (see Design Component Palette).

The connector works with both Jira Service Desk Cloud accounts and Jira Service Desk Server instances.

Atlassian Jira Service Management was formerly known as Jira Service Desk and received its new name as of its version 4.14. However, there are many references to Service Desk in this documentation, the Atlassian documentation, and the Atlassian REST APIs. See the Atlassian Service Management 4.14.x release notes for details.

Note

This connector can be used only with Private Agents. In addition, it is a Connector SDK-based connector, which may be referred to by Jitterbit when communicating changes made to connectors built with the Connector SDK.

Connection Documentation

In addition to the Jira Service Management connection, see the comprehensive Jira Service Management connection details page. Configuration details such as these are included on that page:

  • Getting Started: Initial steps for establishing a connection.
  • Advanced Features: User-defined views and SSL configuration.
  • Data Model: The data model that the connector uses to represent the endpoint.
  • Advanced Configurations Properties: Properties that can be defined to configure a connection for both basic and advanced configurations.

Activity Documentation

Together, a specific Jira Service Management connection and its activities are referred to as a Jira Service Management endpoint:

Jira Service Management activity types

  • Query: Retrieves records from a table at Jira Service Management and is intended to be used as a source in an operation.

  • Create: Inserts a record into a table at Jira Service Management and is intended to be used as a target in an operation.

  • Update: Updates a record in a table at Jira Service Management and is intended to be used as a target in an operation.

  • Delete: Deletes a record from a table at Jira Service Management and is intended to be used as a target in an operation.

  • Execute: Executes a procedure at Jira Service Management and is intended to be used as a target in an operation.

Prerequisites and Supported API Versions

The Jira Service Management connector requires the use of an agent version 10.1 or later. These agent versions automatically download the latest version of the connector when required.

This connector requires the use of a Private Agent.

Refer to the Atlassian documentation for information on the schema nodes and fields.

OAuth Authentication

OAuth authentication is supported as described in Configure OAuth Connections.

Troubleshooting

If you experience issues with the Jira Service Management 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 Private Agents to generate additional log files and data.

  4. Enable connector verbose logging for this connector using this specific configuration entry of logger name and level:

    <logger name="org.jitterbit.connector.verbose.logging.JiraServiceDesk" level="TRACE"/>
    
  5. Check the agent logs for more information.