SAP Knowledge Base Article - Public

2649816 - CompoundEmployee API Delta Transmission

Symptom

Delta Transmission - Overview

Employee Central’s Compound Employee API offers two different kinds of delta transmission:

  • Effective-dated delta transmission
  • Period-based delta transmission

Effective-dated delta transmission is designed for consumers that work in an effective-dated manner. This means, it is assumed that consumers store the time frame (start and end date) when a data record is effective. Deltas are communicated with regard to the time frames that have been transmitted in the last replication.

In contrast to this, period-based delta transmission is intended for consumers that are not able to deal with effective-dated objects. Deltas contain retro-active changes and effective-dated objects that are relevant for the given period.
Non-effective dated objects are returned in both kinds of delta transmission, if these are changed after the last replication.

Note: Delta transmission is based on active auditing to determine the historical data set of employees, which means that auditing must be switched on during the system setup phase prior to the initial load of employees into the system.

Environment

Successfactors CompoundEmployee API

Resolution

Delta transmission needs to be enabled and always requires a date/time indication for the last synchronization as a part of theWhere clause when calling the Compound Employee API.
Syntax:

  FROM CompoundEmployee
  WHERE ( last_modified_on > to_datetime(LastModifiedDate))

For both delta transmission modes, the query parameter queryMode and value delta or periodDelta needs to be passed to run the API in delta transmission mode.

Syntax:
  <urn:param>
    <urn:name>queryMode</urn:name>
    <urn:value>delta</urn:value>
  </urn:param>
Or
  <urn:param>
    <urn:name>queryMode</urn:name>
    <urn:value>periodDelta</urn:value>
  </urn:param>

To indicate the period for the period-based delta transmission, the parameter couple “fromDate … toDate” is required as part of the “Where” clause together with the “last_modified_on” date when calling the API. This period couple parameter needs to be passed with an “AND” operator in “Where” clause. From a selection point of view,
employees need to match either the “last_modified_on” or the period criterion in order to get selected.

Syntax:
   FROM CompoundEmployee
   WHERE ( last_modified_on > to_datetime(LastModifiedDate)
      AND fromDate = to_date(FromDate,'YYYY-MM-DD')
      AND toDate = to_date(ToDate,'YYYY-MM-DD') )

See Also

Compound Employee API - Delta Transmission Handbook in help.sap.com

Query Parameters for the Compound Employee API

Effective-Dated vs. Period-Based Delta Transmission

Keywords

CompoundEmployee, API, Delta Mode, queryMode, delta transmission, SFAPI , KBA , LOD-SF-INT-CE , Compound Employee API , LOD-SF-INT , SF Integrations - EC Payroll, Boomi/ HCI, API , How To

Product

SAP SuccessFactors HCM Core all versions