Connect to Dynamics CRM Data in JRuby

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

Getting Started

---

Configure a JDBC Connection to Dynamics CRM 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 Dynamics CRM\lib).

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

The connection string options meet the authentication and connection requirements of different Dynamics CRM instances. To connect to your instance, set the User and Password properties, under the Authentication section, to valid Dynamics CRM user credentials and set the Url to a valid Dynamics CRM server organization root. Additionally, set the CRMVersion property to 'CRM2011+' or 'CRMOnline'. IFD configurations are supported as well; set InternetFacingDeployment to true.

Additionally, you can provide the security token service (STS) or AD FS endpoint in the STSURL property. This value can be retrieved with the GetSTSUrl stored procedure. Office 365 users can connect to the default STS URL by simply setting CRMVersion.

Built-in Connection String Designer

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

java -jar cdata.jdbc.dynamicscrm.jar

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

Below is a typical JDBC connection string for Dynamics CRM:

jdbc:dynamicscrm:User=myuseraccount;Password=mypassword;URL=https://myOrg.crm.dynamics.com/;CRM Version=CRM Online;

Create a JRuby App with Connectivity to Dynamics CRM Data

Create a new Ruby file (for example: DynamicsCRMSelect.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 Dynamics CRM 2018/lib/cdata.jdbc.dynamicscrm.jar'

url = "jdbc:dynamicscrm:User=myuseraccount;Password=mypassword;URL=https://myOrg.crm.dynamics.com/;CRM Version=CRM Online;"
conn = java.sql.DriverManager.getConnection(url)
stmt = conn.createStatement
rs = stmt.executeQuery("SELECT FirstName, NumberOfEmployees FROM Account")
while (rs.next) do
 puts rs.getString(1) + ' ' + rs.getString(2)
end

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

jruby -S DynamicsCRMSelect.rb

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