Connect to Ontraport Data in JRuby

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

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

JRuby natively supports JDBC, so you can easily connect to Ontraport 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 Ontraport Profile on disk (e.g. C:\profiles\Ontraport.apip). Next, set the ProfileSettings connection property to the connection string for Ontraport (see below).

Ontraport API Profile Settings

In your Ontraport account, navigate to Administration > Integrations > ONTRAPORT API Instructions and Key Manager to obtain both your API Key and App ID.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Ontraport 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 Ontraport:

jdbc:api:Profile=C:\profiles\Ontraport.apip;ProfileSettings='APIKey=your_api_key;AppId=your_app_id';

Create a JRuby App with Connectivity to Ontraport 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 Ontraport 2018/lib/cdata.jdbc.api.jar'

url = "jdbc:api:Profile=C:\profiles\Ontraport.apip;ProfileSettings='APIKey=your_api_key;AppId=your_app_id';"
conn = java.sql.DriverManager.getConnection(url)
stmt = conn.createStatement
rs = stmt.executeQuery("SELECT Id, Name FROM Campaigns")
while (rs.next) do
  puts rs.getString(1) + ' ' + rs.getString(2)
end

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

jruby -S APISelect.rb

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