Access Jira Service Desk Data in Mule Applications Using the CData JDBC Driver

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Jira Service Desk JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Jira Service Desk.



Create a simple Mule Application that uses HTTP and SQL with the CData JDBC Driver for Jira Service Desk to create a JSON endpoint for Jira Service Desk data.

The CData JDBC Driver for Jira Service Desk connects Jira Service Desk data to Mule applications enabling read , write, update, and delete functionality with familiar SQL queries. The JDBC Driver allows users to easily create Mule applications to backup, transform, report, and analyze Jira Service Desk data.

This article demonstrates how to use the CData JDBC Driver for Jira Service Desk inside of a Mule project to create a Web interface for Jira Service Desk data. The application created allows you to request Jira Service Desk data using an HTTP request and have the results returned as JSON. The exact same procedure outlined below can be used with any CData JDBC Driver to create a Web interface for the 200+ available data sources.

  1. Create a new Mule Project in Anypoint Studio.
  2. Add an HTTP Connector to the Message Flow.
  3. Configure the address for the HTTP Connector.
  4. Add a Database Select Connector to the same flow, after the HTTP Connector.
  5. Create a new Connection (or edit an existing one) and configure the properties.
    • Set Connection to "Generic Connection"
    • Select the CData JDBC Driver JAR file in the Required Libraries section (e.g. cdata.jdbc.jiraservicedesk.jar).
    • Set the URL to the connection string for Jira Service Desk

      You can establish a connection to any Jira Service Desk Cloud account or Server instance.

      Connecting with a Cloud Account

      To connect to a Cloud account, you'll first need to retrieve an APIToken. To generate one, log in to your Atlassian account and navigate to API tokens > Create API token. The generated token will be displayed.

      Supply the following to connect to data:

      • User: Set this to the username of the authenticating user.
      • APIToken: Set this to the API token found previously.

      Connecting with a Service Account

      To authenticate with a service account, you will need to supply the following connection properties:

      • User: Set this to the username of the authenticating user.
      • Password: Set this to the password of the authenticating user.
      • URL: Set this to the URL associated with your JIRA Service Desk endpoint. For example, https://yoursitename.atlassian.net.

      Note: Password has been deprecated for connecting to a Cloud Account and is now used only to connect to a Server Instance.

      Accessing Custom Fields

      By default, the connector only surfaces system fields. To access the custom fields for Issues, set IncludeCustomFields.

      Built-in Connection String Designer

      For assistance in constructing the JDBC URL, use the connection string designer built into the Jira Service Desk JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

      java -jar cdata.jdbc.jiraservicedesk.jar

      Fill in the connection properties and copy the connection string to the clipboard.

    • Set the Driver class name to cdata.jdbc.jiraservicedesk.JiraServiceDeskDriver.
    • Click Test Connection.
  6. Set the SQL Query Text to a SQL query to request Jira Service Desk data. For example: SELECT RequestId, ReporterName FROM Requests WHERE CurrentStatus = 'Open'
  7. Add a Transform Message Component to the flow.
  8. Set the Output script to the following to convert the payload to JSON:
    %dw 2.0
    output application/json
    ---
    payload
            
  9. To view your Jira Service Desk data, navigate to the address you configured for the HTTP Connector (localhost:8081 by default): http://localhost:8081. The Jira Service Desk data is available as JSON in your Web browser and any other tools capable of consuming JSON endpoints.

At this point, you have a simple Web interface for working with Jira Service Desk data (as JSON data) in custom apps and a wide variety of BI, reporting, and ETL tools. Download a free, 30 day trial of the JDBC Driver for Jira Service Desk and see the CData difference in your Mule Applications today.