Integrate with SAP Netweaver Gateway Data in JReport Designer

Jerod Johnson
Director, Technology Evangelism

Create charts and reports based on SAP Netweaver Gateway data in JReport Designer.

The CData JDBC Driver for SAP Netweaver Gateway data enables access to live data from dashboards and reports as if SAP Netweaver Gateway were a relational database, allowing you to query SAP Netweaver Gateway data using familiar SQL queries. This article shows how to connect to SAP Netweaver Gateway data as a JDBC data source and create reports based on SAP Netweaver Gateway data in JReport Designer.

Connect to SAP Netweaver Gateway Data

Edit C:\JReport\Designer\bin\setenv.bat to add the location of the JAR file to the ADDCLASSPATH variable:

...
set ADDCLASSPATH=%JAVAHOME%\lib\tools.jar;C:\Program Files\CData\CData JDBC Driver for SAP Netweaver Gateway 2016\lib\cdata.jdbc.sapgateway.jar;
...

Create a new data source by clicking File New Data Source.
In the resulting dialog, create a name for the data source (CData JDBC Driver for SAP Netweaver Gateway), select JDBC, and click OK.
In the Get JDBC Connection Information dialog you will configure your connection to the JDBC driver:
- Driver: Be sure that the Driver box is checked and fill in the name of the class for the driver:
```
cdata.jdbc.sapgateway.SAPGatewayDriver
```
- URL: 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;
```
- User: The username to authenticate with; typically left blank.
- Password: The password to authenticate with; typically left blank.
👁 Configuring the connection to the JDBC Driver (Salesforce is shown.)
In the Add Table dialog, select the tables you wish to include in your report (or in future reports using this data source) and click Add.
👁 Adding Tables. (Salesforce is shown.)

Click Done once the dialog has completed loading the tables.
In the Catalog Browser, you can create the queries that you will use to populate your reports. You can do this now, or after you create your report. In either case, expand () the data source (CData JDBC Driver for SAP Netweaver Gateway), right-click on Queries, and select Add Query. 👁 Adding a query for data to be used in the report. (Salesforce is shown.)
In the Add Table/View/Query dialog, expand () the JDBC URL and Tables and select the table(s) you wish to use in the query and click OK. 👁 Selecting a table for the query. (Salesforce is shown.)
In the Query Editor dialog, you can select the columns you wish to include or simply click the SQL button and manually input your own query. For example:
```
SELECT ProductID, Quantity FROM SalesOrderLineItems WHERE Quantity < 15
```
👁 Editing the query. (Salesforce is shown.)

With the query built, click OK to close the Query Editor dialog. At this point you are ready to add SAP Netweaver Gateway data to a new or existing report.

NOTE: Now that the query is built, you can create a Business View based on the query. With a Business View, you can create Web reports or library components based on the query. For more information on this, refer to the JReport tutorials.