Search Results view_by_type




Overview
Explore in AI Chat

Overview

BIS_PMV_PARAMETERS_PUB is a public PL/SQL package owned by APPS that forms part of the Oracle E-Business Suite Business Intelligence System (BIS) framework, specifically the Page Metadata Viewer (PMV) subsystem. The package provides the runtime API through which Oracle EBS forms and page-based applications persist, retrieve, and format the user-entered parameter values associated with a page view session. Its central responsibility is to reconcile the declarative parameter definitions registered in the AK (Application Kit) customization and region repository with the concrete values submitted by an end user at runtime, returning those values in a normalized record structure suitable for constructing the query executed by the underlying page.

The package is declared with AUTHID CURRENT_USER, so all referenced objects are resolved under the privileges of the invoking session rather than the package owner. It exposes five documented entry points and is referenced by 279 other packages, which makes it a foundational dependency within the BIS page rendering stack rather than a leaf-level utility.

Key Procedures and Functions

  • RETRIEVE_PAGE_PARAMETER — Retrieves the definition and resolved value of a single page parameter. It accepts a page session record and returns a parameter record through an IN OUT NOCOPY parameter, together with the standard FND message stack outputs (return status, message count, and message data).
  • RETRIEVE_PAGE_PARAMETERS — The bulk counterpart to the above. Given a page session record, it returns a PL/SQL associative array of parameter records indexed by BINARY_INTEGER, populated with all parameters defined for the page. This is the primary entry point used when a page must render or evaluate its full parameter set.
  • INITIALIZE_QUERY_TYPE — A function that returns a BIS_QUERY_ATTRIBUTES structure. Despite the name commonly reported by callers, it is a function rather than a procedure, and it initializes the query attribute descriptor used downstream when the page parameter values are translated into a query definition. The name is frequently encountered because callers search for it when diagnosing page query initialization errors.
  • CLEAR_USER_PERSONALIZATION — Removes persisted user-level personalization for page parameters, restoring the delivered/default state.
  • INITIALIZE_BIS_BUCKET_REC — Initializes the BIS bucket record structure used by the page framework, providing default bucket metadata before values are bound.

The package also declares a rich set of typed constants — including bind-type indicators (INTEGER_BIND, VARCHAR2_BIND, DATE_BIND, NUMERIC_BIND, CHARACTER_BIND, MESSAGE_BIND) and type discriminators (BIND_TYPE, SQL_STRING_TYPE, VIEW_BY_TYPE) — along with the page_session_rec_type and parameter_rec_type record definitions and the parameter_tbl_type collection type. Rather than accepting a long list of scalar parameters, the public procedures exchange data through these strongly typed records.

Tables Accessed

The package reads the AK customization metadata tables — AK_CUSTOMIZATIONS, AK_CUSTOM_REGIONS, AK_CUSTOM_REGIONS_TL, AK_CUSTOM_REGION_ITEMS, and AK_CUSTOM_REGION_ITEMS_TL — to resolve parameter labels, descriptions, required flags, default flags, hierarchy flags, dimensions, and operators. The translated tables supply language-specific text. BIS_AK_CUSTOM_REGIONS provides the BIS-specific view of region metadata, and BIS_USER_ATTRIBUTES stores and retrieves saved user personalization values and defaults. All access is performed through APPS synonyms.

Usage Notes

BIS_PMV_PARAMETERS_PUB is invoked at runtime from the BIS/Oracle Marketing and interactive page framework whenever a page with user-defined parameters is initialized, refreshed, or personalized. Custom code should call RETRIEVE_PAGE_PARAMETERS to obtain a full parameter set and RETRIEVE_PAGE_PARAMETER for point lookups, always checking x_return_status and consuming the message stack on failure. The package is versioned in the ETRM at 12.1.1 and is documented for 12.2.2 as well; the IN OUT NOCOPY and AUTHID CURRENT_USER conventions are consistent across both releases. Developers extending pages should avoid direct DML against the AK and BIS tables and instead rely on these public APIs to preserve framework integrity.