Search Results ben_pei_shd




Overview
Explore in AI Chat

Overview

APPS.BEN_PEI_SHD is a shadow (SHAD) package body delivered as part of the Oracle Advanced Benefits (BEN) product family in Oracle E-Business Suite 12.1.1 and 12.2.2. It is classified as an OTHER API rather than a public, date-tracked business API, which indicates that it is intended primarily for internal consumption by other Advanced Benefits components rather than for direct customer extension. The package supports the lifecycle management of an underlying database entity by exposing the standard shadow-package pattern used throughout the BEN schema: DML status tracking, logical locking, effective-date maintenance, and detection of update or delete modes against existing rows.

The referenced table BEN_PL_EXTRACT_IDENTIFIER_F identifies the functional domain as extract identifier configuration for benefit plans, meaning this package underpins the metadata that controls how plan-level benefit data is identified when extracted and transferred. Because it is a shadow package, its members are called by the corresponding non-shadow package (BEN_PEI) and by the AutoPatch / DateTrack machinery rather than by end users. The package is VALID in the documented ETRM metadata and is depended upon by six other database objects, confirming its role as a shared internal service.

Key Procedures and Functions

  • RETURN_API_DML_STATUS — Returns the status of the most recent DML operation performed through the package, allowing callers to determine whether the preceding insert, update, or delete succeeded.
  • CONSTRAINT_ERROR — Handles constraint violations raised during DML processing, translating database-level integrity failures into a controlled error path.
  • API_UPDATING — Indicates whether an API-driven update is currently in progress, typically used to suppress or branch logic during nested processing.
  • FIND_DT_DEL_MODES — Determines the DateTrack delete modes applicable to a row, informing how effective-dated deletions should be applied.
  • FIND_DT_UPD_MODES — Determines the DateTrack update modes applicable to a row, informing how effective-dated changes should be applied.
  • UPD_EFFECTIVE_END_DATE — Maintains the EFFECTIVE_END_DATE on the underlying record, the core operation in DateTrack's date-splitting logic.
  • LCK — Provides logical row locking, preventing concurrent modification of the same extract identifier record.
  • CONVERT_ARGS — Normalises or converts argument values passed into the package's API surface before they are processed.

Tables Accessed

Two tables are documented via APPS synonyms. BEN_PL_EXTRACT_IDENTIFIER_F is the primary base table, holding the effective-dated extract identifier definitions that the package reads and writes; all DateTrack and DML members operate against this table. ALL_CONSTRAINTS is queried to introspect table constraints, which supports the CONSTRAINT_ERROR and FIND_DT_DEL_MODES / FIND_DT_UPD_MODES logic by establishing which integrity rules and DateTrack transitions apply. No other data objects are documented.

Usage Notes

APPS.BEN_PEI_SHD is not referenced by any database object directly named in the metadata, but it is reported as referenced by six other packages, reflecting the shadow-package convention in which the non-shadow BEN_PEI package and related benefits configuration code call into BEN_PEI_SHD for DML, locking, and effective-date handling. It should not be invoked directly from custom forms or concurrent programs; instead, customers should call the supported public API surface of the corresponding BEN_PEI package. Direct invocation risks bypassing validation and DateTrack consistency checks, particularly around UPD_EFFECTIVE_END_DATE and the LCK locking semantics. When troubleshooting Advanced Benefits extract identifier configuration issues, DBAs and developers may query the package source and its dependencies in ALL_DEPENDENCIES to confirm whether a given error originates in the shadow layer or in calling code.