Search Results ben_program_api




Overview
Explore in AI Chat

Overview

BEN_PROGRAM_API is a public PL/SQL API in the APPS schema that provides the transaction-level entry point for creating, maintaining, and removing program records within the Oracle EBS Advanced Benefits (OLTP) product family. In Advanced Benefits, a program is the container object that groups one or more plans and plan types under a common offering, and it sits near the top of the benefits configuration hierarchy (program, plan type, plan, option). Because programs participate in date-tracked eligibility and enrollment processing, direct DML against the underlying tables is not supported; all maintenance must pass through this API so that the standard validation, date-track and object-versioning logic in the BEN schema is enforced.

The package is classified as an API in the ETRM repository and reports a status of VALID. Its dependency list shows it builds on HR_API, the Oracle HRMS generic API utility layer that supplies the standard date-track and business-group handling routines, and on the STANDARD package for PL/SQL constructs. This confirms the package follows the documented HRMS API pattern rather than performing ad hoc inserts and updates.

Key Procedures and Functions

The ETRM documentation records four documented program units. Parameter lists are not reproduced here; only the documented purpose of each unit is described.

  • CREATE_PROGRAM — Inserts a new program record, populating the base row and any associated date-track rows so the program is usable in plan design and enrollment processing. It is the supported route for establishing a new program definition.
  • UPDATE_PROGRAM — Modifies an existing program, applying the surrogate-key and date-tracked update semantics required by the BEN data model so that historical versions remain consistent.
  • DELETE_PROGRAM — Removes a program record, including its date-tracked rows, subject to the referential rules governing programs that are still referenced by dependent plan design objects.
  • LCK — The locking routine used by the API to serialize concurrent modifications to a program row, preventing conflicting updates during concurrent plan design or enrollment activity.

Tables Accessed

The documented table reference for this package is BEN_PGM_F, the base ("F") table that stores program definitions in the BEN schema. The API reads and writes this table through the APPS synonym, with the intersecting date-track table maintained implicitly by the HRMS date-track framework. Because the base table is date-tracked, delete and update operations performed through the API also affect the corresponding date-track rows rather than removing or altering only the base record.

Usage Notes

BEN_PROGRAM_API is not normally invoked directly by end users. It is called from the Benefits plan design setup forms and from a set of BEN and GHR packages. The ETRM dependency report lists the following referencing objects: BEN_PD_COPY_TO_BEN_ONE, BEN_PLAN_DESIGN_DELETE_API, BEN_PROGRAM_API itself (recursive or internal reference), GHR_FEHB_PLAN_DESIGN, GHR_TSP_CATCHUP_PLAN_DESIGN, GHR_TSP_PLAN_DESIGN, PQH_GSP_STAGE_TO_BEN and PQH_GSP_UTILITY. This pattern shows the API is consumed both by benefits plan design copy and delete utilities and by the public-sector GSP staging and utility packages that load plan design data.

When extending or integrating with Advanced Benefits on Oracle EBS 12.1.1 or 12.2.2, custom code should call this API rather than issuing DML against BEN_PGM_F. Doing so preserves the locking, validation and date-track behavior already relied upon by the seven dependent packages listed in the ETRM metadata.