How to connect to Jira Service Desk Data in DBVisualizer

The CData JDBC Driver for Jira Service Desk implements JDBC standards to provide connectivity to Jira Service Desk data in applications ranging from business intelligence tools to IDEs. This article shows how to establish a connection to Jira Service Desk data in DBVisualizer and use the table editor to edit and save Jira Service Desk data.

Create a New Driver Definition for Jira Service Desk Data

Follow the steps below to use the Driver Manager to provide connectivity to Jira Service Desk data from DBVisualizer tools.

1. In DBVisualizer, click Tools -> Driver Manager.
2. Click the plus sign "" to create a new driver.
3. Select "Custom" as the template.
4. On the Driver Settings tab:
   • Set Name to a user-friendly name (e.g. "CData Jira Service Desk Driver")
   • Set URL Format to jdbc:jiraservicedesk:
   • In Driver artifacts and jar files (jars are loaded in order from top):
     1. Click the plus sign "" -> "Add Files"
     2. Navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\)
     3. Select the JAR file (cdata.jdbc.JiraServiceDesk.jar) and click "Open"
5. The Driver Class should populate automatically. If not, select class (cdata.jdbc.jiraservicedesk.JiraServiceDeskDriver).

Define the Connection to the JDBC Data Source

Close the "Driver Manager" and follow the steps below to save connection properties in the JDBC URL.

1. In the "Databases" tab, click the plus sign "" and select the driver you just created.

2. In the "Connection" section, set the following options:

   • Database Type: If you selected the wizard option, the database type is automatically detected. If you selected the "No Wizard" option, select the Generic or Auto Detect option in the Database Type menu.
   • Driver Type: Select the driver you just created.

   • Database URL: Enter the full JDBC URL. The syntax of the JDBC URL is jdbc:jiraservicedesk: followed by the connection properties in a semicolon-separated list of name-value pairs.

     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 connection string is below:

     jdbc:jiraservicedesk:ApiKey=myApiKey;User=MyUser;InitiateOAuth=GETANDREFRESH
3. On the Connection tab, click Connect.

To browse through tables exposed by the Jira Service Desk JDBC Driver, right-click a table and click "Open in New Tab."

To execute SQL queries, use the SQL Commander tool: Click SQL Commander -> New SQL Commander. Select the Database Connection, Database, and Schema from the available menus.

See the "Supported SQL" chapter in the help documentation for more information on the supported SQL. See the "Data Model" chapter for table-specific information.

More Information & Free Trial