EndPayrollRegisterCache

Create Payroll Register Cache

Minor Business Rule

Object Name: B0700006

Parent DLL: CPAY

Location: Client/Server

Language: C

Data Structure

D0700006A - DS for Initialize Payroll Register Cache

Parameter NameData ItemData TypeReq/OptI/O/Both
szPayrollRegisterCachePIDcharOPTNONE

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.

Related Functions

B0000564 Get Internal Next Number

Related Tables

None
InitializePayrollRegisterCache

InitializePayrollRegisterCache

Create Payroll Register Cache

Minor Business Rule

Object Name: B0700006

Parent DLL: CPAY

Location: Client/Server

Language: C

Data Structure

D0700006A - DS for Initialize Payroll Register Cache

Parameter NameData ItemData TypeReq/OptI/O/Both
szPayrollRegisterCachePIDcharOPTNONE

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.

Related Functions

B0000564 Get Internal Next Number

Related Tables

None
ProcessPayrollRegisterCache

ProcessPayrollRegisterCache

Create Payroll Register Cache

Minor Business Rule

Object Name: B0700006

Parent DLL: CPAY

Location: Client/Server

Language: C

Functional Description

Purpose

The purpose of this business function is to create, write, and update the Payroll Register Cache in 
order to keep track of Business Unit, Company, and Grand Totals when creating the Payroll Register 

report (R073012).

Setup Notes and Prerequisites


Special Logic




Technical Specification

Parameters

D0700006A

Data Item Data Structure DescriptionI/ORequiredNotes
PIDPayroll Register CacheI/OYThis is the Unique Payroll Register cache name created by 

next numbers that is returned from Initialize Payroll Register Cache.  This is also the Payroll 

Register Cache name that is passed to End Payroll Register Cache to terminate all handles to the cache.


D0700006B

Data Item Data Structure DescriptionI/ORequiredNotes
PIDPayroll Register CacheIYUnique Payroll Register Cache Name

HMCOCompany HomeIYHome Company  F07350

HMCUCost Center HomeIYHome Business Unit  F07350

PDBAPBDA Code1I/OYPay Type Code  F07352

DL01Pay Type DescriptionI/OYPay Type Desc  F07352

HRWHours WorkedI/OYHours Worked  F07352

GPAYPay Type Current AmountI/OYPay Type Current Amt  F07352

YTDPay Type YTD AmountI/OYPay Type YTD Amt  F07352

PTAXPayroll Tax TypeI/OYTax Type  F07352

TARATax Area WorkI/OYTax Area  F07352

DBARPDBACode2I/OYDeduction Code  F07352

DL02Tax Deduction DescriptionI/OYTax/Deduction Desc  F07352

SCURTax Deduction Current AmountI/OYTax/Deduction Current Amt  F07352

YTDGTax Deduction YTD AmountI/OYTax/Deduction YTD Amt  F07352

EV01Pay Type FlagI/OYPay Type Flag  used to keep track of pay types that are left in 

the cache.

EV02Tax FlagI/OYTax Flag  used to keep track of taxes that are left in the cache.

EV03Deduction FlagI/OYDeduction Flag  used to keep track of deductions that are left in 

the cache.

EV04Processing ModeIYPass '1' to Write Records to Cache; Pass '2' to Retrieve totals 

from Cache

INT01Line NumberI/OYUsed so that the Gross Wage Line will not be overwritten.



Related Tables
 

Table Table Description
None


Processing


If the processing mode is equal to '1' then:

     -Call I_B0700006_Write_PayrollRegister_Cache_Records

     -Create the correct key to the Payroll Register Cache determined by whether you are

     working with a pay type, taxe or deduction.  Because you want the records to be written

     into the correct order it is important on how the key is loaded.


If the record is a pay type the key is as follows: 
Key FieldValueSource
Home CompanyF07352

Home Business UnitF07352

PDBACode1F07352

Tax TypeBlank

Tax AreaBlank

PDBACode2Zero


If the record is a tax the key is as follows:

Key FieldValueSource

Home CompanyF07352
Home Business UnitF07352

PDBACode1'99999'F07352

Tax TypeBlankF07352

Tax AreaBlankF07352

PDBACode2Zero


If the record is a deduction the key is as follows:

Key FieldValueSource

Home CompanyF07352
Home Business UnitF07352

PDBACode1'99999'F07352

Tax Type'ZZ'

Tax AreaBlank

PDBACode2ZeroF07352


     Based on the type you are working with (pay type, tax, or deduction) update records in the

     cache if they are present.  If they are not present add the records.

          -If the cache never had any records to begin with (i.e. the first time through) create

          records in the cache according to the type.


     If the processing mode is equal to '2' then:

          -Call I_B0700006_Retrieve_Totals


          -If the Total Mode Flag = '0' then:

               - Retrieve records from the Payroll Register Cache for Business Unit totals.

               - Retrieve records for pay types, taxes and deductions.  

               - Delete the cache record so that it will not be retrieved again.  

               - Update appropriate flag when fetch not successful.

- Update the Business Unit field in the cache records with "Blanks" to prepare for
 -Company Total time.  Also add or update the appropriate record totals in the cache based on 

whether it is a pay type, tax, or deduction


          -If the Total Mode Flag = '1' then:

               - Retrieve records from the Payroll Register Cache for Company totals.

               - Retrieve records for pay types, taxes and deductions.  

               - Delete the cache record so that it will not be retrieved again.  

               - Update appropriate flag when fetch not successful.

               - Update the Company field in the cache records with "Blanks" so that we can

update or add a grand total for either a pay type, tax, or deduction record.

          - If the Total Mode Flag = '2' then:

               - Retrieve records from the Payroll Register Cache for Grand totals.

               - Retrieve records for pay types, taxes and deductions.  

               - Delete the cache record so that it will not be retrieved again.  

               - Update appropriate flag when fetch not successful.


Data Structure

D0700006B - DS for Process Payroll Register Cache

Parameter NameData ItemData TypeReq/OptI/O/Both
szPayrollRegisterCachePIDcharOPTNONE

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.

szCompanyHomeHMCOcharOPTNONE

The company number where the employee records generally reside.

szCostCenterHomeHMCUcharOPTNONE

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

mnPBDACode1PDBAMATH_NUMERICOPTNONE

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.

szPayTypeDescriptionDL01charOPTNONE

A user defined name or remark.

mnHoursWorkedHRWMATH_NUMERICOPTNONE

The number of hours associated with each transaction.

mnPayTypeCurrentAmountGPAYMATH_NUMERICOPTNONE

The actual gross pay amount for an employee. This amount is different from the distributed gross pay amount used for labour 
distribution. On Work Order Time Entry, use this field to record miscellaneous pay for an employee, such as piece rate bonus.

mnPayTypeYTDAmountYTDMATH_NUMERICOPTNONE

The sum of all net postings from the first day of the current fiscal year to the last day of the current month or period. The system uses the 
period totals from the Account Balances table (F0902) to calculate the YTD period end total.

szPayrollTaxTypePTAXcharOPTNONE

A code that specifies the type of payroll tax being processed. This is a user defined code (07/TX). To set up state minimum wage amounts, 
you must enter MW in this field. To do so, you must first add MW to UDC 07/TX. However, you should not change the codes and definitions 
that J.D. Edwards provides with the software.

szTaxAreaWorkTARAcharOPTNONE

A code that identifies a geographical location and the tax authorities for an employee work site, including employee and employer statutory 
requirements. In the Vertex payroll tax calculation software, the tax area code is synonymous with GeoCode. To determine the valid codes 
for your location, refer to the documentation for the tax calculation software that you are using.

mnPDBACode2DBARMATH_NUMERICOPTNONE

The code associated with a deduction, benefit, or accrual (DBA) that was used to calculate the employee's net payment. This code prints 
on the right side of the payment stub.

szTaxDeductionDescriptionDL02charOPTNONE

Additional text that further describes or clarifies a field in the system.

mnTaxDeductionCurrentAmountSCURMATH_NUMERICOPTNONE

The current amount of gross pay, taxes, deductions, or benefits. This value only appears on the right hand side of the stub.

mnTaxDeductionYTDAmountYTDTMATH_NUMERICOPTNONE

Calendar year-to-date payroll taxes withheld.

cPayTypeFlagEV01charOPTNONE

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

cTaxFlagEV02charOPTNONE

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

cDeductionFlagEV03charOPTNONE

A radio button that specifies the level at which trace/track result is to be displayed.  Select the Detail to display all transactions except IB, IX, 
and IZ types.  Or, select Derivative Lots Only to display only those transactions that may have created new derivative lot. 

cProcessingModeEV04charOPTNONE

PeopleSoft event point processing flag 04.

nLineNumberINT01integerOPTNONE

Number of Days in Future to Query for Responses Due. 

mnAddressNumber_AN8AN8MATH_NUMERICOPTNONE

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

Related Functions

B0000564 Get Internal Next Number

Related Tables

None