EndCachesPayrollJournals

Create Caches For Payroll Journals

Minor Business Rule

Object Name: B0700026

Parent DLL: CPAY

Location: Client/Server

Language: C

^

Data Structure

D0700026 - DS For Initialize/Ending Caches For Payroll Journal

Parameter NameData ItemData TypeReq/OptI/O/Both
szJournalTaxCacheNamePIDcharOPTNONE

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.

mnJobnumberAJOBSMATH_NUMERICOPTNONE

The job number (work station ID) which executed the particular job.

szJournalDBACacheNamePIDcharOPTNONE

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.

szJournalTimecardCacheNamePIDcharOPTNONE

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.

szJournalWCCacheNamePIDcharOPTNONE

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.

szJournalWCAccumCacheNamePIDcharOPTNONE

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.

szJournalKeyCacheNamePIDcharOPTNONE

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.

szJournalTaxableAmountCachePIDcharOPTNONE

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.

szJournalDBATaxExemptCachePIDcharOPTNONE

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.

szJournalHandleCacheNamePIDcharOPTNONE

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

None

Related Tables

None
InitializeCachesPayrollJournals

InitializeCachesPayrollJournals

Create Caches For Payroll Journals

Minor Business Rule

Object Name: B0700026

Parent DLL: CPAY

Location: Client/Server

Language: C

Functional Description
Initialize Payroll Journal Caches

Purpose

The purpose of this function is to initialize the Caches that are populated from the F07353, F0709, 
F06116, and F069126 files for future use in the Tax Detail, DBA Detail, Timecards,  Workers Comp, 

Workers Comp Accum, and Key Caches.


Setup Notes and Prerequisites


Special Logic




Technical Specification

Create unique Cache Name to be used each time this job is run.
This is done by going out to Next Numbers using System Code 00 and Next Number Index 4.  After 

getting the Next Numbering Scheme, a prefix such as TX, DB, TC, WC, WA, or KY is place before the number, 

thus creating the cahe name.


Then setup the Indexes for each cache:


Index to Tax Cache

 cProcessKey

 mnCheckControlNumber

 mnAddressNumber

 szTaxAreaWork

 szPayrollTaxType


Index to DBA Cache

 mnCheckControlNumber

 mnAddressNumber

 mnPayrollTransactionNo

 mnPayDeductBenAccType

 mnWageAttachmentCtrlNum


Index to Timecard Cache 

 mnCheckControlNumber

 mnAddressNumber

 mnPayrollTransactionNo


Index to Workers' Comp Cache  

 cSortKey1or2

 szTaxAreaWorkKey1

 szCompanyKey1

 szCostCenterKey1

 szWorkersCompInsurCodeKey1

 cSubClassKey1

 jdDateBeginningEffectiveKey1

 mnCalendarYearKey2

 szTaxAreaWorkKey2

 szCompanyKey2


Index to Workers' Comp Accumulations Cache 

 cSortKeyWorG

 mnFromTransTypeCode

 mnWorkState


Index to Key Cache  

 cWCSortKeyWorG

 mnWCFromTransTypeCode

 mnWCWorkState

 mnTXCheckControlNumber

 mnTXAddressNumber

 szTXTaxAreaWork

 szTXPayrollTaxType

 mnTCPayrollTransactionNo

^

Data Structure

D0700026 - DS For Initialize/Ending Caches For Payroll Journal

Parameter NameData ItemData TypeReq/OptI/O/Both
szJournalTaxCacheNamePIDcharOPTNONE

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.

mnJobnumberAJOBSMATH_NUMERICOPTNONE

The job number (work station ID) which executed the particular job.

szJournalDBACacheNamePIDcharOPTNONE

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.

szJournalTimecardCacheNamePIDcharOPTNONE

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.

szJournalWCCacheNamePIDcharOPTNONE

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.

szJournalWCAccumCacheNamePIDcharOPTNONE

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.

szJournalKeyCacheNamePIDcharOPTNONE

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.

szJournalTaxableAmountCachePIDcharOPTNONE

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.

szJournalDBATaxExemptCachePIDcharOPTNONE

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.

szJournalHandleCacheNamePIDcharOPTNONE

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

None

Related Tables

None
ProcessJournalEntriesDriver

ProcessJournalEntriesDriver

Create Caches For Payroll Journals

Minor Business Rule

Object Name: B0700026

Parent DLL: CPAY

Location: Client/Server

Language: C

Data Structure

D0700026G - DS to Process Journals Entries Driver

Parameter NameData ItemData TypeReq/OptI/O/Both
szKeyCacheNamePIDcharOPTNONE

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.

szTaxCacheNamePIDcharOPTNONE

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.

szTimeCardCacheNamePIDcharOPTNONE

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.

szPayrollJournalCacheNamePIDcharOPTNONE

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.

szCompressionRuleCacheNamePIDcharOPTNONE

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.

szPDBACacheNamePIDcharOPTNONE

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.

szWCGenLiabCacheNamePIDcharOPTNONE

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.

szWrkCompGenLiabCacheNamePIDcharOPTNONE

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.

szWCKeyCacheNamePIDcharOPTNONE

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.

mnCheckControlNumberCKCNMATH_NUMERICOPTNONE

A number used to group all payroll transactions for each payment or individual interim payment. This number is carried into the accounting 
journal entries and facilitates the update of the actual check number after payment printing is complete. This number is also used for 
automatically voiding payments. The payment work table contains both the actual check number and the check control number. All associated 
payment transactions are automatically reversed using the check control number. This is not the actual check number.

mnAddressNumberAN8MATH_NUMERICOPTNONE

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

mnLineNumberLNIDMATH_NUMERICOPTNONE

A number that identifies multiple occurrences, such as line numbers on a purchase order or other document. Generally, the system assigns 
this number,but in some cases you can override it.

mnBatchNumberICUMATH_NUMERICOPTNONE

A number that identifies a group of transactions that the system processes and balances as a unit. When you enter a batch, you can either 
assign a batch number or let the system assign it using the Next Numbers program.

mnWeeksWorkedPeriodWKSMATH_NUMERICOPTNONE

Weeks Worked

mnBurdenLineNumberLNIDMATH_NUMERICOPTNONE

A number that identifies multiple occurrences, such as line numbers on a purchase order or other document. Generally, the system assigns 
this number,but in some cases you can override it.

jdDatePayPeriodEndingPPEDJDEDATEOPTNONE

The last day of a processing period (pay period, month, quarter or year).

jdDtOverrideDateDWKJDEDATEOPTNONE

The date used as the actual work date or pay-period ending date.

jdDatePayCheckCKDTJDEDATEOPTNONE

The date associated with the various types of net pay instructions. This date relates to a payroll check, an interim payment, a bank 
automatic-deposit advice slip, a payslip (cash), or a claim reimbursement.

jdPayrollVersionCheckDateCKDTJDEDATEOPTNONE

The date associated with the various types of net pay instructions. This date relates to a payroll check, an interim payment, a bank 
automatic-deposit advice slip, a payslip (cash), or a claim reimbursement.

cPayrollExpenseJournalCodeEV01charOPTNONE

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

cTaxProcessKeyEV01charOPTNONE

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

cOverrideCompressionRuleEV01charOPTNONE

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

cIntercompanyFlagPEF1charOPTNONE

A code that determines where intercompany settlements are generated. You can enter 1 in this field to specify the intercompany 
settlements to be generated through the Payroll system before they are posted to the General Ledger. Or you can enter 0 to specify the settlements to 
be generated through the General Ledger system, not the Payroll system. If you leave this field blank, 0 is the default value.

szEECompanyHomeHMCOcharOPTNONE

The company number where the employee records generally reside.

szEECostCenterHomeHMCUcharOPTNONE

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

szVoidHomeCompanyCOcharOPTNONE

A code that identifies a specific organization, fund, or other reporting entity. The company code must already exist in the Company 
Constants table (F0010) and must identify a reporting entity that has a complete balance sheet. At this level, you can have intercompany 
transactions. Note: You can use company 00000 for default values such as dates and automatic accounting instructions. You cannot use company 00000 
for transaction entries.

szVoidHomeCostCenterMCUcharOPTNONE

An alphanumeric code that identifies a separate entity within a business for which you want to track costs. For example, a business unit 
might be a warehouse location, job, project, work center, branch, or plant. You can assign a business unit to a document, entity, or person for 
purposes of responsibility reporting. For example, the system provides reports of open accounts payable and accounts receivable by 
business unit to track equipment by responsible department. Business unit security might prevent you from viewing information about business units 
for which you have no authority.

szCountryForPayrollCCPRcharOPTNONE

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

szProgramIdPIDcharOPTNONE

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.

szUserIdUSERcharOPTNONE

The code that identifies a user profile.

mnTimeLastUpdatedUPMTMATH_NUMERICOPTNONE

The time that specifies when the program executed the last update to this record.

jdDateUpdatedUPMJJDEDATEOPTNONE

The date that specifies the last update to the file record.

szWorkStationIdJOBNcharOPTNONE

The code that identifies the work station ID that executed a particular job.

szAAIJournalCacheNamePIDcharOPTNONE

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.

szWCTaxTypeCode_RTRTcharOPTNONE

A code that identifies the table that contains user defined codes. The table is also referred to as a UDC type.

cDoNotCreateJournalDetailsEV01charOPTNONE

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

mnPayrollJournalVersionCouPJVCMATH_NUMERICOPTNONE

A field that identifies the number of versions of payroll journal entries that was launched using multiple version processing.

szJournalDetailCacheNamePIDcharOPTNONE

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.

szF07210PayCycleCodePCCDcharOPTNONE

A code that identifies the values for a master payroll cycle.

jdF07210DateBeginningEffEFTBJDEDATEOPTNONE

The date that an address, item, transaction, or table record becomes active.  The meaning of this field differs, depending on the program.  
For example, the effective date could represent the following:    o When a change of address becomes effective.   o When a lease becomes 
effective.   o When a price becomes effective.   o When the currency exchange rate becomes effective.   o When a tax rate becomes effective. 

jdF07210DateEndingEffEFTEJDEDATEOPTNONE

The date on which the item, transaction, or table becomes inactive, or through which you want transactions to appear. This field is used 
generically throughout the system. It could be a lease effective date, a price or cost effective date, a currency effective date, a tax rate effective 
date, or whatever is appropriate.

cEnableMCTABCMAcharOPTNONE

A code which specifies whether Management Approval is necessary before a batch of timecards can be included in a Pre-Payroll 
Processing.

szTaxableAmountCacheNamePIDcharOPTNONE

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

None

Related Tables

None
ReadingWritingDBAJECache

ReadingWritingDBAJECache

Create Caches For Payroll Journals

Minor Business Rule

Object Name: B0700026

Parent DLL: CPAY

Location: Client/Server

Language: C

^

Data Structure

D0700026B - DS For Reading/Writing DBA JE Cache

Parameter NameData ItemData TypeReq/OptI/O/Both
mnCheckControlNumberCKCNMATH_NUMERICOPTNONE

A number used to group all payroll transactions for each payment or individual interim payment. This number is carried into the accounting 
journal entries and facilitates the update of the actual check number after payment printing is complete. This number is also used for 
automatically voiding payments. The payment work table contains both the actual check number and the check control number. All associated 
payment transactions are automatically reversed using the check control number. This is not the actual check number.

mnAddressNumberAN8MATH_NUMERICOPTNONE

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

mnPayrollTransactionNoPRTRMATH_NUMERICOPTNONE

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.

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

mnWageAttachmentCtrlNumWANOMATH_NUMERICOPTNONE

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.

cDeductionBenefitMethodDEDMcharOPTNONE

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.

cHoursDollarsMethodHWcharOPTNONE

Does this holiday occur on a weekend (Y) or is it on a week day (N)?

szBusinessUnitDBAAllocatioMCUGcharOPTNONE

This field will come from one of two sources:    1.   Direct entry of a business unit on the One-Time-Override screen; or    2.   When the system 
automatically calculates a DBA based on finding an entry in the Union/Plan Master (F069106) specifically for the business unit matching one 
or more time cards. Only in these two cases will the business unit be filled in in the F0609 and F0619 files. In all other cases it will be blank.

szUnionCodeUNcharOPTNONE

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

szJobCategoryJBCDcharOPTNONE

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.

szJobStepJBSTcharOPTNONE

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.

mnWorkStateWSTMATH_NUMERICOPTNONE

Vertex state code identifying the state where the employee works.  REQUIRED.

mnWorkCountyWCNTMATH_NUMERICOPTNONE

Vertex county code identifying where the employee works. Zero fill if you do not need to calculate county taxes.

mnWorkCityWCTYMATH_NUMERICOPTNONE

Vertex city code identifying the city where the employee works. Zero fill if you do not need to calculate city taxes.

cCalendarMonthUpdateCMHUcharOPTNONE

This method determines how transition months are stored for calendar month history. Transition months occur when the pay period crosses 
into another month. Valid codes are:    blank This is the default. DBAs are prorated to the pay period ending date and the last day of the 
previous month if timecards exist for both months.    1       DBAs are allocated to the pay period ending date.

jdDtWorkDateThruDWKJDEDATEOPTNONE

The date used as the actual work date or pay-period ending date.

jdDtWorkDateFromDWKJDEDATEOPTNONE

The date used as the actual work date or pay-period ending date.

szJournalDBACacheNamePIDcharOPTNONE

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.

cProcessingModeEV01charOPTNONE

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

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

mnPDBAHoursWorkPHRWMATH_NUMERICOPTNONE

The number of hours associated with each transaction.

cInterimCheckStatusICScharOPTNONE

A code that indicates the type of payment that the system generated. For OneWorld, valid codes are:    A Automatic deposit    C 
Computer-generated payment    V Voided regular payment    M Manually-generated payment    Z Voided manual payment For World, valid codes are:    A 
Automatic deposit    C Computer-generated payment    P Payslip (cash)    M Manually-generated payment    X Voided payment  If the code is M, 
the Automatic Accounting Instruction (AAI) for the payroll manual check bank are used to generate the cash entry. If the code is C or blank, 
the AAI for the normal payroll bank is used.

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

cErrorFlagEV01charOPTNONE

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

mnUniqueKeyIDInternalUKIDMATH_NUMERICOPTNONE

This field is a unique number used to identify a record in a file.

cEffectOnCheckCHCKcharOPTNONE

A code that specifies the effect a benefit has on gross and net income. Valid values are:  1 A non-cash benefit that is non-taxable. The 
benefit, which is a journal entry only, has no effect on gross or net income. 2 A cash benefit that is taxable. The system adds the benefit to gross and 
net income.  3 A non-cash benefit that is taxable. The system adds the benefit to the taxable gross income, but there is no effect on net 
income other than the tax that is withheld. 4 A cash benefit that is non-taxable. There is no effect on gross income, and the system adds the benefit to 
net income as an adjustment to net pay. In addition, the system adds this type of benefit to gross wages on the payroll register so that gross - 
deductions = net.

idDBACacheCursorGENLNGIDOPTNONE

General purpose ID variable.

cEffectOnGLJLEOWcharOPTNONE

A code indicating whether you want journal entries passed from payroll to the general ledger and the method you want to use. Valid codes 
are: N Pass dollars only to the general ledger. M Do not pass dollars or hours to the general ledger. This code allows an accrual to be tracked 
in employee payroll history and the dollars to be omitted from the general ledger.

Related Functions

None

Related Tables

None
ReadingWritingDBATaxExemptCache

ReadingWritingDBATaxExemptCache

Create Caches For Payroll Journals

Minor Business Rule

Object Name: B0700026

Parent DLL: CPAY

Location: Client/Server

Language: C

Data Structure

D0700026I - Reading/Writing DBA Tax Exempt Cache

Parameter NameData ItemData TypeReq/OptI/O/Both
mnPayDeductBenAccTypePDBAMATH_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.

szTaxExemptTypes01TT01charOPTNONE

You can specify up to 15 tax types for which the respective payroll tax is not to be computed for a pay, deduction, or benefit code. If you 
enter * in the first element of this list, no taxes are computed.

szTaxExemptTypes02TT02charOPTNONE

You may specify up to 15 tax types for which the respective payroll tax is NOT to be computed for a pay, deduction, or benefit code. If you 
enter an asterisk (*) in the first element of this list, it signifies that no taxes are to be computed.

szTaxExemptTypes03TT03charOPTNONE

You may specify up to 15 tax types for which the respective payroll tax is NOT to be computed for a pay, deduction, or benefit code. If you 
enter an asterisk (*) in the first element of this list, it signifies that no taxes are to be computed.

szTaxExemptTypes04TT04charOPTNONE

You may specify up to 15 tax types for which the respective payroll tax is NOT to be computed for a pay, deduction, or benefit code. If you 
enter an asterisk (*) in the first element of this list, it signifies that no taxes are to be computed.

szTaxExemptTypes05TT05charOPTNONE

You may specify up to 15 tax types for which the respective payroll tax is NOT to be computed for a pay, deduction, or benefit code. If you 
enter an asterisk (*) in the first element of this list, it signifies that no taxes are to be computed.

szTaxExemptTypes06TT06charOPTNONE

You may specify up to 15 tax types for which the respective payroll tax is NOT to be computed for a pay, deduction, or benefit code. If you 
enter an asterisk (*) in the first element of this list, it signifies that no taxes are to be computed.

szTaxExemptTypes07TT07charOPTNONE

You may specify up to 15 tax types for which the respective payroll tax is NOT to be computed for a pay, deduction, or benefit code. If you 
enter an asterisk (*) in the first element of this list, it signifies that no taxes are to be computed.

szTaxExemptTypes08TT08charOPTNONE

You may specify up to 15 tax types for which the respective payroll tax is NOT to be computed for a pay, deduction, or benefit code. If you 
enter an asterisk (*) in the first element of this list, it signifies that no taxes are to be computed.

szTaxExemptTypes09TT09charOPTNONE

You may specify up to 15 tax types for which the respective payroll tax is NOT to be computed for a pay, deduction, or benefit code. If you 
enter an asterisk (*) in the first element of this list, it signifies that no taxes are to be computed.

szTaxExemptTypes10TT10charOPTNONE

You may specify up to 15 tax types for which the respective payroll tax is NOT to be computed for a pay, deduction, or benefit code. If you 
enter an asterisk (*) in the first element of this list, it signifies that no taxes are to be computed.

szTaxExemptTypes11TT11charOPTNONE

You may specify up to 15 tax types for which the respective payroll tax is NOT to be computed for a pay, deduction, or benefit code. If you 
enter an asterisk (*) in the first element of this list, it signifies that no taxes are to be computed.

szTaxExemptTypes12TT12charOPTNONE

You may specify up to 15 tax types for which the respective payroll tax is NOT to be computed for a pay, deduction, or benefit code. If you 
enter an asterisk (*) in the first element of this list, it signifies that no taxes are to be computed.

szTaxExemptTypes13TT13charOPTNONE

You may specify up to 15 tax types for which the respective payroll tax is NOT to be computed for a pay, deduction, or benefit code. If you 
enter an asterisk (*) in the first element of this list, it signifies that no taxes are to be computed.

szTaxExemptTypes14TT14charOPTNONE

You may specify up to 15 tax types for which the respective payroll tax is NOT to be computed for a pay, deduction, or benefit code. If you 
enter an asterisk (*) in the first element of this list, it signifies that no taxes are to be computed.

szTaxExemptTypes15TT15charOPTNONE

You may specify up to 15 tax types for which the respective payroll tax is NOT to be computed for a pay, deduction, or benefit code. If you 
enter an asterisk (*) in the first element of this list, it signifies that no taxes are to be computed.

cProcessingModeEV01charOPTNONE

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

szJournalDBATaxExemptCachePIDcharOPTNONE

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.

cErrorFlagEV01charOPTNONE

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

Related Functions

None

Related Tables

None
ReadingWritingTaxableAmountCache

ReadingWritingTaxableAmountCache

Create Caches For Payroll Journals

Minor Business Rule

Object Name: B0700026

Parent DLL: CPAY

Location: Client/Server

Language: C

Data Structure

D0700026H - Reading/Writing Taxable Amount JE Cache

Parameter NameData ItemData TypeReq/OptI/O/Both
mnAddressNumberAN8MATH_NUMERICOPTNONE

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

mnCheckControlNumberCKCNMATH_NUMERICOPTNONE

A number used to group all payroll transactions for each payment or individual interim payment. This number is carried into the accounting 
journal entries and facilitates the update of the actual check number after payment printing is complete. This number is also used for 
automatically voiding payments. The payment work table contains both the actual check number and the check control number. All associated 
payment transactions are automatically reversed using the check control number. This is not the actual check number.

mnPayrollTransactionNoPRTRMATH_NUMERICOPTNONE

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.

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.

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.

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

cProcessingModeEV01charOPTNONE

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

szJournalTaxableAmountCachePIDcharOPTNONE

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.

cErrorFlagEV01charOPTNONE

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

Related Functions

None

Related Tables

None
ReadingWritingTaxJECache

ReadingWritingTaxJECache

Create Caches For Payroll Journals

Minor Business Rule

Object Name: B0700026

Parent DLL: CPAY

Location: Client/Server

Language: C

Functional Description
Reading and Writing Tax Journal Entries Cache.

Purpose

The purpose of this function is to either Read from or Write to the Tax Cache.

Setup Notes and Prerequisites


Special Logic

cProcessingMode = 0 (Tells the function to Write to or Update the Tax Cache)

cProcessingMode = 1 (Tells the function to Read from the Tax Cache)

cProcessingMode = 2 (Tells the function to Delete from the Tax Cache)


Technical Specification

Key to Tax Cache:
 cProcessKey

 mnCheckControlNumber

 mnAddressNumber

 szTaxAreaWork

 szPayrollTaxType

 

Tax Cache Fields:

 cProcessKey

 mnCheckControlNumber

 mnAddressNumber

 szTaxAreaWork

 szPayrollTaxType

 mnWorkedTaxAmount

 mnResidenceTaxAmount

 mnTaxRate

 mnTaxBase

 mnTaxableAmount

 mnTimecardCount

 mnTimecardIndex

 mnTimecardIndexDetail

 cInterimCheckStatus 

 szJournalTaxCacheName

 cTaxOverrideFlag

 cDeductionBenefitMethod



If cProcessingMode = '0'

  Check to see if the record you wish to write to cache already exists.

  If the record already exists

    Add 1 to the TimecardCount

    Add the Taxable Amount passed into the function to mnTaxableAmount.

  Else

    Create a new cache record with fields passed in

  End If

End If


If cProcessingMode = '1'

  Check to see if the record you wish to retrieve in the cache exists.

  If the record exists

    Retrieve record from Cache

  End If

End If


If cProcessingMode = '2'

  Check to see if the record you wish to delete in the cache exists.

  If the record exists

    Delete the record from the Cache

  End If

End If


^

Data Structure

D0700026A - DS For Reading/Writing Tax JE Cache

Parameter NameData ItemData TypeReq/OptI/O/Both
mnCheckControlNumberCKCNMATH_NUMERICOPTNONE

A number used to group all payroll transactions for each payment or individual interim payment. This number is carried into the accounting 
journal entries and facilitates the update of the actual check number after payment printing is complete. This number is also used for 
automatically voiding payments. The payment work table contains both the actual check number and the check control number. All associated 
payment transactions are automatically reversed using the check control number. This is not the actual check number.

mnAddressNumberAN8MATH_NUMERICOPTNONE

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

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.

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.

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

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

cInterimCheckStatusICScharOPTNONE

A code that indicates the type of payment that the system generated. For OneWorld, valid codes are:    A Automatic deposit    C 
Computer-generated payment    V Voided regular payment    M Manually-generated payment    Z Voided manual payment For World, valid codes are:    A 
Automatic deposit    C Computer-generated payment    P Payslip (cash)    M Manually-generated payment    X Voided payment  If the code is M, 
the Automatic Accounting Instruction (AAI) for the payroll manual check bank are used to generate the cash entry. If the code is C or blank, 
the AAI for the normal payroll bank is used.

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

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

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

mnTimecardCountPRTRMATH_NUMERICOPTNONE

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.

mnTimecardIndexPRTRMATH_NUMERICOPTNONE

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.

mnTimecardIndexDetailPRTRMATH_NUMERICOPTNONE

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.

szJournalTaxCacheNamePIDcharOPTNONE

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.

cProcessingModeEV01charOPTNONE

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

cTaxOverrideFlagTXOFcharOPTNONE

This flag indicates whether the tax was overridden.

cDeductionBenefitMethodDEDMcharOPTNONE

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.

cProcessKeyEV01charOPTNONE

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

cErrorFlagEV01charOPTNONE

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

cNewProcessKeyEV01charOPTNONE

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

Related Functions

None

Related Tables

None
ReadingWritingTimecardJECache

ReadingWritingTimecardJECache

Create Caches For Payroll Journals

Minor Business Rule

Object Name: B0700026

Parent DLL: CPAY

Location: Client/Server

Language: C

Functional Description
Reading and Writing Timecard Journal Entries Cache.

Purpose

The purpose of this function is to either Read from or Write to the Timecard Cache.

Setup Notes and Prerequisites


Special Logic

cProcessingMode = 0 (Tells the function to Write to the Timecard Cache)

cProcessingMode = 1 (Tells the function to Read from the Timecard Cache)

cProcessingMode = 2 (Tells the function to Delete from the Timecard Cache)


Technical Specification

Key to Timecard Cache:
  mnCheckControlNumber

  mnAddressNumber

  mnPayrollTransactionNo

 

Timecard Cache Fields:

  mnCheckControlNumber

  mnAddressNumber

  mnPayrollTransactionNo

  szCompany

  szCostCenter

  szObjectAccount

  szSubsidiary

  szSubledger

  cSubledgerType

  szCompanyHome

  szCostCenterHome

  szPhase

  szJobCategory

  szJobStep

  mnAmtGrossPay

  mnHoursWork

  cWCExcludePremiumPayYN

  cGLExcludePremiumPayYN_2

  szEquipmentWorkedOn 

  szJournalTimecardCacheName

  szWorkersCompInsurCode

  szRechargeCostCenter

  mnWorkerCompPremBase

  mnWorkerCompOvertime

  mnWorkerCompPremiumAmt

  mnWorkState

  mnAmtGenLiabBase

  mnGenLiabOvertimeAmt

  mnGenLiabExcludable

  mnAmtGenLiabPremAmt

  mnFrequencyMathNumeric

  mnWorkerCompExcludable

  cRechargeCode

  cInterimCheckStatus

  cWorkersCompSubClass 

  cDeductionBenefitMethod



If cProcessingMode = '0'

  Check to see if the record you wish to write to cache already exists.

  If the record does not already exists

    Create a new cache record with fields passed in

  End If

End If


If cProcessingMode = '1'

  Check to see if the record you wish to retrieve in the cache exists.

  If the record exists

    Retrieve record from Cache

  End If

End If


If cProcessingMode = '2'

  Check to see if the record you wish to delete in the cache exists.

  If the record exists

    Delete the record from the Cache

  End If

End If


^

Data Structure

D0700026C - DS For Reading/Writing Timecard JE Cache

Parameter NameData ItemData TypeReq/OptI/O/Both
mnCheckControlNumberCKCNMATH_NUMERICOPTNONE

A number used to group all payroll transactions for each payment or individual interim payment. This number is carried into the accounting 
journal entries and facilitates the update of the actual check number after payment printing is complete. This number is also used for 
automatically voiding payments. The payment work table contains both the actual check number and the check control number. All associated 
payment transactions are automatically reversed using the check control number. This is not the actual check number.

mnAddressNumberAN8MATH_NUMERICOPTNONE

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

mnPayrollTransactionNoPRTRMATH_NUMERICOPTNONE

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.

szCompanyCOcharOPTNONE

A code that identifies a specific organization, fund, or other reporting entity. The company code must already exist in the Company 
Constants table (F0010) and must identify a reporting entity that has a complete balance sheet. At this level, you can have intercompany 
transactions. Note: You can use company 00000 for default values such as dates and automatic accounting instructions. You cannot use company 00000 
for transaction entries.

szCostCenterMCUcharOPTNONE

An alphanumeric code that identifies a separate entity within a business for which you want to track costs. For example, a business unit 
might be a warehouse location, job, project, work center, branch, or plant. You can assign a business unit to a document, entity, or person for 
purposes of responsibility reporting. For example, the system provides reports of open accounts payable and accounts receivable by 
business unit to track equipment by responsible department. Business unit security might prevent you from viewing information about business units 
for which you have no authority.

szObjectAccountOBJcharOPTNONE

The portion of a general ledger account that refers to the division of the Cost Code (for example, labor, materials, and equipment) into 
subcategories. For example, you can divide the Cost Code for labor into regular time, premium time, and burden. Note: If you use a flexible chart of 
accounts and the object account is set to 6 digits, J.D. Edwards recommends that you use all 6 digits. For example, entering 000456 is not 
the same as entering 456 because if you enter 456 the system enters three blank spaces to fill a 6-digit object.

szSubsidiarySUBcharOPTNONE

A subset of an object account. Subsidiary accounts include detailed records of the accounting activity for an object account.

szSubledgerSBLcharOPTNONE

A code that identifies a detailed, auxiliary account within a general ledger account. A subledger can be an equipment item number or an 
address book number. If you enter a subledger, you must also specify the subledger type.

cSubledgerTypeSBLTcharOPTNONE

A user defined code (00/ST) that is used with the Subledger field to identify the subledger type and how the system performs subledger 
editing. On the User Defined Codes form, the second line of the description controls how the system performs editing. This is either hard-coded 
or user defined. Valid values include: A Alphanumeric field, do not edit   N Numeric field, right justify and zero fill   C Alphanumeric field, right 
justify and blank fill  

szCompanyHomeHMCOcharOPTNONE

The company number where the employee records generally reside.

szCostCenterHomeHMCUcharOPTNONE

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

szPhaseWR01charOPTNONE

A user defined code (00/W1) that indicates the current stage or phase of development for a work order. You can assign a work order to only 
one phase code at a time. Note: Certain forms contain a processing option that allows you to enter a default value for this field. If you enter a 
default value on a form for which you have set this processing option, the system displays the value in the appropriate fields on any work 
orders that you create. The system also displays the value on the Project Setup form. You can either accept or override the default value.

szJobCategoryJBCDcharOPTNONE

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.

szJobStepJBSTcharOPTNONE

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.

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

mnHoursWorkPHRWMATH_NUMERICOPTNONE

The number of hours associated with each transaction.

jdDtWorkDateDWKJDEDATEOPTNONE

The date used as the actual work date or pay-period ending date.

cWCExcludePremiumPayYNPPTcharOPTNONE

A code that indicates whether the premium portion of overtime pay should be excluded from the calculation. For workers compensation 
rates, this field relates to only those pay types that are defined in the Workers-Compensation Insurance-Basis Table. For U.S. 
unemployment-insurance rates, this field relates to all pay types that are defined as taxable. For Canadian employment-insurance rates, this field should be 
set to No because premium pay such as overtime is not excluded from employment insurance in Canada. For pay tables that are used for 
step progression processing, this field should be set to No.

cGLExcludePremiumPayYN_2PPTcharOPTNONE

A code that indicates whether the premium portion of overtime pay should be excluded from the calculation. For workers compensation 
rates, this field relates to only those pay types that are defined in the Workers-Compensation Insurance-Basis Table. For U.S. 
unemployment-insurance rates, this field relates to all pay types that are defined as taxable. For Canadian employment-insurance rates, this field should be 
set to No because premium pay such as overtime is not excluded from employment insurance in Canada. For pay tables that are used for 
step progression processing, this field should be set to No.

szEquipmentWorkedOnEQWOcharOPTNONE

The ID number for the equipment that an employee maintained or repaired, but did not use. For example, an employee might change the 
oil in the company dump truck. Use this field to direct labor expenses to this piece of equipment.

szJournalTimecardCacheNamePIDcharOPTNONE

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.

cProcessingModeEV01charOPTNONE

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

cErrorFlagEV01charOPTNONE

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

szWorkersCompInsurCodeWCMPcharOPTNONE

A user defined code (00/W) that represents a workers' compensation insurance (WCI) code. This code should correspond to the 
classifications on your periodic workers' compensation insurance reports.

mnWorkerCompPremBaseWCMBMATH_NUMERICOPTNONE

The reportable earnings. This is the basis for calculating the workers compensation and general liability premiums.

mnWorkerCompOvertimeWCMOMATH_NUMERICOPTNONE

The pay earned by the employee for overtime hours. This amount may or may not be subject to Workers Compensation Premiums.

mnWorkerCompPremiumAmtWCAMMATH_NUMERICOPTNONE

The amount paid for the workers compensation or general liability insurance. See also GENA.

cRechargeCodeRCCDcharOPTNONE

A code that identifies whether the employee is to be handled through the Recharge processing option for the Payroll Journal Entry 
program. Valid codes are:    1   Payroll Processing Only    2   Payroll and Recharge Processing    3   Recharge Processing Only  After a timecard has 
been added, you cannot change its record type.

cInterimCheckStatusICScharOPTNONE

A code that indicates the type of payment that the system generated. For OneWorld, valid codes are:    A Automatic deposit    C 
Computer-generated payment    V Voided regular payment    M Manually-generated payment    Z Voided manual payment For World, valid codes are:    A 
Automatic deposit    C Computer-generated payment    P Payslip (cash)    M Manually-generated payment    X Voided payment  If the code is M, 
the Automatic Accounting Instruction (AAI) for the payroll manual check bank are used to generate the cash entry. If the code is C or blank, 
the AAI for the normal payroll bank is used.

mnWorkStateWSTMATH_NUMERICOPTNONE

Vertex state code identifying the state where the employee works.  REQUIRED.

cWorkersCompSubClassWETcharOPTNONE

A code that specifies any special circumstances associated with the workers compensation insurance (WCI) code, resulting in multiple 
rates for the same WCI code due to location or risk, for example. The subclass should remain blank if multiple rates do not exist. Default codes 
are: Blank There are no special circumstances associated with this code. F There are special circumstances associated with this code.

szRechargeCostCenterGMCUcharOPTNONE

A Business Unit is an accounting entity required for management reporting. It can be thought of as a profit center, department, warehouse 
location, job,project, workcenter, etc. For Payroll purposes, this Business Unit represents the distribution account where the recharge(billing) 
amounts are to be posted. The only time that this field will be generated is when you are keying in an employee as a Record Type(RCCD) 2 or 
3. In this case the derived distribution account, or entered account, equals this Business Unit.

mnAmtGenLiabBaseGENBMATH_NUMERICOPTNONE

This is the amount of taxable wages upon which the general liability premium was computed.

mnGenLiabOvertimeAmtGENOMATH_NUMERICOPTNONE

The premium portion of overtime wages which have been designated as excluded from the calculation of General Liability(PD/BI) 
Insurance.

mnGenLiabExcludableGENXMATH_NUMERICOPTNONE

The amount of the employees wages which have been designated as excluded from the calculation of General Liability(PD/BI) Insurance.

mnAmtGenLiabPremAmtGENAMATH_NUMERICOPTNONE

The amount paid for the General Liability Insurance. See also WCA.

mnFrequencyMathNumericADNLMATH_NUMERICOPTNONE

The number of lines to print on the auto deposit advice.

mnWorkerCompExcludableWCMXMATH_NUMERICOPTNONE

The amount of gross pay that is not included in the basis for the premium calculation. For example, many policies will exclude premium 
wages from the basis and only include straight time equivalent wages as the basis for the calculation of premiums.

cDeductionBenefitMethodDEDMcharOPTNONE

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.

mnWorkCountyWCNTMATH_NUMERICOPTNONE

Vertex county code identifying where the employee works. Zero fill if you do not need to calculate county taxes.

Related Functions

None

Related Tables

None
ReadingWritingWCGLDeductionCache

ReadingWritingWCGLDeductionCache

Create Caches For Payroll Journals

Minor Business Rule

Object Name: B0700026

Parent DLL: CPAY

Location: Client/Server

Language: C

Data Structure

D0700026J - Reading and Writing WC/GL Deduction Cache

Parameter NameData ItemData TypeReq/OptI/O/Both
szJournalsHandleCacheNamePIDcharOPTINPUT

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.

cProcessingModeEV01charOPTINPUT

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

mnAddressNumberAN8MATH_NUMERICOPTINPUT

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

mnCheckControlNumberCKCNMATH_NUMERICOPTINPUT

A number used to group all payroll transactions for each payment or individual interim payment. This number is carried into the accounting 
journal entries and facilitates the update of the actual check number after payment printing is complete. This number is also used for 
automatically voiding payments. The payment work table contains both the actual check number and the check control number. All associated 
payment transactions are automatically reversed using the check control number. This is not the actual check number.

mnPayrollTransactionNumberPRTRMATH_NUMERICOPTINPUT

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.

mnDBACodePDBAMATH_NUMERICOPTINPUT

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.

mnDBAAmountGPAYMATH_NUMERICOPTOUTPUT

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.

Related Functions

None

Related Tables

None
ReadingWritingWCGLTaxKeyCache

ReadingWritingWCGLTaxKeyCache

Create Caches For Payroll Journals

Minor Business Rule

Object Name: B0700026

Parent DLL: CPAY

Location: Client/Server

Language: C

Functional Description
Reading and Writing Key Journal Entries Cache.

Purpose

The purpose of this function is to either Read from or Write to the Key Cache.

Setup Notes and Prerequisites


Special Logic

cProcessingMode = 0 (Tells the function to Write to the Key Cache)

cProcessingMode = 1 (Tells the function to Read from the Key Cache)

cProcessingMode = 2 (Tells the function to Delete from the Key Cache)


Technical Specification

Key to Key Cache:
  cWCSortKeyWorG

  mnWCFromTransTypeCode

  mnWCWorkState

  mnTXCheckControlNumber

  mnTXAddressNumber

  mnTCPayrollTransactionNo

  szTXTaxAreaWork

  szTXPayrollTaxType



Key Cache Fields:

  cWCSortKeyWorG

  mnWCFromTransTypeCode

  mnWCWorkState

  mnTXCheckControlNumber

  mnTXAddressNumber

  mnTCPayrollTransactionNo

  szTXTaxAreaWork

  szTXPayrollTaxType

  mnTCCheckControlNumber

  mnTCAddressNumber

  mnTCPayrollTransactionNo



If cProcessingMode = '0'

  Check to see if the record you wish to write to cache already exists.

  If the record does not exist

    Create a new cache record with fields passed in

  End If

End If


If cProcessingMode = '1'

  Check to see if the record you wish to retrieve in the cache exists.

  If the record exists

    Retrieve record from Cache

  End If

End If


If cProcessingMode = '2'

  Check to see if the record you wish to delete in the cache exists.

  If the record exists

    Delete the record from the Cache

  End If

End If



^

Data Structure

D0700026F - DS For Reading/Writing WC/GL/Tax Key Cache

Parameter NameData ItemData TypeReq/OptI/O/Both
cWCSortKeyWorGSOVRcharOPTNONE

An option that indicates which lines print on an attachment.

mnWCFromTransTypeCodePPYFMATH_NUMERICOPTNONE

The number and description of the PDBA that you want the system to use to calculate the corresponding PDBA. This number is the 
beginning number in the range that is the basis of the calculation.

mnWCWorkStateWSTMATH_NUMERICOPTNONE

Vertex state code identifying the state where the employee works.  REQUIRED.

mnTXCheckControlNumberCKCNMATH_NUMERICOPTNONE

A number used to group all payroll transactions for each payment or individual interim payment. This number is carried into the accounting 
journal entries and facilitates the update of the actual check number after payment printing is complete. This number is also used for 
automatically voiding payments. The payment work table contains both the actual check number and the check control number. All associated 
payment transactions are automatically reversed using the check control number. This is not the actual check number.

mnTXAddressNumberAN8MATH_NUMERICOPTNONE

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

szTXTaxAreaWorkTARAcharOPTNONE

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.

szTXPayrollTaxTypePTAXcharOPTNONE

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.

mnTCCheckControlNumberCKCNMATH_NUMERICOPTNONE

A number used to group all payroll transactions for each payment or individual interim payment. This number is carried into the accounting 
journal entries and facilitates the update of the actual check number after payment printing is complete. This number is also used for 
automatically voiding payments. The payment work table contains both the actual check number and the check control number. All associated 
payment transactions are automatically reversed using the check control number. This is not the actual check number.

mnTCAddressNumberAN8MATH_NUMERICOPTNONE

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

mnTCPayrollTransactionNoPRTRMATH_NUMERICOPTNONE

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.

szJournalKeyCacheNamePIDcharOPTINPUT

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.

cProcessingModeEV01charOPTINPUT

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

cErrorFlagEV01charOPTNONE

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

mnWCWorkCountyWCNTMATH_NUMERICOPTNONE

Vertex county code identifying where the employee works. Zero fill if you do not need to calculate county taxes.

Related Functions

None

Related Tables

None
ResetAllJECaches

ResetAllJECaches

Create Caches For Payroll Journals

Minor Business Rule

Object Name: B0700026

Parent DLL: CPAY

Location: Client/Server

Language: C

^

Data Structure

D0700026 - DS For Initialize/Ending Caches For Payroll Journal

Parameter NameData ItemData TypeReq/OptI/O/Both
szJournalTaxCacheNamePIDcharOPTNONE

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.

mnJobnumberAJOBSMATH_NUMERICOPTNONE

The job number (work station ID) which executed the particular job.

szJournalDBACacheNamePIDcharOPTNONE

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.

szJournalTimecardCacheNamePIDcharOPTNONE

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.

szJournalWCCacheNamePIDcharOPTNONE

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.

szJournalWCAccumCacheNamePIDcharOPTNONE

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.

szJournalKeyCacheNamePIDcharOPTNONE

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.

szJournalTaxableAmountCachePIDcharOPTNONE

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.

szJournalDBATaxExemptCachePIDcharOPTNONE

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.

szJournalHandleCacheNamePIDcharOPTNONE

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

None

Related Tables

None
BAs, 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. 

cInterimCheckStatusICScharOPTNONE

A code that indicates the type of payment that the system generated. For OneWorld, valid codes are:    A Automatic deposit    C 
Computer-generated payment    V Voided regular payment    M Manually-generated payment    Z Voided manual payment For World, valid codes are:    A 
Automatic deposit    C Computer-generated payment    P Payslip (cash)    M Manually-generated payment    X Voided payment  If the code is M, 
the Automatic Accounting Instruction (AAI) for the payroll manual check bank are used to generate the cash entry. If the code is C or blank, 
the AAI for the normal payroll bank is used.

mnTaxRateRTAMMATH_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 ove