Search Results ben_cpe_ins




Overview
Explore in AI Chat

Overview

BEN_CPE_INS is a PL/SQL package in the APPS schema that forms part of the Oracle E-Business Suite Advanced Benefits (Benefit) module's copy-entity infrastructure. The package name derives from the "BEN" product prefix and the "CPE" copy-entity component, with the "_INS" suffix indicating its role in insert operations. Its function is to perform the physical insertion of copy-entity result rows into the Benefits copy-entity tables, working in coordination with the shadow/audit package BEN_CPE_SHD. The package is classified as OTHER in the ETRM documentation, meaning it is a supporting internal utility rather than a public-facing API such as those published through the BEN_*_API naming convention.

BEN_CPE_INS operates within the broader benefit plan copy process, in which a user duplicates benefit plans, programs, or related configuration from a source to a target environment. The copy-entity framework tracks the relationships between source and destination entity instances, and the insert package persists those mappings and intermediate results. It is one of several packages that together implement the copy routine, and its ETRM status is VALID across the 12.1.1 and 12.2.2 releases.

Key Procedures and Functions

ETRM documents three procedures or functions within BEN_CPE_INS:

  • SET_BASE_KEY_VALUE — Establishes the base key value or key context that subsequent insertion logic uses. It is called during initialization of an insert operation so that the correct primary key or entity identifier is available before rows are written. This supports the key-mapping requirements of the copy-entity process, where source keys must be translated to newly generated target keys.
  • INS — The principal insertion routine. It writes the copy-entity result rows to the relevant base and shadow tables, applying the key values prepared by SET_BASE_KEY_VALUE. This is the procedure invoked by the calling copy-entity API when a new result record must be persisted.

The ETRM extract lists only these entries. Parameter lists, overloading, and exact signatures are not published in the metadata and must be confirmed against the package specification in the target instance.

Tables Accessed

BEN_CPE_INS reads and writes two tables, referenced through APPS synonyms:

  • BEN_COPY_ENTITY_RESULTS — The primary base table holding copy-entity result records. The INS suffix package and the INS procedure both indicate that inserts into this table are the core activity. Each row represents the outcome of copying one entity instance.
  • BEN_COPY_ENTITY_RESULTS_S — The shadow or audit table associated with the base table. Consistent with Oracle's shadow-table convention, it records the audit trail of inserted rows. The dependency on BEN_CPE_SHD confirms that shadow-table handling is integral to the package's operation.

The dependency report shows BEN_CPE_INS depends on the SYS STANDARD package, as is normal for any PL/SQL unit, and on BEN_CPE_SHD, indicating delegation of shadow-row maintenance to the audit package.

Usage Notes

BEN_CPE_INS is an internal component and is not intended for direct invocation by end users or typical customizations. It is called by BEN_COPY_ENTITY_RESULTS_API, the documented public entry point for the copy-entity results facility. The ETRM dependency list records exactly one referencing package, BEN_COPY_ENTITY_RESULTS_API, and also shows a self-reference, indicating recursive or internally sequenced calls within BEN_CPE_INS itself.

In practice, this package is invoked indirectly when a benefits administrator runs a copy-plan or copy-entity concurrent request or performs a related action in the Benefits forms. Custom code should call BEN_COPY_ENTITY_RESULTS_API rather than BEN_CPE_INS, since the base insert package assumes the calling API has already validated inputs and established key context. Because only the two documented procedures are exposed in the metadata, integrators should treat the package as a private implementation detail subject to change. Validation of exact signatures requires inspection of the deployed package specification.