Ready to get started?

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

 Download Now

Learn more:

Jira Service Management Icon Jira Service Management JDBC Driver

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

Access Live Jira Service Management Data in Coginiti Pro



Connect to and query live Jira Service Management data from the GUI in the Coginiti Pro: SQL Analytics Tool.

Coginiti Pro is a single tool for all your SQL data and analytics needs, designed specifically for data engineers, analysts, and data scientists. When paired with the CData JDBC Driver for Jira Service Management, Coginiti Pro can access and query live Jira Service Management data. This article describes how to connect to and query Jira Service Management data from Coginiti Pro.

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

Gather Connection Properties and Build a Connection String

Download the CData JDBC Driver for Jira Service Management installer, unzip the package, and run the JAR file to install the driver. Then gather the required connection properties.

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.

NOTE: To use the JDBC driver in Coginiti Pro, you may need a license (full or trial) and a Runtime Key (RTK). For more information on obtaining this license (or a trial), contact our sales team.

Built-in Connection String Designer

For assistance constructing the JDBC URL, use the connection string designer built into the Jira Service Management JDBC Driver. 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 (including the RTK) and copy the connection string to the clipboard.

Create a JDBC Data Source for Jira Service Management Data

  1. Open Coginiti Pro and in the File menu, select "Edit Drivers."
  2. In the newly opened wizard, click "Add" and select "Generic."
  3. In the "JDBC Drivers" wizard, set the driver properties (below) and click "Create Driver."

    • Set JDBC Driver Name to a useful name, like CData JDBC Driver for Jira Service Management.
    • Click "Add Files" to add the JAR file from the "lib" folder in the installation directory (e.g. cdata.jdbc.jiraservicedesk.jar)
    • Select the Class Name: cdata.jdbc.jiraservicedesk.JiraServiceDeskDriver.

Create a Connection using the CData JDBC Driver for Jira Service Management

  1. In the File menu, click "Edit Connections."
  2. In the newly opened wizard, click "Add" and select "Generic."
  3. In the "Connections" wizard, set the connection properties.
    • Set Connection name to an identifying name.
    • Set Database JDBC driver to the Driver you configured earlier.
    • Set JDBC URL to the JDBC URL configured using the built-in connection string designer (e.g. jdbc:jiraservicedesk:ApiKey=myApiKey;User=MyUser;InitiateOAuth=GETANDREFRESH
  4. Click "Test" to ensure the connection is configured properly. Click "Save."

Query Jira Service Management Using SQL

  1. Open the Connections tab by clicking on database icon: .
  2. Click the plus sign () to add a new query tab.
  3. Once the query console is open, write the SQL script you wish to execute and click "Run at Cursor".

    NOTE: You can use the explorer on the left to determine table/view names and column names.

    Using the explorer

    1. In the "Select connection" field, select the connection you wish to query.
    2. Expand your newly created connection, expand the "CData" catalog, and expand the Jira Service Management catalog.
    3. Expand "Tables" or "Views" to find the entity you wish to query.
    4. Expand your selected entity to explore the fields (columns).

Free Trial & More Information

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