How to connect to SAP ByDesign Data from IntelliJ

The CData JDBC Driver for SAP ByDesign enables you to access SAP ByDesign as a JDBC data source, providing integration with rapid development tools in IDEs. This article shows how to use the data source configuration wizard to connect to SAP ByDesign data in IntelliJ.

Create a JBDC Data Source for SAP ByDesign

Follow the steps below to add the driver JAR and define connection properties required to connect to SAP ByDesign data.

1. In the Data Sources window, right-click and then click Add Data Source -> DB Data Source.

2. In the Data Source Properties dialog that appears, the following properties are required:

   • JDBC Driver Files: Click the button next to this menu to add the JDBC Driver file cdata.jdbc.sapbydesign.jar, located in the installation directory.
   • JDBC Driver Class: In this menu, select cdata.jdbc.sapbydesign.SAPByDesignDriver from the list.

   • Database URL: Enter the connection URL in the JDBC URL property. The URL must start with jdbc:sapbydesign: and includes connection properties separated with semicolons.

     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 the following:

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

Edit and Save SAP ByDesign Data

To discover schema information, right-click the data source you just created and click Refresh Tables. To query a table, right-click it and then click Open Tables Editor.