HR Changed fields

As of release 2023.1.1, HR event have the ability to generate the list of fields that have changed during an employee record change. This will be represented in the event by an array inside the event body called changedfields with the following properties:

Field	Description
FieldName	Name of the changed field
FieldPath	Path of the field
OldValue	Value of the field before the change
NewValue	Value of the field after the change

Example of a changed field list after an employment status change

   "changedfields": [
      {
        "FieldName": "EmployeeEmploymentStatus.EffectiveStart",
        "FieldPath": "$.EffectiveStart",
        "OldValue": "3/30/2023 12:00:00 AM",
        "NewValue": "5/13/2023 12:00:00 AM"
      },
      {
        "FieldName": "EmployeeEmploymentStatus.BaseRate",
        "FieldPath": "$.BaseRate",
        "OldValue": "27.00000",
        "NewValue": "28"
      },
      {
        "FieldName": "EmployeeEmploymentStatus.BaseSalary",
        "FieldPath": "$.BaseSalary",
        "OldValue": "56160.00000",
        "NewValue": "58240"
      },
      {
        "FieldName": "EmployeeEmploymentStatus.EmploymentStatusReason.XRefCode",
        "FieldPath": "$.EmploymentStatusReason.XRefCode",
        "OldValue": "DISABLED",
        "NewValue": "Adjustment"
      }
    ]

Activate Changed field header

This feature can be enabled by setting client property "Enable Field Level Change Tracking for HR API Entities" to true.
This client property is only visible to Ceridian support role and you will need to contact support to activate it.

Changed field list generation logic

Changed field list will be generated when:

• An update was made to an existing HR entity record (i.e: change is made to EmployeeBase, WorkAssignment or EmploymentStatus, etc.)
• A new HR entity record was added to an employee’s profile (e.g., a new EmploymentStatus), and there is a previous record to compare against. This is only true in cases where the addition of the new record impacts the effective dating of a previous record.
  • If you add a new Role, and that role is not flagged as the employee’s default role, then the new entity record does not impact any previously entered Role record.
    • This will result in the event being generated without field changes noted in the Changed Field Header.
  • If you add a new EmploymentStatus, the employee’s previous EmploymentStatus will be automatically end-dated.
    • This will result in the relevant field changes being exposed to the Changed Field Header.