SAP SuccessFactors

succesfactors-1
HRIS Service User Setup

Overview

In this article, we will be covering the steps needed to create a new User in SAP SuccessFactors, and limiting the permissions / scope to what is required for the use case of the company you are linking to!

Step 1: Create a new Super Admin User that will be used to link

Follow to create a Super Admin user in your system that will have limited permissions / scope for the use case you are linking for.

Step 2: Create a new Permission Group

Search up "Manage Permission Groups" in your search bar to navigate to the Permission Groups page.
Screen Shot 2023-09-08 at 2.50.26 PM.png
Expand to see full image
You will need to click "Create New" to create a new Permission Group for the linking flow.
You can name the "Group Name" something along the lines of "Integrations Linking" to track that this Permission Group is for this specific connection.
The User Type needs to be "Employee", and the "Choose Group Members" should include the User you created in Step 1.
Screen Shot 2023-09-08 at 2.51.15 PM.png
You do not need to input anything in regards to the Exclude Section, or the Granted Permission Roles at this time.
Click "Done" to create and save this Permission Group.

Step 3: Create Permission Role with Proper Permissions

Search up "Manager Permission Roles" in your search bar to navigate to the Permission Role page.
Screen Shot 2023-09-08 at 2.54.46 PM.png
Exand to see full image

Part 1: Name the Permission Group

Screen Shot 2023-09-08 at 3.22.58 PM.png
Expand to see full image

Part 2: Identify and Select the Permissions that matter for the use case you are trying to achieve

Click "Permissions" to open available User and Admin Privileges available.

REQUIRED FOR GENERAL AUTHENTICATION:

Manage Integration Tools - Access to "Manage OAuth2 Client Applications", "Manager OData API Basic Authentication", and all API + OData related pieces
This will be category agnostic, and just required for the general API authentication.
Screen Shot 2023-09-08 at 3.28.50 PM.png
Exand to see full image
General User Permission - User Login is required to ensure that you're able to login to integrate
Screen Shot 2023-09-08 at 3.36.03 PM.png
Exand to see full image

HRIS Permissions:

Employee Data - this allows for View Access to Employee Information
Screen Shot 2023-09-08 at 3.34.37 PM.png
Exand to see full image
Employee Central API, Employee Central Import Settings,
Screen Shot 2023-09-08 at 3.42.30 PM.png
Exand to see full image

Part 3: Granting Permission Role to the created Permission Group

Click "Add" to add the Permission Group created in Step 2. You can search for the name of that Group, select it, and then press "Done"
Screen Shot 2023-09-08 at 3.44.54 PM.png
Exand to see full image
Now you should save these changes as you're all set! You just need to login into the User's SAP account and generate the Client Credentials, which is described below.
Now we will go through the full Linking Flow from within the Service User's Account!

Step 4: Find your SAP SuccessFactors API Server URL

1. To find your API Server URL, go to this
.

2. In the listed API Server URLs, search for the environment that matches your subdomain. For example, if your domain was https://salesdemo4.successfactors.com, search for salesdemo4.

Screen Shot 2022-10-04 at 6.03.13 PM.png
Expand to see full image
If you are unsure what your API Server URL is, or are having trouble connecting, we recommend reaching out to your SAP Support team to obtain your API Server URL.
info
If you are using the our sandbox, please enter: api68sales.successfactors.com

3. Copy the entire URL.

In this example, it would be: apisalesdemo4.successfactors.com

4. Enter your SAP SuccessFactors API Server URL into the integration authorization component as shown below:

Screen Shot 2022-10-04 at 6.05.43 PM.png

Step 5: Find your SAP Username and Company ID

1. To find your SAP SuccessFactors username, go to the upper right hand side and click on your profile image to view your username.

This will be the Username for the Service User you created in the first part of this guide!
annotely_image (14).jpeg
Expand to see full image

2. To find your SAP SuccessFactors Company ID, in the same dropdown menu, click "Show version information." Locate Company ID in the modal that pops up:

page_2.jpeg
Expand to see full image

3. Once you obtain your username (not email) and company ID, enter them in the linking flow as shown:

Untitled (6).png
Expand to see full image

Step 6: Find your SAP SuccessFactors Client ID and Secret

1. In your Admin Center, go to Tools, and search Manage OAuth2 Client Applications (If your page looks different, search for Manage OAuth2Client Applications in the search tool on your homepage).

Screen Shot 2022-10-05 at 12.36.49 PM.png
Expand to see full image

2. Click Register Client Application.

Screen Shot 2022-10-04 at 6.21.45 PM.png
Expand to see full image

3. Fill out Application Name & Application URL (what actually goes in these fields is not important, except that the URL has to begin with https://).

Untitled (8).png
Expand to see full image

4. Click Generate X.509 Certificate. Fill out Common Name (name doesn't matter) and hit Generate.

Untitled (9).png

5. Once the certificate populates, download and save it. You will have downloaded a file called Certificate.pem.

Untitled (10).png
Expand to see full image

6. Click Register (it will have replaced the Generate button).

7. Back on your Manage OAuth2 Client Applications, go to the application you just created and click Edit.

Untitled (11).png
Expand to see full image

8. You will now see an API key listed - this is your Client ID. Copy and save this Key.

Screen Shot 2021-11-01 at 8.36.42 PM.png
Expand to see full image

9. Open up the "Certificate.pem" file that you downloaded previously in a text editor.

The string between:
——BEGIN ENCRYPTED PRIVATE KEY——
and
—— END ENCRYPTED PRIVATE KEY——
is your Client Secret. Copy the Client Secret and save.
annotely_image (15).jpeg
Expand to see full image

10. Enter your Client ID and Secret into the integration authorization component as shown below:

Untitled (13).png
Expand to see full image

Process complete! 🎉



Additional Resources



Did this article help?


Want to print your doc?
This is not the way.
Try clicking the ⋯ next to your doc name or using a keyboard shortcut (
CtrlP
) instead.