PayCycleGroupFunction

Pay Cycle Group Function

Minor Business Rule

Object Name: B0700018

Parent DLL: CPAY

Location: Client/Server

Language: C

Functional Description

Purpose
The purpose of the Pay Cycle Group Function business function is to add records to the Pay Cycle 
Group Cache and to determine whether the Pay Cycle Group Flag is "on" - equal to '1' - for a given 
employee.

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

'b7Functions determines whether there are records in the Pay Cycle Group Cache:

'b7If there are records, function reads Pay Cycle Group Cache using Pay Cycle Group and 
Business Unit passed to the function.

'b7If matching record is found, Pay Cycle Group Flag on cache record is returned 
to calling program via the cPayCycleGroupFlag (i.e., set to '1').

'b7If no matching record is found, function attempts to read Business Unit 
Constants (F069056) using Business Unit passed to function.  If matching record is found, 
the Pay Cycle Group (yocygr) on the F069056 record is compared to the Pay Cycle 
Group that is passed to function.  

If Business Unit Constants (F069056) record is successfully fetched:

If the groups are equal, then cPayCycleGroupFlag is set to '1' 
and passed to the calling program and a record is added to the Pay 
Cycle Group Cache.

If the groups are not equal, then cPayCycleGroupFlag is set to 
'0' and passed to the calling program and a record is added to the 
Pay Cycle Group Cache.

If Business Unit Constants (F069056) record is not successfully 
fetched:

The cPayCycleGroupFlag is set to '0' and passed to the calling 
program and a record is added to the Pay Cycle Group Cache.

'b7If there are no records in the Pay Cycle Group Cache:

'b7Function attempts to read Business Unit Constants (F069056) using Business 
Unit passed to function.  If matching record is found, the Pay Cycle Group (yocygr) on 
the F069056 record is compared to the Pay Cycle Group that was passed to function.  


If Business Unit Constants (F069056) record is successfully fetched:

If the groups are equal, then cPayCycleGroupFlag is set to '1' 
and passed to the calling program and a record is added to the Pay 
Cycle Group Cache.

If the groups are not equal, then cPayCycleGroupFlag is set to 
'0' and passed to the calling program and a record is added to the 
Pay Cycle Group Cache.

If Business Unit Constants (F069056) record is not successfully 
fetched:

The cPayCycleGroupFlag is set to '0' and passed to the calling 
program and a record is added to the Pay Cycle Group Cache.









Data Structure

D0700018 - DS for Pay Cycle Group Function

Parameter NameData ItemData TypeReq/OptI/O/Both
szPayCycleGroupCYGRcharREQINPUT

Special Input Expected
Value from Pay Cycle Parameters (F07210).

THIS IS A REQUIRED FIELD.

Special Value Returned

^

szBusinessUnitMCUcharREQINPUT

Special Input Expected
Value from Employee Transactions Detail File (F06116).

THIS IS A REQUIRED FIELD.

Special Value Returned
^

cPayCycleGroupFlagEV01charOPTOUTPUT

Special Input Expected
None

Special Value Returned

Returns value of '1' or '0' to calling program.  '1' means the Pay Cycle Group Flag is "on";  '0' 
means the Pay Cycle Group Flag is "off".
^

szPayCycleCachePIDcharREQINPUT

Special Input Expected
Name of the cache - returned from InitializePrePayrollCaches (B0700003).

THIS IS A REQUIRED FIELD.

Special Value Returned
^

Related Functions

B0700003 Create PrePayroll Caches

Related Tables

F069056 Establishment Constant File