Skip to Content

Jira Connector

Summary

The Harmony Jira Connector establishes access to Jira.

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

The Jira connector supports Jira Software Cloud, Jira Server, and Jira Data Center.

Note

The Jira connector supports standard custom fields. Advanced custom fields are not supported.

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

Connector Overview

This connector is used to first configure a Jira 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 Jira connection and its activities are referred to as a Jira endpoint:

Jira activity types

  • Search: Retrieves object data from a Jira project and is intended to be used as a source in an operation.

  • Issue: Creates, updates, or deletes an issue in a Jira project and is intended to be used as a target in an operation.

  • Create: Creates object data in a Jira project and is intended to be used as a target in an operation.

  • Update: Updates object data in a Jira project and is intended to be used as a target in an operation.

  • Search Dashboard: Retrieves dashboard data from Jira and is intended to be used as a source in an operation.

  • Delete: Deletes object data from Jira and is intended to be used as a target in an operation.

  • Transition: Retrieves or updates Jira issues and is intended to be used as a target in an operation.

  • Search Filter: Retrieves filter data from Jira and is intended to be used as a source 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

The Jira 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.

The Jira connector uses the Jira REST API v3 for the Jira Cloud instance type and Jira REST API v2 for the Jira On-premise instance type. Refer to the API documentation for information on the schema nodes and fields.

The Jira On-premise instance type is supported with Jira Server and Jira Data Center versions 8.22.3 and 9.4.3.

This connector supports 3-legged OAuth 2.0 authentication for agent version 10.83 / 11.21 or later.

Troubleshooting

If you experience issues with the Jira 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, you can enable connector verbose logging for this connector using this specific configuration entry of logger name and level:

    <logger name="org.jitterbit.connector.jira" level="DEBUG"/>
    
  5. If using Private Agents, you can check the agent logs for more information.