Results for “bsc_portlet_util”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

APPS.BSC_PORTLET_UTIL is a utility package body in the Oracle E-Business Suite Balanced Scorecard (BSC) module. Its primary business function is to resolve the runtime network endpoints that the application server must use when assembling and rendering portlet content and HTML fragments. Because portlets in the Balanced Scorecard are effectively embedded web components that reference JSP resources, images, and other HTML pieces hosted on the middle-tier, the package centralizes the logic needed to translate the server configuration stored in FND_WEB_CONFIG into usable host names, port numbers, and fully qualified URLs. It also provides supporting services such as decrypting stored plug information, obtaining HTML fragments for a portlet, realigning those HTML pieces, testing HTTPS availability, and reading arbitrary configuration values.

The package is classified as a utility (API classification UTIL) under the APPS schema, and the source header carries a version that places its last significant change around 2007, with an original creation history dated 2001. This long-lived footprint reflects its role as a stable, low-level helper relied upon across the Balanced Scorecard framework rather than as an end-user-facing API. The user's search fragment referencing "hostname" corresponds directly to the package's most prominent functions, which parse a web URL and extract the host name substring from it.

Key Procedures and Functions

• GET_JSP_SERVER — Returns the JSP host derived from the FND_WEB_CONFIG.JSP_AGENT setting. It parses the configured URL string by locating the double-slash and then the following slash, extracting the host portion. Example output form is a machine name such as ap100jvm.us.oracle.com. Returns null when JSP_AGENT is not configured.
• GET_WEBDB_HOST — Returns the WebDB/web server host from FND_WEB_CONFIG.WEB_SERVER. It skips the protocol prefix and, where present, trims at the colon that introduces the port; when no port is present it returns the remainder of the URL.
• GET_WEBDB_PORT — Returns the port component associated with the configured web server URL.
• GET_BSC_URL — Returns the Balanced Scorecard application URL used to build links and resource references.
• GET_BSC_JSP_PATH — Returns the JSP path portion for BSC resources, complementing the host resolution functions.
• GOTOMAINMENU — Builds or redirects to the Balanced Scorecard main menu location.
• UPDATE_PORTLET_NAME — Persists a change to a portlet's display name.
• DECRYPT_PLUG_INFO — Decrypts stored plug information, using UTL_RAW based operations, so portlet plug metadata can be read after being held in an obfuscated form.
• REQUEST_HTML_PIECES — Retrieves HTML fragments, typically by invoking outbound HTTP calls through UTL_HTTP, to obtain the markup to be embedded in a portlet page.
• RE_ALIGN_HTML_PIECES — Adjusts or realigns retrieved HTML fragments so they render consistently within the portlet container.
• TEST_HTTPS — Probes whether HTTPS connectivity is available, allowing callers to decide between secure and non-secure resource retrieval.
• GETVALUE — A generic helper that returns a configuration or attribute value used across the package.

Tables Accessed

• FND_WEB_CONFIG — Source of the JSP agent and web server URL values parsed by the host, port, URL, and JSP path functions.
• ICX_PAGE_PLUGS — Stores portlet plug definitions and page-level plug configuration; read to locate and resolve the plug information that the decrypt and HTML request routines operate on.
• PLITBLM — The PL/SQL integer table type used internally to pass collections of values, such as batches of HTML pieces, between routines.
• UTL_HTTP — Used to issue outbound HTTP requests when fetching HTML pieces from remote web resources.
• HTP — Used to generate or manipulate HTML output when assembling portlet content.
• UTL_RAW — Supports the binary/raw conversions needed by the decryption routine for plug information.
• V$INSTANCE — Read to identify the current database instance, typically to vary behavior or diagnostics by instance.

Usage Notes

BSC_PORTLET_UTIL is an internal framework utility rather than a directly invoked end-user interface. It is referenced by three other packages, which call it to resolve server endpoints and to obtain rendered HTML before composing the Balanced Scorecard portlet pages presented to users. Typical invocation therefore occurs during portlet page rendering in the middle tier, where the host and port helpers feed URL construction, and the request and realign functions fetch and normalize the HTML fragments embedded into the region. DECRYPT_PLUG_INFO and UPDATE_PORTLET_NAME are invoked when portlet plug metadata must be read or modified, and TEST_HTTPS is used as a capability probe before choosing secure transport. Because the functions depend on the FND_WEB_CONFIG settings, custom code that reuses GET_JSP_SERVER, GET_WEBDB_HOST, GET_WEBDB_PORT, GET_BSC_URL, or GET_BSC_JSP_PATH should ensure those configuration values are correctly maintained, since null or malformed settings will yield null or truncated host strings. The package is best treated as a helper library embedded in EBS Balanced Scorecard customization and extension work rather than as a standalone public API.