Search Results create_worksheet_detail_bp




Overview
Explore in AI Chat

Overview

The APPS.PQH_WORKSHEET_DETAILS_API package body is a public PL/SQL API within the Oracle E-Business Suite HRMS/Public Sector family, operating in the APPS schema. It exposes the business logic required to maintain worksheet detail records that belong to the Oracle Payroll/HR worksheet framework (the PQH product prefix, historically associated with budgeting and position worksheets). Worksheets in this framework hold the line-level detail that supports budget, position, and compensation planning activities, and the worksheet details represent the individual entries that are collected, validated, and subsequently applied to the underlying HR and payroll entities.

The package body is documented as VALID with an API classification of "API," indicating that it is intended for programmatic invocation rather than as an internal helper. It is a thin orchestration layer built on top of the Business Key (BK) private packages and the individual table-handler packages for insert, update, delete, and shadow operations, ensuring that row-level validation, WHO column maintenance, business-group security, and audit/shadow tracking are applied consistently regardless of the calling client.

Key Procedures and Functions

The ETRM metadata documents four procedures, all of which represent the standard transactional surface of the API:

  • CREATE_WORKSHEET_DETAIL — the primary business-facing procedure for inserting a new worksheet detail record. It accepts the descriptive attributes of the detail, performs validation, and delegates the physical insert to the appropriate table-handling package.
  • CREATE_WORKSHEET_DETAIL_BP — the "business process" variant of the create operation. The _BP suffix identifies an entry point designed for invocation from a defined business process or workflow context, allowing the surrounding process to supply additional control and error-handling semantics around the creation of the detail.
  • UPDATE_WORKSHEET_DETAIL — modifies the attributes of an existing worksheet detail row. It applies the same validation and audit rules as creation, and writes the corresponding change through the update handler and associated shadow record.
  • DELETE_WORKSHEET_DETAIL — removes a worksheet detail. The presence of a dedicated delete handler and shadow package confirms that deletes are tracked for audit and reversal purposes rather than being hard physical removals in every case.

No parameter lists are documented in the supplied metadata, and they are therefore not reproduced here. The procedures share the naming conventions, error-stack handling, and HR_API/HR_UTILITY support routines that are standard across Oracle HRMS APIs.

Tables Accessed

The package operates against two principal tables, accessed through APPS synonyms:

  • PQH_WORKSHEET_DETAILS — the master table for worksheet detail rows. This is the object that the create, update, and delete procedures persist to, via the PQH_WDT_INS, PQH_WDT_UPD, PQH_WDT_DEL, and PQH_WDT_SHD handlers.
  • PQH_WORKSHEET_PERIODS — the worksheet period definition table. It is referenced to validate and resolve the period to which a detail belongs, ensuring that a detail is created only within a valid, existing worksheet period.

Additional dependencies visible in the metadata include HR_API and HR_UTILITY (generic HRMS API and utility support), the four Business Key private packages (_BK1 through _BK3), and PQH_WKS_BUDGET, reflecting cross-validation against worksheet budget data.

Usage Notes

Because this is classified as an API, it is the supported integration point for external and custom code that must create, amend, or remove worksheet details; direct DML against PQH_WORKSHEET_DETAILS is not supported. The package is documented as referenced by four other database objects, so it is commonly called from the worksheet maintenance forms and from batch or concurrent processing that mass-populates worksheet content. The metadata states that the package is not referenced by any other database object for dependency purposes on the object graph shown, but the ETRM record indicates callers do exist among related packages.

In both Oracle EBS 12.1.1 and 12.2.2 the package body follows identical conventions; the 12.2.2 online patching architecture does not alter its callable surface, though the editioning and AD_ZD handling of the underlying objects should be respected by any wrapper that invokes it. Callers should initialize the HRMS globals (fnd_global/hr_api context) and handle the standard API error stack returned through the p_error or message-table mechanism appropriate to each procedure.