Connect to Jira Service Management Data in Aqua Data Studio

The CData JDBC Driver for Jira Service Management integrates Jira Service Management data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Jira Service Management data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The Jira Service Management data source can then be accessed from Aqua Data Studio tools.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. Enter the following JDBC connection properties:
   • Name: Enter a name for the data source; for example, Jira Service Management.
   • Driver Location: Click the Browse button and select the cdata.jdbc.jiraservicedesk.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.jiraservicedesk.JiraServiceDeskDriver.

   • URL: Enter the JDBC URL, which 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, 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 Management 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.

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     A typical JDBC URL is below:

     jdbc:jiraservicedesk:ApiKey=myApiKey;User=MyUser;InitiateOAuth=GETANDREFRESH;

   👁 The JDBC data source, defined by the JAR path, driver class, and JDBC URL. (QuickBooks is shown.)
   

Query Jira Service Management Data

You can now query the tables exposed.