EndCPRCache

Certified Payroll Register Caching

Minor Business Rule

Object Name: B0700067

Parent DLL: CPAY

Location: Client/Server

Language: C

Function Name: End CPR Cache

Object Name: B0700067

Object Desc: Certified Payroll Register Cache

Parent DLL: CHRM

Location Client/Server

Language: C

Functional Description

Purpose:

This function will clear and remove all of the caches used in the certified payroll register.

Parameters:

Data Item Data Structure Description   I/ORequiredNotes
PID  szHourlyRateCache     IRequired
PID  szHRReportCache    IRequired
PID  szFringeCache    IRequired
PID  szTaxDeductionCache    IRequired
PID  szJobCodeStepCache    IRequired

Related Tables:

Called Functions:

Source NameFunction Name

Error Messages:

Data ItemDescription
3143Cache can not be accessed

Special Logic/Notes:

^

Data Structure

D0700067A - DS for Initialize/End CPR Caches

There are two methods to populate the data structure parameters.  The first is when initializing the
cache, and the second is when removing the cache.

Initialize the cache

Hourly Rate Cache       - Output
HR Report Cache         - Output
Fringe Cache            - Output
Tax Deduction Cache     - Output
Job Code Step Cache     - Output

End the cache

Hourly Rate Cache       - Input
HR Report Cache         - Input
Fringe Cache            - Input
Tax Deduction Cache     - Input
Job Code Step Cache     - Input

^

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
szHourlyRateCache	PID	char	OPT	NONE
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.
szHRReportCache	PID	char	OPT	NONE
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.
szFringeCache	PID	char	OPT	NONE
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.
szTaxDeductionCache	PID	char	OPT	NONE
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.
szJobCodeStepCache	PID	char	OPT	NONE
The number that identifies the batch or interactive program (batch or interactive object). For example, the number of the Sales Order Entry interactive program is P4210, and the number of the Print Invoices batch process report is R42565. The program ID is a variable length value. It is assigned according to a structured syntax in the form TSSXXX, where: T The first character of the number is alphabetic and identifies the type, such as P for Program, R for Report, and so on. For example, the value P in the number P4210 indicates that the object is a program. SS The second and third characters of the number are numeric and identify the system code. For example, the value 42 in the number P4210 indicates that this program belongs to system 42, which is the Sales Order Processing system. XXX The remaining characters of the numer are numeric and identify a unique program or report. For example, the value 10 in the number P4210 indicates that this is the Sales Order Entry program.

Related Functions

B0000564 Get Internal Next Number

Related Tables

None

InitializeCPRCache

Certified Payroll Register Caching

Minor Business Rule

Object Name: B0700067

Parent DLL: CPAY

Location: Client/Server

Language: C

Function Name: Initialize CPR Cache

Object Name: B0700067

Object Desc: Certified Payroll Register Cache

Parent DLL: CHRM

Location Client/Server

Language: C

Functional Description

Purpose:

This function will create all of the caches used in generating the certified payroll register.

Parameters:

Data Item Data Structure Description   I/ORequiredNotes
PID  szHourlyRateCache     ORequired
PID  szHRReportCache    ORequired
PID  szFringeCache    ORequired
PID  szTaxDeductionCache    ORequired
PID  szJobCodeStepCache    ORequired

Related Tables:

Called Functions:

Source NameFunction Name

Error Messages:

Data ItemDescription
3143Cache can not be accessed

Special Logic/Notes:

^

Data Structure

D0700067A - DS for Initialize/End CPR Caches

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
szHourlyRateCache	PID	char	OPT	NONE
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.
szHRReportCache	PID	char	OPT	NONE
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.
szFringeCache	PID	char	OPT	NONE
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.
szTaxDeductionCache	PID	char	OPT	NONE
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.
szJobCodeStepCache	PID	char	OPT	NONE
The number that identifies the batch or interactive program (batch or interactive object). For example, the number of the Sales Order Entry interactive program is P4210, and the number of the Print Invoices batch process report is R42565. The program ID is a variable length value. It is assigned according to a structured syntax in the form TSSXXX, where: T The first character of the number is alphabetic and identifies the type, such as P for Program, R for Report, and so on. For example, the value P in the number P4210 indicates that the object is a program. SS The second and third characters of the number are numeric and identify the system code. For example, the value 42 in the number P4210 indicates that this program belongs to system 42, which is the Sales Order Processing system. XXX The remaining characters of the numer are numeric and identify a unique program or report. For example, the value 10 in the number P4210 indicates that this is the Sales Order Entry program.

Related Functions

B0000564 Get Internal Next Number

Related Tables

None

ProcessCPRFringeCache

Certified Payroll Register Caching

Minor Business Rule

Object Name: B0700067

Parent DLL: CPAY

Location: Client/Server

Language: C

Function Name: Process CPR Fringe Cache

Object Name: B0700067

Object Desc: Certified Payroll Register Cache

Parent DLL: CHRM

Location Client/Server

Language: C

Functional Description

Purpose:

This function will create an retrieve fringe benefit records into a cache. The fringe benefit records are first read from the F0724, within the certified payroll
register UBE.

Parameters:

Data Item Data Structure Description   I/ORequiredNotes
PID  szFringeCache     IRequired
PDBA  mnPayDeductBenAccType I/ORequired
EXA  szNameAlphaExplanation    I/ORequired
BDA  mnAmountBurden    I/ORequired
EV01  cProcessingMode    IRequired

Related Tables:

Called Functions:

Source NameFunction Name

Error Messages:

Data ItemDescription
3143Cache can not be accessed

Special Logic/Notes:

This function will load fringe benefit records into the cache, and retrieve the cache records for
printing on the certified payroll register.  The fringe benefit records are read from the F0724 in the
certified payroll register UBE.

When called with the processing mode set to '0', this function will add the fringe benefit record to
the cache.

When called with the processing mode set to '1', this function will retrieve the first fringe benefit
record from the cache.  The record is then removed from the cache.

^

Data Structure

D0700067C - DS for Process CPR Fringe Cache

There are two methods to populate the data structure parameters.  The first is when loading a record
to the cache.  The second is retrieving a record from the cache.

Load record to cache

Fringe Cache            - Input
PDBA Code               - Input
PDBA Code Description   - Input
Amount Burden           - Input
Processing Mode         - Input

Retrieve record from cache

Fringe Cache            - Input
PDBA Code               - Output
PDBA Code Description   - Output
Amount Burden           - Output
Processing Mode         - Input

^

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
szFringeCache	PID	char	OPT	NONE
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.
mnPayDeductBenAccType	PDBA	MATH_NUMERIC	OPT	NONE
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.
szNameAlphaExplanation	EXA	char	OPT	NONE
A description, remark, explanation, name, or address.
mnAmountBurden	BDA	MATH_NUMERIC	OPT	NONE
The total amount of burden, by type, pertaining to the labor distribution account.
cProcessingMode	EV01	char	OPT	NONE
An option that specifies the type of processing for an event.

Related Functions

B0000564 Get Internal Next Number

Related Tables

None

ProcessCPRRateCache

Certified Payroll Register Caching

Minor Business Rule

Object Name: B0700067

Parent DLL: CPAY

Location: Client/Server

Language: C

Function Name: Process CPR Fringe Cache

Object Name: B0700067

Object Desc: Certified Payroll Register Cache

Parent DLL: CHRM

Location Client/Server

Language: C

Functional Description

Purpose:

This function will create and retrieve rate detail records into a cache. The rate detail records are first read from the F0618 (timecard history), within the
certified payroll register UBE.

Parameters:

Data Item Data Structure Description   I/ORequiredNotes
PID  szHourlyRateCache     IRequired
PID  szHRReportCache    IRequired
PTCT  cPayTypeCategory    IRequiredUsed in loading only
SHRT  mnRateHourly    IRequiredUsed in loading only
SHRW  mnHoursWorked    IRequiredUsed in loading only
GPA  mnAmtGrossPay    IRequiredUsed in loading only
CEDT  cCertifiedEditFlag    IRequiredUsed in loading only
DWK  jdDtWorkJulian    I/ORequiredInput is for loading of cache
record.  Output is for retrieval of cache record.
RHRW  mnRegularHoursWorked    ORequiredUsed in retrieval only
PHRT  mnRegularRate    ORequiredUsed in retrieval only
THRW  mnOvertimeHoursWorked   O RequiredUsed in retrieval only
OT2  mnOvertimeRate    ORequiredUsed in retrieval only
HHRW  mnOtherHoursWorked    O RequiredUsed in retrieval only
PHRW  mnTotalHoursWorked    O RequiredUsed in retrieval only
GPA  mnJobAmount    O RequiredUsed in retrieval only
EV01  cProcessingMode    IRequired
MATH01 mnRegLineCounter    I/O RequiredUsed in loading only
MATH01 mnOvrLineCounter    I/O RequiredUsed in loading only
MATH01 mnOthLineCounter    I/O RequiredUsed in loading only

Related Tables:

Called Functions:

Source NameFunction Name

Error Messages:

Data ItemDescription
3143Cache can not be accessed

Special Logic/Notes:

This function is called in one of two methods.

1.  With the processing mode set to '0', a record will be added/updated to both the hourly rate cache
and the hourly rate report cache.  The hourly rate report cache has all of the rate records in the
correct format for printing the rate detail on the certified payroll register.  The hourly rate cache
acts as an index to the hourly rate report cache.  When adding/updating records the hourly rate cache
will be searched first, to determine where in the hourly rate report cache the new record should go.

2.  With the processing mode set to '1', only records from the hourly rate report cache will be
retrieved.  The record retrieved is then sent to the print line, in the certified payroll register UBE.
The hourly rate cache is not used when retrieving records.  The retrieval will return the first record
on the hourly rate report cache, and then remove the record from the cache.

^

Data Structure

D0700067B - DS for Process CPR Rate Cache

There are two methods to populate the data structure parameters.  The first is when loading a record
to the cache.  The second is retrieving a record from the cache.

Load record to cache

Hourly Rate Cache       - Input
HR Report Cache         - Input
Pay Type Category       - Input
Rate Hourly             - Input
Hours Worked            - Input
Amount Gross Pay        - Input
Certified Edit Flag     - Input
Date Worked             - Input
Processing Mode         - Input
Reg Rate Line Counter   - Input/Output
Ovr Rate Line Counter   - Input/Output
Oth Rate Line Counter   - Input/Output

  ** All other parameters are ignored. **

Retrieve record from cache

Hourly Rate Cache       - Input
HR Report Cache         - Input
Date Worked             - Output
Regular Hours Worked    - Output
Regular Rate            - Output
Overtime Hours Worked   - Output
Overtime Rate           - Output
Other Hours Worked      - Output
Total Hours Worked      - Output
Job Amount              - Output
Processing Mode         - Input

  ** All other parameters are ignored. **
^

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
szHourlyRateCache	PID	char	OPT	NONE
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.
szHRReportCache	PID	char	OPT	NONE
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.
cPayTypeCategory	PTCT	char	OPT	NONE
A user defined code (07/PC) that specifies the pay type categories you want to use: o For regular pay o To generate overtime o For reporting purposes on the Certified Payroll Register (U.S. only).
mnRateHourly	SHRT	MATH_NUMERIC	OPT	NONE
This is the employee's hourly rate. If applicable, Pay Type Multiplier and Shift Differential values will be added. If you change the value of the data display decimals for this field, you must also change the Hourly Rate (PHRT) and Base Rate (BHRT) fields in Time Entry to have exactly the same data display decimals.
mnHoursWorked	SHRW	MATH_NUMERIC	OPT	NONE
The standard number of hours to be paid employees whose pay frequency is Semi-Monthly (S). The number entered into this field is used during pre-payroll processing when the system calculates autopay; the hours entered into this field are used versus calculating the hours based upon gross pay divided by the hourly rate.
mnAmtGrossPay	GPA	MATH_NUMERIC	OPT	NONE
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).
cCertifiedEditFlag	CEDT	char	OPT	NONE
A code which specifies the type of information to be printed on the Certified Payroll Register for the Job Type and Job Step. The codes are: N Do not print any information related to this Job Type/Job Step on the Certified Payroll Register. Y Print all information related to this Job Type/Job Step on the Certified Payroll Register. H Print Hours Only for this Job Type/Job Step on the Certified Payroll Register.
jdDtWorkJulian	DWK	JDEDATE	OPT	NONE
The date used as the actual work date or pay-period ending date.
mnRegularHoursWorked	RHRW	MATH_NUMERIC	OPT	NONE
Hours Worked - Regular
mnRegularRate	PHRT	MATH_NUMERIC	OPT	NONE
The employee's hourly rate, which is retrieved during time entry. If you enter a rate in this field on any other form, that rate can override the value in the Employee Master table. In the Employee Master table, this number is the employee's base hourly rate. In the Union Rates table, it is the straight time rate. NOTE: If you change the number of the data display decimal digits for this field, you must also change fields Rate - Base Hourly (BHRT) and Rate - Hourly (SHRT) so that they have exactly the same number of data display decimal digits.
mnOvertimeHoursWorked	THRW	MATH_NUMERIC	OPT	NONE
Hours Worked - Overtime
mnOvertimeRate	OT2	MATH_NUMERIC	OPT	NONE
The rate of billing for "double" time.
mnOtherHoursWorked	HHRW	MATH_NUMERIC	OPT	NONE
The total number of hours which have been designed as 'Other' via the Category Code on the Pay Type Revision screen.
mnTotalHoursWorked	PHRW	MATH_NUMERIC	OPT	NONE
The number of hours associated with each transaction.
mnJobAmount	GPA	MATH_NUMERIC	OPT	NONE
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).
cProcessingMode	EV01	char	OPT	NONE
An option that specifies the type of processing for an event.
mnRegLineCounter	MATH01	MATH_NUMERIC	OPT	NONE
- - - Good Performance Low Value.
mnOvrLineCounter	MATH01	MATH_NUMERIC	OPT	NONE
- - - Good Performance Low Value.
mnOthLineCounter	MATH01	MATH_NUMERIC	OPT	NONE
- - - Good Performance Low Value.

Related Functions

B0000564 Get Internal Next Number

Related Tables

None