How to use SQLAlchemy ORM to access SAP SuccessFactors LMS Data in Python

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems effectively. With the CData Python Connector for SAP SuccessFactors LMS and the SQLAlchemy toolkit, you can build SAP SuccessFactors LMS-connected Python applications and scripts. This article shows how to use SQLAlchemy to connect to SAP SuccessFactors LMS data to query SAP SuccessFactors LMS data.

With built-in optimized data processing, the CData Python Connector offers unmatched performance for interacting with live SAP SuccessFactors LMS data in Python. When you issue complex SQL queries from SAP SuccessFactors LMS, the CData Connector pushes supported SQL operations, like filters and aggregations, directly to SAP SuccessFactors LMS and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Connecting to SAP SuccessFactors LMS Data

Connecting to SAP SuccessFactors LMS data looks just like connecting to any relational data source. Create a connection string using the required connection properties. For this article, you will pass the connection string as a parameter to the create_engine function.

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.

Follow the procedure below to install SQLAlchemy and start accessing SAP SuccessFactors LMS through Python objects.

Install Required Modules

Use the pip utility to install the SQLAlchemy toolkit and SQLAlchemy ORM package:

pip install sqlalchemy
pip install sqlalchemy.orm

Be sure to import the appropriate modules:

from sqlalchemy import create_engine, String, Column
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker

Model SAP SuccessFactors LMS Data in Python

You can now connect with a connection string. Use the create_engine function to create an Engine for working with SAP SuccessFactors LMS data.

NOTE: Users should URL encode the any connection string properties that include special characters. For more information, refer to the SQL Alchemy documentation.

engine = create_engine("sapsuccessfactorslms:///?User=username&CompanyId=CompanyId&Url=https://api4.successfactors.com&InitiateOAuth=GETANDREFRESH")

Declare a Mapping Class for SAP SuccessFactors LMS Data

After establishing the connection, declare a mapping class for the table you wish to model in the ORM (in this article, we will model the Items table). Use the sqlalchemy.ext.declarative.declarative_base function and create a new class with some or all of the fields (columns) defined.

base = declarative_base()
class Items(base):
	__tablename__ = "Items"
	ItemID = Column(String,primary_key=True)
	ItemTitle = Column(String)
	...

Query SAP SuccessFactors LMS Data

With the mapping class prepared, you can use a session object to query the data source. After binding the Engine to the session, provide the mapping class to the session query method.

Using the query Method

engine = create_engine("sapsuccessfactorslms:///?User=username&CompanyId=CompanyId&Url=https://api4.successfactors.com&InitiateOAuth=GETANDREFRESH")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Items).filter_by(Active="true"):
	print("ItemID: ", instance.ItemID)
	print("ItemTitle: ", instance.ItemTitle)
	print("---------")

Alternatively, you can use the execute method with the appropriate table object. The code below works with an active session.

Using the execute Method

Items_table = Items.metadata.tables["Items"]
for instance in session.execute(Items_table.select().where(Items_table.c.Active == "true")):
	print("ItemID: ", instance.ItemID)
	print("ItemTitle: ", instance.ItemTitle)
	print("---------")

For examples of more complex querying, including JOINs, aggregations, limits, and more, refer to the Help documentation for the extension.

Free Trial & More Information

Download a free, 30-day trial of the CData Python Connector for SAP SuccessFactors LMS to start building Python apps and scripts with connectivity to SAP SuccessFactors LMS data. Reach out to our Support Team if you have any questions.