SAP SuccessFactors
SAP SuccessFactors HCM Suite is SAP's SaaS human resources solution. It offers a variety of applications from Core HR applications like Employee Central or Employee Central Payroll, as well as Talent Management covering for example the Recruiting and Onboarding. You can integrate SAP SuccessFactors with your on-premise system, either via SAP Cloud Platform Integration, via SAP PI, or file download/upload.
Integration Scenario
Please, provide a valid admin page (see the wiki for details)
Enter the preview mode to see the content - a reminder that the admin page should be activated separately.
For SAP SuccessFactors the following integration scenarios are possible:
The different scenarios contain the following exceptions and point-to-point connections:
- Integrating SAP ERP with the SAP SuccessFactors Network mediated via SAP Integration Suite - Cloud Integration: 1, 3, 5, 7
- Integrating SAP ERP with the SAP SuccessFactors mediated via SAP Process Integration: 1, 2, 3, 4, 6, 7
being relevant when monitoring the following SAP ERP replications:
A) Cost Center replication from Employee Central to SAP ERP HCM
B) Organizational Objects replication from Employee Central to SAP ERP HCM
C) Employee Master Data and Organizational Assignments replication from Employee Central to SAP ERP HCM
D) SAP ERP HCM and Employee Central Side-By-Side integration
| Replication | Scenario Component | Monitored Content | Monitoring Category | |
|---|---|---|---|---|
| 1 | A, B, C, D | Systems: ABAP on-premise system | Logs written in the ABAP Application Log for the BIB integration | ABAP Application Log |
| 2 | A | Systems: ABAP on-premise system | IDocs | IDoc |
| 3 | B, C, D | Systems: ABAP on-premise system | Web Service errors and performance | Web Service Messages (ABAP), Web Service (Performance) |
| 4 | A | Systems: ABAP on-premise system | Messages in the ABAP proxy framework | ABAP: PI Messages |
| 5 | A, B, C | Cloud Services: SAP Integration Suite - Cloud Integration | Integration flows (IFlow) in SAP Integration Suite - Cloud Integration | SAP Integration Suite |
| 6 | A, B, C | Systems: SAP PI on-premise system | PI Messages | ABAP: PI Messages Java: PI Communication Channels, PI Messages |
| 7 | B, C, D | Cloud Services: SAP SuccessFactors | Errors that occur in the SAP SuccessFactors Cloud service (Data Replication Monitor and Event Management). | SAP SuccessFactors Data Replication Monitor, SAP SuccessFactors Middleware Integration, SAP SuccessFactors Scheduled Jobs, SAP SuccessFactors Integration Center, SAP SuccessFactors Smart Suite |
When you set up the exception collection and monitoring you first need to know or identify which Web Service end-points and PI or CPI messages flows are relevant for your scenario. You can find this information here:
- https://help.sap.com/viewer/product/SAP_SUCCESSFACTORS_EMPLOYEE_CENTRAL_INTEGRATION_TO_SAP_BUSINESS_SUITE → Integration with SAP ERP or Integration with SAP S/4HANA On Premise → Select the guide for your integration scenario.
SAP SuccessFactors Scenarios covered by Focused Run
The following SAP SuccessFactors scenarios are currently covered:
- Employee Central
- Talent Management
Technical Prerequisites
The integration between SAP SuccessFactors and the on-premise SAP HCM system is usually done using the Business Integration Builder (BIB).
Note: In the past, the integration was done using the SFIHCM add-on which had it's own error log stores in the ABAP system. This integration and hence these log stores are not relevant anymore for the integration with the current SAP SuccessFactors version.
Configure Cloud Service
Please, provide a valid admin page (see the wiki for details)
Enter the preview mode to see the content - a reminder that the admin page should be activated separately.
Preparations in SAP SuccessFactors
Creating a User for SuccessFactors Monitoring
The following steps describe how to create a user that can access the Execution Manager to collect exceptions from SuccessFactors.
- Enable SFAPI: In order to use the SFAPI, SuccessFactors must enable the API for your company instance. Please contact your SuccessFactors support representative to enable the SFAPI for your instance.
- Create a new user for the SFAPI in SuccessFactors.
- Assign API Login Permissions: Each user of the API must have API Login Permission. Setting this permission depends on which permission system you are using in your SuccessFactors instance.
- Traditional (aka User-Based) Permission System: Admin Tools → Manage Users → Manage API Login Permission
- Role-Based Permission System: Follow steps below
- Role-based Permission System:
- Access Admin Center → Manage Permission Role
- Create a new permission role, e.g. SFAPI_EM
- Make sure the following permissions are assigned to this role:
- General User Permission:
- User Login
- SFAPI User Login
- Admin Center Permissions
- Read Execution Manager Events
- Read Execution Manager Event Payload
- Manage Integration Tools
- Allow Admin to Access OData API through Basic Authentication
- General User Permission:
- Grant this role to the SFAPI user you created before
- Add an exception for this user under Admin Center → Password and Login Policy Settings → Set API Login Exceptions
- Set the parameter 'Maximum password age(days)' = -1 for the user
For more information refer to SAP note 2161909 - How to enable SFAPI in SuccessFactors
Please, provide a valid admin page (see the wiki for details)
Enter the preview mode to see the content - a reminder that the admin page should be activated separately.
Input Values for SAP SuccessFactors
- Company ID: Your Company ID
- API Server Root URL: Enter the Production System API URL for your datacenter. You can find the URL in SAP note 2215682 - Successfactors API URLs for different Data Centers
- Description: (optional)
Please, provide a valid admin page (see the wiki for details)
Enter the preview mode to see the content - a reminder that the admin page should be activated separately.
Input Values for SAP SuccessFactors
- Type: BASICAUTH
- User: The user created for SFAPI
- Password:Password of the user
Advanced Integration Monitoring Setup
Please, provide a valid admin page (see the wiki for details)
Enter the preview mode to see the content - a reminder that the admin page should be activated separately.
Available Monitoring Categories
For SAP SuccessFactors different monitoring categories are available.
- SuccessFactors Data Replication Monitor: Collects exceptions from the Data Replication Monitor. This category is configured on the SuccessFactors cloud service.
- SuccessFactors Middleware Integration: Collects exceptions from the Execution Manager for middleware integrations via the OData API. This category is configured on the SuccessFactors cloud service.
- SuccessFactors Scheduled Job: Collects job exceptions from the Execution Management. This category is configured on the SuccessFactors cloud service.
- SuccessFactors Integration Center: Collects exceptions from the Execution Management for direct integrations executed via the Integration Center. This category is configured on the SuccessFactors cloud service.
- SuccessFactors Smart Suite: Collects exceptions from the Execution Management for Smart Suite exceptions. This category is configured on the SuccessFactors cloud service.
For monitoring of errors and warning happening during the integration on the on-premise side, please use:
- ABAP Application Log on the ABAP on-premise system.
The following monitoring categories are deprecated and should only be used as long as you still use the SFIHCM integration add-on in your on-premise system. Please note, even if you don't use the add-on anymore, they might still show up for your SAP HCM system in AIM if you used the SFIHCM add-on in the past and it is still installed on the SAP HCM system:
- HCM Employee Errors
- HCM Compensation Errors
- HCM OnBoarding Errors
- HCM Recruiting Errors
- HCM Variable Pay Errors
Please, provide a valid admin page (see the wiki for details)
Enter the preview mode to see the content - a reminder that the admin page should be activated separately.
Available Filter Options
SuccessFactors Integration using BIB writes errors in the ABAP Application Log. Hence you have to select at least the Object and the Subobject. Use the monitoring category 'ABAP Application Log' on the on-premise system. Please use the following filter parameters to collect the correct application logs:
| Replication Area | Object | Sub-Object |
|---|---|---|
| Combined employee master data and organizational assignments replication from Employee Central to SAP ERP HCM | ECPAO_IN |
|
| Employee master data replication from Employee Central to SAP ERP HCM | PAOC_SFI_PA |
|
| Organizational data or organizational objects replication from Employee Central to SAP ERP HCM and S/4HANA | PAOC_SFI_OM |
|
| Employee time data replication from Employee Central to SAP ERP HCM | PAOC_SFI_PA |
|
| Replication of employee data from SAP ERP HCM to Employee Central in a Side-by-side scenario (SAP ERP HCM and EC are used both simultaneously) | ECPAO |
|
For the categories collected from the SAP SuccessFactors cloud service, you can collect all exceptions or filter them using the following parameters:
SuccessFactors Data Replication Monitor
- ReplicationContent Type: Content type (e.g. 'Employee Absence Data')
- Replication Target System: Target System (e.g. SAP HCM system)
SuccessFactors Middleware Integration
- Event Description: Description of the error event
- Event Name: Name of the event
- Module Name: Name of SuccessFactors Module
- Process Name: The name of the process to be monitored (must be part of the selected log store/process type)
- User ID: The user running the process
SuccessFactors Scheduled Jobs
- Event Description: Description of the error event
- Event Name: Name of the event
- Module Name: Name of SuccessFactors Module
- Process Name: The name of the process to be monitored (must be part of the selected log store/process type)
- User ID: The user running the process
SuccessFactors Integration Center
- Event Description: Description of the error event
- Event Name: Name of the event
- Module Name: Name of SuccessFactors Module
- Process Name: The name of the process to be monitored (must be part of the selected log store/process type)
- User ID: The user running the process
SuccessFactors Smart Suite
- Event Description: Description of the error event
- Event Name: Name of the event
- Module Name: Name of SuccessFactors Module
- Process Name: The name of the process to be monitored (must be part of the selected log store/process type)
- User ID: The user running the process
Please, provide a valid admin page (see the wiki for details)
Enter the preview mode to see the content - a reminder that the admin page should be activated separately.
Available Metrics
For SAP SuccessFactors the following metrics are available:
SuccessFactors Data Replication Monitor
- SuccessFactors Data Replication Monitor exceptions: Indicates that new exceptions were collected during the last data collection interval
SuccessFactors Middleware Integration
- SuccessFactors Integration exceptions: Indicates that new exceptions were collected during the last data collection interval
SuccessFactors Scheduled Job
- SuccessFactors Scheduled Jobs exceptions: Indicates that new exceptions were collected during the last data collection interval
SuccessFactors Integration Center
- SuccessFactors Simple Integration exceptions: Indicates that new exceptions were collected during the last data collection interval
SuccessFactors Smart Suite
- SuccessFactors Smart Suite exceptions: Indicates that new exceptions were collected during the last data collection interval
Error for the replication on the on-premise systems can be collected with the metric 'ABAP Application Log exceptions' for the category ABAP Application Log.