Search Results validate_event_id
Overview
HZ_EXTRACT_BO_UTIL_PVT is a private (PVT) PL/SQL package owned by the APPS schema within the Oracle Trading Community Architecture (HZ) product. Its documented display name, "Contact Point," indicates that it provides utility services for the extraction and traversal of business object (BO) hierarchies associated with contact points and related TCA entities. The package is declared with AUTHID CURRENT_USER and is classified as an internal, non-public API, meaning it is intended for consumption by other TCA packages rather than by external callers. Its primary business function is to resolve root event identifiers, validate event and business object context, and resolve object relationships—particularly parent/child object types—that arise when TCA business object tracking records must be expanded to their underlying entities. The package header (ARHEUTVS.pls, version 120.4.12010000.2, shipped 2009) is governed by the Oracle Trading Community Architecture Technical Implementation Guide (115hztig.pdf). The package is referenced by approximately 30 other packages, underscoring its role as a shared internal utility layer.
Key Procedures and Functions
The package exposes five documented subprograms:
- VALIDATE_EVENT_ID — A procedure that validates an event identifier against a party, event type, and business object code, returning a status indicator. It is used to confirm that a supplied event is legitimate and consistent with the referenced business object.
- GET_PARENT_OBJECT_TYPE — A function that returns the object type of the parent for a given parent table name and parent identifier. This is the object targeted by the search term "get_parent_object_type" and serves hierarchy resolution during business object extraction.
- GET_USER_NAME — A function that returns the user name associated with a supplied user identifier, resolving against FND_USER for display or audit purposes.
- GET_BO_ROOT_IDS — The central procedure for obtaining root event identifiers. It returns a collection of root business object IDs (BO_ID_TBL, a table of NUMBER indexed by BINARY_INTEGER) along with standard API return status, message count, and message data. It accepts an initialization flag and an event ID.
- VALIDATE_SSM_ID — A procedure that validates a supplied SSM identifier along with associated object state values and organization context, returning status and message information. It accepts an object type and optional organization ID.
The package also declares a public type BO_ID_TBL and a package constant G_RETURN_USER_NAME, derived from the HZ_RETURN_USER_NAME profile option.
Tables Accessed
The documented tables are referenced through APPS synonyms and span the core TCA model:
- FND_USER — Supports user name resolution via GET_USER_NAME.
- HZ_BUS_OBJ_TRACKING — The business object tracking table, central to event and root ID resolution.
- HZ_CONTACT_POINTS — Contact point records, consistent with the package's display name.
- HZ_PARTIES, HZ_PARTY_SITES, HZ_LOCATIONS — Party and location data underpinning contact point and hierarchy lookups.
- HZ_CUST_ACCOUNTS, HZ_CUST_ACCOUNT_ROLES, HZ_CUST_ACCT_SITES, HZ_CUST_SITE_USES — Customer account, role, and site usage data used when resolving parent object types and validating event context.
- HZ_ORG_CONTACTS — Organization contact relationships relevant to contact point hierarchy resolution.
Because it is a private utility, reads dominate; the package resolves and validates rather than maintaining transactional data.
Usage Notes
HZ_EXTRACT_BO_UTIL_PVT is an internal package and is not exposed as a public API. It is invoked indirectly through the roughly 30 dependent packages that perform TCA business object extraction and event processing, typically in the context of contact point extraction, business object tracking, and customer/party data synchronization. It may be called from concurrent programs that batch-extract TCA business objects, from forms that display or validate contact point relationships, and from custom code that must resolve root business object IDs or determine the parent object type for a given parent table and ID. Developers should not call this package directly from customizations; the supported public APIs should be used instead, with this package treated as an implementation detail. Standard API conventions apply, including the return status, message count, and message data out parameters on the documented procedures.