Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →Connect to Jira Service Management Data in Ruby
Connect to Jira Service Management data in Ruby with ruby-dbi, dbd-odbc, and ruby-odbc.
The CData ODBC Driver for Jira Service Management makes it easy to integrate connectivity to live Jira Service Management data in Ruby. This article shows how to create a simple Ruby app that connects to Jira Service Management data, executes a query, and displays the results.
Create an ODBC Connection to Jira Service Management Data
If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.
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.
Installing Ruby and Necessary Gems
If you do not have Ruby installed, refer to the Ruby installation page. With Ruby installed, you will need to install the ruby-dbi, dbd-odbc, and ruby-odbc gems:
gem install dbi
gem install dbd-odbc
gem install ruby-odbc
Create a Ruby App with Connectivity to Jira Service Management Data
Create a new Ruby file (for example: JiraServiceDeskSelect.rb) and open it in a text editor. Copy the following code into your file:
#connect to the DSN
require 'DBI'
cnxn = DBI.connect('DBI:ODBC:CData JiraServiceDesk Source','','')
#execute a SELECT query and store the result set
resultSet = cnxn.execute("SELECT RequestId, ReporterName FROM Requests WHERE CurrentStatus = 'Open'")
#display the names of the columns
resultSet.column_names.each do |name|
print name, "\t"
end
puts
#display the results
while row = resultSet.fetch do
(0..resultSet.column_names.size - 1).each do |n|
print row[n], "\t"
end
puts
end
resultSet.finish
#close the connection
cnxn.disconnect if cnxn
With the file completed, you are ready to display your Jira Service Management data with Ruby. To do so, simply run your file from the command line:
ruby JiraServiceDeskSelect.rb
Writing SQL-92 queries to Jira Service Management allows you to quickly and easily incorporate Jira Service Management data into your own Ruby applications. Download a free trial today!