Search Results ben_plan_design_wizard_api




Overview
Explore in AI Chat

Overview

The APPS.BEN_PLAN_DESIGN_WIZARD_API package is a server-side PL/SQL API within the Oracle E-Business Suite Advanced Benefits (BEN) module. It supports the Plan Design Wizard, a guided configuration utility that enables benefits administrators to define, copy, and stage benefits plan structures and their associated routing and hierarchy metadata. The package is classified as an API and holds a VALID status in the APPS schema, confirming it is a supported, compiled database object in EBS 12.1.1 and 12.2.2.

Its principal business role is to orchestrate the movement of plan design data through the wizard's staging, copy, and result-processing phases. Rather than acting as a standalone end-user interface, the package functions as the transactional engine behind the Plan Design Wizard and its companion copy processes.

Key Procedures and Functions

ETRM 12.2.2 documents six procedures and functions within this package. Each serves a distinct role in the wizard workflow:

  • WRITE_ROUTE_AND_HIERARCHY — Persists routing and hierarchy information generated during plan design, establishing the structural relationships that govern how entities are organized.
  • UPDATE_RESULT_ROWS — Modifies the result rows produced by the copy or design process, reflecting processing outcomes and status changes.
  • DELETE_ENTITY — Removes an entity from the staged plan design, supporting cleanup and rework scenarios within the wizard.
  • PDW_SUBMIT_COPY_REQUEST — Submits the plan design wizard copy request, initiating the process that replicates an existing plan design into a new configuration.
  • REUSE_DELETED_HIERARCHY — Reinstates or reuses hierarchy data that was previously deleted, allowing administrators to recover prior structural definitions.

The sixth documented member is not itemized in the provided excerpt; the five above represent the primary public interface. Parameter lists are not published in the source metadata and are intentionally omitted here.

Tables Accessed

The package references three tables through APPS synonyms:

  • BEN_COPY_ENTITY_RESULTS — Stores the results of entity-level copy operations, which UPDATE_RESULT_ROWS writes to and maintains.
  • PQH_COPY_ENTITY_TXNS — Records copy transaction data within the Public Sector/HR (PQH) staging framework used to track entity replication.
  • PQH_TABLE_ROUTE — Holds routing definitions that determine how staged data is directed, consumed by WRITE_ROUTE_AND_HIERARCHY.

Usage Notes

This package is typically invoked indirectly. It is referenced by BEN_PLAN_DESIGN_COPY_PROCESS, the concurrent/processing program that drives plan design copying, and by PQH_GSP_STAGE_TO_BEN, which moves staged Public Sector data into Benefits. It also references itself, indicating internal recursive or helper calls. Custom code should treat this as an internal supporting API rather than a primary integration point; direct invocation is appropriate only when extending the Plan Design Wizard or the copy process. Because it participates in the copy and staging pipeline, it should be called with attention to concurrent processing order and transaction consistency.