EmployeeLockoutFunction

Employee Lockout Function

Minor Business Rule

Object Name: B0700021

Parent DLL: CPAY

Location: Client/Server

Language: C

Functional Description

Purpose
The purpose of the Employee Lockout Function business function is to write a record to the Employee
Lockout Code (F07300) file to signify that the employee has been locked to the Payroll being processed.

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 calls GetPayrollLockoutStatus (N0500021) to determine whether employee has been locked to another
payroll. If so, the cErrorFlag output parameter is set to '1' and the function returns to the calling program.

Function Reads Employee Multiple Jobs (F060118) file using Address Number, Job Code and Job Step.

For each Employee Multiple Jobs record determine whether Job Qualifies Compares Payroll Beginning and Ending dates to Start (PSDT) and Stop
Dates (PTDT) on F060118

Provided Job Qualifies:

Write record to Multiple Jobs Cache

Determine whether Pay Cycle Group or Payroll Company not equal to blank

If Condition is True either not equal to blank

Determine whether Salaried Employee

If Salaried Employee

Determine whether Employee Payroll Company EQ Home Company
Employee Home Business Unit in Pay Cycle Group Code

If Condition True, Set cEmployeeLockoutFlag to '1'

If not Salaried Employee

Call Lock Timecards Function (B0700019) to determine whether to lock employee

If Condition is False both are equal to blank

Set cEmployeeLockoutFlag to '1'

Write record to Employee Lockout Code (F07300)

If Job does not Qualify:

ErrorFlag output parameter is set to '1' and the function returns to the calling program.

Data Structure

D0700021 - DS for Employee Lockout Function

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
szPayrollCompany	CO	char	REQ	INPUT
Special Input Expected Value from Pay Cycle Parameters (F07210). THIS IS A REQUIRED FIELD. Special Value Returned ^
szPayCycleGroupCode	CYGR	char	REQ	INPUT
Special Input Expected Value from Pay Cycle Parameters (F07210). THIS IS A REQUIRED FIELD. Special Value Returned ^
cPayCycleGroupType	PCGT	char	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 ^
jdPayrollBeginningDate	EFTB	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 ^
mnAddressNumber	AN8	MATH_NUMERIC	REQ	INPUT
Special Input Expected Value from Employee Master (F060116). THIS IS A REQUIRED FIELD. Special Value Returned ^
jdDateEmploymentStart	DST	JDEDATE	REQ	INPUT
Special Input Expected Value from Employee Master (F060116). THIS IS A REQUIRED FIELD. Special Value Returned ^
mnPayCycleBypassCount	PYCB	MATH_NUMERIC	REQ	INPUT
Special Input Expected Value from Employee Master (F060116). 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 ^
szHomeBusinessUnit	HMCU	char	REQ	INPUT
Special Input Expected Value from Employee Master (F060116). THIS IS A REQUIRED FIELD. Special Value Returned ^
szPositionID	POS	char	REQ	INPUT
Special Input Expected Value from Employee Master (F060116). THIS IS A REQUIRED FIELD. Special Value Returned ^
szJobCode	JBCD	char	REQ	INPUT
Special Input Expected Value from Employee Master (F060116). THIS IS A REQUIRED FIELD. Special Value Returned ^
szJobStep	JBST	char	REQ	INPUT
Special Input Expected Value from Employee Master (F060116). THIS IS A REQUIRED FIELD. Special Value Returned ^
szUnionCode	UN	char	REQ	INPUT
Special Input Expected Value from Employee Master (F060116). THIS IS A REQUIRED FIELD. Special Value Returned ^
jdNextRaiseDate	NRDT	JDEDATE	REQ	INPUT
Special Input Expected Value from Employee Master (F060116). THIS IS A REQUIRED FIELD. Special Value Returned ^
mnNextHourlyRate	HRTN	MATH_NUMERIC	REQ	INPUT
Special Input Expected Value from Employee Master (F060116). THIS IS A REQUIRED FIELD. Special Value Returned ^
cPayFrequency	PFRQ	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 ^
szTimecardCache	PID1	char	REQ	INPUT
Special Input Expected Name of the cache - returned from InitializePrePayrollCaches (B0700003). THIS IS A REQUIRED FIELD. Special Value Returned ^
szMultipleJobsCache	PID2	char	REQ	INPUT
Special Input Expected Name of the cache - returned from InitializePrePayrollCaches (B0700003). THIS IS A REQUIRED FIELD. Special Value Returned ^
szPayCycleCache	PID3	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	PID4	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 ^
mnNumberJobs	MATH01	MATH_NUMERIC	OPT	OUTPUT
Special Input Expected None Special Value Returned [FUTURE] Will return number of jobs processed. ^
cErrorFlag	EV01	char	OPT	OUTPUT
Special Input Expected None Special Value Returned Returns a '1' if Employee being processed is locked to another payroll; otherwise, will return a '0'. ^
cPayTypeHSP	SALY	char	REQ	INPUT
Special Input Expected Value from Employee Transactions Detail File (F06116). THIS IS A REQUIRED FIELD. Special Value Returned ^
szNameAlpha	ALPH	char	REQ	INPUT
Special Input Expected Value from Employee Transactions Detail File (F06116). THIS IS A REQUIRED FIELD. Special Value Returned ^
cEELockedAnotherPayrollFlag	EV03	char	OPT	OUTPUT
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.
cPayPeriodNumber1	PPM1	char	OPT	INPUT
The number of the pay period, within the month, for employees who are paid weekly. This field is used in conjunction with the Pay Period to Calculate field on the DBA Setup form to determine which deductions, benefits, and accruals the system will calculate during the current payroll cycle.
cPayPeriodNumber2	PPM2	char	OPT	INPUT
The number of the pay period, within the month, for employees who are paid biweekly. The system uses this value and the Pay Period to Calculate, from the DBA Setup form, to determine which deductions, benefits, and accruals to calculate during the current payroll cycle.
cPayPeriodNumber3	PPM3	char	OPT	INPUT
The number of the pay period, within the month, for employees paid semimonthly. The system uses this value and the Pay Period to Calculate, from the DBA Setup form, to determine which deductions, benefits, and accruals to calculate for the current payroll processing cycle.
cPayPeriodNumber4	PPM4	char	OPT	INPUT
The number of the pay period within the month, for employees who are paid monthly. This field is used in conjunction with the Pay Period to Calculate field on the DBA Setup form to determine which deductions, benefits, and accruals are to be calculated during this payroll cycle.
cPayPeriodNumber5	PPM5	char	OPT	INPUT
The number of the pay period for employees who are paid annually. This field is used in conjunction with the Pay Period to Calculate field on the DBA Setup form to determine which deductions, benefits, and accruals are to be calculated during this payroll cycle.
cPayPeriodNumber6	PPM6	char	OPT	INPUT
The number of the pay period, within the month, that is used in conjunction with the Pay Period to Calculate field on the DBA Setup form to determine which deductions, benefits, and accruals are to be calculated during this payroll cycle.
cEELockoutUpdateFlag	UFLG	char	OPT	NONE
This indicator in the employee master is under program control. It is set to Y when anything is added, changed or deleted related to the employee including the master file itself, the employee's pay/deduction/benefit/accrual transaction profile, his current time and pay detail transactions or interim check information. The principal use of this indicator is to determine whether the employee needs to be reprocessed during a pre-payroll rerun. The pre-payroll process automatically resets this flag to blank.
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.

Related Functions

B0700003 Create PrePayroll Caches
B0700019 Lock Timecards Function
N0500021 Get Payroll Lockout Status
N0700105 F07355 Write Pre-Payroll Error Record

Related Tables

F060118 Employee Jobs
F07300 Employee Lockout Code File