Search Results hz_geo_struct_map_s

Overview

The APPS.HZ_GEO_STRUCT_MAP_PUB package body is the public API layer of the Oracle E-Business Suite Trading Community Architecture (TCA) geography model. Its purpose is to create, update, and delete geography structure mappings — the configuration records that tell TCA how a country's administrative divisions (such as state, county, city, or postal boundaries) are organized into a hierarchy of geography structure levels. These mappings are what allow Oracle EBS to validate addresses, resolve geography identifiers, and enforce consistent territorial data across applications such as Receivables, Order Management, and Customer Data Management. The package is classified as a public (PUB) API, meaning it is designed to be invoked by external callers including Oracle forms, concurrent programs, and custom extensions, and it is documented in ETRM 12.2.2 with status VALID in the APPS schema. It sits above a private implementation package, HZ_GEO_STRUCT_MAP_PVT, which performs the underlying data manipulation, and it works alongside the HZ_GEO_STRUCT_MAP_DTL_PVT package. The package body references FND_API and FND_MSG_PUB, indicating it follows the standard TCA API conventions of returning a FND_API.G_RET_STS_SUCCESS-style status and populating the FND message stack with errors or warnings rather than raising raw exceptions.

Key Procedures and Functions

The ETRM metadata documents four public procedures and functions on this package body:

• CREATE_GEO_STRUCT_MAPPING — Creates a new geography structure mapping record, establishing the association between a geography structure and the underlying geography metadata such as the structure level and territory context.
• DELETE_GEO_STRUCT_MAPPING — Removes an existing geography structure mapping, typically used when a country's administrative hierarchy is reconfigured or retired.
• CREATE_GEO_STRUCT_MAP_DTLS — Creates detail lines for an existing geography structure mapping, defining the individual level combinations or detail attributes that make up the mapping.
• UPDATE_GEO_STRUCT_MAP_DTLS — Modifies existing geography structure mapping detail lines, allowing the hierarchy definition to be adjusted without recreating the parent mapping.

Each routine operates within the standard TCA API contract, returning a status and message list to the caller. The private package HZ_GEO_STRUCT_MAP_PVT and the sequence HZ_GEO_STRUCT_MAP_S are invoked internally to supply primary key values and to persist the actual rows. The package is referenced by two other database objects, reflecting its role as a shared configuration service rather than a leaf-level utility.

Tables Accessed

The package reads and writes the core geography structure tables. HZ_GEO_STRUCT_MAP holds the mapping header records, while HZ_GEO_STRUCT_MAP_DTL holds the mapping detail lines manipulated by the create and update detail routines. HZ_GEO_STRUCTURE_LEVELS provides the valid structure levels that a mapping may reference, and HZ_GEOGRAPHY_TYPES_B supplies geography type definitions. HZ_ADDRESS_USAGES and HZ_ADDRESS_USAGE_DTLS are accessed to keep address usage configuration consistent with geography structure changes. Validation and lookup activity relies on FND_TERRITORIES for country information, and on the metadata views FND_TABLES, FND_COLUMNS, and FND_DESCR_FLEX_CONTEXTS_VL for descriptive flexfield and table/column introspection. Utility packages HZ_GNR_GEN_PKG, HZ_GNR_UTIL_PKG, and HZ_UTILITY_V2PUB, together with PLITBLM and DUAL, support generic processing and single-row selection.

Usage Notes

HZ_GEO_STRUCT_MAP_PUB is typically invoked from Oracle's geography setup forms and from concurrent programs that load or migrate geography structure configurations during implementation. Because it is a PUB API, custom code should call it rather than inserting directly into HZ_GEO_STRUCT_MAP or HZ_GEO_STRUCT_MAP_DTL, ensuring that sequence values from HZ_GEO_STRUCT_MAP_S, validation logic, and FND message handling are applied correctly. Callers must supply the standard API parameters and check the returned status before committing, as the procedures do not implicitly commit the transaction in the caller's session.