Jira Service Desk Reporting in OBIEE with the Jira Service Desk JDBC Driver

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.



Deploy the Jira Service Desk JDBC driver on OBIEE to provide real-time reporting across the enterprise.

The CData JDBC Driver for Jira Service Desk is a standard database driver that can integrate real-time access to Jira Service Desk data into your Java-based reporting server. This article shows how to deploy the driver to Oracle Business Intelligence Enterprise Edition (OBIEE) and create reports on Jira Service Desk data that reflect any changes.

Deploy the JDBC Driver

Follow the steps below to add the JDBC driver to WebLogic's classpath.

For WebLogic 12.2.1, simply place the driver JAR and .lic file into DOMAIN_HOME\lib; for example, ORACLE_HOME\user_projects\domains\MY_DOMAIN\lib. These files will be added to the server classpath at startup.

You can also manually add the driver to the classpath: This is required for earlier versions. Prepend the following to PRE_CLASSPATH in setDomainEnv.cmd (Windows) or setDomainEnv.sh (Unix). This script is located in the bin subfolder of the folder for that domain. For example: ORACLE_HOME\user_projects\domains\MY_DOMAIN\bin.

set PRE_CLASSPATH=your-installation-directory\lib\cdata.jdbc.jiraservicedesk.jar;%PRE_CLASSPATH%

Restart all servers; for example, run the stop and start commands in DOMAIN_HOME\bitools\bin.

Create a JDBC Data Source for Jira Service Desk

After deploying the JDBC driver, you can create a JDBC data source from BI Publisher.

  1. Log into BI Publisher, at the URL http://localhost:9502/analytics, for example, and click Administration -> Manage BI Publisher.
  2. Click JDBC Connection -> Add Data Source.
  3. Enter the following information:
    • Data Source Name: Enter the name that users will create connections to in their reports.
    • Driver Type: Select Other.
    • Database DriverClass: Enter the driver class, cdata.jdbc.jiraservicedesk.JiraServiceDeskDriver.
    • Connection String: Enter the JDBC URL.

      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
    • Username: Enter the username.
    • Password: Enter the password.
  4. In the Security section, select the allowed user roles.

Create Real-Time Jira Service Desk Reports

You can now create reports and analyses based on real-time Jira Service Desk data. Follow the steps below to use the standard report wizard to create an interactive report that reflects any changes to Jira Service Desk data.

  1. On the global header, click New -> Data Model.
  2. On the Diagram tab, select SQL query in the menu.
  3. Enter a name for the query and in the Data Source menu select the Jira Service Desk JDBC data source you created.
  4. Select standard SQL and enter a query like the following: SELECT RequestId, ReporterName FROM Requests WHERE CurrentStatus = 'Open'
  5. Click View Data to generate the sample data to be used as you build your report.
  6. Select the number of rows to include in the sample data, click View, and then click Save As Sample Data.
  7. Click Create Report -> Use Data Model.
  8. Select Guide Me and on the Select Layout page select the report objects you want to include. In this example we select Chart and Table.
  9. Drop a numeric column like ReporterName onto the Drop Value Here box on the y-axis. Drop a dimension column like RequestId onto the Drop Label Here box on the x-axis.
  10. Click Refresh to pick up any changes to the Jira Service Desk data.