GetPayrollLockoutStatus

Get Payroll Lockout Status

Minor Business Rule

Object Name: N0500021

Parent DLL: CFND

Location: Client/Server

Language: NER

Functional Description

The purpose of this NER is to determine if an employee is locked to a pre-payroll.  If it is determined that the record  is locked to a pre-payroll this NER
returns a one character code (EV01) showing the specific payroll cycle stage to the calling function.

The error flag (EV01) will have the following codes returned:
'0' will be returned if the employee is not locked to a payroll
'1' will be returned if the employee is locked to an active payroll
'2' will be returned if the employee is locked to an active payroll and  the payroll is presently processing.
'3' will be returned if the employee is locked to an active payroll and the checks have been printed.

If a '1' error code is returned, changes to the record for the current payroll version can be allowed, but the calling program must determine if changes to
the record will affect gross to net calculations.   (The calling program will use the Pay Period Start and Pay Period End Dates to determine if the changed
record affects the active payroll run).  If changes affect gross to net calculations, the calling function must call NER N0500020 (Force Changes Only), to flag
the Payroll Cycle Parameter (F07210) record with a Force Changes code (YST1).  If a '2' or a '3' error code is returned, the calling program must determine if the
work date on the record falls on or between the Pay Period Start and Pay Period End dates.  If it does, changes to the employee record must not be
allowed.  Either wait for the pre-payroll run to finish processing (error code 2), or the pre-payroll must be reset (error code 3) before changes can be allowed.

If a '0' error code is returned the record is not locked to a payroll and changes to the record should be allowed.


SetUp Notes

Technical Specifications

Parameters

Data Item            Data Structure DescriptionI/ORequiredTableNotes
AN8        MnAddressNumberIY
EFTB       JdPayPeriod StartDateOValue retrieved from F07210 file
EFTE       JdPayPeriodEndDateOValue retrieved from F07210 file
PAYD         mnPayrollID          OValue retrieved from F07300 file
USER         SzUserID                OValue retrieved from F07210 file
EV01          cErrorCode                      OOutput  Error Code

AN8 is the single key to the Lockout Code File (F07300) file.  By passing this parameter you are able to determine if an active Payment Record entry
exists.   If AN8 is not found in the F07300 file, update the Error Code (EV01) field with '0' and return to the calling program without updating the remaining data
structure fields.

Read F07300 file by AN8 until no more records are found (it will be in a DOWHILE loop, since more than one record can be in the F07300 file for an
employee).

Read the F07300 file until no more records for AN8 found, or until a record with a locked flag is found.  (The locked flag indicates that the employee is
locked to an active payroll).

If a record is found in the F07300 file with a locked flag

Access the F07210 file with PAYD as the single key. Return in the Data Structure the following fields to the calling program:

    Effective Beginning Date (EFTB)
    Effective Ending Date (EFTE)
    User ID (USER)
    Payroll ID (PAYD)
    Error Code (EV01)  Error Code is update as follows:
    If Pre-Payroll Status (PPST) = ' 1'
         Return '1' in Error Code (EV01)
                  End
    If  Pre-Payroll Status (PPST) = 'A' or 'S'
        Return '2' in Error Code (EV01)
    End
    If  Check Status (CHKS) = 'A' or ''1'
        Return '3' in Error Code (EV01)
    End

End

cErrorCode values:

'0' allow full update of record
'1' Record is included in an active pre-payroll (calling program can allow changes, but must call N0500020)
'2' Pre-Payroll is currently running (do not allow changes to the record)
'3' Checks have been printed for the payroll (do not allow changes to the record)

Related Tables

Table Table Description
F07300Employee Lockout Code File
F07210Payroll Cycle Parameter File

Processing

Data Structure

DN0500021 - Get Payroll Lockout Status

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
mnAddressNumber	AN8	MATH_NUMERIC	REQ	INPUT
A number that identifies an entry in the Address Book system, such as employee, applicant, participant, customer, supplier, tenant, or location.
jdDateBeginningEffective	EFTB	JDEDATE	OPT	OUTPUT
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.
jdDateEndingEffective	EFTE	JDEDATE	OPT	OUTPUT
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.
szPayrollID	PAYD	char	OPT	OUTPUT
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.
szUserId	USER	char	OPT	OUTPUT
The code that identifies a user profile.
cErrorCode	EV01	char	OPT	OUTPUT
An option that specifies the type of processing for an event.

Related Functions

None

Related Tables

None