Search Results template_stack_canvases




Overview
Explore in AI Chat

Overview

The APPS.HR_TEMPLATE_STACK_CANVAS_INFO package body is a component of the Oracle E-Business Suite (EBS) Human Resources (HR) module, specifically belonging to the Oracle Forms-based template and canvas infrastructure. Its principal business function is to resolve the relationship between a form template (an Oracle Forms template registered in the HR schema) and the set of stack canvases, tab pages, and canvas names that are associated with that template. In Oracle Forms terminology, a "stack canvas" is a canvas that is displayed in a stacked arrangement — such as a tabbed region — where multiple canvases occupy the same screen position and are toggled by the user. This package provides a programmatic API to enumerate those stacked canvases for a given form template so that downstream HR personalization, template administration, and form-rendering logic can determine which canvases belong to which template.

Key Procedures and Functions

The ETRM metadata documents two procedures or functions within this package body:

  • TEMPLATE_STACK_CANVASES — The primary function. It accepts a form template identifier and returns a PL/SQL collection of the stack canvases associated with that template. The function delegates resolution to HR_FORM_STACK_CANVAS_INFO.FORM_STACK_CANVASES, passing the application ID and form ID derived from the template via HR_FORM_TEMPLATE_INFO helper functions. It then iterates over the returned form-level stack canvas collection and populates a template-level collection, mapping the form stack canvas ID to a template stack canvas ID, and carrying forward the canvas name, tab page name, and stack canvas name. The body uses FIRST/NEXT loop iteration with EXTEND to build the return collection, and returns an empty collection if none are found.
  • TEMPLATE_STACK_CANVASES_PST — A companion function, also listed in the documented procedure/function inventory. Its naming suggests a persisted or cached variant of the same enumeration logic, retaining template stack canvas information for reuse. As the metadata does not expose its parameter list, only its role in providing the same template-to-stack-canvas resolution is asserted here.

No parameter lists are invented; the above reflects only what the documented excerpt supports.

Tables Accessed

The package operates over the HR template/canvas metadata model. The documented referenced tables are:

  • HR_FORM_TEMPLATES_B — Stores registered form templates; supplies the FORM_TEMPLATE_ID used as the input key.
  • HR_FORM_CANVASES_B — Stores canvas definitions, including stack canvas attributes.
  • HR_FORM_TAB_PAGES_B — Stores tab page definitions that group stacked canvases into tabbed regions.
  • HR_FORM_TAB_STACKED_CANVASES — The junction table linking tab pages to their stacked canvases, which drives the enumeration returned by the function.
  • PLITBLM — A PL/SQL internal table utility used for collection handling.

These tables are accessed through APPS synonyms, so the package reads the HR metadata independently of the base table owner. The package is read-only with respect to this model; it derives and returns canvas information rather than modifying template definitions.

Usage Notes

This package is a low-level infrastructure API and is not intended for direct end-user invocation. It is typically called from within the HR Forms template-processing stack, during initialization or rendering of a form that uses a registered HR template, when the runtime needs to resolve the stacked canvases and tab pages belonging to that template. Customizations and extensions that manipulate HR template canvases — for example, personalization code that needs to enumerate tabbed regions for a given template — can call TEMPLATE_STACK_CANVASES to obtain the template-level collection. Because the ETRM metadata records that no other packages reference this package body, its callers are expected to be forms-invoked or custom code rather than a shared public API. It should be used in the context of an active Oracle EBS database session under the APPS schema, and callers must handle the possibility of an empty return collection when a template defines no stacked canvases.