(Note: make this window as wide as possible to clearly view the tabel of parameters below)
Business Function Specification
Function Name:Retrieve SVH Available Hours
Source Name:N0500024
Data Structure:DN0500024A
Designer:Falah Thamir
Programmer:Falah Thamir
System Code:05A
Function Category
Function Use
Revisions Log
Date Modifications by SAR Number Description
-------------- ---------------- ---------- ---------------------
16 June, 1998 Falah Thamir 1958608 Creation
1.Functional Description
1.1Purpose
This function will retrieve available accrued time, beginning balance, time added, and time taken,
all in hours, during the requested calendar year from all PDBA's of the requested code (e.g. "V" for
vacation, which is from Data Dictionary Item "SVH" ,UDC 06/SV).
1.2Setup Notes and Prerequisites
SVH codes must be set-up in UDC 06/SV before calling this function.
1.3Special Logic
2.Technical Specifications
2.1Parameters:
Data ItemData Structure DescriptionI/OReqrdNotes
------------------------------------------------------------------------
AN8mnAddressNumber I x
EV01cAccrualType I xS = Sick
V = Vacation
H = Holiday
Other codes as permitted in the set-up of SVH
DTJdDate I xDate of inquiry
EV01cCalendar_FiscalAnniver
saryFlag01 I x0 = Calendar year accrual
1 = Fiscal/Anniversary year
accrual
This option is not currently implemented; only Calendar
accruals are returned
MATH06mnErrorCodeReturned O xError Code:
0 = no errors
1 = no records found in F06146
2 = a PDBA has no record in F069116
3 = no Pay Types found in F069036
4 = Error in cAccrualType code
5 = jdDate not entered
11 = Fiscal/Anniversary retrieval not yet
implemented
Note: Returned code is the first one detected
EV01cMultiplePayTypeFlag01 O Multiple Pay Type Flag
0 = one Pay Type record found in F069036
referenced by any PDBA
1 = more than one Pay Type referenced by
a PDBA in F069036
Note: The PDBA causing this warning is not
reported. It is up to the user to find out
which one it is.
BHBBmnHoursAvailable O Hours available
BHBBmnHoursBeginningBalance O Hours, beginning balance
BHBBmnHoursAddedThisYear O Hours added this year
BHBBmnHoursTakenThisYearI/O Hours taken this year.
If a value is passed in, it will be added to the value
retrieved.
2.2Related Tables
TableTable Description
---------------------------------------------
F06146Employee Transaction History Summary
F069116Payroll Transaction Constants
F069036Payroll Transaction Cross Reference
2.3Related Business Functions
Source NameFunction Name
------------------------------
Processing
1. Get the two-digit year from the date passed through the data structure. This is the DTEY key to
F06146. Call N0800031 to verify that the code passed in cAccrualType is already set-up for "SVH".
2. Search F06146 based on AN8, PDBA > 999, DTEY, and DISO = "Y". The selection is based on DBA's
that are accrual types (DISO = A). If found, then check that DBA in F069116 for required SVH code and ACO
(Available Carryover) = "Y". If conditions are met, then go to next step. Start the search in F06146
in an ascending order of PDBA's to avoid considering a PDBA code more than once.
3. Retrieve all records in F06146 based on AN8, PDBA from previous step, and DTEY from step 1, and
calculate the total BHBB (beginning balance) and BH01 .. BH12 (added this year).
4. Read F069036 based on PDBA from previous step and XTYP = "R" to get the Pay Types (PPYT), and
retrieve all records in F06146 based on AN8, PDBA = Pay Type, and DTEY. Add values from BH01 .. BH12 from
all records to get a total of time taken for that PDBA.
5. Repeat steps 2, 3, & 4, until end-of-file is reached. Add all values from steps 3 and 4 to
calculate a grand total of beginning balance, time added, and time taken from all accrual type PDBA's.
6. If a value is passed in time taken (mnHoursTakenThisYear), it will be added to the amount
retrieved above.
7. Calculate available time = beginning balance + time added - time taken. Return all four values
plus error code and flag in the data structure.
Notes:
1. Fiscal/Anniversary accrual is not yet set-up in OneWorld. Therefore, this version will only handle
calendar year accruals [F. Thamir, 13 March, 1998]
2. DBA codes are setup as follows: Codes 001 - 999 are Pay Types; codes 1000 - 9999 include accrual
types
3. There may be multiple entries in F06146 per AN8 per Accrual or Pay Type per year from different
HMCO's.
4. Multiple Pay Types may be referenced by one accrual which is setup in F069036 with XTYP = "R".
5. A record does not have to pre-exist in F06146. It is supposed to exist only when there are entries
(hours). For example, Pay Type records may not exist until "Time Taken" is entered.
DN0500024A - Retrieve SVH Available Hours
| 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
| ||||
| cAccrualTypeToInquire | SVH | char | REQ | INPUT |
A user defined code (system 06, type SV) that specifies whether the benefit or accrual type is sick, vacation, holiday, leave, or other. | ||||
| jdDateOfInquiry | DT | JDEDATE | REQ | INPUT |
The date that the employee was terminated, if applicable. | ||||
| cCalendar_FiscalAnnivFlag01 | EV01 | char | REQ | INPUT |
An option that specifies the type of processing for an event. | ||||
| mnErrorCodeReturned | MATH06 | MATH_NUMERIC | OPT | OUTPUT |
Event point for Math Numeric. | ||||
| cMultiplePayTypeFlag01 | EV01 | char | OPT | OUTPUT |
An option that specifies the type of processing for an event. | ||||
| mnHoursAvailable | BHBB | MATH_NUMERIC | OPT | OUTPUT |
The balance at the beginning of the year for the number of hours associated with a PDBA. | ||||
| mnHoursBeginningBalance | BHBB | MATH_NUMERIC | OPT | OUTPUT |
The balance at the beginning of the year for the number of hours associated with a PDBA. | ||||
| mnHoursAddedThisYear | BHBB | MATH_NUMERIC | OPT | OUTPUT |
The balance at the beginning of the year for the number of hours associated with a PDBA. | ||||
| mnHoursTakenThisYear | BHBB | MATH_NUMERIC | OPT | BOTH |
The balance at the beginning of the year for the number of hours associated with a PDBA. | ||||
| mnHoursAccNotAvailable | BHBB | MATH_NUMERIC | OPT | OUTPUT |
The balance at the beginning of the year for the number of hours associated with a PDBA. | ||||
| mnDollarsAvailable | BWBB | MATH_NUMERIC | OPT | NONE |
The balance at the beginning of the year for the gross pay associated with a pay, deduction, benefit, or accrual. | ||||
| mnDollarsBegBal | BWBB | MATH_NUMERIC | OPT | NONE |
The balance at the beginning of the year for the gross pay associated with a pay, deduction, benefit, or accrual. | ||||
| mnDollarsAddedThisYear | BWBB | MATH_NUMERIC | OPT | NONE |
The balance at the beginning of the year for the gross pay associated with a pay, deduction, benefit, or accrual. | ||||
| mnDollarsTakenThisYear | BWBB | MATH_NUMERIC | OPT | NONE |
The balance at the beginning of the year for the gross pay associated with a pay, deduction, benefit, or accrual. | ||||
| mnDollarsAccNotAvail | BWBB | MATH_NUMERIC | OPT | NONE |
The balance at the beginning of the year for the gross pay associated with a pay, deduction, benefit, or accrual. | ||||
| mnFromDBAAvailable | PDBA | MATH_NUMERIC | OPT | 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
| ||||
| mnThruDBAAvaialble | PDBA | MATH_NUMERIC | OPT | 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
| ||||
| mnFromDBAAccrued | PDBA | MATH_NUMERIC | OPT | 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
| ||||
| mnThruDBAAccrued | PDBA | MATH_NUMERIC | OPT | 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
| ||||
| jdAnniversaryDate | DTE | JDEDATE | OPT | NONE |
You can enter a date with or without slashes (/) or dashes (-) as separators.
If you leave a date entry field blank, the system supplies the
| ||||
| None |
| None |