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

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

Install the CData JDBC Driver in Azure

To work with live Acumatica 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.acumatica.jar) from the installation location (typically C:\Program Files\CData[product_name]\lib).

Connect to Acumatica from Databricks

With the JAR file installed, we are ready to work with live Acumatica 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 Acumatica, and create a basic report.

Configure the Connection to Acumatica

Connect to Acumatica 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.acumatica.AcumaticaDriver"
url = "jdbc:acumatica:RTK=5246...;Url = https://try.acumatica.com/ISV/entity/Default/17.200.001/;User=user;Password=password;Company=CompanyName;"

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Acumatica 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.

Set the following connection properties to connect to Acumatica:

• User: Set this to your username.
• Password: Set this to your password.
• Company: Set this to your company.
• Url: Set this to your Acumatica URL, in the format http://{Acumatica ERP instance URL}/entity/{Endpoint name}/{Endpoint version}/.
  For example: https://acumatica.com/entity/Default/17.200.001/

See the Getting Started guide in the CData driver documentation for more information.

Load Acumatica Data

Once the connection is configured, you can load Acumatica 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" , "Events") \
	.load ()

Display Acumatica Data

Check the loaded Acumatica data by calling the display function.

display (remote_table.select ("Id"))

Analyze Acumatica 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 Acumatica data for analysis.

% sql

SELECT Id, location_displayname FROM Events

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