Search Results hz_geo_structure_validate_pvt




Overview
Explore in AI Chat

Overview

HZ_GEO_STRUCTURE_VALIDATE_PVT is a private PL/SQL package in the APPS schema that provides the internal validation logic underpinning Oracle E-Business Suite's geography and address validation framework. It belongs to the Oracle Trading Community Architecture (TCA) / Customer Data Management (CDM) foundation layer, specifically the Geography and Address Validation module. Its central purpose is to verify the structural and referential integrity of geography data before that data is used to build or evaluate address validation rules. Geography structures in EBS define the hierarchical relationships between geographies — for example, Country > State > City > Postal Code — along with the geography types and relationship types that make up those hierarchies. The package enforces that only valid geography types, geography identifiers, relationship types, structure levels, and zone types participate in a structure definition, thereby preventing corrupted hierarchies from reaching the validation engine. Because the package is classified "PVT" (private), it is not intended to be called directly from customer code; it exists to service the public API layer and the internal validation engine.

Key Procedures and Functions

The ETRM documentation lists five documented procedures/functions, each devoted to a specific facet of geography validation:

  • VALIDATE_GEOGRAPHY_TYPE — confirms that a supplied geography type is recognized and permissible within the geography model, guarding against invalid type codes entering a structure definition.
  • VALIDATE_GEOGRAPHY_ID — verifies that a specific geography identifier exists and is valid, ensuring references resolve to real geography records.
  • VALIDATE_GEO_REL_TYPE — checks that a geography relationship type is valid, supporting the parent/child links that form a geography hierarchy.
  • VALIDATE_GEO_STRUCTURE — the core routine; validates the overall geography structure, reconciling structure levels, types, and relationships as a coherent whole.
  • VALIDATE_ZONE_TYPE — validates zone type references used within geography and address validation processing.

These routines are consumed internally; specific parameter signatures are not part of the published API surface and should not be assumed.

Tables Accessed

The package reads from several TCA geography and validation tables through APPS synonyms:

  • HZ_GEOGRAPHIES — the master geography entity table; used to confirm geography IDs exist and are active.
  • HZ_GEOGRAPHY_TYPES_B — the base table of geography type definitions; supports VALIDATE_GEOGRAPHY_TYPE.
  • HZ_GEO_STRUCTURE_LEVELS — defines the level composition of geography structures; supports VALIDATE_GEO_STRUCTURE.
  • HZ_RELATIONSHIP_TYPES — defines valid relationship types; supports VALIDATE_GEO_REL_TYPE.
  • PLITBLM — an Oracle-supplied packaged index/object table used internally by PL/SQL packages, not a functional business table.

Access is primarily read-only lookup and validation; the package performs no independent DML on these tables.

Usage Notes

HZ_GEO_STRUCTURE_VALIDATE_PVT is invoked indirectly. It is referenced by HZ_GEOGRAPHY_STRUCTURE_PUB (the public geography structure API), by HZ_GEOGRAPHY_VALIDATE_PVT, and recursively by itself, meaning calls originate from the public validation API rather than from end-user forms or concurrent programs directly. Typical invocation paths include the Address Validation (Tax/Geography) setup flows, TCA geography maintenance screens, and any custom code that calls HZ_GEOGRAPHY_STRUCTURE_PUB to create or modify geography structures. Because the package is private and its signatures are subject to change across releases, developers should call the supported public API (HZ_GEOGRAPHY_STRUCTURE_PUB) rather than the PVT package. The behavior described applies to both Oracle EBS 12.1.1 and 12.2.2, where the geography validation framework remains consistent in architecture.