Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Important
This feature is for public preview customers only. Features in preview might not be complete and could undergo changes before becoming available in the broader release.
You can import organizational data into Microsoft 365 with the SAP SuccessFactors connector. Here's how.
Prerequisites
Before you can set up a connection between SAP SuccessFactors and Microsoft 365, you'll need the following information about your SAP SuccessFactors environment from your SAP SuccessFactors Administrator:
- Company ID
- Base URL
- User ID
- API key
- Completed steps within SAP SuccessFactors described below in Step 2
Steps
1. Set up your SAP SuccessFactors connection
Applies to: Microsoft 365 Global Administrator
Start the import from the Data Connections page on the Organizational Data in Microsoft 365 page (Home > Setup > Migration and imports > Organizational Data in Microsoft 365 > Data Connections).
Select Get started (if this is the first time you're importing data), or New import (if you've already imported data).
On the Select connection type page, select Start SuccessFactors setup.
On the Download your SAP SuccessFactors certificate page, select Download certificate. A x509 certificate file will download called "publicKey.pem." Open the file in a text editor and copy its contents. Share this with the SAP SuccessFactors admin.
Read the acknowledgment note and select Next.
Under Set up SAP SuccessFactors connection:
- Enter a name for your connection.
- Contact your SAP SuccessFactors admin to complete the steps in SAP SuccessFactors described below in Step 2. Enter the SAP SuccessFactors Company ID, Base URL, User ID, and API key provided by the SAP SuccessFactors admin.
- Select how frequently you want SAP SuccessFactors to send data to Microsoft 365: weekly or monthly.
Confirm you understand that the data you upload here might be processed by Viva and Microsoft 365, as well as non-Microsoft services to which you've granted access through Microsoft Graph, and select Next.
Review your connection details, then select Confirm.
Note
If you set up periodic exports, your data will be validated for Viva and Microsoft 365 services requirements. Validation takes a few hours; however, it can take up to three days for your complete data upload to be available in the profile store. You can check the validation status on the Organizational data page in the Microsoft 365 admin center. When the validation is complete, a message lets you know that your data is in use and managed by Viva and Microsoft 365.
2. Steps within SAP SuccessFactors
Applies to: SAP SuccessFactors Admin
Create/identify an API user to be used for OData API access. The UserId/Username of this user is required for future steps. This user is assigned permissions to access user data through the SAP SuccessFactors OData APIs.
Create an API Permissions Role
In the SAP SuccessFactors Admin Center, navigate to Manage Permission Roles, and select Create to create a new role.
Add a Role Name and Description for the new permission role. The name and description should indicate that the role is for API usage permissions.
In the Add Permissions section, on the left under Administrator Permissions, search for "Employee Central API." This role requires the Employee Central Foundation OData API (read-only) and Employee Central HRIS OData API (read-only) permissions.
Some permissions are required under the Employee Data section. This restricts which fields are ingested. Ensure the view column is selected for all the fields you want to share, such as User id, email, or manager. The relevant fields are listed under Standard Element on this page. A subset of these can be selected to start for testing, such as User id, email, and manager.
Note
The status and lastModified fields are required because they're used for filtering. These fields must always be included for the connector to work.
Once all the permissions are set up, select Next and then save the permission role.
Create an API Permissions Group for the assigned role. Navigate to Manage Permission Groups in the Microsoft 365 admin center and create a new group. Search for the user created in Step 1 and assign that user to the newly created group, for example:
Assign the Permission Role to the new Permission Group. In Manage Permission Roles, select Add Role Assignments to assign the created role to the group. Name the role assignment whatever you want, then on the Grant Access To page, select the group you created in Step 2c, for example:
Then, advance through the rest of the screens and select Save. You now have all the required permissions to create an OAuth token and fetch user data.
Register a new OAuth2 Client Application
- In the Microsoft 365 admin center, navigate to the Manage OAuth2 Client Applications page and select Register Client Application. Learn more.
- The Application Name can be anything but it must be unique, such as "Microsoft 365."
- Set the Application URL to any valid URL.
- Enable Bind to users and enter the User ID from Step 1 into the "User IDs" field. This ensures that only the created user is allowed to generate OAuth tokens.
- X.509 Certificate should contain the full public key copied in Step 2.
- After registering the client application, view it so you can copy the "API Key" for the next step.
- Save the following information and share it with the Microsoft 365 global admin to enter in the Microsoft 365 admin center:
- Company ID is your SAP SuccessFactors company ID
- Base URL is your SAP SuccessFactors data center URL. See a list of SAP SuccessFactors API Servers.
- User ID is the user that has the required API permissions. If you enabled bind to user, that user's id must be used in the "User ID" field.
- A "Secret" or "SecretUri" is required depending on how you provide the API key.
How SAP SuccessFactors sends data to Microsoft 365
When you connect SAP SuccessFactors to Microsoft 365, SAP SuccessFactors sends a set of predefined source columns. These columns are mapped to fields in Microsoft 365. You can't change these predefined fields.
Field mapping
The table below shows how SAP SuccessFactors fields correspond to Microsoft 365 fields. Learn more about Microsoft 365 fields, including data type and formatting requirements.
| Attribute | SAP SuccessFactors Field |
|---|---|
| Microsoft_PersonEmail | personNav.emailNav.results[?(@.emailType == '8448')].emailAddress |
| Microsoft_ManagerEmail | jobInfoNav.results[?(@.effectiveLatestChange == true)].managerEmploymentNav.personNav.emailNav.results[?(@.emailType == '8448')].emailAddress |
| Microsoft_Organization (Department) | jobInfoNav.results[?(@.effectiveLatestChange == true)].departmentNav.name |
| Microsoft_Layer | No mapping from SAP SuccessFactors |
| Microsoft_LevelDesignation | jobInfoNav.results[?(@.effectiveLatestChange == true)].positionNav.jobLevel |
| Microsoft_JobDiscipline | jobInfoNav.results[?(@.effectiveLatestChange == true)].jobClassificationCountryNavUSA.cust_jobDiscipline Or EmpJob.results[?(@.endDate == null)].jobClassificationCountryNavUSA.cust_jobDiscipline |
| Microsoft_CompanyOfficeLocation | jobInfoNav.results[?(@.effectiveLatestChange == true)].locationNav.internalCode |
| Microsoft_CompanyOfficeCountryOrRegion | jobInfoNav.results[?(@.effectiveLatestChange == true)].locationNav.addressNavDEFLT.country |
| Microsoft_CompanyPostOfficeBox | No mapping from SAP SuccessFactors |
| Microsoft_CompanyOfficeStreet | jobInfoNav.results[?(@.effectiveLatestChange == true)].locationNav.addressNavDEFLT.address1 |
| Microsoft_CompanyOfficeCity | jobInfoNav.results[?(@.effectiveLatestChange == true)].locationNav.addressNavDEFLT.city |
| Microsoft_CompanyOfficeState | jobInfoNav.results[?(@.effectiveLatestChange == true)].locationNav.addressNavDEFLT.state |
| Microsoft_CompanyOfficePostalCode | jobInfoNav.results[?(@.effectiveLatestChange == true)].locationNav.addressNavDEFLT.zipCode |
| Microsoft_Company | jobInfoNav.results[?(@.effectiveLatestChange == true)].companyNav.name |
| Microsoft_CompanyCode | No mapping from SAP SuccessFactors |
| Microsoft_FirstName | personNav.personalInfoNav.results[0].firstName |
| Microsoft_LastName | personNav.personalInfoNav.results[0].lastName |
| Microsoft_DisplayName | personNav.personalInfoNav.results[0].displayName |
| Microsoft_JobTitle | jobInfoNav.results[?(@.effectiveLatestChange == true)].jobTitle |
| Microsoft_SecondaryJobTitle | No mapping from SAP SuccessFactors |
| Microsoft_UserSkillNames | No mapping from SAP SuccessFactors |
| Microsoft_EmploymentType | jobInfoNav.results[?(@.effectiveLatestChange == true)].employmentTypeNav.picklistLabels.results[?(@.locale == "en_US")].label |