SAP SuccessFactors Background Check
To successfully send webhook notifications from SAP SuccessFactors, follow these steps in your SAP SuccessFactors account and complete the necessary actions.
This guidance assumes that you have administrative privileges for your SAP SuccessFactors account.
Enable the Other Background Check Vendor option
1
Background Check Central Configuration
Go to the Admin Center and search for Background Check Central
Enable Background Check in Recruiting and Choose 
Other Background Check VendorSelect the type of integration template for the external background check
Recruiters do not need the mandatory permissions to initiate background checks using the Integration Center. However, to use the Integration Center for modeling and executing the integration, you do need the following mandatory permissions:
- Admin access to MDF OData API
- Access to Integration Center
- Access to non-Secured Objects
1
Go to Integration Center
Navigate to Admin Center and search for Integration Center
To view the list of available integrations, click on 
My Integrations.2
Select the Type of Integration Center Template
Click the 
Select the following values from the modal
Use the search box to find the entity called 
+ Create button and select More Integration Types to access the list of available integration types.- Application/UI, for Trigger Type
- SuccessFactors, for Source Type
- REST, for Destination Type
- JSON, for Format
Create buttonJobApplicationBackgroundCheckRequest, and then select it from the search results.Create and configure an integration template for background checks
1
Options Step
Enter the name of the integration, then click the 
Next button to proceed with further configuration steps. You can also click the Save button to save the current step’s configuration.2
Configure Fields Step
Click on the 
Click the 
To set the association for added element. Click on the 
Choose the specific fields to map that can be found in the Entity Tree View.
Select the field and Click on the 
You will notice that the Association has been updated for the data field.
Map the properties of the data fields to their corresponding properties in the OData API.
+ button > Insert Sibling Element, then click on the inserted element to open a prompt where you can enter the name of the element.Please refer the mapping listed here.
+ button > Add Child Element for the added element and then click on the inserted element to open a prompt where you can enter the name of the child element.Set as Associated Field icon.Change Association button.Please follow the mapping below to receive the correct order notification
Please follow the mapping below to receive the correct order notification
| Expected properties of data fields | To | Corresponding properties in the OData API entity |
|---|---|---|
| backgroundCheckInfo/requestId | -> | requestId |
| backgroundCheckInfo/bgiAccountId | -> | jobApplication/jobRequisition/bgiAccountId/id |
| backgroundCheckInfo/packageId | -> | jobApplication/jobRequisition/packageId/id |
| backgroundCheckInfo/packageExternalCode | -> | jobApplication/jobRequisition/packageId/externalCode |
| backgroundCheckInfo/packageLocaleLabel | -> | jobApplication/jobRequisition/packageId/localeLabel |
| createdByUserInfo/userId | -> | createdByUserNav/userId |
| createdByUserInfo/firstName | -> | createdByUserNav/firstName |
| createdByUserInfo/lastName | -> | createdByUserNav/lastName |
| createdByUserInfo/email | -> | createdByUserNav/email |
| createdByUserInfo/jobRole | -> | createdByUserNav/jobRole |
| createdDateTime | -> | createdDateTime |
| lastModifiedDateTime | -> | lastModifiedDateTime |
| orderStatus | -> | orderStatus |
| responseCode | -> | responseCode |
| responseDetail | -> | responseDetail |
| vendorCode | -> | vendorCode |
| vendorOrderNo | -> | vendorOrderNo |
| applicationInfo/applicationId | -> | jobApplication/applicationId |
| applicationInfo/appStatusName | -> | jobApplication/jobAppStatus/appStatusName |
| jobRequisitionInfo/jobReqId | -> | jobApplication/jobReqId |
| jobRequisitionInfo/externalTitle | -> | jobApplication/jobRequisition/jobReqLocale/externalTitle |
| jobRequisitionInfo/hiringManager/usersSysId | -> | jobApplication/jobRequisition/hiringManager/usersSysId |
| jobRequisitionInfo/hiringManager/firstName | -> | jobApplication/jobRequisition/hiringManager/userNav/firstName |
| jobRequisitionInfo/hiringManager/lastName | -> | jobApplication/jobRequisition/hiringManager/userNav/lastName |
| jobRequisitionInfo/hiringManager/email | -> | jobApplication/jobRequisition/hiringManager/userNav/email |
| jobRequisitionInfo/hiringManager/operatorRole | -> | jobApplication/jobRequisition/hiringManager/operatorRole |
| jobRequisitionInfo/hiringManagerTeam/usersSysId | -> | jobApplication/jobRequisition/hiringManagerTeam/usersSysId |
| jobRequisitionInfo/hiringManagerTeam/firstName | -> | jobApplication/jobRequisition/hiringManagerTeam/userNav/firstName |
| jobRequisitionInfo/hiringManagerTeam/lastName | -> | jobApplication/jobRequisition/hiringManagerTeam/userNav/lastName |
| jobRequisitionInfo/hiringManagerTeam/email | -> | jobApplication/jobRequisition/hiringManagerTeam/userNav/email |
| jobRequisitionInfo/hiringManagerTeam/operatorRole | -> | jobApplication/jobRequisition/hiringManagerTeam/operatorRole |
| candidateInfo/candidateId | -> | jobApplication/candidate/candidateId |
| candidateInfo/firstName | -> | jobApplication/candidate/firstName |
| candidateInfo/lastName | -> | jobApplication/candidate/lastName |
| candidateInfo/primaryEmail | -> | jobApplication/candidate/primaryEmail |
| candidateInfo/contactEmail | -> | jobApplication/candidate/contactEmail |
3
Response Fields Step
Click on the 
Click on the 
Switch to Field Mapping View option,+ button and select the JobApplicationBackgroundCheckRequest entity. Then click Add and proceed by clicking the Next button.4
Filter and Sort Step
You do not need to set anything on the Filter and Sort step. Simply click the 
Next button.5
Destination Settings Step
Select the option for 
REST Server Settings and input the following details:- Connection Name: You can choose any name you prefer.
- REST API URL: This is the endpoint URL provided by StackOne, which will be used to receive background check order requests.
- Authentication Type: Select
Basic Authenticationfrom the dropdown menu. - Username: Enter the
External Trigger Tokenthat you receive from theStackOne Integration Hubduring the connection setup. - Password: This field can be left empty.
- HTTP Method: Choose the
POSTmethod under REST Operation Settings.
Next button to proceed.6
Review and Run Step
Review the template structure in the Review and Run step. To save it, select the 
You can confirm the integration by returning to Integration Center > My Integrations.
Save option. After creation, the template will run in the background, eliminating the need to click Run Now.You can access the logs by clicking on the
Last Run Time link.Create Vendor from Recruiting External Vendor
1
Go to the Manage Data
Navigate to Manage Data and select 
Enter the External Code, Vendor Name, and select 
Recruiting External Vendor from Create New dropdownBackground Check as the Integration Type from the dropdown menu. Click on Save to create the vendor.External Code refers to a text string that serves as a code for the background check vendor. The OData API entities use this value to facilitate communication between the third-party vendor and SAP SuccessFactors. If this information is not entered correctly, certain integration scenarios may fail to function properly.Create Recruiting Vendor Integration Mapping
1
Go to the Manage Data
Navigate to Manage Data and select 
Enter the External Code, select your Vendor Name, choose your Integration Name from the dropdown, and set the Default integration value to 
Click
Recruiting Vendor Integration Mapping from Create New dropdownYes.Enter a numeric value in the Hours Before User Can Reinitiate field. This field currently has no functionality in SAP SF.Save to save the mapping between the vendor and integration.Only one
Recruiting Vendor Integration Mapping can be active at a time. To set the selected vendor integration as active for the instance, select Yes in the Default Integration field.Manage fields for the Job Requisition template
1
Go to Manage Templates
Navigate to Admin Center and search for Manage Templates
Navigate to the Recruiting Management tab, select Job Requisition, and choose the template that is in use for the specific job requisition, such as
Standard Job Requisition.How to Locate the Job Requisition Template Name
How to Locate the Job Requisition Template Name
Go to the Recruiting and select any specific job requisition.
Click on the 
i icon to view the Job Requisition Template.2
Add bgiAccountId & packageId fields in template
Please add the following fields that you will receive in the order request:
In the next step, Update the permissions to ensure the fields are visible during Job Requisition creation or updates.
- bgiAccountId: You can create multiple accounts with a single third-party background check vendor. This field enables recruiters to select which account to use.
- packageId: Recruiters can choose the package they want to apply to a specific job requisition.
You can specify the standard fields `bgiAccountId` and `packageId` using the Job Requisition XML as well.
You can specify the standard fields `bgiAccountId` and `packageId` using the Job Requisition XML as well.
This approach will only be used if you have permission to upload the Job Requisition template via an XML file; otherwise, you can manually add the fields and click the
Publish button.Manage the permissions for the fields added to the Job Requisition template
1
Go to Manage Templates
To add or update field permissions, navigate to the specific Job Requisition Template, select 
After successfully updating the permissions, the fields will be visible in the Job Requisition during create/edit.
Field Permissions Defined, and then click on Add Field Permission from the modal.- Field Permission description: Enter any description
- Field Permission Type: Select
Write Permission - Field Permission Role Name: Select
Recruiter - Field Reference ID: Select
bgiAccountId&packageIdfields - Field Permission Status: Select
Allorpre-approvedfrom dropdown
Publish to save your changes.To add background check accounts from the PickList Center.
1
Go to background check accounts
Go to Admin Center and search for 
Search for 
PickList CenterbgiAccountId2
Add New Accounts
Click on 
bgiAccountId. This will direct you to the Picklist Values page where you can add different Background Check Accounts.You can create multiple accounts with a single third-party background check vendor. All accounts added in this picklist will be available for recruiters to choose as the Background Check Account under the Job Requisition details.
To add background check packages from PickList Center
1
Go to the packages
Go to Admin Center and search for Search for 
PickList CenterpackageId2
Add New Packages
Click on 
packageId to go to the Picklist Values page, where you can add different Background Check Packages.All packages added in this picklist will be available for recruiters to choose as the Background Check Package to apply on the Job Requisitions.
To include a Background Check stage in the Talent Pipeline
You can skip this step if you already have a separate
Background Check stage in the talent pipeline for the Job Requisition.1
Go to Applicant Status Configuration
Go to Admin Center and search for 
It will take you to the page for the 
Edit Applicant Status Configuration.Select the specific Applicant Status Set currently in use for the job requisition, such as the Standard Status Set.Standard Status Set,2
Edit Applicant Status Set configurations
Find 
Click the 
Background Check stage, edit and select none from the Status Group dropdown. This will make the Background Check visible as a separate stage in the Job Requisition’s Talent Pipeline.Save and Finish button to save your changes.3
Where can you verify the added stage
Navigate to the Job Requisiton > Candidates. Above, you will see the updated talent pipeline,
You can now proceed to move the candidates to the Background Check stage.
Edit Job Requisition to Select Background Check
1
Go to Job Requisition
Navigate to specific Job Requisition, hover over the specific requisition title to open the Actions menu and then select 
Select the correct values for the Account ID and Package ID fields. Click on the
View or Edit Requisition.Save Changes button.If fields are not visible after adding fields & permissions in above steps
If fields are not visible after adding fields & permissions in above steps
Navigate to Admin Center and search for 
Click on the 
OData API Metadata Refresh and ExportRefresh button next to Cache.To Send Background Check to the Candidate
If you are not seeing the
Background Check as a separate step in the current Job Requisition, please visit this step.1
Go to Talent Pipeline
Navigate to the specific Job Requisition and click on Candidates. Select the candidate, then choose the 
Choose 
Move Candidate option from the Take Action menu.Background Check from the dropdown menu, then click Apply Updates to move the candidate forward.2
Send Background Check to Candidate
Navigate to Background Check, click on the
Go to the specific Job Requisition Template > Template Settings > Application Status Configuration and Add the feature permission block for background check to the job requisition template.
Or you can add permissions via Job Requisition template XML file.
Click on the
Initiate Background Check option in the Take Action menu.If `Initiate Background Check` option is not present
If `Initiate Background Check` option is not present
1
Assign Background Check Initiate Permission
Users involved in recruiting must have the necessary permissions to initiate background checks.
2
Assign Background Check Initiate Permission
Assign
Background Check Initiate Permission and Allow users to execute “Application/UI” or “Event-based” Integrations role-based permissions from Admin Center.Confirm to send the Background Check. You’ll get the success on the same modal.3
How to view the requested background check?
The Background Check request will appear in the candidate’s application under the Background Check portlet.
To Check Result of the Background Check
1
Go to Background Check portlet
Go to the 
Background Check stage, The results will be available in the Background Check portlet within the candidate application.Congratulations, you’re all set! If you face any issues with the steps mentioned above, please contact us by emailing integrations@stackone.com. We’re always here to assist you!