Connect to SageHR Data in JRuby

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

Configure a JDBC Connection to SageHR 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 SageHR\lib).

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

Start by setting the Profile connection property to the location of the SageHR Profile on disk (e.g. C:\profiles\SageHR.apip). Next, set the ProfileSettings connection property to the connection string for SageHR (see below).

SageHR API Profile Settings

Navigate to Settings > Integrations > API in your SageHR account and click Enable API Access to obtain your API key. Your Subdomain is the prefix of your SageHR URL.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the SageHR JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.api.jar

Fill in the connection properties and copy the connection string to the clipboard.

Below is a typical JDBC connection string for SageHR:

jdbc:api:Profile=C:\profiles\SageHR.apip;ProfileSettings='APIKey=your_api_key;Subdomain=your_subdomain';

Create a JRuby App with Connectivity to SageHR Data

Create a new Ruby file (for example: APISelect.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 SageHR 2018/lib/cdata.jdbc.api.jar'

url = "jdbc:api:Profile=C:\profiles\SageHR.apip;ProfileSettings='APIKey=your_api_key;Subdomain=your_subdomain';"
conn = java.sql.DriverManager.getConnection(url)
stmt = conn.createStatement
rs = stmt.executeQuery("SELECT ApplicantId, Action FROM ApplicantActions")
while (rs.next) do
  puts rs.getString(1) + ' ' + rs.getString(2)
end

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

jruby -S APISelect.rb

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