How to connect to SAP Ariba Source Data in DBVisualizer

The CData JDBC Driver for SAP Ariba Source implements JDBC standards to provide connectivity to SAP Ariba Source data in applications ranging from business intelligence tools to IDEs. This article shows how to establish a connection to SAP Ariba Source data in DBVisualizer and use the table editor to edit and save SAP Ariba Source data.

Create a New Driver Definition for SAP Ariba Source Data

Follow the steps below to use the Driver Manager to provide connectivity to SAP Ariba Source data from DBVisualizer tools.

1. In DBVisualizer, click Tools -> Driver Manager.
2. Click the plus sign "" to create a new driver.
3. Select "Custom" as the template.
4. On the Driver Settings tab:
   • Set Name to a user-friendly name (e.g. "CData SAP Ariba Source Driver")
   • Set URL Format to jdbc:saparibasource:
   • In Driver artifacts and jar files (jars are loaded in order from top):
     1. Click the plus sign "" -> "Add Files"
     2. Navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\)
     3. Select the JAR file (cdata.jdbc.SAPAribaSource.jar) and click "Open"
5. The Driver Class should populate automatically. If not, select class (cdata.jdbc.saparibasource.SAPAribaSourceDriver).

Define the Connection to the JDBC Data Source

Close the "Driver Manager" and follow the steps below to save connection properties in the JDBC URL.

1. In the "Databases" tab, click the plus sign "" and select the driver you just created.

2. In the "Connection" section, set the following options:

   • Database Type: If you selected the wizard option, the database type is automatically detected. If you selected the "No Wizard" option, select the Generic or Auto Detect option in the Database Type menu.
   • Driver Type: Select the driver you just created.

   • Database URL: Enter the full JDBC URL. The syntax of the JDBC URL is jdbc:saparibasource: followed by the connection properties in a semicolon-separated list of name-value pairs.

     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.

     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 connection string is below:

     jdbc:saparibasource:API=SupplierDataAPIWithPagination-V4;APIKey=wWVLn7WTAXrIRMAzZ6VnuEj7Ekot5jnU;Environment=SANDBOX;Realm=testRealm;AuthScheme=OAuthClient;InitiateOAuth=GETANDREFRESH
   • NOTE: Since SAP Ariba Source does not require a User or Password to authenticate, you may use whatever values you wish for Database Userid and Database Password.
3. On the Connection tab, click Connect.

To browse through tables exposed by the SAP Ariba Source JDBC Driver, right-click a table and click "Open in New Tab."

To execute SQL queries, use the SQL Commander tool: Click SQL Commander -> New SQL Commander. Select the Database Connection, Database, and Schema from the available menus.

See the "Supported SQL" chapter in the help documentation for more information on the supported SQL. See the "Data Model" chapter for table-specific information.

More Information & Free Trial