How to connect and process Dynamics CRM Data from Azure Databricks

Databricks is a cloud-based service that provides data processing capabilities through Apache Spark. When paired with the CData JDBC Driver, customers can use Databricks to perform data engineering and data science on live Dynamics CRM data. This article walks through hosting the CData JDBC Driver in Azure, as well as connecting to and processing live Dynamics CRM data in Databricks.

With built-in optimized data processing, the CData JDBC driver offers unmatched performance for interacting with live Dynamics CRM data. When you issue complex SQL queries to Dynamics CRM, the driver pushes supported SQL operations, like filters and aggregations, directly to Dynamics CRM and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze Dynamics CRM data using native data types.

Install the CData JDBC Driver in Azure

To work with live Dynamics CRM data in Databricks, install the driver on your Azure cluster.

1. Navigate to your Databricks administration screen and select the target cluster.
2. On the Libraries tab, click "Install New."
3. Select "Upload" as the Library Source and "Jar" as the Library Type.
4. Upload the JDBC JAR file (cdata.jdbc.dynamicscrm.jar) from the installation location (typically C:\Program Files\CData[product_name]\lib).

Connect to Dynamics CRM from Databricks

With the JAR file installed, we are ready to work with live Dynamics CRM data in Databricks. Start by creating a new notebook in your workspace. Name the notebook, select Python as the language (though Scala is available as well), and choose the cluster where you installed the JDBC driver. When the notebook launches, we can configure the connection, query Dynamics CRM, and create a basic report.

Configure the Connection to Dynamics CRM

Connect to Dynamics CRM by referencing the class for the JDBC Driver and constructing a connection string to use in the JDBC URL. Additionally, you will need to set the RTK property in the JDBC URL (unless you are using a Beta driver). You can view the licensing file included in the installation for information on how to set this property.

driver = "cdata.jdbc.dynamicscrm.DynamicsCRMDriver"
url = "jdbc:dynamicscrm:RTK=5246...;User=myuseraccount;Password=mypassword;URL=https://myOrg.crm.dynamics.com/;CRM Version=CRM Online;"

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.

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

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.

Load Dynamics CRM Data

Once the connection is configured, you can load Dynamics CRM data as a dataframe using the CData JDBC Driver and the connection information.

remote_table = spark.read.format ( "jdbc" ) \
	.option ( "driver" , driver) \
	.option ( "url" , url) \
	.option ( "dbtable" , "Account") \
	.load ()

Display Dynamics CRM Data

Check the loaded Dynamics CRM data by calling the display function.

display (remote_table.select ("FirstName"))

Analyze Dynamics CRM Data in Azure Databricks

If you want to process data with Databricks SparkSQL, register the loaded data as a Temp View.

remote_table.createOrReplaceTempView ( "SAMPLE_VIEW" )

The SparkSQL below retrieves the Dynamics CRM data for analysis.

% sql

SELECT Contact.FirstName, SUM(Account.NumberOfEmployees) FROM Contact, Account GROUP BY Contact.FirstName

The data from Dynamics CRM is only available in the target notebook. If you want to use it with other users, save it as a table.

remote_table.write.format ( "parquet" ) .saveAsTable ( "SAMPLE_TABLE" )

Download a free, 30-day trial of the CData JDBC Driver for Dynamics CRM and start working with your live Dynamics CRM data in Azure Databricks. Reach out to our Support Team if you have any questions.