How to Connect DBeaver to SAP Ariba Source via a JDBC Driver

The CData JDBC Driver for SAP Ariba Source implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to SAP Ariba Source data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for SAP Ariba Source Data

Follow the steps below to load the driver JAR in DBeaver.

1. Open the DBeaver application and, in the "Database" menu, select the "Driver Manager" option. Click "New" to open the "Create new driver" form.
2. In the Settings tab:
   • Set Driver Name to a user-friendly name for the driver (e.g. CData JDBC Driver for SAP Ariba Source).
   • Set Class Name to the class name for the JDBC driver: cdata.jdbc.saparibasource.SAPAribaSourceDriver.
   • Set URL Template to jdbc:saparibasource:.
3. In the Libraries tab, click "Add File," navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\) and select the JAR file (cdata.jdbc.SAPAribaSource.jar).

Create a Connection to SAP Ariba Source Data

Follow the steps below to add credentials and other required connection properties.

1. In the "Database" menu, click "New Database Connection."
2. In the "Connect to a database" wizard that results, select the driver you just created (e.g. CData JDBC Driver for SAP Ariba Source) and click "Next >."
3. On the Main tab of the configuration wizard, set the JDBC URL, using the required 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.

   Below is a typical connection string:

   jdbc:saparibasource:API=SupplierDataAPIWithPagination-V4;APIKey=wWVLn7WTAXrIRMAzZ6VnuEj7Ekot5jnU;Environment=SANDBOX;Realm=testRealm;AuthScheme=OAuthClient;InitiateOAuth=GETANDREFRESH
4. Click "Test Connection ..." to ensure you have configured the connection properly.
5. Click "Finish."

Query SAP Ariba Source Data

You can now query information from the tables exposed by the connection: Right-click a Table and then click View Table. The data is available on the Data tab.

More Information & Free Trial