Connect to ADP Data in JRuby

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

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

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

Connect to ADP by specifying the following properties:

• OAuthClientId: The client Id of the custom OAuth application you obtained from ADP.
• OAuthClientSecret: The custom OAuth application's client secret.
• SSLClientCert: Set this to the certificate provided during registration.
• SSLClientCertPassword: Set this to the password of the certificate.
• UseUAT: The connector makes requests to the production environment by default. If using a developer account, set UseUAT = true.
• RowScanDepth: The maximum number of rows to scan for the custom fields columns available in the table. The default value will be set to 100. Setting a high value may decrease performance.

The connector uses OAuth to authenticate with ADP. OAuth requires the authenticating user to interact with ADP using the browser. OAuth access can be configured in ADP through ADP API Central. For more information, refer ADP's API Central Quick Start Guide and the OAuth section in CData's Help documentation.

Built-in Connection String Designer

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

java -jar cdata.jdbc.adp.jar

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

Below is a typical JDBC connection string for ADP:

jdbc:adp:OAuthClientId=YourClientId;OAuthClientSecret=YourClientSecret;SSLClientCert='c:\cert.pfx';SSLClientCertPassword='admin@123';InitiateOAuth=GETANDREFRESH;

Create a JRuby App with Connectivity to ADP Data

Create a new Ruby file (for example: ADPSelect.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 ADP 2018/lib/cdata.jdbc.adp.jar'

url = "jdbc:adp:OAuthClientId=YourClientId;OAuthClientSecret=YourClientSecret;SSLClientCert='c:\cert.pfx';SSLClientCertPassword='admin@123';InitiateOAuth=GETANDREFRESH;"
conn = java.sql.DriverManager.getConnection(url)
stmt = conn.createStatement
rs = stmt.executeQuery("SELECT AssociateOID, WorkerID FROM Workers")
while (rs.next) do
 puts rs.getString(1) + ' ' + rs.getString(2)
end

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

jruby -S ADPSelect.rb

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