Connect to Highrise Data in JRuby

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Highrise JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Highrise account data including Accounts, Deals, Emails, People, Tasks, and more!



Create a simple JRuby app with access to live Highrise data.

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

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

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

Highrise uses the OAuth authentication standard. To authenticate to Highrise, you will need to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL by registering an app with Highrise. You will also need to set the AccountId to connect to data.

See the "Getting Started" section in the help documentation for a guide to using OAuth.

Built-in Connection String Designer

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

java -jar cdata.jdbc.highrise.jar

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

Below is a typical JDBC connection string for Highrise:

jdbc:highrise:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost;AccountId=MyAccountId;InitiateOAuth=GETANDREFRESH

Create a JRuby App with Connectivity to Highrise Data

Create a new Ruby file (for example: HighriseSelect.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 Highrise 2018/lib/cdata.jdbc.highrise.jar' url = "jdbc:highrise:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost;AccountId=MyAccountId;InitiateOAuth=GETANDREFRESH" conn = java.sql.DriverManager.getConnection(url) stmt = conn.createStatement rs = stmt.executeQuery("SELECT Name, Price FROM Deals") while (rs.next) do puts rs.getString(1) + ' ' + rs.getString(2) end

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

jruby -S HighriseSelect.rb

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