Search Results hr_template_canvas_info




Overview
Explore in AI Chat

Overview

HR_TEMPLATE_CANVAS_INFO is a PL/SQL package owned by the APPS schema in Oracle E-Business Suite, documented as VALID in the ETRM repository for releases 12.1.1 and 12.2.2. It belongs to the Oracle Human Resources (HR) family of form-template utilities that drive the configurable, template-based UI framework used extensively across HRMS self-service and professional forms. In that framework, a "form template" defines the overall layout of an Oracle Forms page, while a "canvas" represents an individual drawing surface or tabbed region within the form, and a "window" represents the containing Forms window. The package supplies canvas-level metadata — properties, identifiers and descriptive attributes — that the runtime engine uses to render and persist HR form templates correctly. Its API classification is OTHER, indicating it is an internal supporting package rather than a public, externally documented business API or a formal concurrent-program driver.

Key Procedures and Functions

The ETRM metadata documents two callable units. Neither has a published parameter list in the repository, so only their purpose is described here.

  • TEMPLATE_CANVAS_INFO — the primary entry point. It accepts a template/canvas context and returns, or populates, the canvas information needed by callers — for example canvas names, associated windows and property values drawn from the underlying HR base tables. It underpins the "Template Canvas Information" logic referenced by HRMS forms that must resolve which canvas belongs to which template.
  • TEMPLATE_CANVAS_INFO_PST — the "_PST" suffix conventionally denotes a supplementary or secondary variant of the main routine (commonly a processing, validation or "post" companion). It provides the parallel handling path for canvas information, invoked in the same template-processing flow as the primary procedure.

Tables Accessed

The package references the following tables through APPS synonyms, forming the template/canvas/window data model:

  • HR_FORM_TEMPLATES_B — base table of form template definitions; provides the template header against which canvas information is resolved.
  • HR_TEMPLATE_CANVASES_B — base table of canvases belonging to each template; the central source of canvas records returned by the API.
  • HR_FORM_CANVASES_B — base table of canvas definitions at form level.
  • HR_CANVAS_PROPERTIES — property/value pairs describing individual canvas attributes.
  • HR_FORM_WINDOWS_B and HR_TEMPLATE_WINDOWS_B — window definitions linking canvases to their enclosing Forms windows.
  • PLITBLM — a standard Oracle-supplied PL/SQL table/index-by table type reference used internally for bulk operations.

Usage Notes

HR_TEMPLATE_CANVAS_INFO is invoked indirectly. It is not typically called by end users or by standalone concurrent programs; rather, it is consumed by the HR form-template runtime and by other HRMS packages and forms that need to enumerate or validate canvases associated with a template. Because ETRM records no packages referencing it ("referenced by 0 other packages"), its callers are primarily compiled Oracle Forms libraries and internal template utilities rather than other PL/SQL packages in the dependency graph. Customizations should not alter this package; developers requiring canvas metadata should treat it as an internal implementation detail and, where a supported interface exists, use the public HR template APIs instead. Any direct invocation in custom code should be limited to read-only retrieval of canvas information within the same releases (12.1.1 and 12.2.2) where the signature is validated.