Ready to get started?

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

Download Now

Connect to DocuSign Data in Ruby

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

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

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

To connect to DocuSign, set the following connection properties:

  • UseSandbox: indicates whether current user account is sandbox or not (FALSE by default)
  • AccountId (optional): set it in the connection string if you have access to multiple Account Ids

Authenticating to DocuSign

DocuSign uses the OAuth authentication standard. To authenticate using OAuth, you will need to create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties. See the Help documentation 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 DocuSign Data

Create a new Ruby file (for example: DocuSignSelect.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 DocuSign Source','','') #execute a SELECT query and store the result set resultSet = cnxn.execute("SELECT DocumentId, DocumentName FROM Documents WHERE DocumentName = 'TPSReport'") #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 DocuSign data with Ruby. To do so, simply run your file from the command line:

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