SAP Knowledge Base Article - Public

2527345 - Defining the Integration Center Template for External Background Checks


How to define the Integration Center Template for External Background Checks.

Enabling the Background Check with External Third Party Vendor has 7 parts that a client needs to do.

This is part 4 of 7.


SAP SuccessFactors Recruiting Management


After you've created the Integration Center template for external background checks, define the elements and fields on the template.


Before proceeding, create an Integration Center template based on the JobApplicationBackgroundCheckRequest entity.
You can download a sample template from the SAP API Business Hub to use as a starting point for the background check integration template.

The fields defined on the integration template determine the outbound payload structure of the integration. To understand the full range of options available, consult the OData API guides
For a full list of available entities and their properties, consult Admin Center > Data API Data Dictionary.
To understand the data structures of SAP SuccessFactors Recruiting, use Admin Center > Integration Center > Data Model Navigator.

1.On the Options tab, define the Integration Name.
2.Click Next.
3.Click the plus sign icon and select Add Sibling Element to add elements to the template. Enter a name for the element in the Label text box


Each sibling element corresponds to a section of the template. For example, you might add sibling elements called BackgroundCheckInfo and ApplicantInfo.

4.Select the sibling element you created, then click the plus sign icon and Add Child Element.
5.Enter the desired name of the field in the Label text box.

After you have created the desired data structure, associate the created properties with their corresponding OData API properties.

6.Select one of the fields you would like to associate with an OData API properly.
7.Click Set as Associated Field.


8.Find the OData API property you want to associate the field with.

  • Search for the property by name using the Enter for Field Name search box. This is only recommended if you know the exact name of the property you want to associate.
  • Use the Entity Tree View to find related entities that can be reached through the OData API navigation properties.

When most of the fields are associated, you can see a preview of the integration payload in the Preview section.

9.Click Next when you are finished associating the fields.
10.On the Response Fields tab, click the Switch to Field Mapping View option.

11.Click the plus sign icon and select the JobApplicationBackgroundCheckRequest entity.
12.Click Add.
13.Click Next.
14.Click Next. No settings are required on the Filter and Sort tab.
15.Define the destination settings for the REST API call on the Destination Settings tab.

You can find additional information for defining the destination settings on the Integration Center guide.

16.Click Next.
17.Review the template structure on the Review and Run tab.
18.Click Save to save the template.

Once created the template runs in the background, so there is no need to select Run Now.



See Also

Integration Center

SAP API Business Hub


Background Check with External Third Party Vendor Third Party Vendor Background Check SAP SuccessFactors Recruiting Management , KBA , LOD-SF-RCM-INT , Integrations & Intelligent Services , How To


SAP SuccessFactors Recruiting 1708