Search Results hz_event_pkg




Overview
Explore in AI Chat

Overview

HZ_EVENT_PKG is a PL/SQL package owned by the APPS schema in Oracle E-Business Suite, classified under the Oracle Trading Community Architecture (TCA) as an "OTHER" API. Its principal business function is to serve as the event notification and subscription engine for the Oracle Workflow infrastructure embedded within the Trading Community Architecture and its dependent modules. The package provides a programmatic mechanism for raising business events — such as party creation, updates, merges, and business object status changes — into the Oracle Workflow event system, where subscriptions and interested listeners can consume them. By centralizing event publication logic, HZ_EVENT_PKG allows subscribing packages, forms, and concurrent processes to react to data changes within the TCA registry without requiring direct coupling between the originating transaction and the interested consumer.

Key Procedures and Functions

The package exposes five documented program units, each supporting a distinct stage of the event lifecycle:

  • RAISE_EVENT — The primary entry point used to publish a named business event into the Oracle Workflow event system, making it visible to registered subscribers.
  • EVENT — Supports the assembly and preparation of the event payload prior to publication, central to the internal flow of the package.
  • EXIST_SUBSCRIPTION — Determines whether a subscription exists for a given event, allowing calling code to conditionally publish or suppress events and thereby avoid unnecessary overhead.
  • ITEM_KEY — Generates or retrieves the item key that uniquely identifies the event instance within Oracle Workflow, ensuring each raised event can be tracked as a discrete workflow item.
  • ADDPARAMENVTOLIST — Adds an environment or parameter entry into the parameter list structure passed with the event, enabling contextual data to accompany the notification.

Tables Accessed

The package reads and writes against a well-defined set of Oracle Workflow and TCA tables, accessed through APPS synonyms:

  • WF_EVENTS — Master definition of raised events and their attributes.
  • WF_EVENT_SUBSCRIPTIONS — Subscription rules determining which listeners receive a raised event.
  • WF_PARAMETER_LIST_T and WF_PARAMETER_T — Storage for parameter name/value pairs and the enclosing parameter list passed with an event.
  • WF_SYSTEMS — Identifies the owning workflow system for the event.
  • HZ_WF_ITEMS_S — TCA-specific sequence used to derive item keys, together with DUAL and the PLITBLM (PL/SQL integer table) structure used for list handling.

Usage Notes

HZ_EVENT_PKG is an internal infrastructure package rather than an end-user callable API. It is typically invoked indirectly by higher-level TCA packages — including HZ_PARTY_BO_PVT, HZ_BUSINESS_EVENT_V2PVT, and HZ_BES_BO_RAISE_PKG — that raise events during party or business object processing. It is also referenced by HZ_PARTY_MERGE and ARP_CMERGE_MASTER during customer and party merge operations, where merge-related events must be published to downstream subscribers such as synchronization or data-purging processes. Direct calls from custom code are uncommon and generally unnecessary; developers requiring event publication should prefer the documented business object APIs, which in turn delegate to this package. Its dependency on Oracle Workflow objects means it functions only where the Workflow schema is installed and event subscriptions are configured. Because it operates at the base of the TCA event mechanism, modifications or diagnostics affecting it should be treated as high-impact changes to be validated carefully in a non-production environment.