Search Results form_stack_canvases




Overview
Explore in AI Chat

Overview

The APPS.HR_FORM_STACK_CANVAS_INFO package is an internal Oracle E-Business Suite database package whose primary purpose is to expose metadata about stacked canvases defined within Oracle Forms-based applications. In Oracle Forms, a stacked canvas is a canvas that occupies the same window as a content canvas and can be programmatically raised or hidden to present additional information within the same window region. The HR product family relies heavily on this Forms construct, particularly within the person, assignment, and position maintenance forms, where stacked canvases are used to present tabbed or layered content.

The package does not perform business transactions or update application data. Instead, it acts as a repository access layer, allowing callers to retrieve a structured description of the stacked canvases associated with a given form. This metadata is consumed by runtime form logic and by other packages that need to introspect the layout and navigation structure of HR forms. The package is classified as OTHER under the ETRM API classification scheme, and its documented access status is "Internal Development Use Only," meaning Oracle does not support its direct invocation by customers or third-party integrators.

Key Procedures and Functions

The package exposes a single documented function:

  • FORM_STACK_CANVASES — Returns a PL/SQL table containing the details of all stacked canvases belonging to a specified form. The function accepts an application identifier and a form identifier as input parameters, and returns a collection typed as t_form_stack_canvases. Each element of the returned collection is a record typed as t_form_stack_canvas, whose fields describe an individual stacked canvas mapping: the form tab stacked canvas identifier, the canvas name, the tab page name, and the stacked canvas name.

The function raises an error on failure. The global types t_form_stack_canvas and t_form_stack_canvases are declared in the package specification, allowing callers to declare matching variables and iterate over the returned collection. No other functions or procedures are documented in the ETRM metadata for this package.

Tables Accessed

The package reads from the following tables, accessed through APPS synonyms:

  • HR_FORM_TAB_STACKED_CANVASES — The primary source of the form tab stacked canvas identifier and the relationships between tab pages and stacked canvases.
  • HR_FORM_CANVASES_B — Provides the base-table canvas name values for both the canvas and the stacked canvas fields.
  • HR_FORM_TAB_PAGES_B — Supplies the tab page name associated with each stacked canvas.
  • FND_APPLICATION and FND_FORM — Used to resolve and validate the application identifier and form identifier passed by the caller.
  • HR_FORM_WINDOWS_B and PLITBLM — Additional reference and utility tables involved in resolving form window context and returning the PL/SQL table.

All access is read-only; the package does not insert, update, or delete rows.

Usage Notes

HR_FORM_STACK_CANVAS_INFO is typically invoked from within Oracle Forms runtime libraries or from other internal HR packages that must determine which stacked canvases exist for a form before navigating to or displaying them. It may also be called by custom code that performs form metadata introspection, although this is not officially supported. Because the access status is Internal Development Use Only, customizations should avoid direct dependency on this package, as its signature and behavior may change without notice across releases. In EBS 12.1.1 and 12.2.2 the package remains a server-side PL/SQL unit residing in the APPS schema, compiled against the HR and FND base tables listed above. It is referenced by at least one other package in the E-Business Suite, confirming its role as a shared metadata provider rather than a standalone utility.