Search Results get_upgrade_status

Overview

APPS.PAY_CHQWRT_PKG is the cheque writer SQL construction package within the Oracle Payroll and Oracle Payments cheque printing infrastructure. Its name derives from "cheque writer," and the package body header explicitly identifies it as the "Package and procedure to build sql for cheque writer." In Oracle EBS 12.1.1 and 12.2.2, this package is classified as an OTHER API under the APPS schema. It does not expose a public business API in the conventional sense; rather, it is an internal helper package whose primary role is to assemble the dynamic SQL statements used by the cheque writer concurrent process when selecting and processing payments for cheque printing.

The package has a long lineage, with version and change history dating back to 1994. The change log records tuning for performance (1996, bug 339128), corrections for duplicate assignment actions on voided payments, support for selecting voided cheques, and a rewrite to support multiple threads. Later revisions added a cheque_date function and subsequently removed it, and version 115.3 (February 2006) introduced the ability to pay organizations directly. These changes reflect the package's evolution alongside the cheque writer's threading and payment-selection logic.

Key Procedures and Functions

The ETRM metadata documents a single procedure or function: CHQSQL. Consistent with the package's stated purpose, CHQSQL builds the SQL used by the cheque writer. Its responsibility is to construct the query statements that retrieve the assignment action and related payment records in the correct order, including the subquery logic required to select voided cheques and to avoid creating duplicate actions for voided payments. Because CHQSQL is a builder routine rather than a business transaction API, it is not intended for direct invocation by external application code.

Tables Accessed

Per the documented metadata for release 12.2.2, the package references one table via APPS synonyms: PAY_UPGRADE_STATUS. This reference is consistent with the user search term "get_upgrade_status," indicating that the package interrogates the payroll upgrade status as part of its runtime behavior — most likely to guard SQL construction or execution until the appropriate upgrade state is reached. The historical change list references payment, assignment action, and voided cheque data, but those objects are not enumerated in the current ETRM table list; PAY_UPGRADE_STATUS is the sole documented table dependency.

Usage Notes

PAY_CHQWRT_PKG is invoked indirectly by the Oracle Payroll cheque writer concurrent program and its associated routines. It is not referenced by any other documented package (zero referencing packages), confirming its position as a leaf-level internal utility. Because it is classified as OTHER and exposes only the CHQSQL builder, it should not be called from custom forms, concurrent programs, or bespoke PL/SQL. Organizations customizing cheque printing should treat this package as Oracle-internal and avoid dependencies on it, since its body may change between patch levels. The presence of the PAY_UPGRADE_STATUS check also means behaviour can vary depending on the current upgrade state of the environment.