EmployeePlanReportCache

Employee Plan Report Cache

Minor Business Rule

Object Name: B0800840

Parent DLL: CHRM

Location: Client/Server

Language: C

Data Structure

D0800840 - Employee Report 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_NUMERICREQINPUT

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

mnNumberKeysNKEYSMATH_NUMERICREQINPUT

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

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.

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.

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.

szBenefitGroupCategorySBGRcharOPTBOTH

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.

szPlanIdPLANcharOPTBOTH

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.

szPlanAdditionalOptionAOPTcharOPTBOTH

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.

jdEffectiveDateEFTJDEDATEOPTBOTH

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.

szPlanDescriptionDS50charOPTBOTH

A descriptive statement of up to 50 characters in length.

szEnrollmentStatusBeginXDFScharOPTBOTH

A code that indicates the status of an employee's enrollment in a plan. It is a user defined code (08/ES), and you must use the following 
restrictions for the definitions:   o  All statuses indicating active participation in a plan must begin with the letter A.   o  All statuses indicating an 
ending status that does not result in a new enrollment (such as a termination) must have the letter X in the first position of Description 2 (data item 
DL02), General User Defined Codes form.   o  A status beginning with the letter X, when used as an ending status, represents a mistaken 
enrollment. No employee DBA instructions are written.   o  An asterisk (*) indicates all statuses not otherwise specified.

szEnrollmentStatusEndingXESTcharOPTBOTH

A code that indicates the ending status of an employee's enrollment in a plan. This status represents the reason for ending the old 
enrollment and is used as the beginning status of any resulting new enrollment. You can define this code using user defined code table 08/ES. See 
data item XDFS (Status - Enrollment) for restrictions on the allowed values. Note: An ending status that begins with the letter X represents a 
mistaken enrollment.

jdEndEnrollmentDateEFTEJDEDATEOPTBOTH

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.

jdBeginDBADateDTDBJDEDATEOPTBOTH

The beginning date on the employee's DBA instruction record (F06106) for this enrollment. In most cases, this is the same as the beginning 
effective date of the enrollment. However, it can be later than the beginning effective date if the enrollment is changed retroactively. Only 
active enrollment records have a value in this field since they are the only enrollment records that result in payroll deductions, benefits, or 
accruals. Active records have a beginning status that starts with A.

jdEndDBADateDTDEJDEDATEOPTBOTH

The ending date on the employee's DBA instruction record (F06106) for this enrollment. In most cases, this is the same as the ending 
effective date of the enrollment. However, it can be later than the ending effective date if the enrollment is changed retroactively. Only active 
enrollment records have a value in this field since they are the only enrollment records that result in payroll deductions, benefits, or accruals. Active 
records have a beginning status that starts with A.

mnAmountOrRateRTAMMATH_NUMERICOPTBOTH

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. 

jdDateByDateCodeEFTJDEDATEOPTBOTH

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.

szPrimaryCarePhysicianNumbPCP#charOPTBOTH

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

cPCPVisitedPCPVSTcharOPTBOTH

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

szProcessingNoteDS80charOPTBOTH

A free-form text field for comments or memoranda.

cCategoryErrorEV01charOPTBOTH

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

Related Functions

None

Related Tables

None