How do I add new input values to existing elements?

You can add new input values to an element using the HCM Data Loader, when the element has entry values already created or processed in the payroll run.

The new input values must meet the following criteria:

• Input value isn't required
• Default at runtime isn't enabled
• Default value isn't provided
• Default formula isn't attached
• Input value with the same name doesn't exist already for the same element

You can add multiple input values at once as long as it meets these guidelines.

When you create a new input value for an element using the PayrollElementDefinition HDL object, a new flow, Perform Post Processing of Element with task Create Element Entry Values will automatically assign this value to all element entries. After the entry values are created for all impacted employees, you can change the entry value.

During the entry creation process, if the Perform Post Processing of Element flow errors out for any reason, you can retry or resubmit the process to create the remaining entry values. You also have the option to rollback the process, which deletes all entry values. When you delete the entry values, you must also delete the input values that were created using HDL.

Validations are provided to ensure the input and entry values are created successfully. When the Perform Post Processing of Element process is running, or being rolled back, the following validations will be applied:

• The element will be locked for any modification.
• The Calculate Payroll, Adjust Multiple Balances, Calculate Gross Earning, Load Initial Balances, Reverse Payroll Calculation, and Recalculate Payroll for Retroactive Changes payroll processes will be blocked from running when the postprocessing of element is being run.
• The element will continue to be in locked status if the element postprocess is rolled back but newly created input values aren't deleted. During this time, the Calculate Payroll, Adjust Multiple Balances, Calculate Gross Earning, Load Initial Balances, Reverse Payroll Calculation, and Recalculate Payroll for Retroactive Changes payroll processes will error out till the newly created input values are deleted.
• The QuickPay submission and Retry process are prevented from submission.
• The input value can't be created while a payroll process is being run.

Note:

The payroll processes that are running beyond 3 days will be ignored while doing the above validation check.

This feature isn't intended to upgrade the existing elements with any other objects, such as upgrading the element that was created using the HR or Payroll Interface license to an element to use in Payroll processing with Payroll license. It's only for adding new input values when the above conditions are met.

Consider when's the best time to create any new input values, to avoid the impact on your payroll cycle, such as overnight or weekend. Ensure that the add new input value functionality isn't planned to be run when any of the above payroll processes are running, waiting, or planned to be run, as it will impact the regular payroll cycle.

Some key points to note:

• Input values and their associated entry values won't be rolled back if run results are created for the element after adding the new input value.

• When an input value is deleted from an element, the corresponding element eligibility input value will also be deleted automatically, provided it isn't referenced in balance definitions, status processing rules, or other associated definitions.

• The Run Feature Upgrade process includes functionality to unlock elements under specific scenarios, based on the element name provided through the Additional Details parameter:

  • If the postprocess is rolled back but input values haven't been deleted through the HCM Data Loader (HDL), resulting in a locked element, you can use this feature as an alternative to HDL.

  • If a rollback fails and leaves the element locked, the process can now delete entry values and the newly created input values to resolve the locked status.

  • If an element is locked due to orphaned data for a newly added input value, this process can identify and address the issue.

• When rolling back postprocessing for an element with no existing entries and a new input value added, the element won't be locked if there are no entry values.

• Adding a new input value to an element without existing entries won't lock the element.