Pay Action Parameters PDF

Oracle HCM
Pay_Action_Parameters
Comprehensive Overview
Release 11i & R12
Prepared by Carole Black
Author: Carole Black
Creation Date: 21 Nov 2007
Last Updated: 21 Nov 2007
Control Number:
Version: 1.0
Copyright (C) 2007 Oracle Corporation All Rights Reserved
NOTE: The contents of this document are deemed to be correct

and accurate at time of going to press. If inaccuracies are
discovered then please contact [email protected]. Please
also contact me if you have experiences to share that would fit
within the scope of this document. There is no commitment on
content or scheduling for any functionality contained within this
document.
Guidelines made within this document may not hold true for every
HCM implementation at every site. The information must therefore be
thoroughly tested if it is to be followed.
Oracle HCM Pay_Action_Parameter Page 1 of 74 Oracle / Client Confidential

Comprehensive Overview 11i & R12
OVERVIEW ................................................................................................................................ 5
PAY ACTION PARAMETERS .................................................................................... 6
PAY ACTION PARAMETER VALUES ................................................................ 6
SUMMARY OF THE ACTION PARAMETERS ............................................ 7
OVERVIEW OF THE ACTION PARAMETERS.......................................... 11
ADD_MAG_REP_FILES ........................................................................................................ 11
ADVANCE_PAY_OFFSET ................................................................................................... 12
ASSIGNMENT_SET_DATE ................................................................................................ 12
BAL_BUFFER_SIZE ................................................................................................................. 13
BEE_INTERVAL_WAIT_SIZE ............................................................................................ 13
BEE_LOCK_INTERVAL_WAIT_SEC ............................................................................. 14
BEE_LOCK_MAX_WAIT_SEC ........................................................................................... 15
BEE_ MAX_WAIT_SEC .......................................................................................................... 16
CHANGED_BALANCE_VALUE_CHECK ................ ERROR! BOOKMARK NOT DEFINED.
CHUNK SHUFFLE .................................................................................................................... 17
CHUNK SIZE .............................................................................................................................. 18
COST_BUFFER_SIZE .............................................................................................................. 19
COST_API_IMODE ................................................................................................................. 20
COST_PLS_VAL ........................................................................................................................ 20
COST_VAL_SEGS .................................................................................................................... 21
COSTBAL ...................................................................................................................................... 22
DATA_MIGRATOR_MODE............................................................................................... 22
DATA_PUMP_DISABLE_CONT_CALC ...................................................................... 23
DATA_PUMP_NO_FND_AUDIT ..................................................................................... 24
DATA_PUMP_NO_LOOKUP_CHECKS ...................................................................... 25
DATA_PUMP_PURGE_CHUNK_SIZE ......................................................................... 25
DBC_FILE ...................................................................................................................................... 26
EE_BUFFER_SIZE ..................................................................................................................... 27
EE_ORIG_TERM_RULE_DATE_FUNC......................................................................... 27
FF_MAX_OPEN_CURSORS ................................................................................................ 28

FREQ_RULE_WHOLE_PERIOD ....................................................................................... 29
HR_DM_DEBUG_LOG .......................................................................................................... 29
HR_DM_DEBUG_PIPE .......................................................................................................... 72
HR_DU_DEBUG_LOG ........................................................................................................... 72
HR_DU_DEBUG_PIPE ........................................................................................................... 72
HRLEGDEL_SLEEP ................................................................................................................. 30
HR_GL_SYNC_DEBUG ......................................................................................................... 31
INIT_PAY_ARCHIVE ............................................................................................................. 31
INTERLOCK ................................................................................................................................ 32
JP_DIM_EXC_REV_FLAG .................................................................................................... 33
JRE_* ................................................................................................................................................ 33
JRE_VERBOSE.................................................................................................................................. 33
JRE_XMS ........................................................................................................................................... 33
JRE_XMX........................................................................................................................................... 33
JRE_XSS............................................................................................................................................. 33
LAT_BAL_CHECK_MODE .................................................................................................. 34
LOGGING .................................................................................................................................... 35
LOG_AREA .................................................................................................................................. 36
LOG_ASSIGN_END ................................................................................................................ 37
LOG_ASSIGN_START .......................................................................................................... 37
LOW_VOLUME ......................................................................................................................... 38
MANY_PROCS_IN_PERIOD.............................................................................................. 39
MAX_ERRORS_ALLOWED ................................................................................................ 39
MAX_SINGLE_UNDO ........................................................................................................... 40
MAX_ITERATIONS ................................................................................................................ 41
MESSAGE_NAMES ................................................................................................................. 72
OLD_LOW_VOLUME ............................................................................................................ 72
PAY_ACTION_PARAMETER_GROUPS ..................................................................... 42
PAYROLL_WF_NOTIFY_ACTION.................................................................................. 42
PDF_TEMP_DIR ........................................................................................................................ 73
PLSQL_PROC_INSERT ......................................................................................................... 73
PRINT_FILES .............................................................................................................................. 43
PRINTER_MEM_SIZE ............................................................................................................ 73
PROCESS_TIMEOUT ............................................................................................................. 45
PROCOST ..................................................................................................................................... 45
PUMP_DEBUG_LEVEL ......................................................................................................... 46
PUMP_DT_ENFORCE_FOREIGN_LOCKS................................................................. 47
PURGE_SKIP_TERM_ASG ................................................................................................. 47
PURGE_TIMEOUT................................................................................................................... 48
QUICKPAY_INTERVAL_WAIT_SEC AND .................................................................. 48
QUICKPAY_MAX_WAIT_SEC .......................................................................................... 48
RANGE_PERSON_ID ............................................................................................................. 50
REMOVE_ACT ........................................................................................................................... 51
REPORT_URL ............................................................................................................................. 73
RESET_PTO_ACCRUALS .................................................................................................... 53
RETRO_DELETE ....................................................................................................................... 73
RETRO_POP_COST_KEYFLEX ......................................................................................... 54
RETRO_RECALC_ALL_COMP ......................................................................................... 73
REV_LAT_BAL ........................................................................................................................... 54
RR_BUFFER_SIZE .................................................................................................................... 55
RRV_BUFFER_SIZE ................................................................................................................. 55
RUN_XDO .................................................................................................................................... 56
SET_DATE_EARNED ............................................................................................................. 58
STD_FILE_NAME ..................................................................................................................... 58
SUPPRESS_INSIG_INDIRECT ......................................................................................... 59
TAX_CACHE_SIZE .................................................................................................................. 60
TAX_CHECK_OVERRIDE ................................................................................................... 60
TAX_DATA .................................................................................................................................. 60
TAX_DEBUG_FLAG ................................................................................................................ 61
TAX_LIBRARIES ....................................................................................................................... 61
TGL_DATE_USED ................................................................................................................... 61
TGL_GROUP_ID ....................................................................................................................... 62
TGL_REVB_ACCT_DATE .................................................................................................... 63
TGL_SLA_MODE ..................................................................................................................... 73
THREADS ..................................................................................................................................... 64
TRACE ............................................................................................................................................ 66
TRACE_LEVEL ........................................................................................................................... 67
TRANSGL_TRACE .................................................................................................................. 68
TR_BUFFER_SIZE..................................................................................................................... 68
US_ADVANCE_EARNINGS_TEMPLATE .................................................................. 74
US_ADVANCE_WAGE_ATTACHMENT .................................................................... 69
US_SOE_VIEW_FROM_ASG_FP_SCREEN ................................................................ 70
USER_MESSAGING ............................................................................................................... 71
UTF8_RESTRICTION_MODE ........................................................................................... 74

Overview
This document highlights the parameters on the Pay_Action_Parameters table
the provided a comprehensive overview of each parameter. Including the
parameter use, values, default values, and where the parameter is used with
the Oracle HCM Application.
This document is a gathering point of multiple pieces of information regarding

the Pay_Action_Parameters and should be used as reference when making
changes to the Pay_Action_Parameters table.

Pay Action Parameters
Payroll action parameters, which are stored on the Pay_Action_Parameter

table, are considered to be ‘Global’ parameters that control aspects of the
Oracle Payroll batch processes. It is important to recognize that the effects of
setting values at the ‘Global’ level for specific parameters may be application
wide. The text indicates where parameters are related to specific processes.
For some parameters you should also understand the concept of array
processing and how this affects performance.
By using Pay_Action_Parameter_Groups, a specific pay action parameter can

be setup to execute for a specific Business Group or User, and will therefore
not impact the overall application.
Pay Action Parameter Values
Predefined values for each parameter are supplied with the system, but you
can override these values as part of your initial implementation and for
performance tuning.
The PAY_ACTION_PARAMETERS view contains the columns:

PARAMETER_NAME and PARAMETER_VALUE which will map onto the
same 2 columns in the PAY_ACTION_PARAMETER_VALUES table. The
definition of the view uses the value of a pay_action_parameter_group_id
global variable (defined in the pay_core_utils package) to join to the
ACTION_PARAMETER_GROUP_ID column of
PAY_ACTION_PARAMETER_VALUES table.
The values stored in the pay_action_parameter_values table with a null

action_parameter_group_id are referred to as global parameters. The view is
defined so that if a parameter has been given a value in both the group
specified with the group_id global variable AND a row in the values table with
a null group_id (ie a global variable) only the former will be returned. In other
words a parameter with the correct group_id will take precedence over a global
parameter.
It is recommended that the values for the Pay Action Parameters be entered via
the application, within the Pay Action Parameter Form (PAYWSATP.fmb),
which will allow the user to create new groups and add/update parameters
within groups
The payroll batch processes read values from this view upon startup, or will
provide appropriate defaults, if specific parameter values are not specified.

Summary of the Action Parameters
The following list shows user enterable action parameters and values with any predefined default value
.
Parameter Description sValues Default
The maximum number of additional audit
ADD_MAG_REP_FILES or report files the magnetic tape process can 1 or more 4
produce
Obsoletes the arrear payroll and allows
ADVANCE_PAY_OFFSET Y or N N
different offset payroll for Advance Pay.
Determines whether date_earned context
ASSIGNMENT_SET_DATE D
for assignment sets is effective date
Size of the Balance Buffer in the Payroll
BAL_BUFFER_SIZE 1 or more 30
Run
Size of the Balance Buffer in the Payroll
BEE_INTERVAL_WAIT_SEC 1 or more 2
Run
Batch Element Entry (BEE) Database Lock
BEE_LOCK_INTERVAL_WAIT_SEC 0 or More 0
Rolling Interval
Batch Element Entry (BEE) Database Lock
BEE_LOCK_MAX_WAIT_SEC 0 or more 0
Timeout
BEE_MAX_WAIT_SEC Batch Element Entry (BEE) Timeout 1 or more 600
CHANGED_BALANCE_VALUE_CHECK Disable changed balance value check Y or N y
Randomizes the order in which the chunks
CHUNK SHUFFLE Y or N N
are processed
CHUNK SIZE Size of the chunks (commit units) 1 – 16000 20
Size of the buffer used in the array inserts
COST_BUFFER_SIZE 1 or more 20
and selects within the Costing process.
COST_API_IMODE Use ID Mode of KeyFlex API in Costing. Y or N N
COST_PLS_VAL Costing process use flexfield validation API Y or N Y
Enable server side validation on the
COST_VAL_SEGS Y or N N
segment
COSTBAL Use hierarchy in balance costs Y or N N
Used to override the Data Migrator mode
DATA_MIGRATOR_MODE P, Y, or N N
used in Data Pump
Used to disable the Continuous Calculation
DATA_PUMP_DISABLE_CONT_CALC Y or N N
functionality during Data Pump processing.
Used to disable the Auditing functionality
DATA_PUMP_NO_FND_AUDIT Y or N N
during Data Pump processing
Used to disable the Lookup Checks during
DATA_PUMP_NO_LOOKUP_CHECKS Y or N N
Data Pump processing.
Controls the number of rows to be deleted
DATA_PUMP_PURGE_CHUNK_SIZE 1 – 5000 500
in each commit unit.
DBC file used to get JAVA connection (used
DBC_FILE
in Dev DB only)
EE_BUFFER_SIZE Element entry buffer size for payroll run 1 or more 40
Use original functionality when deriving
EE_ORIG_TERM_RULE_DATE_FUNC Y or N N
employee termination rule dates
FastFormula Maximum Open Formula
FF_MAX_OPEN_CURSORS 32 – 128 128
Cursors
When using this parameter, the date used
FREQ_RULE_WHOLE_PERIOD Y, N, or R D
will be regular payment date (most of the

time this is the check date)
:INFO
:SUMM
Data Migrator Debug Level for Logfile :SUMM
HR_DM_DEBUG_LOG :ROUT
Output :FAIL
:PARA
:FAIL
HR_DM_DEBUG_PIPE Data Migrator Debug Level for Pipe Output
:INFO
:SUMM
Data Uploader Debug Level for Logfile :SUMM
HR_DU_DEBUG_LOG :ROUT
Output :FAIL
:PARA
:FAIL
Data Uploader Debug Level for Pipe
HR_DU_DEBUG_PIPE
Output
O or more
HRLEGDEL_SLEEP Sleep time for disable HRMS access 10
seconds
NORMAL or
HR_GL_SYNC_DEBUG HR Auto Orgs Debug Level NORMAL
DEBUG
Switch for data corruption workaround in Y or N or
INIT_PAY_ARCHIVE N
archive process YYYY/MM/DD
Use the assignment level interlocking
INTERLOCK Y or N N
procedures
JP Balance Dimension: Exclude Reversal /
JP_DIM_EXC_REV_FLAG Y or N N
Reversed Results
JRE_VERBOSE JAVA Debugging – JAVA Statements Y or N N
JRE_XMS JAVA Debugging – JAVA Min heap size Y or N N
JRE_XMX JAVA Debugging – JAVA Max heap size Y or N N
JAVA Debugging - JAVA min shared heap
JRE_XSS Y or N N
size
Switch to determine which balances to B – Ck Latest Bal
LAT_BAL_CHECK_MODE N
check first (Latest Balances or Run Results) R - Ck Run Res
G – General
M – Entry/Exit
P – Performance
E – Element
L – Bal Fetching
B – Bal Maint
I – Bal Output
R – Run Results
LOGGING Debug messaging level
F – Formulas
C – Cache Struct
Q- Cache Query
S – Cache End
Stat
V – Quantum
T – PLSQL-Dtls
Z – PLSQL-Bkout
Function to start
LOG_AREA Procedure to debug
logging
Assignment to
All
LOG_ASSIGN_END Ending assignment to debug end logging,
assignments
including this one
Assignment to All
LOG_ASSIGN_START Starting assignment to debug
start logging assignments
LOW_VOLUME Low_Volume Optimizer Setting. Y or N N

MANY_PROCS_IN_PERIOD Many processes included in period Y or N N
CHUNK_
SIZE (or 20
Maximum number of consecutive errors if no chunk
MAX_ERRORS_ALLOWED 1 or more
you encounter before a full failure. size)
20
Maximum number of assignment actions

MAX_SINGLE_UNDO 1 or more 50
for form rollback of a payroll action.
Maximum number of attempted runs in
MAX_ITERATIONS O or more 15
iterations per run action.
Switch to only output message names
MESSAGE_NAMES
instead of text
OLD_LOW_VOLUME Save for rule hint Y or N N
PAY_ACTION_PARAMETER_GROUPS Use the new grouping functionality Y or N N
NULL
Process workflow wait switch
WAIT
PAYROLL_WF_NOTIFY_ACTION NULL
NOWAIT
PAYMENTWAIT
PDF_TEMP_DIR Temporary Directory for PDF Merging
Enable/disable PL/SQL based range
PLSQL_PROC_INSERT Y or N
processing code
PRINT_FILES Use concurrent request to print files Y or N N
PRINTER_MEM_SIZE Override printer memory size in Kbytes
PROCESS_TIMEOUT Time in minutes before a process times out 0 or more No Timeout
PROCOST Costing of proration Y or N Y
AMD
RRP
GID
MSG
ROU
Logging for tracking errors with Data
PUMP_DEBUG_LEVEL WCD
Pump
STK
EXT
RRI
CLF
BLI
Enforce Date-track Foreign Key Locking
PUMP_DT_ENFORCE_FOREIGN_LOCKS Y or N Y
When Running Data Pump
PURGE_SKIP_TERM_ASG Skip terminated assignments in purge Y or N N
Time allowed (in seconds) before the purge
PURGE_TIMEOUT O or more 0
process times out.
QUICKPAY_INTERVAL_WAIT_SEC QuickPay Polling Interval 1 or more 2
QUICKPAY_MAX_WAIT_SEC QuickPay Timeout 1 or more 300
Switch to use person_id in
RANGE_PERSON_ID Y or N N
pay_population_ranges
Switch to disable the deletion of report
REMOVE_ACT Y or N Y
assignment actions
URL location where payroll process report
REPORT_URL
output files will be written.
Determines whether the PTO accruals for
RESET_PTO_ACCRUALS an assignment should be recalculated from Y or N N
the beginning..

Now a Legislation
RETRO_DELETE Retropay process updates run results
Rule
Retropay by element populate cost
RETRO_POP_COST_KEYFLEX Y or N N
keyflex_id from original
RETRO_RECALC_ALL_COMP
REV_LAT_BAL Reversals maintain latest balances Y or N N
RR_BUFFER_SIZE Run result buffer size for the payroll run 1 or More 20
RRV_BUFFER_SIZE Run value buffer size for the payroll run 1 or More 30
RUN_XDO Run XML Publisher for Report Generation Y or N Y
Set date earned on child processes Y or N N

SET_DATE_EARNED
N (if not
overridden
Use standard payroll file naming
STD_FILE_NAME Y or N by
convention
legislative
rule)
Suppress creation of insignificant indirect
SUPPRESS_INSIG_INDIRECT Y or N
run results
TAX_CACHE_SIZE Quantum cache size 0 or more 0
TAX_CHECK_OVERRIDE Quantum override version checking Y or N N

TAX_DATA Quantum Storage location of taxation files
TAX_DEBUG_FLAG Quantum switch debugging on Y or N N
$PAY_TOP
/vendor/
TAX_LIBRARIES Quantum override location of tax libraries
quantum/li
b
Transfer to GL Process transfer on date
TGL_DATE_USED Null, E or EVE Null
earned
TGL_GROUP_ID Populate group_id in gl_interface
Accounting Date for reversals and balance
TGL_REVB_ACC_DATE C or P P
adjustments
TGL_SLA_MODE Switch for use of sub ledger accounting
THREADS Number of slave processes system uses 1 or more 1
TRACE Switch database tracing on Y or N N
TRACE_LEVEL Sets the level of the Database Trace
TRANSGL_THREAD Switch for Multi-Threaded TGL version Y or N Y
TR_BUFFER_SIZE Taxability rules buffer size for payroll run 100 or above 500
US_ADVANCE_EARNINGS_TEMPLATE Switch for US earning element template Y or N Y
Advance US wage attachment functionality
US_ADVANCED_WAGE_ATTACHMENT Y or N
enabled
PREPAY or
US_SOE_VIEW_FROM_ASG_FP_SCREEN Switch for US SOE NULL
NULL
USER_MESSAGING Switch user messaging on Y or N N
BYTE
UTF8_RESTRICTION_MODE UTF8 Restriction Mode CHAR BYTE
UNRESTRICTED

Overview of the Action Parameters
The following is a comprehensive overview of the action parameter, including

a description of the parameter, how and when to use the parameter, and what
Oracle HCM modules use the parameter.
ADD_MAG_REP_FILES
The maximum number of additional audit or report files the

magnetic tape process can produce.
Description
Oracle HCM Reports can be written during the production of the magnetic
tape file. These reports could be used to check the details that are produced. A
number of reports can be created in the same run. That number can be limited
by using the ADD_MAG_REP_FILES action parameter in the
PAY_ACTION_PARAMETERS table.
Each report is accessed by using a prefix that denotes the file, for example,
REPORT1_ to denote report number 1, REPORT2_to denote report number 2,
and so on. If a report number is outside the range of the
ADD_MAG_REP_FILES value, an invalid return error is reported. The report
files are opened as and when needed with the names of the files previously
described.
Values
1 or more
Default Value
Processes Used In
BACS
NACHA
W2
P35
Return to Pay_Action_Parameters Summary

ADVANCE_PAY_OFFSET
Obsoletes the arrear payroll and allows different offset payroll for Advance
Pay.
Description
Once enabled the "Advance Period" entry will be placed in the period earned
rather than period paid. Similarly the "Advance Indicator" entry will be placed
in the period whose regular payment date lies within the period in leave.
NOTE: Customer has to manually switch the feature by creating a record for
the ADVANCE_PAY_OFFSET action parameter.
This is recommended only if there are no pending advances to be processed.

Once switched on this feature then it should not be reverted.
Values
Y or N
Default Value
Processes Used In
Advance Pay
Modules Used In
PAYWSAHP.fmb
ASSIGNMENT_SET_DATE
Whether date_earned context for assignment sets is effective date
Description
When the assignment set is being executed it is looking for the existence of the
element entry on the effective_date, if the entry doesn't exist on that date the
assignment is not qualified for the assignment set and will not be processed.
By setting the ASSIGNMENT_SET_DATE in the pay_action_parameter to D,
the behavior of the Assignment Set is changed subtly in that it provides the
value of the DATE_EARNED of the run for the date earned context.
Values
D
BAL_BUFFER_SIZE
Size of the Balance Buffer in the Payroll Run
Description
Size of the Latest Balance buffer used for array inserts and updates: 1 row per
Latest Balance.
Values
1 or more
Default Value
30
Maximum Value
1000
Parameter Type
Array, Select, Update, and Insert Buffer Size
Processes Used In
Advance Pay RetroPay Process

Payroll Run Quick Pay Process
Process
BEE_INTERVAL_WAIT_SIZE
Batch Element Entry Polling Interval
Description
Setting this parameter will would make the current process wait longer for the
child process to complete
Values
1 or more
Default Value

Parameter Type
BEE
Modules Used In
PAY_PAYWSQEE_PKG (paywsqee.pkb)
BEE_LOCK_INTERVAL_WAIT_SEC
Batch Element Entry (BEE) Database Lock Rolling Interval
Description
This parameter can be set to avoid BEE from raising an error immediately
whenever it encounters an interlock. However please note this might cause
some performance issue as there will be time wasted on waiting while the
interlock is resolved.
Hence we do recommend customers not to submit multiple batches with

overlapping assignments as this would result in interlocking issue. The BEE
Summary form does checks this and warns the user if there would be any
potential interlocks.
Values
0 or more
Default Value
Parameter Type
BEE
Processes Used In
BEE
Modules Used In
Payplnk (paylink.pkb)
pay_batch_link_process_pkg (pybatlnk.pkb)

BEE_LOCK_MAX_WAIT_SEC
Batch Element Entry (BEE) Database Lock Timeout
Description
This parameter can be set to avoid BEE from raising an error immediately
whenever it encounters an interlock. However please note this might cause
some performance issue as there will be time wasted on waiting while the
interlock is resolved.
Hence we do recommend customers not to submit multiple batches with

overlapping assignments as this would result in interlocking issue. The BEE
Summary form does checks this and warns the user if there would be any
potential interlocks.
Values
0 or more
Default Value
Parameter Type
BEE
Processes Used In
BEE
Modules Used In
Payplnk (paylink.pkb)
pay_batch_link_process_pkg (pybatlnk.pkb)

BEE_ MAX_WAIT_SEC
Batch Element Entry (BEE) Timeout
Description
Setting this parameter will would make the current process wait longer for the
child process to complete.
Values
1 or more
Default Value
600
Parameter Type
BEE
Processes Used In
BEE
Modules Used In
PAY_PAYWSQEE_PKG (paywsqee.pkb)
CHANGED_BALANCE_VALUE_CHECK
Disable changed balance value check
Description
Poor performance can be experienced when creating a new balance feed. A

check is performed to find out if the creation will affect the current value of a
balance - and if so a warning message is output. The amount of work that is
required to be undertaken to perform this check is invasive - and can result in
bad performance. By setting the CHANGED_BALANCE_VALUE_CHECK pay
action parameter to N this warning check will be disabled.
Values
Y or N
Default Value

Modules Used In
HR_BALANCE_FEEDS (pybalfed.pkb)
CHUNK SHUFFLE
Randomizes the order in which the chunks are processed
Description
Randomizes the order in which the chunks are processed ( to minimize

contention between database blocks ) rather than processing them sequentially.
Values
Y or N
Default Value
Parameter Type
Parallel Processing
Processes Used In
Advance Pay Payroll Run Rollback

Cash Process PrePayments
Costing Quick Pay Process
Deposit Advice Quick Pay PrePayments
Multi-Threaded Security List Maintenance
Archiver Transfer to GL
Payroll Run Process
Modules Used In
pay_population_ranges_pkg (pycoppr.pkb)

CHUNK SIZE
Size of the chunks (commit units)
Description
Size of each commit unit for the batch process. This parameter determines the
number of assignment actions that are inserted during the initial phase of
processing and the number of assignment actions that are processed at one
time during the main processing phase.
Note: This does not apply to the Cheque Writer/Check Writer, Magnetic Tape
or RetroPay processes.
During the initial phase of processing this parameter defines the array size for
insert. Large chunk size values are not desirable and the default value has been
set as a result of benchmark tests.
Each thread processes one chunk at a time.
Values
1 to 16000
Default Value
20
Maximum Value
16000
Parameter Type
Parallel Processing
Processes Used In
Advance Pay Participation Process: Temporal

Cash Process Payroll Run Process
Costing Payroll Run Rollback
Deposit Advice Premium Calculation Process
Data Pump PrePayments
Multi-Threaded Quick Pay Process
Archiver Quick Pay PrePayments
Participation Security List Maintenance
Process: Selection System Extract Process
Participation System Extract Restart Process
Process: Scheduled Transfer to GL

Modules Used In
PACKAGES
pay_bal_adjust (pybaladj.pkb)
pay_balance_upload (pybalupl.pkb)
pay_mws_magtape_reporting (pymwsrep.pkb)
pay_magtape_extract (pymagext.pkb)
pay_us_magtape_reporting (pyusmrep.pkb)
py_rollback_pkg (pyrolbak.pkb)
REPORTS
PAYCAREG.rdf
PAYUSACT.rdf
PAYUSREG.rdf
PAYUSRW2.rdf
COST_BUFFER_SIZE
Size of the buffer used in the array inserts and selects within the Costing
process.
Description
Addresses memory issue inside costing code specific to assignment level

costing.
Values
1 or more
Default Value
20
Maximum Value
1000
Processes Used In
Costing

COST_API_IMODE
Use ID Mode of KeyFlex API in Costing.
Description
If the COST_API_IMODE pay_action_parameter is set to 'Y', the costing code

will execute the fnd_flex_keyval API in 'I' mode to validate flexfield
combinations. This will allow the use of FND_STANDARD_DATES and FND
LOOKUP value sets for flexfield segments.
Values
Y or N
Default Value
Processes Used In
Costing
COST_PLS_VAL
Costing process use flexfield validation API
Description
Tuning system involves altering the way the costing process validates against
the pay_cost_allocation_keyflex table. This can be done by setting the value of
the parameter COST_PLS_VAL in the table PAY_ACTION_PARAMETERS.
This parameter is usually not defined, this means the costing process
uses (AOL C Code) validation. This is fine until the table becomes
increasingly populated and performance starts to slow. It is then possible
to set COST_PLS_VAL to value Y. This will force the costing process
to validate using the (fnd_flex_keyval PL/SQL API), this will have to be
used together with indexes on the pay_cost_allocation_keyflex table, in
order to see a performance improvements.
Values
Y or N
Default Value

COST_VAL_SEGS
Enable server side validation on the segment
Description
BEE API and Assignment level costing API does check for mandatory
segments from HRMS Family Pack K onwards. However forms does allow
user to create records without enforcing this check.
Check_mandatory_segments procedure in both APIs carries out the check to

see whether any segments are mandatory and if no values are not passed. If so
then it raises an error. This is resolved by not executing this check by default
but this check can be carried out if the "COST_VAL_SEGS" action parameter is
set to 'Y' in the PAY_ACTION_PARAMETERS table.
Values
Y or N
Default Value
Parameter Type
Costing
Modules Used In
PACKAGES
pay_btl_shd (pybtlrhi.pkb)
Pay_cost_allocation_api (pycalapi.pkb)
hr_entry (pyeentry.pkb)

COSTBAL
Use hierarchy in balance costs
Description
The COSTBAL pay_action_parameter has been setup to use a hierarchy in

Balance Cost.
If this setting is made the balancing flexfield will obey the following hierarchy:
Element Link-balance
Organization cost
Payroll cost
i.e. The Balance account is only displayed on the Element Link Form. If this
parameter is set the Balancing information from the element link will be used
and if this is not set traverse the Org and Payroll cost hierarchy to populate the
null segments
Values
Y or N
Default Value
Parameter Type
Costing
DATA_MIGRATOR_MODE
Used to override the Data Migrator mode used in Data Pump
Description
This parameter can be used to override the Data Migrator mode used in Data
Pump, this only takes effect if the Data Migrator mode is originally set to N.
Data_migrator_mode = P is used to to turn off the life event triggers during the
conversion process.
The procedure p_set_data_migrator_mode will set the value of global

data_migrator_mode to the value in the table pay_action_parameters. The
value is then used to check whether the potential life events need to be created
or not .
Oracle internal use only

Values
P, Y or N
Default Value
Parameter Type
Data Pump
DATA_PUMP_DISABLE_CONT_CALC
This parameter is used to disable the Continuous Calculation functionality
during Data Pump processing.
Description
Setting Pay_Action_Parameter parameter

DATA_PUMP_DISABLE_CONT_CALC with value of Y will disable
continuous calc
Values
Y or N
Default Value
Parameter Type
Data Pump
Processes Used In
Data Pump
Modules Used In
PACKAGE
hr_data_pump (hrdpump.pkb)

DATA_PUMP_NO_FND_AUDIT
This parameter is used to disable the Auditing functionality during Data
Pump processing. This can be used to improve the throughput of the data
pump.
Description
Setting Pay_Action_Parameter parameter DATA_PUMP_NO_FND_AUDIT

with value Y to turn off the auditing.
Values
Y or N
Default Value
Parameter Type
Data Pump
Processes Used In
Data Pump
Modules Used In
PACKAGE

DATA_PUMP_NO_LOOKUP_CHECKS
This parameter is used to disable the Lookup Checks during Data Pump
processing. This can be used to improve the throughput of the data pump
Description

DATA_PUMP_NO_LOOKUP_CHECKS with value Y to turn off the
validation.
Values
Y or N
Default Value
Parameter Type
Data Pump
Processes Used In
Data Pump
Modules Used In
PACKAGE
DATA_PUMP_PURGE_CHUNK_SIZE
The DATA_PUMP_PURGE_CHUNK_SIZE action parameter controls the number of
rows to be deleted in each commit unit.
Description

DATA_PUMP_NO_LOOKUP_CHECKS with value Y to turn off the
validation.
Values
1 - 5000

Default Value
500
Maximum Value
5000
Parameter Type
Data Pump
Processes Used In
Data Pump
Modules Used In
PACKAGE
DBC_FILE
DBC file used to get JAVA connection (used in Dev DB only)
Description
If DBC_FILE is not stored in default location of $FND_TOP/secure/ then the

pay_action_parameter parameter DBC_FILE can be set up a with path and
name of dbc file.
Values
Specific to the environment
Default Value
None
Processes Used In
Advance Pay
Payroll Run Process
Quick Pay Process
RetroPay Process

EE_BUFFER_SIZE
Element entry buffer size for payroll run
Description
Size of the buffer used in the initial array selects of Element Entries,
Element Entry Values, Run Results and Run Result Values per
assignment.
Values
1 or more
Default Value
40
Maximum Value
1000
Parameter Type
EE_ORIG_TERM_RULE_DATE_FUNC
Use original functionality when deriving employee termination rule dates
Description
The entry_asg_pay_link_dates procedure in the hr_entry PL/SQL package has

been amended to provide the following behavior - Recurring elements that
were entered against secondary assignments where the employee had been
previously terminated and where the termination rule on the element was 'Last
Standard Process' were not given the correct end-date. To illustrate, consider
the following scenario:
ATD LSP FPD

V V V
ASG |---------------------|-----------------------|
ASG-2 |---------------------|-----------------------|
ET |------------------------------------------------->
EL |------------------------------------------------->
EE1 |---------------------------------|
EE2 |---------------------------------------------|
Where ASG is a primary employee assignment, ASG-2 is a secondary

employee assignment and where the employee associated with each
assignment has been terminated at the Actual Termination Date (ATD), Last
Standard Process Date (LSP) and Final Process Date (FPD) dates shown. Now,
when an entry is created, post-termination, for an element that has the 'Last
Standard Process' termination rule, for both the primary and secondary
assignments, the entry is created with the end-dates shown, i.e. the entry for
the secondary assignment, EE2, has an end-date equal to the Final Process
Date, which is inconsistent with the termination rule on the element. However,
the entry for the primary assignment, EE1, has an end-date equal to the Last
Standard Process date, which is correct.
Customers may revert to the previous behavior, if they so wish, by enabling

the 'EE_ORIG_TERM_RULE_DATE_FUNC' action parameter (i.e. setting the
value to ‘Y’)
Values
Y or N
Default Value
N
Modules Used In
PACKAGE
hr_entry (pyeentry.pkb)
FF_MAX_OPEN_CURSORS
FastFormula Maximum Open Formula Cursors
Description
This parameter defines the maximum number of formula cursors that are kept
open within Fast Formula caches.
By increasing the number of open cursors in the FastFormula C execution

engine formula cache to 128 this reduces the parsing overhead as most
legislations have a lot less than 128 different formulas executed during a
payroll run.
Values
32 - 128
Default Value
128
Maximum Value
128

FREQ_RULE_WHOLE_PERIOD
When using the parameter, the date used will be regular payment date (most
of the time this is the check date)
Description
"The Frequency Rule module has been enhanced to allow a different technique
to determine the first period of a month. This will ensure that the entry is not
processed more than once if it is set to be processed once in a month.
This feature is enabled by setting the parameter value to "Y"
Note: Once this is inserted then it should NOT be updated or deleted, as this
could de-stablize the product."
Values
Y, N or R
Default Value
Modules Used In
PACKAGES
hr_elements (pyelemnt.pkb)
HR_DM_DEBUG_LOG
Data Migrator Debug Level for Logfile Output
Description
This parameter is used to control the level of output in the Data Migrator
process. The “:” character is used to delimit the debug level values.
Values
INFO – Detailed information written to the log file

SUMM – Summary information written to the log
ROUT – Location in code where the log entry was raised is written to the log file
PARA – Parameter values written to the log file
FAIL – Error messages written to the log file
Default Value
:SUMM
:FAIL
Parameter Type
Data Migrator / Data Upload
Processes Used In
Data Migrator
HRLEGDEL_SLEEP
Sleep time for disable HRMS access
Description
When HRGLOBAL is being run the system functionality is temporarily

disabled. This parameter controls the frequency with which the system is
polled to determine whether HRGLOBAL is complete. It specifies the number
of seconds between two successive loops of the program to reduce CPU usage.
Note: This functionality could be used to allow non-HCM users into the
system whilst hrglobal is running. This helps prevent users accessing HCM
functionality whilst hrglobal is running.
Caution: Not widely used though as it temporarily removes menu options

from a users responsibility and is confusing for end users. Use with caution –
if at all!
Values
O or more seconds
Default Value
10
Parameter Type
Data Migrator / Data Upload
Modules Used In
PACKAGE
PAY_HRMS_ACCESS_PKG (pyhraces.pkb)

HR_GL_SYNC_DEBUG
HR Auto Orgs Debug Level
Description
This parameter controls the debug level in the process that synchronizes
organizations between GL and HR. Set the value to DEBUG to turn debugging
on.
Note: The process is ‘Synchronize GL company cost centres with existing

organizations’. If this parameter exists (irrespective of it’s value) it is
interpreted as being in DEBUG mode
Values
NORMAL or DEBUG
Default Value
NORMAL
Processes Used In
Synchronize GL company cost centres with existing organizations
INIT_PAY_ARCHIVE
Switch for data corruption workaround in archive process
Description
The external process archiver uses previously run archives to determine which
balances to report. By setting the pay action parameter
'INIT_PAY_ARCHIVE' to either 'Y' or the date of the archiver run (the date
has to be in "YYYY/MM/DD" format). This parameter causes the external
process archive to run without relying on previous archives and will prevent
the corruption from being carried forward..
Values
Y or N or YYYY/MM/DD
Default Value
Processes Used In
Payroll Archiver
Modules Used In
PACKAGE
pay_us_action_arch (pyusxfrp.pkb)
INTERLOCK
Use the assignment level interlocking procedures
Description
If this parameter is set to Y the assignment action creation phase of the payroll
processes will produce output for each assignment showing the list of
assignments belonging to the payroll that will and will not be processed.
Enabling this parameter results in more work being performed - and hence
impacts performance. For this reason we only recommend setting this
parameter for debugging purposes.
The INTERLOCK pay_action_parameter is supported by SEQUENCED action

only (run, quickpay, retropay...).
BY default this takes a value of 'N' - and this result in a minimal number of sql
statementsbeing executed to find out which assignments to process - and
including in those statements is the predicates to look for other earlier failed
sequenced actions or later sequenced actions. (IF either of these exist for an
assignment then the current process won't process that assignment).
However if the INTERLOCK pay_action_parameter is set to Y, the statements

used to find which assignment to process are broken into sub statements - so
that an explicit statement just looking for earlier failed or future can be
executed on each assignments that are in the set/payroll to be processed. A log
line is put into the concurrent process log file for each assignment that has
been found to have an earlier errored or future action -> so that the user can
effectively see that "this assignment would have been processed but ...".
So in summary, the INTERLOCK pay_action_parameter is for debugging -

when the user wonders why an assignment is not getting processed when they
think it should do. There will be a performance impact if this functionality is
set on - so it is strongly recommend that user only use it for debugging and
ensure they unset it when finished.
Values
Y or N
Default Value

Processes Used In
Payroll Related Processes
Modules Used In
PACKAGE
hr_dynsql (pydynsql.pkb)
JP_DIM_EXC_REV_FLAG
JP Balance Dimension: Exclude Reversal / Reversed Results
Description
Used in JP sql script (run after perlegjp.pdt ) that deletes

PAY_DIMENSION_ROUTES entries, if this parameter is set to Y the script
does not delete entries that use the Exclude Reversal dimension.
Note: This is strictly used for Japanese Localization
Values
Y or N
Default Value
Modules Used In
SCRIPT
JP Postinstall Script (pyjpdim.sql)
JRE_*
JAVA Debugging parameters
Description
JRE_VERBOSE JRE_XMX
Java debug statements Java max heap size
JRE_XMS JRE_XSS
Java min heap size Java min shared heap size

Values
Y or N
Default Value
LAT_BAL_CHECK_MODE
Switch to determine which balances to check first (Latest Balances or Run
Results)
Description
The HRASSACT.TRASH_LATEST_BALANCES procedure is used to check for

and delete affected latest balances when an operation (such as the alteration of
a balance feed) causes the possible invalidity of a latest balance held in the
latest balance tables.
This procedure uses a statement that can be extremely expensive. Depending

upon the customers’ data loading, the expensive statement can be divided up
into separate statements, which will thus improve the performance of this
procedure. The statement in question looks for latest balances affected by the
balance being operated on, and run result values belonging to the input value
being operated on.
If the customer defines the parameter LAT_BAL_CHECK_MODE the value of

'B' (or the HRASSACT.CHECK_LAT_BALS_FIRST global to TRUE) the
statement will be divided into looking for appropriate latest balances first, and
then only run result values if latest balances were found.
If the customer defines the parameter LAT_BAL_CHECK_MODE to 'R' (or

the HRASSACT.CHECK_RRVS_FIRST global to TRUE), conversely the
statement will be divided into looking for a run result value first.
Values
B – Ck Latest Bal
R - Ck Run Res
Default Value
Modules Used In
PACKAGE
Hrassact (pyassact.pkb)

LOGGING
Debug messaging level
Description
Use the LOGGING parameter to provide a large volume of detailed

information that is useful for investigating problems.
Detailed logging options should only be switched on when you need to

investigate problems that are not easily identified in other ways. The logging
activities will have an impact on the overall performance of the process you are
logging. Usually, this feature is needed during your initial implementation and
testing before you go live. In normal operation you should switch off detailed
logging.
Attention: If you need to contact Oracle Support for assistance in identifying or

resolving problems in running your payroll processes, you should prepare
your log file first. Define the Logging Category, Area and range of
Assignments and then resubmit the problem process.
Values
G - General - logging information

Output messages from the PY_LOG macro for general information. This option
does not sort the output and you should normally choose a list of specific
categories.
M - Entry or exit routing information
Output information to show when any function is entered and exited, with
messages such as 'In: pyippee', 'Out : pyippee'. The information is indented to
show the call level, and can be used to trace the path taken through the code at
function call level. Often, this would be useful when attempting to track down
a problem such as a core dump.
P - Performance information
Output information to show the number of times certain operations take place
at the assignment and run levels and why the operation took place. For
example, balance buffer array writes.
E - Element entries information
Output information to show the state of the in-memory element entry
structure, after the entries for an assignment have been fetched, and when any
item of the structure changes; for example, addition of indirects or updates.
This also shows the processing of the entry.
L - Balance fetching information
Output information to show the latest balance fetch and subsequent expiry
stage.
B - Balance maintenance information
Output information to show the creation and maintenance of in-memory
balances
I - Balance output information
Output information to show details of values written to the database from the
balance buffers.
R - Run results information

Output information to show details of run results and run result values written
to the database from the Run Results or Values buffer.
F - Formula information
Output information to show details of formula execution. This includes
formula contexts, inputs and outputs.
C - C cache structures information.
Output information to show details of the payroll cache structures and changes
to the entries within the structure.
Q - C cache query information
Output information to show the queries being performed on the payroll cache
structures.
S - C Cache ending status information
Output information to show the state of the payroll cache before the process
exits, whether ending with success or error. Since much of the logging
information includes id values, this can be used to give a cross reference where
access to the local database is not possible.
T - PL/SQL Detail
Detail of PL/SQL debug information for the process. You can only use the T
parameter if you also specify the Z parameter. Include the T parameter when
debugging any process that uses PL/SQL intensively, for example,
PrePayments.
V - Vertex (US and CA customers only)
Output information to show the values being passed in and out of the Vertex
tax engine. This option also creates a separate file in the Out directory
showing the internal settings of the engine.
Z - PL/SQL Output
Output information to show the PL/SQL debug information for a process. If
you specify the Z parameter, you can also specify the T parameter to show
PL/SQL detail. Include the Z parameter when debugging any process that uses
PL/SQL intensively, for example, PrePayments.
Parameter Type
Logging
Modules Used In
PACKAGES FORMS
pay_ip_startup_util (pyintstu.pkb) PAYWSATP.fmb

pay_pyucslis_pkg (pyucslis.pkb)
pay_us_pto_co_pkg (pyuspaco.pkb)
LOG_AREA
Procedure to debug
Description
Specifies the area of code logging takes place for. The values correspond to c-
code entries in the form PY_ENTRY(env, "pyipppr"); where "pyipppr" is the
functional area that will have logging enabled.

Please note the case is VERY important for the parameter value
Values
Function to start logging
Parameter Type
Logging
LOG_ASSIGN_END
Ending assignment to debug
Description
Specifies the Assignment id that logging ends on. (See online help for
additional information)
Values
Assignment to end logging (including this assignment)
Default Value
All Assignments
Parameter Type
Logging
LOG_ASSIGN_START
Starting assignment to debug
Description
Specifies the Assignment id that logging starts on. (See online help for
additional information)
Values
Assignment to start logging
Default Value
All Assignments
Parameter Type
Logging

LOW_VOLUME
Low_Volume Optimizer Setting.
Description
If this parameter is set to Y then the balance user exit and database item
definitions are forced to use a RULE optimizer hint. Setting this parameter
should ensure that balance statements are executed with optimum explain
plans.
Values
Y or N
Default Value
Maximum Value
N (for DB 9.0 and above)
Modules Used In
PACKAGES
pay_balance_pkg (pybaluex.pkb)
hrdyndbi (pydyndbi.pkb)
Script to set Low_Volume (pyinslv.sql)
PAY_JP_BALANCE_PKG (pyjpblnc.pkb)
SCRIPT
Script to set Low_Volume (pyrtlv.sql)
REPORTS
PAYUSCHK.rdf
PAYUSPST.rdf

MANY_PROCS_IN_PERIOD
Many processes included in period
Description
The assignment action creation statement within pynonrun.pkb used by the

Costing and Transfer to GL processes has been seen to exhibit bad performance
if the process is being executed over many costable actions. Hence an
alternative version of the statement has been implemented using a different
execution plan (via the use of CBO hints) - and will be used if the parameter
'MANY_PROCS_IN_PERIOD' is set to 'Y'.
Values
Y or N
Default Value
Modules Used In
PACKAGES
pay_population_ranges_pkg (pycoppr.pkb)
hr_nonrun_asact (pynonrun.pkb)
MAX_ERRORS_ALLOWED
Maximum number of consecutive errors you encounter before a full failure.
Description
In every pay cycle you would expect some errors to occur in processing
individual assignments, especially in the Payroll Run. These errors are usually
caused by incorrect or missing data in the employee record. For practical
reasons, you would not want the entire run to fail on a single assignment
failure. However, if many assignments generate error conditions one after the
other, this will usually indicate a serious problem, and you will want to stop
the entire process to investigate the cause. For processes that support
assignment level errors you can use the parameter MAX_ERRORS_ALLOWED
to control the point at which you want to stop the entire process to investigate
these errors.
Note: This parameter affects each thread. For example, if

MAX_ERRORS_ALLOWED is set to 10 and THREADS is set to 3, this could
result in the whole process raising up to 27 errors without terminating with
status ‘error’. The first thread to reach 10 errors will cause the whole process to
terminate.

Values
1 or more
Default Value
CHUNK_SIZE (or 20 if no chunk size)
Parameter Type
Error Reporting
Processes Used In
Costing Payroll Run

Data Pump Premium Calculation Process
Participation PrePayments
Process: Selection Rollback
Participation System Extract Process
Process: Scheduled System Extract Restart Process
Participation
Process: Temporal
Modules Used In
PACKAGES
pay_mix_rollback_pkg (pymixrbk.pkb)
PAY_US_PTO_CO_PKG (pyuspaco.pkb)
MAX_SINGLE_UNDO
Maximum number of assignment actions for form rollback of a payroll
action.
Description
The maximum number of assignment actions that can be rolled back in a single
commit unit when rollback is executed from a form. Although you can change
the default limit, you would usually use the Rollback process from the SRS
screen if it is likely to be breached.
Values
1 or more
Default Value
50

Parameter Type
Rollback
Processes Used In
Payroll Run Rollback
Modules Used In
PACKAGE
MAX_ITERATIONS
Maximum number of attempted runs in iterations per run action.
Description
Used within the iterative engine to determine the number of iterations to do

before making the best guess..
Values
0 or more
Default Value
15
Parameter Type
Rollback
Processes Used In
Payroll Run Rollback
Modules Used In
PACKAGE

PAY_ACTION_PARAMETER_GROUPS
Use the new grouping functionality
Description
The user is now be able to use the pay action parameter form to define named
groups of pay action parameters and their values. The customer will then be
able to specify which group a process is to be executed with by entering it as a
new (optional) parameter within the process SRS definition.
For instance the customer will be able to create a group A which contains the
THREADS pay_action_parameter set to 4 and the LOGGING parameter set to
N, and a group B which contains THREADS set to 1, LOGGING set to GMF
and TRACE set to Y. When executing processes he could then elect to execute
a payroll Run with group A so that it executes with 4 threads and no logging,
or he could elect to run a Costing process with group B so that it executes with
1 thread and creates logging and tracing information.
Pay_action_parameters will also be held at a global level (ie no group_id) so

that if a group specified for a process does not contain the definition for a
parameter, the process will use the global value held for that parameter. In
this way group-level parameter values will take precedence over global
parameter values.
Values
Y or N
Default Value
Modules Used In
PACKAGES FORMS
pay_jp_itax_archive_pkg (pyjpiarc.pkb) PAYWSATP.fmb

pay_legislation_rules_pkg (pylegrul.pkb)
pay_pst_utils ( pypstutl.pkb)
PAYROLL_WF_NOTIFY_ACTION
Process workflow wait switch
Description
The parameter, provide functionality to wait or not to wait for user response in
notification generated during the Payroll Workflow Process cycle.

Usage - The most common reason this parameter is used while printing checks
on pre-printed stationary, the customer has to first feed the pre-printed
stationary before printing checks. Another reason is while running RTs for any
Payroll patch user does not have to respond to any notifications.
Values
NULL - Default wait

WAIT - Default wait
NOWAIT - Response not required for any Notification.
PAYMENTWAIT - Response required for only payment notifications
Default Value
NULL
PRINT_FILES
Use concurrent request to print files
Description
This parameter was introduced to support the US and Canadian PDF Report
Enhancements
These reports have been enhanced to use the multi threaded capabilities of
Payroll engine (PYUGEN) and integrate with XML Publisher to generate PDF
output. Once the user submits the above concurrent program, the program will
automatically spawn the following -
sub requests "Generate Payroll XDO Reports" to merge the XML

data with the template to generate the PDF
sub requests "Sub Request: (PDF Document Stream Printing)" to

print the output. The output of this request will have the actual PDF.
Set the following in PAY_ACTION_PARAMETERS after applying the patch
Row 1 >
- Parameter Name: RUN_XDO
- Parameter Value: N
Row 2 >
- Parameter Name: PRINT_FILES
The sub requests "Generate Payroll XDO Reports" spawned by the programs to
merge the XML data and template to generate PDF output requires the
following parameters to be defined in the XDO configuration file.
system-temp-dir: Use this parameter to register the system temporary

directory with XDO. This directory is used to create temporary files during the
execution.

printer_name.pdf-stream-divider-max-output-size: Use this parameter to
specify the maximum size file that can be printed on the printer. The size
should be specified in bytes. The default size is 1,048,576 bytes (1 Mega Byte
(MB)). Replace 'printer_name' with the name your printer is
registered with the application.
The XDO configuration file is called xdo.cfg and is located in the

$XDO_TOP/resource directory. You can edit the existing file. If the filedoes
not exist, you can create a new one. The entries in the xdo.cfg file are in the
following format.
<config version="1.0.0" xmlns="http://xmlns.oracle.com/oxp/config/">

<properties> <property name="system-temp-
dir">temporary_directory</property>
<property name="printer_name.pdf-stream-divider-max-output-
size">file_size_in_bytes
</property> </config>
Users should be able to view the output sent to the printer by looking at the
concurrent request called "Sub Request: (PDF Document Stream Printing)"
Navigation: View => Requests => Find => View Output.
The complete XML generated for a report can be viewed from view Output
button of main request i.e. "Employee W-2 PDF", "RL1 PDF" or "RL2 PDF"
The main concurrent program, Employee W-2 PDF, RL1 PDF or RL2 PDF
will complete with a status of "Warning" (if copies is set to 1 or more).
Users can ignore this warning.
Please note, last employee will be printed twice if the copies is set
to 1 or more.
Values
Y or N
Default Value
Modules Used In
PACKAGE REPORTS
pay_core_xdo_utils Employee W-2 PDF

(paycorexdoutil.pkb) RL1 PDF Report
pay_legislation_rules_pkg RL2 PDF Report
(pylegrul.pkb)

PROCESS_TIMEOUT
Time in minutes before a process times out
Description
Used in the Run Balance generation process to determine how long (in
minutes) to allow before the process times out. If no value is entered then there
will be no timeout limit.
The PROCESS_TIMEOUT is used to control the amount of time that the GRB
or ARBD processes are allowed to execute. This allows for controlling when
we are executing the process so that it does not conflict with the execution of
other mainstream processes running at critical run times.
PROCESS_TIMEOUT Functionality is to allow the Generate Run Balance or

Adjust Run Balance Dates processes to execute for a specific length of time and
the gracefully be shutdown - which will then allow for a retry at a later time:
Process Timeout - The Generate Run Balance process can be scheduled to

timeout after a certain amount of time. Once that time it reached processing is
stopped and will only recommence when Retry Payroll Process is run for the
stopped process.
Values
0 or more
Default Value
No Timeout
Modules Used In
PACKAGES
pay_run_balance_build (pycorubl.pkb)
PROCOST
Costing of proration
Description
When building the Cost Keyflex hierarchy the Costing process fetches the
various levels of the hierarchy as of the date_earned of the Run result being
costed.
The Process was previously enhanced so that Prorated Run results are costed
slightly differently: their element entry level cost is fetched as of the prorated
run results end_date.
In FP.K the Costing process has been enhanced for prorated run results to fetch
all 5 levels of costing as of the end_date of that result.

A switch is being supported so that if a customer has an issue with this new
behavior they can revert back to older behavior (only entry level fetched as of
prorated result end_date)
Values
Y or N
Default Value
PUMP_DEBUG_LEVEL
Logging for tracking errors with Data Pump
Description
Use this parameter to turn on logging for tracking errors generated by the Data
Pump process. You can combine any number of these options by
concatenating the values, separated by a colon.
Note: When you enable data pump logging options, output is produced for
every thread that may be running. Use the PYUPIP command to view this
output
Values
AMD - API Module Debug (enables trace output from API).

RRP - Range Row Processing logging (logs the number of errors that
occurred for each unit of work, or range)
GID - Get_id function failure information (logs failures in func-tions that
map user values to IDs)
MSG - Output specific logging messages
ROU - Routing information (entry to and exit from procedures)
WCD - Wrapper cache debug logging
STK - Stack dump logging (trace information on failure)
EXT - Exit information (trace information on success)
RRI - Range row insert logging
CLF - Send messages to concurrent log file
BLI - Show batch_line information
Processes Used In
Data Pump
Modules Used In
PACKAGE

PUMP_DT_ENFORCE_FOREIGN_LOCKS
Enforce Date-track Foreign Key Locking When Running Data Pump
Description
This parameter is used to control whether Foreign Key Locking is enforced

when an api is called from a Data Pump session.
Oracle internal use only
Values
Y or N
Default Value
Processes Used In
Data Pump
Modules Used In
PACKAGES
hr_pump_utils (hrdputil.pkb)
hrd_rel_uk (pespprhi.pkb)
PURGE_SKIP_TERM_ASG
Skip terminated assignments in purge
Description
This parameter determines whether the purge process includes terminated

assignment. If this is set to Y, the Purge Preparation Phase does not create
assignment actions for terminated assignments.
Values
Y or N
Default Value

Modules Used In
PACKAGE
PURGE_TIMEOUT
Time allowed (in seconds) before the purge process times out.
Description
The purge process uses a "timeout" facility, controlled by the

PURGE_TIMEOUT action parameter. This functionality allows the process
to automatically stop running after a set number of seconds.
Currently, this is only implemented in the purge preparation and purge

deletion phases.
Values
0 or more
Default Value
Modules Used In
PACKAGE
QUICKPAY_INTERVAL_WAIT_SEC and
QUICKPAY_MAX_WAIT_SEC
QuickPay Polling Interval
QuickPay Timeout
Description
System Management of QuickPay Processing
When users initiate a QuickPay run or a QuickPay prepayments process, the

screen freezes until the process finishes. QuickPay is set up to manage any
cases in which the concurrent manager fails to start the process within a
specified time period, or starts it but fails to complete it within the specified
period. This situation can sometimes arise when, for example, many high
priority processes hit the concurrent manager at the same time. The system's
management of the screen freeze occurring when a user initiates a QuickPay
process involves:
- Checking the concurrent manager every few seconds for the process
completion.
- Unfreezing the screen and sending an error message to the user when the
process has not completed within a maximum wait time.
- The error message includes the AOL concurrent request ID of the process.
The user must requery the process to see its current status.
System administrators can improve the speed of QuickPay processing at their

installation by:
- Changing the default for the interval at which checks for process completion
occur. By default, the check of the concurrent manager occurs at 2 second
intervals. The parameter row QUICKPAY_INTERVAL_WAIT_SEC in the
table PAY_ACTION_PARAMETERS sets this default.
- Changing the default for the maximum wait time.
- The maximum wait time allowed for a QuickPay process to complete

defaults to 300 seconds (5 minutes), after which the system issues an error
message. The parameter row QUICKPAY_MAX_WAIT_SEC in the
PAY_ACTION_PARAMETERS table sets this default.
- Defining a new concurrent manager exclusively for the QuickPay run and
prepayments processes.
To change the defaults for the interval at which checks occur or for the
maximum wait time:
- Insert new rows (or update existing rows) in the table

PAY_ACTION_PARAMETERS.
Notice that QUICKPAY_INTERVAL_WAIT_SEC and

QUICKPAY_MAX_WAIT_SEC are codes for the Lookup type
ACTION_PARAMETER_TYPE.
To define a new concurrent manager exclusively for the two QuickPay

processes:
1. Exclude the two QuickPay processes from the specialization rules for the
standard concurrent manager.
2.Include them in the specialization rules for the new QuickPay concurrent
manager to be fewer than those of the standard concurrent manager. Doing
so reduce the time it takes to start requests for the QuickPay processes.
Values
1 or more

Default Value
2 (QUICKPAY_INTERVAL_WAIT_SEC)
300 (QUICKPAY_MAX_WAIT_SEC)
Processes Used In
Quick Pay Process

Quick Pay PrePayments
Modules Used In
PACKAGE
pay_qpq_api (pyqpqrhi.pkb)
RANGE_PERSON_ID
Switch to use person_id in pay_population_ranges
Description
If this parameter is set to Y then various processes will use the person_id
column in pay_population_ranges which should result in improved
performance in the assignment action creation phase of those processes
This column is used in the 'chunk creation' and enhances performance of

multi-threaded payroll reports/processes. The performance of particular
statements within the chunk creation phase of processing is improved for
sparse populations of people with the setting of the RANGE_PERSON_ID
pay_action_parameter to Y. A new PERSON_ID column is introduced into the
table PAY_POPULATION_RANGES so that instead of one row being created
per chunk, a row will now get created per person_id in the chunk to avoid
inefficient range scans.
Values
Y or N
Default Value
Processes Used In
P45
Unacceptable Tax Balance
PAYROLL RUN PROCESS
FRENCH ARCHIVER GB PAYSLIP ARCHIVER
IRELAND PAYSLIP
JP ARCHIVER
US ARCHIVE
US SQWL ARCHIVE
Modules Used In
PACKAGES
PAY_P45_PKG (payrp45.pkb) pay_us_archive (pyusarch.pkb)

PAYUSUNB_PKG (payusunb.pkb) pay_us_action_arch (pyusxfrp.pkb)
hr_dynsql (pydynsql.pkb) pay_us_sqwl_archive (pyussqwl.pkb)
pay_fr_arc_ut (pyfrarcu.pkb) pay_ac_utility (pyacutil.pkb)
pay_gb_payslip_archive (pygbparc.pkb) pay_population_ranges_pkg (pycoppr.pkb)
pay_ie_payslip_archive (pyieparc.pkb) hr_nonrun_asact (pynonrun.pkb)
pay_jp_itax_archive_pkg (pyjpiarc.pkb)
REMOVE_ACT
Switch to disable the deletion of report assignment actions
Description
This parameter is used in magnetic tape process to control whether Magnetic

Tape Report Actions are removed once processing has completed, if the value
is Y then the actions will be removed. This keeps the number of rows held in
pay_assignment_actions to a minimum.
Purpose: This will keep assignment actions and payroll actions in the tables
PAY_PAYROLL_ACTIONS and PAY_ASSIGNMENT_ACTIONS while the
report builds to process the assignments. You can use the action_ids to
troubleshoot the package being utilized by the process. (i.e. Deposit Advice
uses pyusdar.pkb, procedure action_creation)
1. Resp: System Administrator:

2. Nav: Concurrent => Program => Define
3. Query the process in question in the Program field (i.e. Deposit Advice)
4. Choose the 'Parameters' button
5. Add a Parameter named: remove_act
Value set: 30 characters

Default Type: Constant
Default Value: REMOVE_ACT=N
If the parameter REMOVE_ACT is there, change REMOVE_ACT=Y to N, and

make sure the enabled box is checked.
6. Save.
7. Run the report/process again.
Adding the REMOVE_ACT parameter will leave the payroll action in place for
the report/process which can then be queried into pay_assignment_actions.

After running the report, please remove the parameter you just added or set it
back to 'Y', to disable it if it was already set.
8. Resp: US HRMS Manager

9. Nav: View => Payroll Process Results
10.Query payroll processes for the appropriate payroll and time period and
look for the payroll action that the process created. This process will be labeled
as: Magnetic report.
You can obtain the payroll_action_id by choosing
Help->Diagnostics->Examine
from the top menu bar on the
View->Payroll Processes window.
In Unix view the package.procedure that you are troubleshooting and use the
payroll action id and the assignment action id to help determine where your
problem could be.
11.Execute the following 2 queries:
a. select payroll_action_id
from pay_payroll_actions
where request_id = ;
b. select Assignment_action_id, action_status

from Pay_assignment_actions
where Payroll_action_id =
and action_status <> 'C';
Values
Y or N
Default Value
Processes Used In
Retro notification rpt

Rollback
Modules Used In
PACKAGES REPORTS
PAY_RETRO_NOTIF_PKG (payretno.pkb) PAYRPPST

py_rollback_pkg (pyrolbak.pkb) PAYUSNEG
pay_core_xdo_utils (paycorexdoutil.pkb) PAYUSUNB
pay_archive (pyarchiv.pkb) PAYACTHD
pay_batch_link_process_pkg (pybatlnk.pkb) PAYUSACT
PAY_CC_PROCESS_UTILS (pyccutl.pkb) PAYREGW2
pay_generic_upgrade (pycogus.pkb) PAYRPREG
pay_payroll_contact_pkg (pycoprco.pkb) PAYRP99R
pay_run_balance_build (pycorubl.pkb) PYUSW2ER
RESET_PTO_ACCRUALS
This parameter determines whether the PTO accruals for an assignment should
be recalculated from the beginning..
Description
The following seeded PTO Fast Formulas have been modified to include this
parameter:
PTO_PAYROLL_BALANCE_CALCULATION
PTO_HD_ANNIVERSARY_BALANCE
PTO_SIMPLE_BALANCE_MULTIPLIER
The Reset_PTO_Accruals function has been created and it returns "TRUE”

whenever this parameter has been set to `Y? ("FALSE" otherwise).
HRGLOBAL v115.446 or later delivered this new parameter for the table .
The stored PTO balance can be re-calculated by enabling the action parameter
that is detected by the PTO Fast formulas.
To enable this parameter, do the following:
Using US Super HRMS Manager:

1. Navigate to Processes and Reports.
2. Open "Maintain Process Parameters" form.
3. Add new parameter: Reset PTO Accruals and set value to 'Y'.
Notice that once this is set to 'Y', all assignments with PTO elements included
in a payroll run will detect this setting. This will slow your payroll run, so if
possible use an assignment set to re-calculate balances only for those affected
assignments and then reset the parameter to 'N' afterwards.
Values
'Y': Indicates the PTO accruals will be recalculated from the beginning of the
year for all assignments included in the payroll run.
'N': PTO accruals are not re-calculated. Application will behave as normal.
Default Value

RETRO_POP_COST_KEYFLEX
Retropay by element populate cost keyflex_id from original
Description
When this pay_action_parameter is set the Retropay by Element process will

populate retro elements with the cost_allocation_keyflex_id of the elements
they were derived from.
If the RETRO_POP_COST_KEYFLEX pay_action_parameter is set to Y the

retro element will be stamped with the cost_allocation_keyflex that is on the
originating element entry.
Values
Y or N
Default Value
N
REV_LAT_BAL
Reversals maintain latest balances
Description
If you set the REV_LAT_BAL parameter to Y, you can maintain the latest
balances for each reversal that you run. By default, the Reversal process always
removes latest balances. This parameter enables you to maintain the latest
balances and reduce your processing time.
However, be aware that maintaining latest balances also introduces a

performance overhead. The relative advantage of maintaining latest balances
depends on the number and frequency of reversals that you normally run.
Values
Y or N
Default Value
Modules Used In
PACKAGES
Hrassact (pyassact.pkb)
pay_balance_pkg (pybaluex.pkb)

RR_BUFFER_SIZE
Run result buffer size for the payroll run
Description
Size of the Run Result buffer used for array inserts and updates: one row per
Run Result
BAL BUFFER SIZE

EE BUFFER SIZE
RRV BUFFER SIZE
RR BUFFER SIZE
The above four parameters affects array fetch processing within the Payroll
run. If trace files show differences between execute and fetch timings, then
worth having a look at buffer sizes. Try setting each of these to 100.
Values
1 or more
Default Value
20
Maximum Value
1000
Parameter Type
Processes Used In
Advance Pay
Payroll Run Process
Quick Pay Process
RetroPay Process
RRV_BUFFER_SIZE
Run value buffer size for the payroll run
Description
Size of the Run Result buffer used for array inserts and updates: one row per
Run Result
BAL BUFFER SIZE

EE BUFFER SIZE
RRV BUFFER SIZE
RR BUFFER SIZE
The above four parameters affects array fetch processing within the Payroll
run. If trace files show differences between execute and fetch timings, then
worth having a look at buffer sizes. Try setting each of these to 100.
Values
1 or more
Default Value
30
Maximum Value
1000
Parameter Type
Processes Used In
Advance Pay
Payroll Run Process
Quick Pay Process
RetroPay Process
RUN_XDO
Run XML Publisher for Report Generation
Description
Use concurrent request to print files
This parameter was introduced to support the US and Canadian PDF Report
Enhancements
These reports have been enhanced to use the multi threaded capabilities of
Payroll engine (PYUGEN) and integrate with XML Publisher to generate PDF
output. Once the user submits the above concurrent program, the program will
automatically spawn the following -
sub requests "Generate Payroll XDO Reports" to merge the XML data with the
template to generate the PDF
sub requests "Sub Request: (PDF Document Stream Printing)" to print the
output. The output of this request will have the actual PDF.

Set the following in PAY_ACTION_PARAMETERS after applying the patch
Row 1 >
- Parameter Name: RUN_XDO
Row 2 >
- Parameter Name: PRINT_FILES
The sub requests "Generate Payroll XDO Reports" spawned by the programs to
merge the XML data and template to generate PDF output requires the
following parameters to be defined in the XDO configuration file.
system-temp-dir: Use this parameter to register the system temporary

directory with XDO. This directory is used to create temporary files during the
execution.
printer_name.pdf-stream-divider-max-output-size: Use this parameter to

specify the maximum size file that can be printed on the printer. The size
should be specified in bytes. The default size is 1,048,576 bytes (1 Mega Byte
(MB)). Replace 'printer_name' with the name your printer is
registered with the application.
The XDO configuration file is called xdo.cfg and is located in the

$XDO_TOP/resource directory. You can edit the existing file. If the filedoes
not exist, you can create a new one. The entries in the xdo.cfg file are in the
following format.
<config version="1.0.0" xmlns="http://xmlns.oracle.com/oxp/config/">

<properties> <property name="system-temp-
dir">temporary_directory</property>
<property name="printer_name.pdf-stream-divider-max-output-
size">file_size_in_bytes
</property> </config>
Users should be able to view the output sent to the printer by looking at the
concurrent request called "Sub Request: (PDF Document Stream Printing)"
Navigation: View => Requests => Find => View Output.
The complete XML generated for a report can be viewed from view Output
button of main request i.e. "Employee W-2 PDF", "RL1 PDF" or "RL2 PDF"
The main concurrent program, Employee W-2 PDF, RL1 PDF or RL2 PDF
will complete with a status of "Warning" (if copies is set to 1 or more).
Users can ignore this warning.
Please note, last employee will be printed twice if the copies is set
to 1 or more.
Values
Y or N

Modules Used In
PACKAGES REPORTS
pay_core_xdo_utils (paycorexdoutil.pkb) Employee W-2 PDF

RL1 PDF Report
RL2 PDF Report
SET_DATE_EARNED
Set date earned on child processes
Description
Setting the SET_DATE_EARNED parameter to ‘Y’ ensures that any existing

payroll actions, whose date earned is NULL, is updated with the with an
appropriate date_earned value. In addition, it will also ensure the setting of
the date_earned value for any new processing.
In addition, unless the pay_action_parameter is set to Y - the date_earned

column is NOT populated in
any of the interlocking processes (eg Prepayments, Costing, Transfer to GL,
etc).
Values
Y or N
Processes Used In
Rollback
STD_FILE_NAME
Use standard payroll file naming convention
Description
This parameter allows for the ability to change the standard file name for the
Check Writer output
Values
Y If standard file names are required, i.e. want output files to be in the format
p<request_id>.<extension>
N If file names do not need to be standard, i.e. file names can be in the format

<requestor>.<request_id>
Default Value
N (if not overridden by legislative rule)
SUPPRESS_INSIG_INDIRECT
Suppress creation of insignificant indirect run results
Description
If the pay_action_parameter called 'SUPPRESS_INSIG_INDIRECTS' is set to

'Y', the payroll run will not create a run result for an indirect elements
entry and its run result values if the run result values are deemed to be
'insignificant' (e.g. all null or zero). Whereas the elements with direct results
are not suppressed irrespective of their values.
Definitions:
Indirect Run Result - Indirect Run Results are not directly related to an
Element Entry as found on the Element Entry screen but are created as result of
the direct element. For example, Bonus is a direct element and Bonus Special
Features is an indirect element.
Insignificant - run results or run result values which are null, a

number/money with a value 0 or 0.0, or it is a 'jurisdiction_code' result value.
The 'jursidiction_code' result value is a special case in that the run result can be
treated as insignificant if the only run result value that isn't insignificant is the
jurisdiction_code result value.
There is a corresponding legislation rule (SUPPRESS_INSIG_INDIRECTS) that

if set will override this action parameter.
Values
Y or N
Modules Used In
PACKAGE
pay_legislation_rules_pkg (pylegrul.pkb)

TAX_CACHE_SIZE
Quantum cache size
Values
0 or More
Default Value
Parameter Type
Quantum
TAX_CHECK_OVERRIDE
Quantum override version checking
Values
Y or N
Default Value
Parameter Type
Quantum
TAX_DATA
Quantum Storage location of taxation files
Values
Environment Specific
Parameter Type
Quantum

TAX_DEBUG_FLAG
Quantum switch debugging on
Values
Y or N
Default Value
Parameter Type
Quantum
TAX_LIBRARIES
Quantum override location of tax libraries
Values
Environment Specific
Default Value
$PAY_TOP/vendor/quantum/lib
Parameter Type
Quantum
TGL_DATE_USED
Transfer to GL Process transfer on date earned
Description
If you want to set the accounting date for the transfer to date earned, then
change the TGL_DATE_USED pay action parameter to "E".
If you do not do this then the accounting date of the transfer defaults to the
check/cheque date of the originating payroll
Due to the fact that employees need to have distributed labor costs as per the
time period derived from date earned , instead of the time period that payroll
populates in payroll tables. Utilizing the parameter TGL_DATE_USED set to
the value of ‘E’, will send transactions to GL based on date earned (when
switch is enabled), Labor Distribution will also pick up only on the basis of
date earned. The get_payroll_assig actions was modified to pick on the basis of
date earned for regular run, quick pay and reversals.
Not Set - Normal costing will be transferred with an Accounting Date of the
payroll run's effective date. Reversal of Estimate Costing will be transferred
with an Accounting Date of the payroll periods Pay Advice Date + Payroll
Offset Days.
'E' - Normal costing will be transferred with an Accounting Date of the payroll
run's Date Earned. Reversal of Estimate Costing will be transferred with
an Accounting Date of the payroll period's end date.
'EVE' - Normal costing will be transferred with an Accounting Date of the

payroll run's effective date. Reversal of Estimate Costing will be transferred
with an Accounting Date of the payroll period's end date.
Values
Null, E or EVE
Default Value
Null
Parameter Type
Costing
Processes Used In
TRANSFER TO GL
Modules Used In
PACKAGES
PAY_TRGL_PKG (pytrangl.pkb)
TGL_GROUP_ID
Populate group_id in gl_interface
Description
If the TGL_GROUP_ID Pay_Action_Parameter is defined with a value of 'Y',

then the Transfer to GL process will populate the GROUP_ID column of
GL_INTERFACE with the
PAYROLL_ACTION_ID of the “Transfer to GL” process being executed

Please be aware before setting this parameter to TO 'Y' that if a GL Import
process is executed using a NULL GROUP_ID, it will not pick up any entries
that have a NON_NULL group_id . Conversely , executing a GL_IMPORT
process with a NON-NULL group_id will resilt in it picking up anu entries
with a NULL Group_id
Thus great care must be taken in deciding whether setting this parameter is
compatible with all parts of the business process.
.
Parameter Type
Costing
Processes Used In
TRANSFER TO GL
Modules Used In
PACKAGES
TGL_REVB_ACCT_DATE
Accounting Date for reversals and balance adjustments
Description
By default costs are transferred with an ACCOUNTING_DATE equal to the

EFFECTIVE_DATE for Reversals and Balance Adjustment
If the PAY_ACTION_PARAMETER named TGL_REVB_ACC_DATE is set to

C, costs derived from Balance Adjustments and Reversals will transfer with an
ACCOUNTING_DATE equal to the EFFECTIVE_DATE of the Costing process.
The REFERENCE24 column of the GL_INTERFACE table will be populated
with the DATE_EARNED of the Reversal / Balance Adjustment being
transferred. You should be date tracked to a date within an open GL period
when using this parameter and running costing for Reversals and/or Balance
Adjustments.
NOTE: The records that have already run through a costing process will have
an internal check mark. If a costed record is reversed and the reversal needs to
be costed, Costing will only pick up the records that do not have the internal
check mark. Reversals are costed based on the effective date you did the
reversal (i.e. your date track setting); when submitting the costing process for
the reversed records the dates are based on the effective dates used. Therefore
the start and end data parameters must encompass the effective date of the
reversal..

Values
C or P
Default Value
Parameter Type
Costing
Processes Used In
TRANSFER TO GL
Modules Used In
PACKAGES
THREADS
Number of slave processes system uses
Description
Oracle Payroll is designed to take advantage of multiprocessor machines. This

means that you can improve performance of your batch processes by splitting
the processing into a number of ‘threads’. These threads, or sub–processes will
run in parallel.
When you submit a batch process to a concurrent manager the THREADS

parameter will determine the total number of sub–processes that will run
under the concurrent manager. The master process will submit (THREADS – 1)
sub–processes. Set this parameter to the value that provides optimal
performance on your server. The default value, 1, is set for a single processor
machine. On multiprocessor machines set THREADS to be less than or equal to
the number of processors available.
Attention: The concurrent manager must be defined to allow the specified

number of sub–processes to run concurrently.
Values
1 or more
Default Value

Processes Used In
Advance Pay Payroll Run Process

Cash Process Payroll Run Rollback
Check Writer (US / UK) Premium Calculation Process
Costing PrePayments
Data Pump Quick Pay PrePayments
Deposit Advice RetroPay Process
Magnetic Tape Security List Maintenance
Multi-Threaded Archiver System Extract Process
Participation Process: Selection System Extract Restart Process
Participation Process: Scheduled Transfer to GL
Participation Process: Temporal

Modules Used In
REPORTS
PAYCAREG.rdf PAYUSOLS.rdf
PAYRPRNP.rdf PAYUSREG.rdf
PAYUSACT.rdf PAYUSUNB.rdf
TRACE
Switch database tracing on
Description
The SQL trace facility provides you with performance information on

individual SQL statements. You can enable the trace facility for either a session
or an instance. For each SQL statement traced, the following performance
information is generated:
• SQL statement text

• Parse, Execute and Fetch count, CPU/elapsed times, physical/logical reads
and rows processed
• The optimized goal
• Misses in the library cache during parse
• The Explain Plan at time of SQL execution (Oracle 8.1.6+)
• User for which the parse occurred
• Recursive SQL depth
When you enable the trace facility, the performance information for executed
SQL statements is written out to a trace file until the SQL trace facility is
disabled.
Set this parameter to ’Y’ to enable the database trace facility. Oracle trace files
will be generated and saved in the standard output directory for your
platform. Trace only applies to application C processes. The following
processes aren’t covered by this parameter:
• Reversals
• Balance Adjustments
• External / Manual Payments
• Payroll Rollback via Form
• Mark For Retry
Warning: Only use the trace facility to help with the investigation of problems.
Setting the value to ‘Y’ will cause a significant deterioration in database
performance. If you experience a significant problem with the performance of
your payroll processes, you should always check that you have reset this
parameter to the default value – ’N’.
Values
Y or N

Default Value
Modules Used In
REPORTS
PAYACPRE.rdf PAYRPERL.rdf PAYUSTIP.rdf

PAYACPRS.rdf PAYRPFAR.rdf PAYUSTOT.rdf
PAYACTPP.rdf PAYRPGTN.rdf PAYUSUNB.rdf
PAYACVPR.rdf PAYRPHTS.rdf PAYUSW2C.rdf
PAYCABPS.rdf PAYRPTMD.rdf PAYUSW2E.rdf
PAYCADED.rdf PAYRPVPR.rdf PAYUSYNG.rdf
PAYCAREG.rdf PAYUS2EE.rdf PYCACHDA.rdf
PAYCARGT.rdf PAYUS2ER.rdf PYCACHDP.rdf
PAYCASDR.rdf PAYUS940.rdf PYCAPVFT.rdf
PAYFRABS.rdf PAYUS941.rdf PYCARL1P.rdf
PAYGBGTN.rdf PAYUS99R.rdf PYCARL2P.rdf
PAYGBP35.rdf PAYUSACT.rdf PYCARL2R.rdf
PAYGBP60.rdf PAYUSCDA.rdf PYCARL2T.rdf
PAYGBP6L.rdf PAYUSCHK.rdf PYCARLRG.rdf
PAYGBP6L.rdf PAYUSDED.rdf PYCARLTO.rdf
PAYGBP6P.rdf PAYUSEW2.rdf PYCAROEP.rdf
PAYGBSOE.rdf (CO) PAYUSFTR.rdf PYCAT4AP.rdf
PAYGBTPL.rdf (CO) PAYUSGTN.rdf PYCAT4AT.rdf
PAYIESOE.rdf PAYUSLTR.rdf PYCAT4PR.rdf
PAYIEVPR.rdf PAYUSNAC.rdf PYCAT4RG.rdf
PAYJPITW.rdf PAYUSOLS.rdf PYCAT4TO.rdf
PAYMXCHQ.rdf PAYUSPAT.rdf PYCATPCH.rdf
PAYRPAMP.rdf PAYUSPRT.rdf PYCAWCBS.rdf
PAYRPANP.rdf PAYUSPST.rdf PYUSEOS2.rdf
PAYRPCSR.rdf PAYUSREG.rdf PYZARPCO.rdf
PAYRPDTR.rdf PAYUSRRS.rdf PYZARPTR.rdf
PAYRPEMV.rdf PAYUSRW2.rdf PYZASOE.rdf
PAYRPENP.rdf PAYUSTIM.rdf
TRACE_LEVEL
Sets the level of the Database Trace
Description
This parameter sets the level of db trace information generated if tracing has
been enabled for the process.
• Level 1 is the default. This level traces all activities until the trace session is
stopped.
• Level 4 provides level 1 tracing and displays the entered value for all bind
variables. Bind variables are the values that the user enters. The code
displays these bind variables as: b1, etc. When level 4 is activated, the
substituted value for the bind variable is displayed in the trace file.
• Level 8 provides level 1 tracing and displays a list of all database wait
events. Database wait events list the reasons if the elapsed time is greater
than the CPU time in the tkprof report.
• Level 12 provides level 1 tracing in addition to both bind variable
substitution and database wait events.
Values
1, 4, 8, 12
Default Value
NULL
TRANSGL_TRACE
Switch for Multi-Threaded TGL version
Description
For processing large volumes of balance adjustments in particular (due to the

number of payroll actions involved) it is recommend switching to the
multithreaded version of Transfer to GL. This can be done by enable the
multithreaded processing, by setting the parameter TRANSGL_THREAD to ‘Y’
Values
Y or N
Default Value
Processes Used In
Rollback
Modules Used In
PACKAGES
TR_BUFFER_SIZE

Taxability rules buffer size for payroll run
Description
Size of the buffer used in array selects from the PAY_TAXABILITY_RULES

table within the Run process.
The parameter TR_BUFFER_SIZE is used within the Payroll run when fetching
rows form the PAY_TAXABILITY_RULES table. The rows from this table are
fecthed in 'chunks' - using an 'array fetch'. The number of rows
fetched in each chunk is the value of this action parameter.
TR_BUFFER_SIZE defaults to 500. But this parameter can be increased. It is up

to customer to tune the performance of the Application by setting this (and the
other BUFFER SIZE action parameters) to optimum values for their systems
Values
100 or above
Default Value
500
Parameter Type
US_ADVANCE_WAGE_ATTACHMENT
Advance US wage attachment functionality enabled
Description
This parameter controls whether Advanced Wage Attachment functionality

has been enabled.
Setting the parameter to 'No' in PAY_ACTION_PARAMETERS disables the

"advanced wage attachment" functionality and allows the creation of a wage
attachment element in the old style using the Deductions window (template).
After application of the Family Pack, this parameter, although not explicitly
set, defaults to 'Yes' and all NEW wage attachment elements are created using
the new architecture. The setting of this parameter does not impact previously
created involuntary deductions (i.e. those created prior to application of the
family pack).
Development strongly encourages clients to use the new architecture.

However, if there is no pressing need to use the new architecture, you can
continue using the current wage attachment element entries. Leaving the
parameter set to 'No', the new functionality and bug fixes included in Family
Pack H (and pending future bug fixes) are not available. If this meets your

need, set this parameter appropriately and migrate to new involuntary
deductions at a later time.
Values
Y or N
Modules Used In
PACKAGES
pay_us_dedn_template_wrapper (pytmpdde.pkb)
pay_us_garn_upgrade (pyusgrup.pkb)
US_SOE_VIEW_FROM_ASG_FP_SCREEN
Switch for US SOE
Description
This parameter is used for US SOE when viewing it from the Assignment
Form. The parameter, tells the SOE to get the max PrePayment action (action
type P and U) and display the pre-payment details instead of Run, Quickpay
or Reversal information. The navigation of the previous and next button will
also show only the prepayment SOE.
.
Usage - The most common reason this parameter is used is if the client wants
to see the PrePayment SOE instead of Run SOEs. This new parameter will not
be added to the lookup as there are only few clients who have asked for it. It
also will impact Fast path.
Values
PREPAY - get max prepayment SOE as of the effective date
Null or any other value - default feature i.e. gets the max of Run, Quickpay
and Reversal. Previous and Next button then display the R, Q or V actions.
Default Value
NULL
Modules Used In
FORMS
PAYUSSOE.fmb

USER_MESSAGING
Switch user messaging on
Description
Set this to parameter to 'Y' to enable detailed logging of user readable

information to the pay_message_lines table. This information includes details
about the elements and overrides that are processed during the Payroll Run.
Note: This information is useful when you are investigating problems, but you
may find that it is too detailed for normal working
Values
Y or N
Default Value

APPENDIX A
Pay_Action_Parameters that are no being longer used or there is currently no detailed documentation
available.
HR_DM_DEBUG_PIPE
Data Migrator Debug Level for Pipe Output
Description
NO LONGER USED
HR_DU_DEBUG_LOG
Data Uploader Debug Level for Logfile Output
Description
NO LONGER USED
HR_DU_DEBUG_PIPE
Data Uploader Debug Level for Pipe Output
Description
NO LONGER USED
MESSAGE_NAMES
Switch to only output message names instead of text
OLD_LOW_VOLUME
Save for rule hint
Modules Used In
SCRIPT
Script to set Low_Volume (pyinslv.sql)

Script to set Low_Volume (pyrtlv.sql)

PDF_TEMP_DIR
Temporary Directory for PDF Merging
PLSQL_PROC_INSERT
Enable/disable PL/SQL based range processing code
Values
Y or N
Modules Used In
PACKAGE
hr_nonrun_asact (pynonrun.pkb)
PRINTER_MEM_SIZE
Override printer memory size in Kbytes
REPORT_URL
URL location where payroll process report output files will be written.
Description
Set up a pay_action_parameter parameter REPORT_URL with value of the

URL for concurrent output files
RETRO_DELETE
Retropay process updates run results
Description
If this parameter is set the retropay process updates run results to a status of B
rather than deleting them. This is to improve performance of the process.
No longer used – replaced with a legislation rule.
RETRO_RECALC_ALL_COMP
Description

TGL_SLA_MODE
Switch for use of sub ledger accounting
Parameter Type
Costing
Processes Used In
TRANSFER TO GL
US_ADVANCE_EARNINGS_TEMPLATE
Switch for US earning element template
Values
Y or N
UTF8_RESTRICTION_MODE
UTF8 Restriction Mode
Values
BYTE or CHAR
Default Value
BYTE


Pay Action Parameters PDF

Uploaded by

Copyright:

Available Formats

Pay Action Parameters PDF

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Pay Action Parameters PDF

Uploaded by

Copyright:

Available Formats

Oracle HCM

Copyright (C) 2007 Oracle Corporation All Rights Reserved

NOTE: The contents of this document are deemed to be correct

Oracle HCM Pay_Action_Parameter Page 1 of 74 Oracle / Client Confidential

PAY ACTION PARAMETERS .................................................................................... 6

PAY ACTION PARAMETER VALUES ................................................................ 6

SUMMARY OF THE ACTION PARAMETERS ............................................ 7

OVERVIEW OF THE ACTION PARAMETERS.......................................... 11

Oracle HCM Pay_Action_Parameter Page 2 of 74 Oracle / Client Confidential

Oracle HCM Pay_Action_Parameter Page 4 of 74 Oracle / Client Confidential

This document is a gathering point of multiple pieces of information regarding

Oracle HCM Pay_Action_Parameter Page 5 of 74 Oracle / Client Confidential

Payroll action parameters, which are stored on the Pay_Action_Parameter

By using Pay_Action_Parameter_Groups, a specific pay action parameter can

Pay Action Parameter Values

The PAY_ACTION_PARAMETERS view contains the columns:

The values stored in the pay_action_parameter_values table with a null

Oracle HCM Pay_Action_Parameter Page 6 of 74 Oracle / Client Confidential

Oracle HCM Pay_Action_Parameter Page 7 of 74 Oracle / Client Confidential

Oracle HCM Pay_Action_Parameter Page 8 of 74 Oracle / Client Confidential

Maximum number of assignment actions

Oracle HCM Pay_Action_Parameter Page 9 of 74 Oracle / Client Confidential

Set date earned on child processes Y or N N

TAX_CACHE_SIZE Quantum cache size 0 or more 0

TAX_CHECK_OVERRIDE Quantum override version checking Y or N N

Oracle HCM Pay_Action_Parameter Page 10 of 74 Oracle / Client Confidential

The following is a comprehensive overview of the action parameter, including

The maximum number of additional audit or report files the

Return to Pay_Action_Parameters Summary

Oracle HCM Pay_Action_Parameter Page 11 of 74 Oracle / Client Confidential

This is recommended only if there are no pending advances to be processed.

Return to Pay_Action_Parameters Summary

Array, Select, Update, and Insert Buffer Size

Advance Pay RetroPay Process

Oracle HCM Pay_Action_Parameter Page 13 of 74 Oracle / Client Confidential

Return to Pay_Action_Parameters Summary

Hence we do recommend customers not to submit multiple batches with

Return to Pay_Action_Parameters Summary

Oracle HCM Pay_Action_Parameter Page 14 of 74 Oracle / Client Confidential

Hence we do recommend customers not to submit multiple batches with

Return to Pay_Action_Parameters Summary

Oracle HCM Pay_Action_Parameter Page 15 of 74 Oracle / Client Confidential

Return to Pay_Action_Parameters Summary

Poor performance can be experienced when creating a new balance feed. A

Oracle HCM Pay_Action_Parameter Page 16 of 74 Oracle / Client Confidential

Return to Pay_Action_Parameters Summary

Randomizes the order in which the chunks are processed ( to minimize

Advance Pay Payroll Run Rollback

Return to Pay_Action_Parameters Summary

Oracle HCM Pay_Action_Parameter Page 17 of 74 Oracle / Client Confidential

Each thread processes one chunk at a time.

Array, Select, Update, and Insert Buffer Size

Advance Pay Participation Process: Temporal

Oracle HCM Pay_Action_Parameter Page 18 of 74 Oracle / Client Confidential

Return to Pay_Action_Parameters Summary

Addresses memory issue inside costing code specific to assignment level

Return to Pay_Action_Parameters Summary

Oracle HCM Pay_Action_Parameter Page 19 of 74 Oracle / Client Confidential

If the COST_API_IMODE pay_action_parameter is set to 'Y', the costing code