Search Results hz_adapter_pub




Overview
Explore in AI Chat

Overview

HZ_ADAPTER_PUB is a public PL/SQL package in the Oracle E-Business Suite Trading Community Architecture (TCA) / Receivables (AR) module that manages the configuration of adapters used by the Oracle EBS integration and messaging infrastructure. An adapter, in this context, is a registered endpoint that describes how the application should communicate with an external system — for example a third-party data quality service, a tax engine, or a customer data hub. The package provides the application programming interface (API) used to create, maintain, and validate adapter definitions and the territory mappings associated with those adapters.

The package body declares the standard Oracle EBS API error-handling constructs, including a private log procedure, a logerror function, and the use of FND_MSG_PUB and FND_API for message stacking and return-status handling. All public procedures follow the standard EBS API contract: an x_return_status compatibility flag (S, E, or U), plus x_msg_count and x_msg_data output parameters. These conventions allow callers to detect and interpret errors consistently.

Key Procedures and Functions

  • CREATE_ADAPTER — Inserts a new adapter record into HZ_ADAPTERS after internal validation. It assigns the adapter identifier, content source, enabled and synchronous flags, invocation method, message format, host address, credentials, and batch-size settings.
  • CREATE_ADAPTER_TERR — Registers a territory association for an adapter by inserting into HZ_ADAPTER_TERRITORIES, tying an adapter to a specific territory definition.
  • UPDATE_ADAPTER — Modifies an existing adapter record, applying the same validation logic used on creation to protect data integrity.
  • UPDATE_ADAPTER_TERR — Updates the territory-to-adapter mapping held in HZ_ADAPTER_TERRITORIES.
  • VALIDATE_ADAPTER — Validates the adapter attributes supplied by a caller before a create or update is attempted; it is invoked internally by the create and update entry points and may also be called directly by custom code.
  • VALIDATE_ADAPTER_TERR — Performs validation of territory mappings for an adapter prior to insert or update.

In addition, the package body shows an internal step that inserts a new lookup code into the CONTENT_SOURCE_TYPE lookup, ensuring that the content-source value assigned to the adapter is a valid reference-data code. Note that the metadata does not enumerate a public procedure named CHECK_LOOKUP; the lookup validation is performed inline through the FND lookup APIs (FND_LOOKUP_VALUES/FND_LOO…) rather than through a standalone entry point.

Tables Accessed

  • HZ_ADAPTERS — The primary adapter definition table. It stores adapter identity, content source, invocation method, message format, host, credentials, and batch parameters. CREATE_ADAPTER, UPDATE_ADAPTER, and the validation routines read and write this table.
  • HZ_ADAPTER_TERRITORIES — Stores adapter-to-territory associations. It is accessed by CREATE_ADAPTER_TERR, UPDATE_ADAPTER_TERR, and VALIDATE_ADAPTER_TERR to enforce territory scope.
  • FND_TERRITORIES — The Oracle foundation territory reference table, used to validate that territory codes supplied for an adapter mapping exist and are active.

Usage Notes

HZ_ADAPTER_PUB is a public API intended for programmatic invocation rather than direct table manipulation. It is typically called from Oracle Forms-based setup screens, from concurrent programs that seed or migrate adapter configuration, and from custom integration code that provisions adapters in a target environment. Because the documented procedures expose the standard FND_API return-status pattern, callers should check x_return_status after every call and retrieve any stacked messages through FND_MSG_PUB when the status is E or U. The ETRM metadata records that this package is referenced by zero other packages, so it functions as a top-level entry point in the adapter configuration flow. Developers searching on the term check_lookup will typically be looking for lookup-code validation logic; in this package such validation is performed inline against the CONTENT_SOURCE_TYPE lookup rather than through a dedicated check_lookup routine.