Prerequisites

Please carefully read the following to make sure you are able to complete the setup:

You are an Admin of your SAP SuccessFactors instance. If you are not an admin, you won't even be able to search for and access the configuration pages that are described later on.
- Alternatively: Please contact your SuccessFactors Admin and have them take over the integration setup process.
The OData v2 API is available and enabled on your SuccessFactors instance (it is by default, so this is usually not something to worry about).

Overview

Estimated, overall setup time: 30 minutes.

Fundamentally, there are 3 main steps you have to complete to set up the integration:

1. You have to create a new user and permission group for that user,

2. You have to create a new permission role and then assign that to the newly-created permission group,

3. You have to generate the API credentials for that permission role.

That's it! The rest of this document is a step-by-step walkthrough of everything you need to know and do to set up the integration.

Find your API domain

Your API domain will depend on which region you are based in. To find it, you have to:

Open the SuccessFactors API URLs list.
Filter for production environments (unless you're trying to connect a preview instance)
Once the filter is applied, find your location and select the API domain. If you are, for example, based in Germany, your production URL would be https://api012.successfactors.eu/
Hint: The resulting “API Server” URL will often look quite similar to the SuccessFactors domain you log in on (the API for pmsalesdemo8.successfactors.com is, for example, located at apisalesdemo8.successfactors.com)

Please note that this is a workaround as there is no direct way to get the API domain via the SuccessFactors UI on your own. SAP shares in their help center that you should reach out to your SAP consultant to get the proper API domain.

Your API endpoint will depend on where your SAP SuccessFactors instance is located. It can be in one of several data centers. Please contact your SAP SuccessFactors representative if you are unsure of which data center to use. You'll find the endpoints in the Related Information section.

Generate new OAuth2 client credentials

Use the search bar at the top of the dashboard and search for "Learning Administration" – then click on the first result:
Use the left side bar menu to open the "System Administration" tab, then click on "Configuration", and finally click on "OAuth Token Server":
Once there, click on the "Generate a new Client Secret" button:
Before accepting this confirmation dialog, confirm that the previous credentials were not used – otherwise, know that you will need to update them in the appropriate systems:
The page will briefly reload and you will see all of the necessary credentials – copy the "Client ID", "Newly Generated Client Secret", and "Company ID", and paste them in the connection flow:

Create a new administrator user

Use the search bar at the top of the dashboard and search for "Learning Administration" – then click on the first result:
Use the left side bar menu to open the "System Administration" tab, then click on "Security", and finally click on "Role Management":
Once there, click "Add New":
Name the new role "OCNADMIN" and ensure that the "Role Type" is set as "ADMIN" – after that, click on the "Add" button:
Once the new role is created, navigate to the "Permissions" tab and use the "add one or more from list" link to select the following roles: "Learning Activities", "Search", and "People Management" – once done, click "Apply Changes":
Use the left side bar menu again to navigate to "System Administration" > "Security" > "Administrators" – once there, click on the "Add New" button:
Enter "OCN_ADMIN" as the "Admin ID", then "OCN_ADMIN" again as the "Last Name" and "Kombo" as "First Name"
In the "Related User" input, enter the identifier of an existing non-admin user from your instance. Note: this user should have read access to all the courses you are interested in, for example through being assigned to them.
Enter a secure password in the "New Password" field and then again in "Verify Password" – finally, click on the "Add" button:
Once the admin is added, go to the "Assigned Roles" tab and under "Add Roles to the Admin" section, enter the "Role ID" from step 4 and then click "Add":
Finally, enter the "Admin User ID" and "User ID" in the connection flow

Obtaining the Provider ID

Use the search bar at the top of the dashboard and search for "Learning Administration" – then click on the first result:
Use the left side bar menu and navigate to "Content" > "Open Content Network":
In the "Content Provider" section, copy the identifier of the provider you are interested in, specifically the value inside the brackets: