CalculatePlanAmountCache

Calculate Plan Amount Cache

Minor Business Rule

Object Name: B0800029

Parent DLL: CHRM

Location: Client/Server

Language: C

Functional Description

Purpose

This business function manages the cache used for processing data for Calculating the Plan Amounts.


Setup Notes and Prerequisites


Special Logic




Technical Specification


This function will allow the user to perform the following functions to the Calculate Plan Amount 

Cache:


Cache Get 1 

Cache Add 2

Cache Update 3

Cache Delete 4

Cache Delete All  5

Cache Get Next 6

Cache End 8

Cache Close Cursor 9


This function uses the numeric Cache Action Code to determine the appropriate API's to call and 

perform the action requested.  

Data Structure

D0800029 - Caculate Plan Amounts Cache

Parameter NameData ItemData TypeReq/OptI/O/Both
szCacheActionCodeCACTNcharNONENONE

Special Input Expected
Cache  Getab  ab  ab  ab  1 

Cache  Addab  ab  ab  ab  2

Cache  Updateab  ab  ab  3

Cache  Deleteab  ab  ab  4

Cache Delete  Allab  ab        5

Cache Get  Nextab  ab  ab  6

Cache  Add/Updateab  ab        7

Cache  Endab  ab  ab  ab  8

Cache Close  Cursorab  ab  9


^

mnNumberKeysNKEYSMATH_NUMERICNONENONE

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

cSuppressErrorMessagesSUPPScharNONENONE

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.

mnPayDeductBenAccTypePDBAMATH_NUMERICNONENONE

A code that defines the type of pay, deduction, benefit, or accrual. Pay types are numbered from 1 to 999. Deductions and benefits are 
numbered from 1000 to 9999.

mnAmtOrRateRTAMMATH_NUMERICNONENONE

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. 

mnHoursWorkPHRWMATH_NUMERICNONENONE

The number of hours associated with each transaction.

idCacheCursorGENLNGIDNONENONE

General purpose ID variable.

szErrorMessageIDDTAIcharNONENONE

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.

mnJobnumberAJOBSMATH_NUMERICNONENONE

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

mnAddressNumberAN8MATH_NUMERICNONENONE

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

szPlanIdPLANcharNONENONE

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.

szPlanAdditionalOptionAOPTcharNONENONE

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.

jdDateEffectiveRatesEFTJDEDATENONENONE

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.

cPayFrequencyPFRQcharOPTNONE

A user defined code (07/PF) that indicates how often an employee is paid. Valid codes are: B Biweekly   W Weekly   S Semimonthly  
M Monthly   A Annually   C European Annualized  The system uses the value in the Description-2 field on user defined codes to calculate the amount per 
pay period for a salaried employee.

mnRtDistributionOrBillPBRTMATH_NUMERICOPTNONE

A number that specifies the rate that the system uses to bill for labor services. This rate is often referred to as the billing or recharge rate. 
The system charges the resulting amount, based on this rate, to the primary distribution account for the timecard. The system also enters an 
offset to an account that is derived from automatic accounting instructions. This rate does not affect employee payroll. To allow billing rates in 
time entry, the employee record type must be set to 2 (payroll and recharge processing) or 3 (recharge processing only) with the Employee 
Payroll program (P0801PRL).

mnRtSalarySALMATH_NUMERICOPTNONE

The amount that an employee is paid in one year, assuming that the employee is paid every pay period of the year. For WorldSoftware: For 
the employee's primary job, the system stores the annual salary in the Employee Master Information table (F060116) and the Employee 
Jobs table (F060118). For secondary jobs, the system stores the annual salary only in the Employee Jobs table (F060118). Depending on how 
the value that is entered in the Display Salary (Annual/Effective) field in the HR History Constants table (F08040), this field displays one of the 
following:   o  Annual salary. For salaried employees who are not linked with a contract calendar, the user enters the amount or the system 
retrieves the amount from the Pay Grade/Salary Range Table (F082001). For employees who are linked with a contract calendar, the system 
calculates this amount using the following formula: (((current salary minus salary paid before change) divided by number of periods to pay) 
multiplied by pay frequency).   o  Effective salary. For employees whose jobs are linked with a contract calendar, the system recalculates the 
effective salary when you enter a mid-calendar salary adjustment. After you enter a mid-calendar adjustment, the effective salary equals the 
salary that is paid to the employee from the time of the adjustment through the end of the contract. The system calculates this amount using 
the following formula: ((annual salary divided by pay frequency) times periods to pay). 

mnRtHourlyPHRTMATH_NUMERICOPTNONE

The employee's hourly rate, which is retrieved during time entry. If you enter a rate in this field on any other form, that rate can override the 
value in the Employee Master table. In the Employee Master table, this number is the employee's base hourly rate. In the Union Rates table, it 
is the straight time rate. NOTE: If you change the number of the data display decimal digits for this field, you must also change fields Rate - 
Base Hourly (BHRT) and Rate - Hourly (SHRT) so that they have exactly the same number of data display decimal digits.

mnRtPieceworkPPRTMATH_NUMERICOPTNONE

The rate paid for the type of component (piece) produced.  If you enter a rate in this field, this rate overrides the rate in the Employee Master 
file.

jdDateBirthDOBJDEDATEOPTNONE

The employee's date of birth.

jdDateOriginalEmploymentDSIJDEDATEOPTNONE

The date on which the employee was originally hired by the company. If the employee was terminated and subsequently rehired, the new 
start date will be represented by the data in the Date Started (DST) field.

jdDateEmploymentStartDSTJDEDATEOPTNONE

The date on which the employee actually reported to work for the most recent period of hire. When an employee initially begins working, 
the default is the original hire date. If no original hire date exists, the system uses the current date. This field can be updated multiple times if, for 
example, an employee is a seasonal worker. For the calculation tables in the Payroll system and the eligibility tables and date codes in the 
Human Resources system, the system also uses this date as a start date when it calculates deductions, benefits, and accruals.

jdDateLoaStartsLSDTJDEDATEOPTNONE

The date on which an employee's paid or unpaid leave of absence begins. Use this date to indicate the leave for the Family and Medical 
Leave Act.

mnAnnualSalaryLifeLSALMATH_NUMERICOPTNONE

You can use this field to calculate deductions, benefits, and accruals (DBAs) for an employee's life insurance premium. Any table method 
that begins with an I (Insurance) uses this field.

mnAgeFixedFAGEMATH_NUMERICOPTNONE

For World: The age of the employee as of a certain date (for example, January 1st) for a given year. You can manually update this field or 
update it each year using the future data facility. For One World: The age of the employee as of a certain date (for example, January 1st) for a 
given year. You can manually update this field or the system can update this field when you run the Update Employee Master Age report 
(R083495).

mnSalaryFixedFSALMATH_NUMERICOPTNONE

You can use this field to calculate deductions, benefits, and accruals (DBAs) for a spouse's life insurance premium. Any table method that 
begins with an F uses this field.

mnNoOfPayPeriodsYtdPPYRMATH_NUMERICOPTNONE

The number of pay periods per year, defined by the employees' Pay Frequency (PFRQ).

jdDateParticipationPADTJDEDATEOPTNONE

The date the employee began participating in the company deferred income or stock option plan. This date must be later than the Date 
Started date.

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

Related Functions

None

Related Tables

None