Search Results ben_plan_design_program_module




Overview
Explore in AI Chat

Overview

BEN_PLAN_DESIGN_PROGRAM_MODULE is a PL/SQL package in the APPS schema that forms part of the Oracle Advanced Benefits (OLAM / BEN) Plan Design infrastructure in Oracle E-Business Suite 12.1.1 and 12.2.2. Its principal business function is to support the definition, validation, and maintenance of benefit program configurations within the Plan Design workbench. A "program" in Advanced Benefits is the top-level container that groups plans, plan types, options, eligibility profiles, rates, and action types into a coherent set of offerings presented to a population. The package provides the program-level processing logic that the Plan Design forms and concurrent processes invoke when records are created, copied, or validated.

The package is classified as OTHER in the ETRM documentation rather than as a public API, indicating that it is an internal support package intended to be called by Oracle-owned Plan Design modules rather than by customer extensions. It exposes 55 documented procedures and functions, and it sits within a cluster of interdependent Plan Design packages that together implement the copy, formula, rate, and eligibility processing used by the workbench.

Key Procedures and Functions

The documented procedures fall into two broad categories.

These getter functions are consumed by the Plan Design UI and by downstream copy and validation routines that must translate internal IDs into user-facing labels without re-querying the base tables themselves.

Tables Accessed

The package reads from a defined set of Advanced Benefits base tables through APPS synonyms, including BEN_ACTN_TYP, BEN_ACTY_BASE_RT_F, BEN_AGE_FCTR, BEN_BENFTS_GRP, BEN_CMBN_AGE_LOS_FCTR, BEN_CMBN_PLIP_F, BEN_CMBN_PTIP_F, BEN_CMBN_PTIP_OPT_F, BEN_COMP_LVL_FCTR, BEN_COPY_ENTITY_RESULTS, BEN_DPNT_CVG_ELIGY_PRFL_F, BEN_ELIGY_CRITERIA, BEN_ELIGY_PRFL_F, and BEN_ELIG_TO_PRTE_RSN_F. These tables hold benefit groups, activity and age/service/composite rate factors, combined plan-in-program and plan-type-in-program definitions, compensation-level factors, eligibility profiles and criteria, and the results of copy-entity operations. The package also references PQH_TABLE_ROUTE, the Oracle Human Resources table-routing utility, reflecting the shared HR foundation on which Advanced Benefits is built.

Usage Notes

BEN_PLAN_DESIGN_PROGRAM_MODULE is invoked indirectly by Plan Design forms and concurrent processes rather than being called directly from custom code. The ETRM dependency listing shows it is referenced by seven other packages, including BEN_PD_COPY_TO_BEN_FIVE, BEN_PD_FORMULA_PKG, BEN_PD_RATE_AND_CVG_MODULE, BEN_PLAN_DESIGN_ELPRO_MODULE, BEN_PLAN_DESIGN_PLAN_MODULE, BEN_PLAN_DESIGN_TXNS_API, and BEN_PDW_COPY_BEN_TO_STG. This dependency pattern confirms its role as a shared program-level service layer within the Plan Design copy and validation flow. Because it is classified as OTHER and carries no documented public API contract, it should not be called from customer extensions; any dependency on it risks breakage across patches or upgrades. Customizations that require similar name-resolution or result-creation behavior should use the supported Advanced Benefits APIs or views instead.