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.

Connect to SAP ByDesign Data in Aqua Data Studio



Access SAP ByDesign data from tools in Aqua Data Studio such as the Visual Query Builder and the Table Data Editor.

The CData JDBC Driver for SAP ByDesign integrates SAP ByDesign data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to SAP ByDesign data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The SAP ByDesign data source can then be accessed from Aqua Data Studio tools.

  1. In Aqua Data Studio, select Register Server from the Servers menu.
  2. In the Register Server form, select the 'Generic - JDBC' connection.
  3. Enter the following JDBC connection properties:
    • Name: Enter a name for the data source; for example, SAP ByDesign.
    • Driver Location: Click the Browse button and select the cdata.jdbc.sapbydesign.jar file, located in the lib subfolder of the installation directory.
    • Driver: Enter the Driver's class name, cdata.jdbc.sapbydesign.SAPByDesignDriver.
    • URL: Enter the JDBC URL, which starts with jdbc:sapbydesign: and is followed by a semicolon-separated list of connection properties.

      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.

      A typical JDBC URL is below:

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

Query SAP ByDesign Data

You can now query the tables exposed.