Skip to main content
Skip table of contents

Benefit Definitions - HRTBBE

The Human Resources (HR) Benefit Definitions (HRTBBE) page is used to create benefit codes and plans and then group those plans into benefit packages.

Entity: Indicates the Entity ID to identify security clearance. Codes are defined in the HR Entity Codes (HRRQEN) page.

Benefit Definition Tab

Benefit plans are created on the Benefit Definition tab. The benefit plans are then available for employee assignment on the HR Benefit Assignments (HRPYBE) page. When a benefit plan is assigned to an employee, the system accesses this table to retrieve important information, which allows the employee to receive the correct benefit amounts and coverage. The Benefit Codes tab, Payroll (PY) Contribution Master (PYUPCC) page, and PY Deduction Master (PYUPDD) page must be completed before setting up records here. On Benefit Assignment pages, benefit definition information automatically populates when re-entering an existing benefit with a new date range. The entry with the most recent end date will be used to populate the new entry automatically. This is triggered before entering the effective begin date. Any of the automatically populated values may be overridden.

One benefit definition may exist per date range, with no overlapping dates. A record is unique by benefit plan, begin and end dates.  

Plan Details

Code: Indicates the benefit code. Benefit codes typically refer to the kind of plan being entered. For example, MED (medical), BCMD (Blue Cross Medical), KSCN (Kaiser Cancer Care), CAN (Cancer Insurance), etc. Codes are defined in the Benefit Codes tab.

Type: Indicates the benefit type. Benefit type codes typically refer to the type of coverage. For example, AF (after tax), FL (flex), PT (pretax), etc. The field may contain NA as payroll setup determines how to process the various types of benefits based on CDH number. Codes are defined in the HR Entity Specific Codes (HRTBCE) page, Entity Specific Codes tab under the Code ID of BENEFIT_TYPE.

Category: Indicates the benefit category. Benefit categories typically refer to the amount of coverage or quantity of coverage. For example, EO-Employee Only, L1-Life Insurance, etc. Codes are defined in the HR Entity Specific Codes (HRTBCE) page, Entity Specific Codes tab under the Code ID of BENEFIT_CATEGORY.

Plan: The benefit plan is system derived. The plan is created by the concatenation of the benefit code, benefit type and benefit category (one of which must be present). The benefit plan is the key/code used for Benefit Assignments and elsewhere in the HR system.

Short Desc: Indicates a short description. The description may appear on reports and/or screens.

Long Desc: Indicates a long description. The description may appear on reports and/or screens.

Effective Begin/End Dt: The begin and end dates of the benefit plan record.

Sort: Indicates the benefit sort code for use primarily on the HR Benefit Assignments page. Plans will be listed together by sort code. For example, all medical plans together, all dental plans together, all vision plans together, etc. Codes are defined in the HR Non-Entity Specific Codes (HRTBHR) page under the Code ID of BENEFIT_SORT. 

Calc Cd: Indicates the calculation code to be used when the benefit plan is assigned to an employee. Codes are predefined in the system and not available for modification. 

Employer & Employee/Employer

Cont and Ded CDH: Indicates the contribution and/or deduction number associated with the amount/premium. Codes are defined in the PY CDH definitions (PYUPCC or PYUPDD) page where Relate Code #8 contains BENC or BMSC for contributions, BEND or BMSC for deductions. An entry is only required if there is an associated amount greater than 0.00000. BMSC is primarily only useful for Employee Online items where a benefit is set up here but its destination after processing through Employee Online is HRPYCA (hr_cdhassgn table).

Cont and Ded St: Indicates the contribution and/or deduction status. Codes are defined in the HR Non-Entity Specific Codes (HRTBHR) page under the Code ID of CONT/DEDUC_STAT.

Cont and Ded Amt: Indicates the contribution and/or deduction amount/premium. A contribution and/or deduction number must exist if an amount greater than 0.00000 is entered. 

Cont andDed Axp: Indicates how the contribution and/or deduction amount is expressed. Codes are predefined in the system and not available for modification.

Cont andDed Fq: Indicates the frequency or the type of payroll for which the benefit assignment will be effective. If frequency will not be used, enter an A. Codes are defined in the HR Non-Entity Specific Codes (HRTBHR) page under the Code ID of FREQ/PY_TYPE.

EE and EE/ER Box: Indicates the box number or number of months for which the benefit assignment will be effective. If box number will not be used, leave blank. 

Cont and Ded Code1-4: Special codes are used for various purposes, are mostly client defined, and based on payroll setup. If the default flag on the HR System Set Up (HRRQSS) page, Generic Info tab, indicates special code 4 is to be system derived, it will indicate the record's update status; otherwise, the field may be updated manually and contain any character(s). 

Cont and Dec Lmt: Indicates a contribution and/or deduction limit amount. 

Cont and Ded Lxp: Indicates how the limit is expressed. Codes are predefined in the system and not available for modification.

Other Information

Total: System derived based on the contribution and deduction amounts. 

Vendor: Indicates the vendor associated with the entry. Codes are defined in the HR Vendor Codes (HRTBVE) page. Updates payroll CDH assignment, Vendor ID. 

Cap/Amt/Cov 1: Indicates cap, range amount or total coverage values. These may be used with certain calculation codes or may be used to track specific range values. Referred to as Cov 1 in calculation methods. 

Cap/Amt/Cov 2: Indicates cap, range amount or total coverage values. These may be used with certain calculation codes or may be used to track specific range values. Referred to as Cov 2 in calculation methods. 

Group: Indicates the group number. Codes are defined in the HR Entity Specific Codes (HRTBCE) page under the Code ID of BENEFIT_GROUP. 

Sub-Group: Indicates the sub-group number. Codes are defined in the HR Entity Specific Codes (HRTBCE) page under the Code ID of BENEFIT_SUBGROUP.

Age: Indicates the maximum benefit age for benefit eligibility. System derived from HR Benefit Codes but may be overwritten.

Gender: Indicates whether the benefit plan is associated with a particular gender code. Codes are defined in the HR Non-Entity Specific Codes (HRTBHR) page under the Code ID of GENDER_CODE.

Dt Calc: Indicates if the benefit plan requires any special date calculations. For example, if the benefit plan is to begin one month after the base benefit date (as assigned on the HR Benefits Assignment (HRPYBE) page, Benefit Master tab), select code value 1. Codes are predefined in the system and not available for modification. 

Status Information

Action: Indicates the action/purpose for entering or modifying a record. Codes are defined in the HR Non-Entity Specific Codes (HRTBHR) page under the Code ID of ACTION_CODE. 

Notes: Indicates any associated notes.

User ID: Displays the user's ID who last updated the record.

Updated: Displays the date and time of the last update to the record.

Calculation Code Options

CP: Cap Versus Rate Calculation
This is a special calculation for less than 1.00000 FTE. Step one, take the deduction amount/premium and multiply it by (1- Benefit FTE), as assigned on the HR Benefits Assignment (HRPYBE) page, Benefit Master tab. Next, take the contribution amount/premium and subtract this newly computed deduction portion. Take the contribution amount/premium and multiply it by (1.00000 – Benefit FTE). Take the deduction amount/premium and subtract the newly calculated value (contribution amount/premium – Cov 1). Take the calculated contribution amount/premium and multiply it by the assigned Benefit FTE. If the contribution amount/premium is greater than the value found in Cov1 (benefit plan cost/cap), let the contribution amount/premium equal the amount found in Cov1.

FA: Employer * Bene FTE (Difference to Employee).
Retrieve the HRTBBE Contribution and Contribution/Deduction amounts. Employer/Contribution amount = HRTBBE Contribution amount * Benefit FTE. Employee/Deduction amount (C/D) = HRTBBE Total Amount - New Contribution amount.

  • No calculations will occur if the Benefit FTE is >= 1.00000.

  • No calculations will occur if an original amount = 0.

FC: Employer – Computed Employee

  • If Benefit FTE is less than 1:

    • Deduction = Employee amount * (1 – Benefit FTE).

    • Contribution = Employer amount – Employee amount.

  • If Benefit FTE is greater than or equal to 1:

    • Deduction = 0. Contribution = Employer amount

FE: Flex (No Calculations Performed)
User Entered Flex Value (No Calculations Performed). Allow the user to enter the contribution and deduction amounts into the fields on the HR Benefit Assignments (HRPYBE) page manually.

FF: Flat Amts * Bene FTE
Amount * Benefit FTE. Retrieve the HRTBBE Employer/Contribution and Employee/Deduction amounts. Multiply each value by the Benefit FTE to get the new value.

  • No calculations will occur if the Benefit FTE is >= 1.00000.

  • No calculations will occur if an original amount = 0.

FL: Flat Rate
Bring in the Flat Rate (No Calculations Performed). Retrieve the HRTBBE Employer/Contribution and Employee/Deduction amounts and display them to the HR Benefit Assignments (HRPYBE) page.

FS: Flat Amts * Bene Salary
Amount (% or $) * Benefit Salary. Retrieve the deduction and contribution amounts and multiply them by the Benefit Salary (remember Benefit Salary is a frozen value and may represent a rate) as assigned on the HR Benefits Assignment (HRPYBE) page, Benefit Master tab. Benefit Salary must be greater than zero. Special codes are used to indicate whether amount is a percentage or dollar figure.

FW Flat Amts * (Bene Salary / Cov1)
Amount (% or $) * (Benefit Salary / Cov 1). Retrieve the deduction and contribution amounts and multiply them by the Benefit Salary / Cov1 (remember Benefit Salary is a frozen value and may represent a rate) as assigned on the HR Benefits Assignment (HRPYBE) page, Benefit Master tab. COV1 is client defined. Special codes are used to indicate whether amount is a percentage or dollar figure.

FX: Flat Amts * Bene FTE * (Bene Sal/Cov1)
Amount (% or $) * Benefit FTE * (Benefit Salary / Cov1). Retrieve the deduction and contribution amounts and multiply them by the Benefit FTE, as assigned on the HR Benefits Assignment (HRPYBE) page, Benefit Master tab, then multiply by the value found in Cov 1 divided by Benefit Salary. Special codes are used to indicate whether amount is a percentage or dollar figure.

FZ: Flat Amts * Bene FTE * Bene Salary
Amount (% or $) * Benefit FTE * Benefit Salary. Retrieve the deduction and contribution amounts and multiply them by the Benefit FTE and Benefit Salary (remember Benefit Salary is a frozen value and may represent a rate) as assigned on the HR Benefits Assignment (HRPYBE) page, Benefit Master tab. Benefit FTE and Benefit Salary must be greater than zero. Special codes are used to indicate whether amount is a percentage or dollar figure.

LT: Flat Amts * Bene Sal (Max Salary = Cov2)
Benefit Salary * Amount (max salary = Cov2). This code multiplies the salary amount by the value in the contribution and/or deduction amount fields.

MN: Manually Enter the Value
Manually Enter the Benefit Value (No Calculations Performed). Common code PYHR/BENE_MN is used to set the Override checkbox on the HR Benefit Assignments (HRPYBE) page to be selected. The amount fields can be edited. Without the common code, the amount fields cannot be edited and the user must select the checkbox.

PC: Percentage Rate
Bring in the Percentage Value (No Calculations Performed). Retrieve the deduction and contribution amounts and display them to the HR Benefit Assignments (HRPYBE) page. No data manipulation is necessary. Send a P to the first special code on the PY Employee CDH Assignment (PYUPEC) page.

PF: Percent * Bene FTE
Percentage * Benefit FTE Retrieve the HRTBBE Employer/Contribution and Employee/Deduction amounts. Multiply each value by the Benefit FTE. HRTBBE needs to include a P (indicating Percent) in a special code which is sent to the PY Employee CDH Assignment (PYUPEC) page.

  • No calculation will occur if the Benefit FTE is >= 1.00000.

  • No calculation will occur if an original amount = 0.

PS: Percent * Bene Salary
Bring in Percentage * Benefit Salary. Retrieve the deduction and contribution percentages and multiply them by the Benefit Salary (remember Benefit Salary is a frozen value and may represent a rate) as assigned on the HR Benefits Assignment (HRPYBE) page, Benefit Master tab. Benefit Salary must be greater than zero. Send a P to the first special code on the PY Employee CDH Assignment (PYUPEC) page.

PT: Percent * Bene Sal (Max Sal = Cov2)
Percentage * Benefit Salary (max salary = Cov2). Multiply the contribution percentage by the salary amount. The Max Salary (COV2) is client defined.

PW: Percent * (Benefit Salary / Cov1)
Bring in the Percentage * (Benefit Salary / Cov1). Retrieve the deduction and contribution amounts and multiply them by the Benefit Salary / Cov1 (remember Benefit Salary is a frozen value and may represent a rate) as assigned on the HR Benefits Assignment (HRPYBE) page, Benefit Master tab. Send a P to the first special code on the PY Employee CDH Assignment (PYUPEC) page.

PX: Percent * Bene FTE * (Bene Sal/Cov1)
Bring in Percentage * Benefit FTE * (Benefit Salary / Cov 1). Retrieve the deduction and contribution amounts and multiply them by the Benefit FTE, as assigned on the HR Benefits Assignment (HRPYBE) page, Benefit Master tab, and multiply by the value found in Cov1 as assigned on this tab divided by the Benefit Salary. Send a P to the first special code on the PY Employee CDH Assignment (PYUPEC) page.

PY: Calculate Benefit in Payroll
Let PY Calculate the Benefit (No Calculations performed). Retrieve the deduction and contribution amounts and display them to the HR Benefit Assignments (HRPYBE) page. No data manipulation is necessary. Code should be used for all benefit plans that are based on a percentage of employee salary and for any other types of benefit plans where the contribution or deduction value is obtained from a calculation performed in PY.

PZ: Percent * Bene FTE * Bene Salary
Bring in the Percentage * Benefit FTE * Benefit Salary. Retrieve the deduction and contribution amounts and multiply them by the Benefit FTE and Benefit Salary (remember Benefit Salary is a frozen value and may represent a rate) as assigned on the HR Benefits Assignment (HRPYBE) page, Benefit Master tab. Benefit FTE and Benefit Salary must be greater than zero. Send a P to the first special code on the PY Employee CDH Assignment (PYUPEC) page.

Package Definition

The Package Definition tab allows benefit packages to be created, and benefit plans to be associated with those packages. The benefit plans must have previously been defined on the Benefit Definition tab in order to be assigned here. When a benefit package is assigned to an employee, the employee will automatically receive all benefit plans contained in the package. After the assignment is made, additions, deletions, or modifications may be made to the employee records on the HR Benefits Assignment (HRPYBE) page, Benefit Master tab, depending upon the modification circumstances.

Benefit Pkg Cd: Indicates the benefit package code. It is generally used to group certain employees into set benefit structures.

Screen Filter: Indicates if the benefit package is specific to an employee (BENEMSTR or Benefit Master tab on the HR Benefit Assignment (HRPYBE) page), to the dependents only (FAMILY or Family tab on Benefit Assignment (HRPYBE) page) or to All. The Screen Filter controls the pick-list received on other screens. Codes are predefined in the system and not available for modification. 

As of Dt: The As of Dt is used as a filter for the benefit plan listing. Only those benefits with begin dates less than or equal to the As of Dt and end dates greater than or equal to the As of Dt will be available for selection. The date will default to the current date.

Package End Dt: This field is used to end date a benefit package and prevent it from being displayed in the Benefit Package selection list on the HR Benefits Assignment (HRPYBE) page, Benefit Master tab. Only packages with an End Date that is blank or greater than the HR Benefit Master tab's End Date will appear in the selection list. 

Short Desc: Indicates a short description. The description may appear on reports and/or screens.

Long Desc: Indicates a long description. The description may appear on reports and/or screens.

Benefit Plans Associated With the Package

This sub-tab is used to associate benefit plans to a particular package. Plans may be associated with a package either during the package creation or at any other time.

Plan: Indicates all benefit plans associated with the benefit package. All benefit plans will be assigned to an employee, based on the package, from the HR Benefits Assignment (HRPYBE) page, Benefit Master tab. Codes are defined in the HR Benefit Definitions (HRTBBE) page, Benefit Codes tab.

Status Information

Notes: Indicates any associated notes. 

User ID: Displays the user's ID who last updated the record. 

Updated: Displays the date and time of the last update to the record.

Benefit Codes

Benefit Codes are used as part of the benefit plan name.

Code Details

Benefit Code: Indicates the benefit code for use on the Benefit Definition tab. Benefit codes typically refer to the kind of plan being entered, for example MED (medical), BNMD (Blue Cross Medical), KSCN (Kaiser Cancer Care), CAN (Cancer Insurance), etc. 

Maximum Benefit Age: Indicates if there is a benefit age maximum for the code. For example, after 25 years of age dependents are not allowed to be on a particular benefit code. 

Short Description: Indicates a short description. The description may appear on reports and/or screens. 

Long Description: Indicates a long description. The description may appear on reports and/or screens. 

Status Information

Notes: Indicates any associated notes.

User ID: Displays the user's ID who last updated the record.

Updated: Displays the date and time of the last update to the record.

Tools

Copy Existing Benefit Definition

The Copy Existing Benefit Definition tool will copy an existing benefit. Minimally, a new begin date must be entered. After pressing enter the end date of the previous record will be updated to one day prior to the new record's begin date.
Processing steps:

  1. Select an existing record.

  2. Switch to Add Mode.

  3. Enter the matching Code, Type and Category.

  4. Click on the tool. A message appears at the top of the screen: Copy Existing Benefit Definition completed successfully.

  5. Make changes to the new record including a new begin date.

  6. Press Enter/Save.

  7. Refresh the screen and find the records matching the just-entered Code, Type, and Category. The new record will contain the newly entered dates and the previous record will have the correct end date.



JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.