Search Results hz_party_site_v2pub




Overview
Explore in AI Chat

Overview

HZ_PARTY_SITE_V2PUB is a public PL/SQL API package in the Oracle E-Business Suite Trading Community Architecture (TCA) schema, owned by APPS and classified as a PUB (public) API in the ETRM 12.2.2 metadata. It provides the programmatic interface for creating, maintaining, and querying party sites and party site uses within the TCA registry. A party site represents a physical location associated with a party, such as a billing address, a ship-to location, or a registered business address. A party site use associates that site with a specific purpose, providing the mechanism through which addresses gain functional meaning for downstream applications including Order Management, Receivables, Payables, and Purchasing.

This package is the version 2 (V2) API surface, superseding older TCA address APIs and conforming to the standard TCA V2 API conventions: a record-based interface, standardized return status, message list handling through FND_MSG_PUB, and integration with business events and registry validation. The metadata confirms it is referenced by 68 other packages, indicating it is a foundational building block for higher-level TCA and application APIs.

Key Procedures and Functions

The ETRM metadata documents six procedures and functions in the package body:

  • CREATE_PARTY_SITE — Creates a new party site record, associating a location with an existing party. It resolves or validates the location reference and inserts into HZ_PARTY_SITES.
  • UPDATE_PARTY_SITE — Modifies attributes of an existing party site, such as status, identifying address flags, or location linkage, subject to date-tracked update logic.
  • CREATE_PARTY_SITE_USE — Creates a party site use, assigning a site purpose (for example, BILL_TO or SHIP_TO) to a party site. This establishes the operational meaning of the address.
  • UPDATE_PARTY_SITE_USE — Updates an existing party site use, including status and primary-use designation.
  • GET_PARTY_SITE_REC — Retrieves a full party site record for a given identifier, returning the standard TCA record structure for inspection or downstream processing.
  • GET_PARTY_SITE_USE_REC — Retrieves a party site use record, returning its status, purpose, and associated identifiers.

Consistent with TCA V2 conventions, the create and update routines are expected to accept a p_init_msg_list or similar message-list control and return x_return_status and x_msg_count/x_msg_data. Parameter lists are not enumerated here to avoid speculation beyond documented facts.

Tables Accessed

The metadata records direct access to several TCA base tables through APPS synonyms:

  • HZ_PARTY_SITES — the primary table written by create/update party site operations and read by GET_PARTY_SITE_REC.
  • HZ_PARTY_SITE_USES — the primary table for party site use creation, update, and retrieval.
  • HZ_LOCATIONS — read to resolve and validate the underlying address/location record tied to a party site.
  • HZ_PARTIES — read to validate the owning party and enforce party-site relationships.
  • HZ_CUST_ACCT_SITES_ALL, HZ_CUST_SITE_USES, and HZ_CUST_SITE_USES_ALL — customer-side site and site-use tables, reflecting the propagation of party site changes into customer account structures.
  • FND_NEW_MESSAGES — accessed for the TCA messaging framework supporting API return messages.

Dependency information shows the package also invokes HZ_PARTY_SITES_PKG, HZ_PARTY_SITE_USES_PKG, HZ_POPULATE_BOT_PKG, HZ_DQM_SYNC, HZ_BUSINESS_EVENT_V2PVT, HZ_UTILITY_V2PUB, HZ_ORIG_SYSTEM_REF_PUB, ZX_PARTY_TAX_PROFILE_PKG, and HZ_REGISTRY_VALIDATE_V2PUB, along with FND_API, FND_GLOBAL, FND_LOG, FND_MESSAGE, FND_MSG_PUB, and FND_PROFILE. Geographic handling references MDSYS.SDO_GEOMETRY.

Usage Notes

HZ_PARTY_SITE_V2PUB is typically invoked from TCA-based forms and concurrent programs, from higher-level public APIs such as customer and supplier APIs, and from custom PL/SQL integration code. Because it is a PUB API, it is the supported entry point for party site maintenance, whereas direct DML against HZ_PARTY_SITES is unsupported. Callers should initialize the message list through FND_API.G_MISS conventions, validate inputs, and inspect x_return_status and the message stack on completion. The presence of HZ_BUSINESS_EVENT_V2PVT and HZ_DQM_SYNC in the dependency list indicates that invocation may raise business events and trigger synchronization of the TCA registry. In 12.1.1 and 12.2.2, behavior is consistent, with 12.2.x retaining the same V2 API signature. Customizations should avoid modifying the package body, as it is an Oracle-owned, VALID object in the APPS schema, and should instead extend behavior through documented hooks or wrapper packages.