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 "<entity name>" that starts on yyyy-mm-dd. Please use an effective end date filter greater than or equal to yyyy-mm-dd.</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), t-code 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. That includes scenarios where an employee was "Rehired with a new employment" by mistake and this recent employment was later purged.
Cause
Purge Validation protects the SAP HCM 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).
Another error that could be causing this issue is mentioned in KBA 3393967 - Data for employee have been purged. Replication not possible. - Message No. ECPAO_IN_PROCESSING074.
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.
For replications BIB-based:
- Enabling the usage of Purge Status Overview (see Configuring the Parameters for the Employee Master Data and Organizational Assignment Query | SAP Help Portal, point 17) by leaving that check box as empty in the BIB query. If you have installed the new add-on ECS4HCM that option is hard-coded already.
OR - Moving the Full Transmission Start Date forward (see Recommendations for Choosing a Full Transmission Start Date | SAP Help Portal, especially the section "FTSD and Retention Times")
OR - Fix it through EC Check Tool: Check Tool > Validation > Compound Employee API > Replication of a Person is blocked by Purge Validation
- Add the inputs parameters correctly for User, FTSD date, EC entity impacted. E.g. User 12345, 01.01.2022, employment_information
- Quick fix it
For replication PTP-based (Employee Central Payroll):
- Follow the KBA 3048059 resolution;
For replication non-BIB (Implementation Started Before Q2 2017):
- 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;
- 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.
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, ECT-246164, ECPAO_IN_PROCESSING074 , KBA , LOD-SF-INT-CE , Compound Employee API , LOD-EC-INT-EE , Employee Integration EC to ERP On Premise , LOD-EC-ECP-PY , Payroll Integration EC to Employee Central Payroll , Problem
SAP Knowledge Base Article - Public