Search Results create_relationship_with_usg

Overview

APPS.HZ_RELATIONSHIP_V2PUB is the public PL/SQL API package that Oracle Trading Community Architecture (TCA) exposes for the creation, maintenance, and retrieval of party relationship records in Oracle E-Business Suite. The package header, identified by the CVS tag ARH2RESS.pls 120.10, declares itself as containing "the public APIs for party relationships" and is registered under the HZ product with a public API classification. Its documented scope covers the core relationship entities represented by the BUSINESS_ENTITY categories HZ_RELATIONSHIP, HZ_PARTY, HZ_PERSON, and HZ_ORGANIZATION, meaning the package is the sanctioned programmatic entry point for associating one party (the subject) with another party (the object) through a defined relationship code and type.

The package is lifecycle-active and is catalogued in the Oracle Trading Community Architecture Technical Implementation Guide (120hztig.pdf, "Relationship APIs"), which is the authoritative reference for its parameters and behavior. Because relationships underpin organizational hierarchies, person-to-organization affiliations, and contact-to-party linkages throughout EBS, this package is a foundational dependency for a large portion of the TCA stack; the metadata records that it is referenced by 57 other packages.

Key Procedures and Functions

• CREATE_RELATIONSHIP — Creates a new party relationship using the supplied relationship record and party record values. This is the primary entry point for establishing a subject-to-object association between two parties.
• CREATE_RELATIONSHIP_WITH_USG — A variant of the create operation that additionally applies a usage assignment, allowing the caller to record how the relationship is used in addition to creating the relationship itself.
• UPDATE_RELATIONSHIP — Modifies an existing relationship record, such as its status, dates, comments, or descriptive flexfield attributes.
• GET_RELATIONSHIP_REC — Returns the attributes of an existing relationship into the relationship_rec_type structure, used when the caller must read current values before updating or displaying them.

The relationship_rec_type record that the user searched for is the central data structure of this package. It carries the relationship identifiers (relationship_id, subject_id, object_id), the subject and object type/table qualifiers, relationship_code and relationship_type, comments, start_date/end_date, status, content_source_type (defaulting to USER_ENTERED), an attribute category plus twenty descriptive flexfield attributes, created_by_module, application_id, a nested party_rec of type HZ_PARTY_V2PUB.PARTY_REC_TYPE, and additional information columns.

Tables Accessed

The package reads and writes the core TCA relationship tables and their supporting reference data:

• HZ_RELATIONSHIPS and HZ_RELATIONSHIPS_S — the primary relationship entity and its sequence, holding the created and updated relationship rows.
• HZ_PARTIES — the party master used to validate and resolve subject and object parties.
• HZ_RELATIONSHIP_TYPES — supplies the valid relationship type definitions that constrain the relationship_code and relationship_type values.
• HZ_ORG_CONTACTS and HZ_CONTACT_NUMBERS_S — organizational contact and contact number data relevant to relationship usage.
• DUAL and PLITBLM — used for scalar evaluation and PL/SQL table/name-value processing within the API internals.

Usage Notes

HZ_RELATIONSHIP_V2PUB is intended for programmatic invocation rather than direct SQL against the underlying tables. It is typically called from Oracle Forms (the party and organization maintenance screens in the TCA and Receivables modules), from concurrent programs that bulk-load or migrate relationship data, and from customer-written PL/SQL that must create or amend relationships while preserving TCA's validation and denormalization rules. Callers populate a relationship_rec_type record, invoke the relevant create or update procedure, and inspect the returned status and message fields before committing. Because of the nested party_rec component, the package is tightly coupled with HZ_PARTY_V2PUB and is normally invoked in API sequences where the party is created or identified first. Direct DML on HZ_RELATIONSHIPS bypasses the logic in this package and is not supported.