Search Results update_relationship_event




Overview

HZ_BUSINESS_EVENT_V2PVT is a private PL/SQL package in the APPS schema that serves as the internal event-generation layer for the Oracle Trading Community Architecture (TCA) public APIs. Its primary responsibility is to raise Oracle Workflow business events whenever master reference data managed by the TCA *_V2PUB APIs is created or updated. The package name carries the PVT suffix, indicating it is a private helper that is not intended to be called directly by external code; instead, it is invoked by the corresponding public and private API packages after a successful DML operation.

The package covers the principal TCA entity families: parties (persons, groups, organizations), relationships, party sites, party site uses, organization contacts, contact roles, locations, and contact points. For each entity it exposes a parallel create_*_event and update_*_event procedure, allowing consumers to subscribe to changes through the Workflow Business Event System rather than polling the underlying tables. The source header (ARH2BESS.pls, version 120.9) confirms the package is part of the shared HZ business event infrastructure and has been stable since the 11i era.

Key Procedures and Functions

The documented procedures follow a consistent naming pattern and fall into two categories per entity: creation events and update events. With 83 total procedures/functions documented, the package extends well beyond the excerpt below, but the following procedures are explicitly catalogued:

All procedures use the strongly typed _rec_type records defined in the corresponding public API packages (for example, hz_party_v2pub.person_rec_type and hz_relationship_v2pub.relationship_rec_type), which enforces consistency between the API payloads and the event payloads.

Tables Accessed

Because the package does not persist TCA data itself, its table references are limited to the Workflow Business Event System infrastructure:

  • WF_PARAMETER_LIST_T — Used to construct the parameter list passed to the Workflow event engine, carrying the entity identifier and related key values.
  • WF_PARAMETER_T — Holds the individual name/value parameter pairs that make up each event payload.
  • PLITBLM — An Oracle-supplied helper package/table reference used internally by the PL/SQL event utilities.

These tables are accessed through APPS synonyms, and no direct DML is performed against the HZ base tables by this package; the calling API has already committed the transactional data by the time the event is raised.

Usage Notes

HZ_BUSINESS_EVENT_V2PVT is not a public interface and should never be invoked directly from custom forms, concurrent programs, or ad hoc scripts. It is called internally by the TCA HZ_*_V2PUB API packages (and their private counterparts) immediately after a successful create or update operation. With respect to Oracle EBS 12.1.1 and 12.2.2, the package behaves identically; the ETRM documentation lists it as an OTHER-classified private API owned by APPS.

Twenty other packages reference this package, which reflects its central role in the TCA event model. Customers who need to react to party or relationship changes should subscribe to the published Workflow business events (for example, oracle.apps.ar.hz.Person.update and oracle.apps.ar.hz.Relationship.update) rather than calling these procedures. The update_relationship_event procedure, in particular, is the internal hook that fires whenever a relationship record changes, enabling downstream subscribers such as data quality, customer data management, and integration programs to synchronize their own repositories with TCA master data.