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
Unlike the classic point-to-point interfaces like e.g. IDocs, Web Services or RFCs, when talking about monitoring for cloud services, you always also have to consider the integration component of the scenario. For most cloud services, Advanced Integration Monitoring for the cloud service itself concentrates on monitoring exceptions happening in the cloud service. But to fully monitor a cloud service scenario it is also important to monitor the integration between the cloud service and the on-premise backend system. This integration consists of different point-to-point interfaces of different types.
The following section describes the different integration options for the cloud service. Please choose the integration option you are using and consider also setting up the monitoring for the relevant interface types that are part of the integration scenario for the cloud service.
On this page we describe the monitoring categories that are available for this specific cloud service type. For information on how to set up the monitoring categories for the other technical system and cloud service types, please refer to the setup documentation of the respective interface type.
After setting up the monitoring for the single components and interface types, you can use the scenario configuration to group all relevant messages and exceptions of the cloud integration scenario in one Advanced Integration Monitoring scenario. Information how to create scenarios can be found here.
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 CPI: 1, 3, 5, 7
- Integrating SAP ERP with the SAP SuccessFactors mediated via SAP PI: 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 Cloud Platform Integration | Integration flows (iFlow) in SAP CPI | SAP Cloud Platform Integration |
| 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). | SuccessFactors Data Replication Monitor, SuccessFactors Integration, SuccessFactors Scheduled Jobs, SuccessFactors Simple Integration |
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
Public cloud service offerings are usually Software-as-a-Service (SaaS) solutions. This means that customers only have access to the service but not to the underlying infrastructure. Hence, the usual way to connect on-premise managed systems to Focused Run does not apply to cloud services.
However, to be able to monitor exceptions and performance in cloud services they need to be connected to Focused Run. This connection is created using the customer and cloud service specific root URL and an end-point definition, which allows Focused Run to receive information from the cloud service.
The first step is to import the SSL certificate into Focused Run. This is valid for all cloud services.
Import Cloud SSL certificate into STRUST
Export Certificate from Browser:
- Open the cloud service URL in your web browser.
- Click on the padlock next to the Cloud Service URL (within the address input field).
- When using Firefox, click on ‘Show Connection details', ‘More Information', 'View Certificate' and select the ‘Details' tab.
- When using Microsoft IExplorer, click on ‘View Certificate' and select the 'Certificate Path' tab.
- When using Google Chrome, click on ‘Certificate' and select the 'Certificate Path' tab.
- In the displayed certificate hierarchy select the Certification Authority (CA) certificate you plan to trust.
- When using Firefox, press ‘Export…'.
- When using Microsoft IExplorer or Google Chrome, press ‘View Certificate' and in the displayed pop-up navigate to the ‘Details' tab, to press ‘Copy to File…'.
- Select an export format you would like to use and that is supported by STRUST transaction, and export the certificate.
Import Certificate into Focused Run:
- Now, log on to Focused Run and go to transaction STRUST.
- Switch to Edit.
- Double click on entry 'SSL client SSL Client (Anonymous)'.
- Import the previously exported CA certificate, by pressing – within section ‘Certificate' – the icon ‘Import Certificate'.
- Press ‘Add to Certificate List'.
- Finally ‘Save' this modification.
For a successful SSL handshake, please make sure the following parameter are set in the SAP Focused Run system:
- icm/HTTPS/client_sni_enabled = TRUE
- ssl/client_sni_enabled = TRUE
Additionally you have to perform certain preparations in the cloud service to enable Focused Run to connect to the cloud service.
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
After gathering all necessary information and creating the necessary connection point or users in the cloud service, you can now create the cloud service in Focused Run.
- Call transaction FRUN
- Select 'Advanced Integration Monitoring' → Cloud Service Management
- Click the 'Add' button
- Select the Cloud Service Type.
- The other input fields in the section 'Definition' depend on the cloud service type, see the details below
- In the section 'Identification' you have to enter the following:
- Customer Network: the isolated network for which this cloud service should be visible
- Extended Service ID: the extended SID uniquely identifies the cloud service in LMDB and can be between 3 and 8 characters long
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)
The second step is to create the end-point for the cloud service. The end-point is used to actually connect to the cloud service with user and password. Most cloud services use HTTP end-points.
- Click on the extended service ID of the cloud service
- Click the 'Add' button on the 'HTTP ENDPOINTS' tab.
- Enter the following information:
- Section 'Global':
- Description: A meaningful description
- Section 'Authentication':
- The information needed here depends on the cloud service type, please refer to the details below
- Section 'Proxy':
- If necessary add proxy information to connect to the cloud service
- Section 'Global':
Input Values for SAP SuccessFactors
- Type: BASICAUTH
- User: The user created for SFAPI
- Password:Password of the user
Advanced Integration Monitoring Setup
To be able to monitor interfaces of a cloud service you first have to add it to Interface & Cloud Monitoring and select the monitoring categories you want to monitor for the system.
- Open the Advanced Integration Monitoring Application by clicking on the 'Integration & Cloud Monitoring' tile in transaction FRUN
- Click on the pinwheel in the upper right corner of the 'Integration & Cloud Monitoring' application
- In the configuration panel expand the 'Cloud Services' tray and click on the pen icon in the upper right corner. This will open the 'Configuration for Cloud Services' view.
- If your system is not on the list yet, click the 'Add' button to add it. If it is on the list, click on the system ID of the system.
In the next step, you see all monitoring categories which are available for the system, depending on the system type and the installed software components. Some recommended standard monitoring categories are preselected.
Select the monitoring categories in scope.
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
After selecting your monitoring categories you have to maintain filters to define what exactly you want to monitor. Some monitoring categories come with standard filters that usually just select all items of this monitoring category. SAP Focused Run can handle this high amount of monitoring data, so you can stick to this standard filters. Or you can set up filters of your own.
Please note that the filters you set in the 'Monitoring' step filter the data which is collected from the managed system or cloud service. You can also set up filters later in the 'Alerting' step, which will filter the data already in Focused Run.
You can create more than one filter for a monitoring category.
- Select the view 'Monitoring'
- To add a new filter click the '+' button on the upper right corner of the table
- Select the Category for the filter. The drop down list will contain all activated categories for the system
- Enter a filter name
- Select the target client for the ABAP system / the end-point for the cloud services
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/4 HANA | 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
The setup of the filters for the monitoring categories only makes sure that the data is collected, however, alerts are not created automatically. To create alerts and notifications you have to create an alert individually.
- Go the the view 'Alerting'
- Click on the '+' button in the upper right corner of the alerts table. A new panel will appear below the table for you to enter the alert information
- Select the monitoring category
- Select the metric name. The available metrics depend on the monitoring category.
- Enter a name for the alert
In the next sub-step, you have to maintain the filter. For most monitoring categories the available filter fields will be the same as for the 'Monitoring' configuration described above.
For some metrics, you have additional filter fields or you have to maintain metric parameters. You can check the collected data in Focused Run to determine which filter values to use for alerting. Most of the fields can be found in the Collection Context of the collected data.
Please note that the filters on 'Alerting' level filter the data that is already available in Focused Run. They do not influence the data collection itself. You can only filter for data that is collected. Be aware of this if you created strict filters in the 'Monitoring' step.
- Enter a name for the filter
- Maintain the necessary filter fields
In the last sub-step you have to activate the alert:
- Check the check box next to 'Active'
- You can adjust the calculation frequency and the severity
- Available threshold types depend on the metric selected. If the threshold type allows it you can adjust the threshold value which triggers the alert.
- Select the notification variant and the outbound connector variant from the drop-down list.
For single exceptions, the threshold type is always 'Already Rated'. This means depending on the calculation frequency the number of exceptions is checked and an alert is created if this number is bigger than 0. If you want to reduce the number of alert for these metrics, you could increase the value for the calculation frequency to increase the time between checks.
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.