Integrate SAP Netweaver Gateway Data in the Pentaho Report Designer

The CData JDBC driver for SAP Netweaver Gateway data enables access to live data from dashboards and reports. This article shows how to connect to SAP Netweaver Gateway data as a JDBC data source and publish reports based on SAP Netweaver Gateway data in Pentaho.

Connect and Create a Report

1. Copy the JAR file of the driver, located in the lib subfolder of the installation directory, to the \Report-Designer\lib\jdbc\ folder in the Pentaho directory.
2. Run the report-designer.bat file in the \Report-Designer\ folder to open the Report-Designer UI.

3. Create a new data source with the driver by clicking Data -> Add Data Source -> Advanced -> JDBC (Custom) and then creating a new SAP Netweaver Gateway connection. In the resulting dialog, configure the connection properties as shown below.

   • Custom Connection URL property: Enter the JDBC URL. This starts with jdbc:sapgateway: and is followed by a semicolon-separated list of connection properties.

     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.

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     

     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.

     Below is a typical JDBC URL:

     jdbc:sapgateway:User=user;Password=password;URL=https://sapes5.sapdevcenter.com/sap/opu/odata/IWBEP/GWSAMPLE_BASIC/;InitiateOAuth=GETANDREFRESH;

   • Custom Driver Class Name: Enter cdata.jdbc.sapgateway.SAPGatewayDriver.
   • User Name: The username to authenticate with.
   • Password: The password to authenticate with.
   👁 Required connection properties defined in the JDBC URL. (Salesforce is shown.)
   

Add SAP Netweaver Gateway Data to a Report

You are now ready to create a report with SAP Netweaver Gateway data.

1. Add the SAP Netweaver Gateway source to your report: Click Data -> Add Data Source -> JDBC and select the data source.

2. Configure the query. This article uses the one below:

   SELECT ProductID, Quantity FROM SalesOrderLineItems WHERE Quantity < 15

   👁 The query to retrieve data, specified in the JDBC data source configuration wizard. (Salesforce is shown.)
   
3. Drag a chart onto your report and double-click it to edit the chart. Run the report to display the chart. You can use the results of this query to create a simple chart for the SalesOrderLineItems table.
4. Finally, run the report to see the chart.