Search Results pay_pyr_bus




Overview
Explore in AI Chat

Overview

APPS.PAY_PYR_SHD is a shared utility package within the Oracle Payroll (PAY) module of Oracle E-Business Suite, validated and present in both the 12.1.1 and 12.2.2 release codelines. Its name follows the Oracle naming convention for shared PL/SQL libraries: the _SHD suffix indicates that the package exposes reusable logic consumed by other packages rather than being invoked directly by a form or concurrent program. In practice, PAY_PYR_SHD functions as a supporting infrastructure layer for the rate-handling family of payroll packages — PAY_PYR_BUS, PAY_PYR_INS, PAY_PYR_UPD, and PAY_PYR_DEL — which implement the business rules for creating, maintaining, and removing rate records in the PAY_RATES table.

The package is classified as OTHER within the ETRM documentation, meaning it is not a published public API but an internal implementation package. It has no direct user-facing responsibility; instead it centralises constraint validation, DML status tracking, and lock management for the rate entity so that the INSERT, UPDATE, DELETE, and BUS packages behave consistently.

Key Procedures and Functions

The ETRM metadata documents five procedures and functions within PAY_PYR_SHD. Parameter lists are not published and are therefore not reproduced here.

  • RETURN_API_DML_STATUS — Returns the outcome of the most recent DML operation performed by the rate API stack. This allows calling packages such as PAY_PYR_INS and PAY_PYR_UPD to determine whether an insert or update succeeded, typically by returning a status code or SQL%ROWCOUNT-derived value to the caller.
  • CONSTRAINT_ERROR — Handles integrity violations raised against rate records. Because the package references ALL_CONSTRAINTS, this routine is understood to inspect constraint metadata and translate an Oracle constraint exception into a structured API error for the invoking business package.
  • API_UPDATING — Signals or records that an API-driven modification of a rate row is in progress. This guard prevents conflicting or recursive processing while the rate business logic executes.
  • LCK — Acquires or manages the lock on a rate record prior to modification, ensuring that concurrent sessions cannot simultaneously alter the same PAY_RATES row.
  • CONVERT_ARGS — Normalises or converts incoming arguments before they are passed to the underlying rate processing logic, providing a consistent argument interface across the rate packages.

Tables Accessed

  • PAY_RATES — The core rate definition table. PAY_PYR_SHD supports the DML performed by its sibling packages against this table, supplying the lock, constraint, and status handling that surrounds each insert, update, or delete.
  • ALL_CONSTRAINTS — The data dictionary view used to resolve constraint definitions applicable to the rate entity. This reference confirms that PAY_PYR_SHD performs metadata-driven constraint checking rather than relying on hard-coded rule text.

Both objects are accessed through APPS synonyms, consistent with the standard Oracle EBS schema access pattern.

Usage Notes

PAY_PYR_SHD is never invoked directly by an end user. It sits beneath the rate business packages and is called by them during rate maintenance operations. The documented reverse dependencies confirm five packages that reference it: HR_RATE_API, PAY_PYR_BUS (appearing twice), PAY_PYR_DEL (twice), PAY_PYR_INS (twice), and PAY_PYR_UPD (twice), along with a self-reference from PAY_PYR_SHD itself, indicating internal reuse of its own routines.

Because the package is not a public API, customisations should call the business-level packages such as HR_RATE_API or PAY_PYR_BUS rather than PAY_PYR_SHD. Direct modification or extension of this shared package carries upgrade risk in 12.2.2, where online patching (adop) and the dual-file-system editioning model require that any such change be delivered through the supported patching cycle. For the user search term "pay_pyr_bus", the relevant point is that PAY_PYR_BUS is the consumer of this shared logic — PAY_PYR_SHD exists to serve it, not the reverse.