Search Results phone_parse




Overview

HZ_FORMAT_PHONE_V2PUB is a public PL/SQL package in the Oracle E-Business Suite Trading Community Architecture (TCA) schema, owned by APPS and declared with AUTHID CURRENT_USER. Its documented purpose is to house the public application programming interfaces used to parse a raw phone number into its component parts — country code, area code, and subscriber (phone) number — and to format a phone number for display according to the appropriate country-specific phone formats. The package is registered in ETRM with the display name "Format Phone" and is classified under the business entity HZ_CONTACT_POINT with an active lifecycle. Its reference documentation is the Oracle Trading Community Architecture Technical Implementation Guide (120hztig.pdf), section "Phone Parsing and Formatting APIs." Because phone number conventions vary widely across countries, this package centralizes the logic that normalizes and renders contact point telephone data, ensuring consistent storage and presentation of phone information across TCA-based applications.

Key Procedures and Functions

The ETRM metadata documents six procedures and functions in this package. Four are identified by name in the excerpt:

  • PHONE_PARSE — Parses a raw phone number into the country code, area code, and subscriber number, based on the setup of country and user phone preferences. Raw numbers are entered as strings of digits that must include the subscriber number and may include the international prefix, trunk prefix, country code, and area code. The parsed values are returned to the calling Contact Point API, which populates the corresponding columns in HZ_CONTACT_POINTS.
  • PHONE_DISPLAY — Formats a phone number for display using the appropriate phone format definition for the relevant country or territory.
  • CHECK_MOBILE_PHONE — Evaluates a phone number in the context of mobile phone prefix configuration.
  • GET_FORMATTED_PHONE — Returns a formatted representation of a phone number, allowing callers to retrieve a display-ready value.

The package also defines the record type user_phone_preferences_rec, which carries user territory code, default area code, and display flags for area code, all prefixes, and PABX prefix. These preferences influence how numbers are parsed and formatted. Parameter lists are not reproduced here; consumers should consult the documented API signatures in the TCA Technical Implementation Guide.

Tables Accessed

The package reads and writes data through APPS synonyms over the following tables:

  • HZ_CONTACT_POINTS — Stores the parsed country code, area code, and phone number for phone-type contact points.
  • HZ_PHONE_FORMATS — Supplies the format masks used to render numbers for display.
  • HZ_PHONE_COUNTRY_CODES — Provides country code definitions for parsing and validation.
  • HZ_PHONE_AREA_CODES — Provides area code definitions used during parsing.
  • HZ_MOBILE_PREFIXES — Supports mobile phone prefix checking.
  • HZ_PARTY_PREFERENCES — Supplies user and party phone preferences that affect parsing and formatting behavior.
  • PLITBLM — A PL/SQL internal table used for bulk operations within the package.

Usage Notes

HZ_FORMAT_PHONE_V2PUB is not typically called directly by end users. Its primary documented consumer is the Contact Point API, which invokes PHONE_PARSE when creating or updating a PHONE-type contact point and when a raw phone number is supplied, then writes the returned country code, area code, and subscriber number into HZ_CONTACT_POINTS. The package is referenced by six other packages in the TCA schema. In practice, it is exercised indirectly through TCA forms and pages that capture telephone data, and it may be invoked from custom PL/SQL integrations or concurrent programs that create or update contact points programmatically. Because it is a public (PUB) API, it is supported for customer extensions, but callers should rely on the documented signatures published in 120hztig.pdf and avoid dependencies on internal implementation details.