Design BIRT Reports on Jira Service Desk Data

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.



Provide current Jira Service Desk data to your embedded analytics.

The CData JDBC Driver for Jira Service Desk integrates connectivity to Jira Service Desk APIs into your data-driven Java applications. You can use the CData JDBC Driver for Jira Service Desk with the BIRT (Business Intelligence Reporting Tools) platform to create BIRT reports that reflect changes to your data in real time.

  1. If you have not already done so, install the BIRT Framework plugin and the Database Development plugin for Eclipse.
  2. Click File -> New -> Report. The Report Design perspective is opened.
  3. In the Data Explorer, right-click Data Sources and click New Data Source.
  4. Select the Create from a Data Source Type in the Following List option and select JDBC Data Source.
  5. Click Manage Drivers and add the driver JAR, located in the lib subfolder of the installation folder.
  6. In the Database URL box, enter the JDBC URL containing 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.

    A typical JDBC URL is below:

    jdbc:jiraservicedesk:ApiKey=myApiKey;User=MyUser;InitiateOAuth=GETANDREFRESH
  7. Right-click the Data Sets folder and select the JDBC data source for Jira Service Desk.
  8. In the resulting dialog, build the SELECT query to be used to retrieve the data for the report. This article uses the following query: SELECT RequestId, ReporterName FROM Requests WHERE CurrentStatus = 'Open'
  9. In the Palette, drag a Chart onto the editor. The chart wizard is displayed.
  10. After selecting the chart type, drag columns onto the chart fields on the Select Data tab.
  11. Click Run -> View Report -> In Web Viewer to view the report.

Your BIRT reports can now pick up any updates to Jira Service Desk data.

To publish the report to your application server, add the driver JAR to the BIRT Viewer's classpath. For more information, see the CData KB for guides to deploying the JDBC Driver on Java application servers.