Search Results hz_style_fmt_layout_v2pub




Overview
Explore in AI Chat

Overview

The APPS.HZ_STYLE_FMT_LAYOUT_V2PUB package is a public PL/SQL API that belongs to the Oracle E-Business Suite Trading Community / Receivables foundation layer. It provides a programmatic interface for creating, maintaining, and querying the layout definitions used by the flexible address and name style formatting engine. In Oracle EBS, a "style format" determines how party names and addresses are rendered for display, correspondence, and printing. The HZ_STYLE_FMT_LAYOUT record describes the individual line-level and attribute-level elements that make up such a format — for example, which attribute is placed on which line, its position, whether it is mandatory, its casing transform, surrounding delimiters, and prompting text.

This package encapsulates the business rules governing style format layout records so that callers do not write directly to the underlying tables. It enforces the standard Oracle API contract through FND_API return statuses and message-stack handling, allowing calling code to detect and propagate errors consistently within the EBS framework. The API is classified as PUB and is owned by APPS.

Key Procedures and Functions

  • CREATE_STYLE_FMT_LAYOUT — Creates a new style format layout definition. It accepts the populated style_fmt_layout_rec structure (which carries the style format code, variation number, attribute code and application, line number, position, mandatory and formatting flags, transform function, delimiters, blank-line counts, prompt, and date range) and returns the newly assigned style_fmt_layout_id along with the standard x_return_status, x_msg_count, and x_msg_data outputs. Message-stack initialization is controlled through p_init_msg_list.
  • UPDATE_STYLE_FMT_LAYOUT — Modifies an existing style format layout record. This is the procedure most commonly associated with the search term update_style_fmt_layout. It enables callers to revise layout attributes such as position, mandatory flag, delimiters, prompt, and effective dates without directly manipulating the base table.
  • GET_STYLE_FMT_LAYOUT_REC — Retrieves a single style format layout record, returning its details into the style_fmt_layout_rec_type structure. It is used for validation, inquiry, and for populating records prior to an update.

Tables Accessed

The package operates on the HZ_STYLE_FMT_LAYOUTS_B table, accessed through its APPS synonym. This is the base (non-translated) table that stores style format layout definitions. The create and update procedures insert into and modify rows in this table, while the get procedure queries it to reconstruct the record structure. Because the API abstracts the persistence details, direct DML against the table should be avoided in favor of these documented entry points.

Usage Notes

The package is typically invoked from Oracle Forms pages and concurrent programs within the Trading Community and Receivables setup flows, where administrators configure name and address style formats. Custom integrations that need to define or adjust style format layouts — for example, during data migration or configuration replication — should call the create and update procedures rather than writing to HZ_STYLE_FMT_LAYOUTS_B directly. Callers must always inspect x_return_status after each invocation and query the message stack when the status indicates error or unexpected error. The package is referenced by one other package in the EBS codebase, reflecting its role as a foundational element relied upon by higher-level formatting utilities. Effective dates on the record should be supplied consistently so that versioning behavior of style formats is preserved.