Search Results pay_ter_shd




Overview
Explore in AI Chat

Overview

PAY_TER_SHD is a shared utility package within the Oracle E-Business Suite Payroll (PAY) schema, owned by APPS. Its name follows the Oracle convention for "shadow" or shared library code that supports the Term Element functionality of Oracle Payroll. In the ETRM 12.2.2 classification the package is recorded as an OTHER API, meaning it is not exposed as a formally published public interface but is instead consumed internally by the payroll element and termination infrastructure.

The package operates in the same functional neighbourhood as PAY_ELEMENT_TEMPLATE_UTIL and the PAY_TER_BUS, PAY_TER_INS, PAY_TER_UPD and PAY_TER_DEL packages that together manage Payroll Element Templates, including their creation, update and deletion, and the exclusion rules that determine which combinations of element, assignment and organization are permissible. PAY_TER_SHD provides the low-level shared routines — locking, concurrency validation and argument conversion — upon which those higher-level business packages depend.

Key Procedures and Functions

  • CONSTRAINT_ERROR — Raises or reports a constraint-related error condition encountered during template or termination processing. It allows the calling business packages to translate a low-level database constraint failure into a consistent, user-facing payroll error.
  • API_UPDATING — Provides the standard Oracle "API in progress" guard used to detect and prevent re-entrant or concurrent modification of the same template or termination record while an update is underway.
  • LCK — The locking routine. It acquires the row-level lock required before a template or termination record may be modified, ensuring serialized access across concurrent sessions.
  • CONVERT_ARGS — Converts or normalises argument values passed between the shared layer and the business packages, so that callers can supply data in a consistent internal format.

No public parameter lists are documented for these units in the ETRM metadata; the four entries above describe purpose only.

Tables Accessed

  • PAY_TEMPLATE_EXCLUSION_RULES — the principal data table. It stores the rules that govern which element templates may coexist with, or be excluded from, a given payroll configuration. PAY_TER_SHD reads and validates against these rules when the business packages evaluate template eligibility.
  • ALL_CONSTRAINTS — accessed through a PUBLIC synonym, this data dictionary view is used to inspect constraint definitions. This supports the CONSTRAINT_ERROR routine's ability to identify the specific integrity constraint that failed.

The package references no other application tables directly, reinforcing its role as a narrow, shared service layer rather than an owning entity of payroll data.

Usage Notes

PAY_TER_SHD is not invoked directly by forms, concurrent programs or end users. It is referenced by five other packages: PAY_ELEMENT_TEMPLATE_UTIL, PAY_TER_BUS, PAY_TER_DEL, PAY_TER_INS and PAY_TER_UPD (the package also appears in its own dependency listing). These callers handle element template maintenance and termination processing, and delegate locking, concurrency checking, argument conversion and constraint-error handling to PAY_TER_SHD.

Because the package is classified as an OTHER API and is documented as VALID, customisations should treat it as an internal dependency: extend or wrap the documented public packages rather than calling PAY_TER_SHD directly. Any upgrade that changes element template or exclusion-rule logic is likely to affect this package and, transitively, all five dependent units.