Search Results pay_user_columns_ovn

Overview

PAY_PUC_SHD is a shadow (row-handler) package within the Oracle E-Business Suite Payroll (PAY) schema, owned by APPS and marked VALID in the ETRM 12.2.2 registry. The name follows the standard Oracle EBS "shadow package" convention: the _SHD suffix denotes a table-handling shadow package that encapsulates the DML logic, concurrency locking, and API status tracking used by the corresponding business (or "bus") package, here PAY_PUC_BUS. In the EBS multilayered table-handler architecture, the shadow layer isolates physical table access so that multiple row-handler variants (INSERT, UPDATE, DELETE) can share consistent validation and locking behavior.

The package supports maintenance of the PAY_USER_COLUMNS entity — the user-defined payroll column definitions that extend an organization's payroll data model. Its API classification is documented as OTHER, indicating it is an internal, non-public API surfaced through the generated table-handler stack rather than a directly callable public interface.

Key Procedures and Functions

ETRM documents five procedures/functions in PAY_PUC_SHD. Parameter lists are intentionally not reproduced here.

• RETURN_API_DML_STATUS — Returns the current DML status of the row-handler API (for example, success, failure, or row-information status) so calling code can determine the outcome of a prior insert, update, or delete operation.
• CONSTRAINT_ERROR — Records or signals a constraint-violation condition encountered during DML, allowing the caller to distinguish a validation/constraint failure from other error classes.
• API_UPDATING — Indicates whether the API is currently performing an update, typically used to guard re-entrant or overlapping DML paths.
• LCK — The locking primitive. It obtains SELECT ... FOR UPDATE style row locks prior to DML to enforce concurrency control on the underlying payroll column records.
• CONVERT_ARGS — Converts or normalises incoming arguments between the external API call signature and the internal shadow representation, a common pattern in generated table handlers.

Tables Accessed

The documented dependency list shows access to two tables via APPS synonyms:

• ALL_CONSTRAINTS — Read to obtain constraint definitions and detect constraint violations during DML. This dictionary view is referenced in the dependency list directly from PUBLIC/SYS and via the APPS synonym.
• PAY_USER_COLUMNS — The principal entity table for this package; the shadow layer performs the physical inserts, updates, deletes, and lock acquisition against this table on behalf of the row-handler stack. The package PAY_USER_COLUMNS_OVN is a documented dependent, confirming this table as the package's core subject.

Usage Notes

PAY_PUC_SHD is not normally invoked directly from forms or concurrent programs. It is reached through the PAY table-handler chain: PAY_PUC_BUS (business logic) delegates to the shadow package, while PAY_PUC_INS, PAY_PUC_UPD, and PAY_PUC_DEL provide the insert, update, and delete row-handler wrappers. ETRM confirms the package is referenced by eight other packages, including the PAY_PCT_MNT_TL_ARD/ARI/ARU generated APIs, PAY_PUC_INS, PAY_PUC_UPD, PAY_PUC_DEL, and PAY_PUC_BUS itself.

Because it is an internal, generated artifact, customisations should never call PAY_PUC_SHD directly. Any extension of user-defined payroll columns must be performed through the supported public API layer for PAY_USER_COLUMNS. Direct calls risk bypassing the locking, constraint-checking, and DML status-tracking semantics that the shadow package enforces for the standard table handlers.