Results for “delete_txn_cat_document”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

APPS.PQH_TXN_CAT_DOCUMENTS_API is a public PL/SQL application programming interface within the Oracle E-Business Suite HRMS family, specifically associated with the Public Sector/HR (PQH) product schema. Its business function is to provide a controlled, validated entry point for maintaining the association between documents and transaction categories. In Oracle EBS, transaction categories are used to classify personnel or HR-related transactions, and this API governs the creation, modification, and removal of the document-to-transaction-category link records that support those classifications.

The package body is implemented in the file pqtcdapi.pkb and follows the standard Oracle EBS API architecture: each public procedure issues a savepoint, truncates the time portion of incoming date parameters, invokes a "Before Process" user hook, performs validation, and then delegates the physical DML to the corresponding row handler (for example, pqh_tcd_ins.ins for insertion). The public procedures are therefore thin orchestration layers that enforce API rules, error handling, and extensibility hooks while relying on lower-level table handlers to touch the underlying tables.

Key Procedures and Functions

The ETRM metadata documents three public procedures for this package:

• CREATE_TXN_CAT_DOCUMENT — Creates a new association between a document and a transaction category. The procedure copies the validated record into the underlying entity through the insert row handler and returns the newly generated object version number.
• UPDATE_TXN_CAT_DOCUMENT — This is the procedure referenced by the search term update_txn_cat_document. It modifies an existing document-to-transaction-category association, applying the same validation and user-hook pattern and returning the updated object version number for optimistic locking.
• DELETE_TXN_CAT_DOCUMENT — Removes an existing association between a document and a transaction category, again through the corresponding row handler and with the standard API validation and hook processing.

The procedures share a common design contract: they accept a validation flag, an effective date, identifying keys, and use the object version number for concurrency control. The documented source confirms that CREATE_TXN_CAT_DOCUMENT follows this pattern, calling the Before Process user hook pqh_txn_cat_documents_bk1.create_txn_cat_document_b before delegating to the row handler. No parameter lists for UPDATE_TXN_CAT_DOCUMENT or DELETE_TXN_CAT_DOCUMENT are reproduced here, as they are not present in the supplied metadata extract.

Tables Accessed

The supplied ETRM metadata does not enumerate the base tables referenced through APPS synonyms; the documentation set lists no explicit table entries for this object. Based on the naming conventions and the row handlers invoked in the source excerpt, the package operates on the transaction-category document entity through the synonymous table handler pqh_tcd_ins. This handler performs the physical insert (and, by extension, the corresponding update and delete operations invoked by the sibling procedures) against the underlying PQH transaction-category document table. The package also depends on the HR API infrastructure — notably hr_api and hr_utility — for error reporting and debug location tracing.

Usage Notes

This package is classified as a public API and is referenced by one other package. It is typically invoked from the Oracle EBS forms layer (for example, a Public Sector HR maintenance form) whenever a user creates, changes, or removes a document-to-transaction-category association, and it may also be called from concurrent programs, workflow, or custom PL/SQL code that must maintain these relationships. Because the procedures expose user hooks, implementers can extend behavior by defining the corresponding Business Process hook logic without modifying the delivered package. Callers should supply a valid effective date — the API truncates any time component — and should persist the returned object version number to support subsequent update and delete operations under optimistic locking. All calls should be executed in an APPS-connect context with the standard HR API initialization in place.