Connect to Clari Data in JRuby

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

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

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

Clari API Profile Settings

Obtain your API Key and API Secret from Clari workspace settings under Integrations > Clari Copilot API.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Clari.apip;ProfileSettings='APIKey=your_api_key;APISecret=your_api_secret';

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

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

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

jruby -S APISelect.rb

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