Search Results retrieve_page_parameter
Overview
BIS_PMV_PARAMETERS_PUB is a public PL/SQL package in the APPS schema that forms part of the Oracle Business Intelligence System (BIS) infrastructure, specifically the Page Metadata and View (PMV) layer used by Oracle EBS self-service applications. Its principal business function is to resolve, persist, and retrieve the runtime parameters that govern how a personalized or customized page is rendered and queried within Oracle Applications Framework (OAF) and related personalization frameworks.
In Oracle EBS 12.1.1 and 12.2.2, the PMV layer sits beneath the presentation tier and mediates between the definition of a page (including its customizations and user-level personalizations) and the data retrieval performed at runtime. BIS_PMV_PARAMETERS_PUB provides the programmatic entry points by which callers obtain parameter values and query-type definitions for a given page context, and by which they reset user personalization state. The package is classified as a PUB (public) API, indicating that it constitutes a supported interface for other components rather than an internal helper.
Key Procedures and Functions
The documented interface comprises five procedures and functions:
- RETRIEVE_PAGE_PARAMETER — Returns a single named parameter value associated with a page, used when a caller requires one specific parameter rather than the complete set.
- RETRIEVE_PAGE_PARAMETERS — Returns the full collection of parameters for a page, typically the primary entry point for rendering or query construction logic.
- INITIALIZE_QUERY_TYPE — Establishes the query type context for the page, determining how subsequent parameter resolution and data retrieval behave.
- CLEAR_USER_PERSONALIZATION — Removes or resets user-level personalization settings, restoring the page to its default or administrator-defined state.
- INITIALIZE_BIS_BUCKET_REC — Initializes the BIS bucket record structure (BIS_BUCKET_REC) used to hold parameter and query context data for downstream processing.
No parameter lists are documented in the ETRM metadata for these routines; callers should consult the package specification and the ETRM dependency report for exact signatures.
Tables Accessed
The package operates against the AK personalization and customization schema, supplemented by BIS-specific objects:
- AK_CUSTOMIZATIONS — Stores customizations applied to pages and regions, consulted when resolving effective parameter values.
- AK_CUSTOM_REGIONS and AK_CUSTOM_REGIONS_TL — Define customized regions and their translated descriptions.
- AK_CUSTOM_REGION_ITEMS and AK_CUSTOM_REGION_ITEMS_TL — Define the individual items within custom regions, along with translations.
- BIS_AK_CUSTOM_REGIONS — The BIS-specific view or table over AK custom regions used within the BI page framework.
- BIS_USER_ATTRIBUTES — Holds per-user attribute values that influence parameter resolution and personalization.
The package also references BIS_QUERY_ATTRIBUTES, FND_API, FND_MSG_PUB, AK_CUSTOMIZATIONS_PKG, and the BIS_BUCKET_REC structure type. FND_API and FND_MSG_PUB indicate that the package follows the standard EBS API error-handling and message-stack conventions.
Usage Notes
BIS_PMV_PARAMETERS_PUB is not referenced by any database object, meaning it is an entry-point API rather than a utility invoked internally by other PL/SQL units; its callers are external. In practice it is invoked from Oracle Applications Framework pages and the BIS page metadata engine during page initialization, when the framework must determine the effective parameter set, query type, and personalization state before executing a query. The INITIALIZE_QUERY_TYPE and INITIALIZE_BIS_BUCKET_REC routines are called early in the page lifecycle to seed context, while RETRIEVE_PAGE_PARAMETER and RETRIEVE_PAGE_PARAMETERS populate the runtime parameter map. CLEAR_USER_PERSONALIZATION is invoked from personalization administration flows or user preference actions that reset page behavior.
Custom extensions that interact with OAF personalization or BIS reporting pages may call this package directly, but because it is a PUB API and part of the standard BIS layer, direct modification is not supported. Developers should treat it as read-oriented and invoke it within the same session context as the calling page. The dependency on FND_MSG_PUB means callers should check the message stack after invocation.
-
PACKAGE BODY: APPS.BIS_PMV_PARAMETERS_PUB
12.1.1
-
PACKAGE: APPS.BIS_PMV_PARAMETERS_PUB
12.1.1
-
APPS.BIS_PMV_PARAMETERS_PUB dependencies on BIS_PMV_PARAMETERS_PUB
12.1.1
-
PACKAGE: APPS.BIS_PMV_PARAMETERS_PVT
12.1.1
-
PACKAGE BODY: APPS.BIS_PMV_PARAMETERS_PVT
12.1.1
-
APPS.BIS_PMV_PARAMETERS_PVT dependencies on BISVIEWER
12.1.1
-
APPS.BIS_PMV_PARAMETERS_PUB dependencies on FND_MSG_PUB
12.1.1
-
APPS.BIS_PMV_PARAMETERS_PVT dependencies on BIS_PMV_PARAMETERS_PVT
12.1.1
-
APPS.BIS_PMV_PARAMETERS_PVT dependencies on BIS_PMV_SESSION_PVT
12.1.1
-
APPS.BIS_PMV_PARAMETERS_PUB dependencies on FND_API
12.1.1
-
APPS.BIS_PMV_PARAMETERS_PVT dependencies on BIS_PMV_SESSION_PVT
12.1.1
-
APPS.BIS_PMV_PARAMETERS_PVT dependencies on FND_MSG_PUB
12.1.1
-
APPS.BIS_PMV_PARAMETERS_PVT dependencies on BISVIEWER
12.1.1
-
APPS.BIS_PMV_PARAMETERS_PVT dependencies on FND_API
12.1.1