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.

Manage SAP ByDesign Data in DBArtisan as a JDBC Source



Use wizards in DBArtisan to create a JDBC data source for SAP ByDesign.

The CData JDBC Driver for SAP ByDesign seamlessly integrates SAP ByDesign data into database management tools like DBArtisan by enabling you to access SAP ByDesign data as a database. This article shows how to create a JDBC source for SAP ByDesign in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate SAP ByDesign Data into DBArtisan Projects

Follow the steps below to register SAP ByDesign data as a database instance in your project:

  1. In DBArtisan, click Data Source -> Register Datasource.
  2. Select Generic JDBC.
  3. Click Manage.
  4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory.
  5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

    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 typical connection string:

    jdbc:sapbydesign:URL=https://my999999.sapbydesign.com;User=username;Password=password;CustomService=servicename;
  6. Finish the wizard to connect to SAP ByDesign data. SAP ByDesign entities are displayed in the Datasource Explorer.

You can now work with SAP ByDesign data as you work with any other database. See the driver help documentation for more information on the queries supported by the SAP ByDesign API.