Search Results pay_tco_shd




Overview
Explore in AI Chat

Overview

PAY_TCO_SHD is a stored PL/SQL package body owned by the APPS schema in Oracle E-Business Suite, classified as an "OTHER" API type within the Oracle ETRM repository. The name reflects its role: "PAY" denotes the Oracle Payroll product family, "TCO" abbreviates Template Core Objects, and the "_SHD" suffix conventionally marks a shadow or support package. This package operates in conjunction with the PAY_TEMPLATE_CORE_OBJECTS structure, part of the Payroll template architecture that underpins payroll setup objects and their deployment across business groups. Its principal purpose is to manage the update lifecycle of template core object definitions, validating the state of core objects, intercepting conflicting updates through a locking mechanism, and reconciling argument structures passed to dependent template processing. In EBS 12.1.1 and 12.2.2 the package status is documented as VALID, and it is not referenced by any other database object, indicating that it functions as a terminal utility layer invoked by higher-level template or payroll setup code rather than as a shared dependency itself. It depends on HR_API, HR_UTILITY, and STANDARD, together with PAY_TCO_SHD itself and the PAY_TEMPLATE_CORE_OBJECTS and ALL_CONSTRAINTS objects.

Key Procedures and Functions

  • CONSTRAINT_ERROR — raises or signals a constraint violation condition detected while template core objects are being validated or updated; it centralizes error handling for referential and definitional integrity problems.
  • API_UPDATING — determines or flags whether a template core object API is currently in the process of being updated, guarding against overlapping or recursive modification attempts.
  • LCK — implements the locking routine used to serialize access to template core object records, ensuring that concurrent sessions cannot corrupt shared template definitions.
  • CONVERT_ARGS — translates or normalizes argument sets supplied to template core object APIs, reconciling the arguments into the structure expected by the underlying template processing logic.

No parameter lists are documented for these routines in the ETRM metadata, and none are asserted here; their signatures should be confirmed against the deployed source before direct invocation.

Tables Accessed

The package references two primary tables through APPS synonyms:

  • PAY_TEMPLATE_CORE_OBJECTS — the definition table for payroll template core objects; PAY_TCO_SHD reads and maintains these rows during update, lock, and argument-conversion operations.
  • ALL_CONSTRAINTS — the data dictionary view used by the CONSTRAINT_ERROR logic to inspect database constraint definitions and detect violations affecting template core object records.

Dependency metadata also lists PUBLIC.ALL_CONSTRAINTS and SYS.STANDARD, confirming reliance on the standard PL/SQL package and dictionary access through public synonyms.

Usage Notes

PAY_TCO_SHD is an internal support package. It is not referenced by any other database object, meaning it is not exposed as a public API surface and is invoked instead from within Payroll template maintenance flows, typically through form-driven or concurrent setup processing that manipulates template core objects. Documented metadata reports it as referenced by 19 other packages, so its routines are called from a range of dependent payroll and HR template components rather than directly by end users. Direct invocation from custom code is discouraged; the locking (LCK) and update-guard (API_UPDATING) routines assume the calling context of the template object maintenance framework. Any extension or debugging should treat CONSTRAINT_ERROR and CONVERT_ARGS as validation and normalization hooks whose behavior must remain consistent with the template core object model across both 12.1.1 and 12.2.2 releases.