Results for “ben_xic_shd”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

APPS.BEN_XIC_SHD is a shadow (SHD) package body within the Oracle E-Business Suite Advanced Benefits (BEN) module. The "_SHD" suffix indicates that this package is a shadow copy of an entity-maintenance API, generated by the Oracle Applications object library framework to support row-level shadow tracking of the underlying benefit entity. In this case, the base object is the benefit external inclusion change entity (BEN_EXT_INCL_CHG), and the shadow package provides the standard insert, update, lock, and validation behavior associated with that entity.

The package is classified as OTHER in the ETRM repository for release 12.2.2, meaning it is not itself a public business-facing API but rather an internal generated artifact that coordinates DML against the benefit entity and its shadow table. Its primary runtime responsibility is to enforce referential and constraint integrity while recording the before-image of rows for auditing and date-tracked (datetrack) processing.

Key Procedures and Functions

• RETURN_API_DML_STATUS — Returns the current value of the package global g_api_dml as a Boolean, indicating whether an API-driven DML operation has already occurred within the current session for this shadow entity. It is used by callers and by other generated code to avoid duplicate or re-entrant DML.
• CONSTRAINT_ERROR — Centralizes error handling for violated database constraints. Based on the constraint name passed in (for example BEN_EXT_INCL_CHG_FK1 or BEN_EXT_INCL_CHG_FK2), it raises a translated Oracle Applications message using FND_MESSAGE (HR_6153_ALL_PROCEDURE_FAIL) with the procedure name and a step token, so failures surface to the user as standard EBS errors rather than raw ORA- errors.
• API_UPDATING — Sets or queries the internal flag that records that the row is being modified through the API layer, allowing the shadow package to distinguish API-driven changes from direct DML and to trigger the appropriate shadow/date-track logic.
• LCK — Performs the row-level lock on the target entity row prior to update, ensuring concurrency control consistent with the generated object library pattern.
• CONVERT_ARGS — Normalizes or converts incoming API arguments into the internal column representation used by the shadow DML routines before they are applied to the entity.

All routines use HR_UTILITY.SET_LOCATION for debug tracing, consistent with the APPS object library standard (header bexicrhi.pkb, version 120.2).

Tables Accessed

• BEN_EXT_INCL_CHG — The primary benefit external inclusion change entity. The shadow package reads and writes rows here as the subject of insert/update processing, including the modification that the shadow logic tracks.
• ALL_CONSTRAINTS — Read by CONSTRAINT_ERROR to resolve constraint metadata and determine which translated message to raise for a given foreign-key or check violation.

Usage Notes

Because this is a shadow package body, it is not intended to be called directly by end users or custom code. It is invoked indirectly through the public benefit entity API (for example BEN_EXT_INCL_CHG_API or its generated wrapper) and through the standard object-library DML path whenever BEN_EXT_INCL_CHG rows are inserted or updated. The metadata records that the package is referenced by five other packages, reflecting its role as a shared dependency in the benefit entity maintenance chain. Typical invocation contexts include the Benefits external inclusion change forms, related concurrent programs that process benefit enrollment and inclusion data, and any internal API calls that perform date-tracked updates. Customizations should call the public entity API rather than BEN_XIC_SHD directly, since the shadow routines assume the calling layer has already validated the business rules for the entity.