Ready to get started?

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

Download Now

Connect to Acumatica Data in Ruby

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

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

Create an ODBC Connection to Acumatica 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.

Set the following connection properties to connect to Acumatica:

  • User: Set this to your username.
  • Password: Set this to your password.
  • Company: Set this to your company.
  • Url: Set this to your Acumatica URL, in the format http://{Acumatica ERP instance URL}/entity/{Endpoint name}/{Endpoint version}/.
    For example: https://acumatica.com/entity/Default/17.200.001/

See the Getting Started guide in the CData driver documentation for more information.

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 Acumatica Data

Create a new Ruby file (for example: AcumaticaSelect.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 Acumatica Source','','') #execute a SELECT query and store the result set resultSet = cnxn.execute("SELECT Id, location_displayname FROM Events") #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 Acumatica data with Ruby. To do so, simply run your file from the command line:

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