Ready to get started?

Download a free trial of the Jira Service Desk Driver to get started:

 Download Now

Learn more:

Jira Service Desk Icon Jira Service Desk JDBC Driver

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

Connect to Jira Service Desk Data in HULFT Integrate



Connect to Jira Service Desk as a JDBC data source in HULFT Integrate

HULFT Integrate is a modern data integration platform that provides a drag-and-drop user interface to create cooperation flows, data conversion, and processing so that complex data connections are easier than ever to execute. When paired with the CData JDBC Driver for Jira Service Desk, HULFT Integrate can work with live Jira Service Desk data. This article walks through connecting to Jira Service Desk and moving the data into a CSV file.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Jira Service Desk data. When you issue complex SQL queries to Jira Service Desk, the driver pushes supported SQL operations, like filters and aggregations, directly to Jira Service Desk and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze Jira Service Desk data using native data types.

Enable Access to Jira Service Desk

To enable access to Jira Service Desk data from HULFT Integrate projects:

  1. Copy the CData JDBC Driver JAR file (and license file if it exists), cdata.jdbc.jiraservicedesk.jar (and cdata.jdbc.jiraservicedesk.lic), to the jdbc_adapter subfolder for the Integrate Server
  2. Restart the HULFT Integrate Server and launch HULFT Integrate Studio

Build a Project with Access to Jira Service Desk Data

Once you copy the JAR files, you can create a project with access to Jira Service Desk data. Start by opening Integrate Studio and creating a new project.

  1. Name the project
  2. Ensure the "Create script" checkbox is checked
  3. Click Next
  4. Name the script (e.g.: JiraServiceDesktoCSV)

Once you create the project, add components to the script to copy Jira Service Desk data to a CSV file.

Configure an Execute Select SQL Component

Drag an "Execute Select SQL" component from the Tool Palette (Database -> JDBC) into the Script workspace.

  1. In the "Required settings" tab for the Destination, click "Add" to create a new connection for Jira Service Desk. Set the following properties:
    • Name: Jira Service Desk Connection Settings
    • Driver class name: cdata.jdbc.jiraservicedesk.JiraServiceDeskDriver
    • URL: jdbc:jiraservicedesk:ApiKey=myApiKey;User=MyUser;InitiateOAuth=GETANDREFRESH

      Built-in Connection String Designer

      For assistance 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.

      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.

  2. Write your SQL statement. For example:
    SELECT RequestId, ReporterName FROM Requests
  3. Click "Extraction test" to ensure the connection and query are configured properly
  4. Click "Execute SQL statement and set output schema"
  5. Click "Finish"

Configure a Write CSV File Component

Drag a "Write CSV File" component from the Tool Palette (File -> CSV) onto the workspace.

  1. Set a file to write the query results to (e.g. Requests.csv)
  2. Set "Input data" to the "Select SQL" component
  3. Add columns for each field selected in the SQL query
  4. In the "Write settings" tab, check the checkbox to "Insert column names into first row"
  5. Click "Finish"

Map Jira Service Desk Fields to the CSV Columns

Map each column from the "Select" component to the corresponding column for the "CSV" component.

Finish the Script

Drag the "Start" component onto the "Select" component and the "CSV" component onto the "End" component. Build the script and run the script to move Jira Service Desk data into a CSV file.

Download a free, 30-day trial of the CData JDBC Driver for Jira Service Desk and start working with your live Jira Service Desk data in HULFT Integrate. Reach out to our Support Team if you have any questions.