Search Results create_adapter

Overview

HZ_ADAPTER_PUB is a public PL/SQL API package owned by the APPS schema in Oracle E-Business Suite Release 12.1.1 and 12.2.2. It provides the programmatic interface for defining and maintaining adapters within the Oracle Trading Community Architecture (TCA) and Oracle Receivables/HZ data model. An adapter represents a named integration endpoint or message-routing configuration that governs how customer, party, and location data is exchanged with external or downstream systems. Each adapter carries descriptive attributes, a message format code, synchronous/invocation semantics, host addressing, batching parameters, and credential information used to authenticate the outbound or inbound exchange.

The package exposes a formal, editable API surface so that integration developers and internal Oracle modules can create and update adapter definitions and their associated territory-level mappings without writing directly against the underlying HZ tables. The package is declared with AUTHID CURRENT_USER, meaning its SQL executes with the privileges of the calling user rather than the definer, and callers must therefore hold appropriate grants on the affected objects.

Key Procedures and Functions

• CREATE_ADAPTER — Creates a new record in the adapter definition table by accepting a populated adapter record type. It returns the generated adapter identifier along with the standard API return status, message count, and message data outputs. This is the procedure most commonly targeted in searches for create_adapter.
• CREATE_ADAPTER_TERR — Creates an adapter territory mapping record from an adapter territory record type, associating an adapter with a specific territory and enabling default and enabled flags at that territory level.
• UPDATE_ADAPTER — Modifies an existing adapter record. It accepts the adapter record plus an object version number passed in/out for optimistic locking concurrency control.
• UPDATE_ADAPTER_TERR — Modifies an existing adapter-to-territory association, likewise honoring the object version number for concurrency.
• VALIDATE_ADAPTER — Performs validation of adapter attributes against TCA business rules prior to or independent of a create/update operation.
• VALIDATE_ADAPTER_TERR — Validates an adapter territory mapping record, including territory and default flag integrity.

Tables Accessed

• HZ_ADAPTERS — The primary definition table. CREATE_ADAPTER inserts here; UPDATE_ADAPTER modifies rows; VALIDATE_ADAPTER checks existing values.
• HZ_ADAPTER_TERRITORIES — Stores the association between adapters and territories, including enabled and default flags. Managed through the territory-specific create, update, and validate procedures.
• FND_TERRITORIES — The Oracle Applications territory lookup, referenced to validate territory codes supplied in adapter territory records.

Usage Notes

The package is typically invoked from Oracle Forms-based setup screens (adapter definition and territory assignment), from concurrent programs that generate or maintain adapter configurations, and from custom PL/SQL integration code during implementation or data migration. Callers should always inspect the returned x_return_status for the standard FND_API.G_RET_STS_SUCCESS or error values, and should use FND_MSG_PUB to retrieve the detailed error stack when x_msg_count is greater than one. Because the package is AUTHID CURRENT_USER and carries no documented dependents, upgrades to its signature in 12.1.1 versus 12.2.2 should be verified against the specific patch level in use. When performing updates, the object version number must be threaded through the update calls to prevent lost-update conflicts in multi-user environments. Remove any reference to the obsolete package prefix in custom code and target the canonical APPS.HZ_ADAPTER_PUB name.