Ready to get started?

Download a free trial of the Jira Service Desk Driver to get started:

 Download Now

Learn more:

Jira Service Desk Icon Jira Service Desk JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Jira Service Desk.

Connect to Jira Service Desk Data in NetBeans



Connect to Jira Service Desk data in NetBeans with the data source configuration wizard.

The CData JDBC Driver for Jira Service Desk integrates connectivity to live Jira Service Desk data in IDEs that support JDBC. The JDBC standard enables you to use built-in data access wizards and other tools supporting rapid development. This article shows how to connect to Jira Service Desk data in NetBeans. You will create a connection and edit and save Jira Service Desk data in the Table Editor.

Create a JDBC Data Source for Jira Service Desk in NetBeans

To create the JDBC data source, expand the Database node in the Service window, right-click the Drivers node, and select New Driver. In the New Driver wizard that results, enter the following information:

  • Driver File(s): Click Add and, in the file explorer dialog that appears, select the cdata.jdbc.jiraservicedesk.jar file. The driver JAR is located in the lib subfolder of the installation directory.
  • Driver Class: Click Find to search for the driver class inside the JAR. Then select cdata.jdbc.jiraservicedesk.JiraServiceDeskDriver from the menu.
  • Name: Enter the name for the driver.

Define Connection Parameters

Follow the steps below to define required connection properties:

  1. In the Service window, right-click the Database node and click New Connection.

  2. In the New Connection Wizard, enter the following connection properties:

    • Driver Name: In the menu, select the CData JDBC Driver for Jira Service Desk.
    • User Name: Enter the username. This can also be defined in the JDBC URL.
    • Password: Enter the password. This can also be defined in the JDBC URL.
    • JDBC URL: Specify 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.

      A typical JDBC URL is the following:

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

Query Jira Service Desk Data

To connect to Jira Service Desk data, right-click the connection in the Database node and click Connect. After the connection is established, you can expand it to discover schema information.

To load a table in the Data Views window, right-click the table and then click View Data. You can also insert, update, or delete records in the Data Views window.