Ready to get started?

Learn more about the CData ODBC Driver for Xero WorkflowMax or download a free trial:

Download Now

Connect to Xero WorkflowMax Data in Ruby

Connect to Xero WorkflowMax data in Ruby with ruby-dbi, dbd-odbc, and ruby-odbc.

The CData ODBC Driver for Xero WorkflowMax makes it easy to integrate connectivity to live Xero WorkflowMax data in Ruby. This article shows how to create a simple Ruby app that connects to Xero WorkflowMax data, executes a query, and displays the results.

Create an ODBC Connection to Xero WorkflowMax Data

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

To connect to the WorkflowMax API, obtain an APIKey and AccountKey from Xero. This can only be done by contacting Xero support (https://www.workflowmax.com/contact-us).

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.

Installing Ruby and Necessary Gems

If you do not have Ruby installed, refer to the Ruby installation page. With Ruby installed, you will need to install the ruby-dbi, dbd-odbc, and ruby-odbc gems:

gem install dbi gem install dbd-odbc gem install ruby-odbc

Create a Ruby 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:

#connect to the DSN require 'DBI' cnxn = DBI.connect('DBI:ODBC:CData XeroWorkflowMax Source','','') #execute a SELECT query and store the result set resultSet = cnxn.execute("SELECT Id, Name FROM Clients WHERE Name = 'Cynthia'") #display the names of the columns resultSet.column_names.each do |name| print name, "\t" end puts #display the results while row = resultSet.fetch do (0..resultSet.column_names.size - 1).each do |n| print row[n], "\t" end puts end resultSet.finish #close the connection cnxn.disconnect if cnxn

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

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