Search Results update_worksheet

Overview

APPS.PQH_WORKSHEETS_API is the public PL/SQL API for the Oracle EBS Human Resources (HR) Budgeting and Worksheet functionality delivered by the Public Sector / HRMS module family. A worksheet represents a working container within a budget that groups compensation and position-related changes for review, approval, and eventual propagation to the underlying budget. The package encapsulates the transactional logic required to create, modify, and remove worksheet records in a controlled and consistent manner, insulating callers from the physical structure of the underlying table.

The package is classified in the ETRM metadata as a standard API and is owned by APPS. It functions as the supported programmatic interface to the PQH_WORKSHEETS table, exposing three documented entry points: CREATE_WORKSHEET, UPDATE_WORKSHEET, and DELETE_WORKSHEET. Consistent with Oracle's HRMS API architecture, each procedure supports a validation-only mode, maintains the object version number for optimistic locking, and delegates extensibility to a corresponding business-event (BK) hook package.

Key Procedures and Functions

The documented procedures in this package are:

• CREATE_WORKSHEET — Inserts a new worksheet row into PQH_WORKSHEETS. The procedure accepts worksheet identity and budget-relationship information, worksheet naming and version details, action and effective dating, worksheet mode, transaction status, propagation method, and workflow transaction category. It returns the newly generated worksheet identifier and object version number to the caller. As shown in the ETRM excerpt, the procedure opens with an HR utility location marker, issues a savepoint when running in validation-only mode, and invokes the before-hook pqh_WORKSHEETS_bk1.create_WORKSHEET_b prior to executing core processing.
• UPDATE_WORKSHEET — Modifies an existing worksheet record. It is the routine most directly associated with the user search term "update_worksheet" and is the supported mechanism for changing worksheet attributes such as name, status, effective dates, transaction status, or propagation method. Like the create routine, it supports validation-only execution and is designed to maintain object version consistency.
• DELETE_WORKSHEET — Removes a worksheet row from PQH_WORKSHEETS, subject to the business rules enforced within the API.

Each procedure follows the same internal pattern: entry point logging, savepoint establishment for validation mode, invocation of the corresponding before/after hook in the PQH_WORKSHEETS_BK1 package, core DML against the worksheet table, and standard error propagation via HR_UTILITY.

Tables Accessed

The package operates against a single documented table, referenced through an APPS synonym:

• PQH_WORKSHEETS — The base table storing worksheet records. It is the target of the INSERT, UPDATE, and DELETE operations performed by CREATE_WORKSHEET, UPDATE_WORKSHEET, and DELETE_WORKSHEET respectively. Key columns include WORKSHEET_ID and OBJECT_VERSION_NUMBER, both of which are surfaced as OUT parameters by the create routine and used internally for row identification and locking.

No other tables are documented as directly referenced by this package.

Usage Notes

PQH_WORKSHEETS_API is intended for programmatic invocation in the same manner as other Oracle HRMS public APIs. It is normally called directly from forms, from other PL/SQL packages, or from custom code rather than being exposed through a concurrent program wrapper. The ETRM metadata records that the package is referenced by two other packages, indicating that it forms a supporting layer beneath higher-level budget and worksheet processing logic.

Developers invoking UPDATE_WORKSHEET and its sibling routines should observe the following conventions: pass p_validate => TRUE to exercise all business rules without committing data; capture the returned object version number and supply it on subsequent updates to enforce optimistic locking; and be aware that the create routine's before-hook is provided as an extension point for customer-specific logic. In Oracle EBS 12.1.1 and 12.2.2 the package is functionally consistent, and any customization should be applied through the documented BK hook package rather than by modifying the API body itself.