Search Results hz_geography_structure_pub




Overview
Explore in AI Chat

Overview

HZ_GEOGRAPHY_STRUCTURE_PUB is a public PL/SQL API package in the APPS schema that manages the definition and maintenance of geography structures, geography types, zone types, and geography relationship types within the Oracle E-Business Suite Trading Community and Tax (E-Business Tax / ETRM) architecture. Geography structures define the hierarchical levels (such as country, state, county, city, and postal code) that the application uses to organize address validation, tax jurisdiction determination, and party geography assignment. Geography types describe categories of geographic entities, while zone types and relationship types support zone-based and hierarchical classification used in tax configuration and party modeling. The package is classified as a PUB (public) API, indicating it is intended for external invocation by forms, concurrent programs, and custom code rather than restricted to internal use. It exposes a controlled, business-logic-enforced interface to the underlying HZ geography tables, centralizing validation and consistency rules for geography metadata. In Oracle EBS 12.1.1 and 12.2.2, this package is a foundational dependency for downstream geography and tax jurisdiction processing, and it is referenced by several other packages including HZ_GEOGRAPHY_PUB, HZ_GEO_STRUCTURE_PUB_UIW, HZ_GEO_STRUCTURE_VALIDATE_PVT, ZX_GEO_JUR_MIGR_PKG, and ZX_TAX_CONTENT_UPLOAD.

Key Procedures and Functions

The documented API surface comprises seven procedures and functions that create and update geography-related metadata definitions:

  • CREATE_GEOGRAPHY_TYPE — Creates a new geography type definition, establishing a valid category of geographic entity for use in geography structures.
  • CREATE_GEO_STRUCTURE — Creates a new geography structure, defining the organizational hierarchy of geographic levels.
  • DELETE_GEO_STRUCTURE — Removes an existing geography structure definition, subject to the package's consistency controls.
  • CREATE_GEO_REL_TYPE — Creates a geography relationship type, establishing a valid class of relationship between geographies.
  • UPDATE_GEO_REL_TYPE — Modifies an existing geography relationship type definition.
  • CREATE_ZONE_TYPE — Creates a zone type definition used for zone-based geographic and tax classification.
  • UPDATE_ZONE_TYPE — Modifies an existing zone type definition.

Parameter lists for these documented procedures are not reproduced here; callers should reference the package specification in the EBS instance. The API follows the standard Oracle Applications FND_API error-handling and messaging conventions, as evidenced by its dependency on APPS.FND_API.

Tables Accessed

The package reads and writes the principal HZ geography metadata tables through APPS synonyms. HZ_GEOGRAPHY_TYPES_B stores geography type definitions manipulated by the create/update geography type logic. HZ_GEO_STRUCTURE_LEVELS and HZ_GEO_STRUCT_MAP / HZ_GEO_STRUCT_MAP_DTL hold the structure level definitions and mappings that define a geography structure hierarchy. HZ_HIERARCHY_NODES, HZ_RELATIONSHIPS, and HZ_GEOGRAPHY_RANGES support hierarchical and range-based organization of geographies. HZ_GEOGRAPHIES, HZ_GEOGRAPHY_IDENTIFIERS, and HZ_GEO_NAME_REFERENCES (with HZ_GEO_NAME_REFERENCE_LOG) store the geography master records, their identifiers, and name references used to resolve and validate structures. HZ_ADDRESS_USAGES links geographies to address usage contexts. The FND_OBJECTS, FND_OBJECT_INSTANCE_SETS, and FND_OBJECT_INSTANCE_S tables integrate geography definitions with the Oracle Applications object and instance-set framework, enabling object-based security and assignment.

Usage Notes

HZ_GEOGRAPHY_STRUCTURE_PUB is typically invoked indirectly through the E-Business Suite geography and tax configuration user interfaces — such as the Trading Community Manager or E-Business Tax setup forms — where the UI wrapper HZ_GEO_STRUCTURE_PUB_UIW calls the public API to persist user-entered definitions. It is also called by concurrent programs that migrate or upload geography and tax jurisdiction data, including ZX_GEO_JUR_MIGR_PKG and ZX_TAX_CONTENT_UPLOAD, which generate geography structures during tax content loading. Validation logic is delegated to HZ_GEO_STRUCTURE_VALIDATE_PVT, ensuring that structure and relationship definitions satisfy internal integrity rules before commit. Custom code should invoke the package through its declared public procedures using the FND_API standard commit and rollback model, and should not update the underlying HZ geography tables directly, as this bypasses the package's validation and can corrupt geography structure integrity. Because the package is referenced by multiple downstream APIs, changes to geography structures should be planned with awareness of dependencies in geography assignment and tax jurisdiction determination.