Search Results clean_string




Overview
Explore in AI Chat

Overview

BSC_PORTLET_UI_WRAPPER is an Oracle E-Business Suite PL/SQL package body owned by APPS and classified as a miscellaneous ("OTHER") API. It belongs to the Oracle Balanced Scorecard (BSC) product family and provides the server-side rendering and parameter-handling layer that supports the display of scorecard portlets, KPI graphs, and tabbed page regions inside the EBS user interface. The package abstracts the mechanics of HTML generation, URL encoding, custom view parameter assembly, and Oracle Web Toolkit (OWA/HTP) output so that the higher-level scorecard pages can request dynamically constructed markup and page parameters without duplicating that logic. In Oracle EBS 12.1.1 and 12.2.2 the package continues to be deployed under the APPS schema, and its function Encode_String is the routine most often located through the "encode_string" search term, since it is the entry point for escaping reserved characters before they are embedded in generated URLs and page fragments.

Key Procedures and Functions

  • ENCODE_STRING — Escapes reserved characters in a supplied string by replacing each match with an escape character followed by a mapped code letter. It is the core URL/parameter encoding utility used before values are written into generated links or HTML.
  • CLEAN_STRING — Removes enclosing single quotes and trims the supplied value, normalising strings passed in from the user interface or from portlet definitions.
  • GET_PAGE_PARAMS — Retrieves the parameter set associated with a user and a given page, returning the assembled parameters together with the standard return status, message count, and message data outputs.
  • GET_RANKING_PARAMETER — Supplies ranking-related parameters used when scorecard ranking visualisations are rendered.
  • VALIDATE_RESPONSIBILITY — Confirms that the current user is authorised, via responsibility, to view the requested scorecard content.
  • SHOW_INFO_PAGE — Renders an informational page within the portlet or scorecard region.
  • SHOW_CUSTOM_VIEW_IMAGE — Emits the image associated with a user-defined custom view.
  • APPLY_CUSTOMVIEW_PARAMETERS, APPLY_GRAPH_PARAMETERS, APPLY_KPI_LIST_PARAMETERS — Apply the respective sets of parameters to custom view, graph, and KPI list portlets so the correct data and presentation options are used.
  • CHECKUPDATECUSTVIEW — Checks whether a custom view requires updating before it is displayed.
  • GET_CUSTVIEW_MEASURE_NAME — Returns the measure name attached to a custom view, used for labelling and lookup purposes.

Tables Accessed

The package reads and writes scorecard configuration and user-interface metadata. BSC_SYS_IMAGES and BSC_TAB_VIEWS_B supply image and tab view definitions; BSC_USER_KPIGRAPH_PLUGS and BSC_USER_TAB_ACCESS hold user-specific graph plug-ins and tab access rights; FND_RESPONSIBILITY supports responsibility validation; ICX_PAGE_PLUGS_S and ICX_PORTLET_CUSTOMIZATIONS store portlet plug-in definitions and per-user portlet customisations; and DBMS_LOB, HTP, OWA_UTIL, PLITBLM, and WPG_DOCLOAD are used for LOB handling, HTML output, and document loading.

Usage Notes

The package is invoked server-side rather than through a form or concurrent program directly. It is called by scorecard portlet and dashboard pages during page rendering, and it is referenced by at least one other package in the ETRM inventory. Custom code that builds scorecard URLs or portlet links typically calls ENCODE_STRING before embedding parameter values, and developers troubleshooting malformed links or escaped characters should inspect this routine first. Because the encoding replaces only the reserved characters defined in its input parameters, callers must confirm that any additional special characters relevant to their target context are handled separately.