Search Results hxc_tcc_shd




Overview
Explore in AI Chat

Overview

APPS.HXC_TCC_SHD is a helper package body within the Oracle E-Business Suite Time and Labor (HXC) module, associated with Time Category Component (TCC) processing. Its name denotes a shared ("SHD") utility library that centralizes common validation, locking, and DML-status logic used by the object-versioned APIs governing time category components. In Oracle EBS 12.1.1 and 12.2.2 the HXC schema underpins the recording and approval of timecard detail; conditional and component-level rules are applied against time categories, and the packages maintaining those rules follow the standard EBS API architecture (a private package, a public package, and a shadow or shared package such as this one). HXC_TCC_SHD provides the reusable internal routines that the corresponding public API and its dependent packages call to enforce concurrency control, argument conversion, and consistent error handling. The ETRM classification of OTHER indicates the object is not itself a public API, but rather an internal implementation package supporting the versioned TCC API family.

Key Procedures and Functions

The ETRM metadata documents five procedures/functions within this package body:

  • RETURN_API_DML_STATUS — returns the accumulated DML status of the current API transaction, allowing calling packages to determine whether rows were inserted, updated, or deleted before committing.
  • CONSTRAINT_ERROR — a standardized error handler that translates Oracle constraint violations into user-facing messages, typically via FND_MESSAGE, so callers receive consistent diagnostics.
  • API_UPDATING — a concurrency-control flag routine that indicates whether an update operation is currently in progress, supporting the locking conventions used across the TCC API family.
  • LCK — the locking routine, used to obtain and manage row-level locks prior to performing DML on time category component data.
  • CONVERT_ARGS — performs argument conversion for the API, normalizing inbound values before they are processed by the core logic.

These routines are invoked internally by the TCC API packages; they are not intended for direct external invocation. Parameter lists are not documented in the ETRM excerpt and are therefore omitted here.

Tables Accessed

The package references two tables through APPS synonyms:

  • HXC_TIME_CATEGORY_COMPS — the primary transactional table holding time category component definitions. The locking, DML-status, and update-flag routines operate in the context of this table's rows.
  • ALL_CONSTRAINTS — a data dictionary view queried to resolve constraint metadata, supporting the CONSTRAINT_ERROR routine in mapping constraint names to meaningful messages.

In addition to these documented table references, the package depends on FND_MESSAGE for message retrieval, HR_API and HR_UTILITY for shared HR utilities, and the base package HXC_TCC_SHD itself.

Usage Notes

HXC_TCC_SHD is typically invoked indirectly rather than from forms or concurrent programs directly. Normal timecard entry and time category maintenance in Oracle EBS flow through the public TCC APIs, which delegate to this shadow package for locking, conversion, and error handling. The ETRM metadata notes that APPS.HXC_TCC_SHD is not referenced by any database object and is referenced by five other packages, confirming its role as a subordinate dependency rather than an entry-point API. Custom extensions that must invoke TCC logic should call the public API layer instead of this package directly; any direct use risks bypassing the concurrency and validation safeguards that this shadow body is designed to enforce.