Establishing a Connection
The objects available within our connector are accessible from the "cdata.sapsuccessfactorslms" module. To use the module's objects directly:
- Import the module as follows:
import cdata.sapsuccessfactorslms as mod
- To establish a connection string, call the connect() method from the connector object using an appropriate connection string, such as:
mod.connect("User=username;UserType=Password;CompanyId=CompanyId;Url=https://api4.successfactors.com")
Connecting to SAPSuccessFactorsLMS
Before you can connect to SAPSuccessFactorsLMS, you must configure the OAuth application tied to your SAPSuccessFactorsLMS account. See Creating a Custom OAuth App for a procedure.After you have configured your OAuth application, set the following to connect:
- URL: The base URL of your SAP SuccessFactors instance. You can find this value in the URL of your SAP SuccessFactors homepage before the first forward slash (/). For example: https://mycompany.successfactors.eu
- User: The username you use to log in to your SAP SuccessFactors account.
- CompanyId: The unique name assigned to your SAPSuccessFactorsLMS tenant. You can find this value in the URL of your SAP SuccessFactors homepage, between "https://" and ".successfactors" (or ".sapsf" in the case of preview instances).
- UserType: The type of user being used. Select either Admin if your account has the admin role or User if it does not.
- OAuthClientId: The value of the Client ID field, as noted during the configuration of your OAuth application.
- OAuthClientSecret: The value of the Newly Generated Client Secret, as noted during the configuration of your OAuth application.