Search Results add_region

Overview

ICX_API_REGION is an internal PL/SQL package in the APPS schema that provides the programmatic interface for creating, editing, and deleting regions within Oracle E-Business Suite page layouts. Regions are the structural building blocks of self-service and portal-style pages: a main region anchors a layout, and child regions can be split horizontally or vertically, stacked, or used to host portlets and navigational widgets. The package header declares AUTHID CURRENT_USER, so it executes with the privileges of the calling user, and the source header shows it originated in the Oracle iLearning/Interaction Center (ICX) family of page-rendering APIs.

In releases 12.1.1 and 12.2.2 the package remains classified as OTHER and is scoped Internal, meaning Oracle does not publish it as a supported extension point. It is nonetheless the mechanism that the page-definition layer relies upon when region metadata must be written or read directly rather than through the administrative UI. Its central design constraint is the parent/child model: every region either descends from another region or is the root region, identified by the constant MAIN_REGION (parent id 0).

The package exposes a rich set of named constants for split modes, portlet flow, alignment, and width restriction, plus a REGION_VALIDATION_EXCEPTION, REGION_EXECUTION_EXCEPTION, REGION_SECURITY_EXCEPTION, and REGION_NOT_FOUND_EXCEPTION. A region_record type and region_table collection type allow region attributes to be passed and returned as structured data.

Key Procedures and Functions

The ETRM metadata documents eleven callable units. Descriptions below reflect their documented purpose; parameter lists are intentionally not reproduced.

• CREATE_MAIN_REGION — Creates the first (root) region of a layout, the region whose parent is set to MAIN_REGION, and returns the new region id.
• ADD_REGION — Attaches a new child region beneath an existing parent, which is the operation users most commonly associate with the "add_region" search term.
• SPLIT_REGION — Divides an existing region using one of the split-mode constants (REGION_NOT_SPLIT, REGION_HORIZONTAL_SPLIT, or REGION_VERTICAL_SPLIT).
• EDIT_REGION — Modifies the stored attributes of an existing region, such as its height, width, border, alignment, or portlet flow.
• DELETE_REGION — Removes a single region from the layout.
• DELETE_REGIONS — Removes a set of regions, supporting bulk cleanup of a branch or layout.
• GET_REGION — Retrieves a region's attributes, typically as a region_record.
• GET_MAIN_REGION_RECORD — Returns the root region for a given layout.
• GET_CHILD_REGION_LIST — Returns the child regions belonging to a parent region.
• COPY_REGION_PLUGS — Duplicates the page plugs (content slots) attached to a region.
• COPY_CHILD_REGIONS — Duplicates an entire child-region subtree, used when copying page structures.

Tables Accessed

The package reads and writes the following objects through APPS synonyms:

• ICX_REGIONS — The primary region definition table; holds region id, parent region id, split mode, portlet alignment and flow, height, width, width restriction, navigational widget id, and border attributes.
• ICX_REGIONS_S — The translated (TL) companion of ICX_REGIONS, storing language-specific region text.
• ICX_PAGE_PLUGS — The page plug table that associates content or portlet instances with a region; manipulated by COPY_REGION_PLUGS.
• ICX_PAGE_PLUGS_S — The translated companion of ICX_PAGE_PLUGS.
• DUAL — Used for simple scalar lookups and constant evaluation.
• HTP — The PL/SQL web toolkit package used to emit HTML when regions are rendered.

Usage Notes

ICX_API_REGION is an internal API. It is not published in the Oracle EBS Integration Repository as a supported public interface, and Oracle documentation recommends against direct invocation from customer code. In practice it is called by the page-definition and personalization layers of self-service applications, and its functions are referenced by four other packages in the APPS schema that build, clone, or render page layouts. When custom code must manipulate regions, the supported route is the administrative page-layout function rather than a direct call. Developers who do call the package should wrap invocations in PL/SQL exception handlers that explicitly catch REGION_VALIDATION_EXCEPTION, REGION_EXECUTION_EXCEPTION, REGION_SECURITY_EXCEPTION, and REGION_NOT_FOUND_EXCEPTION, and should perform DML within a transaction they control, since region creation and copying routines commit through the standard EBS transaction model. Because the package relies on APPS synonyms, any calling session must have the APPS schema initialized, as is the case in concurrent programs, Forms-based personalization routines, and OAF/PL/SQL controller code running under a valid EBS session.