Ready to get started?

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

Download Now

Connect to FinancialForce Data in Ruby

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

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

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

There are several authentication methods available for connecting to FinancialForce: login credentials, SSO, and OAuth.

Authenticating with a Login and Token

Set the User and Password to your login credentials. Additionally, set the SecurityToken. By default, the SecurityToken is required, but you can make it optional by allowing a range of trusted IP addresses.

To disable the security token:

  1. Log in to FinancialForce and enter "Network Access" in the Quick Find box in the setup section.
  2. Add your IP address to the list of trusted IP addresses.

To obtain the security token:

  1. Open the personal information page on FinancialForce.com.
  2. Click the link to reset your security token. The token will be emailed to you.
  3. Specify the security token in the SecurityToken connection property or append it to the Password.

Authenticating with OAuth

If you do not have access to the user name and password or do not want to require them, use the OAuth user consent flow. See the OAuth section in the Help for an authentication guide.

Connecting to FinancialForce Sandbox Accounts

Set UseSandbox to true (false by default) to use a FinancialForce sandbox account. Ensure that you specify a sandbox user name in User.

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

Create a new Ruby file (for example: FinancialForceSelect.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 FinancialForce Source','','') #execute a SELECT query and store the result set resultSet = cnxn.execute("SELECT BillingState, Name FROM Account WHERE Industry = 'Floppy Disks'") #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 FinancialForce data with Ruby. To do so, simply run your file from the command line:

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