Search Results hz_geo_get_pub




Overview
Explore in AI Chat

Overview

HZ_GEO_GET_PUB is a public PL/SQL package in the Oracle E-Business Suite Applications (APPS) schema that provides a programmatic interface for retrieving geography and zone information from the Oracle Trading Community Architecture (TCA) and Human Resources geography data model. Its primary business function is to resolve a given location or geography into one or more associated zones, such as tax zones, sales territories, or other geographic classifications, based on a supplied zone type and effective date. The package belongs to the Public (PUB) API classification, indicating that it is an officially documented and supported interface intended for invocation by external application code, concurrent programs, and other Oracle EBS modules. In the context of the Oracle EBS 12.1.1 and 12.2.2 releases, this package underpins geography-dependent processing, allowing callers to determine which named zones a location belongs to at a specific point in time, thereby supporting date-effective and range-based geography hierarchies.

Key Procedures and Functions

The package exposes two documented program units, reflecting a focused API surface:

  • GET_ZONE — The central procedure of the package. It accepts an input location table name and location identifier, together with a requested zone type and an effective date, and returns a collection of zone records through an OUT parameter. Each returned record carries the zone identifier, name, code, and type. The procedure also follows the standard Oracle EBS API error-handling convention, returning a return status, message count, and message data to the caller, and optionally initializing the message list on entry. This design allows callers to retrieve all zones of a specified type that apply to a location as of a given date.
  • GET_CONC_NAME — A function that returns a concatenated geography name for a supplied geography identifier. It provides a convenient means of obtaining a formatted, human-readable geography description without requiring the caller to traverse the underlying TCA geography structure directly.

Tables Accessed

The package reads from a range of TCA and HR geography tables through APPS synonyms. HZ_GEOGRAPHIES and HZ_GEOGRAPHY_RANGES supply the core geography records and their range definitions, which are essential for resolving location-to-zone mappings where ranges define membership. HZ_GEOGRAPHY_TYPES_B and HZ_GEO_STRUCTURE_LEVELS provide the geography type definitions and hierarchy levels that determine how geographies are organized and classified. HZ_GEO_NAME_REFERENCES supports resolution of geography names for the concatenation function. HZ_LOCATIONS, HR_LOCATIONS_ALL, HZ_RELATIONSHIPS, and HZ_RELATIONSHIP_TYPES supply location addresses and the relationship records that link locations to geographies and zones. PLITBLM is referenced as a PL/SQL index-by table type used to hold the in-memory zone collection returned to callers. Collectively these tables enable the package to navigate from a location to its applicable zones in a date-effective manner.

Usage Notes

HZ_GEO_GET_PUB is typically invoked from custom PL/SQL code, Oracle Forms, or concurrent programs that need to determine zone membership for a location, particularly in tax, territory, and geography validation scenarios. The metadata indicates that the package is referenced by three other packages, confirming its role as a shared dependency within the TCA geography layer. Because GET_ZONE returns a NOCOPY collection and uses the standard FND_API message stack, callers should check the return status and process any generated messages before consuming the zone table. The effective-date parameter means callers must pass an appropriate date to obtain the correct point-in-time zone assignments, which is important where geography ranges and relationships are date-effective. As a published API, it should be preferred over direct queries against the underlying geography tables to ensure consistent, supported behavior across both 12.1.1 and 12.2.2 environments.