Results for “ben_copy_entity_results_api”

50+ results




AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

BEN_COPY_ENTITY_RESULTS_API is a public PL/SQL package owned by the APPS schema that supports the Oracle Advanced Benefits copy-entity processing framework. Its purpose is to manage the results generated when a copy operation is executed against a benefits entity, such as a program, plan, plan type, option, or eligibility configuration. When a user or concurrent process duplicates a benefits setup object, the system must record which entities were created, updated, or skipped as part of that copy. BEN_COPY_ENTITY_RESULTS_API provides the programmatic interface for creating, maintaining, and removing these result records, thereby giving the benefits engine an auditable trail of copy activity.

The package depends on HR_API and the SYS STANDARD package, and it operates in close coordination with the broader Benefits Plan Design and Public Sector (PQH) staging and routing modules. In the EBS 12.1.1 and 12.2.2 releases, it is classified as an API, meaning it is intended for programmatic invocation rather than direct end-user interaction.

Key Procedures and Functions

The documented interface exposes three procedures, one for each standard data-maintenance operation:

  • CREATE_COPY_ENTITY_RESULTS — Inserts a new copy-entity result record, capturing the outcome of copying a benefits entity so that subsequent processing stages can reference the generated result.
  • UPDATE_COPY_ENTITY_RESULTS — Modifies an existing copy-entity result record, allowing status or attribute changes to be persisted after the initial creation.
  • DELETE_COPY_ENTITY_RESULTS — Removes a copy-entity result record, typically used when a copy operation is rolled back or its intermediate results must be purged.

Parameter lists are not documented in the available metadata and should not be assumed. Each procedure follows Oracle EBS API conventions, and callers should consult the package specification in the target instance for exact signatures.

Tables Accessed

The package operates against two documented tables via APPS synonyms:

  • BEN_COPY_ENTITY_RESULTS — The primary transactional table storing the results of copy-entity operations. This is the table written by CREATE, modified by UPDATE, and purged by DELETE.
  • PQH_TABLE_ROUTE — A Public Sector table-routing structure used to direct processing across source and staging environments. Its involvement reflects the package's role in copy operations that span staging and production benefits data.

Usage Notes

BEN_COPY_ENTITY_RESULTS_API is not invoked directly by end users. It is called by higher-level benefits modules during copy processing. The dependency metadata confirms that it is referenced by fifteen other packages, including BEN_PDW_COPY_BEN_TO_STG, BEN_PD_RATE_AND_CVG_MODULE, BEN_PLAN_DESIGN_ELPRO_MODULE, BEN_PLAN_DESIGN_PLAN_MODULE, BEN_PLAN_DESIGN_PROGRAM_MODULE, BEN_PLAN_DESIGN_TXNS_API, and the PQH staging and routing utilities such as PQH_CORPS_UTILITY, PQH_CPD_HR_TO_STAGE, PQH_GSP_HR_TO_STAGE, PQH_GSP_PRGRULES, PQH_RBC_STAGE, and PQH_RBC_UTILITY. These callers rely on the API to persist and reconcile copy results as benefits configuration is duplicated between environments. Because it modifies core Benefits data, custom code should invoke it only within the supported copy workflow and after validating business prerequisites, and any direct use should be tested carefully in non-production instances first.