Search Results ben_vrbl_rt_elig_prfl_api




Overview
Explore in AI Chat

Overview

The APPS.BEN_VRBL_RT_ELIG_PRFL_API package is a public Oracle E-Business Suite Application Programming Interface (API) that manages variable rate eligibility profiles within the Oracle Advanced Benefits (OAB) module. In the Oracle EBS 12.1.1 and 12.2.2 data models, a variable rate eligibility profile defines the criteria that determine which participants qualify for a given variable rate or rate structure associated with a benefit plan. This package provides the transactional layer that creates, maintains, and removes those eligibility profile definitions in a controlled, validated manner, ensuring that the underlying base table remains consistent with the business rules enforced by the Benefits engine.

The object is registered in the ETRM repository with a status of VALID and is classified as an API (as opposed to a private package or internal utility). Its owner is the APPS schema, which is the standard convention for Oracle EBS public APIs, and its procedures are intended for invocation by other application modules, concurrent processes, or customer extensions rather than by end users directly.

Key Procedures and Functions

The package exposes four documented procedures and functions. Each addresses a distinct phase of the eligibility profile life cycle:

  • CREATE_VRBL_RT_ELIG_PRFL — Inserts a new variable rate eligibility profile record. This routine accepts the profile definition attributes and persists a new row, applying the standard validation and defaulting logic required by the benefits engine.
  • UPDATE_VRBL_RT_ELIG_PRFL — Modifies an existing variable rate eligibility profile. It allows changes to the profile's attributes while preserving referential integrity with dependent rate and plan design records.
  • DELETE_VRBL_RT_ELIG_PRFL — Removes an existing eligibility profile. This routine handles the logical or physical deletion of the record in accordance with Benefits data retention rules and checks for dependencies before removing the row.
  • LCK — A locking routine that obtains a row-level lock on the target profile record. It is typically invoked at the start of an update or delete operation to prevent concurrent modification of the same profile.

No parameter lists are documented in the ETRM metadata, and this article deliberately does not speculate on their signatures.

Tables Accessed

The package operates against a single documented base table, accessed through its APPS synonym:

  • BEN_VRBL_RT_ELIG_PRFL_F — The primary storage table for variable rate eligibility profile definitions. The CREATE procedure inserts rows here, UPDATE modifies existing rows, and DELETE removes them. The LCK routine locks rows in this table to manage concurrency.

The _F suffix indicates that this is a date-tracked (datetrack) table, meaning that the API is responsible for managing effective dates and version history so that historical eligibility configurations are retained for audit and retroactive processing.

Usage Notes

This package is a foundational dependency of several higher-level Benefits processes. The ETRM metadata shows that it is referenced by three other packages, most notably BEN_PD_COPY_TO_BEN_FIVE (used when copying plan design data), BEN_PLAN_DESIGN_DELETE_API (used during plan design deletion), and PQH_GSP_STAGE_TO_BEN (used in the public-sector staging integration). In addition, it depends on HR_API and the SYS.STANDARD package.

Typical invocation points include Oracle Forms-based Benefits setup screens, where user actions on variable rate eligibility profiles are routed through this API, and concurrent programs or custom PL/SQL that programmatically provision benefit configurations. Because it is a validated public API, custom code should call CREATE_VRBL_RT_ELIG_PRFL, UPDATE_VRBL_RT_ELIG_PRFL, and DELETE_VRBL_RT_ELIG_PRFL rather than performing direct DML on BEN_VRBL_RT_ELIG_PRFL_F, ensuring that all validation, locking, and date-tracking behavior is preserved. Developers should also be aware that the package is referenced within its own dependency chain, indicating internal helper calls that support the public procedures.