CommonTestAllDBAs

Perform Functions and Tests for DBA Calculations

Minor Business Rule

Object Name: N0700005

Parent DLL: CPAY

Location: Client/Server

Language: NER

Data Structure

DN0700005A - DS for Common Test All DBA's

Parameter NameData ItemData TypeReq/OptI/O/Both
cDeductionBasisDESQDESQcharREQBOTH

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.

cGrossPayEffectPAYGPAYGcharREQBOTH

A code that indicates whether the pay type is added to, subtracted from, or does not affect the employee's gross pay. Valid values 
are: + Pay type will be added to the employee's gross pay. - Pay type will be subtracted from the employee's gross pay. Blank Pay type will not have 
an effect on the employee's gross pay.  A pay type should not have a negative effect on gross pay. If you set up a pay type to have a negative 
effect on gross or net pay, gross-to-net errors appear on the Payroll Register.  PeopleSoft recommends that you set up a deduction instead 
of a pay type that would have a negative effect on gross pay. When you set up a pay type with no effect on gross pay and a positive effect 
on net pay, do not create a separate check. Creating a separate check will cause a gross-to-net error.

cNetPayEffectPAYNPAYNcharREQBOTH

A code that indicates whether the pay type is added to, subtracted from, or does not affect the employee's net pay. Valid values are:    +        
Pay type will be added to the employee's net pay    -         Pay type will be subtracted from the employee's net pay    blank Pay type will not 
have an effect on the employee's net pay  A pay type should not have a negative effect on net pay. If you set up a pay type to have a negative 
effect on gross or net pay, gross-to-net errors appear on the Payroll Register. J.D.Edwards recommends that you set up a deduction instead 
of a pay type that would have a negative effect on gross pay. When you set up a pay type with no effect on gross pay and a positive effect 
on net pay, do not create a separate check. Creating a separate check will cause a gross-to-net error.

cProcessDuringPrePayrollPPRYPPRYcharREQBOTH

A code specifying whether a benefit is calculated during pre-payroll processing.  Valid codes are: Y Yes, calculate the benefit during 
pre-payroll processing. N No, calculate the benefit during the journal entry step of the payroll cycle. In general, all benefits and accruals are 
calculated during the processing of journal entries because they do not affect the gross-to-net calculation.  However, certain benefits, such as group 
life insurance and the corresponding excess life insurance benefit, must be calculated in pre-payroll because they affect the gross-to-net 
calculation. If you want the benefit or accrual to print on the employee's paystub, use Y and complete the Method of Printing field. 

cSelectionFlagEV01charREQBOTH

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

cDeductionOrNetFlagEV01charREQNONE

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

Related Functions

None

Related Tables

None
ComputePayPeriodoftheMonth

ComputePayPeriodoftheMonth

Perform Functions and Tests for DBA Calculations

Minor Business Rule

Object Name: N0700005

Parent DLL: CPAY

Location: Client/Server

Language: NER

Data Structure

DN0700005B - DS For Computing Pay Period of the Month

Parameter NameData ItemData TypeReq/OptI/O/Both
cPayFrequencyPFRQcharREQINPUT

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.

cPayPeriodNumberWPPM1charOPTINPUT

The number of the pay period, within the month, for employees who are paid weekly. This field is used in conjunction with the Pay Period to 
Calculate field on the DBA Setup form to determine which deductions, benefits, and accruals the system will calculate during the current 
payroll cycle.

cPayPeriodNumber2PPM2charOPTINPUT

The number of the pay period, within the month, for employees who are paid biweekly. The system uses this value and the Pay Period to 
Calculate, from the DBA Setup form, to determine which deductions, benefits, and accruals to calculate during the current payroll cycle.

cPayPeriodNumber3PPM3charOPTINPUT

The number of the pay period, within the month, for employees paid semimonthly. The system uses this value and the Pay Period to 
Calculate, from the DBA Setup form, to determine which deductions, benefits, and accruals to calculate for the current payroll processing cycle.

cPayPeriodNumber4PPM4charOPTINPUT

The number of the pay period within the month, for employees who are paid monthly. This field is used in conjunction with the Pay Period to 
Calculate field on the DBA Setup form to determine which deductions, benefits, and accruals are to be calculated during this payroll cycle.

cPayPeriodNumber5PPM5charOPTINPUT

The number of the pay period for employees who are paid annually. This field is used in conjunction with the Pay Period to Calculate field 
on the DBA Setup form to determine which deductions, benefits, and accruals are to be calculated during this payroll cycle.

cPayPeriodNumber6PPM6charOPTINPUT

The number of the pay period, within the month, that is used in conjunction with the Pay Period to Calculate field on the DBA Setup form to 
determine which deductions, benefits, and accruals are to be calculated during this payroll cycle.

cPayPeriodOfTheMonthPPPcharOPTOUTPUT

The pay period of the MONTH.

Related Functions

None

Related Tables

None
DBALimitsProcessing

DBALimitsProcessing

Perform Functions and Tests for DBA Calculations

Minor Business Rule

Object Name: N0700005

Parent DLL: CPAY

Location: Client/Server

Language: NER

Data Structure

DN0700005E - DS for DBA Limit Processing

Parameter NameData ItemData TypeReq/OptI/O/Both
mnLimitAmount_PercentLCLMATH_NUMERICOPTNONE

The lower or minimum amount to be compared.

mnAmountRTAMMATH_NUMERICOPTNONE

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. 

mnPercentagePPPLMATH_NUMERICOPTNONE

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.

mnAmtGrossPayGPAMATH_NUMERICOPTNONE

The actual gross pay amount for an employee. This amount is to be distinguished from the distributed gross pay amount used for labor 
distribution. See data item DPAY. When using Work Order Time Entry, this field is used to record miscellaneous pay for an employee, (for 
example, piece rate bonus).

mnArrearageAmountARRAMATH_NUMERICOPTNONE

The amount of the deduction that is being or has been reduced because the employee did not receive wages that could cover the payroll 
taxes and deductions calculated within the payroll cycle.

cArrearageRulesARRRcharOPTNONE

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.

Related Functions

None

Related Tables

None
RetrievePayFrequencyDivisor

RetrievePayFrequencyDivisor

Perform Functions and Tests for DBA Calculations

Minor Business Rule

Object Name: N0700005

Parent DLL: CPAY

Location: Client/Server

Language: NER

Data Structure

DN0700005D - DS for retrieving the divisor for a Pay Frequency

Parameter NameData ItemData TypeReq/OptI/O/Both
cPayFrequencyPFRQcharOPTINPUT

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.

mnPayPeriodsperYearMATH01MATH_NUMERICOPTOUTPUT

- - - Good Performance Low Value. 

Related Functions

None

Related Tables

None
SelectionFlagAndCBasisTest

SelectionFlagAndCBasisTest

Perform Functions and Tests for DBA Calculations

Minor Business Rule

Object Name: N0700005

Parent DLL: CPAY

Location: Client/Server

Language: NER

Data Structure

DN0700005 - DS for DBA Calculations C- Basis Test

Parameter NameData ItemData TypeReq/OptI/O/Both
cDeductionBasisDESQcharREQOUTPUT

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.

cPayPeriodNumberPPM1charOPTOUTPUT

The number of the pay period, within the month, for employees who are paid weekly. This field is used in conjunction with the Pay Period to 
Calculate field on the DBA Setup form to determine which deductions, benefits, and accruals the system will calculate during the current 
payroll cycle.

cDeductionPeriod001DEP1charOPTOUTPUT

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.

cDeductionPeriod002DEP2charOPTOUTPUT

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.

cDeductionPeriod003DEP3charOPTOUTPUT

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.

cDeductionPeriod004DEP4charOPTOUTPUT

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.

cDeductionPeriod005DEP5charOPTOUTPUT

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.

cDeductionPeriod006DEP6charOPTOUTPUT

A code designating the pay period in which the system calculates the DBA or auto deposit.  Valid codes are: Y  Calculate the DBA or auto 
deposit during the current period. N  Do not calculate the DBA or auto deposit during the current period. *        Calculate the DBA or auto deposit 
only during the first pay period for each month that 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 or 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 or auto deposit in that period. M 
Use this value only in the fifth period field to calculate the benefit or accrual during the special, or manual timecard post.   M applies only to 
benefits or accruals based on gross hours or dollars.  An M implies a Yes for a weekly withholding frequency.  You should not use this value for 
any DBA with B in the Method of Calculation field.

cYDPayPeriodNumbersPPMBcharOPTOUTPUT

For WorldSoftware: The definition of this field depends on the program from which you access the field:     o Valid Master Pay Cycles 
(P069061) - A value that specifies which period bucket number in the Payroll Integrity table (F0620) will be updated.        The integrity period number 
specifies one of five periods in which the system stores the history. It does not determine the calculation of DBAs. If you run a multiple 
frequency payroll (such as salary with both weekly and biweekly employees), enter an unused integrity period number. For example, for the first 
biweekly payroll of the month, use 2         because 1 was already used for the first weekly payroll.     o Pay Cycle Control Parameters (P06210) - A 
value that specifies whether the pre-payroll programs will calculate those benefits and accruals that are based on calendar month amounts 
(dollars/hours). If the value is N, the system skips these benefits and accruals. For OneWorld: A value that specifies whether the pre-payroll 
programs will calculate benefits and accruals that are based on calendar month amounts (dollars/hours). Valid values are:    Y        Yes. The 
pre-payroll programs will calculate benefits and accruals that are based on calendar month amounts (dollars/hours).    N        No. The pre-payroll 
programs will not calculate benefits and accruals that are based on calendar month amounts (dollars/hours).    Blank Same as N.

cSelectionFlagEV01charREQBOTH

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

Related Functions

None

Related Tables

None
TestForF0705Existence

TestForF0705Existence

Perform Functions and Tests for DBA Calculations

Minor Business Rule

Object Name: N0700005

Parent DLL: CPAY

Location: Client/Server

Language: NER

Data Structure

DN0700005C - DS for Test of F0705 to see if it exists

Parameter NameData ItemData TypeReq/OptI/O/Both
mnAddressNumberAN8AN8MATH_NUMERICREQINPUT

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

mnPayDeductBenAccTypePDBAPDBAMATH_NUMERICREQINPUT

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.

mnDateYrDTEYDTEYMATH_NUMERICREQINPUT

A two-digit number that specifies the applicable year. If you leave this field blank, the program uses the system date.

mnHistoryMonthOfUpdateHMOHMOMATH_NUMERICREQINPUT

The number of the month in which the history files were updated.

cPayPeriodOfTheMonthPPPcharREQINPUT

The pay period of the MONTH.

cRecordFoundFlagEV01charOPTOUTPUT

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

mnWaControlNumberWANOMATH_NUMERICREQINPUT

A control number used to group and identify all related elements associated with a Wage Attachment (Garnishment, Levy, Child Support or 
Loan). This number is assigned by the system and is used to attach a specific deduction to its related Wage Attachment information.

szCompanyHomeHMCOcharREQINPUT

The company number where the employee records generally reside.

szTaxIdentificationNoTAXXcharOPTINPUT

A number that identifies your company to the tax authority. This number can include the tax ID number for an individual, a federal or state 
corporate tax ID, a sales tax number, and so on. This number has specifically been established for the Payroll system to handle the 
requirements of taxing authorities that require more than 9 positions for the tax identification number. Do not enter hyphens (dashes), slashes, spaces, or 
other punctuation in the tax identification number.

cRetrievePDBAHistorySysFlagPHISTcharOPTINPUT

A value that specifies how the system retrieves PDBA history during payroll processing. You can set up the system to retrieve employee 
PDBA history for only the Corporate Tax ID in which the employee works during the pay period, or to retrieve all PDBA history for an employee 
regardless of Corporate Tax ID. You may choose to set up the system to retrieve PDBA history across all Corporate Tax IDs if employees in 
your organization frequently change companies. Retrieving PDBA history across multiple tax IDs allows the system to collect amounts that 
remain in arrears under one Corporate Tax ID if the employee moves to a company with a different Corporate Tax ID. The Special Taxes 
function retrieves total pay period gross earnings across multiple tax IDs, and delivers that amount to Vertex. Therefore, pay period tax limits for 
Federal and State Unemployment and other taxes that have limits are recognized across multiple tax IDs regardless of Common 
Paymaster. Also, with Special Taxes, current payment taxes and taxable gross are determined by reducing the prior pay period tax amounts from the 
summarized tax amounts. You can also determine how the system retrieves PDBA history at the PDBA level. Valid values are: 0 Use the 
information from PDBA setup to determine how the system retrieves PDBA history amounts. Common Paymaster, at the Federal and State levels, 
applies when retrieving current tax amounts from the Tax Detail File (F07353) that are combined with historical tax amounts that are retrieved 
from the Tax History table (F06136). 1 Retrieve PDBA history for only the Corporate Tax ID in which the employee worked during the pay 
period, ignoring the setting at the PDBA level. Common Paymaster, at the Federal and State levels, applies when retrieving current tax amounts 
from the Tax Detail File that are combined with historical tax amounts that are retrieved from the Tax History table. 2 Retrieve PDBA history 
across all Corporate Tax IDs, ignoring the setting at the PDBA level.Special Taxes retrieves total pay period wages across multiple tax IDs and 
delivers the summarized amount to Vertex. Pay period tax limits are recognized regardless of Common Paymaster. Common Paymaster, at 
the Federal and State levels, applies only for retrieving historical tax amounts from F06136. Note:  When you enter a value for Retrieve PDGA 
History System Flag (PHIST), you need to also carefully review the glossary and setting for Common Paymaster (CPYM) on Corporate Tax 
ID Revisions (P059081A). 

cRetrievePDBAHistorySinglePHISHcharOPTINPUT

This option determines how the system retrieves PDBA history for an employee. This value works in conjunction with the Retrieve PDBA 
History System Flag on the Additional Options tab of the Company Options form for Company 0 (zero). If that flag is set to look at each PDBA to 
determine how to retrieve PDBA history, you must enter a value in this field. Valid values are: 1 Retrieve PDBA historical amounts using the 
Corporate Tax ID associated with the Home Company on the employee's timecard. (Default)   2 Retrieve PDBA historical amounts across all 
Corporate Tax IDs for which the employee has history for the current year.

Related Functions

None

Related Tables

None