Search Results icx_portlet




Overview
Explore in AI Chat

Overview

The APPS.ICX_PORTLET package body implements the server-side portlet framework used by Oracle E-Business Suite's EBS homepage, the "Personal Home Page" (PHP) and related dashboard regions delivered through the Oracle Applications Framework (OAF) infrastructure. Its central purpose is to control whether a signed-on user is permitted to view a given portlet, to generate the bookmark and execution links that render portlets on the homepage, and to manage the caching layer that stores per-user and per-function portlet state. Access is governed by the standard EBS security model, so that a portlet is displayed only when the underlying function, responsibility, security group, and user-responsibility assignment authorize it. In the 12.1.1 and 12.2.2 code lines the object remains VALID and classified as an OTHER API, indicating it is primarily an internal runtime component rather than a formally published extension interface.

Key Procedures and Functions

The ETRM metadata documents 18 procedures and functions. They fall into three functional groups.

  • Security and session validation: RESPONSIBILITIES (retrieves the responsibilities available to the current user), VALIDATESESSIONPART1, VALIDATESESSIONPART2, and VALIDATESESSION (verify the user's session context), SSOREDIRECT (handles single sign-on redirection), and LISTENER_TOKEN (supports the listener/token mechanism used during portlet invocation).
  • Link generation: CREATEBOOKMARKLINK and CREATEFWKBOOKMARKLINK build bookmark URLs, while CREATEEXECLINK and CREATEEXECLINK2 build the execution links that run portlets.
  • Caching utilities: UPDCACHEBYUSER, UPDCACHEBYFUNCNAME, UPDATECACHEBYUSERFUNC, UPDCACHEKEYVALUEBYUSER, UPDCACHEKEYVALUEBYFUNCNAME, UPDATECACHEKEYVALUEBYUSERFUNC, UPDCACHEKEYVALUEBYPORTLETREF, and GET_CACHING_KEY maintain and retrieve cache entries scoped by user, function name, or both.

Parameter lists are not exposed in the metadata and should be confirmed from the deployed source before custom invocation.

Tables Accessed

The package reads the standard EBS security and configuration tables through APPS synonyms:

Database utilities DBMS_SQL, HTP, and OWA_UTIL are used for dynamic SQL and HTML/URL output generation.

Usage Notes

ICX_PORTLET is invoked internally by the EBS homepage and OAF portlet regions rather than by end users directly. It is referenced by nine other database objects, so changes carry downstream impact and the body should not be modified without an approved patch path. Typical invocation points are the Personal Home Page rendering cycle, bookmark/widget link actions, and portlet cache maintenance. Administrators use it indirectly when diagnosing why a portlet is hidden (responsibility/function/security group configuration) or when a portlet displays stale content (cache entries keyed by user and function). It is not a documented public API, so custom code should avoid depending on it; developers requiring portlet customization should use ICX_PORTLET_CUSTOMIZATIONS and supported OAF personalization features instead.