Learn more
 

Use JayDeBeApi to access SAP ByDesign Data in Python


Use standard Python scripting and the development environment of your choice to access live SAP ByDesign data.

Access SAP ByDesign data with Python scripts and standard SQL on any machine where Python and Java can be installed. You can use the CData JDBC Driver for SAP ByDesign and the JayDeBeApi module to work with remote SAP ByDesign data in Python. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular Python language. This article shows how to use the driver to execute SQL queries to SAP ByDesign and visualize SAP ByDesign data with standard Python.

Use the JayDeBeApi module

JayDeBeApi is a Python library that serves as a JDBC (Java Database Connectivity) bridge, allowing Python programs to interact with Java databases, including CData JDBC Drivers. Use the pip install command to install the module:

pip install JayDeBeApi

Create the JDBC URL

Once you have JayDeBeApi installed, you are ready to work with SAP ByDesign data in Python using SQL.

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.

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.

Below is a sample variable assignment, including a typical JDBC connection string:

jdbc_url = "jdbc:sapbydesign:URL=https://my999999.sapbydesign.com;User=username;Password=password;CustomService=servicename;"

Access SAP ByDesign data in Python

With the JDBC URL configured, you only need the absolute path to the JDBC driver JAR file, which is in the "lib" folder in the installation directory ("C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.sapbydesign.jar" on Windows).

NOTE: If you haven't already, set the JAVA_HOME environment variable to the Java installation directory.

Use code similar to the follow to read and print data from SAP ByDesign:

import jaydebeapi #The JDBC connection string jdbc_url = "jdbc:sapbydesign:URL=https://my999999.sapbydesign.com;User=username;Password=password;CustomService=servicename;" username = "****" password = "****" #The absolute Path to the JDBC driver JAR file, typically: jdbc_driver_jar = "C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.sapbydesign.jar" conn = jaydebeapi.connect( "cdata.jdbc.sapbydesign.SAPByDesignDriver", jdbc_url, [username, password], jdbc_driver_jar, ) cursor = conn.cursor() cursor.execute("SELECT * FROM [Inventory Balance];") results = cursor.fetchall() for row in results: print(row) cursor.close() conn.close()

Free trial & more information

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

Ready to get started?

Download a free trial of the SAP ByDesign Driver to get started:

 Download Now

Learn more:

SAP ByDesign Icon SAP ByDesign JDBC Driver

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

In this article

Related articles