Search Results bsc_portlet_ui_wrapper




Overview
Explore in AI Chat

Overview

The APPS.BSC_PORTLET_UI_WRAPPER package is a PL/SQL construct within the Oracle E-Business Suite Balanced Scorecard (BSC) module. It is classified under the ETRM with an API classification of OTHER, meaning it is not a documented open interface or public API, but rather an internal wrapper utilized to render and manage the Scorecard portlet user interface within the Oracle Applications Framework (OAF) / portal environment.

Its primary business function is to act as a bridge between the underlying BSC data model and the Java-based or web-based portlet display layer. It manages the transformation of raw scorecard data into HTML that can be rendered in a portlet context, handles the validation of the user's responsibility for security purposes, processes customization parameters for graphs and KPI lists, and manages the display of images and information pages. The package contains 12 documented procedures and functions that support these UI rendering and parameter-passing activities.

Key Procedures and Functions

The package exposes the following documented routines, which fall into string handling, parameter management, security validation, and UI rendering categories:

  • ENCODE_STRING — Encodes a string value, typically for safe inclusion in HTML or URL output within the portlet display.
  • CLEAN_STRING — Sanitizes or cleans an input string, likely removing or escaping characters unsuitable for portlet rendering.
  • GET_PAGE_PARAMS — Retrieves page-level parameters passed to the portlet, used to configure the rendering context.
  • GET_RANKING_PARAMETER — Obtains the ranking parameter used to determine the ordering or ranking of scorecard elements.
  • VALIDATE_RESPONSIBILITY — Validates that the current user holds the appropriate responsibility to view or interact with the portlet content.
  • SHOW_INFO_PAGE — Renders an informational page to the user, typically used for help or status messages within the portlet.
  • SHOW_CUSTOM_VIEW_IMAGE — Displays a custom view image associated with a scorecard or KPI custom view.
  • APPLY_CUSTOMVIEW_PARAMETERS — Applies parameters specific to a custom view configuration to the rendering logic.
  • APPLY_GRAPH_PARAMETERS — Applies graph-specific parameters, controlling how graphical scorecard elements are displayed.
  • APPLY_KPI_LIST_PARAMETERS — Applies parameters governing the display of KPI lists within the portlet.
  • CHECKUPDATECUSTVIEW — Checks whether a custom view requires updating, likely comparing configuration or timestamp data.
  • GET_CUSTVIEW_MEASURE_NAME — Retrieves the measure name associated with a custom view, used for labeling and reporting.

Tables Accessed

The package accesses the following objects (referenced via APPS synonyms), each supporting a distinct aspect of portlet functionality:

Additionally, the package references DBMS_LOB, HTP, OWA_UTIL, PLITBLM, and WPG_DOCLOAD as supporting PL/SQL packages and utilities for LOB handling, HTML generation, and document loading.

Usage Notes

This package is an internal wrapper and is not intended for direct invocation by end users or external custom code. It is invoked indirectly through the Balanced Scorecard portlet framework, typically when a user accesses a scorecard portlet page within the Oracle Applications portal. The package's routines are called by the rendering layer to validate responsibilities, apply user customizations, and produce HTML output. It is referenced by the BSC_CAUSE_EFFECT_UI_WRAPPER package and is itself referenced by only one other package, indicating a narrow and specialized role within the BSC module. Customizations should target the underlying configuration tables rather than this package directly.