Connect to Xero WorkflowMax Data in JRuby

Ready to get started?

Download a free trial:

Download Now

Learn more:

Xero WorkflowMax JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Xero WorkflowMax.

Create a simple JRuby app with access to live Xero WorkflowMax data.

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

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

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

To connect to the WorkflowMax API, obtain an APIKey and AccountKey from Xero. This can only be done by contacting Xero support (

After obtaining an API Key and Account Key, set the values in the APIKey and AccountKey connection properties. Once these are set, you are ready to connect.

Built-in Connection String Designer

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

java -jar cdata.jdbc.xeroworkflowmax.jar

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

Below is a typical JDBC connection string for Xero WorkflowMax:


Create a JRuby App with Connectivity to Xero WorkflowMax Data

Create a new Ruby file (for example: XeroWorkflowMaxSelect.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 Xero WorkflowMax 2018/lib/cdata.jdbc.xeroworkflowmax.jar' url = "jdbc:xeroworkflowmax:APIKey=myApiKey;AccountKey=myAccountKey;" conn = java.sql.DriverManager.getConnection(url) stmt = conn.createStatement rs = stmt.executeQuery("SELECT Id, Name FROM Clients") while ( do puts rs.getString(1) + ' ' + rs.getString(2) end

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

jruby -S XeroWorkflowMaxSelect.rb

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