Search Results pay_sf_shd




Overview
Explore in AI Chat

Overview

PAY_SF_SHD is a PL/SQL package body owned by the APPS schema in Oracle E-Business Suite. The suffix "SHD" denotes shadow, and the package operates within the Oracle Payroll shadow formula infrastructure. Its principal role is to support the maintenance and interpretation of shadow formula definitions stored in the PAY_SHADOW_FORMULAS table. Shadow formulas are the payroll engine's internal, compiled representation of user-defined Oracle Fast Formulas, and they underpin formula validation, run-time evaluation, and diagnostics. The package provides utility procedures for argument conversion, concurrency control, and internal error handling, positioning it as a low-level service component consumed by higher-level payroll formula APIs rather than a directly user-invoked business interface. In the ETRM documentation it is classified as an OTHER API, indicating that it is not part of a formally published public API surface but is internally significant to the payroll formula subsystem. The package is VALID in the APPS schema across both EBS 12.1.1 and 12.2.2.

Key Procedures and Functions

The documented package body exposes four procedures or functions:

  • CONSTRAINT_ERROR — An error-handling routine that signals or raises a constraint-related failure encountered during shadow formula processing. It centralizes exception behaviour so that callers receive a consistent error signal.
  • API_UPDATING — Tracks or flags whether an API-driven update to shadow formula data is presently in progress. This supports controlled write behaviour and prevents conflicting modifications during formula maintenance operations.
  • LCK — A locking routine used to serialize access to shadow formula records, ensuring that concurrent sessions do not corrupt or overwrite formula definitions during update or compilation.
  • CONVERT_ARGS — Converts argument values between the representations used by the payroll formula engine and those expected by shadow formula storage or callers. This is the principal transformation utility within the package.

Parameter lists and signatures are not documented in the available metadata and are intentionally not enumerated here.

Tables Accessed

The package references two tables through APPS synonyms:

  • PAY_SHADOW_FORMULAS — The primary data store for shadow formula definitions. The package reads and manages records in this table to support formula look-up, locking, and update operations.
  • ALL_CONSTRAINTS — A data dictionary view consulted to examine constraint definitions, most likely to validate referential or integrity conditions associated with shadow formula records prior to update, consistent with the CONSTRAINT_ERROR routine.

Additional dependencies include the APPS pay_sf_shd specification, HR_API, HR_UTILITY, and the STANDARD package, confirming reliance on shared HRMS utility and exception-handling infrastructure.

Usage Notes

PAY_SF_SHD is not referenced by any database object, but it is reported as referenced by nine other packages, indicating that it functions as a shared internal service invoked by payroll formula and shadow formula routines. It is typically reached indirectly through formula compilation, validation, and maintenance flows rather than from Oracle Forms or concurrent programs directly. Because the package handles locking, update flagging, and constraint errors, it is most relevant when shadow formulas are being created, regenerated, or replaced—for example during formula compilation after a definition change or during payroll run preparation. Custom code should not call these procedures directly; developers requiring shadow formula information ought to use the supported Fast Formula or payroll APIs, leaving PAY_SF_SHD as an internal implementation detail observed primarily through dependency tracing and troubleshooting.