Search Results update_print_document

Overview

APPS.PQH_DOCUMENTS_API is a public API package belonging to the Oracle HRMS product family (PQH prefix, shared with Oracle Public Sector/HR document management functionality). It provides a programmatic interface for creating, maintaining, and removing document records stored in the PQH_DOCUMENTS_F datetracked entity. Rather than permitting direct DML against the underlying table, Oracle EBS exposes this package as the supported integration point, allowing callers to rely on the package to enforce datetrack (effective date) logic, object version number maintenance, and the consistent propagation of document metadata attributes such as category, short name, document name, LOB code, language, and territory.

The package source header indicates a shipped base version (pqdocapi.pkb 120.1), classifying it as a delivered, supported API rather than a customer extension. It is documented as an API object in the ETRM for both 12.1.1 and 12.2.2, and its internal helper structure — for example, the private create_dummy_rec procedure that seeds an eliminated record via update_document — reflects the standard Oracle datetrack pattern used to terminate the prior effective-dated row when a new version is introduced.

Key Procedures and Functions

The package exposes six documented entry points, organized as three functional pairs:

• CREATE_PRINT_DOCUMENT — The procedure most commonly associated with the search term "create_print_document". It creates a new document record intended for print-oriented document definitions, inserting the row with the supplied document attributes and beginning a new datetracked version.
• CREATE_DOCUMENT — Creates a standard document record in PQH_DOCUMENTS_F. It is the general-purpose creation entry point, distinct from the print-specific variant.
• UPDATE_PRINT_DOCUMENT — Modifies an existing print document, generating a new effective-dated version and preserving history through the datetrack mechanism.
• UPDATE_DOCUMENT — Modifies a standard document record, likewise producing a new version row rather than overwriting history.
• DELETE_PRINT_DOCUMENT — Removes or logically terminates a print document definition while maintaining the datetracked record structure.
• DELETE_DOCUMENT — Removes or terminates a standard document record.

Because the ETRM documentation lists the procedures only by name, parameter signatures are not reproduced here. Callers should reference the package specification in the database for exact argument lists, validation flags, and in/out version-number parameters.

Tables Accessed

The package operates against a single documented table, accessed through its APPS synonym:

• PQH_DOCUMENTS_F — The datetracked (effective-dated) table holding document definitions. It stores effective_start_date, effective_end_date, short_name, document_name, file_id, formula_id, object_version_number, document_category, lob_code, language, and territory. All create, update, and delete operations in the API ultimately read from or write to this table.

Document versioning is managed through the object_version_number column, which the API increments on each update. The datetrack columns drive the effective-dated history, and the package's private routines query the current effective row before applying changes.

Usage Notes

This API is typically invoked from Oracle HRMS forms that maintain document definitions, from concurrent programs that load or migrate document metadata, and from custom PL/SQL integration code. Because PQH_DOCUMENTS_F is a datetracked table, callers must supply a valid effective date and should not perform direct DML against the table. The package is referenced by at least two other packages in the EBS schema, indicating that it serves as a shared, lower-level service within the HR document subsystem. When integrating, developers should invoke the procedure matching their document type (print versus standard) and always pass the current object_version_number on updates to ensure optimistic locking is honored.