Using the CData ODBC Driver for SAP SuccessFactors LMS 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 SuccessFactors LMS 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 SuccessFactors LMS 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 SuccessFactors LMS

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.

SAP SuccessFactors LMS uses OAuth authentication. Before connecting, you must configure an OAuth application tied to your SAP SuccessFactors LMS account.

To establish a connection, set the following properties:

• User: Your SAP SuccessFactors LMS username.
• CompanyId: Your SAP SuccessFactors company identifier.
• Url: The SAP SuccessFactors API URL (e.g., https://api4.successfactors.com).
• OAuthClientId: The client Id assigned when you registered your custom OAuth application.
• OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.

See the Getting Started chapter of the help documentation for a guide to creating a custom OAuth app and using OAuth.

Below is the syntax for a DSN:

[CData SAPSuccessFactorsLMS Source]
Driver = CData ODBC Driver for SAP SuccessFactors LMS
Description = My Description
User = username
CompanyId = CompanyId
Url = https://api4.successfactors.com
InitiateOAuth = GETANDREFRESH

Execute SQL to SAP SuccessFactors LMS

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 SAPSuccessFactorsLMS};User = username;CompanyId = CompanyId;Url = https://api4.successfactors.com;InitiateOAuth = GETANDREFRESH;')
cursor = cnxn.cursor()
cursor.execute("SELECT ItemID, ItemTitle FROM Items WHERE Active = 'true'")
rows = cursor.fetchall()
for row in rows:
  print(row.ItemID, row.ItemTitle)

After connecting to SAP SuccessFactors LMS in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to SAP SuccessFactors LMS 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].