SAP SuccessFactors

Available Monitoring Content

CategoryTypeDescription
SAP SuccessFactors MessagesMessagesSF messages, currently Bank master and legal entity integration
Integration CenterExceptionsCollects exceptions for integrations in Integration Center from the Execution Management
Scheduled JobsExceptionsCollects job exceptions for jobs within Integration Center from the Execution Management
Middleware IntegrationsExceptionsCollects exceptions for integrations via OData API from the Execution Management

Setup Steps in SAP SuccessFactors

Integration Monitoring for SAP SuccessFactors uses a PUSH as well as a PULL mechanism to collect the data for the different monitoring categories.

PUSH data collection:

  • SAP SuccessFactors Messages

PULL data collection:

  • Integration Center
  • Scheduled Jobs
  • Middleware Integrations

Enable Monitoring Data PUSH to SAP Cloud ALM

To enable SAP SuccessFactors to send monitoring data to SAP Cloud ALM you need to perform the Integration Monitoring Registration.

Prerequisites:

  • To be able to perform this setup, your user needs Access to Integration Monitoring Registration UI permissions.
  • You need to obtain the SAP Cloud ALM Service Key to connect to the SAP Cloud ALM system
    • Endpoint: eu10.alm.cloud.sap
    • OAuth URL: Service Key parameter "url" + /oauth/token, e.g. calm-tenant.authentication.eu10.hana.ondemand.com/oauth/token
    • Client ID: Service key parameter "clientid"
    • Client secret: Service key parameter "clientsecret"
  1. Go to Admin Center
  2. In the Tools Search field, search for "Integration Monitoring Registration"
  3. In the following screen enter the following values:
    1. System Type: Enter Cloud ALM
    2. Description: Enter a description, e.g. "Cloud ALM tenant XXX"
    3. Endpoint: Cloud ALM endpoint URL
    4. OAuth URL: Cloud ALM OAuth URL
    5. Client ID: Cloud ALM client ID
    6. Client Secret: Cloud ALM client secret
  4. Click Register
  5. Click OK

Note: To deactivate your instance, click Deregister.

The registration will create an entry for this SAP SuccessFactors instance in the Landscape Management application of SAP Cloud ALM.

Create a User for SAP SuccessFactors Monitoring

https://launchpad.support.sap.com/#/notes/2161909The following steps describe how to create a user that can access the Execution Manager to collect exceptions from SAP SuccessFactors.

  1. Enable SFAPI: In order to use the SFAPI, SAP SuccessFactors must enable the API for your company instance. Please contact your SAP SuccessFactors support representative to enable the SFAPI for your instance.
  2. Create a new user for the SFAPI in SAP 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.
    • Traditional (aka User-Based) Permission System: Admin Tools → Manage Users → Manage API Login Permission
    • Role-Based Permission System: Follow steps below
  4. Role-based Permission System: 
    1. Access Admin Center → Manage Permission Role
    2. Create a new permission role, e.g. SFAPI_EM
    3. 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
    4. Grant this role to the SFAPI user you created before
  5. Add an exception for this user under Admin Center → Password and Login Policy Settings → Set API Login Exceptions
    1. 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

Setup Steps in SAP Cloud ALM

Create HTTP End-Point

The end-point only needs to be created to support PULL data collection. PUSH data collection is configured in the managed cloud service and available after registration of the cloud service in Landscape Management. You can create the PULL end-point for the same system in Landscape Management, that was created by the PUSH registration.

  1. Open the Landscape Management application from the launchpad
  2. Select your SAP SuccessFactors service
  3. Press the > button at the end of the line
  4. On the tab "Endpoints" press the Add button to create a new end-point
  5. Enter a description
  6. Choose the use-case "Exception Monitoring"
  7. Choose BASIC authentication enter the user and password created in SAP SuccessFactors for the SFAPI integration.

Activate Monitoring (Standard)

In SAP Cloud ALM you can easily activate the standard monitoring content without any additional setup effort. 

  1. Open the Integration Monitoring application from the launchpad
  2. The scope selection will appear automatically
  3. Change the drop-down for Display Service to "All"
  4. Make sure to select your cloud service in the scope
  5. Click the Configuration button in the upper right corner to access the configuration
  6. Expand the Configuration panel
  7. Change the toggle button next to the cloud service from OFF to ON

Adjust Monitoring and Alerting (Expert)

You can change which parts of the standard content are activated for each cloud service, activate and deactivate alerts or create own alerts with specific filters. 

  1. In the configuration panel, click on the name of the cloud service
  2. The "Configuration of Services" screen opens
  3. In the "Configuration for Services" screen, click the > button at the end of the line for the cloud service you want to change

Adjust Monitoring Categories

  1. Use the toggle button in the column Active to turn a monitoring category ON or OFF

Adjust Alerting

  1. Use the toggle button in the column Active to turn a standard alert ON or OFF
  2. Press the > button at the end of the line to access the detail setup for an existing alert or use the + button to create a new alert
  3. Adjust the display name if desired
  4. Expand the Filter Configuration tray
  5. Enter a filter name
  6. Select the filter category
  7. Maintain the available filter fields (see details below)

Available Alerts for SAP SuccessFactors

  • Erroneous Message (SuccessFactors) Detected: Creates an alert for each failed message in SAP SuccessFactors
  • Erroneous Messages (SuccessFactors) Detected: Creates an alert if one or more failed messages on SAP SuccessFactors were detected since the last data collection
  • Erroneous Middleware Integration: Monitors exceptions for integrations with SAP SuccessFactors via third party tools through the OData API
  • Erroneous Scheduled Jobs: Monitors exceptions in jobs scheduled in SAP SuccessFactors Integration Center
  • Erroneous Integration Center: Monitors exceptions in integrations in SAP SuccessFactors Integration Center

Available Filter Fields for SAP SuccessFactors

The filter fields depend on the monitoring category the alert is created for and additional on the filter category, if there is more than one available.

SuccessFactors Messages

  • Direction: Inbound or Outbound
  • Integration Type: Scheduled or Event-based
  • Entity: Entity name
  • Status: Status of the message
  • Status Group: Successful, Warning, Error, In Process, Canceled, Others
  • Destination Entity: Receiver entity
  • Source Entity: Sender entity
Middleware Integration, Scheduled Jobs, Integration Center
  • Event Description: Description of the error event
  • Event Name: Name of the event
  • Event Type: WARNING or FAILED
  • Module Name: Name of SuccessFactors Module
  • Process Name: The name of the process to be monitored (must be part of the selected process type)
  • Process Type: SIMPLE_INTEGRATION, SCHEDULED_JOB, INTEGRATION, HCI_INTEGRATION, PI_INTEGRATION
  • User ID: The user running the process