Ready to get started?

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

Download Now

Connect to Sugar CRM Data in Ruby

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

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

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

The User and Password properties, under the Authentication section, must be set to valid SugarCRM user credentials. This will use the default OAuth token created to allow client logins. OAuthClientId and OAuthClientSecret are required if you do not wish to use the default OAuth token.

You can generate a new OAuth consumer key and consumer secret in Admin -> OAuth Keys. Set the OAuthClientId to the OAuth consumer key. Set the OAuthClientSecret to the consumer secret.

Additionally, specify the URL to the SugarCRM account.

Note that retrieving SugarCRM metadata can be expensive. It is advised that you store the metadata locally as described in the "Caching Metadata" chapter of the help documentation.

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 Sugar CRM Data

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

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