Process & Analyze SAP ByDesign Data in Azure Databricks

Ready to get started?

Download for a free trial:

Download Now

Learn more:

SAP ByDesign JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with SAP ByDesign.



Host the CData JDBC Driver for SAP ByDesign in Azure and use Databricks to perform data engineering and data science on live SAP ByDesign data.

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

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

Install the CData JDBC Driver in Azure

To work with live SAP ByDesign 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.sapbydesign.jar) from the installation location (typically C:\Program Files\CData\CData JDBC Driver for SAP ByDesign\lib).

Connect to SAP ByDesign from Databricks

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

Configure the Connection to SAP ByDesign

Connect to SAP ByDesign by referencing the class for the JDBC Driver and constructing a connection string to use in the JDBC URL.

driver = "cdata.jdbc.sapbydesign.SAPByDesignDriver"
url = "jdbc:sapbydesign:URL=https://my999999.sapbydesign.com;User=username;Password=password;CustomService=servicename;"

Built-in Connection String Designer

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

java -jar cdata.jdbc.sapbydesign.jar

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

Set the following connection properties to connect to SAP ByDesign.

  • Url: Set this to the Url of your SAP ByDesign site. For example, https://test.sapbydesign.com
  • User: Set this to the username of your account.
  • Password: Set this to the password of your account.
  • CustomService or AnalyticsService: Only one of these must be specified. If you have a custom service you want to retrieve data from, specify CustomService. If you want to retrieve the reports of a analytical service, specify AnalyticsService.
    If neither is specified, 'cc_home_analytics.svc' will used as a default for the AnalyticsService property. If you are not sure what service to specify, you can always query the Services view to list available services.

Load SAP ByDesign Data

Once the connection is configured, you can load SAP ByDesign 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" , "[Inventory Balance]") \
	.load ()

Display SAP ByDesign Data

Check the loaded SAP ByDesign data by calling the display function.

display (remote_table.select ("ID"))

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

% sql

SELECT ID, ProductCategoryID FROM [Inventory Balance] WHERE ProductCategoryID = '1234567'

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