Search Results hxc_template_summary_api




Overview
Explore in AI Chat

Overview

The APPS.HXC_TEMPLATE_SUMMARY_API package body is a server-side PL/SQL component within the Oracle E-Business Suite Time and Labor (HXC) module. It provides the programmatic interface for managing timecard template summaries — the pre-aggregated structures that describe the layout, block composition, and time attribute configuration of time entry templates used by employees and contingent workers when submitting time. In Oracle EBS 12.1.1 and 12.2.2, the object is registered in the ETRM repository as a VALID package body owned by the APPS schema and classified as an API.

The package encapsulates the business logic required to build, persist, and remove template summary records, insulating calling forms and concurrent programs from the underlying physical data model. It depends on foundation utilities including FND_GLOBAL (for session and user context), STANDARD, and the PL/SQL table utility PLITBLM, as well as Time and Labor collection types such as HXC_ATTRIBUTE_TYPE, HXC_BLOCK_TYPE, and HXC_BLD_BLK_INFO_TYPES.

Key Procedures and Functions

The ETRM metadata documents three public subprograms within this package body:

  • DELETE_TEMPLATE — Removes an existing template summary definition from the repository. It handles the cleanup of the associated summary header and dependent configuration so that a template can be retired or rebuilt without leaving orphaned records.
  • TEMPLATE_DEPOSIT — Writes or refreshes the summary definition for a timecard template. This is the primary "save" operation, persisting the block and attribute configuration assembled by the caller into the summary tables.

A third documented subprogram exists in the package interface but is not itemized in the excerpt above; callers should reference the package specification for the complete signature list. No parameter lists are reproduced here, as the ETRM extract does not publish them.

Tables Accessed

The package operates against the following documented tables through APPS synonyms:

  • HXC_TEMPLATE_SUMMARY — The core table holding template summary headers and their associated definition rows; this is the principal target of TEMPLATE_DEPOSIT and DELETE_TEMPLATE.
  • HXC_BLD_BLK_INFO_TYPES — Supplies the block build information type definitions used to construct the summary structure.
  • HXC_TIME_ATTRIBUTES — Provides the time attribute definitions that a template exposes to the timecard.
  • HXC_TIME_ATTRIBUTE_USAGES — Records how each time attribute is applied within the template context.
  • PLITBLM — The standard Oracle Applications PL/SQL table utility package, used for in-memory collection handling during processing.

Usage Notes

HXC_TEMPLATE_SUMMARY_API is an internal API layer rather than an end-user entry point. It is typically invoked by Time and Labor setup forms and by concurrent programs that generate or regenerate timecard templates, as well as by administrator-level configuration routines. The metadata confirms the package is referenced by three other database objects and itself calls HXC_TEMPLATE_SUMMARY_PKG and HXC_TIMECARD_BLOCK_UTILS, placing it in the middle of the template management call chain.

Because the package is not referenced by external database objects outside this dependency set, customizations should call it only through supported extension patterns and should not bypass the standard validation performed by TEMPLATE_DEPOSIT. Developers integrating with this API should always initialise the FND session context before invocation, since FND_GLOBAL is a declared dependency and the package relies on it for the active user and responsibility.