Search Results populate_loc_geography_info

Overview

ZX_TCM_GEO_JUR_PKG is a Tax Configuration Manager (TCM) utility package within the Oracle E-Business Suite ETRM (E-Business Tax) module. Its principal business function is to resolve the geographic and jurisdictional context of a transaction location so that the tax engine can determine the correct tax regime, tax jurisdiction, and tax rate for a given party location, transaction date, and tax. In practical terms, the package bridges the geography model held in the Oracle Trading Community Architecture (HZ) tables and the jurisdictional model held in the E-Business Tax (ZX) tables.

The package is declared with AUTHID CURRENT_USER, meaning it executes with the privileges of the calling schema rather than the defining schema. This is consistent with its role as a shared, low-level resolver invoked by higher-level tax determination programs and other packages. The source header identifies it as file zxcjurs.pls, version 120.13, with a patch reference dated 2009, confirming its long-standing use across the 12.1.1 and 12.2.2 code lines.

Key Procedures and Functions

• GET_ZONE — Returns zone information for a supplied location and location type at a specified transaction date, using the requested zone type. Output is returned as a collection of the HZ_GEO_GET_PUB.zone_tbl_type structure, enabling the caller to iterate over the geographies that make up the zone hierarchy.
• GET_POS_LOC_OR_SITE — Determines the appropriate location or site identifier for a given party type. This supports point-of-sale and ship-to style resolution where the tax determination flow needs to identify the operative location record.
• GET_TAX_JURISDICTIONS — The core jurisdiction resolver. Given a location, location type, tax, tax regime code, and transaction date, it returns a populated tax_jurisdiction_rec_type record and a found/not-found indicator. The record structure is defined within the package and carries jurisdiction id and code, regime code, tax, and precedence level.
• GET_MASTER_GEOGRAPHY — Resolves the master geography for a location and geography type, returning the geography identifier, code, and name. This supports mapping a specific location to its governing master geography for jurisdictional rollup.
• RETRIEVE_GEO_VALUE — Retrieves a geography value associated with a location or geography context, used in constructing the geography hierarchy required by jurisdiction queries.
• POPULATE_LOC_GEOGRAPHY_INFO — The procedure matched by the user search. It assembles and populates the geography information for a location, consolidating the geography attributes required by the other resolvers in this package. It is the entry point most commonly referenced when the objective is to build or refresh the location-to-geography relationship used during tax jurisdiction determination.

Tables Accessed

The package reads from the TCA and E-Business Tax reference tables. HZ_LOCATIONS, HZ_GEOGRAPHIES, HZ_GEOGRAPHY_TYPES_B, HZ_GEO_NAME_REFERENCES, and HZ_RELATIONSHIP_TYPES supply the geography and location model. HR_LOCATIONS_ALL provides the internal location context. ZX_JURISDICTIONS_B and its global temporary counterpart ZX_JURISDICTIONS_GT supply jurisdiction definitions, while ZX_PARTY_TYPES and ZX_LINES_DET_FACTORS support party and tax line fact resolution. FND_LOG_MESSAGES is used for debug and error logging. DUAL and DBMS_UTILITY and PLITBLM are used for utility and collection operations. The package writes no application data directly; it is a read-and-resolve component.

Usage Notes

ZX_TCM_GEO_JUR_PKG is not exposed as a direct end-user form or concurrent program. It is invoked programmatically by the E-Business Tax determination engine and is referenced by eleven other packages in the tax application stack. Developers extending tax logic typically call POPULATE_LOC_GEOGRAPHY_INFO or GET_TAX_JURISDICTIONS from custom PL/SQL when they need to replicate the standard geography-to-jurisdiction mapping. Because of the AUTHID CURRENT_USER declaration, all callers must have the necessary grants on the underlying HZ and ZX tables. This package should be treated as an internal, unsupported API for customization purposes, and any direct use should be accompanied by appropriate exception handling for the returned status variables.