Connect to Jira Service Desk Data in JRuby

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Jira Service Desk JDBC Driver

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



Create a simple JRuby app with access to live Jira Service Desk data.

JRuby is a high-performance, stable, fully threaded Java implementation of the Ruby programming language. The CData JDBC Driver for Jira Service Desk makes it easy to integrate connectivity to live Jira Service Desk data in JRuby. This article shows how to create a simple JRuby app that connects to Jira Service Desk data, executes a query, and displays the results.

Configure a JDBC Connection to Jira Service Desk Data

Before creating the app, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for Jira Service Desk\lib).

JRuby natively supports JDBC, so you can easily connect to Jira Service Desk and execute SQL queries. Initialize the JDBC connection with the getConnection function of the java.sql.DriverManager class.

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.

Below is a typical JDBC connection string for Jira Service Desk:

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

Create a JRuby App with Connectivity to Jira Service Desk Data

Create a new Ruby file (for example: JiraServiceDeskSelect.rb) and open it in a text editor. Copy the following code into your file:

require 'java' require 'rubygems' require 'C:/Program Files/CData/CData JDBC Driver for Jira Service Desk 2018/lib/cdata.jdbc.jiraservicedesk.jar' url = "jdbc:jiraservicedesk:ApiKey=myApiKey;User=MyUser;InitiateOAuth=GETANDREFRESH" conn = java.sql.DriverManager.getConnection(url) stmt = conn.createStatement rs = stmt.executeQuery("SELECT RequestId, ReporterName FROM Requests") while (rs.next) do puts rs.getString(1) + ' ' + rs.getString(2) end

With the file completed, you are ready to display your Jira Service Desk data with JRuby. To do so, simply run your file from the command line:

jruby -S JiraServiceDeskSelect.rb

Writing SQL-92 queries to Jira Service Desk allows you to quickly and easily incorporate Jira Service Desk data into your own JRuby applications. Download a free trial today!