AvailablePlansEnrollmentCache

Available Plans Enrollment Cache

Minor Business Rule

Object Name: B0800285

Parent DLL: CHRM

Location: Client/Server

Language: C

Data Structure

D0800285 - Available Plans Enrollment Cache

Parameter NameData ItemData TypeReq/OptI/O/Both
mnJobnumberAJOBSMATH_NUMERICREQINPUT

The job number (work station ID) which executed the particular job.

szCacheActionCodeCACTNcharREQINPUT

A code that indicates the activity you want to perform. Valid codes:     o Get - Retrieve the cache element     o Add - Add a cache element     o 
Update - Update a cache element     o Delete - Delete a cache element     o Delete All - Delete all cache elements     o Get Next - Retrieve the 
next cache element     o Add/Update - Add a cache element if it does not exist; Update a cache element if it does exist     o Terminate - 
Terminate Cache

idCacheCursorGENLNGIDREQBOTH

General purpose ID variable.

mnIndexIDNKEYSMATH_NUMERICOPTINPUT

The number of keys in an index that will be used to retrieve, delete, or update a record.

mnNumberKeysNKEYSMATH_NUMERICOPTINPUT

The number of keys in an index that will be used to retrieve, delete, or update a record.

cSuppressErrorMessageSUPPScharOPTINPUT

A flag indicating whether or not runtime error messaging will occur when an error message is issued from a business function.        0 = allow 
runtime error message handling.        1 = suppress runtime error message handling.

szCacheNamePIDcharREQINPUT

The number that identifies the batch or interactive program (batch or interactive object). For example, the number of the Sales Order Entry 
interactive program is P4210, and the number of the Print Invoices batch process report is R42565. The program ID is a variable length value. 
It is assigned according to a structured syntax in the form TSSXXX, where: T The first character of the number is alphabetic and identifies the 
type, such as P for Program, R for Report, and so on. For example, the value P in the number P4210 indicates that the object is a 
program. SS The second and third characters of the number are numeric and identify the system code. For example, the value 42 in the number P4210 
indicates that this program belongs to system 42, which is the Sales Order Processing system. XXX The remaining characters of the numer are 
numeric and identify a unique program or report. For example, the value 10 in the number P4210 indicates that this is the Sales Order Entry 
program.

szErrorMessageIDDTAIcharOPTOUTPUT

A code that identifies and defines a unit of information. It is an alphanumeric code up to 8 characters long that does not allow blanks or 
special characters such as %, &, or +. You create new data items using system codes 55-59. You cannot change the alias.

mnEnrollmentEventTypeEVETMATH_NUMERICOPTNONE

A field that indicates the event during which the enrollment occurs. Valid values include:    1   Open Enrollment    2   Enrollment for current plan 
year

mnAddressNumberAN8MATH_NUMERICOPTNONE

A number that identifies an entry in the Address Book system, such as employee, applicant, participant, customer, supplier, tenant, or 
location.

szBenefitGroupCategorySBGRcharOPTNONE

The category of a benefit group. The category is used to group benefit plans according to the type and/or rule. For 
example: MEDICAL Required Medical Selections   DENTAL Optional Dental Selections   LIFE Required Life Ins Selections Valid categories are set up in the Generic 
Rate and Message table (F00191) for system 08/type SG. Associated text for categories is stored in the General Message Detail table 
(F00192). For more information, see program P00191.

szCategoryDescriptionDL01charOPTNONE

A user defined name or remark.

szPlanIdPLANcharOPTNONE

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.

szPlanAdditionalOptionAOPTcharOPTNONE

A code that identifies any additional options available for a benefit plan that have been defined in the Plan Additional Options table 
(F083202). Note: Additional options must have the same provider, policy number, and enrollment and eligibility rules as the benefit plan to which they 
are associated.

mnSequenceNumberViewSEQ#MATH_NUMERICOPTNONE

A number used to sequence information for review purposes only.

cDepBenDBENcharOPTNONE

A code that indicates whether the person is a dependent or a beneficiary of the employee. Valid codes are: D The person is a 
dependent. B The person is a beneficiary.    Blank The system automatically designates the person as a beneficiary or dependent, depending on the 
benefit plan type.

mnTrackPCPNumberFlagPCPFMATH_NUMERICOPTNONE

An option that specifies whether the benefit plan or benefit plan option tracks primary care physician numbers. If you choose this option, 
then the system displays a form during the enrollment process for an employee to enter the number for a primary care physician.

cAmountOrRateYnEAORcharOPTNONE

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.

mnEmployeeDeductionDBAFDBAMATH_NUMERICOPTNONE

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.

mnEmployerCostDBASDBAMATH_NUMERICOPTNONE

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.

mnEEFlexCostDBAPDDPMATH_NUMERICOPTNONE

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.

mnERFlexCreditDBAPDCPMATH_NUMERICOPTNONE

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.

mnPlanCostPCOSMATH_NUMERICOPTNONE

The cost that the system calculates for a plan or plan option.

mnEmployeeFlexCostEEFCMATH_NUMERICOPTNONE

The amount of flex credits given to an employee by the employer when the employee chooses the benefit plan.

mnPlanCreditPCREMATH_NUMERICOPTNONE

The credit that the system calculates for a plan or plan option.

mnDeductionAmtRateDRTMMATH_NUMERICOPTNONE

The value of this field is either a percentage, a dollar amount or an hourly rate depending upon where it is being used;    A When used in 
conjunction with a Deduction, Benefit or Accrual Type this field may represent many of the above values depending upon the value of the D/B/A 
method code (DEDM).

mnBenefitAmtRateBRTMMATH_NUMERICOPTNONE

The value of this field is either a percentage, a dollar amount or an hourly rate depending upon where it is being used. When used in 
conjunction with a Deduction, Benefit or Accrual Type this field may represent many of the above values depending upon the value of the D/B/A 
method code (DEDM).

jdDateEffectiveRatesEFTJDEDATEOPTNONE

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.

jdDateEndingEffectiveEFTEJDEDATEOPTNONE

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.

cMandatoryParticipationMANPcharOPTNONE

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.

cDefaultPlanXDFPcharOPTNONE

A code that specifies if the plan is a default plan in the category. An employee is automatically enrolled in this plan if no other plans within 
the category are selected. Valid codes are: Y Yes, this is a default plan. N No, this is not a default plan.

mnMinNumOfDepMINDEPMATH_NUMERICOPTNONE

The minimum number of people that can be covered under a specific plan or plan option. This number includes the employee. For 
example, if the plan allows an employee plus one dependent, then the minimum number is 2.

mnMaximumNumberofDependentsMXDPMATH_NUMERICOPTNONE

This variable denotes the maximum number of dependents that may be enrolled in a benefit plan.

cSelection001SL01charOPTNONE

A code used to prompt detail selection from a list of items. Typically, the legitimate selection codes are explained at the bottom of the 
screen of the video display. If not, see the program help instructions.

szEnrollmentEventCodeEECDcharOPTNONE

The user defined code (08/BE) that you use to denote an enrollment event such as marriage.

cCategoryTypeCATYcharOPTNONE

A code that identifies categories for DBAs that use special flex calculation plans, such as lump sum employer flex credits and employee 
flex deductions when remaining flex credits are negative.

szESignatureESIGNcharOPTNONE

A code that identifies an electronic signature that the system assigns when an employee approves of an action in a self-service process.

mnCategorySequenceNumberSEQNMATH_NUMERICOPTNONE

A number used to organize the table into a logical group for online viewing and reporting.

cDefaultingAllowedFlagDEFFLGcharOPTNONE

A code that specifies whether the system automatically displays a benefit plan or benefit plan option as the chosen plan, based on prior 
enrollment.

szPlanGroupingCodePLNGRPcharOPTNONE

An option that allows the user to designate which benefit plans or benefit plan options are related, based on a provider or other criteria.

cNonParticipatingPlanFlagNPPLFLcharOPTNONE

A code that specifies whether an employee can elect to decline participation in the benefit plan.

szShortPlanOptionDescSPLDEScharOPTNONE

A short description (up to 15 characters) of the benefit plan or benefit plan option.

szShortCategoryDescriptionSCTDEScharOPTNONE

A short description (up to 15 characters) of the benefit category.

szBenefitCategoryClassificBCATCLcharOPTNONE

A code that designates benefit categories that are grouped together.

cDeclineCoverageNotifyFlagDCNFcharOPTNONE

A code that the system uses to indicate that the benefit administrator needs to be notified when an employee elects to decline benefit 
coverage.

szPlanOrOptionDescriptionDS50charOPTNONE

A descriptive statement of up to 50 characters in length.

cChangeBeneficiaryEV01charOPTNONE

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

mnDescendingCategorySeqNumSEQNMATH_NUMERICOPTNONE

A number used to organize the table into a logical group for online viewing and reporting.

mnDescendingPlanSeqNumSEQ#MATH_NUMERICOPTNONE

A number used to sequence information for review purposes only.

mnDescendingCategoryClassNKEYSMATH_NUMERICOPTNONE

The number of keys in an index that will be used to retrieve, delete, or update a record.

cGenericFlagEV01charOPTNONE

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

cAutomaticDefaultofCurrentADCEcharOPTNONE

Use this field to specify whether the system should automatically default to the current enrollment. Valid values are:    0   Do not allow 
previous coverage to default as the new coverage    1   Allow previous coverage to default as the new coverage

cAllowBenChangesOnlyABENCOcharOPTNONE

A code that designates whether the only changes that you can make to plans within a benefit category are changes to the beneficiary 
information.

cAllowedPlanOptionEV01charOPTNONE

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

szPrimaryCarePhysicianNumbPCP#charOPTNONE

A code that identifies the employee's or dependent's Primary Care Physician (PCP).

cGenericFlag1EV01charOPTNONE

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

cGenericFlag2EV01charOPTNONE

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

cGenericFlag3EV01charOPTNONE

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

mnNumberOfDependentsMATH01MATH_NUMERICOPTNONE

- - - Good Performance Low Value. 

cActiveFlagEV01charOPTNONE

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

cPCPVisitedPCPVSTcharOPTNONE

An option that indicates whether an employee has previously visited the primary care physician. Valid values are: 0 No 1 Yes

cMustStayInPlanGroupingSIPGcharOPTNONE

This code that identifies what plans an employee can elect during a life event change. Valid values are: 0 An employee can enroll in any 
other valid benefit plan or benefit plan option in the same benefit category. 1 An employee can enroll in a valid benefit plan and benefit plan 
option within the same plan grouping code (PLNGRP) as the benefit plan in which he or she is currently enrolled.

cNewEnrollEV01charOPTNONE

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

mnERCostRTAMMATH_NUMERICOPTNONE

A value that is a percentage, a monetary amount, or an hourly rate, depending on where it is used.  Valid values are: 1 For a deduction, 
benefit, or accrual, the meaning of this value depends on the method of calculation.  The method determines whether the deduction is a flat 
monetary amount, a percentage, or a multiplication rate.  Table method DBAs, depending on which table method they use, can either use this 
amount in the calculation or ignore it.  If there are exceptions to the table calculation, you can override the table code in the detail area, set up a 
flat monetary DBA amount, or override the amount with a one-time override for a timecard. 2 For a pay type, amounts entered in this field 
override the hourly rate. 

szPlanTypePLTYcharOPTNONE

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.

Related Functions

B0000580 Convert String to Math Numeric
N0800074 Determine Open Benefit Category

Related Tables

F085520W Available Plans and Plan Options by Employee Work Table