SAP Knowledge Base Article - Public

3559572 - Onboarding users included in query response - SuccessFactors Compound Employee API

Symptom

You noticed that when querying compound employee API, users who are still in the Onboarding process and which hire will take effect in the future are included in the response.

Environment

  • SAP SuccessFactors HCM Suite
  • Compound Employee API

Reproducing the Issue

  1. I will share 2 example queries where the Onboardees are returned:

    SELECT person, personal_information, email_information, employment_information, job_information, compensation_information WHERE last_modified_on > to_datetime('') AND fromDate = to_date('','YYYY-MM-DD') AND toDate = to_date('','YYYY-MM-DD') AND isContingentWorker IN ('t','f')

    SELECT person, personal_information, email_information, employment_information, job_information WHERE snapshot_date = to_DateTime('') AND effective_end_date = to_date('') AND isContingentWorker = 'f' AND company_territory_code IN ()

  2. Notice that users who are still in the Onboarding process are included in the response.

Cause

The issue occurs because the parameter 'hiringNotCompleted = 'false'' is not included in the query.

Resolution

This is expected to have the OnBoarding users included in the query response due to the following parameter not included in the query: hiringNotCompleted = 'false'

As you can see from the Guide page below: https://help.sap.com/docs/SAP_SUCCESSFACTORS_EMPLOYEE_CENTRAL/5bb9a5b997a843c88e769a105e4af4d4/8d33fc22c0c34937b6acb736770e036e.html?q=onboarding

hiringNotCompleted Employment Filter
Query RequestQuery Response
Contains hiringNotCompleted = 'false'

Contains employments of hired employees

Doesn't contain new employments of candidates

Doesn't contain hiringNotCompleted

Contains employments of hired employees as well as candidates

If you do not want Onboardees to be replicated you would need to use the parameter hiringNotCompleted with value 'false'.

See Also

Refer to the guide page: (https://help.sap.com/docs/SAP_SUCCESSFACTORS_EMPLOYEE_CENTRAL/5bb9a5b997a843c88e769a105e4af4d4/8d33fc22c0c34937b6acb736770e036e.html?q=onboarding)

Keywords

Onboarding, users, query, response, Cloud Integration, hiringNotCompleted, parameter, Compound Employee API. , KBA , LOD-SF-INT-CE , Compound Employee API , Problem

Product

SAP SuccessFactors HCM Suite all versions