SAP SuccessFactors watchlist management integration with Incydr

Overview

The SAP SuccessFactors integration automates Incydr watchlist management based on employee data in SuccessFactors. Specifically, the integration:

• Automatically adds users to Incydr's Departing Employee watchlist based on their departure date in SuccessFactors.
• (Optional) Automatically adds users to Incydr's New Hire watchlist based on their hire date in SuccessFactors.

Considerations

• Employee records are matched between SAP SuccessFactors and Incydr by email address. Only users who already exist in Incydr can be added to watchlists; the integration does not create new Incydr users.
• While SAP SuccessFactors supports multiple email types, only the Business email type is used for matching. Users with only Personal, Other, or non-Business email types in their contact information will not be added to watchlists.

Step 1: SuccessFactors configuration

1. Sign in to your SAP SuccessFactors account as a user with administrator access.
2. Go to Admin Center > API Center > OAuth Configuration for OData.
3. Click Register Client Application and complete the required fields. See SuccessFactors documentation for more details.
4. Click Register, 
5. Note the API Base URL, Company ID, User ID, Client ID, and X.509 Private Key and save them in a secure location for future reference.
   These SuccessFactors credentials are required to complete the integration setup in the Mimecast administration console.

Step 2: Incydr API client configuration

Create a new Incydr API client:

1. Sign in to the Incydr console.
2. Go to Administration > Integrations > API Clients.
3. Select Create new API client.
4. Enter a name specific to this flow (for example, "SuccessFactors watchlist integration").
5. Add these permissions:
   • Detection lists - Read and Write
6. Click Save.
7. Note the Client ID, Secret, and Base URL and save them in a secure location for future reference.
   The Incydr API client credentials are required to complete the integration setup in the Mimecast administration console in the next section.

Step 3: Mimecast configuration

Required credentials
Before beginning this section, ensure you have all credentials from the SuccessFactors and Incydr sections above. You cannot save the MImecast configuration below until all values are provided.

1. Sign in to the Mimecast Administration Console.
2. Go to Integrations > Integration Hub.
3. Scroll to the SAP SuccessFactors Watchlist Management tile and click Configure New.
4. In the Details section:
   • Enter a name and description to uniquely identify this instance of the integration. For example: "Incydr watchlists." (Note that the name cannot be changed later.)
   • Set the Schedule Interval in minutes (minimum: 3, maximum: 1440). This determines how frequently the integration syncs data between SAP SuccessFactors and Incydr.
5. In the SAP SuccessFactors Authentication section:
   • Enter the API Base URL, Company ID, User ID, Client ID, and X.509 private key obtained in the SuccessFactors configuration section above.
6. In the Incydr Authentication section:
   • Enter the Base URL, Client ID, and Secret obtained in the Incydr API client configuration section above.
7. In the Departing Employee Watchlist section, set the Departure Date in Next (Days) value (minimum: 1, maximum: 365). Employees whose departure date falls within this window are added to the Incydr departing employee watchlist on each scheduled run.
8. In the New Hire Watchlist section:
   • Enable Monitor New Hires if you want to monitor newly hired employees. 
   • If enabled, set the Hire Date in Last (Days) value (minimum: 1, maximum: 365). Employees hired within this window are added to the Incydr new hire watchlist on each scheduled run.
9. In the Notification Settings section, add up to 5 email addresses to receive alerts if the integration enters a permanent error state (for example, if API credentials expire or become invalid). Distribution lists are supported. Recipients are also be notified if an employee's email address cannot be matched to an existing Incydr user.
10. Review all configuration sections, then click Save to activate the integration.

Related topics

• Incydr API clients
• Watchlists reference
• SuccessFactors: Registering New Client Application in SAP SuccessFactors Recruiting