Search Results use_qpay_excl_model

Overview

PAY_QPQ_API is the Oracle E-Business Suite public API for the QuickPay process within Oracle Payroll. QuickPay allows a payroll administrator to run a payroll for one or more assignments outside of the normal payroll cycle, permitting rapid payment and validation of a small set of employees or assignments. The package encapsulates the business rules governing pre-processing checks, record creation, updates, deletions and bulk processing logic for QuickPay-driven payroll actions and their associated element entries.

The body is instrumented with the standard EBS-generated table handler conventions, including a row record type (g_rec_type), a persistent old-record buffer (g_old_rec) and a global API DML status flag (g_api_dml). These conventions indicate that PAY_QPQ_API is an auto-generated table handler for the PAY_QUICKPAY_EXCLUSIONS entity, extended with additional QuickPay-specific business procedures. The API is classified as an API in the ETRM metadata and is referenced by five other packages, confirming its role as a shared service layer in the payroll stack.

Key Procedures and Functions

• USE_QPAY_EXCL_MODEL — Determines whether the new QuickPay Exclusions data model is in use. Introduced via Enhancement 3368211, the function delegates to PAY_CORE_UTILS.GET_UPGRADE_STATUS using the short name QPAY_EXCL_TABLE, returning the current status. It raises the qpay_upgrade_in_progress exception (error number -20001) with message PAY_33880_QPAY_UPG_IN_PROGRESS when an upgrade is in flight.
• CHK_ASG_ON_PAYROLL — Validates that the assignment referenced in the QuickPay request is currently on the specified payroll.
• CHK_NEW_EFF_DATE / CHK_EFF_DATE — Validate effective date ranges for the QuickPay transaction, ensuring dates fall within the assignment's payroll period and legislative constraints.
• CHK_DATE_EARNED — Confirms that the date earned supplied matches the payroll period and element configuration.
• CHK_FOR_CON_REQUEST — Detects whether a concurrent request is already processing the same QuickPay action, preventing duplicate submissions.
• RETURN_API_DML_STATUS — Returns the boolean value of g_api_dml, indicating whether the most recent API call performed DML.
• LCK — Locks the target PAY_QUICKPAY_EXCLUSIONS row using the standard select-for-update pattern prior to modification.
• INS / UPD / DEL — Perform the insert, update and delete operations on the QuickPay Exclusions record, respecting the old-record buffer for optimistic concurrency.
• DEFAULT_VALUES — Populates default column values before insert, drawing from payroll and element definitions.
• START_QUICKPAY_PROCESS / WAIT_QUICKPAY_PROCESS — Submit the QuickPay process (typically a concurrent request) and then wait for its completion, enabling synchronous API invocation from forms or custom code.

Additional internal procedures bring the documented total to seventeen, including the control_separate_check_entries routine, which prevents a QuickPay payroll run from combining a separately processed earnings entry with any other entry.

Tables Accessed

The package operates on the following APPS synonyms:

• PAY_QUICKPAY_EXCLUSIONS — The primary entity managed by the table handler, defining assignments excluded from QuickPay.
• PAY_ASSIGNMENT_ACTIONS, PAY_PAYROLL_ACTIONS, PAY_PAYROLL_ACTIONS_S — Drive validation and creation of the QuickPay payroll action row.
• PAY_ELEMENT_ENTRIES_F, PAY_ELEMENT_ENTRY_VALUES_F, PAY_ELEMENT_LINKS_F, PAY_ELEMENT_TYPES_F, PAY_INPUT_VALUES_F, PAY_ELEMENT_CLASSIFICATIONS — Supply the element, input value and classification context required by control_separate_check_entries and defaulting logic.
• PER_TIME_PERIODS — Used by CHK_DATE_EARNED and date validation routines.
• PAY_CONSOLIDATION_SETS, PAY_LEGISLATION_RULES, PAY_LEGISLATIVE_FIELD_INFO — Provide legislative and consolidation constraints applied during validation.
• FND_SESSIONS — Supports API DML status and session-level tracking.

Usage Notes

PAY_QPQ_API is typically invoked from the Oracle Payroll QuickPay form (payrun QuickPay window) and from custom concurrent programs or PL/SQL scripts that need to trigger QuickPay programmatically. The START_QUICKPAY_PROCESS and WAIT_QUICKPAY_PROCESS pair allows custom code to submit and synchronously wait for the QuickPay concurrent request. Because so many routines validate against payroll actions, element entries and time periods, callers must supply a valid payroll assignment, business group and effective date context. The USE_QPAY_EXCL_MODEL function should be checked first whenever custom code manipulates QuickPay Exclusions, so that behaviour is correct on both pre-upgrade and post-upgrade installations. The package is referenced by five other packages, so changes to its behaviour should be assessed for downstream impact.