Payroll Process Configuration Parameters
Payroll processing parameters are system-level parameters that control aspects of payroll-related processes, such as flows and reports.
Values for each parameter are predefined with the application, but you can override these values as part of your initial implementation and for performance tuning. Use the Payroll Process Configuration task under Show More > Payroll in My Client Groups on the Home page.
Processing Parameters
The effects of setting values for specific parameters may be system-wide. When you submit a process that uses flows, such as a batch upload, new hire, or report process, the process reads values from the PAY_ACTION_PARAMETERS table.
You should understand the concept of array processing and how this affects performance before setting some parameters.
The application doesn’t allow a blank value for any parameter. Unless the parameter is required, you must delete the parameter row.
This table describes processing parameters and lists values and predefined default values. These parameters apply to HR applications including payroll and payroll interface.
Parameter |
Description |
Values |
---|---|---|
Assignment ID to End Logging |
Assignment ID upon which logging ends. |
Default: All assignments |
Assignment ID to Start Logging |
Assignment ID upon which logging starts. |
Default: All assignments |
Balance Buffer Size |
Buffer size for array inserts and updates of latest balances, based on one row per balance. Tip:
If your trace files show differences between execute and retrieve timings, look at the buffer sizes you're using. Try setting each of these to 100. |
Maximum: 1000 Minimum: 1 Default: 500 |
Batch Error Mode |
Determines error notifications for the HCM data loads. |
ALL = all rows ANY = any rows NONE = no errors Default: ANY |
Chunk Size |
Number of payroll relationship actions that process together. See also the Parallel Processing Parameters topic. |
Maximum: 16000 Minimum: 1 Default: 20 |
Disable Locking Code in Check Process Post-Populate Method |
Disables the locking code added to the post-populate method to improve check process performance. This parameter isn't available by default. To add the parameter, search for the lookup type PAY_ACTION_PARAMETER_TYPE on the Common Lookups page and add the lookup code ORA_DISABLE_POST_POP_FIX. |
Yes, No Default: No Only change this value if advised by Oracle Support. |
Element Entry Buffer Size |
Buffer size that payroll runs use in the initial array selects of element entries, element entry values, run results, and run result values per assignment. |
Maximum: 1000 Minimum: 1 Default: 500 |
Formula Execution Logging |
Sets the logging level to investigate formula code problems. See also the Logging Processing Parameters topic. |
Unless the parameter is required, delete the parameter row. |
Historic Payment |
Removes the validation to look for banks active as of the process date. This validation is enforced by the payments process. This parameter isn't available by default. You can add it in test environments only. To add the parameter, search for the lookup type PAY_ACTION_PARAMETER_TYPE on the Common Lookups page and add the lookup code HISTORIC_PAYMENT. |
Yes, No Default: No |
Logging Area |
Area to log code. See also the Logging Processing Parameters topic. |
The values correspond to C-code entries in the form PY_ENTRY, that includes the functional area that has logging enabled. |
Logging Category |
Helps investigate problems with large volumes of detailed data. See also the Logging Processing Parameters topic. |
You can set any number of categories by specifying multiple values. For example, enter GMPE, for general logging information, routing information, performance information, and element entry information. Refer to the Logging Processing Parameters topic in the Related Links section for applicable values. Unless the parameter is required, delete the parameter row. |
Manual Task Processing |
Determines processing of manual tasks when SOA server is unavailable. |
Y, N Default: Y |
Maximum Errors Allowed |
Number of payroll relationship actions that you can roll back, when rolling back a process. |
Minimum: 0 Default: CHUNK_SIZE or 20 |
Maximum File Size for View Report Output |
Maximum size in bytes of the report file to show in the output window. This parameter isn't available by default. To add the parameter, search for the lookup type PAY_ACTION_PARAMETER_TYPE on the Common Lookups page and add the lookup code BI_OUTPUT_SIZE. |
Must be a positive number. Default: 10000000 |
Maximum Iterations Allowed per Run Action |
Maximum number of iterations allowed per run action within net-to-gross calculations within the payroll run. |
Minimum: 0 Default: 15 |
Maximum Number of Payroll Relationship Actions to Roll Back |
Number of payroll relationship actions that you can roll back, when rolling back a process. |
Minimum: 1 Default: 50 |
Multithreaded XML Generation for Extracts |
Generates XML for extracts using multiple threads. |
Y, N Default: N |
New Hire Flow Pattern |
Name of the customer-defined flow that’s triggered as part of the new hire process. |
Unless the parameter is required, delete the parameter row. |
Notifications Expiration Offset |
Number of days before a payroll flow notification is automatically deleted. |
Minimum: 5 Default: 5 |
Payroll Batch Loader Encryption Type |
The type of encryption applied to source files loaded using the HCM data loader. |
Unless the parameter is required, delete the parameter row. |
Payroll Criteria for Element Eligibility |
Enables eligibility by payroll for assignment-level elements. |
Yes, No Default: No |
Process Timeout |
Number of minutes before the Run Balance Generation process times out. |
Minimum: 0 Default: No timeouts limit enforced. Unless the parameter is specified, delete the parameter row. |
Remove Report Assignment Actions |
Removes report processing actions after generating reports. |
Yes, No Default: Yes |
Run Result Buffer Size |
Buffer size for array inserts and updates, based on 1 row for each payroll run result. |
Maximum: 1000 Minimum: 1 Default: 500 |
Shuffle Chunk Processing |
Random processing of order chunks for assignment actions. |
Yes, No Default: No |
Suppress Empty XML Tags in Extract Reports |
Reduces the size of extract output for reports by excluding tags with blank values in XML output files. |
Y, N Default: Y |
Termination Flow Pattern |
Name of the customer-defined flow that’s triggered as part of the termination process. |
Unless the parameter is required, delete the parameter row. (No predefined Termination flow pattern). |
Threads |
Total number of subprocesses that you can run from the Oracle Enterprise Scheduler Service. See also the Parallel Processing Parameters topic. |
Minimum: 1 Default: 1 |
Trace |
Enables the database trace facility for application processes written in C only. |
Yes, No Default: No |
Trace Level |
Sets the trace level of the trace event. To generate the finest level of detail, enter the highest value. |
1, 4, 8, 12 Default: None |
User Messaging |
Enables detailed logging of user-readable information to the PAY_MESSAGE_LINES table. |
Yes, No Default: No |
XML_DATA_SOURCE |
For document records delivery options performance purposes, determines if XML is derived from the database. |
Y, N Default: Y |
Payroll-Specific Processing Parameters
This table lists the processing parameters that are applicable only for Oracle Global Payroll.
Parameter |
Description |
Values |
---|---|---|
Accounting Date for Transfer to General Ledger |
The date to transfer and post journal entries for costing results to Oracle Fusion General Ledger. |
E = Date Earned P = Process Date DP = Date Paid from payroll time periods for calculate payroll and QuickPay only. EVE = For the Partial Period Accrual Reversal process, date earned is used. However, if the date earned isn't defined for the time periods on the Payroll Definition page, the payroll period end date is used. For the payroll run that includes the actual costs, the process date of the payroll run is used. Default: P |
Cost Buffer Size |
Buffer size for array insert and select statements when calculating the costing of the payroll run results. |
Maximum: 1000 Minimum: 1 Default: 500 |
Date to Retrieve Assignment Status |
Date earned or date paid, used to determine the effective date for checking assignment status in payroll calculations. |
E = Date earned P = Date paid Default: P |
Earliest Retroactive Processing Date |
Sets earliest date that retroactive processes are calculated. Updates
made before this date aren’t recalculated.
Note: If you define a static
retroactive start date and a rolling retroactive start date, the
retropay process uses the latest of the two dates. For example, if the
static retroactive start date is 01-JAN-2020 and the rolling
retroactive start date is 15-MAR-2019, the retropay process uses a
start date of 01-JAN-2020. Controls the start date of the retroactive period for the Calculate Payroll for Retroactive Changes flow (retropay) as well as for an individual employee |
Date value in |
Extract Data Group for Payroll Register |
Limits the records to include in the output file based on the specified data group name. |
Default: No data group |
Limit Payroll Register Output by Data Group |
Enables processing a subset of records to include in the output file when an extract data group parameter value is also specified. |
Y, N Default: N |
Number of months in rolling period for retroactive changes |
Sets the number of months in the retroactive pay rolling period. If you don't want to limit the duration of the retroactive pay period, change the default of 12 month rolling period to 999 months. Note: You can limit the number of payroll periods included in the
retroactive pay process by setting the earliest start date for the
process for the process for all retroactive notifications using both
the Earliest Retroactive Processing Date
parameter and this parameter. For example, you may want to set a static
start date based on your payroll go-live date and use a rolling period to
ensure retroactive pay doesn't calculate for more than a 24 month period.
Retroactive pay uses the latest of the two dates when both parameters are
set.
If you don't want to limit the duration of the retroactive pay period, change the default 12 month rolling period to 999 months. |
Default: 12 |
Reversal and Balance Adjustment Accounting Date |
Accounting date based on one of these dates:
|
T = Transfer using end date of the Transfer to Subledger Accounting task as the accounting date P = Use process date of the reversal or balance adjustment as the accounting date Default: P |
Wage Basis Rules Buffer Size |
Used in array selects from the PAY_ TAXABILITY_RULES table within the Payroll Calculation process. |
Minimum: 100 Default: 500 |