Contact Us

Setup for SAP SuccessFactors

This page explains how to connect SAP SuccessFactors tenants to SAP Cloud ALM.

Currently the following monitoring application are supported for SAP SuccessFactors:

Setup Videos

The following videos demonstrate the setup steps to set up Integration & Exception Monitoring for SAP SuccessFactors.

A textual step by step description for all setup steps is provided in the sections below the videos.

 

Set Up Integration & Exception Monitoring for SAP SuccessFactors

  • Prerequisites for this video:

Set Up Business Process Monitoring for SAP SuccessFactors

  • Prerequisites for this video:
    • Create an SFAPI user in SAP SuccessFactors as described under SAP SuccessFactors SFAPI User
    • You need a user with the role "Business Process Monitoring Administrator" in SAP Cloud ALM

Prerequisites

Technical Prerequisites

  • You need to obtain the SAP Cloud ALM Service Key to connect to the SAP Cloud ALM system
  • Enable SFAPI usage
    • In order to use the SFAPI, SAP SuccessFactors must enable the API for your company instance. This is usually done during the initial implementation. If this was not done, please contact your SAP SuccessFactors support representative to enable the SFAPI for your instance.

Required Authorizations

  1. Your personal user needs the permission Manage Integration Tools > Access to Integration Service Registration Center UI
  2. Create a new user for the SFAPI in SAP SuccessFactors assign the settings and authorizations listed under SAP SuccessFactors SFAPI User

Setup Steps in SAP SuccessFactors

Enable Monitoring Data PUSH to SAP Cloud ALM

This step is only needed if you use integrations for which we can collect messages.

You find supported scenarios in the table Available Monitoring Content on the Integration & Exception Monitoring page for SAP SuccessFactors.

  1. Go to "Admin Center"
  2. In the "Tools Search", search for Integration Service Registration Center
  3. In the following screen select "SAP Cloud ALM"
  4. Enter the following values:
    1. System Type: Enter the role of the SAP SuccessFactors system as DEV, TEST or PROD (you must use these specific values instead of other free form role types).
    2. Description: Enter a description, e.g. "SAP SuccessFactors tenant XXX"
    3. Endpoint: SAP Cloud ALM service key parameter "Api" without /api
    4. OAuth URL: SAP Cloud ALM service key parameter "url" + /oauth/token
    5. Client ID: SAP Cloud ALM service key parameter "clientid"
    6. Client Secret: SAP Cloud ALM service key parameter "clientsecret"
  5. Click "Register"
  6. 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, if it doesn't already exist.

Create HTTP Endpoint

Endpoint for Exception Monitoring

The endpoint only needs to be created to support the PULL data collection of exceptions.

Please note: Currently, the PUSH monitoring setup creates an additional cloud service in Landscape Management. If you activated the PUSH data collection in the previous step, you should create the endpoint for this cloud service. If you didn't activate the PUSH data collection please create the endpoint for the SAP SuccessFactors HXM Suite tenant that was synchronized automatically from SAP.

  1. Open the Landscape Management application from the launchpad
  2. Select your SAP SuccessFactors service (Service type "SAP SuccessFactors HXM Suite")
  3. Check the value for the field "System ID" in the properties (e.g. DC33STD or DC57PREV)
  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. Adjust the Root URL: Enter the Production System API URL for your data center
    1. You can find the URL in SAP note 2215682 - SuccessFactors API URLs for different Data Centers. Please check the link under "See also" if your data center is not listed.
    2. If the "System ID" value ended with STD, use the URL for the Production environment. 
    3. If the "System ID" value ended with PREV, use the URL for the Preview environment
  8. Choose "Basic Authentication" and enter:
    • User: <user>@<companyID> with the user created in SAP SuccessFactors for the SFAPI integration.
    • Password: The password for the user
    • For more information see SAP Note 2613670 OData Reference Guide
  9. Click "Save".

Endpoint for Business Process Monitoring

After the creation of the end-point the data collection will be scheduled automatically.

  1. Open the Landscape Management application from the launchpad
  2. Select your SAP SuccessFactors service (Service type "SAP SuccessFactors HXM Suite")
  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 "Business Process Monitoring"
  7. Adjust the Root URL: Enter the Production System API URL for your data center
    1. You can find the URL in SAP note 2215682 - SuccessFactors API URLs for different Data Centers. Please check the link under "See also" if your data center is not listed.
    2. If the "System ID" value ended with STD, use the URL for the Production environment. 
    3. If the "System ID" value ended with PREV, use the URL for the Preview environment
  8. Choose "Basic Authentication" and enter:
    • User: <user>@<companyID> with the user created in SAP SuccessFactors for the SFAPI integration.
    • Password: The password for the user
    • For more information see SAP Note 2613670 OData Reference Guide
  9. Click "Save".
  10. After the successful activation, the data collection will start, and the SAP SuccessFactors tenant will appear in the Configuration pane in the Business Process Monitoring application. 

Next Steps

After creating the endpoint in SAP Cloud ALM, you have to perform the following steps to activate the monitoring use-cases:

  • Integration & Exception Monitoring: The data collection for SAP SuccessFactors messages is activated automatically, but you still have to Activate Monitoring Data Collection for SAP SuccessFactors exceptions
  • Business Process Monitoring: Data collection is activated automatically

Troubleshooting & Customer Support

To troubleshoot any issues with the setup or the data collection for SAP SuccessFactors, please follow the Troubleshooting for SAP SuccessFactors page

Should this information not suffice to address your problem please open an incident.