Connect to Pipeliner CRM Data in JRuby

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

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

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

Pipeliner CRM API Profile Settings

Navigate to Administration > Obtain API Key within your Pipeliner CRM workspace to retrieve the API Token, API Password, Space ID, and Service URL.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Pipeliner.apip;ProfileSettings='User=your_api_token;Password=your_api_password;SpaceId=your_space_id;ServiceUrl=your_service_url';

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

url = "jdbc:api:Profile=C:\profiles\Pipeliner.apip;ProfileSettings='User=your_api_token;Password=your_api_password;SpaceId=your_space_id;ServiceUrl=your_service_url';"
conn = java.sql.DriverManager.getConnection(url)
stmt = conn.createStatement
rs = stmt.executeQuery("SELECT Success, Id FROM Account")
while (rs.next) do
  puts rs.getString(1) + ' ' + rs.getString(2)
end

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

jruby -S APISelect.rb

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