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 from a Connection Pool in JBoss



Integrate Jira Service Desk data into Java servlets: Use the Management Console in JBoss to install the Jira Service Desk JDBC Driver.

CData JDBC drivers can be configured in JBoss by following the standard procedure for connection pooling. This article details how to access Jira Service Desk data from a connection pool in JBoss applications. This article details how to use the JBoss Management Interface to configure the CData JDBC Driver for Jira Service Desk. You will then access Jira Service Desk data from a connection pool.

Create a JDBC Data Source for Jira Service Desk from the Management Console

Follow the steps below to add the driver JAR and define required connection properties.

  1. In the Runtime menu, select the Domain or Server menu, depending on whether you are deploying to a managed domain or to a stand-alone server, and click "Manage deployments" to open the Deployments page.
  2. Click Add. In the resulting wizard, add the JAR file and license for the driver, located in the lib subfolder of the installation directory. Finish the wizard with the defaults, select the driver, and click Enable.
  3. In the Configuration menu, click Subsystems -> Connector -> Datasources. This opens the JDBC Datasources page.
  4. Click Add and, in the resulting wizard, enter a name for the driver and the JNDI name. For example: java:jboss/root/jdbc/JiraServiceDesk
  5. Select the driver that you added above.
  6. Enter the JDBC URL and the username and password. The syntax of the JDBC URL is jdbc:jiraservicedesk: 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, 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 connection string is below:

    jdbc:jiraservicedesk:ApiKey=myApiKey;User=MyUser;InitiateOAuth=GETANDREFRESH
  7. Test the connection and finish the wizard. Select the Jira Service Desk data source and click Enable.

More JBoss Integration

The steps above show how to configure the driver in a simple connection pooling scenario. For more information, refer to the Data Source Management chapter in the JBoss EAP documentation.