Integrate with SAP Ariba Source Data in JReport Designer

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

Connect to SAP Ariba Source Data

1. 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 Ariba Source 2016\lib\cdata.jdbc.saparibasource.jar;
   ...
   

2. Create a new data source by clicking File New Data Source.
3. In the resulting dialog, create a name for the data source (CData JDBC Driver for SAP Ariba Source), select JDBC, and click OK.
4. 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.saparibasource.SAPAribaSourceDriver

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

     In order to connect with SAP Ariba Source, set the following:

     • API: Specify which API you would like the provider to retrieve SAP Ariba data from. Select the Supplier, Sourcing Project Management, or Contract API based on your business role (possible values are SupplierDataAPIWithPaginationV4, SourcingProjectManagementAPIV2, or ContractAPIV1).
     • DataCenter: The data center where your account's data is hosted.
     • Realm: The name of the site you want to access.
     • Environment: Indicate whether you are connecting to a test or production environment (possible values are TEST or PRODUCTION).

     If you are connecting to the Supplier Data API or the Contract API, additionally set the following:

     • User: Id of the user on whose behalf API calls are invoked.
     • PasswordAdapter: The password associated with the authenticating User.

     If you're connecting to the Supplier API, set ProjectId to the Id of the sourcing project you want to retrieve data from.

     Authenticating with OAuth

     After setting connection properties, you need to configure OAuth connectivity to authenticate.

     • Set AuthScheme to OAuthClient.
     • Register an application with the service to obtain the APIKey, OAuthClientId and OAuthClientSecret.

       For more information on creating an OAuth application, refer to the Help documentation.

     Automatic OAuth

     After setting the following, you are ready to connect:

     APIKey: The Application key in your app settings. OAuthClientId: The OAuth Client Id in your app settings. OAuthClientSecret: The OAuth Secret in your app settings.

     When you connect, the provider automatically completes the OAuth process:

     1. The provider obtains an access token from SAP Ariba and uses it to request data.
     2. The provider refreshes the access token automatically when it expires.
     3. The OAuth values are saved in memory relative to the location specified in OAuthSettingsLocation.

     Built-in Connection String Designer

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

     java -jar cdata.jdbc.saparibasource.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:saparibasource:API=SupplierDataAPIWithPagination-V4;APIKey=wWVLn7WTAXrIRMAzZ6VnuEj7Ekot5jnU;Environment=SANDBOX;Realm=testRealm;AuthScheme=OAuthClient;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.)
   

5. 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.

6. 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 Ariba Source), right-click on Queries, and select Add Query. 👁 Adding a query for data to be used in the report. (Salesforce is shown.)
   
7. 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.)
   
8. 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 SMVendorID, Category FROM Vendors WHERE Region = 'USA'
   

   👁 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 Ariba Source 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.

Add SAP Ariba Source Data to a Report

You are now ready to create a report with SAP Ariba Source data.

1. Create a new report (File New Page Report) or open the Chart Wizard for an existing report.
2. Select the Query (or create a new one; see above).
👁 Selecting the query to use. (Salesforce is shown.)

3. Assign a Category and Value for the chart from the columns in your Query and click Finish.
👁 Assigning columns to define the chart. (Salesforce is shown.)

4. Click the View tab for your report to see the chart.