Search Results update_portlet_name




Overview
Explore in AI Chat

Overview

APPS.BSC_PORTLET_UTIL is a utility package within the Oracle E-Business Suite Balanced Scorecard (BSC) module. It provides a centralized library of helper routines used to render, retrieve, and manage portlet content within the BSC dashboard framework. The package abstracts the mechanics of communicating with the JSP/WebDB tier, decrypting portlet session information, and assembling HTML fragments returned from remote HTTP calls. A large portion of its design is dedicated to the manipulation of UTL_HTTP.HTML_PIECES collections, the PL/SQL data type used by Oracle's HTTP utility to return multi-part web responses. The package exposes a set of named constants for return codes (success, error, session expiry, no-row) and for internal parameter and message keys, which allows callers to interpret results consistently. Because the source header indicates a 2005 copyright, the package is a long-standing component that has been carried forward through the 12.1.1 and 12.2.2 releases to support the portlet rendering pipeline.

Key Procedures and Functions

The documented API surface covers configuration lookup, URL construction, navigation, and content assembly.

  • GET_JSP_SERVER / GET_WEBDB_HOST / GET_WEBDB_PORT — return the JSP server name, WebDB host, and WebDB port respectively, providing the connection endpoints for portlet calls.
  • GET_BSC_URL — builds a fully qualified Balanced Scorecard URL from a session identifier, plug identifier, JSP name, extra parameters, and a flag controlling whether the responsibility ID is included.
  • GET_BSC_JSP_PATH — returns the base JSP path used when constructing BSC portlet URLs.
  • GOTOMAINMENU — redirects the caller to the main menu, using a cookie value and an encrypted plug identifier for authentication context.
  • UPDATE_PORTLET_NAME — updates the stored display name of a portlet for a given user and plug identifier.
  • DECRYPT_PLUG_INFO — decrypts an encrypted plug identifier and returns the associated session ID and plug ID as output parameters.
  • REQUEST_HTML_PIECES — issues an HTTP request against a supplied URL (with an optional proxy) and returns the response as a UTL_HTTP.HTML_PIECES collection.
  • RE_ALIGN_HTML_PIECES — the routine most relevant to the search term. It accepts an HTML_PIECES collection and returns a re-aligned collection, normalizing or re-chunking the HTML fragments so that downstream consumers receive well-formed, consistently segmented content. This is typically necessary because HTTP responses arrive in arbitrary buffer boundaries that do not correspond to meaningful HTML units.
  • TEST_HTTPS — a diagnostic procedure used to validate HTTPS connectivity against a supplied URL.
  • GETVALUE — a general-purpose accessor used to retrieve configuration or session values.

Tables Accessed

The package reads ICX_PAGE_PLUGS through its APPS synonym to resolve portlet and plug definitions, which links a plug identifier to its display attributes, including the name maintained by UPDATE_PORTLET_NAME. V$INSTANCE is queried to identify the current database instance, supporting environment detection. PLITBLM is used for PL/SQL message lookup related to the defined message names and texts. The remaining referenced objects — UTL_HTTP, HTP, and UTL_RAW — are PL/SQL-supplied packages used for HTTP transport, HTML generation, and raw encryption/decryption handling rather than application tables.

Usage Notes

BSC_PORTLET_UTIL is invoked from the Balanced Scorecard portlet rendering flow, where the JSP tier calls back into the database to fetch and assemble portlet HTML. It is referenced by three other packages, indicating it functions as a shared dependency rather than an entry-point API. Customizations that extend BSC dashboards or embed portlets should use REQUEST_HTML_PIECES together with RE_ALIGN_HTML_PIECES to retrieve and normalize remote content before display. Because the package depends on WebDB/JSP host and port settings, deployments must ensure those values resolve correctly in the target environment; TEST_HTTPS is the appropriate verification tool. Routine maintenance should treat the package as Oracle-owned and avoid direct modification, instead extending behavior through supported configuration or wrapping calls in custom code.