Search Results icx_login




Overview
Explore in AI Chat

Overview

ICX_LOGIN is a PL/SQL package owned by the APPS schema in Oracle E-Business Suite, classified under the ETRM API classification "OTHER." Despite its name, which suggests a narrow authentication role, the package serves as a shared utility layer for the Oracle EBS self-service login and personalization framework — the same infrastructure that renders the login page, validates the authenticated session, and resolves the personalized home page presented to each user after sign-on. In EBS 12.1.1 and 12.2.2 the package header (ICXLOGIS.pls, version 120.1) remains stable and contains no public constants, exceptions, or type declarations; it exposes only four callable functions and no procedures, making it a compact, low-surface-area utility package. Its responsibilities span session validation, message resolution from the FND message dictionary, page identification for a given user, and HTML/JavaScript string sanitization for browser output. The package is a foundational element of the Oracle iSupport and self-service frameworks, where it underpins the behavior of the login flow and the subsequent rendering of personalized content. Because it sits beneath the self-service UI layer, failures here typically manifest as login-page errors, blank personalization regions, or incorrect message text rather than as business-transaction failures.

Key Procedures and Functions

  • validateSession — Accepts a session identifier and returns a numeric status indicating whether that session is currently valid. It is the canonical check used by self-service pages to confirm that a user's authenticated session has not expired or been invalidated before privileged content is rendered.
  • get_fnd_message — Retrieves message text from the Oracle Application Object Library message dictionary. It accepts an application code and message name, and optionally a token name and token value for substitution, returning the resolved message string. This allows self-service pages to display translatable, centrally maintained messages rather than hard-coded literals.
  • get_page_id — Accepts a user identifier and returns the page identifier associated with that user, used to determine which personalized page or landing content should be presented after login.
  • replace_onMouseOver_quotes — Sanitizes a string by replacing quotation characters used in onMouseOver event attributes, taking the target browser into account. This prevents malformed HTML and script-injection issues when page content is emitted to different browser families.

Tables Accessed

The package reads and writes through APPS synonyms across two functional areas. The self-service page framework is represented by ICX_PAGES, ICX_PAGES_S, ICX_PAGE_COLOR_SCHEME, ICX_PAGE_PLUGS, and ICX_PAGE_PLUGS_S; these store page definitions, their translation rows, the color scheme assigned to a page, and the plug (region) definitions and translations that populate a page. The Oracle Application Object Library is represented by FND_FORM_FUNCTIONS and FND_MENU_ENTRIES, which provide the function and menu metadata required to resolve navigation and security context during login. The message dictionary lookup performed by get_fnd_message relies on the underlying FND message tables that back the message dictionary API.

Usage Notes

ICX_LOGIN is invoked indirectly through the Oracle EBS self-service login and personalization stack rather than by end users directly. It is referenced by the JSP and PL/SQL components that render the login page and the personalized home page after authentication, and it may be called from custom self-service code that needs to validate a session or resolve a message. In 12.1.1 and 12.2.2 the package is not referenced by any other package, so its callers are external — chiefly self-service JSPs, page-rendering PL/SQL, and custom extensions. Custom developers invoking it should respect the return-type contracts: numeric status from validateSession and get_page_id, and a string from get_fnd_message and replace_onMouseOver_quotes, with the message and token parameters being optional. Because it is an APPS-owned package with no documented public types, custom code should depend only on the four functions listed in the header rather than on internal package state, which is not part of the public contract.