Search Results pqh_worksheets_api




Overview
Explore in AI Chat

Overview

PQH_WORKSHEETS_API is a public PL/SQL package owned by the APPS schema in Oracle E-Business Suite Release 12.1.1 and 12.2.2. It forms part of the Oracle Public Sector/HR budgeting and position management stack, delivering the standard application programming interface through which worksheet records are created, maintained, and removed. The package provides a controlled, supported entry point to the underlying PQH_WORKSHEETS table so that forms, concurrent programs, and custom extensions do not write to the base table directly. Its status is VALID in the documented metadata, and it is classified as an API object within the ETRM (E-Business Suite Technical Reference Manual). The package depends on the HR_API utility package and the SYS.STANDARD package, reflecting its reliance on HRMS standard API error handling and savepoint-based validation conventions.

Key Procedures and Functions

The documented interface exposes three procedures:

  • CREATE_WORKSHEETS / CREATE_WORKSHEET — Inserts a new worksheet row into PQH_WORKSHEETS, applying the defaulting, validation, and column-population logic required by the budgeting model.
  • UPDATE_WORKSHEET — Modifies an existing worksheet record, validating the supplied changes and recording the update through the standard HRMS API pattern.
  • DELETE_WORKSHEET — Removes a worksheet record after performing referential and business-rule checks.

Each procedure is implemented using the HR_API conventions, meaning the caller supplies a standard parameter structure and receives a success or failure outcome through the HR_API return mechanism. No parameter lists are documented in the ETRM metadata, so the exact signatures must be read from the package specification in the database or from the associated API documentation before use.

Tables Accessed

The only documented table referenced by PQH_WORKSHEETS_API is PQH_WORKSHEETS, accessed through the APPS synonym. This is the base table holding worksheet definitions used by the position budgeting and control functionality. The API reads existing rows to validate update and delete requests and writes to the table for create and update operations. Because the package is the supported maintenance path, direct DML against PQH_WORKSHEETS is discouraged; the API enforces the mandatory columns, who-columns, and effective-dating rules expected by downstream consumers.

Usage Notes

PQH_WORKSHEETS_API is referenced by two other APPS packages, PQH_BUDGET and PQH_APPLY_BUDGET, which indicates that worksheet creation and maintenance are driven indirectly by budget processing and budget application routines rather than by end users alone. In a running environment, the procedures are typically invoked from the position budgeting forms in the Public Sector/HRMS module, from concurrent programs that build or refresh budget worksheets, or from custom PL/SQL that needs to programmatically manage worksheet records during data migration or integration. Custom code should call these procedures rather than inserting into PQH_WORKSHEETS directly, and should include the standard HR_API error-handling block so that business-rule failures are surfaced correctly. Because the package is a documented, VALID API, it is supported for use in 12.1.1 and 12.2.2, though the exact parameter definitions should be confirmed against the deployed package specification, since the ETRM metadata summarises procedures without listing their arguments.