Search Results bis_html_utilities_pvt




Overview
Explore in AI Chat

Overview

APPS.BIS_HTML_UTILITIES_PVT is a private PL/SQL utility package in Oracle E-Business Suite that generates HTML banner markup for Oracle Forms-based and report-based user interfaces. The package was created to centralize the construction of standardized HTML page headers, or banners, that appear at the top of Self-Service and Business Intelligence System (BIS) style screens and reports. Its source header dates to 1999, and the implementation carries the AUTHID CURRENT_USER directive, meaning that the package executes with the privileges of the invoking schema rather than its owner, consistent with a private helper that is called from within the APPS execution context.

The package is classified as PVT (private) in the ETRM metadata, indicating it is not a public, supported API. It exists to support banner rendering for reports and forms rather than to expose a general-purpose interface to external customizations. The business value lies in consistent presentation: titles, image server references, menu links, related report icons, and translated text are assembled into a single HTML fragment that calling programs embed into their output.

Key Procedures and Functions

All fourteen documented program units share the name BUILD_HTML_BANNER, which is heavily overloaded across multiple signatures. These overloads fall into recurring functional patterns rather than a single entry point:

  • BUILD_HTML_BANNER (simple form) — accepts a title and a help target and returns or renders a basic banner, typically for a forms context.
  • BUILD_HTML_BANNER (report variants) — several overloads accept an RDF report filename, a title, and a menu link, with optional flags such as related_reports_exist and parameter_page. These support the standard report banner that offers navigation back to a menu and indicates the presence of related reports or a parameter page.
  • BUILD_HTML_BANNER (image/NLS variants) — additional overloads accept icx_report_images, more_info_directory, and nls_language_code, enabling the banner to resolve image locations and localized content.
  • BUILD_HTML_BANNER (icon_show variants) — overloads that take an icon_show boolean control whether the banner is generated with the standard two icons.

Several overloads return the generated markup through an OUT NOCOPY VARCHAR2 parameter, which minimizes copying overhead for the potentially large HTML string. Supporting functions documented in the package include GET_TRANSLATED_ICON_TEXT, which returns localized icon labels; GET_IMAGES_SERVER, which resolves the image server base; GET_NLS_LANGUAGE, which returns the current NLS language; and GET_IMAGE_FILE_STRUCTURE, which determines the directory layout for banner images.

Tables Accessed

The package reads from a small set of metadata sources through APPS synonyms:

  • FND_LANGUAGES — consulted to obtain installed and active language information that drives translated banner text.
  • NLS_SESSION_PARAMETERS — read to determine the current session language and territory, ensuring the banner renders in the user's language.
  • HTP — the PL/SQL HTML generation package, invoked to emit the banner markup rather than being queried as a table.

No write operations are indicated in the documented metadata; the package is a read-only rendering utility.

Usage Notes

BIS_HTML_UTILITIES_PVT is typically invoked internally by Oracle Forms and report-integration code that needs to produce a standard banner without duplicating HTML generation logic. Because it is a private package, direct invocation by customer customizations is not a supported practice; the supported extension points are the public APIs and the underlying report or form frameworks. The package is referenced by two other packages, confirming its role as a shared internal dependency rather than a top-level entry point. When troubleshooting banner rendering issues, the image server resolution, NLS language value, and image file structure are the usual points of investigation, since these determine whether icons and translated labels appear correctly in both 12.1.1 and 12.2.2 environments.