Manage Jira Service Management Data in DBArtisan as a JDBC Source

The CData JDBC Driver for Jira Service Management seamlessly integrates Jira Service Management data into database management tools like DBArtisan by enabling you to access Jira Service Management data as a database. This article shows how to create a JDBC source for Jira Service Management in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate Jira Service Management Data into DBArtisan Projects

Follow the steps below to register Jira Service Management data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory. 👁 The JDBC driver definition in the Register Datasource wizard. (Salesforce is shown.)
   
5. In the Connection URL box, enter credentials and other required connection properties in 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, 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.

   👁 Required JDBC connection properties in the Register Datasource wizard. (Salesforce is shown.)
   

   Below is a typical connection string:

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

6. Finish the wizard to connect to Jira Service Management data. Jira Service Management entities are displayed in the Datasource Explorer.

You can now work with Jira Service Management data as you work with any other database. See the driver help documentation for more information on the queries supported by the Jira Service Management API.