GetCompBudgetSpentRemainAmts

Get Comp Budget/Spent/Remaining Amts For Increase Types

Minor Business Rule

Object Name: N0800172

Parent DLL: CHRM

Location: Client/Server

Language: NER

Functional Description

Purpose
The NER calculates the budget/spent/remaining of the increase types requested for a particular
supervisor, report view, and model name.

Setup Notes and Prerequisites
Required inputs are the supervisor number, report view, use prorate system option, use prorate amount
in spent calculation system option, reflect in budget if eligibility is overridden system option,
model name, review type, and model owner.  A max of 10 increase type codes can be passed in.

The output fields are max of 10 sets of increase budget/spent/remaining amounts and a set of total
budget/spent/remaining of all increase types.

Special Logic
Report view: '1' = Direct reports; '2' = All reports (Direct and Indirect Reports).  If the direct
report, the employee/supervisor relationship level considered is only 1.

The budget amount is the accumulation of the budget amounts for the eligible increase type (ie the
field. Actual eligibility (ACTEL) = '1').
If the system option, 'reflect in budget if eligibility is overridden', is '1', the budget amount is
adjusted accordingly, if the eligibility is overridden.  Eligibility is overriden, when the actual
eligibility (ACTEL) is not equal to the modified eligibility (MODEL).  If the modified eligibility is '1'
(ie make eligible from ineligible), the budget amount is added to the accumulated budget amount.  If
the modified eligiblity is '0' (ie make ineligible from eligible), the budget amount is deducted from
the accumulated budget amount.

The spent amount is the accumulation of either the increase amounts or the prorate amounts for the
increase type.  If system options, 'Use prorate' and 'Use prorate amount in spent calculation' are both
'1', the prorate amounts are accumulated as the increase spent amount.  Otherwise, the increase
amounts are accumulated as the increase spent amount.

The remaining amount is the difference between the accumulated budget and the spend amount for the
increase type.

The business view used in the NER is V08831WFJA, which joins tables, F08830WF, F08831WF, and F05840.
Records in the business view, with model type = 'T', are not considered in the calculations, as there
records belonging to employees who are terminated and are to be removed from the compensation review.

Technical Specification
For each non blank and non null increase type passed in  //up to a max of 10 increase types//,
perform this logic:

• Get the budget/spent/remaining for the increase type, using the special logic above
• Accumulate the increase budget/spent/remaining to a total budget/spent/remaining amounts
• Pass the increase budget/spent/remaining for the increase type in the appropriate output fields.

• Pass the total budget/spent/remaining amounts in the appropriate output fields.

Data Structure

D0800172 - Get Comp Budget/Spent/Remaining Amts For Increase Types

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
mnSupervisor	ANPA	MATH_NUMERIC	REQ	INPUT
The address book number of the supervisor.
cReportView	RVIEW	char	REQ	INPUT
Flag to indicate Report View. UDC table (08/RV) is attached to this item.
cUseProrate	EV01	char	REQ	INPUT
An option that specifies the type of processing for an event.
cUseProrateAmtInSpent	EV01	char	REQ	INPUT
An option that specifies the type of processing for an event.
cReflectInBudgetEligOvrd	EV01	char	REQ	INPUT
An option that specifies the type of processing for an event.
szIncreaseType1	TRS	char	OPT	INPUT
A code that indicates the reason for one of the following: o Changing an active employee's record o Terminating an employee o Recommending a change in salary or rate This is a user defined code (06/T). If you are reactivating an employee, the code must be numeric. The code for new hires is the default reason code.
mnIncreaseType1Budget	MATH01	MATH_NUMERIC	OPT	OUTPUT
- - - Good Performance Low Value.
mnIncreaseType1Spent	MATH01	MATH_NUMERIC	OPT	OUTPUT
- - - Good Performance Low Value.
mnIncreaseType1Remain	MATH01	MATH_NUMERIC	OPT	OUTPUT
- - - Good Performance Low Value.
szIncreaseType2	TRS	char	OPT	INPUT
A code that indicates the reason for one of the following: o Changing an active employee's record o Terminating an employee o Recommending a change in salary or rate This is a user defined code (06/T). If you are reactivating an employee, the code must be numeric. The code for new hires is the default reason code.
mnIncreaseType2Spent	MATH01	MATH_NUMERIC	OPT	OUTPUT
- - - Good Performance Low Value.
mnIncreaseType2Budget	MATH01	MATH_NUMERIC	OPT	OUTPUT
- - - Good Performance Low Value.
mnIncreaseType2Remain	MATH01	MATH_NUMERIC	OPT	OUTPUT
- - - Good Performance Low Value.
szIncreaseType3	TRS	char	OPT	INPUT
A code that indicates the reason for one of the following: o Changing an active employee's record o Terminating an employee o Recommending a change in salary or rate This is a user defined code (06/T). If you are reactivating an employee, the code must be numeric. The code for new hires is the default reason code.
mnIncreaseType3Spent	MATH01	MATH_NUMERIC	OPT	OUTPUT
- - - Good Performance Low Value.
mnIncreaseType3Remain	MATH01	MATH_NUMERIC	OPT	OUTPUT
- - - Good Performance Low Value.
mnIncreaseType3Budget	MATH01	MATH_NUMERIC	OPT	OUTPUT
- - - Good Performance Low Value.
szIncreaseType4	TRS	char	OPT	INPUT
A code that indicates the reason for one of the following: o Changing an active employee's record o Terminating an employee o Recommending a change in salary or rate This is a user defined code (06/T). If you are reactivating an employee, the code must be numeric. The code for new hires is the default reason code.
mnIncreaseType4Budget	MATH01	MATH_NUMERIC	OPT	OUTPUT
- - - Good Performance Low Value.
mnIncreaseType4Spent	MATH01	MATH_NUMERIC	OPT	OUTPUT
- - - Good Performance Low Value.
mnIncreaseType4Remain	MATH01	MATH_NUMERIC	OPT	OUTPUT
- - - Good Performance Low Value.
szIncreaseType5	TRS	char	OPT	INPUT
A code that indicates the reason for one of the following: o Changing an active employee's record o Terminating an employee o Recommending a change in salary or rate This is a user defined code (06/T). If you are reactivating an employee, the code must be numeric. The code for new hires is the default reason code.
mnIncreaseType5Spent	MATH01	MATH_NUMERIC	OPT	OUTPUT
- - - Good Performance Low Value.
mnIncreaseType5Budget	MATH01	MATH_NUMERIC	OPT	OUTPUT
- - - Good Performance Low Value.
mnIncreaseType5Remain	MATH01	MATH_NUMERIC	OPT	OUTPUT
- - - Good Performance Low Value.
szIncreaseType6	TRS	char	OPT	INPUT
A code that indicates the reason for one of the following: o Changing an active employee's record o Terminating an employee o Recommending a change in salary or rate This is a user defined code (06/T). If you are reactivating an employee, the code must be numeric. The code for new hires is the default reason code.
mnIncreaseType6Remain	MATH01	MATH_NUMERIC	OPT	OUTPUT
- - - Good Performance Low Value.
mnIncreaseType6Spent	MATH01	MATH_NUMERIC	OPT	OUTPUT
- - - Good Performance Low Value.
mnIncreaseType6Budget	MATH01	MATH_NUMERIC	OPT	OUTPUT
- - - Good Performance Low Value.
szIncreaseType7	TRS	char	OPT	INPUT
A code that indicates the reason for one of the following: o Changing an active employee's record o Terminating an employee o Recommending a change in salary or rate This is a user defined code (06/T). If you are reactivating an employee, the code must be numeric. The code for new hires is the default reason code.
mnIncreaseType7Remain	MATH01	MATH_NUMERIC	OPT	OUTPUT
- - - Good Performance Low Value.
mnIncreaseType7Budget	MATH01	MATH_NUMERIC	OPT	OUTPUT
- - - Good Performance Low Value.
mnIncreaseType7Spent	MATH01	MATH_NUMERIC	OPT	OUTPUT
- - - Good Performance Low Value.
szIncreaseType8	TRS	char	OPT	INPUT
A code that indicates the reason for one of the following: o Changing an active employee's record o Terminating an employee o Recommending a change in salary or rate This is a user defined code (06/T). If you are reactivating an employee, the code must be numeric. The code for new hires is the default reason code.
mnIncreaseType8Spent	MATH01	MATH_NUMERIC	OPT	OUTPUT
- - - Good Performance Low Value.
mnIncreaseType8Budget	MATH01	MATH_NUMERIC	OPT	OUTPUT
- - - Good Performance Low Value.
mnIncreaseType8Remain	MATH01	MATH_NUMERIC	OPT	OUTPUT
- - - Good Performance Low Value.
szIncreaseType9	TRS	char	OPT	INPUT
A code that indicates the reason for one of the following: o Changing an active employee's record o Terminating an employee o Recommending a change in salary or rate This is a user defined code (06/T). If you are reactivating an employee, the code must be numeric. The code for new hires is the default reason code.
mnIncreaseType9Budget	MATH01	MATH_NUMERIC	OPT	OUTPUT
- - - Good Performance Low Value.
mnIncreaseType9Spent	MATH01	MATH_NUMERIC	OPT	OUTPUT
- - - Good Performance Low Value.
mnIncreaseType9Remain	MATH01	MATH_NUMERIC	OPT	OUTPUT
- - - Good Performance Low Value.
szIncreaseType10	TRS	char	OPT	INPUT
A code that indicates the reason for one of the following: o Changing an active employee's record o Terminating an employee o Recommending a change in salary or rate This is a user defined code (06/T). If you are reactivating an employee, the code must be numeric. The code for new hires is the default reason code.
mnIncreaseType10Budget	MATH01	MATH_NUMERIC	OPT	OUTPUT
- - - Good Performance Low Value.
mnIncreaseType10Spent	MATH01	MATH_NUMERIC	OPT	OUTPUT
- - - Good Performance Low Value.
mnIncreaseType10Remain	MATH01	MATH_NUMERIC	OPT	OUTPUT
- - - Good Performance Low Value.
mnTotalRemain	MATH01	MATH_NUMERIC	OPT	OUTPUT
- - - Good Performance Low Value.
mnTotalSpent	MATH01	MATH_NUMERIC	OPT	OUTPUT
- - - Good Performance Low Value.
mnTotalBudget	MATH01	MATH_NUMERIC	OPT	OUTPUT
- - - Good Performance Low Value.
szModelName9	MNAME	char	REQ	INPUT
The model name. Valid values are: MASTER is a model name to be used for the Final Submitted Compensation. PUBLIC model is controlled by a UDC Table. Must use entry from the UDC Table. PRIVATE model could have any name the owner chooses.
cReviewType	RWTYP	char	REQ	INPUT
A code that indicates the last compensation review type.
mnModelOwner	MOWNR	MATH_NUMERIC	REQ	INPUT
The address book number of the person creating the model.

Related Functions

None

Related Tables

None