Search Results hz_orig_sys_ref_obj




Overview
Explore in AI Chat

Overview

The APPS.HZ_EXTRACT_RELATIONSHIP_BO_PVT package body is a private (PVT) PL/SQL API belonging to the Oracle E-Business Suite Trading Community Architecture (TCA) / Customer Data Management (CDM) layer. Its core business function is to extract relationship business objects — the party-to-party and party-to-account associations stored in the TCA Registry — and marshal them into the transient BO structures used by the broader HZ extraction and synchronization framework during the 12.1.1 and 12.2.2 releases.

In practical terms, this package participates in the extraction pipeline that serializes TCA relationship data for downstream consumption: outbound integrations, data migration, master data synchronization between instances, or publication to external systems through the CDM extraction infrastructure. It does not persist a long-lived business entity itself; rather it reads source relationship rows and populates the in-memory business object tables that the calling extractor then processes.

Key Procedures and Functions

ETRM documents one procedure or function for this private package body:

  • GET_RELATIONSHIP_BOS — The single documented entry point. It is responsible for retrieving the set of relationship business objects for the extraction context and returning them as populated object collections. In the context of the search term hz_relationship_obj, this procedure is the mechanism that assembles HZ_RELATIONSHIP_OBJ records into an object table (the HZ_RELATIONSHIP_OBJ_TBL collection type) so that the parent extractor can iterate over the relationship BOs as a coherent, typed set rather than raw rows.

Only this one procedure is catalogued; the extraction and helper logic it relies upon is supplied by the sibling package HZ_EXTRACT_BO_UTIL_PVT and the utility layer HZ_UTILITY_V2PUB, both of which are documented dependencies.

Tables Accessed

The documented tables referenced via APPS synonyms are:

  • HZ_RELATIONSHIPS — The base TCA table holding the actual relationship records between parties (for example, a person's employment at an organization or an organizational contact role). GET_RELATIONSHIP_BOS reads from this table as the authoritative source of relationship rows to be extracted.
  • HZ_ORIG_SYS_REFERENCES — The original-system reference table that stores the external/legacy identifier cross-references for TCA entities. It is consulted so that each extracted relationship BO can carry its originating system identifiers, which is essential for downstream reconciliation.

In addition, the dependency list reveals that the procedure works with the object structure tables HZ_RELATIONSHIP_OBJ, HZ_RELATIONSHIP_OBJ_TBL, HZ_ORIG_SYS_REF_OBJ, and HZ_ORIG_SYS_REF_OBJ_TBL. These are the in-memory object/collection types populated from the base tables above, and they represent the payload returned by GET_RELATIONSHIP_BOS.

Usage Notes

Because the API classification is PVT, HZ_EXTRACT_RELATIONSHIP_BO_PVT is not a public interface and should not be invoked directly by custom code. It is called internally by the HZ extraction framework — typically an extractor that coordinates the extraction of party, account, location, and relationship business objects in sequence. Typical invocation paths include concurrent programs or batch extractors within Customer Data Management, and internal package logic that processes a full TCA entity graph.

The package depends on FND_API, FND_MSG_PUB, FND_MESSAGE, and FND_LOG, indicating that it follows Oracle's standard API conventions: it returns a standard FND_API.G_RET_STS_SUCCESS/ERROR status, reports problems through the FND message stack, and emits debug output to FND_LOG.

ETRM records that this package is not referenced by any other database object (only by the extraction framework at runtime), and that it itself references three other packages alongside the utility and object-type dependencies. Customizations should be confined to the public extraction framework rather than this private body, since its signature and internal behaviour are subject to change across patch levels between 12.1.1 and 12.2.2.