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
    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
  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. Adjust the Root URL: Enter the Production System API URL for your datacenter
    1. You can find the URL in SAP note 2215682 - Successfactors API URLs for different Data Centers
  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
  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
  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 datacenter
    1. You can find the URL in SAP note 2215682 - Successfactors API URLs for different Data Centers
  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
  9. Click "Save".

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

Symptom: The endpoint check fails with the error "Server returned unexpected status code: HTTP/1.1 401 Unauthorized" despite entering the correct password. You can log on to SAP SuccessFactors with this user and password. You are also using an IAS (Identity Authentication Service) for the authentication.

Reason: The SAP SuccessFactors API URL doesn't use the IAS for authentication. Instead, whatever password is set for the user in SAP SuccessFactors itself is the one the API URL expects. You can verify this the following way:

  1. Try to log on to the OData endpoint for the API URL for your data center, e.g. https://apisalesdemo8.successfactors.com/odata/v2
  2. Enter the username@<Company ID> and password you want to use
  3. You get the error: "[LGN0015]Authentication failed. You have entered an incorrect username or password (status code = 4)."

Solution:

You have to make sure that the correct password is set in the SAP SuccessFactors Admin Center > Tools > Reset User Passwords 

  1. Log on to SAP SuccessFactors
  2. Go to Admin Center > Tools > Reset User Passwords
  3. Find the SFAPI user you want to use
  4. Reset the password to the password you want to use
  5. Click "Reset User Password"
  6. Try again to log on to the API URL
  7. You should now get an XML file as response