Ready to get started?

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

Download Now

Design BIRT Reports on SAP Netweaver Gateway Data

Provide current SAP Netweaver Gateway data to your embedded analytics.

The CData JDBC Driver for SAP Netweaver Gateway integrates connectivity to SAP Netweaver Gateway APIs into your data-driven Java applications. You can use the CData JDBC Driver for SAP Netweaver Gateway with the BIRT (Business Intelligence Reporting Tools) platform to create BIRT reports that reflect changes to your data in real time.

  1. If you have not already done so, install the BIRT Framework plugin and the Database Development plugin for Eclipse.
  2. Click File -> New -> Report. The Report Design perspective is opened.
  3. In the Data Explorer, right-click Data Sources and click New Data Source.
  4. Select the Create from a Data Source Type in the Following List option and select JDBC Data Source.
  5. Click Manage Drivers and add the driver JAR, located in the lib subfolder of the installation folder.
  6. In the Database URL box, enter the JDBC URL containing the connection string.

    SAP Gateway allows both basic and OAuth 2.0 authentication. You can use basic authentication to connect to your own account, or you can use OAuth to enable other users to retrieve data from your service with their accounts. In addition to authenticating, set the following connection properties to access SAP Gateway tables.

    • Url: Set this to the URL of your environment, or to the full URL of the service. For example, the full URL might appear as: https://sapes5.sapdevcenter.com/sap/opu/odata/IWBEP/GWSAMPLE_BASIC/. In this example, the environment URL would just be: https://sapes5.sapdevcenter.com.
    • Namespace: Set the appropriate Service Namespace. In the example above, IWBEP is the namespace. It is optional if the full URL to the service is specified.
    • Service: Set this to the service you want to retrieve data from. In the example above, the service is GWSAMPLE_BASIC. It is not required if the full URL is specified.

    Authenticate via Basic Authentication

    In basic authentication, you use your login credentials to connect. Set the following properties:

    • User: This is the username you use to log in to SAP Gateway.
    • Password: This is the password you use to log in to SAP Gateway.

    Authenticate via OAuth Authentication

    You can connect to SAP Gateway using the embedded OAuth connectivity (without setting any additional authentication connection properties). When you connect, the OAuth endpoint opens in your browser. Log in and grant permissions to complete the OAuth process. See the OAuth section in the online Help documentation for more information on other OAuth authentication flows.

    Built-in Connection String Designer

    For assistance in constructing the JDBC URL, use the connection string designer built into the SAP Netweaver Gateway JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

    java -jar cdata.jdbc.sapgateway.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:sapgateway:User=user;Password=password;URL=https://sapes5.sapdevcenter.com/sap/opu/odata/IWBEP/GWSAMPLE_BASIC/;InitiateOAuth=GETANDREFRESH
  7. Right-click the Data Sets folder and select the JDBC data source for SAP Netweaver Gateway.
  8. In the resulting dialog, build the SELECT query to be used to retrieve the data for the report. This article uses the following query: SELECT ProductID, Quantity FROM SalesOrderLineItems WHERE Quantity < 15
  9. In the Palette, drag a Chart onto the editor. The chart wizard is displayed.
  10. After selecting the chart type, drag columns onto the chart fields on the Select Data tab.
  11. Click Run -> View Report -> In Web Viewer to view the report.

Your BIRT reports can now pick up any updates to SAP Netweaver Gateway data.

To publish the report to your application server, add the driver JAR to the BIRT Viewer's classpath. For more information, see the CData KB for guides to deploying the JDBC Driver on Java application servers.