The Entitlement Process

The primary job of the Entitlement process is to resolve entitlement elements. The process begins when the Process List Manager encounters the entitlement element on the Process List as it processes a payee. The process contains four steps:

  1. Get entitlement rule definition.

    1. Get the definition of the entitlement element.

    2. Overlay the entitlement definition with the payee override, if any.

    3. Overlay the entitlement definition with positive input, if any.

    4. If the payee override is required, but no override or positive input exists, exit the program.

  2. Resolve frequency-based entitlement.

    1. Check generation control for entitlement.

    2. If generation control exists, call the Generation Control program. If the program says not to process the entitlement element or the adjustment element, exit the program.

    3. If generation control is not entered, or if the condition is met, call the PIN Manager to resolve the entitlement.

    4. If the entitlement frequency differs from the pay period frequency, convert the entitlement units.

  3. Resolve adjustment, if applicable.

    1. If generation control says to process the adjustment, call the PIN Manager to resolve the adjustment element and pay off units element.

    2. If the pay off units element does not equal 0, add the pay off earning element and units to positive input.

  4. Update results.

    1. Set the return code to PIN Manager.

    2. Add the entitlement element and units to the PIN Manager return list, if calculated.

    3. Add the adjustment element and units to the PIN Manager return list, if calculated.