Prerequisites

• You are an Admin of your SAP SuccessFactors instance. If you are not an admin, you won't even be able to search for and access the configuration pages that are described later on.
  • Alternatively, please contact your SuccessFactors Admin and have them take over the integration setup process.

Enable Background Check in Recruiting 

1. In SuccessFactors, go to Admin Center and search for "Background Check Central":
   
    
2. Make sure the "Enable Background Check in Recruiting" is on, and that the "Other Background Check Vendor" option is selected:
   

Set Up Background Check Integration

1. In SuccessFactors, go to Admin Center and search for "Integration Center":
   
    
2. Click on "My Integrations":
   
    
3. Click on the "+ Create" button, and select "More Integration Types" from the dropdown:
   
    
4. Make sure the options instructed in the connection flow are selected in the "Choose Integration Type" pop-up, and click on "Create":
   
   
   
    
5. Search for JobApplicationBackgroundCheckRequest in the "Search for Entities by Entity Name" search box, select the entity and click on "Select":
   
    
6. In the "Options" step, enter a name for the integration. You can use what's suggested in the connection flow, and click "Next":
   
   
    
7. In the "Configure Fields" step, click on the "plus" button, select "Insert Sibling Element":
   
    
8. Per the instruction of the connection flow, please change the Sibling Element's label to backgroundCheckInfo:
   
    
9. Under the backgroundCheckInfo, click on the "plus" button and select "Add Child Element":
   
    
10. Please add the Child Elements instructed by the connection flow. We are going to use the requestId field as an example:
    
    1. Select the child "Element", and change its "Label" to requestId, and click on the "Set as Associated Field" icon:
       
        
    2. Select the related field as instructed by the connection flow from the "Entity Tree View" section of the pop-up, and click on the "Change Association to "<PLACEHOLDER_FOR_RELATED_FIELD>"":
       
       
        
    3. Repeat the same process for the renaming of Child Elements instructed by the connection flow:
       
        
    4. The "Field Detail View" should look like the following example once you're done:
       
       
        
11. Skip to the "Destination Settings" step:
    
     
12. In the "Destination Settings" step, select the "REST Server Settings" option. Copy the "REST API URL" from the connection flow. Set the "Authentication Type" to Basic Authentication, and copy the "User Name" and "Password" from the connection flow. Please also make sure the value of "HTTP Method" is set to POST:
    
    
    
    
     
13. Click on "Save" and "Save" from the options list:
    
     
14. Click "Save" in the pop-up:
    
     
     

Set Up Recruiting Vendor

1. In SuccessFactors, go to Admin Center and search for "Manage Data":
   
    
2. Select the Recruiting External Vendor option from the "Create New" dropdown:
   
    
3. Enter the Recruiting External Vendor's details instructed by the connection flow, and click "Save":
   
   
    
4. Go back to "Manage Data", and select the Recruiting Vendor Integration Mapping option from the "Create New" dropdown:
   
    
5. Enter the Recruiting Vendor Integration Mapping's details instructed by the connection flow, and click "Save":
   
   
   Only one Recruiting Vendor Integration Mapping can be active at once. Please ensure the existing Vendor Integration Mapping's Default Integration is set to No.
    
6. Click on "Continue" in the connection flow:
   
   
    

Configure Job Requisition Template

1. Search for "Manage Templates" and select it from the dropdown:
   
    
2. Select the "Recruiting Management" tab and click "Job Requisition":
    
3. Click on the job requisition template that belongs to your job (we're using the "Job Requisition - Quick Apply" template in this example):
   
   If you don't know which template your job requisition is based on, follow the steps here for an easy way to find out
    
4. Click on the "XX Fields Defined. Click to modify" link:
   
    
   1. Search for and make sure there's a field with the following values in the "Fields" pop-up:
      Field-ID: bgiAccountId
      Field Type: picklist
      Picklist ID: bgiAccountId
      
      
      Otherwise, create a "standard" field with the following details:
      Field-ID: bgiAccountId
      Field Type: picklist
      Field Label: Background Check Vendors Account ID
      Field Description: Background Check Vendors Account ID
      Required: False
      Picklist ID: bgiAccountId
      
       
   2. Search for and make sure there's a field with the following values
      Field-ID: packageId
      Field Type: picklist
      Picklist ID: packageId
      
      
      Otherwise, create a "standard" field with the following details:
      Field-ID: packageId
      Field Type: picklist
      Field Label: Background Check Vendor Package ID
      Field Description: Background Check Vendor Package ID
      Required: False
      Picklist ID: packageId
       

5. Close the "Fields" pop-up by clicking on "Done", and click on the "XX Fields

    Permission Defined. Click to modify" link:
   
    

   1. Click on "Add field permission" in the "Field Permissions" pop-up:
      
       
   2. Please enter the following properties, and click "Done":
      Field Permission Description: Background Check
      Field Permission Type: Write Permission
      Field Permission Role Name: All or Selected → Recuiter
      Reference ID: Select bgiAccountId and packageId
      Permission Status: All or Selected → pre-approved
      
       
6. Configure Feature Permissions
   1. Go to "General Settings" → "Application Status Configuration":
      
       
   2. Click on the "XX Feature Permissions defined. Click to modify." link:
       
   3. Click on "Add feature permission" in the "Feature Permissions" pop-up:
       
   4. Please enter the following properties, and click "Done":
      Feature Permission Description: Show Background Check Result on Candidate
      Feature Permission Type: backgroudCheck
      Feature Permission Role Name: All 
      Feature Permission Status: All or Selected → pre-approved
      
      
      The "Feature Permission Status" field controls in which stages the "Background Check" section can be seen on a candidate's application page. You can create the backgroundCheck Feature Permission for as many stages as you wish.
      
       

7. Click on "Publish":

   
    

8. Click on "Yes" in the "Publish Confirmation" pop-up:
   
    
9. Click "Set up integration" in the connection flow to finalise the connection:
   

Find out which template is used for a job requisition

1. Search for "Reassign Job Requisitions":
   
    
2. Type in the ID of the Job Requisition and click on the suggestion, then click "Search":
   
    
3. The template name will be shown in the highlighted area: