Search Results pay_bth_shd




Overview
Explore in AI Chat

Overview

PAY_BTH_SHD is the shared utility package body in the Oracle Payroll (PAY) module of Oracle E-Business Suite, owned by the APPS schema and validated in both 12.1.1 and 12.2.2. Its name reflects its role as a "shared" (SHD) service layer for batch header processing. The package encapsulates the common PL/SQL logic that multiple payroll batch-processing routines rely upon, rather than duplicating that logic across each consumer. Its principal responsibilities are DML status tracking, concurrency control, and argument conversion for batch header operations against the PAY_BATCH_HEADERS table. As a package body with API classification OTHER, it is not part of the public, externally documented PL/SQL API surface; it is an internal implementation package. The ETRM metadata records five procedures and confirms that the package is referenced by five other packages while itself referencing no dependency back into PAY_BTH_SHD from elsewhere, indicating it sits low in the payroll batch call stack.

Key Procedures and Functions

The documented procedures (five in total, per ETRM 12.2.2) are:

  • RETURN_API_DML_STATUS — Returns the current status of data manipulation operations performed by the API layer, allowing callers to determine whether inserts, updates, or deletes against batch headers have succeeded or failed.
  • CONSTRAINT_ERROR — Centralizes handling of constraint violations raised during batch header DML, providing a consistent error path when database integrity rules are breached.
  • API_UPDATING — Signals or tracks that the API is currently performing an update, supporting re-entrancy and state awareness across nested calls.
  • LCK — Implements locking logic for batch header records, guarding against concurrent modification of the same batch by competing sessions.
  • CONVERT_ARGS — Converts incoming arguments into the internal representation required by the batch header processing routines.

Because the metadata does not publish parameter signatures, no parameter lists are stated here; these procedures should be treated as internal callable units rather than a documented public interface.

Tables Accessed

Two tables are referenced through APPS synonyms:

  • PAY_BATCH_HEADERS — The primary subject of the package. It stores batch header records for payroll batch processing. The package reads and writes this table as part of header creation, update, and locking operations.
  • ALL_CONSTRAINTS — The data dictionary view used to inspect constraint metadata, which supports the CONSTRAINT_ERROR procedure in interpreting and reporting constraint violations.

The dependency list further shows references to FND_MESSAGE (message/error text retrieval), HR_API and HR_UTILITY (shared HR utilities), and STANDARD. These support internationalized messaging and reusable validation logic but are not the package's business tables.

Usage Notes

PAY_BTH_SHD is invoked indirectly. It is called by payroll batch processing forms, concurrent programs, and other payroll packages that manipulate batch headers, and it is not intended to be called directly by custom code. Developers extending payroll batch functionality should call the higher-level, documented public APIs that in turn delegate to PAY_BTH_SHD, and should rely on its DML status return and locking behavior rather than implementing equivalent logic independently. Because it is a VALID APPS object in 12.1.1 and 12.2.2, it can be expected to be present unmodified in both releases, though any customization should be verified against the specific patch level of the environment.