How to connect to Jira Service Management Data from IntelliJ

The CData JDBC Driver for Jira Service Management enables you to access Jira Service Management as a JDBC data source, providing integration with rapid development tools in IDEs. This article shows how to use the data source configuration wizard to connect to Jira Service Management data in IntelliJ.

Create a JBDC Data Source for Jira Service Management

Follow the steps below to add the driver JAR and define connection properties required to connect to Jira Service Management data.

1. In the Data Sources window, right-click and then click Add Data Source -> DB Data Source.

2. In the Data Source Properties dialog that appears, the following properties are required:

   • JDBC Driver Files: Click the button next to this menu to add the JDBC Driver file cdata.jdbc.jiraservicedesk.jar, located in the installation directory.
   • JDBC Driver Class: In this menu, select cdata.jdbc.jiraservicedesk.JiraServiceDeskDriver from the list.

   • Database URL: Enter the connection URL in the JDBC URL property. The URL must start with jdbc:jiraservicedesk: and includes connection properties separated with semicolons.

     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 the following:

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

Edit and Save Jira Service Management Data

To discover schema information, right-click the data source you just created and click Refresh Tables. To query a table, right-click it and then click Open Tables Editor. You can also modify records in the Table Editor.