GetVOE_EmployeeInformation

Get VOE Employee Information

Minor Business Rule

Object Name: N0500040

Parent DLL: CFND

Location: Client/Server

Language: NER

Function: N0500040, Get Verification Of Employment (VOE) Employee Information
Data Structure: D0500040A

Functional Description

Purpose

Retrieve employee information related to Verification Of Employment (see list of output parameters).
The information include information from F060116, Employee Master, and earnings during the year of
request, plus the previous two years.

Setup Notes and Prerequisites

UDC for VOECATE, VOE Category, needs to be set-up (UDC 05/V1)

Special Logic

The UDC codes for VOECATE are hard-coded in this function to categorise pay types. If a change is
made, this function will need to be revised.
The current codes are: BASE, BONUS, COMMISSION, OTHER, & OVERTIME
[F. Thamir, 14 August, 1998]

Technical Specification

Parameters

Input:

1. AN8,Address Number(required)

2. DRQJ,Date of request(required)

Output:

1. MATH06,Error code(required)
0 = no errors
1 = Address Number not entered
2 = Date of request not entered
3 = both Address Number and Date of Request not entered
4 = Description of Job Type/Step not found (description returned by N0500042
5 = a record in F05002 has Date From < Date Through (blank dates are considered open)
6 = a code for VOECATE (UDC 05/V1) found in F05002 that was not accounted for in this function

2. MATH06,Warning code
No codes are currently coded

3. DST,Date employment started

4. DESCJTS,Description of Job Type/Step

5. EST,Employment Status

6. PAST,Employee Pay Status

7. SALY,Pay Type HSP

8. PFRQ,Pay Frequency

9. PPSOW,Rate, Pay per pay period

10. AMTINC,Amount of increase

11. DR,Date of last raise

12. NRDT,Date of next raise

13. AYTDDB0,Amount, YTD Base pay during year of request

14. AYTDDB1,Amount, YTD Base pay one year prior to base year

15. AYTDDB2,Amount, YTD Base pay two years rior to base year

16. AYTDOT0,Amount, YTD Overtime pay during year of request

17. AYTDOT1,Amount, YTD Overtime pay one year prior to base year

18. AYTDOT2,Amount, YTD Base pay two years rior to base year

19. AYTDCM0,Amount, YTD Overtime pay during year of request

20. AYTDCM1,Amount, YTD Overtime pay one year prior to base year

21. AYTDCM2,Amount, YTD Overtime pay two years rior to base year

22. AYTDBN0,Amount, YTD Bonus pay during year of request

23. AYTDBN1,Amount, YTD Bonus pay one year prior to base year

24. AYTDBN2,Amount, YTD Bonus pay two years rior to base year

25. AYTDOR0,Amount, YTD Other pay during year of request

26. AYTDOR1,Amount, YTD Other pay one year prior to base year

27. AYTDOR2,Amount, YTD Other pay two years rior to base year

28. AYTDTL0,Amount, YTD total pay during year of request

29. AYTDTL1,Amount, YTD total pay one year prior to base year

30. AYTDTL2,Amount, YTD total pay two years rior to base year

31. HMCO,Home Company of employee

Processing

1. Call N0500009, Retrieve Employee Master Info

2. Call N05000042, F08001 Retrieve Specific Job Information, to retrieve description of Job Type/Step
(which were retrieved in step 1

3. Call N0800006, Calc Pay Period / Annual Salary from input, to return pay paer pay period

4. Calculate amount of increase
if previos salary > 0 then amount of increase - annual salary - previous salary
else amount of increase = 0

5. Retrieve amounts AYTDxxx for last three years, starting with present date
counter = 0
while counter < 3 and erro code not 0
date = date of request - (counter x 12 months)
extract the 2-digit year from date (DTEY)
F05002.Select All
while not end-of-file (F05002) and erro code not 0
F05002.Fetch Next (VOECATE, PayType, EFFFROM, EFFTHRU)
if date >= F05002.EFFFROM and date <= F05002.EFFTHRU
GrossPay = 0.00
F06146.Select (AN8, F05002.PayType, DTEY)
while not end-of-file (F06146)
F06146.Fetch Next (BW01 ... BW12) [gross pay, months 1 .. 12)
sum = BW01 + ... + BW12
GrossPay = GrossPay + sum
endwhile
if counter = 0
if F05002.VOECATE = "BASE" then AYTDBS0 = AYTDBS0 + GrossPay
else if F05002.VOECATE = "BONUS" then AYTDBN0 = AYTDBN0 + GrossPay
.
.
else if F05002.VOECATE = ""OVERTIME" then AYTDOT0 + GrossPay
else error code = 6
else
if counte = 1
.
.
else if counter = 2
endwhile
counter = counter + 1
endwhile

6. Pass back values to data structure
Error Code = erro code
Warning Code = warning code
if error code not = 0
copy other values
endif

Data Structure

D0500040A - Get VOE Employee Information

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
mnAddressNumber	AN8	MATH_NUMERIC	REQ	INPUT
A number that identifies an entry in the Address Book system, such as employee, applicant, participant, customer, supplier, tenant, or location.
jdDateRequestedJulian	DRQJ	JDEDATE	REQ	INPUT
The date that an item is scheduled to arrive or that an action is scheduled for completion.
mnErrorCodeReturned	MATH06	MATH_NUMERIC	REQ	OUTPUT
Event point for Math Numeric.
mnWarningCodeReturned	MATH06	MATH_NUMERIC	OPT	OUTPUT
Event point for Math Numeric.
jdDateEmploymentStart	DST	JDEDATE	OPT	OUTPUT
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.
szDescriptionJobTypeStep	DESCJTS	char	OPT	OUTPUT
The description associated with the job type and job step. This description is stored in the Job Information table (F08001).
cEmploymentStatus	EST	char	OPT	OUTPUT
A user defined code (07/ES) that specifies an employee's status within the company. You can change the default codes or set up new codes to meet the needs of your company. Sample valid values include the following: Blank Full-time regular. 1 Full-time temporary 2 Part-time temporary 3 Part-time regular 4 Seasonal 5 Casual
cEmployeePayStatus	PAST	char	OPT	OUTPUT
The code used to indicate whether an employee's pay status is active or inactive. Codes for active pay status employees are numeric, and codes for inactive pay status employees are alphabetic. The system omits all employees with alphabetic pay status codes from the payroll run. See also Employment Status (EST) and Change Reason (TRS).
cPayTypeHSP	SALY	char	OPT	OUTPUT
A code that specifies how an employee is paid. Valid codes are: H Hourly S Salaried P Piecework
cPayFrequency	PFRQ	char	OPT	OUTPUT
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.
mnRatePayPeriodSalary	PPSOW	MATH_NUMERIC	OPT	OUTPUT
Pay Period Salary is calculated by dividing the annual salary by the number of pay periods.
mnAmountOfIncrease	AMTINC	MATH_NUMERIC	OPT	OUTPUT
Amount of increase is the difference between two values. A negative value indicates a decrease.
jdDateLastRaise	DR	JDEDATE	OPT	OUTPUT
The date of the employee's last raise. For the stand-alone HR system, this is the date when you update salary and wages. If you also have the Payroll system, this date is automatically updated when a payroll is run. You define pay effective dates using the Pay Rate Information screen.
jdDteNextRaiseEffective	NRDT	JDEDATE	OPT	OUTPUT
The date that the hourly or annual pay rate for the employee increases. The new rate goes into effect after a payroll cycle completes with a pay period end date on or after the date of the next raise.
mnAmountBasePay0	AYTDBS0	MATH_NUMERIC	OPT	OUTPUT
Amount paid from all pay types considered to be base salary for the current year.
mnAmountBasePay1	AYTDBS1	MATH_NUMERIC	OPT	OUTPUT
The amount paid from all pay types considered to be base salary for the year prior to the current year.
mnAmountBasePay2	AYTDBS2	MATH_NUMERIC	OPT	OUTPUT
Amount paid from all pay types considered to be base salary, for the year that is two years prior to the current year.
mnAmountOverTimePay0	AYTDOT0	MATH_NUMERIC	OPT	OUTPUT
Amount paid from all pay types considered to be overtime pay for the current year.
mnAmountOverTimePay1	AYTDOT1	MATH_NUMERIC	OPT	OUTPUT
Amount paid from all pay types considered to be overtime pay for the year prior to the current year.
mnAmountOverTimePay2	AYTDOT2	MATH_NUMERIC	OPT	OUTPUT
Amount paid from all pay types considered to be overtime pay, for the year that is two years prior to the current year.
mnAmountCommissionPay0	AYTDCM0	MATH_NUMERIC	OPT	OUTPUT
Amount paid from all pay types considered to be commission pay for the current year.
mnAmountCommissionPay1	AYTDCM1	MATH_NUMERIC	OPT	OUTPUT
Amount paid from all pay types considered to be commission pay for the year prior to the current year.
mnAmountCommissionPay2	AYTDCM2	MATH_NUMERIC	OPT	OUTPUT
Amount paid from all pay types considered to be commission pay, for the year that is two years prior to the current year.
mnAmountBonusPay0	AYTDBN0	MATH_NUMERIC	OPT	OUTPUT
The amount of bonus pay that the employee earned, year-to-date in the current year. The system calculates this amount by searching the employee's timecards for pay types that represent bonus pay. It then calculates the amount of the employee's earnings during the year that were attributed to the bonus pay types. Note: When you set up a pay type, you use the Pay Type Category field (PTCT) to identify it as part of a related group of pay types, such as regular pay,bonus pay, commissions, and so on. You define pay type categories in user defined code list 06/PC.
mnAmountBonusPay1	AYTDBN1	MATH_NUMERIC	OPT	OUTPUT
The amount of bonus pay that the employee earned in the year prior to the current year. The system calculates this amount by searching the employee's timecards for pay types that represent bonus pay. It then calculates the amount of the employee's earnings during the year that were attributed to the bonus pay types. Note: When you set up a pay type, you use the Pay Type Category field (PTCT) to identify it as part of a related group of pay types, such as regular pay,bonus pay, commissions, and so on. You define pay type categories in user defined code list 06/PC.
mnAmountBonusPay2	AYTDBN2	MATH_NUMERIC	OPT	OUTPUT
The amount of bonus pay that the employee earned in the year that is two years prior to the current year. The system calculates this amount by searching the employee's timecards for pay types that represent bonus pay. It then calculates the amount of the employee's earnings during the year that were attributed to the bonus pay types. Note: When you set up a pay type, you use the Pay Type Category field (PTCT) to identify it as part of a related group of pay types, such as regular pay,bonus pay, commissions, and so on. You define pay type categories in user defined code list 06/PC.
mnAmountOtherPay0	AYTDOR0	MATH_NUMERIC	OPT	OUTPUT
Amount paid from all pay types considered to be other pay for the current year. Other pay is anything other than base salary, overtime, commission, and bonus.
mnAmountOtherPay1	AYTDOR1	MATH_NUMERIC	OPT	OUTPUT
Amount paid from all pay types considered to be other pay, for the year prior to the current year. Other pay is anything other than base salary, overtime,commission, and bonus.
mnAmountOtherPay2	AYTDOR2	MATH_NUMERIC	OPT	OUTPUT
Amount paid from all pay types considered to be other pay, for the year two years prior to the current year. Other pay is anything other than base salary,overtime, commission, and bonus.
mnAmountTotalPay0	AYTDTL0	MATH_NUMERIC	OPT	OUTPUT
The total paid from all pay types considered to be base salary (overtime,commission, bonus, and other pay types) for the current year.
mnAmountTotalPay1	AYTDTL1	MATH_NUMERIC	OPT	OUTPUT
The total amount paid from all pay types considered to be base salary (overtime, commission, bonus, and other pay types) for the year prior to the current year.
mnAmountTotalPay2	AYTDTL2	MATH_NUMERIC	OPT	OUTPUT
The total amount paid from all pay types considered to be base salary (overtime, commission, bonus, and other pay types) for the year two years prior to the current year.
szCompanyHome	HMCO	char	OPT	OUTPUT
The company number where the employee records generally reside.

Related Functions

None

Related Tables

None