Search Results ben_elig_cvrd_dpnt_api




Overview
Explore in AI Chat

Overview

BEN_ELIG_CVRD_DPNT_API is a PL/SQL application programming interface package owned by the APPS schema in Oracle E-Business Suite (validated against 12.1.1 and 12.2.2). It supports the Benefits module's dependent eligibility processing, specifically maintaining the records that determine which dependents and beneficiaries are eligible to be covered under a given program, plan, or plan option. Its name derives from the underlying entity "Eligible Covered Dependent," and the package acts as the controlled entry point through which eligibility and enrollment logic creates, modifies, and removes those eligibility records rather than manipulating the base tables directly. It is classified as an API in the ETRM metadata and depends upon the HR_API package and standard SYS constructs.

Key Procedures and Functions

The documented interface exposes ten procedures and functions. Their names and intended purposes are as follows.

  • CREATE_ELIG_CVRD_DPNT — Creates a new eligible covered dependent record for a participant, capturing the eligibility determination produced by the Benefits engine.
  • UPDATE_ELIG_CVRD_DPNT — Modifies an existing eligible covered dependent record, preserving the API's validation and audit conventions.
  • DELETE_ELIG_CVRD_DPNT — Removes an eligible covered dependent record when eligibility ends or the record is superseded.
  • LCK — A locking routine used to serialize concurrent access to an eligible covered dependent record during transactional processing.
  • DPNT_ACTN_ITEMS — Handles dependent action items associated with the eligibility record, driving the workflow of required dependent-related activities.
  • DPNT_ACTN_ITEMS_W — The "W" variant of the dependent action items routine, providing the same processing in a different context (commonly invoked within the Web/self-service layer).
  • ADD_USAGE — Registers or increments usage against an eligible covered dependent, typically for plan capacity or benefit allocation tracking.
  • REMOVE_USAGE — Reverses or decrements usage previously recorded against an eligible covered dependent.
  • CHK_MAX_NUM_DPNT_FOR_PEN — Validates whether the maximum permitted number of dependents has been reached for a given participant or benefit offering.

No parameter signatures are documented in the ETRM excerpt, and callers should obtain the exact interface from the Oracle-published API documentation before invoking these routines.

Tables Accessed

The package reads and writes benefits eligibility and enrollment data through APPS synonyms. The core eligibility entity is BEN_ELIG_CVRD_DPNT_F, supplemented by configuration and definition tables including BEN_DSGN_RQMT_F, BEN_DSGN_RQMT_RLSHP_TYP, BEN_OIPL_F, BEN_OPT_F, BEN_PL_F, and BEN_CVRD_DPNT_CTFN_PRVDD_F. Enrollment activity is captured in BEN_PRTT_ENRT_ACTN_F and BEN_PRTT_ENRT_RSLT_F, while BEN_PER_IN_LER and BEN_PRMRY_CARE_PRVDR_F supply participant and primary-care provider context. Person data is drawn from PER_ALL_PEOPLE_F, PER_CONTACT_RELATIONSHIPS, PER_PERSON_TYPES, and PER_PERSON_TYPE_USAGES_F.

Usage Notes

BEN_ELIG_CVRD_DPNT_API is referenced by fifteen other packages, including BEN_DETERMINE_DPNT_ELIGIBILITY, BEN_ELECTION_INFORMATION, BEN_ENROLLMENT_PROCESS, BEN_MAINTAIN_DESIGNEE_ELIG, BEN_SSPNDD_ENROLLMENT, and BEN_PRTT_ENRT_RESULT_API. It is also invoked by the HRDPP_CREATE_ELIG_CVRD_DPNT, HRDPP_UPDATE_ELIG_CVRD_DPNT, and HRDPP_DELETE_ELIG_CVRD_DPNT data pump routines, indicating that it participates in bulk migration and setup loading. Custom code and Oracle forms should call these documented procedures rather than writing directly to BEN_ELIG_CVRD_DPNT_F, ensuring that eligibility rules, usage counters, and person relationship validation remain consistent. Because the package relies on HR_API and interacts with person-type usages, callers must ensure the effective-dated person records are committed before invocation.