Disable New Elections

XML Forms Guide

Version
R2024.1.1
Disable New Elections

Before You Begin: The configuration below doesn't limit which deductions are displayed in the Deduction Code drop-down list of forms. This must be defined separately. See Define Available Deductions.

In payroll election request forms, you can enable optional validation that only allows users to submit a form if they select a deduction or earning that they have an active payroll election for. For example, if this validation is enabled, a user can only submit the form if they select an existing deduction or earning, in which case they can update the deduction or earning amount.

Note: This validation should always be enabled for payroll election cancellation forms, so that users can cancel only deductions or earnings that are active in their payroll elections.

This validation is performed by a field in the form that isn't visible to users submitting the form. In this field, the <InitialValue> tag can be set to True to enforce this validation or False not to enforce it. When set to False, users can submit the form with any deduction that they select from the Deduction Code drop-down list:

Copy
<Field>
    <Style>IVCheckBox</Style>
    <BindingProperty>EmployeeDeduction.DisableNewElection</BindingProperty>
    <IsRequired>False</IsRequired>
    <Visible>False</Visible>
    <InitialValue>False</InitialValue>
</Field>

This field is included in the following code examples, where it’s disabled for the payroll election request form and enabled for the payroll election cancellation form: