Build Visualizations of Jira Service Desk Data in Birst

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.



Use the CData JDBC Driver for Jira Service Desk and the Birst Cloud Agent to build real-time visualizations of Jira Service Desk data in Birst.

Birst is a cloud business intelligence (BI) tool and analytics platform that helps organizations quickly understand and optimize complex processes. When paired with the CData JDBC Driver for Jira Service Desk, you can connect to live Jira Service Desk data through the Birst Cloud Agent and build real-time visualizations. In this article, we walk you through, step-by-step, how to connect to Jira Service Desk using the Cloud Agent and create dynamic reports in Birst.

With powerful data processing capabilities, the CData JDBC Driver offers unmatched performance for live Jira Service Desk data operations in Birst. When you issue complex SQL queries from Birst 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). With built-in dynamic metadata querying, the JDBC driver enables you to visualize and analyze Jira Service Desk data using native Birst data types.

Configure a JDBC Connection to Jira Service Desk Data in Birst

Before creating the Birst project, you will need to install the Birst Cloud Agent (in order to work with the installed JDBC Driver). Also, copy the JAR file for the JDBC Driver (and the LIC file, if it exists) to the /drivers/ directory in the installation location for the Cloud Agent.

With the driver and Cloud Agent installed, you are ready to begin.

  1. Create a new project in Birst.
  2. Name the connection (e.g. CDataJiraServiceDesk).
  3. Choose Live Access.
  4. Select an agent.
  5. Set Database Type to Other.
  6. Set SQL Type to MSSQL
  7. Set the Connection string.

    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.

    When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

    Below is a typical JDBC connection string for Jira Service Desk:

    jdbc:jiraservicedesk:ApiKey=myApiKey;User=MyUser;InitiateOAuth=GETANDREFRESH
  8. Set the Driver Name: cdata.jdbc.jiraservicedesk.JiraServiceDeskDriver and click Save.

NOTE: Since authentication to Jira Service Desk is managed from the connection string, you can leave Security Credentials blank.

Configure Jira Service Desk Data Objects

Now that the connection is configured, we are ready to configure the schema for the dataset, choosing the tables, views, and columns we wish to visualize.

  1. Select the Schema (e.g. JiraServiceDesk).
  2. Click on Tables and/or Views to connect to those entities and click Apply.
  3. Select the Tables and Columns you want to access and click Done.

With the objects configured, you can perform any data preparation and discover any relationships in your data using the Pronto Prepare and Relate tools.

Build a Visualization

After you prepare your data and define relationships between the connected objects, you are ready to build your visualization.

  1. Select the Visualizer tool from the menu.
  2. Select Measures & Categories from your objects
  3. Select and configure the appropriate visualization for the Measure(s) you selected.

Using the CData JDBC Driver for Jira Service Desk with the Cloud Agent and Birst, you can easily create robust visualizations and reports on Jira Service Desk data. Download a free, 30-day trial and start building Birst visualizations today.