Using the CData ODBC Driver for SAP Ariba Source in PyCharm

The CData ODBC Drivers can be used in any environment that supports loading an ODBC Driver. In this tutorial we will explore using the CData ODBC Driver for SAP Ariba Source from within PyCharm. Included are steps for adding the CData ODBC Driver as a data source, as well as basic PyCharm code to query the data source and display results.

To begin, this tutorial will assume that you have already installed the CData ODBC Driver for SAP Ariba Source as well as PyCharm.

Add Pyodbc to the Project

Follow the steps below to add the pyodbc module to your project.

1. Click File -> Settings to open the project settings window.
2. Click Project Interpreter from the Project: YourProjectName menu.
3. To add pyodbc, click the + button and enter pyodbc.
4. Click Install Package to install pyodbc.

Connect to SAP Ariba Source

You can now connect with an ODBC connection string or a DSN. See the Getting Started section in the CData driver documentation for a guide to creating a DSN on your OS.

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.

Below is the syntax for a DSN:

[CData SAPAribaSource Source]
Driver = CData ODBC Driver for SAP Ariba Source
Description = My Description
API = SupplierDataAPIWithPagination-V4
APIKey = wWVLn7WTAXrIRMAzZ6VnuEj7Ekot5jnU
Environment = SANDBOX
Realm = testRealm
AuthScheme = OAuthClient
InitiateOAuth = GETANDREFRESH

Execute SQL to SAP Ariba Source

Instantiate a Cursor and use the execute method of the Cursor class to execute any SQL statement.

import pyodbc

cnxn = pyodbc.connect('DRIVER={CData ODBC Driver for SAPAribaSource};API = SupplierDataAPIWithPagination-V4;APIKey = wWVLn7WTAXrIRMAzZ6VnuEj7Ekot5jnU;Environment = SANDBOX;Realm = testRealm;AuthScheme = OAuthClient;InitiateOAuth = GETANDREFRESH;')
cursor = cnxn.cursor()
cursor.execute("SELECT SMVendorID, Category FROM Vendors WHERE Region = 'USA'")
rows = cursor.fetchall()
for row in rows:
 print(row.SMVendorID, row.Category)

After connecting to SAP Ariba Source in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to SAP Ariba Source data as if it were a standard database. If you have any questions, comments, or feedback regarding this tutorial, please contact us at [email protected].