Search Results refresh_eff_date_caches




Overview
Explore in AI Chat

Overview

APPS.BEN_COMP_OBJECT_LIST1 is a PL/SQL package within the Oracle E-Business Suite Advanced Benefits (BEN) module. Its primary business function is to manage and materialize the list of compensation objects that apply to a participant or population, given a business group, a compensation selection rule, and an effective date. In Oracle Advanced Benefits, a "compensation object" is the abstract representation of any item that contributes to a participant's compensation or benefit eligibility calculation — including salary, hourly wages, compensation plans, and other remunerative elements. Because eligibility and rate determination frequently require resolving which compensation objects satisfy a given selection rule at a specific point in time, the EBS runtime maintains a cache of resolved results to avoid repeated, expensive evaluation of selection criteria.

The package is the programmatic entry point for populating that cache. It is declared with AUTHID CURRENT_USER, meaning its procedures execute with the privileges of the invoking user rather than the definer, which is consistent with its role as an internal engine called from other BEN runtime code that already operates within the security context of the application.

Key Procedures and Functions

The package exposes two documented procedures; no functions are declared in the public specification.

  • POPULATE_COMP_OBJECT_LIST — The principal worker procedure. Its purpose is to evaluate a compensation selection rule for a given business group and effective date, determine the set of compensation objects that satisfy that rule, and persist the resulting rows into the compensation object cache. It accepts a cache identifier, a business group identifier, a compensation selection rule identifier, and an effective date as inputs, allowing callers to target a specific cache instance and control the temporal context of the evaluation. This procedure is the mechanism by which the cache transitions from empty to populated for a given rule/date combination.
  • REFRESH_EFF_DATE_CACHES — A maintenance procedure that refreshes the effective-date-sensitive caches. Its purpose is to invalidate or regenerate cached compensation object lists whose content depends on the current or a changed effective date. It carries no documented parameters, indicating it operates globally across the affected cache entries. This procedure supports keeping cached results consistent when effective-dated configuration changes or date-driven processing occurs.

Tables Accessed

The package reads and writes the following tables through APPS synonyms:

  • BEN_COMP_OBJ_CACHE_ROW — The compensation object cache table. This is the primary persistence target: POPULATE_COMP_OBJECT_LIST inserts or updates the resolved compensation object rows keyed to the cache identifier, business group, selection rule, and effective date. REFRESH_EFF_DATE_CACHES similarly manipulates rows in this table to keep effective-date-dependent entries current. This table is the reason the package exists — it exists to service, populate, and refresh this cache.
  • PLITBLM — The PL/SQL table (index-by table) type used within the BEN codebase for passing and manipulating collections in memory. Its reference indicates the procedure builds intermediate in-memory collections while assembling the compensation object list before writing results to BEN_COMP_OBJ_CACHE_ROW.

Usage Notes

This package is classified as an "OTHER" API, not a public supported API, and therefore is not intended for direct invocation by customer extensions. It is invoked internally by the Advanced Benefits engine. The ETRM metadata records that the package is referenced by three other packages, which is consistent with its role as a shared cache-population utility called from eligibility, rate, and compensation processing routines.

Typical invocation occurs during benefits open enrollment, life-event processing, and periodic benefit calculation runs, when the system must resolve compensation objects for participants over a range of dates. In those flows, POPULATE_COMP_OBJECT_LIST is called to build or extend the cache for a specific rule and effective date, and REFRESH_EFF_DATE_CACHES is called to keep cached results synchronized as effective dates advance or configuration is updated. The use of AUTHID CURRENT_USER means callers must have the necessary object privileges on the referenced BEN tables, which is normal for internal BEN runtime packages executing under APPS.

Because the specification is thin and the naming reveals cache-oriented behavior, the package should be treated as an internal performance optimization layer for compensation object resolution. Customizations that need compensation object results should query the BEN tables or call supported Advanced Benefits APIs rather than invoke this package directly, since its cache structures and refresh semantics are not part of the supported integration surface.