SAP Best Practices For SAP Successfator EC Integration With SAP ERP HCM PAYROLL
SAP Best Practices For SAP Successfator EC Integration With SAP ERP HCM PAYROLL
1 Purpose. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2 Solution Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
5 Implementation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
5.1 Technical Users. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13
SAP SuccessFactors Employee Central. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Setup SF API User Group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Set up SF API Permission Roles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Enhance Administrator Permission for Monitoring. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16
5.2 Set up Replication Target System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
6 Permission Roles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Getting Started Guide: SAP Best Practices for SAP SuccessFactors EC Integration with SAP
ERP HCM Payroll
2 PUBLIC Content
1 Purpose
This Getting Started guide describes all activities you need to carry out before you implement the solution
package from system preparation to implementation of the business content and validation.
Further Info
This section is for the following target groups who already have a sound knowledge of the SAP Best Practices
implementation, including tools and documentation.
● Business consultants: Evaluate business content/processes including troubleshooting, FAQ, and further
information, for extended usage of the package.
● Implementation consultants (application consultants): Implementation of business content and
processes.
Note
The Reimagined Home Page (Latest Home Page) will be pushed to all customer instances (that are not
already migrated). For more details, check the Migration to Reimagined Home Page June 2022 - Innovation
Alert post in the SAP SuccessFactors Community.
Therefore all home page activities described in this solution are already based on the new UI experience.
Note
All workbooks referenced in the configuration guides can be found on the SAP Help Portal.
Getting Started Guide: SAP Best Practices for SAP SuccessFactors EC Integration with SAP
ERP HCM Payroll
Purpose PUBLIC 3
2 Solution Overview
The SAP Best Practices content for migration and replication is intended to accelerate the migration of
organizational and employee data from the on-premise SAP ERP HCM System to SAP SuccessFactors
Employee Central and to enable replication of the data from SAP SuccessFactors Employee Central to SAP
HCM on-premise Payroll in the core hybrid setup.
Getting Started Guide: SAP Best Practices for SAP SuccessFactors EC Integration with SAP
ERP HCM Payroll
4 PUBLIC Solution Overview
3 System Setup and Preparation
Prior to implementing an SAP Best Practices package (SAP BP package), check the Software and Delivery
Requirements document regarding required SAP notes to be installed in the on-premise finance/cloud payroll
system.
Getting Started Guide: SAP Best Practices for SAP SuccessFactors EC Integration with SAP
ERP HCM Payroll
System Setup and Preparation PUBLIC 5
4 Preparing for Implementation
A communication user must be created in the SAP ERP HCM system for technical communication between the
ERP system and Cloud Platform Integration account as a system or communication user.
1. In your SAP ERP HCM system, access the transaction using one of the following navigation options:
2. On the User Maintenance: Initial Screen, enter a <User Id> for your technical user, for example,
SF_COMM.
3. Choose Create.
4. On the Logon Data tab, choose the entry B (System), as User Type.
5. On the Roles tab, assign the user roles described in the next section Authorization Roles [page 6] to the
user.
6. Save your user.
The following roles specific to integration and migration need to be provided to the technical communication
user created in the previous step. These roles also need to be provided to users who are testing and executing
the migration and replication reports.
● SAP_HR_SFIOM_PROCESSING
● SAP_HR_SFIOM_WEBSERV
● SAP_HR_SFI_EMPL_DATA_REPL
In addition, the user customizing the technical settings would require access to the generic roles (if not already
provided by the system administrator) to carry out customizations in the Configuration guides.
● SAP_BC_WEBSERVICE_SERVICE_USER
● SAP_BC_CUS_CUSTOMIZER
● SAP_ABAP_CHANNELS_ADMIN
● SAP_BC_CTS_ADMIN
● SAP_BC_WEBSERVICE_ADMIN_TEC
Getting Started Guide: SAP Best Practices for SAP SuccessFactors EC Integration with SAP
ERP HCM Payroll
6 PUBLIC Preparing for Implementation
● B_ALE_ALL
● S_IDOC_ALL
The client certificate for the ERP system must be signed by one of the certifying authorities, which is trusted by
the load balancer. Further information can be found on the Load Balancer Root Certificates Supported by SAP
page.
The client certificate needs to be imported to the ERP system using the transaction STRUST (Trust Manager).
In addition, the certifying authority’s root certificates and other certificates must also be imported to the Cloud
Platform Instance, if not done already.
You must have access to SAP SuccessFactors Employee Center provisioning to perform the configuration for
the instance. As a customer, you do not have access to Provisioning. To complete tasks in Provisioning, contact
your implementation Partner. If you are no longer working with an Implementation partner, contact SAP
Support.
In the SAP SuccessFactors instance, the following provisioning switches need to be checked in the Company
Settings of your company:
Note
If the SAP Best Practice pre-configured instance has been copied, all Employee Central related switches are
disabled by default and need to be enabled again.
If the instance was not copied, most of the provisioning settings will already be enabled in your company
based on the licensing.
Check the below listed switches and enable the missing one based on your scope.
Note
For utilizing the search capabilities (control + F) in Provisioning, the exact text of the setting is listed.
Getting Started Guide: SAP Best Practices for SAP SuccessFactors EC Integration with SAP
ERP HCM Payroll
Preparing for Implementation PUBLIC 7
Switch Status
Enable Advances — requires “Employee Central V2 (that is Event Reason Derivation)”, “Enable Generic Ob Enabled
jects”, “Enable Deductions Management”, “Effective Dated Data Platform”, “Employee Profile data audit”
and “Enable the Attachment Manager”
Enable Deductions Management — requires “Employee Central V2 (that is Event Reason Derivation)”, “En Enabled
able Generic Objects”, “Effective Dated Data Platform”, “Employee Profile data audit” and “Enable the At
tachment Manager”
Enable Cost Distribution — requires “Employee Central V2 (that is Event Reason Derivation)”, “Enable Ge Enabled
neric Objects”, “Effective Dated Data Platform”, “Employee Profile data audit” and “Enable the Attachment
Manager”
Caution
For existing customers, by switching on this feature via the Upgrade Center, the old direct-deposit-
based UIs, APIs and objects will be irreversibly deactivated. New Payment Information is integrated
into Employee Central Payroll. Integration scenarios towards 3rd party systems utilizing the old direct
deposits APIs might no longer work. Check in advance and inform customers that they might need to
migrate existing 3rd party integration scenarios to the new APIs, for example, compound employee
API or OData API.
Switch Action
Enable Payroll Integration (Valid for SAP Payroll in ERP Systems) — requires “Enable Generic Objects”, Enable
“Enable Translation of Employee Central Foundation Objects”, “Enable the Attachment Manager” and “Em
ployee Central Foundation Objects”
Caution
Furthermore this SAP Best Practices content requires the latest user interface for the employee profile –
People Profile.
Getting Started Guide: SAP Best Practices for SAP SuccessFactors EC Integration with SAP
ERP HCM Payroll
8 PUBLIC Preparing for Implementation
People Profile is a prerequisite for a growing number of new solutions and functionalities.
Use
In this activity, you create a user to run and check the upgrades for the related SAP Best Practices scope if not
yet available in the system.
Note
We recommend using only one User ID with a valid e-mail address to activate the SAP Best Practices
content. Thus, you avoid changing ownership during the activation.
Getting Started Guide: SAP Best Practices for SAP SuccessFactors EC Integration with SAP
ERP HCM Payroll
Preparing for Implementation PUBLIC 9
Procedure
1. Log in to SAP SuccessFactors Provisioning for your instance using the following link:
Link https://<server>.successfactors.com/provisioning_login
Admin Password Enter password. This password needs to be changed with the first login to a password
that is suitable to your company policy
Admin First Name Enter the first name for the admin user
Admin Last Name Enter the last name for the admin user
Caution
Enter a valid e-mail address. All logs and status updates regarding the implementation will be send via
e-mail to this e-mail address.
Use
This section describes the set-up steps necessary to allow the previous created user to manage the role-based
permission access.
Getting Started Guide: SAP Best Practices for SAP SuccessFactors EC Integration with SAP
ERP HCM Payroll
10 PUBLIC Preparing for Implementation
Procedure
For implementing the SAP Best Practices for Employee Central, some basic permissions are needed to run the
activation and to check the result. Only for this purpose create an SAP Best Practices Upgrade Center Admin
role and group as described below.
Note
This role and group is only needed for the implementation of the SAP Best Practices scope and can be
deleted after the finalization.
If the picklists in the Employee Central instance are not already migrated to MDF picklists, the following steps
need to be followed for picklist conversion prior to activating SAP Best Practices content.
Getting Started Guide: SAP Best Practices for SAP SuccessFactors EC Integration with SAP
ERP HCM Payroll
Preparing for Implementation PUBLIC 11
In order to check whether the picklists are migrated, go to Admin center and search for Picklist. If you see
Picklist Management, it means that you are still using the legacy picklist and they have not being migrated. On
the other hand, if you see Picklist Center, it means they have already been migrated to the MDF Picklist.
The following upgrade center items need to be activated to enable Best Practices:
Procedure
Getting Started Guide: SAP Best Practices for SAP SuccessFactors EC Integration with SAP
ERP HCM Payroll
12 PUBLIC Preparing for Implementation
5 Implementation
Follow the steps in this section to get started on the implementation. Adapt the integration settings based on
the payroll settings and customer requirements.
STATUS active
USERID SFAPI
USERNAME SFAPI
FIRSTNAME User
LASTNAME SFAPI
MANAGER NO_MANAGER
Getting Started Guide: SAP Best Practices for SAP SuccessFactors EC Integration with SAP
ERP HCM Payroll
Implementation PUBLIC 13
Field Name Value
HR NO_HR
DEPARTMENT N/A
JOBCODE N/A
DIVISION N/A
LOCATION
Getting Started Guide: SAP Best Practices for SAP SuccessFactors EC Integration with SAP
ERP HCM Payroll
14 PUBLIC Implementation
2. Go to Admin Center.
3. Type Manage Permission Roles in the tool search box and select the feature/tool from the list.
4. On the Manage Permission Roles page select Create New.
5. The Permission Role Detail page opens.
6. In field Role Name: enter SAP BP SFAPI and in field Description: enter SAP Best Practices SFAPI
User Role.
7. Under Permission settings choose Permission....
8. Under User Permissions → General User Permissions select the SFAPI User Login checkbox.
9. Under Administrator Permissions → Manage Integration Tools, select the following checkboxes.
○ Access to SFAPI API Audit Log
○ Access to SFAPI Metering Details
○ Access to SFAPI Data Dictionary
○ Allow Admin to Access OData API through Basic Authentication checkbox.
○ Access to OData API Audit Log
○ Access to Integration Center
○ Access to Data Replication Monitor
10. Under Administrator Permissions → Employee Central API select the following checkboxes:
○ Employee Central Foundation SOAP API
○ Employee Central HRIS SOAP API
○ Employee Central Foundation OData API (read-only)
○ Employee Central HRIS OData API (read-only)
○ Employee Central Foundation OData API (editable)
○ Employee Central HRIS OData API (editable)
11. Under Administrator Permissions → Metadata Framework select the following checkboxes:
○ Admin access to MDF OData API
○ Import Permission on Metadata Framework
12. Under Administrator Permissions → Manage User select the following checkbox:
○ Employee Export
13. Choose Done. You will now revert to the Permission Role Detail page.
14. Scroll down to section 3. Grant this role to... and select Add....
15. On the Grant this role to... page select Grant this role to: Permission Group and select SAP BestPractices
SFAPI User Group. For the target population, select Everyone.
16. Choose Done.
17. Choose Save Changes to update the role.
18. Log out and log on again as admin user to refresh the assigned role-based permissions.
Getting Started Guide: SAP Best Practices for SAP SuccessFactors EC Integration with SAP
ERP HCM Payroll
Implementation PUBLIC 15
5. Choose Add.
6. In the upcoming window, enter the following settings:
IP address restrictions If you need to restrict IP addresses, consult the Regions page.
Administrator Permissions
8. Choose Done.
9. Choose Save Changes.
Getting Started Guide: SAP Best Practices for SAP SuccessFactors EC Integration with SAP
ERP HCM Payroll
16 PUBLIC Implementation
5.2 Set up Replication Target System
External Code <Logical system of the Employee Central Payroll system> for example: <ERP
SID>CLNT<CLNTID>
6. Choose Save.
Note
If the Replication Target System node is not available under Admin Center → Manage Data, enabling Payroll
Integration is necessary under Provisioning Access. Refer to SAP Note 2246342 for further details.
Getting Started Guide: SAP Best Practices for SAP SuccessFactors EC Integration with SAP
ERP HCM Payroll
Implementation PUBLIC 17
6 Permission Roles
SAP Best Practices SFAPI API Login Permission Permission for API access for Employee Central
User Role
Getting Started Guide: SAP Best Practices for SAP SuccessFactors EC Integration with SAP
ERP HCM Payroll
18 PUBLIC Permission Roles
Important Disclaimers and Legal Information
Hyperlinks
Some links are classified by an icon and/or a mouseover text. These links provide additional information.
About the icons:
● Links with the icon : You are entering a Web site that is not hosted by SAP. By using such links, you agree (unless expressly stated otherwise in your
agreements with SAP) to this:
● The content of the linked-to site is not SAP documentation. You may not infer any product claims against SAP based on this information.
● SAP does not agree or disagree with the content on the linked-to site, nor does SAP warrant the availability and correctness. SAP shall not be liable for any
damages caused by the use of such content unless damages have been caused by SAP's gross negligence or willful misconduct.
● Links with the icon : You are leaving the documentation for that particular SAP product or service and are entering a SAP-hosted Web site. By using such
links, you agree that (unless expressly stated otherwise in your agreements with SAP) you may not infer any product claims against SAP based on this
information.
Example Code
Any software coding and/or code snippets are examples. They are not for productive use. The example code is only intended to better explain and visualize the syntax
and phrasing rules. SAP does not warrant the correctness and completeness of the example code. SAP shall not be liable for errors or damages caused by the use of
example code unless damages have been caused by SAP's gross negligence or willful misconduct.
Bias-Free Language
SAP supports a culture of diversity and inclusion. Whenever possible, we use unbiased language in our documentation to refer to people of all cultures, ethnicities,
genders, and abilities.
Getting Started Guide: SAP Best Practices for SAP SuccessFactors EC Integration with SAP
ERP HCM Payroll
Important Disclaimers and Legal Information PUBLIC 19
www.sap.com/contactsap
SAP and other SAP products and services mentioned herein as well as
their respective logos are trademarks or registered trademarks of SAP
SE (or an SAP affiliate company) in Germany and other countries. All
other product and service names mentioned are the trademarks of their
respective companies.