Integrate with Jira Service Desk Data in JReport Designer

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 charts and reports based on Jira Service Desk data in JReport Designer.

The CData JDBC Driver for Jira Service Desk data enables access to live data from dashboards and reports as if Jira Service Desk were a relational database, allowing you to query Jira Service Desk data using familiar SQL queries. This article shows how to connect to Jira Service Desk data as a JDBC data source and create reports based on Jira Service Desk data in JReport Designer.

Connect to Jira Service Desk Data

  1. Edit C:\JReport\Designer\bin\setenv.bat to add the location of the JAR file to the ADDCLASSPATH variable:
    ...
    set ADDCLASSPATH=%JAVAHOME%\lib\tools.jar;C:\Program Files\CData\CData JDBC Driver for Jira Service Desk 2016\lib\cdata.jdbc.jiraservicedesk.jar;
    ...
    
  2. Create a new data source by clicking File New Data Source.
  3. In the resulting dialog, create a name for the data source (CData JDBC Driver for Jira Service Desk), select JDBC, and click OK.
  4. In the Get JDBC Connection Information dialog you will configure your connection to the JDBC driver:
    • Driver: Be sure that the Driver box is checked and fill in the name of the class for the driver: cdata.jdbc.jiraservicedesk.JiraServiceDeskDriver
    • URL: Enter the JDBC URL. This starts with jdbc:jiraservicedesk: and is followed by a semicolon-separated list of 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.

      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 URL:

      jdbc:jiraservicedesk:ApiKey=myApiKey;User=MyUser;InitiateOAuth=GETANDREFRESH
    • User: The username to authenticate with; typically left blank.
    • Password: The password to authenticate with; typically left blank.
  5. In the Add Table dialog, select the tables you wish to include in your report (or in future reports using this data source) and click Add.

    Click Done once the dialog has completed loading the tables.

  6. In the Catalog Browser, you can create the queries that you will use to populate your reports. You can do this now, or after you create your report. In either case, expand () the data source (CData JDBC Driver for Jira Service Desk), right-click on Queries, and select Add Query.
  7. In the Add Table/View/Query dialog, expand () the JDBC URL and Tables and select the table(s) you wish to use in the query and click OK.
  8. In the Query Editor dialog, you can select the columns you wish to include or simply click the SQL button and manually input your own query. For example:
    SELECT RequestId, ReporterName FROM Requests WHERE CurrentStatus = 'Open'
    

    With the query built, click OK to close the Query Editor dialog. At this point you are ready to add Jira Service Desk data to a new or existing report.

    NOTE: Now that the query is built, you can create a Business View based on the query. With a Business View, you can create Web reports or library components based on the query. For more information on this, refer to the JReport tutorials.

Add Jira Service Desk Data to a Report

You are now ready to create a report with Jira Service Desk data.

  1. Create a new report (File New Page Report) or open the Chart Wizard for an existing report.
  2. Select the Query (or create a new one; see above).
  3. Assign a Category and Value for the chart from the columns in your Query and click Finish.
  4. Click the View tab for your report to see the chart.