Success Factors

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.

Technical Prerequisites

The following technical prerequisites have to be met in order to monitor this scenario:

  • To collect single exceptions in the SAP HCM Integration Add-On for Employee, Compensation, Recruiting, OnBoarding & Variable Pay you need at least SAP Solution Manager 7.1 SP14.
  • To create alerts via Web Service Monitoring you need at least SAP Solution Manager 7.1 SP05.
  • To monitor exceptions from the SAP SuccessFactors Data Replication Monitor or Execution Management you need at least SAP Solution Manager 7.2 SP06.

Import Cloud Service SSL Certificate

In the context of Hybrid Scenarios, data collectors are connecting from Solution Manager to the Cloud Service provider, in order to collect exceptions and/or statistical data. To allow this outgoing connection from Solution Manager, the SSL Certificate of the Cloud Service provider has to be imported in Trust Manager (STRUST).

  1. Open the cloud service URL in a browser
  2. Click 'View' → 'Security Report' or click the padlock next to the URL in the address input field
  3. Click 'View certificates'
  4. Switch to the 'Details' tab and click 'Copy to File...'
  5. Export the certificate in 'Base-64 encoded X.509 (.CER)' format
  6. Log on to SAP Solution Manager and go to transaction STRUST
  7. Import the certificate to 'SSL client SSL Client (Anonymous)'

Available Monitoring Content

The following SuccessFactors scenarios are currently support with SAP Solution Manager public cloud operations:

  • Employee Central
  • Talent Management 

To monitor the entire SAP SuccessFactors scenario you need to monitor the on premise SAP SuccessFactors Integration add-on as well as the integration solution. The SAP SuccessFactors Integration add-on writes error messages to the application log.  

SAP SuccessFactors integrates with on premise systems via different technologies. Depending on which one you use for your scenario you have to also monitor the integration solution to ensure end-to-end monitoring coverage for the cloud scenario.

Here some integration scenarios examples and monitoring content:

  • Integrating SAP ERP with the SAP SuccessFactors Network mediated via SAP CPI: 1, 3, 5, 8
  • Integrating SAP ERP with the SAP SuccessFactors mediated via SAP PI (Web Service based): 1, 3, 6, 8
  • Integrating SAP ERP with the SAP SuccessFactors Network mediated via file download/uploade (FTP/SFTP server) : 2, 4, (6), 7, 8

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 Scenario Component Monitoring Object Description Monitoring Template Since SP
 1  A, B, C, D On premise Exceptions in SuccessFactors Integration Add-on Errors that are written to the Application Log in the SFIHCM Integration Add-on are collected and written to the central exception store in SAP Solution Manager. HCM <SF Scenario> Error Log (ExMan) 7.1 SP14*
 2 A On premise IDoc  IDocs sent and received by the on-premise system IDoc (Real-time Monitoring)  7.1 SP12
 3 B, C, D On premise  Web Service  Web Services exposed on the ABAP on-premise system used by the SF scenario. This template is also used to monitor the number of application log errors for the integration add-in. Web Services ABAP 7.1 SP05*
 4  A On premise ABAP Proxy Messages in error status in the ABAP proxy framework

Process Integration (PI - ABAP only)

7.1 SP12
 5  A, B, C Integration Exceptions in SAP CPI  Exceptions in integration flows in SAP Cloud Platform Integration  Cloud (SAP HCI) 7.1 SP12*
 6  A, B, C Integration PI Messages Errors in PI message send via SAP PI.

Process Integration (PI)

7.1 SP12*
 7   A Integration File Download/Upload Monitor files on operating system level to make sure they are created in time and correctly File (Diagnostics Agent) & File (Remote)  7.1 SP10* 
 8 A, B, C, D Cloud Exceptions in SAP SuccessFactors Errors that occur in the SAP SuccessFactors Cloud service (Data Replication Monitor and Event Management) Cloud (Success Factors) 7.1 SP14*

*) Monitoring content was extended with later support packages (see monitoring template page for details) 

When you set up the exception collection and monitoring you first need to know or identify with PI services, files or SAP CPI iFlows are relevant for each scenario. This SAP Help page gives you an overview over the integration content:

 https://help.sap.com/viewer/p/SFIHCM → Integration Add-On for SAP ERP HCM and SuccessFactors HCM Suite:

  • PI: Integration Using Middleware → Integration Content for SAP Process Integration
  • CPI: Integration Using Middleware → Integration Content for SAP HANA Cloud Integration
  • File: Integration Using File Download

The following SAP Help page contains documentation that applies to integration of Employee Central with ERP systems: https://help.sap.com/viewer/p/SAP_SUCCESSFACTORS_EMPLOYEE_CENTRAL_INTEGRATION_TO_SAP_BUSINESS_SUITE

Monitoring Template: Cloud (Success Factors)

Metric Name Description MAI Category Since SP

Number of exceptions (Data Replication Monitor)

Single exceptions (Data Replication Monitor)

 

Number of exceptions detected in SuccessFactors Data Replication Monitor.

Single exceptions detected in SuccessFactors Data Replication Monitor.

Exceptions and statistics are retrieved from central Exception Management in Solution Manager. Data Collection is executed in delta mode.

 

Exceptions

7.2 SP06

Number of exceptions (Integration)

Single exceptions (Integration)

Number of exceptions detected in SuccessFactors for Process Type INTEGRATION.

Single exceptions detected in SuccessFactors for Process Type INTEGRATION.

Exception statistics is retrieved from central Exception Management in Solution Manager. Data Collection is executed in delta mode.

Exceptions

7.1 SP14

Number of exceptions (SF API)

Single exceptions (SF API)

Number of exceptions detected in SuccessFactors for Process Type API.

Single exceptions detected in SuccessFactors for Process Type API.

Exception statistics is retrieved from central Exception Management in Solution Manager. Data Collection is executed in delta mode.

Exceptions Not yet support by SF Execution Manager

Number of exceptions (Scheduled Jobs)

Single exceptions (Scheduled Jobs)

Number of exceptions detected in SuccessFactors for Process Type SCHEDULED_JOBS.

Single exceptions detected in SuccessFactors for Process Type SCHEDULED_JOBS.

Exception statistics is retrieved from central Exception Management in Solution Manager. Data Collection is executed in delta mode.

Exceptions 7.1 SP14 

Number of exceptions (Simple Integration)

Single exceptions (Simple Integration)

Number of exceptions detected in SuccessFactors for Process Type SIMPLE_INTEGRATION.

Single exceptions detected in SuccessFactors for Process Type SIMPLE_INTEGRATION.

Exception statistics is retrieved from central Exception Management in Solution Manager. Data Collection is executed in delta mode.

Exceptions 7.1 SP14 

Number of exceptions (Smart Suite)

Single exceptions (Smart Suite)

Number of exceptions detected in SuccessFactors for Process Type SMART_SUITE.

Single exceptions detected in SuccessFactors for Process Type SMART_SUITE.

Exception statistics is retrieved from central Exception Management in Solution Manager. Data Collection is executed in delta mode.

Exceptions Not yet support by SF Execution Manager

Number of exceptions (Talent Management - Compensation)

Single exceptions (Talent Management - Compensation)

Number of exceptions detected in SAP Human Capital Management (Talent Management - Compensation Error Logs).

Single exceptions detected in SAP Human Capital Management (Talent Management - Compensation Error Logs).

The exceptions are retrieved from HCM via the central Exception Management in Solution Manager. Data Collection is executed in delta mode.

Exceptions 7.1 SP14

Number of exceptions (Talent Management - Employee Data)

Single exceptions (Talent Management - Employee Data)

Number of exceptions detected in SAP Human Capital Management (Talent Management - Employee Data Error Logs).

Single exceptions detected in SAP Human Capital Management (Talent Management - Employee Data Error Logs).

The exceptions are retrieved from HCM via the central Exception Management in Solution Manager. Data Collection is executed in delta mode.

Exceptions 7.1 SP14

Number of exceptions (Talent Management - Onboarding)

Single exceptions (Talent Management - Onboarding)

Number of exceptions detected in SAP Human Capital Management (Talent Management - Onboarding Error Logs).

Single exceptions detected in SAP Human Capital Management (Talent Management - Onboarding Error Logs).

The exceptions are retrieved from HCM via the central Exception Management in Solution Manager. Data Collection is executed in delta mode.

Exceptions 7.1 SP14

Number of exceptions (Talent Management - Recruiting)

Single exceptions (Talent Management - Recruiting)

Number of exceptions detected in SAP Human Capital Management (Talent Management - RecruitingError Logs).

Single exceptions detected in SAP Human Capital Management (Talent Management - Recruiting Error Logs).

The exceptions are retrieved from HCM via the central Exception Management in Solution Manager. Data Collection is executed in delta mode.

Exceptions 7.1 SP14

Number of exceptions (Talent Management - Variable Pay)

Single exceptions (Talent Management - Variable Pay)

Number of exceptions detected in SAP Human Capital Management (Talent Management - Variable Pay Error Logs).

Single exceptions detected in SAP Human Capital Management (Talent Management - Variable Pay Error Logs).

The exceptions are retrieved from HCM via the central Exception Management in Solution Manager. Data Collection is executed in delta mode.

Exceptions 7.1 SP14
Number of exceptions in SuccessFactors BizX (Delta)

Number of exceptions detected in SuccessFactors BizX.

Exception statistics is retrieved from central Exception Management in Solution Manager. Data Collection is executed in delta mode.

The statistics are based on single exceptions which are send from SuccessFactors BizX via eMail to Solution Manager Inbox. They are available afterwards in central Exception Management in Solution Manager.

Exceptions Deprecated
Number of exceptions in SuccessFactors BizX (Last 24h)

Number of exceptions detected in SuccessFactors BizX during the last 24h.

Exception statistics is retrieved from central Exception Management in Solution Manager. Data Collection is executed in delta mode.

The statistics are based on single exceptions which are send from SuccessFactors BizX via eMail to Solution Manager Inbox. They are available afterwards in central Exception Management in Solution Manager.

Exceptions Deprecated

Configuration

Step 1: Define Cloud Service in SAP Solution Manager

You need the following information to create the SAP SuccessFactors cloud service:

  • Company ID
  • User: See information below
  • Password
  • Main URL: The root URL of the API server corresponding to your SAP SuccessFactors account/data center. This URL is different from the SuccessFactors main URL for applications, it is typically something like https://<api-server>.successfactors.com (e.g. https://api10.successfactors.com)

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.

  1. 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.
  2. Create a new user for the SFAPI in SuccessFactors.
  3. 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.
    1. Traditional (aka User-Based) Permission System: Admin Tools → Manage Users → Manage API Login Permission
    2. Role Based Permission System: API Login Permission in the Role Based Permission system is listed under the General User Permission category in the Permission settings page.
  4. For the Exception management scenarios, the API is called Execution Manager. Create a new permission role to be assigned to the SFAPI user (e.g. SFAPI_EM)
  5. 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
      • Admin access to OData API 
  6. Grant this role to the user you created before

The Cloud Services configuration is now accessible from the SAP Solution Manager Configuration (SOLMAN_SETUP) → Managed Systems Configuration → Tab 'Cloud Services'.

Create Cloud Service:

  1. Select 'Cloud Service Operations' → Create Cloud Service
  2. Select Service Type: 'SAP SuccessFactors' from the drop-down list.
  3. Define Service:
    • Company ID: Enter your SAP SuccessFactors <Company ID> and a description
  4. Define Root URL: Enter the <Main URL> as Root URL.
    • You can also adjust the extended service ID (The ID used as SID in LMDB) here.
  5. Confirmation: Check your input values and click 'Finish'

The second step is to create the end-point for the cloud service. For SuccessFactors you can create an HTTP end-point and additionally an SFTP end-point if you have integration using file download. 

Create the End-Points:

  1. Select your SAP SuccessFactors cloud service from the list and click 'Configure Cloud Service' 
  2. Configure Endpoints: Click the 'Add' button on the 'HTTP Endpoints' tab.
  3. Enter the following information:
    • Description: A meaningful description
    • User: <user>
    • Password: <password>
    • If necessary add proxy information to connect to SAP SuccessFactors
  4. To create and SFTP endpoint click the 'Add' button on the 'SFTP Endpoint' tab
  5. Enter the following information: 
    • Description: A meaningful description
    • User: <User>
    • Password: <Password>
    • Protocol: SFTP or FTP
    • Host: hostname of the remote host (FQDN)
    • Port: (S)FTP port of the remote host. The default FTP port is 21, the default SFTP port is 22.
    • Timezone: Select the time zone of the remote host

Configure Exception Management

For SAP SuccessFactors you have to set up two distinct exception log stores, as described below and depending on your integration solution. Typically, if your integration includes the SAP SuccessFactors Integration add-on, installed in the SAP ABAP on premise system, you need to set up one log store that collects the exceptions occurring in this add-on. Additionally you have to set up the exception store for the exceptions occurring in SAP SuccessFactors.

Exceptions in SAP SuccessFactors Integration Add-On 

The SAP SuccessFactors Integration add-on writes single exceptions into error messages in the ABAP Application Log. These application log entries can be collected with the log store for the SAP HCM Integration Add-on.

The log store is set up on the SAP ABAP on premise system on which the add-on is installed.

To access the Exception Management setup please go to transaction SOLMAN_SETUP → Application Operations → Exception Management 

  1. In the step 'Define Scope' select the tab 'Technical Systems' and your SAP ABAP system. Click on 'Configure' or click 'Next' two times. You will enter the step 'Exception Configuration'.
  2. Click 'Add / Configure Log Store' → Standard. Select the relevant log store. The following log stores collect application log errors in the SuccessFactors context:
    • HCM Employee Error Log
    • HCM Compensation Error Log
    • HCM OnBoarding Error Log
    • HCM Recruiting Error Log
    • HCM Variable Pay Error Log
  3. Select the fields for filtering for your log store. The following filter fields are available:
    • MESSAGE_ID: Message Class (e.g. E (Error))
    • MESSAGE_NUMBER: Message Number
    • MESSAGE_TEXT: Localized Message Text
  4. Maintain the filter values for the fields in the Filter Definition panel under the log stores table. You can also add, remove or change filter fields and values later on in the area. You can use different operators for your filter value. You can add more than one filter filed combination per log store. To add an additional filter field combination click on the button 'Add Filter' in the 'Configured Log Stores' panel.
  5. Once you are done with the Log Store setup click 'Next' to go to the alert configuration. The alert configuration is done in the 'Interface and Connection Monitoring' described in the next section.

Exceptions in the Integration Add-In

If you set up the monitoring for the exceptions in the Exception Management and you activate the monitoring here, you will receive an alert (and if set up this way an email) for every single exception in the application log.

It is instead advised to set up the actual monitoring and alerting for the application log entries in the Web Service monitoring within Interface and Connection Monitoring. This will collect the number of occurred errors and create one alert accordingly. You can then use the Exception Management to drill down into the single exceptions.

Exceptions in SuccessFactors

In the second exception store you can collect exceptions directly from SAP SuccessFactors.

To access the Exception Management setup please go to transaction SOLMAN_SETUP → Application Operations → Exception Management 

  1. In the step 'Define Scope' select the tab 'Cloud Services' and your SAP Success Factors cloud service. If you didn't configure the system before make sure to select 'All Cloud Services' in the view drop-down. Click on 'Configure' or click 'Next' two times. You will enter the step 'Exception Configuration'.
  2. Click 'Add / Configure Log Store'. Select the relevant log store. The following log stores are available for SAP SuccessFactors:
    • SF Data Replication Errors
    • SF INTEGRATION
    • SF API (Currently no meaningful errors are written by the SF Execution Manager)
    • SF SCHEDULED_JOB
    • SF SIMPLE_INTEGRATION
    • SF SMART_SUITE (Currently no meaningful errors are written by the SF Execution Manager)
  3. Select the correct end-point for SAP SuccessFactors if you have more than one.
  4. Select the fields for filtering for your log store. Which fields are available depends on the log store:
    • SF Data Replication Errors:
      • replicationContentType: Content Type (e.g. 'Employee Absence Data')
      • replicationTargetSystem: Target System (e.g. SAP HCM system)
      • sourceMessageText: Message Text
    • All others:
      • eventDescription: Description of the error event
      • eventName: Name of the event
      • moduleName: Name of SuccessFactors Module
      • processName: The name of the process to be monitored (must be part of the selected log store/process type)
      • userID: The user running the process 
  5. Maintain the filter values for the fields in the Filter Definition panel under the log stores table. You can also add, remove or change filter fields and values later on in the area. You can use different operators for your filter value. You can add more than one filter filed combination per log store. To add an additional filter field combination click on the button 'Add Filter' in the 'Configured Log Stores' panel.
  6. Once you are done with the Log Store setup click 'Next' to go to the alert configuration. The alert configuration is done in the 'Interface and Connection Monitoring' described in the next section.

Configure Interface and Connection Monitoring

The last step is the configuration of Interface and Connection Monitoring. The Interface and Connection Monitoring setup can be accessed via SAP Solution Manager Configuration (SOLMAN_SETUP). 

To access the Integration Monitoring setup please go to SAP Solution Manager Configuration (SOLMAN_SETUP) → Application Operations → Integration Monitoring → Interface and Connections.

If you didn't perform the infrastructure configuration yet, please follow the Interface and Connection Monitoring Setup

Monitoring Template: Web Services ABAP

This monitoring template is used to monitor the performance and for exceptions happening in the Web Service communication between the SAP Success Factors  Integration add-on in SAP ABAP and SAP Cloud Platform Integration.

For detailed setup information how to set up this channel type please refer to the configuration of Web Service Channels. You can use the template Web Services ABAP (SOAP) or Web Services ABAP (STAD) for the monitoring. Please note if you use the Web Services ABAP (SOAP) template you must activate the Web Service performance monitoring in the ABAP system as per SAP Note 1639329.

Which Web Service proxy/name you need to enter depends on the scenario in the SAP Success Factors integration. Please find your integration scenario here: https://help.sap.com/viewer/p/SAP_SUCCESSFACTORS_EMPLOYEE_CENTRAL_INTEGRATION_TO_SAP_BUSINESS_SUITE:

  1. Select your integration scenario under 'Integration with SAP ERP' or 'Integration with SAP S/4HANA On Premise'
  2. Navigate to 'Setting up the Middleware <...>' → Configuration Steps
  3. Under 'How to find the Endpoint URLs' → 'Finding the URL for Communication from the Middleware to SAP ERP/SAP S/4HANA' you will find the INBOUND web services in the ABAP backend system. Set up this Web Service interface from the Middleware → SAP HCM and make sure the measuring point in the SAP HCM system
  4. Under 'Activating the <SAP HCM> Outbound Web Services to Set Up the Connection from SAP S∕4HANA HR to the Middleware' you will find the WS proxies for the OUTBOUND communication. Set up this Web Service interface from the SAP HCM → Middleware and make sure the measuring point in the SAP HCM system

Make sure to use the input help for the field WS name or WS proxy to fill in the filter values.

Monitoring Template: Cloud (Success Factors)

Navigate to the step 'Define Scope'. You can create a new scenario for the SAP Success Factors monitoring or use an existing one. Make sure the on premise system for the SAP Success Factors scenario and the Cloud Service created for SAP Success Factors are part of the Interface and Connection Monitoring scenario. If you use the integration via SAP CPI this cloud service should be added as well.

Create the Interface Channel:

  1. Select the scenario and click 'Next'
  2. In step 'Preparation' perform all relevant manual activities and run all automatic activities.
  3. In step 'Configuration' click the 'Add' button.
    • Channel Name: Enter a meaning full name (max. 30 characters)
    • Type: Select 'Cloud'
    • Monitoring Template: Select 'Cloud (Success Factors)'
    • Description: Enter a description for the channel
  4. Click Next.
  5. Source type:
    • If the source system is the on premise system, please select 'Technical System'
    • If the source system is the cloud service please select 'External Service'
  6. Source: Select the on premise system resp. the Cloud Service from the drop-down list
  7. Target Type:
    • If the target system is the on premise system, please select 'Technical System'
    • If the target system is the cloud service please select 'External Service'
  8. Target: Select the on premise system resp. the Cloud Service from the drop-down list
  9. The measuring point is selected automatically
  10. If more than one client are connected for the on premise system please select the correct client for the monitoring
  11. Click Next.
  12. Click Finish.

Maintain the Interface:

  1. The interface channel type does not have any configurable parameters.

Select Metrics:

  1. On the tab 'Metrics' select the metrics you want to monitor

  2. Enter Metric Parameters:

    • Number of exceptions / Single Exceptions (Data Replication Monitor):

      • Parameter set name: You can enter a name for the parameter set to distinguish it if you have more than one
      • Replication Content Type: Content Type (e.g. 'Employee Absence Data')
      • Replication Target System: Target System (e.g. SAP HCM system)
      • Source Message Text: Message Text
    • Number of exceptions / Single Exceptions (Integration), Number of exceptions / Single Exceptions (SF API), Number of exceptions / Single Exceptions (Scheduled Jobs), Number of exceptions / Single Exceptions (Simple Integration), Number of exceptions / Single Exceptions (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 
    • Number of exceptions / Single Exceptions (Talent Management - Compensation), Number of exceptions / Single Exceptions (Talent Management - Employee Data), Number of exceptions / Single Exceptions (Talent Management - Onboarding), Number of exceptions / Single Exceptions (Talent Management - Recruiting), Number of exceptions / Single Exceptions (Talent Management - Variable Pay)
      • Message ID: Message Class (e.g. E (Error))
      • Message Number: Message Number
      • Message Text: Localized Message Text
  3. Save your interface channel by clicking on the 'Save' button.

Metrics for Talent Management Application

The metrics for Talent Management Applications are collected based on the exception stores for the HCM Error Logs. These exceptions are collected in the SAP HCM system. Hence the exception stores are set up in the SAP HCM system context.

In ICMon these metrics are implicitly collected from the HCM system, even if the measuring point is set to the SF external service. So the data collector will try to get the information from "the other" partner assuming it is the SAP HCM system. To successfully collect these metrics you must create a direct channel between SAP HCM and SF, even if you are using a middleware.

You can maintain attributes as described in the Interface and Connection Monitoring Setup on tab 'Attributes'.

Thresholds and the collection schedule are maintained in the next step of the guided procedure. Once you have maintained all your channels, click 'Next' in the main guided procedure to move to the step 'Activation'.

Maintain Thresholds and Schedule:

  1. Select the Alert for the SAP Ariba Network channel (the alert is the line with the red flash icon next to it)
    • On alert level you can maintain notification and incident message creation
    • Do not remove the flag for 'Do not Group Individual Occurrences' as this flag ensures that an alert is created for each exception
  2. Select the Metrics
    • You can adjust the thresholds on the tab Thresholds.
    • Do not change the data collector type or data collector name on the tab 'Data Collection' as the monitor will not work anymore if this is changed.
    • Only change the collection interval if you know what you do or if advised to do this by SAP.
  3. Click 'Apply and Activate' → <Choose one option> to activate the monitoring