Purpose
This guide explains how to connect SAP SuccessFactors to BetterUp®, using either an existing admin account or a dedicated service user.
Overview
To connect, you enter four things on the SAP SuccessFactors card on the BetterUp integrations page:
- API Server URL
- Username
- Company ID
- OAuth credentials (Client ID and Client Secret)
After you enter them, BetterUp checks your credentials and confirms the connection.
Jump to: Roles and responsibilities | Configuration and setup | Troubleshooting | FAQs
Roles and responsibilities
| Role | Responsibilities |
|---|---|
| SAP SuccessFactors admin | Create the service user (if using one), set its permissions, and generate the OAuth credentials. Or share access with the person doing setup. |
| BetterUp admin | Enter the API Server URL, username, Company ID, and OAuth credentials on the BetterUp integrations page. |
One person can do both if they have admin access in SAP SuccessFactors and BetterUp.
Choose an account to connect with
| Option | What to do |
|---|---|
| Dedicated service user (recommended) | Follow every step. The service user can only access what you grant it. |
| Existing admin account | Skip Steps 1 and 2, and use your own username in Step 4. |
Configuration and setup
Step 1: Create a service user
- Search for and select the Import Employee Data task.
-
Change the action to Download Template.
-
Choose the Basic Import entity and select Generate Template.
- Open the downloaded file and add a row with these values:
| Field | Sample value | Notes |
|---|---|---|
| Status | active | |
| User ID | integration_sample | Any name that helps you recognize the user |
| Username | integration_sample | Any name that helps you recognize the user |
| First Name | Sample | Any name that helps you recognize the user |
| Last Name | Integration | Any name that helps you recognize the user |
| integration_sample@example.com | Doesn't need to be a real address | |
| Manager | NO_MANAGER | |
| HR | NO_HR | |
| Default Locale | en_US |
- Save the file. Back in SAP, change the action to Import Data.
- Choose the Basic Import entity, select your file, then select Import. To check the file first, select Validate Import File Data.
- Confirm the success message appears.
- After up to a minute, search for the new user. If it appears, it was successfully created.
Step 2: Give the service user permissions
Set up a permission group and a read-only permission role by following SAP SuccessFactors: Required permissions. Then come back to Step 3.
Step 3: Find your API Server URL
Your API Server URL depends on your region.
- Open SAP's list of SuccessFactors API Servers and filter for your environment (usually production, unless you're using a preview or demo instance).
-
Find your location and its API Server URL. For example, Brazil uses https://api19.sapsf.com/. You can also search for your subdomain: if your login is https://salesdemo4.successfactors.com, search for salesdemo4.
- Copy the entire URL. In this example, it's apisalesdemo4.successfactors.com.
- Enter it in the BetterUp connection window.
Tip: Your API Server URL usually mirrors your login URL. For example, a login URL of https://hcm68sales.successfactors.com has an API Server URL of api68sales.successfactors.com. If you're not sure, SAP recommends confirming with your SAP Support team.
Step 4: Enter your username and Company ID
- Enter the service user's username from Step 1, or your own if you're using an admin account. To find a username, select the profile image at the top right. Use the username, not the email address.
- To find your Company ID, select your profile image, then Show version information. The Company ID appears in the pop-up.
- Enter the Company ID in the BetterUp connection window, then select Next.
Step 5: Generate your Client ID and Client Secret
-
In Admin Center, go to Tools and search for Manage OAuth2 Client Applications. If your page looks different, search for it from your homepage.
- Select Register Client Application.
- Fill in Application Name and Application URL. Any values work, but the URL must start with https://. If you're using a service user, check Bind to Users and enter its username in User IDs.
- Select Generate X.509 Certificate, enter any Common Name, and select Generate.
- When the certificate appears, download and save it. The file is named Certificate.pem.
- Select Register (it replaces the Generate button).
- Back in Manage OAuth2 Client Applications, find your new application and select Edit.
- Copy the API Key. This is your Client ID.
- Open Certificate.pem in a text editor. Copy the text between BEGIN ENCRYPTED PRIVATE KEY and END ENCRYPTED PRIVATE KEY. This is your Client Secret.
- Enter the Client ID and Client Secret in the BetterUp connection window.
BetterUp checks your credentials, which takes a few seconds to about a minute. When you see the success screen, you're connected.
Troubleshooting
If the connection fails, check these in order.
| Problem | What to check |
|---|---|
| Wrong URL | You entered the API Server URL from Step 3, not your login URL. |
| Partial URL | The entire API Server URL is pasted into the BetterUp connection window. |
| Wrong Client ID | The Client ID is the API Key from Step 5. |
| Wrong Client Secret | The Client Secret is only the text between BEGIN ENCRYPTED PRIVATE KEY and END ENCRYPTED PRIVATE KEY. |
| Missing permissions | The service user's role matches SAP SuccessFactors: Required permissions. |
| IP restrictions | See the FAQ below. |
FAQs
Should I use a service user or my own admin account?
Use a service user. It only has the read-only permissions you grant it, and the connection doesn't depend on one person's account.
Our SAP instance has IP restrictions. Will the connection work?
Only if BetterUp's IP addresses are on your allowlist. In Admin Center, go to IP Restriction Management. If addresses are listed, your instance only accepts access from those addresses: ask your BetterUp implementation contact for BetterUp's IP addresses, add them, and try again. If no addresses are listed, SAP accepts any IP address with valid credentials.
How long does BetterUp take to check my credentials?
A few seconds to about a minute.
Still stuck? Contact tech-ipm@betterup.co or your BetterUp implementation contact.
Jump to: Roles and responsibilities | Configuration and setup | Troubleshooting | FAQs