Prerequisites
Make sure the person completing this integration is 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.
If not, please contact your SuccessFactors Admin and have them take over the integration setup process.
Step by Step Instructions
Estimated overall setup time: 30 minutes.
There are 3 main steps you have to complete to set up the integration:
- Create a new user and permission group for that user
- Create a new permission role and then assign that to the newly-created permission group
- 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.
Step 1 - 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 and filter for production environments.
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/
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.
Step 2 - Find your Company ID
Click on the profile picture in the top right and then on Show version information and copy the value right next to Company ID:
Step 3 - Create a new user
In the admin center, search for Import Employee Data and lick on the action that just appeared.
Click on Import data and then Download Template. Make sure Entity = Basic Import and then click Generate Template. ****
You will receive a csv file to download.
Add an additional row and fill out at least these fields:
- Status: active
- User ID: SFAPI_RAVIO_INTEGRATION
- Username: SFAPI_RAVIO_INTEGRATION
- First name: Ravio
- Last name: Integration User
- Email: integrations@ravio.com (this is an example, replace with any email you see fit)
- Manager: NO_MANAGER
- HR: NO_HR
- Default locale: en_US
Now click on Download Template and then on Import Data making sure Entity = Basic Import again.
Before uploading, click on the Validate Import File Data button to make sure there are no mistakes. If you see Validation Successful, import the data.
Please keep the .csv file open in the background, as you will need to reference it later.
You can ensure the creation succeeded by searching for the employee name (first name and last name) or username and seeing it under the "People" section. Don't be confused if the new user doesn't show up immediately, it can sometimes take a few minutes for the user to show up in the search!
Once the user shows up as described, you can move on to creating the permissions group.
Step 4 - Create a permissions group
Search for Manage Permission Groups and on the new page select Create New
Make sure the below is populated:
- Name: Ravio Permissions
- Category: Username
- Group Members: Make sure the user that we just created is added (SFAPI_RAVIO_INTEGRATION).
Click Done.
Step 5 - Create a permission role & assign the right permissions
Search for Manage Permission Roles, and then Create New.
Enter a name for the permission role (e.g. Ravio Permission Role) and click on the Permission button.
Now you have to assign the correct permissions to the permission group. To do this, go through the following steps:
-
See the needed permissions in the connection flow (this is an example, please refer to below Required Permissions table):
-
For each Bullet, find the permission category in the sidebar. I.e. for "Manage System Properties", find the corresponding permission group in the sidebar of the SF UI.
-
Now for each sub-bullet, click the right permission in the category on the right hand side.
Required Permissions
- Recruiting Permissions
- OData API Job Requisition Export
- OData API Job Offer Export
- OData API Offer Letter Export
- OData API Application Export
- OData API Candidate Export (required for deduplicating candidates)
- Employee Central API
- Employee Central Foundation OData API (optional, used for retrieving job locations)
- Manage Integration Tools
- OData API Attachment Import
When you checked all necessary permissions, click Done.
Now click on the "Add" button under section 3
In the new window, click on the Select button and enter the name of your permission group. Once this is added, click Done.
You should now see your permission group, click Done again then finally Save Changes.
Step 6 - Generate new OAuth2 client credentials
Search for Manage OAuth2 Client Applications and in the new window, click on Register Client Application.
Enter a name and a valid URL (https://app.ravio.com) for the application, click the Bind to Users checkbox and click OK.
Enter the USER ID of the user that we created earlier.
Do not click "Generate X.509 Certificate" but instead, "Copy" the certificate from the connection flow:
Paste the certificate and click Register.
Now click on "View" in the row at the very top and get the API key.
Paste the API key and the name of the API user into the connection flow and click on Set up integration.