Connect to Factorial Data in JRuby

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

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

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

Authentication

Factorial uses OAuth 2.0 for authentication to connect to your HR data or to allow other users to connect to their data.

Using OAuth Authentication

To connect using OAuth, follow these steps:

1. Navigate to your Factorial admin panel and create a new OAuth application.
2. Copy the Client ID and Client Secret from your application configuration.
3. Configure the following connection properties:

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to OAuth.
• OAuthClientId: Set this to your OAuth Client ID.
• OAuthClientSecret: Set this to your OAuth Client Secret.
• Scope: Set this to specify the data access permissions (default: "read write").

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Factorial.apip;AuthScheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

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

url = "jdbc:api:Profile=C:\profiles\Factorial.apip;AuthScheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;"
conn = java.sql.DriverManager.getConnection(url)
stmt = conn.createStatement
rs = stmt.executeQuery("SELECT ,  FROM Agreements")
while (rs.next) do
  puts rs.getString(1) + ' ' + rs.getString(2)
end

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

jruby -S APISelect.rb

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