SAP Knowledge Base Article - Public

3434930 - "The effective end date filter is outside of the retention period" error when replicating employee data

Symptom

You are replicating SuccessFactors employee data to HCM (also known as ERP/ECP/S4HANA) but the replication is failing with an error like the below:

  • "<code>COMPOUND_EMPLOYEE/EFFECTIVE_END_DATE_FILTER_IN_PURGE_PERIOD</code>
    <severity>ERROR</severity>
    <message_text>The effective end date filter is outside of the retention period of entity "employment_information" that starts on 2024-01-01. Please use an effective end date filter greater than or equal to 2024-01-01.</message_text>"

This error may affect segments of the Compound Employee API such as personal_information or employment_information and may be visible through tracking tools such as SFAPI audit log (SuccessFactors), SLG1 (HCM) or middleware logs (CPI or Boomi).

Environment

SAP SuccessFactors HCM Suite

Reproducing the Issue

This error is particularly common in two scenarios:

  • Scenario 1: A business purge was used to remove old records from the employee's history, but the Full Transmission Start Date (FTSD) used in the integration is lower than the used retention period;

  • Scenario 2: A person had multiple employments and one of his employments with a termination date after the Full Transmission Start Date (FTSD) was purged completely;

Cause

Purge Validation protects the ERP system from deleting data which was purged in EC. This way, it is not possible to replicate a person if effective-dated master data is not completely available anymore back until the FTSD (scenario 1). Also remaining employments can't be replicated anymore if another employment of the same person has been purged as the validation is performed on person level (scenario 2).

Legacy replication (non-BIB) are simply not designed to handle this type of scenarios. This can be mitigated by switching to Business Integration Builder (BIB) based replication with activating the option to use DRTMPurgeStatusOverview where the purge evaluation is done in ERP instead of EC.

Resolution

There are different resolutions for each integration scenario and they are all based on the Data Purge Handling chapter of Compound Employee API guide. 
IMPORTANT (specially for Scenario 2, above): The Highest Business Purge Date set by the DRTM Master Data Purge is determined based on the highest termination date from the purged employments. As a result, if the employee's termination happened before the FTSD / Effective End date Filter it will not be captured by the purge validation. If the employment was created by accident, the hire and termination date should be moved before the FTSD before the employment is purged. If this was a "real" employment, this might not be possible.

If using BIB:

If using ECP (Employee Central Payroll):

  • Follow the KBA 3048059's resolution;

If not using BIB:

  • Do not purge master data which is valid after the FTSD;
  • Do not rehire into existing person if you plan to purge employments of the same person, create a new person instead;
  • If this already happened, please, create a support case to LOD-SF-INT team, mentioning this KBA, so they engage Engineering team to remove the blocking records from the purge status table;
    OBS. for technical support: Refer to the INC8432760

NOTE: Please consider move from the non-BIB to the BIB replication, based on the following documents:

See Also

Keywords

EFFECTIVE_END_DATE_FILTER_IN_PURGE_PERIOD, The effective end date filter is outside of the retention period, Please use an effective end date filter greater than or equal to, CE, CompoundEmployee, Compound_Employee, rehire, re-hire, hire, EC, replication, BIB, non-BIB, legacy, FTSD , KBA , LOD-SF-INT-CE , Compound Employee API , LOD-EC-INT-EE , Employee Integration EC to ERP On Premise , LOD-SF-INT , Integrations , Problem

Product

SAP SuccessFactors HCM suite all versions