GetEEPDBAInfoFromCache

Read Employee PDBA Cache Created by B0700020

Minor Business Rule

Object Name: B0500027

Parent DLL: CFND

Location: Client/Server

Language: C

Data Structure

D0500027C - Get All PDBA Information of Employee from Cache

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
szProgramIdszEEPDBACacheID	PID	char	REQ	INPUT
The number that identifies the batch or interactive program (batch or interactive object). For example, the number of the Sales Order Entry interactive program is P4210, and the number of the Print Invoices batch process report is R42565. The program ID is a variable length value. It is assigned according to a structured syntax in the form TSSXXX, where: T The first character of the number is alphabetic and identifies the type, such as P for Program, R for Report, and so on. For example, the value P in the number P4210 indicates that the object is a program. SS The second and third characters of the number are numeric and identify the system code. For example, the value 42 in the number P4210 indicates that this program belongs to system 42, which is the Sales Order Processing system. XXX The remaining characters of the numer are numeric and identify a unique program or report. For example, the value 10 in the number P4210 indicates that this is the Sales Order Entry program.
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.
mnRecordNumberInCache	MATH06	MATH_NUMERIC	REQ	INPUT
Event point for Math Numeric.
cSetOWErrorFlag01	EV01	char	REQ	INPUT
An option that specifies the type of processing for an event.
mnErrorCodeReturned	MATH06	MATH_NUMERIC	REQ	OUTPUT
Event point for Math Numeric.
cTransactTypeTimePay	DISO	char	OPT	OUTPUT
A code used to distinguish between the following types of payroll entries: P Time Cards (Earnings) D Deductions withheld B Benefit (both cash and non cash) A Accrual of sick, vacation, comp, and so forth Note: These codes may only be changed by J.D. Edwards If you enter an * in this field the system displays all four types of PDBAs.
cSickVacationHoliday	SVH	char	OPT	OUTPUT
A user defined code (system 06, type SV) that specifies whether the benefit or accrual type is sick, vacation, holiday, leave, or other.
mnPDBACode	PDBA	MATH_NUMERIC	REQ	OUTPUT
A code that defines the type of pay, deduction, benefit, or accrual. Pay types are numbered from 1 to 999. Deductions and benefits are numbered from 1000 to 9999.
cAccruCarryovrOfAvail	ACO	char	OPT	OUTPUT
This code is internally set by the system during DBA Setup. If a DBA has related pay types the code is set to Y. This tells the system that this is the available DBA. All other DBAs will have a code of N.
jdDatePayStarts	PSDT	JDEDATE	OPT	OUTPUT
The date that an employee may begin participating in the company's benefit plans or may be included in payroll processing. You can also use this field to provide a beginning date for seasonal employees or for employees who work only part of the year (such as a teacher who works only nine months of the year).
jdDatePayStops	PTDT	JDEDATE	OPT	OUTPUT
The date when an employee should no longer be included in a payroll cycle or the date when an employee stops participating in the company's benefit plans. You can use this date for terminated employees, seasonal employees, or employees who work only part of the year (such as a teacher who works only nine months of the year). See also data item PSDT. This date may also be the date that a deduction, benefit, or accrual instruction stops.
szBenefitDeductionTable	DTAB	char	OPT	OUTPUT
The table used if the calculation requires table values.
cDeductionBasis	DESQ	char	OPT	OUTPUT
A user defined code (07/DB) that specifies the basis of a deduction, benefit, or accrual. When the system calculates the gross amount for disposable net wages, it does not use the basis of calculation. The gross amount includes all earnings that have a positive effect on the gross and net payment. For wage attachments use one of the following codes: 1-8 Garnishment, tax levy, wage assignment (child support and maintenance) R Loan, interest 0 Fees Note: When using the following codes (L = Prior Year, I= Inception to Date or P = Prior Month), it is required to roll over pdba amounts at year end for any pdba code that is included in the basis of calculation. Rollover (P07390) is required to create historical summary records (F06145 or F06146) in the new year that summarize amounts used for these calculations.
mnAmtOrRate	RTAM	MATH_NUMERIC	OPT	OUTPUT
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, benefit, or accrual, the meaning of this value depends on the method of calculation. The method determines whether the deduction is a flat monetary amount, a percentage, or a multiplication rate. Table method DBAs, depending on which table method they use, can either use this amount in the calculation or ignore it. If there are exceptions to the table calculation, you can override the table code in the detail area, set up a flat monetary DBA amount, or override the amount with a one-time override for a timecard. 2 For a pay type, amounts entered in this field override the hourly rate.
mnLimitOnPayPerDollars	PPDL	MATH_NUMERIC	OPT	OUTPUT
The maximum amount that can be withheld or accrued in a pay period for a deduction, benefit or accrual. This amount is expressed in dollars for deductions and benefits. For accruals, this amount is expressed in hours.
mnLimitOnMonthlyDollars	MDL	MATH_NUMERIC	OPT	OUTPUT
The maximum amount that can be withheld or accrued in a month for a deduction, benefit or accrual. This amount is expressed in dollars for deductions and benefits. For accruals, this amount is expressed in hours.
mnLimitOnAnnualDollars	ADL	MATH_NUMERIC	OPT	OUTPUT
The maximum amount that can be withheld or accrued in a year for a deduction, benefit or accrual. This amount is expressed in dollars for deductions and benefits. For accruals, this amount is expressed in hours. NOTE: For the Payroll system, this field can represent either an initial annual limitation or a final limitation in a year: o If the Annual (Level 1) field is not blank, this amount represents the first level of the yearly limitation. The value in Annual (Level 2) represents the final limitation. o If an annual limit is specified on a DBA calculation table, the annual limit from the table will take precedence over annual limits defined at the master DBA or employee levels.
mnLimitOnPayPeriodPer	PPPL	MATH_NUMERIC	OPT	OUTPUT
The maximum percentage of pay that the calculated deduction or benefit amount may not exceed. This percentage works in conjunction with the dollar limits of the deduction or benefit, so whichever limit is reached first stops the calculation. For accrual transactions, this field represents an hour's limit.
mnNoOfDeductionPeriods	NP	MATH_NUMERIC	OPT	OUTPUT
The number of periods for which a deduction or benefit should be taken. The system automatically decreases this number by one for each period taken. You must enter a value in this field if you automate the Number of Periods field. For PeopleSoft World: Enter a value in this field if you entered Y (Yes) in the Use Number of Periods field on the DBA Additional Information form.
mnAmountDue	AD	MATH_NUMERIC	OPT	OUTPUT
The balance or amount due on an open invoice or voucher. In the Address Book Master file (F0101), this is a memo amount field used to determine if a particular order exceeds a credit limit. See the documentation for the Order Processing system.
mnAddressNumberPayee	ANN8	MATH_NUMERIC	OPT	OUTPUT
The address book number for the supplier who receives the final payment. In Benefits administration, this is the address book number of the company that issues the plan and receives premium payments for it. For wage attachments, payee is the address book number of the agency, company, individual, or court that is to receive the payment of the check.
cDeductionPeriod001	DEP1	char	OPT	OUTPUT
A code designating the pay period in which the system calculates the DBA/auto deposit. Valid codes are: Y Take the DBA/auto deposit during the current period. N Do not take the DBA/auto deposit during the current period. * Take the DBA/auto deposit only during the first pay period for each month the employee works based on the ending date of this month's pay period. blank Continue to look for a code at the lower level. The system searches for DBA/auto deposit rules first at the employee level, then at the group level, and finally at the DBA master level. If the field is blank at all levels, the system does not calculate the DBA/auto deposit in that period. M Applies only to benefits based on gross hours or dollars. An M in the fifth field only tells the system to calculate the benefit during the special timecard post. An M implies a Yes for a weekly withholding frequency.
cDeductionPeriod002	DEP2	char	OPT	OUTPUT
A code designating the pay period in which the system calculates the DBA/auto deposit. Codes are: Y Take the DBA/auto deposit during the current period. N Do not take the DBA/auto deposit during the current period. * Take the DBA/auto deposit ONLY during the first pay period for each month the employee works based on the pay-period-end-date month. Blank SPECIAL MEANING: Continue to look for a code at the lower level. The system searches for DBA/auto deposit rules first at the employee level, then at the group level, and finally at the DBA master level. If the field is blank at all levels, the system does not calculate the DBA/auto deposit in that period. M SPECIAL MEANING: Applies only to benefits based on gross hours or dollars. An M in the fifth field only tells the system to calculate the benefit during the daily timecard post. An M implies a yes for a weekly withholding frequency.
cDeductionPeriod003	DEP3	char	OPT	OUTPUT
A code designating the pay period in which the system calculates the DBA/auto deposit. Codes are: Y Take the DBA/auto deposit during the current period. N Do not take the DBA/auto deposit during the current period. * Take the DBA/auto deposit ONLY during the first pay period for each month the employee works based on the pay-period-end-date month. Blank SPECIAL MEANING: Continue to look for a code at the lower level. The system searches for DBA/auto deposit rules first at the employee level, then at the group level, and finally at the DBA master level. If the field is blank at all levels, the system does not calculate the DBA/auto deposit in that period. M SPECIAL MEANING: Applies only to benefits based on gross hours or dollars. An M in the fifth field only tells the system to calculate the benefit during the daily timecard post. An M implies a yes for a weekly withholding frequency.
cDeductionPeriod004	DEP4	char	OPT	OUTPUT
A code designating the pay period in which the system calculates the DBA/auto deposit. Codes are: Y Take the DBA/auto deposit during the current period. N Do not take the DBA/auto deposit during the current period. * Take the DBA/auto deposit ONLY during the first pay period for each month the employee works based on the pay-period-end-date month. Blank SPECIAL MEANING: Continue to look for a code at the lower level. The system searches for DBA/auto deposit rules first at the employee level, then at the group level, and finally at the DBA master level. If the field is blank at all levels, the system does not calculate the DBA/auto deposit in that period. M SPECIAL MEANING: Applies only to benefits based on gross hours or dollars. An M in the fifth field only tells the system to calculate the benefit during the daily timecard post. An M implies a yes for a weekly withholding frequency.
cDeductionPeriod005	DEP5	char	OPT	OUTPUT
A code designating the pay period in which the system calculates the DBA/auto deposit. Codes are: Y Take the DBA/auto deposit during the current period. N Do not take the DBA/auto deposit during the current period. * Take the DBA/auto deposit ONLY during the first pay period for each month the employee works based on the pay-period-end-date month. Blank SPECIAL MEANING: Continue to look for a code at the lower level. The system searches for DBA/auto deposit rules first at the employee level, then at the group level, and finally at the DBA master level. If the field is blank at all levels, the system does not calculate the DBA/auto deposit in that period. M SPECIAL MEANING: Applies only to benefits based on gross hours or dollars. An M in the fifth field only tells the system to calculate the benefit during the daily timecard post. An M implies a yes for a weekly withholding frequency.
szJobCategoryF06106	JBCD	char	OPT	OUTPUT
A user defined code (07/G) that defines the jobs within your organization. You can associate pay and benefit information with a job type and apply that information to the employees who are linked to that job type.
szJobStepF06106	JBST	char	OPT	OUTPUT
A user defined code (07/GS) that designates a specific level within a particular job type. The system uses this code in conjunction with job type to determine pay rates by job in the Pay Rates table.
mnHoursMinimumAllowed	HMIN	MATH_NUMERIC	OPT	OUTPUT
The minimum number of hours worked or pieces produced in order for a DBA to be calculated. If the number of hours worked or pieces produced is less than this amount, the system assumes zero hours when it calculates the DBA. The system uses this field only if the method of calculation is H or I.
mnHoursMaximumAllowed	HMAX	MATH_NUMERIC	OPT	OUTPUT
The maximum number of hours worked or pieces produced that a DBA can be based on. If the actual hours worked or pieces produced are greater than the specified maximum, the system bases the calculation on the maximum. The system uses this field only if the method of calculation is H or I.
mnPredecessorDeduction	PDED	MATH_NUMERIC	OPT	OUTPUT
A code that identifies another DBA whose limit must be met first before this DBA calculates. For example; deduction 1400 has an annual limit of $2,000.00. After this limit is met, deduction 1500 begins calculation and withholding. The DBA number of the predecessor must be lower than the successor's number.
szDeductionGroup	DGRP	char	OPT	OUTPUT
Specify a code common to all deductions or benefits that share the same limitations (for example, pay period dollar amount or percentage, monthly,annual, and so on). The system takes these limits from the first deduction encountered in the group, and withholds for all deductions until the limit is reached for the aggregate. Example: Deduction 6400, Group A, Annual Limit = $1000, No Pay Period Limit Deduction 6430, Group A, No Annual or Pay Period Limit Deduction 7700, Group A, No Annual or Pay Period Limit Deduction 9400, Group B, No Annual or Pay Period Limit Deduction 7550, Group B, No Annual Limit, Pay Period Limit = $50 For this example, the system looks at the deductions assigned to Group A, and applies a $1000 annual limit for all three deductions. The system continues to take the deductions from an employee's paycheck until a total of $1000 has been deducted between all entities in Group A for the year. For deductions in Group B, the system deducts no more than $50 per pay period between for the two deductions.
cArrearageRules	ARRR	char	OPT	OUTPUT
A code indicating how to adjust deductions when the employee is in a negative pay situation. Valid codes are: P Do a partial or full deduction as needed. This is the default. F Do a full reduction or none at all. N Do not reduce. Q Same as code P. In addition, place the amount in arrears, but do not apply the limits when collecting the arrearage. Write the arrearage balance to history. R Same as code P. In addition, place the amount in arrears and apply the limits when collecting the arrearage. Write the arrearage balance to history. G Same as code F. In addition, place the amount in arrears, but do not apply the limits when collecting the arrearage. Write the arrearage balance to history. H Same as code F. In addition, place the amount in arrears and apply the limits when collecting the arrearage. Write the arrearage balance to history. S Same as code P. In addition, place the amount in arrears for the current pay period only but do not apply the limits when collecting the arrearage. Do not write the arrearage balance to history. T Same as code P. In addition, place the amount in arrears for the current pay period only and apply the limits when collecting the arrearage. Do not write arrearage balance to history. I Same as code F. In addition, place the amount in arrears for the current pay period only, but do not apply the limits when collecting the arrearage. Do not write arrearage balance to history. J Same as code F. In addition, place the amount in arrears for the current pay period only and apply the limits when collecting the arrearage. Do not write arrearage balance to history.
mnLimitOnQuarterlyDls	QDL	MATH_NUMERIC	OPT	OUTPUT
The maximum amount that can be withheld or accrued in a calendar quarter for a deduction, benefit or accrual. This amount is expressed in dollars for deductions and benefits. For accruals, this amount is expressed in hours.
mnPayrollTransactionNo	PRTR	MATH_NUMERIC	OPT	OUTPUT
A unique number that the system assigns to each timecard. You can use this field in the Time Entry By Job program to retrieve a specific timecard for display. This field is also used to tie a timecard to each Actual Burden audit record created for the timecard during the Actual Burden Journaling process.
szUnionCodeF06106	UN	char	OPT	OUTPUT
A user defined code (06/UN) that represents the union or plan in which the employee or group of employees work or participate.
mnAmountOrRateSecond	AMTS	MATH_NUMERIC	OPT	OUTPUT
The second amount or rate associated with a deduction, benefit, or accrual. Because many DBA types require multiple tiers, two levels of Amount (Rate) exist. The system uses the first level, Amount (Rate) 1, until the annual limit is reached. Then, the second level, Amount (Rate) 2, begins the next time the employee is paid. Amount (Rate) 2 continues until the second annual limit is reached. This field works in conjunction with the annual limit fields. The rate you enter in this field supersedes any other table rate for an employee, except for one-time overrides during time entry.
mnAnnualLimitLevel2	SADL	MATH_NUMERIC	OPT	OUTPUT
The maximum amount that can be withheld or accrued in a year for a deduction, benefit or accrual. This amount is expressed in dollars for deductions and benefits. For accruals, this amount is expressed in hours. NOTE: This field represents the second level annual limitation. It is used when there is an initial annual limit which has been reached. The DBA will calculate using amount rate 2.
cZeroOverrideFlag	ZOVR	char	OPT	OUTPUT
A Yes/No field indicating whether the system treats the Amount/Rate field as a zero amount override. You use this field primarily when an employee is part of a group plan yet does not receive a particular benefit in that plan.
cGenerateVoucherFlag	GVCH	char	OPT	OUTPUT
A code used to determine whether the system should generate a voucher for the DBA, tax, or wage attachment during the final update phase of the payroll processing cycle. Valid codes are: N No, do not generate a voucher Y Yes, generate a voucher
szPlanId	PLAN	char	OPT	OUTPUT
An abbreviation or number that identifies a specific employee benefit. Examples are: o Employee Health Insurance o Accidental Death and Dismemberment o Health Club Expense Reimbursement o Employee Stock Appreciation Rights A benefit plan typically is associated with a deduction, benefit, or accrual. For example, a medical plan is a benefit that might also require a deduction to withhold premiums from an employee's pay.
szNameAlphaExplanation	EXA	char	OPT	OUTPUT
A description, remark, explanation, name, or address.
cDeductionBenefitMethod	DEDM	char	OPT	OUTPUT
A user defined code (07/DM) that specifies the method that the system uses to perform certain calculations. For example, the system uses a method of calculation to calculate deductions, benefits, and accruals (DBAs) and workers' compensation insurance.
cDecliningBalance	DBAL	char	OPT	OUTPUT
A code that indicates whether you want the system to use the Amount Due at the DBA, group, or employee level to determine whether to use the specified deduction in a payroll cycle. Clicking on the field enables the Amount Due field to continue the deduction until the amount is zero. When you choose this field, you must also enter a value in the Amount Due field, otherwise the system considers the deduction to be cleared or inactive. If you do not click on this field, the Amount Due will not be used with the specified deduction. For advance deductions, you must click this field.
cUseNumberOfPeriods	NPER	char	OPT	OUTPUT
When you set up a DBA that is not a wage attachment deduction, use this field to indicate whether you want the system to read the Number of Periods field to determine if this DBA should be included in the payroll cycle. If you enter a Y, the number of periods must be entered in the No. of Deductions field or the system considers the DBA to be inactive. When you set up a wage attachment DBA, leave this field blank. Use the Employee Wage Attachment Entry form to enter the number of periods for which the deduction should be taken. For One World valid values are: Click on the field if you want the system to read the Number of Periods field and continue the DBA only until the amount due is zero. Blank Do not read the Number of Periods field for this DBA. For World, valid values are: Y Yes, read the Number of Periods field and continue this DBA only until the amount due is zero. N No, do not read the Number of Periods field for this DBA. Blank Do not read the Number of Periods field for this DBA.
szAnniversaryFiscalBeginni	AFDT	char	OPT	OUTPUT
A user-defined code (07/AF) that specifies when the rollover year begins. If blank, the system rolls the accrual over at the end of the standard calendar year (December 31, XXXX). To specify a fiscal year, enter user defined code FISC. The system will use the fiscal year setup for the employee's home company. To specify an anniversary year, enter any of the other codes in the user defined code table. For example, if you want the rollover year to begin on the employee's date of birth, use code DOB. To create related DBAs, use the same date code on both the DBA for the accrual, and the DBA for the available balance.
cFileCode	EV01	char	REQ	OUTPUT
An option that specifies the type of processing for an event.
szNameAlpha	ALPH	char	OPT	OUTPUT
The text that names or describes an address. This 40-character alphabetic field appears on a number of forms and reports. You can enter dashes, commas, and other special characters, but the system cannot search on them when you use this field to search for a name.
szCostCenterHome	HMCU	char	OPT	OUTPUT
The number of the business unit in which the employee generally resides.
szUnionCode	UN	char	OPT	OUTPUT
A user defined code (06/UN) that represents the union or plan in which the employee or group of employees work or participate.
szJobCategory	JBCD	char	OPT	OUTPUT
A user defined code (07/G) that defines the jobs within your organization. You can associate pay and benefit information with a job type and apply that information to the employees who are linked to that job type.
szJobStep	JBST	char	OPT	OUTPUT
A user defined code (07/GS) that designates a specific level within a particular job type. The system uses this code in conjunction with job type to determine pay rates by job in the Pay Rates table.
szCountryForPayroll	CCPR	char	OPT	OUTPUT
A user defined code list 00/CN that indicates the country in which the employee resides.
szBenefitGroupCode	DIVC	char	OPT	OUTPUT
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.

Related Functions

N0500007 Get Local Union Code

Related Tables

F07210 Pay Cycle Parameters File

GetNumOfRecsInEEPDBACache

Read Employee PDBA Cache Created by B0700020

Minor Business Rule

Object Name: B0500027

Parent DLL: CFND

Location: Client/Server

Language: C

(Note: make this window as wide as possible to see the Parametrs table clearly)

Business Function Specification

Source Name:B0500027

Data Structure:D0500027A

Function Name:Read Employee PDBA Cache created by B0700020 - Get Number Of
Records In Employee PDBA Cache

System Code:05A

Designer:David Scott

Programmer:Falah Thamir

Function Category:

Function Use:

Revisions Log
Date:24 April, 1998
Modifications by:Falah Thamir
SAR Number:1958608
Description:Creation

1.Functional Description

1.1Purpose

This function will return the number of records in cache created by B0700020.

1.2Setup Notes and Prerequisites

The function B0700020, Create EE PDBA Cache, InitializeEEPDBACache, followed by ProcessEEPDBACache,
must first be called to create the cache.

1.3Special Logic

2.Technical Specifications

2.1Parameters:
Data ItemData Structure DescriptionI/OReqrd Notes
----------------------------------------------------------------
PIDszEEPDBACacheIDIxPass the value assigned by
B0700020, InitializeEEPDBACache

EV01cSetOWErrorFlag01IxFlag to set OneWorld errors
1 = set OneWorld errors
anything else = do not set
OneWorld errors
Error codes are always returned
in mnErrorCodeReturned
Note: do not set OneWorld errors in batch operations

MATH06mnNoOfRecordsInCacheOxNumber of records in cache

MATH06mnErrorCodeReturnedOxError code returned
0 = no errors
1 = cache is empty

2.2Related Tables
TableTable Description
----------------------

2.3Related Business Functions
Source NameFunction Name
------------------------

Processing

1. Access cache identified by Cache ID.

2. If cache contains any records, the number of records will be returned in mnNoOfRecordsInCache. If
the cache is empty, an error code will be returned.

Notes:

Data Structure

D0500027A - Get number of records In EE PDBA cache

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
szEEPDBACacheID	PID	char	REQ	INPUT
The number that identifies the batch or interactive program (batch or interactive object). For example, the number of the Sales Order Entry interactive program is P4210, and the number of the Print Invoices batch process report is R42565. The program ID is a variable length value. It is assigned according to a structured syntax in the form TSSXXX, where: T The first character of the number is alphabetic and identifies the type, such as P for Program, R for Report, and so on. For example, the value P in the number P4210 indicates that the object is a program. SS The second and third characters of the number are numeric and identify the system code. For example, the value 42 in the number P4210 indicates that this program belongs to system 42, which is the Sales Order Processing system. XXX The remaining characters of the numer are numeric and identify a unique program or report. For example, the value 10 in the number P4210 indicates that this is the Sales Order Entry program.
cSetOWErrorFlag01	EV01	char	REQ	INPUT
An option that specifies the type of processing for an event.
mnNoOfRecordsInCache	MATH06	MATH_NUMERIC	REQ	OUTPUT
Event point for Math Numeric.
mnErrorCodeReturned	MATH06	MATH_NUMERIC	REQ	OUTPUT
Event point for Math Numeric.

Related Functions

N0500007 Get Local Union Code

Related Tables

F07210 Pay Cycle Parameters File

GetSVH_PDBA_CodesFromCache

Read Employee PDBA Cache Created by B0700020

Minor Business Rule

Object Name: B0500027

Parent DLL: CFND

Location: Client/Server

Language: C

(Note: make this window as wide as possible to clearly view the Parameters table)

Source Name:B0500027

Data Structure:D0500027B

Function Name:Read Employee PDBA Cache created by B0700020 -
Get SVH PDBA Codes from Cache

System Code:05A

Designer:David Scott

Programmer:Falah Thamir

Function Category:

Function Use:

Revisions Log
Date:24 April, 1998
Modifications by:Falah Thamir
SAR Number:1958608
Description:Creation

1.Functional Description

1.1Purpose

This function will retrieve cache data created by B0700020 related to SVH-type
(Sick/Vacation/Holiday) PDBA's.

1.2Setup Notes and Prerequisites

The function B0700020, InitializeEEPDBACache, followed by ProcessEEPDBACache with DISO = "A" to fetch
accrual-type PDBA records, must first be called to create the cache. The cache created by B0700020 is
sorted by DISO/SVH/PDBA.

1.3Special Logic

2.Technical Specifications

2.1Parameters:
Data ItemData Structure DescriptionI/ORequrdNotes
-------------------------------------------------------------------
PIDszEEPDBACacheIDIxPass the value assigned
by B0700020,
InitializeEEPDBACache

AN8mnAN8_AddressNumberIxAddress Number

MATH06mnRecordNumberInCacheIxRecord number in cache

EV01cSetOWErrorFlag01IxFlag to set OneWorld
errors
1 = set OneWorld errors
anything else = do not set
OneWorld errors
Error codes are always
returned in
mnErrorCodeReturned
Note: do not set OneWorld errors in batch operations

MATH06mnErrorCodeReturnedOxError code returned by
this function
0 = no errors
1 = cache is empty or has been terminated
2 = mnAddressNumber format is wrong
4 = mnRecordNumber format is wrong or < 1
6 = the format of both Address Number and record number are wrong
8 = number of records in cache < record number requested
9 = Cache has data from a different Address Number or Address
Number in cache has wrong format
10 = DISO not equal to "A", i.e. PDBA is not an accrual type
11 = cache cannot be initialized (error from jdeCacheInit API)
12 = cannot open a cursor to access the cache (error from
jdeCacheOpenCursor API)
13 = cannot close cursor to cache (error from
jdeCacheCloseCursor API)
14 = cannot fetch from cache (error from jdeCacheFetch API)

DISOcDISO_DBATypeOxDBA Type; should be "A"
(Accrual) for SVH-type
PDBA's

SVHcSVH_AccrualTypeOxBenefit/Accrual Type

PDBAmnPDBACodeOxPDBA Code

ACOcACOAvailableCarryover
OfAvailYNOxAvailable Carryover, Y/N

2.2Related Tables
TableTable Description
----------------------

2.3Related Business Functions
Source NameFunction Name
------------------------

Processing

1. Access cache identified by CacheID.

2. Get number of records in cache and compare with number of record requested. If mnRecordNo > no. of
records in cache, return with an error code.

3. Go to record number mnRecordNumber, retrieve data, and pass back information in parameter list.

Notes:

When access to cache is no longer needed, call B0700020, EndEEPDBACache, to free memory.

Data Structure

D0500027B - Get Employee SVH PDBA Codes from Cache

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
szEEPDBACacheID	PID	char	REQ	INPUT
The number that identifies the batch or interactive program (batch or interactive object). For example, the number of the Sales Order Entry interactive program is P4210, and the number of the Print Invoices batch process report is R42565. The program ID is a variable length value. It is assigned according to a structured syntax in the form TSSXXX, where: T The first character of the number is alphabetic and identifies the type, such as P for Program, R for Report, and so on. For example, the value P in the number P4210 indicates that the object is a program. SS The second and third characters of the number are numeric and identify the system code. For example, the value 42 in the number P4210 indicates that this program belongs to system 42, which is the Sales Order Processing system. XXX The remaining characters of the numer are numeric and identify a unique program or report. For example, the value 10 in the number P4210 indicates that this is the Sales Order Entry program.
mnAN8_AddressNumber	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.
mnRecordNumberInCache	MATH06	MATH_NUMERIC	REQ	INPUT
Event point for Math Numeric.
cSetOWErrorFlag01	EV01	char	REQ	INPUT
An option that specifies the type of processing for an event.
mnErrorCodeReturned	MATH06	MATH_NUMERIC	REQ	OUTPUT
Event point for Math Numeric.
cDISO_DBAType	DISO	char	REQ	OUTPUT
A code used to distinguish between the following types of payroll entries: P Time Cards (Earnings) D Deductions withheld B Benefit (both cash and non cash) A Accrual of sick, vacation, comp, and so forth Note: These codes may only be changed by J.D. Edwards If you enter an * in this field the system displays all four types of PDBAs.
cSVH_AccrualType	SVH	char	REQ	OUTPUT
A user defined code (system 06, type SV) that specifies whether the benefit or accrual type is sick, vacation, holiday, leave, or other.
mnPDBACode	PDBA	MATH_NUMERIC	REQ	OUTPUT
A code that defines the type of pay, deduction, benefit, or accrual. Pay types are numbered from 1 to 999. Deductions and benefits are numbered from 1000 to 9999.
cACOAccruCarryoverOfAvailYN	ACO	char	REQ	OUTPUT
This code is internally set by the system during DBA Setup. If a DBA has related pay types the code is set to Y. This tells the system that this is the available DBA. All other DBAs will have a code of N.

Related Functions

N0500007 Get Local Union Code

Related Tables

F07210 Pay Cycle Parameters File

ore this DBA calculates. For example; deduction 1400 has an annual
limit of $2,000.00. After this limit is met, deduction 1500 begins calculation and withholding. The DBA number of the predecessor must be lower
than the successor's number.

szDeductionGroupDGRPcharOPTOUTPUT

Specify a code common to all deductions or benefits that share the same limitations (for example, pay period dollar amount or percentage,
monthly,annual, and so on). The system takes these limits from the first deduction encountered in the group, and withholds for all
deductions until the limit is reached for the aggregate. Example: Deduction 6400, Group A, Annual Limit = $1000, No Pay Period Limit Deduction 6430,
Group A, No Annual or Pay Period Limit Deduction 7700, Group A, No Annual or Pay Period Limit Deduction 9400, Group B, No Annual or Pay
Period Limit Deduction 7550, Group B, No Annual Limit, Pay Period Limit = $50 For this example, the system looks at the deductions
assigned to Group A, and applies a $1000 annual limit for all three deductions. The system continues to take the deductions from an employee's
paycheck until a total of $1000 has been deducted between all entities in Group A for the year. For deductions in Group B, the system deducts
no more than $50 per pay period between for the two deductions.

cArrearageRulesARRRcharOPTOUTPUT

A code indicating how to adjust deductions when the employee is in a negative pay situation. Valid codes are: P Do a partial or full
deduction as needed. This is the default. F Do a full reduction or none at all. N Do not reduce. Q Same as code P. In addition, place the amount in
arrears, but do not apply the limits when collecting the arrearage. Write the arrearage balance to history. R Same as code P. In addition, place the
amount in arrears and apply the limits when collecting the arrearage. Write the arrearage balance to history. G Same as code F. In addition,
place the amount in arrears, but do not apply the limits when collecting the arrearage. Write the arrearage balance to history. H Same as
code F. In addition, place the amount in arrears and apply the limits when collecting the arrearage. Write the arrearage balance to
history. S Same as code P. In addition, place the amount in arrears for the current pay period only but do not apply the limits when collecting the
arrearage. Do not write the arrearage balance to history. T Same as code P. In addition, place the amount in arrears for the current pay period only and
apply the limits when collecting the arrearage. Do not write arrearage balance to history. I Same as code F. In addition, place the amount in
arrears for the current pay period only, but do not apply the limits when collecting the arrearage. Do not write arrearage balance to
history. J Same as code F. In addition, place the amount in arrears for the current pay period only and apply the limits when collecting the arrearage. Do
not write arrearage balance to history.

mnLimitOnQuarterlyDlsQDLMATH_NUMERICOPTOUTPUT

The maximum amount that can be withheld or accrued in a calendar quarter for a deduction, benefit or accrual. This amount is expressed in
dollars for deductions and benefits. For accruals, this amount is expressed in hours.

mnPayrollTransactionNoPRTRMATH_NUMERICOPTOUTPUT

A unique number that the system assigns to each timecard. You can use this field in the Time Entry By Job program to retrieve a specific
timecard for display. This field is also used to tie a timecard to each Actual Burden audit record created for the timecard during the Actual
Burden Journaling process.

szUnionCodeF06106UNcharOPTOUTPUT

A user defined code (06/UN) that represents the union or plan in which the employee or group of employees work or participate.

mnAmountOrRateSecondAMTSMATH_NUMERICOPTOUTPUT

The second amount or rate associated with a deduction, benefit, or accrual. Because many DBA types require multiple tiers, two levels of
Amount (Rate) exist. The system uses the first level, Amount (Rate) 1, until the annual limit is reached. Then, the second level, Amount (Rate) 2,
begins the next time the employee is paid. Amount (Rate) 2 continues until the second annual limit is reached. This field works in conjunction
with the annual limit fields. The rate you enter in this field supersedes any other table rate for an employee, except for one-time overrides
during time entry.

mnAnnualLimitLevel2SADLMATH_NUMERICOPTOUTPUT

The maximum amount that can be withheld or accrued in a year for a deduction, benefit or accrual. This amount is expressed in dollars for
deductions and benefits. For accruals, this amount is expressed in hours. NOTE: This field represents the second level annual limitation. It is
used when there is an initial annual limit which has been reached. The DBA will calculate using amount rate 2.

cZeroOverrideFlagZOVRcharOPTOUTPUT

A Yes/No field indicating whether the system treats the Amount/Rate field as a zero amount override. You use this field primarily when an
employee is part of a group plan yet does not receive a particular benefit in that plan.

cGenerateVoucherFlagGVCHcharOPTOUTPUT

A code used to determine whether the system should generate a voucher for the DBA, tax, or wage attachment during the final update
phase of the payroll processing cycle. Valid codes are: N No, do not generate a voucher Y Yes, generate a voucher

szPlanIdPLANcharOPTOUTPUT

An abbreviation or number that identifies a specific employee benefit. Examples are: o Employee Health Insurance o Accidental Death
and Dismemberment o Health Club Expense Reimbursement o Employee Stock Appreciation Rights A benefit plan typically is associated
with a deduction, benefit, or accrual. For example, a medical plan is a benefit that might also require a deduction to withhold premiums from
an employee's pay.

szNameAlphaExplanationEXAcharOPTOUTPUT

A description, remark, explanation, name, or address.

cDeductionBenefitMethodDEDMcharOPTOUTPUT

A user defined code (07/DM) that specifies the method that the system uses to perform certain calculations. For example, the system uses
a method of calculation to calculate deductions, benefits, and accruals (DBAs) and workers' compensation insurance.

cDecliningBalanceDBALcharOPTOUTPUT

A code that indicates whether you want the system to use the Amount Due at the DBA, group, or employee level to determine whether to
use the specified deduction in a payroll cycle. Clicking on the field enables the Amount Due field to continue the deduction until the amount is
zero. When you choose this field, you must also enter a value in the Amount Due field, otherwise the system considers the deduction to be
cleared or inactive. If you do not click on this field, the Amount Due will not be used with the specified deduction. For advance deductions, you
must click this field.

cUseNumberOfPeriodsNPERcharOPTOUTPUT

When you set up a DBA that is not a wage attachment deduction, use this field to indicate whether you want the system to read the Number
of Periods field to determine if this DBA should be included in the payroll cycle. If you enter a Y, the number of periods must be entered in the
No. of Deductions field or the system considers the DBA to be inactive. When you set up a wage attachment DBA, leave this field blank. Use
the Employee Wage Attachment Entry form to enter the number of periods for which the deduction should be taken. For One World valid
values are: Click on the field if you want the system to read the Number of Periods field and continue the DBA only until the amount due is zero.
Blank Do not read the Number of Periods field for this DBA. For World, valid values are:    Y        Yes, read the Number of Periods field and
continue this DBA only until the amount due is zero.    N        No, do not read the Number of Periods field for this DBA.    Blank Do not read the
Number of Periods field for this DBA.

szAnniversaryFiscalBeginniAFDTcharOPTOUTPUT

A user-defined code (07/AF) that specifies when the rollover year begins.  If blank, the system rolls the accrual over at the end of the
standard calendar year (December 31, XXXX).   To specify a fiscal year, enter user defined code FISC.  The system will use the fiscal year setup for
the employee's home company. To specify an anniversary year, enter any of the other codes in the user defined code table.  For example,
if you want the rollover year to begin on the employee's date of birth, use code DOB. To create related DBAs, use the same date code on
both the DBA for the accrual, and the DBA for the available balance.

cFileCodeEV01charREQOUTPUT

An option that specifies the type of processing for an event.

szNameAlphaALPHcharOPTOUTPUT

The text that names or describes an address. This 40-character alphabetic field appears on a number of forms and reports. You can enter
dashes, commas, and other special characters, but the system cannot search on them when you use this field to search for a name.

szCostCenterHomeHMCUcharOPTOUTPUT

The number of the business unit in which the employee generally resides.

szUnionCodeUNcharOPTOUTPUT

A user defined code (06/UN) that represents the union or plan in which the employee or group of employees work or participate.

szJobCategoryJBCDcharOPTOUTPUT

A user defined code (07/G) that defines the jobs within your organization. You can associate pay and benefit information with a job type and
apply that information to the employees who are linked to that job type.

szJobStepJBSTcharOPTOUTPUT

A user defined code (07/GS) that designates a specific level within a particular job type. The system uses this code in conjunction with job
type to determine pay rates by job in the Pay Rates table.

szCountryForPayrollCCPRcharOPTOUTPUT

A user defined code list 00/CN that indicates the country in which the employee resides.

szBenefitGroupCodeDIVCcharOPTOUTPUT

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.

Related Functions

N0500007 Get Local Union Code

Related Tables

F07210 Pay Cycle Parameters File

GetNumOfRecsInEEPDBACache

Read Employee PDBA Cache Created by B0700020

Minor Business Rule

Object Name: B0500027

Parent DLL: CFND

Location: Client/Server

Language: C

(Note: make this window as wide as possible to see the Parametrs table clearly)

Business Function Specification
<