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.
D0800029 - Caculate Plan Amounts Cache
Parameter Name | Data Item | Data Type | Req/Opt | I/O/Both |
---|---|---|---|---|
szCacheActionCode | CACTN | char | NONE | NONE |
Special Input Expected
| ||||
mnNumberKeys | NKEYS | MATH_NUMERIC | NONE | NONE |
The number of keys in an index that will be used to retrieve, delete, or update a record. | ||||
cSuppressErrorMessages | SUPPS | char | NONE | NONE |
A flag indicating whether or not runtime error messaging will occur when an error message is issued from a business function.
0 = allow
| ||||
mnPayDeductBenAccType | PDBA | MATH_NUMERIC | NONE | NONE |
A code that defines the type of pay, deduction, benefit, or accrual.
Pay types are numbered from 1 to 999. Deductions and benefits are
| ||||
mnAmtOrRate | RTAM | MATH_NUMERIC | NONE | NONE |
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,
| ||||
mnHoursWork | PHRW | MATH_NUMERIC | NONE | NONE |
The number of hours associated with each transaction. | ||||
idCacheCursor | GENLNG | ID | NONE | NONE |
General purpose ID variable. | ||||
szErrorMessageID | DTAI | char | NONE | NONE |
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
| ||||
mnJobnumberA | JOBS | MATH_NUMERIC | NONE | NONE |
The job number (work station ID) which executed the particular job. | ||||
mnAddressNumber | AN8 | MATH_NUMERIC | NONE | NONE |
A number that identifies an entry in the Address Book system, such as employee, applicant, participant, customer, supplier, tenant, or
| ||||
szPlanId | PLAN | char | NONE | NONE |
An abbreviation or number that identifies a specific employee benefit. Examples are:
o Employee Health Insurance
o Accidental Death
| ||||
szPlanAdditionalOption | AOPT | char | NONE | NONE |
A code that identifies any additional options available for a benefit plan that have been defined in the Plan Additional Options table
| ||||
jdDateEffectiveRates | EFT | JDEDATE | NONE | NONE |
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
| ||||
cPayFrequency | PFRQ | char | OPT | NONE |
A user defined code (07/PF) that indicates how often an employee is paid. Valid codes are:
B
Biweekly
W
Weekly
S
Semimonthly
| ||||
mnRtDistributionOrBill | PBRT | MATH_NUMERIC | OPT | NONE |
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.
| ||||
mnRtSalary | SAL | MATH_NUMERIC | OPT | NONE |
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
| ||||
mnRtHourly | PHRT | MATH_NUMERIC | OPT | NONE |
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
| ||||
mnRtPiecework | PPRT | MATH_NUMERIC | OPT | NONE |
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
| ||||
jdDateBirth | DOB | JDEDATE | OPT | NONE |
The employee's date of birth. | ||||
jdDateOriginalEmployment | DSI | JDEDATE | OPT | NONE |
The date on which the employee was originally hired by the company. If the employee was terminated and subsequently rehired, the new
| ||||
jdDateEmploymentStart | DST | JDEDATE | OPT | NONE |
The date on which the employee actually reported to work for the most recent period of hire. When an employee initially begins working,
| ||||
jdDateLoaStarts | LSDT | JDEDATE | OPT | NONE |
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
| ||||
mnAnnualSalaryLife | LSAL | MATH_NUMERIC | OPT | NONE |
You can use this field to calculate deductions, benefits, and accruals (DBAs) for an employee's life insurance premium. Any table method
| ||||
mnAgeFixed | FAGE | MATH_NUMERIC | OPT | NONE |
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
| ||||
mnSalaryFixed | FSAL | MATH_NUMERIC | OPT | NONE |
You can use this field to calculate deductions, benefits, and accruals (DBAs) for a spouse's life insurance premium. Any table method that
| ||||
mnNoOfPayPeriodsYtd | PPYR | MATH_NUMERIC | OPT | NONE |
The number of pay periods per year, defined by the employees' Pay Frequency (PFRQ). | ||||
jdDateParticipation | PADT | JDEDATE | OPT | NONE |
The date the employee began participating in the company deferred income or stock option plan. This date must be later than the Date
| ||||
mnEnrollmentEventType | EVET | MATH_NUMERIC | OPT | NONE |
A field that indicates the event during which the enrollment occurs. Valid values include:
1 Open Enrollment
2 Enrollment for current plan
|
None |
None |