Step-by-step deployment guide
1. Setting up a dedicated user in SAP SuccessFactors
The SAP SuccessFactors connector for Elimity Insights authenticates as an OAuth client application bound to a user. We recommend creating a dedicated user to assign the minimal amount of permissions. Refer to the official documentation for instructions on how to create a new user in SAP SuccesFactors. Note down the newly created user's username.
2. Setting up a dedicated permission role in SAP SuccessFactors
We also recommend creating a dedicated permission role for the newly created user. This permission role should only grant the 'Employee Export' permission. The official documentation contains more information about creating a new permission role in SAP SuccessFactors.
3. Setting up a dedicated permission group in SAP SuccessFactors
To assign the newly created permission role to the newly created user, we recommend using a dedicated static permission group. Refer to the official documentation for instructions in how to create a new static permission group in SAP SuccessFactors.
4. Assigning the permission role in SAP SuccessFactors
Follow the instructions listed in the official documentation to assign the newly created permission role to the newly created permission group.
5. Setting up an OAuth client application in SAP SuccessFactors
Create a new OAuth client application as described in the official documentation. We recommend enabling the 'Bind to Users' option and entering the newly created user's username in the 'User IDs' field. For the 'X.509 Certificate' field, we recommend to generate your own certificate and private key; for example by using the following OpenSSL command:
$ openssl req -days 999 -keyout key.pem -newkey rsa -nodes -out cert.pem -subj '/CN=elimity-insights' -x509Remember to strip out the beginning and ending lines from the certificate contents before pasting into the 'X.509 Certificate' field. Securely store the private key you generated, you will need it to set up the new source in Elimity Insights. Also note down the newly created application's API key.
6. Deploying the gateway
The next step in setting up automatic imports via a custom SAP SuccessFactors gateway is deploying the gateway itself. As usual, please make sure your instance of Elimity Insights can reach the gateway and that the gateway can reach your SAP SuccessFactors tenant. Since we distribute the gateway as a Docker image, our recommendation for deployment is to use a CaaS solution like Google Cloud Run or Azure Container Apps. If that's not an option, you can also manually deploy the image on e.g. Windows Server. Refer to our documentation about gateways and import agents for additional details.
7. Creating a custom source in Elimity Insights
To set up automatic imports via the custom SAP SuccessFactors gateway we need to create a custom source in Elimity Insights itself first. Use the export file below as a starting point for the new source's data model:
This file just defines the only user entity type and a single (fixed) status attribute type. You can simply add attribute types to the data model later on.
8. Enabling automatic imports
Having a the new custom source, you can now navigate to its detail page in Elimity Insights and open the 'CONFIG' tab. Click the 'EDIT' button and enter your gateway's URL and the desired CRON schedule. Also add the following configuration values:
apiKey
Text
API key you noted down in step 5
apiUrl
Text
URL of the API server for your SAP SuccessFactors tenant; refer to the official documentation for more information
attributes
JSON
JSON array describing which attributes to import from SAP SuccessFactors; refer to the dedicated section on this page for more information
companyId
Text
Your SAP SuccessFactors company identifier; refer to the official documentation for instructions on how to find this information
userId
Text
Username of the newly created user, which you noted down in step 1
x509PrivateKeyFile
Secret file
Private key you stored in step 5
Attributes
The attributes configuration value determines which attributes the gateway should import from SAP SuccessFactors. It should be a JSON array of objects, where each object should have the following properties:
id
string
Unique identifier of the attribute type for which the gateway should import assignments
path
string
Path of the property to read from user objects returned by SAP SuccessFactors; refer to the dedicated section on this page for more information
Path
For each attribute you want to import, the gateway needs to know where to find it in user objects returned by SAP SuccessFactors. The table below shows which values of path we currently support, and what their corresponding data types are:
companyExitDate
Date-time
custom01, custom02, ..., custom15
String
department
String
division
String
email
String
empId
String
firstName
String
hireDate
Date-time
jobCode
String
lastModified
Date-time
lastName
String
manager.displayName
String
username
String
Last updated