Ready to get started?

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

Download Now

Connect to MYOB AccountRight Data in Ruby

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

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

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

These properties are required when connecting to a company file (both for Cloud and On-Premise instances).

  • CompanyFileId: You can find this by starting MYOB, opening your data file, and selecting Help -> About MYOB
  • User: The username associated with your company file.
  • Password: The password associated with your company file.

Connecting to a Cloud Instance

To connect to a cloud instance of MYOB, you can use the embedded OAuth credentials or create an OAuth app with MYOB. This process is detailed in the Help documentation.

Connecting to an On-Premise instance:

When connecting to an on-premise instance, you will need to set the following connection property in addition to those above:

  • InitiateOauth: Set this to OFF.
  • Url: The Url of your MYOB instance.

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 MYOB AccountRight Data

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

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