LaunchGenericPayrollReportsPrgm

Launch Payroll Reports Driver

Minor Business Rule

Object Name: B0700031

Parent DLL: CPAY

Location: Client/Server

Language: C

Functional Description

Purpose

The purpose of the Launch Payroll Report Programs business function is to generically launch the 
Payroll Report UBEs and Versions listed in the Report Setup (F07354) for the Payroll being processed.


Setup Notes and Prerequisites

You must first create the UBEs and Versions that you wish this business function to launch.  ALL UBEs 

to be launched by this business function must contain the same data structure;  at the current time, 

it consists of Payroll ID (PAYD).


Special Logic

None


Technical Specification

• Reads the Versions List (F983051) table to retrieve the processing options for the version passed to 
the function.

• Call jdeLaunchUBE to launch the program and version passed to the function.  Pass the Payroll ID to 
the program being launched. 


^

Data Structure

D0700031 - DS for Launch Reports Only

Parameter NameData ItemData TypeReq/OptI/O/Both
szPayrollIDPAYDcharREQINPUT

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

THIS IS A REQUIRED FIELD.


Special Value Returned
^

cReportStepCodeRPSCcharREQINPUT

Special Input Expected
This is the Step Code that determines which reports will be run at very stages of the Payroll Cycle. 
('1' Pre-Payroll reports;  '2' Payment reports;  '3' Journal reports;  '4' Reports Only reports;  '5'  

Final Update reports)


THIS IS A REQUIRED FIELD.


Special Value Returned
^

szReportProgramPID1charREQINPUT

Special Input Expected
Name of the UBE that is stored in Report Setup (F07354).

THIS IS A REQUIRED FIELD.


Special Value Returned
^

szReportVersionVERScharREQINPUT

Special Input Expected
Name of the UBE Version that is stored in the Report Setup (F07354).

THIS IS A REQUIRED FIELD.


Special Value Returned

^

cProcessingModeEV01charREQINPUT

Special Input Expected
This is the processing mode for the report payment programs.  Pass 'A' for asynchronous, or 'S' for 
synchronous.


THIS IS A REQUIRED FIELD.


Special Value Returned


^

cReturnCodeEV02charOPTOUTPUT

Special Input Expected
None

Special Value Returned

Returns a '0' if the function completed successfully; returns a '1' if the function has errors.
^

szUserIdForR07280USERcharOPTNONE

The code that identifies a user profile.

cPrintVertexRptForR07280EV01charOPTNONE

An option that specifies the type of processing for an event.

mnOverpaymentDBAForR07280PDBAMATH_NUMERICOPTNONE

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.

szTimeEntryVersion_VERSVERScharOPTNONE

A user-defined set of specifications that control how applications and reports run. You use versions to group and save a set of user-defined 
processing option values and data selection and sequencing options. Interactive versions are associated with applications (usually as a 
menu selection). Batch versions are associated with batch jobs or reports. To run a batch process, you must choose a version.

cPrePayrollStatus_EV01EV01charOPTNONE

An option that specifies the type of processing for an event.

cFutureDateRevisionsFlag_EV02EV02charOPTNONE

An option that specifies the type of processing for an event.

szFutureDateRevisionsVers_VERSVERScharOPTNONE

A user-defined set of specifications that control how applications and reports run. You use versions to group and save a set of user-defined 
processing option values and data selection and sequencing options. Interactive versions are associated with applications (usually as a 
menu selection). Batch versions are associated with batch jobs or reports. To run a batch process, you must choose a version.

cUpdatePayRateStepProg_EV03EV03charOPTNONE

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. 

cRollInterimIDDatesFlag_EV04EV04charOPTNONE

PeopleSoft event point processing flag 04.

cExpenseDistribCode_JCTYJCTYcharOPTNONE

This code determines the G/L date for labor and burden entries. Document types T2 and T4 are used to record labor and T3 is used to 
record burden.    1   Work Date.  The G/L date is the timecard work date.    2   Period Ending Date.  The G/L date is the pay period end date for the 
payroll cyle currently being run.    3   Cost Period.  The G/L date is the end of the accounting fiscal period for timecards with a work date in the 
prior period;  and the G/L date is the pay period end date for timecards in the current period.

cCreateJEsInFullDetail_EV01EV01charOPTNONE

An option that specifies the type of processing for an event.

jdOverrideAcctgDate_AGDTAGDTJDEDATEOPTNONE

The date on which the payroll-accounting journal entries are created. This date is the payment date unless you override it.

cAccountsPayableInteg_IAPIAPcharOPTNONE

A/P Integration is used to specify the level of integration between the Payroll and the Accounts Payable systems. Pro forma vouchers are 
created during the payroll journal entries step of the payroll cycle. Actual vouchers are created in accounts payable during the final update 
step.    N   No integration.    0   Create vouchers for both DBAs and taxes that have been setup with A/P integration.    1   Create vouchers only for 
DBAs that have been setup with A/P integration.    2   Create vouchers only for taxes that have been setup with A/P integration.

cRunAccountsPayableInt_APINAPINcharOPTNONE

A code that allows you to rerun A/P integration without rerunning pay period journals. This code is typically associated with a checkbox. 
Valid values are:    0  (Unchecked) - Run pay period journals and accounts payable integration.    1  (Checked) - Run accounts payable 
integration only.

cWAInvoiceDate_ARSTARSTcharOPTNONE

A code that specifies whether the invoice date on the voucher is the payroll check date or the pay period end date.  When the Accounts 
Payable system prints the payment for the payee, the system can print the invoice date on the check stub. The system fills the invoice date only 
for wage attachments.  This feature is useful when the payee uses the employee's pay schedule to track payments.  Values are:   Blank  
Create the voucher with check date in the invoice date field.  The invoice number will be the concatenation of the payroll ID, time, and voucher 
transaction number.   C  Create the voucher with check date in the invoice date field. The invoice number will be the concatenation of the check 
date, time, and voucher transaction number.  P  Create the voucher with pay-period end date in the invoice date field. The invoice number will 
be the concatenation of the pay-period end date, time, and voucher transaction number. 

cSeparateBatchForDBAsTax_APVBAPVBcharOPTNONE

A code that specifies whether to separate DBA vouchers and tax vouchers into two batches. This code is useful when your payment 
schedule for taxes requires you to approve and post the batch to accounts payable at a much earlier date than DBAs (or vice versa). This code is 
typically associated with a checkbox. Valid values are:    0 (Unchecked) - Create one batch for both DBA vouchers and tax vouchers.    1 
(Checked) - Create two batches, one for DBA vouchers and one for tax vouchers.

mnAccrualFactorRate_ACCFACCFMATH_NUMERICOPTNONE

The accrual factor applies to payroll expenses and is normally used during a transition pay period where all timecards are entered with a 
work date equal to the pay period end date. In this case, you can use the accrual factor (for example, 25 for 25%) to accrue a portion of payroll 
expenses in the previous month and defer the expense in the following month.

cDoNotCreateF05290s_EV06EV06charOPTNONE

An option that specifies the type of processing for an event.

cJEMultipleVersionsFlag_EV05EV05charOPTNONE

A flag that indicates whether automatic spell check is turned on.

cDeletePrevJEWORegen_EV01EV01charOPTNONE

An option that specifies the type of processing for an event.

szF07210Company_COCOcharOPTNONE

A code that identifies a specific organization, fund, or other reporting entity. The company code must already exist in the Company 
Constants table (F0010) and must identify a reporting entity that has a complete balance sheet. At this level, you can have intercompany 
transactions. Note: You can use company 00000 for default values such as dates and automatic accounting instructions. You cannot use company 00000 
for transaction entries.

jdF07210PaycheckDate_CKDTCKDTJDEDATEOPTNONE

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.

mnPrevGLBatchNbr_GICUGICUMATH_NUMERICOPTNONE

The batch number which has been assigned to the group of Journal Entries generated in the Payroll System. This number ties the entries 
together all of the way through Final Update and into the General Ledger Post program.

cInterCOSettlementFlag_EV02EV02charOPTNONE

An option that specifies the type of processing for an event.

cCopyLaborHoursP07210_EV03EV03charOPTNONE

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. 

szCountryForPayroll_CCPRCCPRcharOPTNONE

A user defined code list 00/CN that indicates the country in which the employee resides.

szVersion9_VER9VER9charOPTNONE

This is the batch number for payroll tax vouchers. If you specify separate batches for DBAs and taxes this batch will contain payroll 
vouchers for taxes. If separate batches are not specified, this batch is not created and payroll tax vouchers are placed in the same batch with 
DBAs. Separate batches are specified from the Journals step of the Pay Cycle.

jdPayPeriodEndingDate_PPEDPPEDJDEDATEOPTNONE

The last day of a processing period (pay period, month, quarter or year).

mnAPVoucherBatchNbr_VICUVICUMATH_NUMERICOPTNONE

This is the batch number for payroll vouchers. If you specify separate batches for DBAs and taxes this batch will contain payroll vouchers 
for DBAs. Otherwise, it will contain payroll vouchers for both DBAs and taxes. Separate batches are specified from the Journals step of the Pay 
Cycle.

mnF07210BatchNumber_ICUICUMATH_NUMERICOPTNONE

A number that identifies a group of transactions that the system processes and balances as a unit. When you enter a batch, you can either 
assign a batch number or let the system assign it using the Next Numbers program.

mnF07210DateYr_DTEYDTEYMATH_NUMERICOPTNONE

A two-digit number that specifies the applicable year. If you leave this field blank, the program uses the system date.

cPayPeriodWeekly_PPM1PPM1charOPTNONE

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.

cPayPeriodBiWeekly_PPM2PPM2charOPTNONE

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.

cPayPeriodSemiMonthly_PPM3PPM3charOPTNONE

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.

cPayPeriodMonthly_PPM4PPM4charOPTNONE

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.

cPayPeriodAnnual_PPM5PPM5charOPTNONE

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.

cPayPeriodOther_PPM6PPM6charOPTNONE

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.

cProcessInterimsFlag_EV01EV01charOPTNONE

An option that specifies the type of processing for an event.

cReprocessDBAFlag_EV01EV01charOPTNONE

An option that specifies the type of processing for an event.

cStepProgDeleteTime_EV01EV01charOPTNONE

An option that specifies the type of processing for an event.

mnPayrollJournVersCount_MATH10MATH10MATH_NUMERICOPTNONE

Event point for Math Numeric.

mnVersionNumber_MATH01MATH01MATH_NUMERICOPTNONE

- - - Good Performance Low Value. 

Related Functions

None

Related Tables

F983051 Versions List