Search Results error_screen




Overview
Explore in AI Chat

Overview

APPS.ICX_ADMIN_SIG is a foundational PL/SQL package in the Oracle E-Business Suite (EBS) 12.1.1 and 12.2.2 technology stack that provides the server-side rendering and administrative scaffolding for Oracle iHelp and Self-Service application pages. Declared with AUTHID CURRENT_USER, the package executes with the privileges of its caller, allowing it to be invoked from within the Oracle Application Framework (OAF) runtime and from custom JSP or PL/SQL-generated HTML pages. Its core purpose is to emit the HTML, JavaScript, and help-window code required to present consistent Oracle EBS user interface chrome — headers, toolbars, footers, tables, and help links — and to standardize the display of error conditions to end users.

The package is classified under the ETRM "OTHER" API classification, signalling that it is an internal Oracle utility rather than a formally published, customer-facing integration API. Nevertheless, its procedures are referenced by 38 other packages across the EBS schema, making it a highly leveraged dependency for iHelp and Self-Service rendering.

Key Procedures and Functions

Thirteen documented procedures and functions are exposed by the package specification:

  • HELP_WIN_SCRIPT — Emits JavaScript into the header section of an HTML page so that help text can be launched in a separate browser window. It accepts a help target, an optional language code, and an application short name (defaulting to ICX) to resolve the correct iHelp content.
  • ICX_FND_HELP — Integrates the package's help rendering with the Oracle Foundation help subsystem so that the Global Menu help button resolves correctly under the OA framework.
  • HELP_WIN_SYNTAX — Generates the JavaScript call syntax associated with the help window mechanism.
  • BACKGROUND — Renders the background element of the page layout.
  • OPENHEADER, CLOSEHEADER, CLOSEHEADER2 — Manage the opening and closing markup of the page header region, including the variant closing behaviour required by different OAF layout beans.
  • TOOLBAR — Renders the toolbar region of a Self-Service page.
  • STARTOVER — Resets or restarts page rendering context.
  • FOOTER — Emits the standard page footer markup.
  • ERROR_SCREEN — Produces the standardized error display presented to users when a Self-Service page or help request fails; this is the procedure most directly associated with the error_screen search term.
  • SHOWTABLE, DISPLAYTABLE — Format and render tabular data within the generated HTML output.

Tables Accessed

The package reads and writes through APPS synonyms covering four documented objects:

  • FND_APPLICATION — Supplied so the package can validate the application_short_name argument and locate the product that owns the iHelp documentation.
  • ICX_SESSIONS — Provides session context, ensuring rendered pages and help lookups are scoped to the current user session.
  • HTF and HTP — The Oracle HTML toolkit packages used to generate tags and page markup.
  • OWA_UTIL — Supplies the PL/SQL web toolkit utilities underpinning HTTP output and HTML escaping.

Usage Notes

ICX_ADMIN_SIG is not intended for direct customer invocation. It is called internally by the Oracle Application Framework — notably by OAPageLayoutBean for the Global Menu help button — and by iHelp and Self-Service JSP/PLSQL pages that rely on its header, toolbar, footer, and error-rendering routines. The ERROR_SCREEN procedure is the documented entry point responsible for presenting failure conditions to users, and is the procedure most relevant when diagnosing error-screen rendering in 12.1.1 or 12.2.2. Because 38 packages depend on it, any custom code should treat the package as a read-only internal utility and avoid extensions that could disturb the shared rendering contract.