CreateDBACacheHistory

Create PDBA Cache History

Minor Business Rule

Object Name: B0700013

Parent DLL: CPAY

Location: Client/Server

Language: C

1.Functional Description

1.1Purpose
This business function is used to create DBA Cache History during the Pre-Payroll phase of the Pay Cycle.

1.2Setup Notes and Prerequisites


1.3Special Logic

This section should be used when additional logic is used in the Business Function for application specific functionality or exceptional situations.

2.Technical Specifications


2.1Parameters:

Data Item Data Structure Description I/ORequiredNotes
PID          Check Control Cache NameIY

PID1         Check Control Cache NameIY

AN8          Address Number                  IY

                Payroll Month                       IY

                Payroll Year                                         IY

                Payroll Quarter Beg MonthIY

                  Payroll Quarter End MonthIY

                Calendar Month                   IY

                                Calendar Year                        IY

                Calendar Quarter Beg MonthIY

                    Calendar Quarter End MonthIY

PID2                     Timecard Cache Name             IY

PAYD          Payroll ID                               IY

                Payment Year                         IY

HMCO              Home Company                       IY


2.2Related Tables 

Table Table Description
F06145Calendar Month DBA Summary History

F06146Payroll Month DBA Summary History

F069116Transaction Parameters File

F0709DBA Transaction Detail


2.3Related Business Functions

Source NameFunction Name
B070003Initialize/End Pre-Payroll Caches


2.4Processing 

This business function processes the Check Control Number cache.  For  the first check control number read, it retrieves Calendar Payroll Month History, 
DBA Transaction Detail and Payment Year DBA History, if the Payroll Year is different from the Payment Year.



Data Structure

D0700013 - DS for Create DBA Cache History

Parameter NameData ItemData TypeReq/OptI/O/Both
szCheckControlCachePIDcharOPTNONE

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.

szDBACachePID1charOPTNONE

Program ID - 01

mnAddressNumberAN8MATH_NUMERICOPTNONE

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

mnPayrollMonthHMOMATH_NUMERICOPTNONE

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

mnPayrollYearYRMATH_NUMERICOPTNONE

The calendar year for this calendar.

mnPayrollQuarterBeginMonthPNFMATH_NUMERICOPTNONE

This period number allows you to specify a default financial reporting date different from the actual accounting period.  Because financial 
report preparation often lags behind the actual closing of books, this facility allows you to close a month without having to finish all financial 
statements. By changing this single parameter, you can execute any prior period financial statement.

mnPayrollQuarterEndMonthPNMATH_NUMERICOPTNONE

A number indicating the current accounting period.  This number, used in conjunction with the Company Constants table (F0010) and the 
General Constants table (F0009), allows the user to define up to 14 accounting periods. See General Ledger Date.  The current period number 
is used to determine posted before and posted after cut off warning messages.  It is also used as the default accounting period in the 
preparation of financial reports.

mnCalendarMonthMADDMATH_NUMERICOPTNONE

The number of months to add to or subtract from the date specified in the Based on Date field (DABS) to determine the discount due date or 
net due date. The system uses this field in conjunction with the Fixed Days field (DYFX] and Days to Add (DADD) field to calculate the due 
date.  For example, if you enter 20 in the Fixed Days field and 1 in the Months to Add field, and the Based on Date is 1 (invoice date), the 
system calculates the due date as the 20th day of the month following the date specified for the invoice date. 

mnCalendarYearYROMATH_NUMERICOPTNONE

The calender year.

mnCalendarQuarterBeginMonthPNCMATH_NUMERICOPTNONE

A number (from 1 to 14) that identifies the current accounting period . The system uses this number to generate error messages, such as 
PBCO (posted before cut off) and PACO (posted after cut off).

mnCalendarQuarterEndMonthPNKMATH_NUMERICOPTNONE

A number indicating the current accounting period.  This number, used in conjunction with the Company Constants file (F0010) and the 
General Accounting Constants (F0009), allows the user to define up to 53 accounting periods. See General Ledger Date.  The current period 
number is used to determine posted before and posted after cut off warning messages.  It is also used as the default accounting period in the 
preparation of financial reports.

szTimecardCachePID2charOPTNONE

Program ID - 02

szPayrollIDPAYDcharOPTNONE

A code that identifies a group of employees for whom you are processing payroll. Use this ID to process each step of the payroll 
cycle. This code is also used to identify the interim ID that you select when you enter interim payments.

mnPaymentYearYRMATH_NUMERICOPTNONE

The calendar year for this calendar.

szCompanyHomeHMCOcharOPTNONE

The company number where the employee records generally reside.

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.

jdDatePayPeriodEnding_PPEDPPEDJDEDATEOPTNONE

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

cProcInterimsEV01charOPTNONE

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

cMergeInterimsEV01charOPTNONE

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

cRetrievePDBAHistorySysFlagPHISTcharOPTNONE

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

cTaxCalcMethodFICMcharOPTNONE

A code that specifies the tax method that the Vertex payroll-tax calculation system uses to calculate certain taxes. The codes are defined in 
UDC 07/TM. This code can also determine the form that the employee receives for year-end tax reporting. For example, when you enter C, 
a contract employee receives IRS Form 1099-M rather than IRS Form W-2. If a form is not specified in Description 2, the system generates 
IRS Form W-2. For employees who are paid multiple times within one pay period, the system should review previous payments within the same 
pay period and then adjust tax amounts. To specify this function, enter S. If a tax method exists for an employee in addition to the normal tax 
method that is set up in the Employee Master Information table (F060116), the system can use the alternative tax method to interactively 
process interim payments. To specify this function, enter Z. Some values, such as S and Z, might require additional setup in the UDC table.

cBypassVoidwithSpecialTaxesBPVDcharOPTNONE

A code that indicates whether you want to bypass or process voided payments if those payments contain special taxes. Valid values 
are: 0 Process voided payments with special taxes.  1 Bypass voided payments with special taxes.

jdDateBeginningEffectiveEFTBJDEDATEOPTNONE

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. 

jdDateEndingEffectiveEFTEJDEDATEOPTNONE

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.

szCountryForPayrollCCPRcharOPTNONE

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

Related Functions

B0700003 Create PrePayroll Caches
N0700470 Four-digit Year to Two-digit Year

Related Tables

F0607 Wage Attachment Ledger File
F06116 Employee Transaction Detail File
F06145 Calendar Month DBA Summary History File
F06146 Employee Transaction History Summary
F069086 Payroll Corporate Tax Identification
F069116 Payroll Transaction Constants
F0709 Deduction/Benefit/Accrual Ledger File