Search Results get_orig_sys_reference_rec_2




Overview
Explore in AI Chat

Overview

HZ_ORIG_SYSTEM_REF_PUB_JW is a public PL/SQL package in the Oracle E-Business Suite Trading Community Architecture (TCA) / Receivables schema, owned by APPS and classified as an OTHER API in the ETRM repository for releases 12.1.1 and 12.2.2. Its role is to expose the Original System Reference model used by TCA to record and retrieve correlations between parties, party sites, and other entities and the identifiers by which those entities are known in external or legacy source systems. Because the same real-world customer, supplier, or account can originate in multiple feeder applications, the Original System Reference entity provides the cross-reference layer that maps a local record to its foreign-system key, entity type, and owning table.

The package is a header-level interface (the _JW suffix indicates the generated wrapper, with AUTHID CURRENT_USER and standard p_init_msg_list / x_return_status / x_msg_count / x_msg_data error-handling parameters), and it is intended for programmatic use rather than for interactive data entry.

Key Procedures and Functions

Four procedures are documented in the ETRM metadata:

  • GET_ORIG_SYSTEM_REFERENCE_REC_2 — Retrieves a single Original System Reference record by its surrogate primary key. Callers pass the identifier and receive the mapped attribute set (foreign key value, orig system, entity name, owning table name, status, timestamps, and related descriptive columns) through the OUT parameters.
  • GET_ORIG_SYS_ENTITY_MAP_REC_1 — Returns the entity mapping definition for a given combination of original system and owner table name, describing which TCA entity the source system maps into. This is the lookup used to validate that a source system is registered and permitted for a given owning entity before inserting references.
  • CREATE_ORIG_SYSTEM_REFERENC_3 — Creates a new Original System Reference row, binding an external system key to an internal TCA entity. The procedure performs the standard API validation and returns the generated identifier plus a standard return status and message stack. This is the procedure associated with the user search term create_orig_system_referenc_3.
  • UPDATE_ORIG_SYSTEM_REFERENC_4 — Updates an existing Original System Reference record, typically to correct the external key, change the original system, or adjust the owning entity relationship.

Tables Accessed

The ETRM record for this package lists no tables referenced through APPS synonyms; the DML is performed inside the package body against the underlying TCA Original System Reference tables (HZ_ORIG_SYS_REFERENCES and the associated entity-map table) and their history/audit counterparts. The absence of a synonym list in the metadata reflects the wrapper-level documentation only, not the runtime footprint. Functionally, the package reads the entity-map table to resolve source-system-to-entity mappings and inserts, updates, or selects from the reference table that stores the actual cross-reference rows.

Usage Notes

Because this is a public (_PUB) interface, it is the supported entry point for external code: concurrent programs, PL/SQL batch loads, BPEL/interface programs, and custom Oracle Forms extensions that need to register or look up source-system identifiers for TCA entities. Typical invocations occur during customer or supplier import, data migration from legacy systems, and multi-application integration where a unique external key must be reconciled to a party or site. Callers should first invoke GET_ORIG_SYS_ENTITY_MAP_REC_1 to confirm the mapping exists, then use CREATE_ORIG_SYSTEM_REFERENC_3 or UPDATE_ORIG_SYSTEM_REFERENC_4 for maintenance, always checking x_return_status and consuming x_msg_count/x_msg_data for diagnostics. Direct DML against the base tables should be avoided, since bypassing these APIs skips validation and audit handling. No other packages are documented as referencing it, so it functions as a leaf-level public service within the TCA stack.