Search Results update_region

Overview

The APPS.BIS_PMV_REGION_PVT package is the private PL/SQL API that governs the lifecycle of "Region" definitions used within Oracle EBS Business Intelligence / Daily Business Intelligence reporting. Regions are logical groupings that organize report content (such as KPI folders, dashboard sections, or report regions) into a navigable hierarchy on the reporting portal. By providing a controlled, API-based interface for creating, modifying, and removing these region definitions, the package isolates the underlying tables from direct manipulation and enforces validation, multi-lingual (MLS) integrity, and message-stack conventions expected by the EBS framework.

The package is classified as PVT (private), meaning it is not intended as a public extension point. Its companion public interface is BIS_AK_REGION_PUB, which defines the record type (Bis_Region_Rec_Type) shared between the two packages. The private layer performs the actual data manipulation while the public layer exposes supported entry points.

The header identifies the module as "Private API for Region" and dates the original creation to 2002–2004. The package body resides in BISVREPS.pls and is owned by APPS.

Key Procedures and Functions

The package exposes three documented procedures, all following the standard EBS API error-handling signature (a return status, a message count, and a message data buffer):

• CREATE_REGION — Inserts a new region definition. It accepts a region record (Bis_Region_Rec_Type), a commit flag, and standard OUT parameters for status and messages. Used when a new report region is introduced.
• UPDATE_REGION — Modifies an existing region record. It consumes the same region record structure as CREATE_REGION, allowing attribute changes such as name, description, or display configuration.
• DELETE_REGION — Removes a region definition identified by p_Region_Code and p_Region_Application_Id. Because a region belongs to a specific application, deletion is scoped by both the region code and the owning application ID, preventing accidental cross-application removal.

The procedures use NOCOPY hints on OUT parameters for performance and derive their default commit behavior from FND_API.G_TRUE.

Tables Accessed

The provided ETRM metadata does not enumerate specific base tables; the package operates via APPS synonyms. Based on the API's purpose, the procedures write to the underlying BIS region repository tables, which store region metadata. DELETE_REGION performs a physical or logical removal within that repository. Because the API is MLS-aware, it may also interact with translation tables associated with region names and descriptions. Any direct dependence on specific table names should be confirmed through the package body, as the ETRM excerpt lists no explicit synonyms.

Usage Notes

As a private API, BIS_PMV_REGION_PVT is normally invoked indirectly. Callers should use the public wrapper BIS_AK_REGION_PUB for region maintenance, which forwards requests to this private layer. The package is referenced by one other package, confirming its role as an internal implementation detail.

Typical invocation scenarios include:

• Concurrent programs or setup screens that provision report regions.
• Administrative OAF/Forms pages for BI configuration that need to add or retire a region.
• Custom code where a region lifecycle change must occur transactionally as part of a larger integration.

When calling DELETE_REGION from custom code, always pass both the region code and the correct application ID, and inspect x_return_status (comparing against FND_API.G_RET_STS_SUCCESS) before committing. Because the API honors p_commit, passing FND_API.G_FALSE permits the caller to control transaction boundaries. Direct DML against the region tables bypasses the validations enforced by this package and is not recommended.