GetPlanInofrmation

Get Benefit Plan Information

Minor Business Rule

Object Name: N0800079

Parent DLL: CHRM

Location: Client/Server

Language: NER

Functional Description

Purpose


This NER determines if an entered Benefit Plan is found in F08320. If the Plan is not found, the NER 

returns an error code of '1'. If the record is found, the NER returns an error code of '0' and the 

information related to that plan.


Setup Notes and Prerequisites


Special Logic




Technical Specification


szPlanID - Required input field.


cErrorCode values are as follows:

0 = No Errors, Plan found.

1 = Error, Plan not found. 


Data Structure

D0800079 - Get Benefit Plan Information

Parameter NameData ItemData TypeReq/OptI/O/Both
szPlanIdPLANcharREQINPUT

An abbreviation or number that identifies a specific employee benefit. Examples are:   o  Employee Health Insurance   o  Accidental Death 
and Dismemberment   o  Health Club Expense Reimbursement   o  Employee Stock Appreciation Rights  A benefit plan typically is associated 
with a deduction, benefit, or accrual. For example, a medical plan is a benefit that might also require a deduction to withhold premiums from 
an employee's pay.

cErrorCodeEV01charOPTOUTPUT

An option that specifies the type of processing for an event.

szNameAlphaExplanationEXAcharOPTOUTPUT

A description, remark, explanation, name, or address.

szDescripCompressedDCcharOPTOUTPUT

The compressed description contains the alpha name without slashes, dashes, commas, and other special characters.  The compressed 
description is the field used in the Name Search.

mnAddressNumberPayeeANN8MATH_NUMERICOPTOUTPUT

The address book number for the supplier who receives the final payment. In Benefits administration, this is the address book number of the 
company that issues the plan and receives premium payments for it. For wage attachments, payee is the address book number of the 
agency, company, individual, or court that is to receive the payment of the check.

jdDateEffectiveRatesEFTJDEDATEOPTOUTPUT

The date that identifies when a date is first valid. The effective date is used generically. It can be a lease effective date, a price or cost 
effective date, a currency effective date, a tax rate effective date, or whatever is appropriate.

jdDateEndingEffectiveEFTEJDEDATEOPTOUTPUT

The date on which the item, transaction, or table becomes inactive, or through which you want transactions to appear. This field is used 
generically throughout the system. It could be a lease effective date, a price or cost effective date, a currency effective date, a tax rate effective 
date, or whatever is appropriate.

cStatCodeSTUScharOPTOUTPUT

A user defined code (system 08/type ST) that defines the current state of the benefit plan. For example, you can use A to define the plan as 
active.

szPlanTypePLTYcharOPTOUTPUT

A user defined code (system 08/type PT) that identifies the specific type of plan. For example, L can be used to identify a life insurance 
plan.

cBeneficiaryFlagBENFcharOPTOUTPUT

A code that indicates whether beneficiary information is required for employees participating in the plan or plan additional option. Valid 
codes are: Blank No dependent or beneficiary information is required   D Dependent information is required   B Beneficiary information is required

szCertificateNumberCERNcharOPTOUTPUT

The certificate or policy number of the benefit plan.

mnCoverageAmountCOVAMATH_NUMERICOPTOUTPUT

The dollar amount of coverage that this plan provides to every employee enrolled in the plan.

mnPremiumPaymentPREPMATH_NUMERICOPTOUTPUT

The premium payment amount that applies to this plan.

szVestingTableVTABcharOPTOUTPUT

A user defined code (table 06/VT) that identifies the table that applies to this plan.

mnDbaEmployeePercentEDBAMATH_NUMERICOPTOUTPUT

This is the employee percentage for the plan contribution. (50% = .50)

mnEmployeeDbaIdFDBAMATH_NUMERICOPTOUTPUT

The DBA defined in the Payroll Transactions Constants table (F069116) that is used to calculate the dollar amount that the employee 
contributes by enrolling in the plan. In most cases, this DBA is defined to deduct pay from the enrolled employee's check.

mnDbaEmployerPercentRDBAMATH_NUMERICOPTOUTPUT

The Employer Percentage for the plan contribution.

mnDbaEmployerIdSDBAMATH_NUMERICOPTOUTPUT

The DBA defined in the Payroll Transactions Constants table (F069116) that the system uses to calculate the dollar amount that the 
employer contributes to the employee enrolled in the plan. In most cases, this DBA is defined as a benefit to add pay to the enrolled employee's 
check.

cMandatoryParticipationMANPcharOPTOUTPUT

A code that tells indicates whether the plan is required for all employees. Valid codes are: Y Yes, all employees must participate in this plan. 
You should not use this code unless all employees are required to participate in the plan. N No, all employees are not required to 
participate in this plan.  It is optional.

mnPerCoverageDollarsPCDOMATH_NUMERICOPTOUTPUT

The amount of coverage that is paid for by the amount in the Monthly Premium field (data item PREP).  For example, a premium charge can 
be defined as thirty dollars for every thousand dollars of coverage.  In this case, the monthly premium is 30, and the number in the Per 
Coverage Dollars field is 1000.

mnSalaryFactorSALFMATH_NUMERICOPTOUTPUT

A multiplier (factor) that the system uses to calculate the amount of coverage provided to an employee, based on the employee's 
salary. For example, a salary factor of 2.0 indicates coverage for an employee in the amount of twice the employee's salary.

szBenefitDeductionTableDTABcharOPTOUTPUT

The table used if the calculation requires table values.

mnPayrollDedPointsPDDPMATH_NUMERICOPTOUTPUT

The DBA defined in the Payroll Transactions Constants file (F069116) that is used to calculate the points amount that the employee 
contributes by enrolling in the plan in a flexible spending environment. DBAs used for points in a benefit plan or option must meet two requirements: 1. 
  The DBA must have blanks in the specification for Gross Effect and Net Effect (see data items PAYG and PAYN) so that the use of 
(non-dollar) points does not add or subtract dollars from employee pay. 2.   The DBA must have an M in the specification for Journal Entry (Y/N/M) 
(see data item NMTH) so that the use of (non-dollar) points does not affect the G/L system.

mnPayrollCreditPointsPDCPMATH_NUMERICOPTOUTPUT

The DBA defined in the Payroll Transactions Constants table (F069116) that will be used to calculate the points amount that the employer 
contributes to an employee enrolled in a flexible spending environment. DBAs used for points in a benefit plan or option must meet two 
requirements: 1.   The DBA must have blanks in the specification for gross effect and net effect (see data items PAYG and PAYN) so that the use of 
(non-dollar) points does not add or subtract dollars from employee pay. 2.   The DBA must have an M in the specification for Journal Entry 
(Y/N/M) (see data item NMTH) so that the use of (non-dollar) points does not affect the G/L system.

cDeductPointsDolsYNDPYNcharOPTOUTPUT

A code that defines whether the combined deduction/benefit amount for this plan contributes to the enrolled employee's reimbursable 
spending account. The code also identifies whether the spending account is for medical or other types of expenses. Valid codes are:    0   Not part 
of a flex plan, not a spending account    1   Not part of a flex plan, a medical spending account    2   Not part of a flex plan, a spending account 
not for medical expenses    3   Part of a flex plan, not a spending account    4   Part of a flex plan, a medical spending account    5   Part of a 
flex plan, a spending account not for medical expenses

szVestingCalculationRuleVCRLcharOPTOUTPUT

A user defined code to describe the vesting calculation rule. Note:  This field is for future use.

szPtTableVestingHoursPTVHcharOPTOUTPUT

The pay type table used to calculate the hours worked for vesting service.

mnVestingMinHoursVSMHMATH_NUMERICOPTOUTPUT

The minimum number of hours required during a specified period of time to be eligible for a year of vesting service.

cVestingCompPerVCPEcharOPTOUTPUT

The computation period used to calculate if a person has fullfilled the minimum requirements to qualify for a year of vesting service.    C 
Calendar Year    P Plan Year    A Anniversary Year (The year beginning with the person's date of hire.)

szReportCodePlanMstr001PH01charOPTOUTPUT

A code you can define for reporting on benefit plans.  You can define this code using user defined code table 08/B1.

szReportCodePlanMstr002PH02charOPTOUTPUT

A code you can define for reporting on benefit plans.  You can define this code using user defined code table 08/B2.

szReportCodePlanMstr003PH03charOPTOUTPUT

A code you can define for reporting on benefit plans.  You can define this code using user defined code table 08/B3.

szReportCodePlanMstr004PH04charOPTOUTPUT

A code you can define for reporting on benefit plans.  You can define this code using user defined code table 08/B4.

szReportCodePlanMstr005PH05charOPTOUTPUT

A code you can define for reporting on benefit plans.  You can define this code using user defined code table 08/B5.

szReportCodePlanMstr006PH06charOPTOUTPUT

A code you can define for reporting on benefit plans.  You can define this code using user defined code table 08/B6.

szReportCodePlanMstr007PH07charOPTOUTPUT

A code you can define for reporting on benefit plans.  You can define this code using user defined code table 08/B7.

szReportCodePlanMstr008PH08charOPTOUTPUT

A code you can define for reporting on benefit plans.  You can define this code using user defined code table 08/B8.

szReportCodePlanMstr009PH09charOPTOUTPUT

A code you can define for reporting on benefit plans.  You can define this code using user defined code table 08/B9.

szReportCodePlanMstr010PH10charOPTOUTPUT

A code you can define for reporting on benefit plans. You can define this code using user defined code table 08/B0.

szEligibilityTable1XET1charOPTOUTPUT

The table used to specify the rules, if any, for the employee's initial enrollment in the plan. Even when a plan has no eligibility criteria, J. D. 
Edwards recommends that you set up a table, such as "None," for initial eligibility testing.

szEligibilityTable2XET2charOPTOUTPUT

A code used to specify the rules, if any, for an employee's continuing enrollment in the plan. Even when a plan has no eligibility criteria, J.D. 
Edwards recommends that you set up a table, such as None, for continuing eligibility testing.

cAmountOrRateYnEAORcharOPTOUTPUT

A code that indicates whether you can enter an amount or rate when you enroll an employee in a benefit plan. Typically, you enter Y (yes) 
when the employee determines the amount of a deduction or a benefit. Examples include 401(k) percentages, dependent care, and health 
care reimbursements.

cAgeRateFlagARFLcharOPTOUTPUT

A code that determines whether the employee's age/salary will be taken as the age/salary at enrollment time or the current 
age/salary. Allowed values are as follows:    Y Use the employee's age or salary corresponding to the date of enrollment.    N Use the employee's current 
age or salary each time the deduction is taken so an employee may have a new rate mid-year. This code is intended for use with plans that 
have amounts based on the employee's age or salary only.     ***  NOTE   *** This is a future feature for the JDE Benefits module.

szPrerequisitePlanPPLNcharOPTOUTPUT

The benefit plan, if any, in which the employee must be enrolled before the employee is eligible to participate in this plan.

mnMaximumPremiumMXPRMATH_NUMERICOPTOUTPUT

The maximum premium amount permitted.

mnRoundingAmountRNDAMATH_NUMERICOPTOUTPUT

The amount that the system uses to round the coverage dollars to the nearest whole number.  For example, if the coverage dollars are 
15,250 and you enter 1,000 in this field, the system rounds the coverage dollars to 16,000.

cTransferToCobraCBRAcharOPTOUTPUT

A code that specifies one of the following:   o  Whether the system should place an employee being terminated from the plan in COBRA   o  
Whether a benefit is also a COBRA plan Valid codes are: Y The plan is a COBRA plan. N The plan is not a COBRA plan. Note: If you enter Y in 
this field, you must define each DBA with the COBRA plan equivalent equal to 1. This field is found on DBA Additional Information. If you 
specify that this plan is a COBRA plan, then you must also turn on the Valid for COBRA option located on the US Leg/Reg form in the DBA setup.

szSecondary401kPlanPLN2charOPTOUTPUT

Secondary 401(k) Plan.

cFlexibleSpendingAcctFSAFcharOPTOUTPUT

A code that determines whether or not the combined deduction/benefit amount for this plan will contribute to the reimbursable spending 
account for an employee upon enrollment and identify whether the spending account is for medical or other type expenses.  Allowed values are:   
 0  Not a Spending Account    1  A MEDICAL Spending Account    2  A Spending Account but NOT for Medical Expenses

mnPayTypeForFlexibleSpendingPAYFMATH_NUMERICOPTOUTPUT

This is the Pay Type used when making reimbursements from the Flexible Spending Accounts. Note:  It is Critical that the Category Code 10 
for this Pay Type be set up correctly in order to process FSA claims.

cEePointsAllowanceForFLXAcharOPTOUTPUT

This flag is used to identify the EE Points that are given to the employee so they can "purchase" the benefits that they want. For instance, if a 
company gives each employee 200 points they would identify this by setting on the "Points Allowance" flag.  That way, when the employee  
"spends" 120 points for Medical Insurance, the system will know that the employee has only 80 points left to spend.

szPrerequisitePlanTypePLTZcharOPTOUTPUT

The Plan Type code which is a prerequisite for an employee to be eligible to enroll in this plan.

cFlagEmployeeEmployerEFL1charOPTOUTPUT

Indicate whether this DBA is an employee or employer contribution.

cFlagEmployeeEmployer2EFL2charOPTOUTPUT

Indicate whether this DBA is an employee or employer contribution.

cFlagEmployeeEmployer3EFL3charOPTOUTPUT

Indicate whether this DBA is an employee or employer contribution.

cFlagEmployeeEmployer4EFL4charOPTOUTPUT

Indicate whether this DBA is an employee or employer contribution.

cFlagPointsMoneyEFP1charOPTOUTPUT

Indicate whether this DBA represents a point value or a monetary value.

cFlagPointsMoney2EFP2charOPTOUTPUT

Indicate whether this DBA represents a point value or a monetary value.

cFlagPointsMoney3EFP3charOPTOUTPUT

Indicate whether this DBA represents a point value or a monetary value.

cFlagPointsMoney4EFP4charOPTOUTPUT

Indicate whether this DBA represents a point value or a monetary value.

cFlagRateEntryEFR1charOPTOUTPUT

A code that indicates whether you are allowed to enter an amount or rate during employee benefit enrollment. This code is used primarily 
when the employee has input into the amount to be used for a deduction or a benefit. Examples include 401(k) percentages, and dependent 
care and health care reimbursements.

cFlagRateEntry2EFR2charOPTOUTPUT

A code that indicates whether you are allowed to enter an amount or rate during employee benefit enrollment. This code is used primarily 
when the employee has input into the amount to be used for a deduction or a benefit. Examples include 401(k) percentages, and dependent 
care and health care reimbursements.

cFlagRateEntry3EFR3charOPTOUTPUT

A code that indicates whether you are allowed to enter an amount or rate during employee benefit enrollment. This code is used primarily 
when the employee has input into the amount to be used for a deduction or a benefit. Examples include 401(k) percentages, and dependent 
care and health care reimbursements.

cFlagRateEntry4EFR4charOPTOUTPUT

A code that indicates whether you are allowed to enter an amount or rate during employee benefit enrollment. This code is used primarily 
when the employee has input into the amount to be used for a deduction or a benefit. Examples include 401(k) percentages, and dependent 
care and health care reimbursements.

Related Functions

None

Related Tables

None