Symptom
- A change has been noticed in a number of OData entities, where the "Start Date" label seems to have been renamed to "Event Date".
- This is impacting the following SuccessFactors EC OData APIs:
EmpCompensation
EmpJob
EmpJobRelationships
EmpPayCompRecurring
FOCorporateAddressDEFLT
HrisEmergencyContactAddressDEFLT
PerAddressDEFLT
PerPersonRelationship
PerPersonal
PerGlobalInfoXXX
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 OData API Framework
Reproducing the Issue
- Access the OData entities.
- Observe the label change from "Start Date" to "Event Date".
Cause
Known behaviour.
Resolution
FAQ
- Is there any workaround I can apply if I'm impacted by this issue? Yes. For a workaround, please follow these steps (Note: No matter what the language the user is using, you just need to make the change for English US)
- Go to Admin Center -> Manage Languages.
- Make the change for the row “English US”:
- If the company already has custom translations for “English US”
Click the link displayed on the column “Custom Translation”. On the pop-up window, click “Download” to download the custom translation csv file. Open the csv file with text editor, add a new line with the text:
"EMPFILE_HRIS_EVENT_DATE","Start Date"
Save the csv file and go back to the pop-up window, click “Upload Now” to upload it. - If the company hasn’t configured any custom translations for “English US”
Click “Action” button at the right side of the row “English US”. Select “Create Custom Translation” on the drop-down menu. Give any name.
Create a new file with extension “.csv” and add the following 2 lines:
"Key","en_US"
"EMPFILE_HRIS_EVENT_DATE","Start Date"
Click "Upload Now" on the "to-do" column to upload the file.
- If the company already has custom translations for “English US”
- Refresh the OData API metadata.
- Why was this change made? The change was made to give more accurate labels for some properties, namely, to change the label from a hard-coded string to a standard message. This was to align with the API industry best practice, stating that “Field labels, titles and description cannot be considered as a part of stability contract of API”.
- When was the change made? The change was made during the Development phase of SAP SuccessFactors 1H 2025 Release.
- I run an integration between SAP SAC and SAP SuccessFactors and I'm impacted by this. For SAC integrations, please note the workaround in 1. above will work. The SAC and SuccessFactors engineering teams are currently working together to seek for a potential enhancement on the SAC side (e.g. read Name instead of Label in future releases of SAC). This KBA will be kept up-to-date with any news in this regard.
- Will this happen again in the future? Why was I not notified? Since reading the Label is not a good practice in API operations, there was no expectation of any impact to our customers. As a corrective action, should a similiar initiative take place in the future, we will ensure to notify all customers proactively via the regular channels (e.g. What's New Viewer)
See Also
Keywords
OData, API, Label Change, Start Date, Event Date, EmpJobPersonalInfomationJob, Admin Center, Manage Languages, Custom Translation, EMPFILE_HRIS_EVENT_DATE, KI2505, 1H 2025, 2505, KEA, Known Error, known issue, bug, error, fix, defect, release, production, preview, H1, EmpCompensation, EmpJob, EmpJobRelationships, EmpPayCompRecurring, FOCorporateAddressDEFLT, HrisEmergencyContactAddressDEFLT, PerAddressDEFLT, PerPersonRelationship, PerPersonal, PerGlobalInfoXXX , KBA , LOD-SF-INT-EC , Employee Central SFAPI & OData Entities , Known Error