SAP SuccessFactors

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).

Find your API domain

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

1. Open the SuccessFactors API URLs list.

2. Filter for production environments (unless you're trying to connect a preview instance)

   

3. Once the filter is applied, find your location and select the API domain. If you are, for example, based in Germany, you're 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)

Find your Company ID

1. Click on the profile picture in the top right and then on "Show version information":
   ​

   

2. Copy the value right next to Company ID:
   ​

   

Create a new user

1. In the admin center, go to the search console and type in "Import Employee Data"
   ​Click on the action that just appeared:
   ​

   

2. Click on "Import data" and then select "Download Template":
   ​

   

3. Click on the field next to "Select an entity" and then on "Basic Import":
   ​

   

4. Click on the "Generate Template" button
   ​

   

5. You will receive a .csv file to download. You at least have to fill out these fields
   - Status: active
   - User ID: any value (i.e. SFAPI_INTEGRATION)
   - Username: any value (i.e. SFAPI_INTEGRATION)
   - First name: any value (i.e. API)
   - Last name: any value (i.e. Integration)
   - Email: any value (doesn't have to be a valid email, i.e. integration+user@example.com)
   - Manager: NO_MANAGER
   - HR: NO_HR
   - Default locale: en_US
   ​
   Your csv should now look something like this example CSV
   ​
   It's important that you generate your own .csv template and don't download this example as your SuccessFactors instance will be configured differently
   ​

6. Now click on "Download Template" and then on "Import Data" to switch back
   ​

   

7. Click on the field next to "Select an entity" and then on "Basic Import"
   ​

   

8. Click on the "Browse" and select your .csv file to upload

9. Click on the "Validate Import File Data" button
   ​

   

10. If you see the "Validation Successful" dialog, click on the "Import" button
    ​

    

11. You should now see this success dialog

    

12. You can make sure the creation succeeded by searching for the employee name or username and seeing it under the "People" section

    

Create a permissions group

1. Go to your search bar and enter "Manage Permission Groups"
   Click on the Action
   ​

   

2. On the new page, click the "Create New" button
   ​

   

3. Give the group a "name" and click on "Pick a category"
   Select the category option "Username"
   ​

   

4. Search for your user (to learn how to create a new one, click here) by entering it's username and tick the box next to it

5. Click "Done"
   ​

   

6. You should now see your user in the people pool

7. Click "Done"
   ​

   

Create a permission role

1. Go to the search bar and enter "Manage Permission Roles"
   Then click on the action with the same name
   ​

   

2. On the new page, click on "Create New"
   ​

   

3. Enter a name for the permission role

4. Click on the "Permission" button
   ​

   

5. Now you have to assign the correct permissions to the permission group. To do this, go through the following steps:

   1. See the needed permissions in the connection flow

      

      
      This is just an example. To see the scopes that are required for you, open the connection flow yourself.
      ​
      ​

   2. For each Bullet, find the the permission category in the sidebar. I.e. for "Manage System Properties", find the
      You can find these more easily by pressing STRG + F and pasting the permission there
      ​

      
   3. 

   4. Now for each sub-bullet, click the right permission in the category

      
      

6. When you checked all necessary permissions, click "Done"
   ​

   

7. Now click on the "Add" button under section 3

   

8. In the new window, click on the "Select" button

   

9. Enter the name of your permission group (if you haven't created one yet, click here) and select it

10. Click "Done"
    ​

    

11. You should now see your permission group

12. Click "Done" again
    ​

    

13. At last, click "Save Changes"

    

Generate new OAuth2 client credentials

1. Go to your search bar and enter "Manage OAuth2 Client Applications"
   Click on the action
   ​

   

2. In the new window, click on "Register Client Application"

   

3. In the new window enter a name and a valid URL for the application

4. Do not click "Generate X.509 Certificate" but instead, "Copy" the certificate from the connection flow:
   ​

   

   
   ​

5. Click "Register"

   

6. Now click on "View" in the row at the very top
   ​

   

7. Get the API key

   

8. Now paste the API key and the name of the API user into the connection flow

9. Click on "Set up integration"
   ​