Search Results icx_fnd_help

Overview

ICX_ADMIN_SIG is an Oracle E-Business Suite PL/SQL package owned by APPS and classified as an OTHER API within the ETRM repository. It belongs to the ICX (Oracle iProcurement / Self-Service) product family and provides server-side rendering and JavaScript generation utilities used by Oracle's self-service HTML pages. Its most frequently referenced entry point, HELP_WIN_SCRIPT, is the procedure a developer calls from the header section of an HTML page to emit the JavaScript code required to open iHelp documentation in a separate browser window, preserving context for the currently displayed Self Service application page.

The package is part of the legacy JTT/HTML toolkit lineage (the "SIG" naming convention shared with ICX_FND_SIG and similar packages). It is declared AUTHID CURRENT_USER, meaning it executes with the privileges of the calling schema rather than the owner. The header comment identifies its original authoring context as far back as 2005, and it remains present in both 12.1.1 and 12.2.2 environments, where the OAF-based framework still invokes it for the Global Menu help button.

Key Procedures and Functions

• HELP_WIN_SCRIPT — The primary documented procedure (and the term the user searched for). It inserts JavaScript into an HTML page header so that the user can invoke a help window. It accepts a definition/help target (defHlp) identifying the Self Service page, an optional language_code overriding the user's session language preference, and an application_short_name defaulting to 'ICX' that tells iHelp which product owns the staged documentation. If content is missing for the target and language, the user is presented with the list of languages in which the target does exist.
• ICX_FND_HELP — Help integration routine bridging the ICX layer to FND help infrastructure.
• HELP_WIN_SYNTAX — Generates or describes the JavaScript syntax required for the help window invocation.
• BACKGROUND — Emits the page background markup.
• OPENHEADER / CLOSEHEADER / CLOSEHEADER2 — Open and close the HTML document header and related structural elements.
• TOOLBAR — Renders the standard toolbar region.
• STARTOVER — Resets output state for a new page render.
• FOOTER — Emits the page footer.
• ERROR_SCREEN — Renders a standardized error page.
• SHOWTABLE / DISPLAYTABLE — Render tabular data in the HTML output stream.

Tables Accessed

• FND_APPLICATION — Resolves application_short_name to the owning product, which determines where the iHelp target is staged.
• ICX_SESSIONS — Provides session context, including the user's current language preference and Self Service session state.
• HTF / HTP — Oracle's HTML generation packages, used to produce the markup and script emitted by the render procedures.
• OWA_UTIL — Supplies web utility routines for output and URL handling.

All of these are referenced through APPS synonyms, consistent with the package's AUTHID CURRENT_USER declaration.

Usage Notes

HELP_WIN_SCRIPT is intended to be called from the header section of a Self Service HTML page, before the help link is rendered, so that the generated JavaScript is available when the user clicks the help button. In the OAF stack, OAPageLayoutBean calls this API to implement the Global Menu help button; the header comment notes that this was necessary because the JDBC setBoolean API does not work with Oracle and fnd_help.get_url could not be used directly with the helpsystem parameter set.

The package may be invoked from custom JSP/HTML pages, from PL/SQL-based self-service screens, and indirectly from OAF pages. When extending or troubleshooting help behavior, developers should supply a valid defHlp target and allow language_code to default so the user's language preference is honored. Because the package is referenced by 38 other packages, modifications carry broad impact and should be regression-tested across help-enabled pages in both 12.1.1 and 12.2.2.