How to connect and process Dynamics 365 Business Central 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 365 Business Central data. This article walks through hosting the CData JDBC Driver in Azure, as well as connecting to and processing live Dynamics 365 Business Central data in Databricks.

With built-in optimized data processing, the CData JDBC driver offers unmatched performance for interacting with live Dynamics 365 Business Central data. When you issue complex SQL queries to Dynamics 365 Business Central, the driver pushes supported SQL operations, like filters and aggregations, directly to Dynamics 365 Business Central 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 365 Business Central data using native data types.

Install the CData JDBC Driver in Azure

To work with live Dynamics 365 Business Central data in Databricks, install the driver through Azure Data Lake Storage (ADLS). (Please note that the method of connecting through DBFS, which previous versions of this article described, has been deprecated, but has not published an end-of-life.)

1. Upload the JDBC JAR file to a blob container of your choice (i.e. "jdbcjars" container of the "databrickslibraries" storage account).
2. Fetch the Account Key from the storage account by expanding "Security + networking" and clicking on "Access Keys". Show and copy whichever of the two keys you wish to use.
3. Get the JDBC JAR file's URL by navigating to Containers, opening the specific container storing the JAR, and selecting the entry for the JDBC JAR file. This should open the file's details, where there should be a convenient button to copy the URL button to clipboard. This value will look similar to the below, though the "blob" component may vary depending on storage account type:

   https://databrickslibraries.blob.core.windows.net/jdbcjars/cdata.jdbc.salesforce.jar

   
4. In the Configuration tab of your Databricks cluster, click on the Edit button and expand "Advanced options". From there, add the following Spark option (derived from the JAR URL's domain name) with your copied Account key as its value and click Confirm: spark.hadoop.fs.azure.account.key.databrickslibraries.blob.core.windows.net
5. In the Libraries tab of your Databricks cluster, click on "Install new", and select the ADLS option. Specify the ABFSS URL for the driver JAR (also derived from the JAR URL's domain name), and click Install. The ABFSS URL should resemble the below:

   abfss://[email protected]/cdata.jdbc.salesforce.jar

   

Connect to Dynamics 365 Business Central from Databricks

With the JAR file installed, we are ready to work with live Dynamics 365 Business Central data in Databricks. Start by creating a new notebook in your workspace. Name the workbook, make sure Python is selected as the language (which should be by default), click on Connect and under General Compute select the cluster where you installed the JDBC driver (should be selected by default).

Configure the Connection to Dynamics 365 Business Central

Connect to Dynamics 365 Business Central 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.d365businesscentral.D365BusinessCentralDriver"
url = "jdbc:d365businesscentral:RTK=5246...;OrganizationUrl=https://myaccount.financials.dynamics.com/;"

Built-in Connection String Designer

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

java -jar cdata.jdbc.d365businesscentral.jar

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

To authenticate to Dynamics 365 Business Central, you must select an AuthScheme and provide the required properties.To authenticate with an Access Key, set AuthScheme to "AccessKey" and provide the User and AccessKey properties.

To obtain the User and AccessKey values, navigate to the Users page in Dynamics 365 Business Central and then click on Edit. The User Name and Web Service Access Key values are what you will enter as the User and AccessKey connection string properties. Note that the User Name is not your email address. It is a shortened user name.

Additionally, specify OrganizationUrl. If you have multiple companies in your organization, you must also specify the Company to indicate which company you would like to connect to. Company does not need to be specified if you have only one company.

If you wish to authenticate through other methods, refer to the Help documentation.

Load Dynamics 365 Business Central Data

Once the connection is configured, you can load Dynamics 365 Business Central 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" , "Accounts") \
	.load ()

Display Dynamics 365 Business Central Data

Check the loaded Dynamics 365 Business Central data by calling the display function.

display (remote_table.select ("accountid"))

Analyze Dynamics 365 Business Central 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 365 Business Central data for analysis.

result = spark.sql("SELECT accountid, Name FROM SAMPLE_VIEW")

The data from Dynamics 365 Business Central 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 365 Business Central and start working with your live Dynamics 365 Business Central data in Azure Databricks. Reach out to our Support Team if you have any questions.