PaymentShellRecordServer

Payment Shell Record Server

Minor Business Rule

Object Name: B0700017

Parent DLL: CPAY

Location: Client/Server

Language: C

Functional Description

Purpose
The purpose of the Payment Shell Record Server business function is to create a Payment (F07350)
record for each Check Control Number (in the Check Control Cache) for a given employee. These records are
created during the Pre-Payroll process.

Setup Notes and Prerequisites
This function should be called during Pre-Payroll from the Pre-Payroll Driver (R07200) program. You
must call InitializePrePayrollCaches (B0700003) before calling this function in order to retrieve the
appropriate cache names.

Special Logic
None

Technical Specification

Function reads all Payment (F07350) records for employee being processed:

- Determines whether DBA Limit (DBLF) and Tax Limit (TXLF)flags are equal to '1' for any of
employee's payments.

- Sets internal variables cDBALimitFlag and cTaxLimitFlag to '1' if any of the payments for the
employee are equal to '1'.

Function reads thru Check Control Cache:

- Creates Payment (F07350) record for each Check Control Number read.

Data Structure

D0700017 - DS for Payment Shell Record Server

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
mnAddressNumber	AN8	MATH_NUMERIC	REQ	INPUT
Special Input Expected Value from Employee Master (F060116). THIS IS A REQUIRED FIELD. Special Output Returned ^
jdPayrollBeginningDate	EFTB	JDEDATE	REQ	INPUT
Special Input Expected Value from Pay Cycle Parameters (F07210). THIS IS A REQUIRED FIELD. Special Value Returned ^
jdPayrollEndingDate	EFTE	JDEDATE	REQ	INPUT
Special Input Expected Value from Pay Cycle Parameters (F07210). THIS IS A REQUIRED FIELD. Special Value Returned ^
jdDatePayPeriodEnding	PPED	JDEDATE	REQ	INPUT
Special Input Expected Value from Pay Cycle Parameters (F07210). THIS IS A REQUIRED FIELD. Special Value Returned ^
szPayrollID	PAYD	char	REQ	INPUT
Special Input Expected Value from Pay Cycle Parameters (F07210). THIS IS A REQUIRED FIELD. Special Value Returned ^
szHomeCompany	HMCO	char	REQ	INPUT
Special Input Expected Value from Employee Master (F060116). THIS IS A REQUIRED FIELD. Special Value Returned ^
szCompany	CO	char	REQ	INPUT
Special Input Expected Value from Employee Master (F060116)or from Pay Cycle Parameters (F07210). THIS IS A REQUIRED FIELD. Special Value Returned ^
szHomeBusinessUnit	HMCU	char	REQ	INPUT
Special Input Expected Value from Employee Master (F060116). THIS IS A REQUIRED FIELD. Special Value Returned ^
cTaxHistoryType	THTY	char	REQ	INPUT
Special Input Expected Value from Employee Master (F060116). THIS IS A REQUIRED FIELD. Special Value Returned ^
szReportingCodesPayro001	P001	char	REQ	INPUT
A category code that defines payroll system needs. You can define the use and description of this code to fit your organization. For example, you can set up a category code for information such as Division, Supervisor, Branch office, Health insurance plan, Stock plan, and so on. Note: When setting up category codes in the Workforce Management system, you should coordinate information with the payroll department to insure that information is not duplicated or overwritten.
szReportingCodesPayro002	P002	char	REQ	INPUT
Special Input Expected Value from Employee Master (F060116). THIS IS A REQUIRED FIELD. Special Value Returned ^
szReportingCodesPayro003	P003	char	REQ	INPUT
Special Input Expected Value from Employee Master (F060116). THIS IS A REQUIRED FIELD. Special Value Returned ^
szReportingCodesPayro004	P004	char	REQ	INPUT
Special Input Expected Value from Employee Master (F060116). THIS IS A REQUIRED FIELD. Special Value Returned ^
szRoutingCodeCheck	MAIL	char	REQ	INPUT
Special Input Expected Value from Employee Master (F060116). THIS IS A REQUIRED FIELD. Special Value Returned ^
szCheckControlCache	PID	char	REQ	INPUT
Special Input Expected Name of the cache - returned from InitializePrePayrollCaches (B0700003). THIS IS A REQUIRED FIELD. Special Value Returned ^
jdDateUpdated	UPMJ	JDEDATE	OPT	INPUT
Special Input Expected Value from GetAuditInformation (B9800100). Special Value Returned ^
mnTimeLastUpdated	UPMT	MATH_NUMERIC	OPT	INPUT
Special Input Expected Value from GetAuditInformation (B9800100). Special Value Returned ^
szProgramID	PID	char	OPT	INPUT
Special Input Expected Value from GetAuditInformation (B9800100). Special Value Returned ^
szWorkStationID	JOBN	char	OPT	INPUT
Special Input Expected Value from GetAuditInformation (B9800100). Special Value Returned ^
szUserID	USER	char	OPT	INPUT
Special Input Expected Value from GetAuditInformation (B9800100). Special Value Returned ^
szAlphaName	ALPH	char	REQ	INPUT
Special Input Expected Value from Employee Master (F060116). THIS IS A REQUIRED FIELD. Special Value Returned ^
jdDatePayCheck	CKDT	JDEDATE	REQ	INPUT
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.
cEmployeePayStatus	PAST	char	OPT	NONE
The code used to indicate whether an employee's pay status is active or inactive. Codes for active pay status employees are numeric, and codes for inactive pay status employees are alphabetic. The system omits all employees with alphabetic pay status codes from the payroll run. See also Employment Status (EST) and Change Reason (TRS).
jdDateTerminated	DT	JDEDATE	OPT	NONE
The date that the employee was terminated, if applicable.
cTerminatedEEPaidFlag	EV01	char	OPT	OUTPUT
An option that specifies the type of processing for an event.
szTimecardCacheName	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.
szAAIJournalsCache_PID	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.
szOverrideGLBankAccount_GLBA	GLBA	char	OPT	NONE
The number of the bank account (general ledger account) to be updated automatically when receipts or disbursements are entered. The bank account number is assumed to be the same for every document in a batch. Therefore, it is not cleared from entry to entry. However, if you leave the bank account number blank, the system retrieves a default bank account number from the Automatic Accounting Instructions file (F0012), item number RB for Accounts Receivable and PB for Accounts Payable.
cEmpNotPaidFlag_EV03	EV03	char	OPT	NONE
A radio button that specifies the level at which trace/track result is to be displayed. Select the Detail to display all transactions except IB, IX, and IZ types. Or, select Derivative Lots Only to display only those transactions that may have created new derivative lot.

Related Functions

B0700003 Create PrePayroll Caches
B0700920 Retrieve AAI for Journals
B0701180 Retrieve Corporate Tax ID
N0700105 F07355 Write Pre-Payroll Error Record

Related Tables

F06106 Employee Pay Instructions
F069096 Payroll General Constants
F069116 Payroll Transaction Constants
F07350 Payment File