Search Results hz_style_fmt_layouts

Overview

HZ_STYLE_FMT_LAYOUT_V2PUB is a public PL/SQL API package in the Oracle E-Business Suite (EBS) Trading Community Architecture (TCA) / Receivables foundation layer that manages style format layout definitions for the Oracle Applications framework. Style format layouts are the attribute-driven configuration records that control how a particular business object is presented and formatted within Oracle HTML-based and self-service user interfaces — for example, the layout of a party or account record displayed in a customer-facing page or an internal administrative screen. The package is classified as a full public (PUB) API, meaning it exposes a supported, versioned interface intended to be called by other Oracle EBS modules, customer extensions, and integration code rather than being restricted to internal use.

The source header identifies the package as ARH2FLSB.pls, version 115.5, authored by rchanamo in late 2003, placing its lineage within the Receivables (AR) schema family while operating on HZ-style (Trading Community) objects. The package name carries the V2PUB suffix, indicating it belongs to the second-generation TCA public API family that standardized error handling through the x_return_status convention.

Key Procedures and Functions

The package exposes three documented entry points:

• CREATE_STYLE_FMT_LAYOUT — Creates a new style format layout record. This is the entry point used when a layout definition does not yet exist for a given style format and must be inserted into the repository. According to the package body header, the public routine delegates to the private worker procedure do_create_style_fmt_layout, which performs the actual insert and returns the record with its generated identifiers.
• UPDATE_STYLE_FMT_LAYOUT — Updates an existing style format layout record. It relies on optimistic locking semantics via p_object_version_number, so callers must supply the current version value; a mismatch causes the update to be rejected. The private counterpart is do_update_style_fmt_layout.
• GET_STYLE_FMT_LAYOUT_REC — Retrieves the full style format layout record for a specified layout, populating the style_fmt_layout_rec_type structure used by the create and update APIs. This read accessor completes the standard create/update/get triad typical of TCA public APIs.

The package body also declares private helper procedures (do_create_style_fmt_layout and do_update_style_fmt_layout) and commented-out debug scaffolding (enable_debug and disable_debug, tied to the HZ_API_FILE_DEBUG_ON and HZ_API_DBMS_DEBUG_ON profile options) that were used during development and are not active public interfaces.

Tables Accessed

The sole documented table is HZ_STYLE_FMT_LAYOUTS_B, accessed through its APPS synonym. This table stores the base (non-translated) definition of each style format layout, including the layout identifier, associated style format, and object version number. CREATE_STYLE_FMT_LAYOUT performs inserts against this table, UPDATE_STYLE_FMT_LAYOUT modifies existing rows and increments the object version, and GET_STYLE_FMT_LAYOUT_REC reads rows to populate the record type.

Usage Notes

Because this is a PUB-classified API, it is the supported mechanism for programmatic manipulation of style format layouts and should be preferred over direct DML against HZ_STYLE_FMT_LAYOUTS_B. The package is referenced by one other package in the documented dependency set, and is most commonly invoked from TCA-based Forms and self-service flows that allow administrators to define or adjust presentation layout, as well as from custom PL/SQL that provisions layout configuration during implementation or data migration. Callers must always inspect the returned x_return_status and should follow the standard TCA convention of checking for the expected success value before assuming the operation succeeded. When updating, the caller must first read the record through GET_STYLE_FMT_LAYOUT_REC (or otherwise obtain the current object version number) and pass that value into UPDATE_STYLE_FMT_LAYOUT to satisfy the concurrency check. Although the tooling associated with the package supports file and DBMS debug output gated by profile options, that instrumentation is disabled in the shipped body.