SAP Knowledge Base Article - Public

2845873 - How Background Check Integration Works (Integration Center) - Recruiting Management

Symptom

This article describes the steps on How Background Check Integration Works when configured using Integration Center.

"Image/data in this KBA is from SAP internal systems, sample data, or demo systems. Any resemblance to real data is purely coincidental."

Environment

SAP SuccessFactors Recruiting Management (RCM)

Resolution

Recruiting Management to Background Check Vendor through Integration Center.

1. Candidates are placed in Background Check Status and Recruiters will click on Take Action > Initiate Background Check.

kb1.png

The Initiate Background Check option will show as long as the feature permission is set in the Job Requisition Template.

<feature-permission type="backgroundCheck">
  <description><![CDATA[The following roles can launch background check]]></description>
  <role-name><![CDATA[S]]></role-name>
  <role-name><![CDATA[R]]></role-name>
  <role-name><![CDATA[T]]></role-name>
  <role-name><![CDATA[Q]]></role-name>
  <status><![CDATA[Background Check]]></status>
</feature-permission>

2. Candidate Application Data will go to the Integration Center Job. The name of the job is typically the name of the third-party vendor, e.g., HireRight, FADV, Justifacts.

kb2.png

3. SuccessFactors will send initial data which consists typically of application ID, candidate ID, vendor code, and backgroundCheckRequest ID.

{"accountId":"SAPTest01",
"backgroundCheckRequestCreatedBy":"adminsap",
"backgroundCheckRequestLastModifiedDate":"2019-09-16T11:12:46Z",
"backgroundCheckRequestResponseDetail":"Draft",
"JobApplicationId":"5222",
"backgroundCheckRequestVendorCode":"HIRERIGHT",
"packageId":"210034",
"CandidateId":"2324",
"backgroundCheckRequestResponseCode":"OK",
"fallback":"InviteApplicant",
"backgroundCheckRequestCreatedDateTime":"2019-09-16T09:58:27Z",
"backgroundCheckRequestVendorOrderNumber":"199",
"backgroundCheckRequestId":"208",
"throwback":"",
"backgroundCheckRequestOrderStatus":"OK"}

Note: This is a sample payload that we sent to HireRight. The payload contents may be different for other vendors or will depend on what fields were mapped by your Implementation Partner.

4. The Background Check Vendor will confirm the initial data sent and respond by sending a Job Application query using applicationID as the main filter.

https://api4preview.sapsf.com/odata/v2/JobApplication(5222L)?$expand=education,state,candidate,candidate/state,jobRequisition/bgiAccountId,jobRequisition/packageId,jobRequisition/recruiter

Note: This is a sample request query that HireRight sends to SuccessFactors.

5. SuccessFactors will reply to the query by sending the information that the Background Check vendor requested.

6. At this point, the Background Check vendor will process the background check request. Send background email to candidates, etc.

<?xml version="1.0" encoding="UTF-8"?><CreateOrder xmlns="urn:connect.hireright.com/model" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" transactionID="20191010170549033|1|82C06C594C194CB8AADBBC98988CBD57" fallbackModel="InviteApplicant">
<CustomerId>789511</CustomerId>
<UserId>579012</UserId>
<AccountId>SAPTest01/AccountId>
<CompanyLogin>SAPT</CompanyLogin>
<UserRefId>265098</UserRefId>
<PackageId>211890</PackageId>
<ClientRefId>211</ClientRefId>
<FlexFields><FlexField name="JobAppId">5222</FlexField>
<FlexField name="JobReqId">1122</FlexField>
<FlexField name="BackgroundCheckRequestId">208</FlexField>
<FlexField name="PositionTitle"/>
<FlexField name="JobStartDate"/>
<FlexField name="Role"/>
<FlexField name="JobCode">342167</FlexField>
<FlexField name="Division">US Operations</FlexField>
<FlexField name="CostCenterId"/>
<FlexField name="Location"/>
<FlexField name="Department">US Operations</FlexField>
<FlexField name="PositionNumber"/></FlexFields>
<ClientLocale>en_US</ClientLocale>

<Payload>
<BackgroundCheck xmlns="http://ns.hr-xml.org/2006-02-28"><BackgroundSearchPackage>
<PersonalData><PersonName><GivenName>SAPTEST</GivenName><MiddleName>TEST</MiddleName><FamilyName>User</FamilyName>
<Affix type="generation"/></PersonName><PostalAddress><CountryCode>USA</CountryCode><PostalCode>34472</PostalCode>
<Region>945</Region><Municipality>test</Municipality><DeliveryAddress><AddressLine>test</AddressLine><AddressLine/></DeliveryAddress></PostalAddress>
<ContactMethod><Location>home</Location><Telephone><FormattedNumber/></Telephone><Mobile><FormattedNumber>5346345</FormattedNumber></Mobile>
<InternetEmailAddress>test@gmail.com</InternetEmailAddress></ContactMethod><DemographicDetail><GovernmentId issuingAuthority="SSN" countryCode="US"/>
<DateOfBirth/><GenderCode/><Language>en</Language></DemographicDetail></PersonalData>

<Screenings><Screening type="education"><SearchEducation><EducationHistory><SchoolOrInstitution><School><SchoolName/></School>
<LocationSummary><Municipality/><Region/><CountryCode/></LocationSummary><Degree degreeType=""><DegreeDate><YearMonth/></DegreeDate><DegreeMajor><Name>53453</Name></DegreeMajor>
<DatesOfAttendance><StartDate><YearMonth/></StartDate><EndDate><YearMonth/></EndDate></DatesOfAttendance></Degree></SchoolOrInstitution></EducationHistory></SearchEducation>
</Screening></Screenings></BackgroundSearchPackage></BackgroundCheck></Payload><Properties><Property name="ShowAccountList">false</Property></Properties></CreateOrder>

Note: This is a sample background check order sent to HireRight.

7. Vendor will send the results of the background check and SuccessFactors will display it in the portlet.

kb3.png

8. The Background Check Result would look like as follows.

<?xml version="1.0" encoding="utf-8"?><entry xmlns="http://www.w3.org/2005/Atom" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xml:base="https://api4preview.sapsf.com/odata/v2/">
<id>https://api4preview.sapsf.com/odata/v2/JobApplicationBackgroundCheckResult(5222L)</id><title type="text"></title><updated>2019-09-17T15:58:28Z</updated><author><name></name></author>
<link rel="edit" title="JobApplicationBackgroundCheckResult" href="JobApplicationBackgroundCheckResult(208L)"></link><category term="SFOData.JobApplicationBackgroundCheckResult" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme"></category><content type="application/xml"><m:properties>
<d:vendorCode m:type="Edm.String">HIRERIGHT</d:vendorCode>
<d:vendorOrderNo m:type="Edm.String">199</d:vendorOrderNo>
<d:stepName m:type="Edm.String">Overall Status</d:stepName>
<d:stepStatus m:type="Edm.String">Completed</d:stepStatus>
<d:stepMessage m:type="Edm.String">HireRight Order Number is SF-091619-JY8UP. Overall order status is 100% complete.</d:stepMessage>
<d:finalStep m:type="Edm.Boolean">false</d:finalStep><d:statusId m:type="Edm.Int64">204</d:statusId></m:properties></content></entry>

This is a sample background check result from HireRight.

See Also

2215682 - Successfactors API URLs for different Data Centers

2845845 - How Background Check Integration Works (Middleware) - Recruiting Management   
2851325 - How Background Check Integration Works (Intelligent Services) - Recruiting Management

2768811 - How to Configure Background Check (Integration Center) - Recruiting Management
2851285 - How to Troubleshoot Background Check Integration - Recruiting Management

Keywords

Background Check, Background Check Integration, Third-party Vendor, Recruiting Management, RCM, Integration, API, Integration Center , KBA , LOD-SF-RCM-INT , Integrations & Intelligent Services , How To

Product

SAP SuccessFactors Recruiting all versions