RetrieveEmployeePersonalBenefit

Retrieve Employee Personal Benefit Information

Minor Business Rule

Object Name: N0800024

Parent DLL: CHRM

Location: Client/Server

Language: NER

Functional Description

Purpose

The purposes of this function are to fetch employee benefit information, and, if requested, calculate 

the employee's age.

Setup Notes and Prerequisites


Special Logic




Technical Specification


ERROR CODES

0 = No Errors

1 = The Address Number was not passed in.

2 = Could not fetch information from F060116 using Address Number as the key.


First, the function fetches the data from the employee master and passes it back through the data 

structure.  If the Suppress Age flag is not 1, then the function calculates the employee age as of the 

date passed in.  If the as of date is not passed into the function, the system date is used.  The age is 

then also passed back out through the data structure.

Data Structure

DN0800024 - Retrieve Employee Personal Benefit Information

Parameter NameData ItemData TypeReq/OptI/O/Both
mnAddressNumberAN8MATH_NUMERICREQINPUT

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

jdAsOfDateEFTJDEDATEOPTNONE

Special Input Expected
The employees age is calculated as of this date.  If it is left blank, the system date is used.  

***The age is only calculated if the Suppress Age Calculation is not 1.


^

szSocialSecurityNumberSSNcharOPTNONE

A number that indicates the tax ID. In the United States, the tax ID is the social security number. In Canada, it is the social insurance number. 
If you add employee information for a non-US or non-Canadian company, you can leave this field blank. However, if the international code is 
set to Y and the default company is non-Canadian and non-United States, you can enter a 16-character number for the tax ID. The system 
does not permit duplicate tax ID numbers. Also, the number cannot include dashes. For example, if a social security number of nn-nn-nnnn is 
used, the number should be entered as follows: 123456789.

szBenefitGroupCodeDIVCcharOPTNONE

The benefit group to which the employee is assigned. Benefit groups facilitate employee enrollment by categorizing benefit plans and 
allowing enrollment rules for those categories. For example, assigning an employee to an executive (EXEC) benefit group automatically links the 
employee to the benefits available to executives in your organization.

mnAgeCalculatedFAGEMATH_NUMERICOPTNONE

Special Output Returned
The value returned here is a calculated age as of the As Of Date.  It is only calculated if the 

Suppress Age Calculation flag is not 1.


^

szCompanyHomeHMCOcharOPTNONE

The company number where the employee records generally reside.

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.

cErrorCodeERRCcharOPTNONE

Special Output Returned
0 = No Errors

1 = The Address Number was not passed in.

2 = Could not fetch information from F060116 using Address Number as the key.

^

cSuppressAgeCalculationEV01charOPTNONE

Special Input Expected
Pass a '1' in the SuppressAgeCalculation flag if the function should not calculate the age.  
Otherwise, it will calculate the employee's age as of the effective date passed in (or the system date if it 

is left blank).


^

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.

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). 

mnWorkHoursPerYearIHMATH_NUMERICOPTNONE

The number of work hours in the year. When you do not set your payroll company constants to use the Pay Grade Step table as the 
pay-rate source, the system uses this number to compute the hourly rate when you supply the annual salary (or to compute the annual salary when 
you supply the hourly rate). When you set your constants to use the Pay Grade Step table as the pay rate source, the system uses the 
following sequence to search for the standard number of hours that it uses to calculate the salary or hourly rate per pay period:     o Employee entry 
forms (this field)     o Pay Grade Step table (hours per day multiplied by days per year)     o Payroll company constants for the employee's 
company     o Payroll company constants for the default company (company 00000)     o Data dictionary     o System default value of 2080 
standard hours per year

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).

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.

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.

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.

mnAgeFixedFromF060116FAGEMATH_NUMERICOPTNONE

Special Output Returned
The fixed age stored in the Employee Master (F060116).


^

Related Functions

None

Related Tables

None