Search Results hz_utility_pub




Overview

HZ_UTILITY_PUB is a public PL/SQL package in the APPS schema that provides shared utility functions for the Oracle E-Business Suite Trading Community Architecture (TCA) and Receivables (AR) modules. Its name and API classification as a PUB package indicate that it is designed for external invocation — from forms, concurrent programs, workflows, and customer extensions — rather than being an internal helper package. The package body holds the executable implementation of the procedures and functions declared in the HZ_UTILITY_PUB specification.

At a practical level, HZ_UTILITY_PUB supplies common surrogate value routines that standardize how key context columns are populated across TCA tables: the standard WHO columns (created_by, creation_date, last_updated_by, last_update_date, last_update_login) and the concurrent program context columns (request_id, program_application_id, program_id, program_update_date). It also exposes a USER_ID function for ascertaining the current application user. Centralizing these lookups ensures that every TCA entity record carries consistent auditing and request-tracking values without each calling package re-implementing the logic.

Key Procedures and Functions

The ETRM 12.2.2 metadata documents ten procedures/functions, most of which are simple value-returning accessors:

  • CREATED_BY — Returns the value used to populate the CREATED_BY WHO column for a new TCA row.
  • CREATION_DATE — Returns the creation timestamp value for a new row.
  • LAST_UPDATED_BY — Returns the value for the LAST_UPDATED_BY audit column.
  • LAST_UPDATE_DATE — Returns the update timestamp value.
  • LAST_UPDATE_LOGIN — Returns the login context value for the LAST_UPDATE_LOGIN column.
  • REQUEST_ID — Returns the current concurrent request identifier for assignment to request-tracking columns.
  • PROGRAM_ID — Returns the concurrent program identifier.
  • PROGRAM_APPLICATION_ID — Returns the application identifier that owns the running concurrent program.
  • PROGRAM_UPDATE_DATE — Returns the program update timestamp.
  • USER_ID — Returns the current application user identifier.

These accessors are typically implemented as thin wrappers over FND_GLOBAL calls, isolating the rest of the TCA code base from the underlying FND_GLOBAL interface. Parameter lists are not documented here and are therefore not restated.

Tables Accessed

No physical tables are documented as directly referenced by HZ_UTILITY_PUB. Instead, the package depends on APPS.FND_GLOBAL for session and request context, and on the STANDARD package (SYS) for procedural support. Its role is to feed values into the WHO and concurrent-program columns of TCA and AR tables at the point where records are inserted or updated, so the audit columns are populated correctly by the calling package.

Usage Notes

HZ_UTILITY_PUB is referenced by 134 other database objects, reflecting its role as a foundational utility within the TCA stack. Typical invocation occurs during INSERT and UPDATE processing in higher-level public APIs such as the HZ_REGISTRY and related party/account packages, by concurrent programs that process trading community data, and by custom extensions that need standardized WHO and request-tracking values. Both the 12.1.1 and 12.2.2 releases expose the identical API surface, so custom code compiled against 12.1.1 remains compatible after an upgrade. Because it is a PUB package, direct callers should treat the documented procedures and functions as the supported interface and avoid depending on unpublished internal elements of the body.