Ready to get started?

Learn more about the CData JDBC Driver for SAP ByDesign or download a free trial:

Download Now

SAP ByDesign Reporting in OBIEE with the SAP ByDesign JDBC Driver

Deploy the SAP ByDesign JDBC driver on OBIEE to provide real-time reporting across the enterprise.

The CData JDBC Driver for SAP ByDesign is a standard database driver that can integrate real-time access to SAP ByDesign data into your Java-based reporting server. This article shows how to deploy the driver to Oracle Business Intelligence Enterprise Edition (OBIEE) and create reports on SAP ByDesign data that reflect any changes.

Deploy the JDBC Driver

Follow the steps below to add the JDBC driver to WebLogic's classpath.

For WebLogic 12.2.1, simply place the driver JAR and .lic file into DOMAIN_HOME\lib; for example, ORACLE_HOME\user_projects\domains\MY_DOMAIN\lib. These files will be added to the server classpath at startup.

You can also manually add the driver to the classpath: This is required for earlier versions. Prepend the following to PRE_CLASSPATH in setDomainEnv.cmd (Windows) or setDomainEnv.sh (Unix). This script is located in the bin subfolder of the folder for that domain. For example: ORACLE_HOME\user_projects\domains\MY_DOMAIN\bin.

set PRE_CLASSPATH=your-installation-directory\lib\cdata.jdbc.sapbydesign.jar;%PRE_CLASSPATH%

Restart all servers; for example, run the stop and start commands in DOMAIN_HOME\bitools\bin.

Create a JDBC Data Source for SAP ByDesign

After deploying the JDBC driver, you can create a JDBC data source from BI Publisher.

  1. Log into BI Publisher, at the URL http://localhost:9502/analytics, for example, and click Administration -> Manage BI Publisher.
  2. Click JDBC Connection -> Add Data Source.
  3. Enter the following information:
    • Data Source Name: Enter the name that users will create connections to in their reports.
    • Driver Type: Select Other.
    • Database DriverClass: Enter the driver class, cdata.jdbc.sapbydesign.SAPByDesignDriver.
    • Connection String: Enter 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.

      When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

      A typical JDBC URL is below:

      jdbc:sapbydesign:URL=https://my999999.sapbydesign.com;User=username;Password=password;CustomService=servicename;
    • Username: Enter the username.
    • Password: Enter the password.
  4. In the Security section, select the allowed user roles.

Create Real-Time SAP ByDesign Reports

You can now create reports and analyses based on real-time SAP ByDesign data. Follow the steps below to use the standard report wizard to create an interactive report that reflects any changes to SAP ByDesign data.

  1. On the global header, click New -> Data Model.
  2. On the Diagram tab, select SQL query in the menu.
  3. Enter a name for the query and in the Data Source menu select the SAP ByDesign JDBC data source you created.
  4. Select standard SQL and enter a query like the following: SELECT ID, ProductCategoryID FROM [Inventory Balance] WHERE ProductCategoryID = '1234567'
  5. Click View Data to generate the sample data to be used as you build your report.
  6. Select the number of rows to include in the sample data, click View, and then click Save As Sample Data.
  7. Click Create Report -> Use Data Model.
  8. Select Guide Me and on the Select Layout page select the report objects you want to include. In this example we select Chart and Table.
  9. Drop a numeric column like ProductCategoryID onto the Drop Value Here box on the y-axis. Drop a dimension column like ID onto the Drop Label Here box on the x-axis.
  10. Click Refresh to pick up any changes to the SAP ByDesign data.