Search Results pqh_documents_wrapper




Overview
Explore in AI Chat

Overview

PQH_DOCUMENTS_WRAPPER is an Oracle E-Business Suite PL/SQL package owned by the APPS schema and classified under the ETRM API classification "OTHER." It functions as a self-service wrapper layer over the core documents API, PQH_DOCUMENTS_API. Its declared purpose is to expose the underlying delete_document operation in a form suitable for self-service invocation, deriving all IN parameters appropriately before delegating to the base API. The package is declared AUTHID CURRENT_USER, meaning its unqualified database object references are resolved in the schema of the calling user rather than the definer, a standard pattern for wrapper packages that rely on APPS synonyms being visible to the session.

The package body is documented as Internal Development use only, indicating it is not intended as a public integration surface. Its single documented responsibility is the deletion of a document master record together with all of its dependent child records, with effective-dating behavior supplied through the underlying date-tracked API.

Key Procedures and Functions

The package exposes one documented procedure, DELETE_DOCUMENT. It is the self-service wrapper counterpart to pqh_documents_api.delete_document, and its stated contract is to delete all child records of a document before removing the master record. Because deletion is performed through the date-tracked API, the procedure supports validation-only execution, effective date control, and date-track mode selection, and it returns the resulting effective start and end dates along with an object version number for optimistic locking.

Status reporting follows the standard EBS API convention: on success, the return status output conveys a success value; on failure, it conveys a failure value. Callers are expected to inspect the return status rather than rely on exceptions for ordinary error conditions. All IN parameters must have been derived appropriately before invocation, which is consistent with the wrapper's role of shielding self-service callers from the parameter preparation performed by the base API.

Tables Accessed

The package operates against two documented tables, reached through APPS synonyms: PQH_DOCUMENTS_F and PQH_DOCUMENT_ATTRIBUTES_F. PQH_DOCUMENTS_F holds the master document rows, while PQH_DOCUMENT_ATTRIBUTES_F holds the associated attribute rows that constitute the child records referenced in the procedure's documented behavior. The deletion sequence — children first, then master — reflects the referential dependency between these two tables and avoids orphaned attribute rows. Both are date-tracked ("_F") entities, which explains the procedure's effective date, date-track mode, and effective start/end date parameters.

Usage Notes

Typical invocation is from self-service flows where an end user removes a document, with the wrapper absorbing parameter derivation before calling the core API. It may also be called from concurrent programs or custom PL/SQL that needs the same self-service semantics. Because the package is marked Internal Development use only, direct calls from custom code should be treated as unsupported and subject to change between releases; where possible, callers should confirm supported alternatives before depending on this interface. Callers must supply a valid date-track mode, an effective date, and the document identifier and object version number, and must handle the returned status, effective dates, and updated object version number. Testing with validation enabled prior to committing a destructive delete is advisable, given that the operation removes child records irreversibly. The package is referenced by zero other packages in the documented metadata, confirming that it is a terminal wrapper rather than a shared utility.