How to connect to Salesforce using Ruby via ODBC

[daniel]

Introduction

In this article, we will show how to connect to the Salesforce API with Ruby using the ODBC interface.

Connecting Ruby to Salesforce via ODBC allows you to seamlessly interact with customer data, automate CRM tasks, and integrate Salesforce with other applications.

By leveraging the ruby-odbc gem, you can retrieve leads, manage accounts, and automate data processing. This guide will walk you through the installation, configuration, and troubleshooting process to establish a reliable connection between Ruby and Salesforce using ODBC.

Prerequisites

• Have a Salesforce Account
• Download and install the ZappySys ODBC PowerPack

Steps

Step 1: Install Ruby and the ruby-odbc Gem

Some versions of Ruby may not be fully compatible with the ruby-odbc gem. To ensure proper functionality, using Ruby 3.1.x is recommended, as newer versions may introduce compatibility issues.

1. Download the Ruby Installer.
2. Install Ruby and DevKit.
3. Open Command Prompt as an administrator.
4. Verify the version you use with this command ruby -v.
5. Install the ruby-odbc gem with the following command: gem install ruby-odbc.
6. Verify the gem installed with this command: gem list ruby-odbc.

NOTE: If you encounter installation issues, you may need administrative permissions.

Step 2: Generate Security Token

1. Log in to Salesforce to generate the security token.

2. Navigate to [Your Name] at the top > My Settings > Personal > Reset My Security Token > [Reset Security Token]:
   

   

3. Get your token in your mailbox account

Step 3: Setup ODBC data source based on Salesforce driver

1. Open the ODBC Data Source by typing “ODBC” in the search box and launching the ODBC Data Source:
   
   
2. Create a User Data Source (User DSN) based on the ZappySys Salesforce Driver:
   
   
3. Provide your username, password, and security token in the SalesForce Connection settings, then test the connection by pressing Test Connection button:
   
   
4. Navigate to the Preview tab, select a table from the tables dropdown, choose a column ([value]), and click Preview Data to view the data:
   
   

Step 4: Access Salesforce API with Ruby via ODBC data source

Once the DSN is set up, you can use ruby-odbc to establish the connection and run queries. Create a Ruby file, e.g., SalesforceRuby.rb :

require 'odbc'

# DSN name configured in ODBC
# DSN name configured in ODBC
dsn = "ZappySys Salesforce Driver"  # Replace with the correct name

begin
  # Connect to the database using DSN
  db = ODBC.connect(dsn)

  # Verify connection
  puts "✅ Successfully connected to ODBC"

  # Execute a test query
  query = "SELECT * FROM FilesList"  # Adjust according to your database
  stmt = db.run(query)

  # Check if there is data
  rows = stmt.fetch_all
  if rows.empty?
    puts "⚠️ No data found in the database."
  else
    # Display results
    rows.each do |row|
      puts row.inspect
    end
  end

  # Close connection
  stmt.close
  db.disconnect

rescue ODBC::Error => e
  puts "❌ Connection error: #{e.message}"
end

When you run the code, it will call the Salesforce API via ODBC and retrieve data about your campaign lists.

Common errors and solutions

Error: cannot load such file -- dbi (LoadError)

Cause
You are trying to use the dbi gem, but it is not installed.

Solution
In the command line, run these commands to install the ODBC connectors.

gem install dbi
gem install dbd-odbc

---

Error: Failed to build gem native extension.

Cause
A compiler or necessary libraries are missing when compiling the gem.

Solution
In the command line, install MSYS2 and ensure gcc and make are available.

---

Error: Data source name not found, and no default driver specified.

Cause
The DSN is not configured, or the driver is not installed.

Solution

• Verify the configuration in odbcad32.exe
• Ensure the DSN name in the code exactly matches the one configured in ODBC.

---

Error: Issues with Ruby Version

Cause
Some Ruby versions may not be compatible with the ruby-odbc gem, especially if they are too new or old.

Solution

• Check your Ruby version with:

  ruby -v
  

• If your version is 3.2.x and you experience issues, try using an earlier version of Ruby (e.g., 2.7.x) or use RVM to switch versions:

  rvm install 2.7.8
  rvm use 2.7.8
  

Conclusion

Integrating Ruby with Salesforce through ODBC provides a powerful way to manage CRM data efficiently and automate business processes. Following this guide, you learned how to set up the connection, troubleshoot potential issues, and optimize data workflows.

To get started, download and install the ZappySys ODBC PowerPack to enable ODBC connectivity with Salesforce.

If you experience any challenges, review the error logs and verify your DSN configuration. If you still need assistance, feel free to reach out to ZappySys Support.

References

• Salesforce Connector
• RubyInstaller

Contact us

If you encounter any challenges or have specific use cases, please contact our support team via chat or ticket.