Search Results get_rank_level_shrt_name




Overview
Explore in AI Chat

Overview

BIS_PMV_PORTAL_UTIL_PUB is a public PL/SQL utility package in the APPS schema that supports Oracle EBS Portal and Performance Management Viewer (PMV) functionality. It provides shared helper routines used by the portal framework to resolve user-specific personalization settings, ranking parameters, time-level labels, and "as of" date values for KPI and PMV portlets. The package is declared with AUTHID CURRENT_USER, meaning its unqualified object references resolve against the invoking schema's privileges rather than the definer's. The source header (BISPPUTS.pls 120.0, dated 2005/06/01) and the dbdrv checkfile directive confirm it is an Applications technology stack object deployed and patched via AD utilities. Several procedures carry bug-fix annotations (for example, Bug 3573468 on CLEAN_PORTLETS), indicating ongoing maintenance within the EBS release stream common to 12.1.1 and 12.2.2.

Key Procedures and Functions

The documented API surface consists of seven callable units, several of which follow the standard EBS PL/SQL return-status convention (x_return_status, x_msg_count, x_msg_data out parameters):

  • GET_RANKING_PARAMETER — Returns the ranking parameter configured for a given portal page and user, used to drive how ranking-based portlets order and display data.
  • GET_TIME_LEVEL_LABEL — Returns the time-level label (for example, the period or calendar grain) associated with a page and user, driving time-based KPI display captions.
  • GETTIMELEVELLABEL — A function variant that returns the time-level label as a VARCHAR2 based on page, user, session, and function name; used where a direct return value is more convenient than OUT parameters.
  • GETASOFDATEANDLABEL — Resolves and returns the "as of" date together with its display label, used to timestamp KPI and PMV results.
  • GET_RANK_LEVEL_AND_NUM_VALUES — Returns the rank level and the number of ranking values for a page, user, and responsibility, supporting rank-based personalization.
  • CLEAN_PORTLETS — Removes or resets portlet personalization records based on user name, page ID, page name, or function name; introduced/updated under Bug 3573468 to allow targeted cleanup.
  • GET_RANK_LEVEL_SHRT_NAME — Returns the short name for a rank level, supporting KPI portlet personalization (annotated to KPI Portlet Personalization).

Tables Accessed

The package references the following objects through APPS synonyms:

  • AK_REGIONS and AK_REGION_ITEMS — Oracle Application Framework (OAF) region metadata used to map page/region context to personalization settings.
  • BIS_USER_ATTRIBUTES — Stores user-level personalization attributes for BIS/PMV portlets, the primary source for ranking, time-level, and as-of settings.
  • FND_FORM_FUNCTIONS — Resolves function names to function metadata, supporting function-scoped personalization and cleanup.
  • PLITBLM — The PL/SQL interlanguage message table used to fetch translated message text for return messages.
  • DUAL — Used for single-row evaluations and default-value resolution.

Usage Notes

BIS_PMV_PORTAL_UTIL_PUB is not an end-user-facing concurrent program; it is invoked programmatically. It is typically called from OAF-based portal pages, KPI/PMV portlet controllers, and JSP or PL/SQL region logic that renders personalized dashboards, and it may also be called from custom code that manages portlet personalization or performs administrative cleanup of stale portlet settings. The documented metadata records five other packages referencing this package, confirming it acts as a shared lower-level utility. Because it is classified as a PUB (public) API, it is intended to be called from outside its own package body and should be treated as the supported interface for retrieving ranking, time-level, and as-of personalization values on both EBS 12.1.1 and 12.2.2. Callers should always inspect x_return_status and the message stack before consuming returned values.