Ready to get started?

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

Download Now

Connect to DocuSign Data in JRuby

Create a simple JRuby app with access to live DocuSign data.

JRuby is a high-performance, stable, fully threaded Java implementation of the Ruby programming language. The CData JDBC Driver for DocuSign makes it easy to integrate connectivity to live DocuSign data in JRuby. This article shows how to create a simple JRuby app that connects to DocuSign data, executes a query, and displays the results.

Configure a JDBC Connection to DocuSign Data

Before creating the app, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for DocuSign\lib).

JRuby natively supports JDBC, so you can easily connect to DocuSign and execute SQL queries. Initialize the JDBC connection with the getConnection function of the java.sql.DriverManager class.

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.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the DocuSign JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.docusign.jar

Fill in the connection properties and copy the connection string to the clipboard.

Below is a typical JDBC connection string for DocuSign:

jdbc:docusign:OAuthClientId=MyClientId; OAuthClientSecret=MyClientSecret; CallbackURL=http://localhost:33333; InitiateOAuth=GETANDREFRESH

Create a JRuby 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:

require 'java' require 'rubygems' require 'C:/Program Files/CData/CData JDBC Driver for DocuSign 2018/lib/cdata.jdbc.docusign.jar' url = "jdbc:docusign:OAuthClientId=MyClientId; OAuthClientSecret=MyClientSecret; CallbackURL=http://localhost:33333; InitiateOAuth=GETANDREFRESH" conn = java.sql.DriverManager.getConnection(url) stmt = conn.createStatement rs = stmt.executeQuery("SELECT DocumentId, DocumentName FROM Documents") while (rs.next) do puts rs.getString(1) + ' ' + rs.getString(2) end

With the file completed, you are ready to display your DocuSign data with JRuby. To do so, simply run your file from the command line:

jruby -S DocuSignSelect.rb

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