Search Results hz_format_pub




Overview
Explore in AI Chat

Overview

APPS.HZ_FORMAT_PUB is a public PL/SQL package body in the Oracle E-Business Suite Trading Community Architecture (TCA) schema, validated as VALID and classified as a PUB API. Its core business function is the dynamic rendering and formatting of party, address, and name data according to configurable style formats, layouts, locales, and variations maintained in the TCA style infrastructure. Rather than hard-coding address or name presentation, HZ_FORMAT_PUB reads format definitions and layout rules from the style tables and applies them at runtime, ensuring that addresses, party names, and location data are displayed consistently with country-specific and business-specific conventions. The package is a foundational formatting utility used broadly across TCA, Oracle Receivables, Order Management, and other modules that present party and location information to users.

Key Procedures and Functions

The packaged procedures and functions (17 documented signatures) are divided into address formatting, name formatting, generic data formatting, layout resolution, and territory lookup:

  • FORMAT_ADDRESS — renders a formatted address string for a given location using the applicable style format and layout.
  • FORMAT_ELOC_ADDRESS — formats electronic (eLoc) addresses, such as email or URL entries.
  • FORMAT_ADDRESS_LAYOUT — generates address output explicitly against a specified layout definition.
  • FORMAT_ADDRESS_LOV — produces the formatted address representation used by address list-of-values (LOV) queries.
  • FORMAT_NAME — formats party or person names per the configured name style and ordering conventions.
  • FORMAT_DATA — a general-purpose formatter that applies a given format/layout specification to arbitrary input data.
  • GET_CONTEXT — resolves and returns the formatting context (style, format, and related attributes) applicable to the current invocation.
  • GET_STYLE_FORMAT — retrieves the style format definition corresponding to a given style or usage.
  • USE_NEU_COUNTRY_FORMAT — determines whether the newer configured country address format should be applied for the country in question.
  • GET_NEU_COUNTRY_CODE — returns the country code used by the newer address format logic.
  • GET_TL_TERRITORY_NAME — retrieves the translated territory (country) name from the territory translation views.
  • GET_DEFAULT_REF_TERRITORY — returns the default reference territory, typically the operating unit or system default country.

Tables Accessed

The package reads configuration and reference data from the TCA style tables, including HZ_STYLES_B, HZ_STYLE_FORMATS_B, HZ_STYLE_FMT_LAYOUTS_B, HZ_STYLE_FMT_LOCALES, and HZ_STYLE_FMT_VARIATIONS, which together define styles, their formats, layout structures, locale overrides, and format variations. Location and territory data are sourced from HZ_LOCATIONS, FND_TERRITORIES, FND_TERRITORIES_TL, and FND_TERRITORIES_VL. Metadata dictionary views FND_COLUMNS, FND_TABLES, FND_PRIMARY_KEYS, and FND_PRIMARY_KEY_COLUMNS are queried for relationship and structure definitions, while FND_LANGUAGES, FND_PROFILE, NLS_SESSION_PARAMETERS, and DBMS_SQL support language, profile, and dynamic SQL processing. All access is performed through APPS synonyms.

Usage Notes

HZ_FORMAT_PUB is typically invoked indirectly by TCA-based forms, concurrent programs, and other formatted-output routines whenever an address, name, or location must be presented in the user's configured style. It is referenced by 38 other database objects, confirming its role as a shared utility rather than an entry-point API. Custom code may call the public procedures directly to obtain consistent formatting rather than reimplementing address or name rendering logic.