Search Results get_relationship_bos




Overview
Explore in AI Chat

Overview

HZ_EXTRACT_RELATIONSHIP_BO_PVT is a private (PVT classification) PL/SQL package in the APPS schema that supports Oracle EBS Trading Community Architecture (TCA) business object extraction. Its role is to query and assemble relationship business objects — the associations between parties such as contacts, employees, or organizations — into a structured collection that downstream extraction and integration logic can consume. The package name follows the standard extraction naming pattern (HZ_EXTRACT_<entity>_BO_PVT), indicating it is a helper package that isolates the "get" logic for a single business object type rather than exposing a public API. Status is VALID across the documented 12.1.1 and 12.2.2 releases, and the documented procedure count is one, reflecting a narrowly scoped, single-purpose utility.

Key Procedures and Functions

The ETRM metadata documents a single procedure for this package:

  • GET_RELATIONSHIP_BOS — Retrieves relationship business objects. Based on the package's name and the documented dependency on HZ_RELATIONSHIP_OBJ_TBL, this procedure populates a table of relationship object records (the PL/SQL collection defined by the HZ_RELATIONSHIP_OBJ_TBL type) rather than returning a scalar value. It forms the extraction entry point for relationship data, allowing calling packages to obtain a set of relationship business objects for further processing, serialization, or transfer. The procedure is the only documented member of the package, which is consistent with the pattern of a "get all business objects for this entity" retrieval routine.

The metadata does not document any parameter lists, and no parameter details should be assumed beyond the observable behavior of populating the HZ_RELATIONSHIP_OBJ_TBL structure.

Tables Accessed

Two base tables are documented as referenced through APPS synonyms:

  • HZ_RELATIONSHIPS — The core TCA table storing relationship records between parties, including relationship type, directionality, and status. GET_RELATIONSHIP_BOS reads this table to build the relationship business objects.
  • HZ_ORIG_SYS_REFERENCES — Stores original system reference information that links TCA entities to their source systems and identifiers. This is read to preserve source-system context on the extracted relationship objects, which is essential for reliable inbound/outbound integration.

In addition, the dependency listing shows the package references the collection type HZ_RELATIONSHIP_OBJ_TBL, which is the structure used to hold the retrieved business objects, and the FND_API package, typically used for standard API return status handling and message propagation.

Usage Notes

HZ_EXTRACT_RELATIONSHIP_BO_PVT is an internal extraction helper and is not intended to be called directly by end users, forms, or standard concurrent programs. The dependency metadata shows it is referenced by three other packages: HZ_EXTRACT_ORGANIZATION_BO_PVT, HZ_EXTRACT_PERSON_BO_PVT, and itself. The references from the organization and person extraction packages indicate that relationship business objects are assembled as part of broader party extraction flows, where extracting a person or organization triggers retrieval of its associated relationships. This makes the package part of a coordinated extraction layer used by TCA integration and data-publishing processes, such as those feeding external systems or reporting extracts. Custom code should prefer the public extraction APIs rather than invoking this private package directly; any direct use should be treated as an unsupported extension, subject to change between releases, and must account for the FND_API-based error handling and the HZ_RELATIONSHIP_OBJ_TBL collection structure returned by GET_RELATIONSHIP_BOS.