Search Results x_object_version_number

Overview

APPS.HZ_WORD_RPL_COND_ATTRIBS_PKG is a private PL/SQL package body in the Oracle E-Business Suite Trading Community / Customer Master (HZ) schema. It functions as the low-level data access layer for the HZ_WORD_RPL_COND_ATTRIBS table, which stores the associative condition-attribute mappings used by the word replacement engine during outbound correspondence generation. Word replacement in Oracle EBS is the mechanism that substitutes merge fields, tokens, and personalized values into letters, statements, and other documents produced by the Oracle Receivables and Customer Master letter-generation features. The condition-to-attribute relationships held in HZ_WORD_RPL_COND_ATTRIBS determine which replacement attributes are eligible under a given replacement condition, so this package sits directly in the path of correspondence personalization.

The package is classified as OTHER in the ETRM metadata rather than as a public or private API standard, reflecting its role as an internal helper object rather than a published integration point. It provides the canonical Insert/Update/Delete/Lock operation set expected of an Oracle EBS table handler, and as such it is the object through which higher-level public APIs such as HZ_UTILITY_V2PUB and the correspondence-related public APIs physically mutate the underlying rows.

Key Procedures and Functions

• INSERT_ROW — Inserts a new association between a word replacement condition and a condition attribute into HZ_WORD_RPL_COND_ATTRIBS. In addition to the condition identifier and associated condition attribute identifier, the procedure accepts x_object_version_number. The value is passed through a DECODE against FND_API.G_MISS_NUM so that a missing sentinel is converted to NULL rather than persisted, preserving the standard Oracle EBS concurrency-control convention for new rows.
• UPDATE_ROW — Modifies an existing association, permitting the associated condition attribute identifier to be changed while the condition identifier and original attribute identifier act as the composite key. The procedure receives x_object_version_number as an IN OUT NOCOPY parameter, computes a new value as NVL(x_object_version_number, 1) + 1, writes it to the OBJECT_VERSION_NUMBER column, and returns it to the caller. This implements optimistic locking: the caller's stale version number is superseded atomically within the update.
• DELETE_ROW — Removes rows from HZ_WORD_RPL_COND_ATTRIBS. Two overloads are documented: one keyed on both the condition identifier and the associated condition attribute identifier, and one keyed on the condition identifier alone, supporting deletion of all attribute associations belonging to a condition.
• LOCK_ROW — Acquires a row-level lock on the target association so that a subsequent update or delete proceeds against a consistent, current image of the row. It is the standard EBS companion to the update path.

Tables Accessed

A single table, HZ_WORD_RPL_COND_ATTRIBS, is referenced through its APPS synonym. The package reads and writes it exclusively; INSERT_ROW and UPDATE_ROW also populate and refresh the standard EBS audit columns LAST_UPDATE_DATE, LAST_UPDATED_BY, CREATION_DATE, CREATED_BY, and LAST_UPDATE_LOGIN, taking their values from the global state maintained in HZ_UTILITY_V2PUB. The OBJECT_VERSION_NUMBER column is the sole concurrency token for the table and is written on both insert and update.

Usage Notes

Because the object is backed by no other package according to the ETRM metadata, it is not a general-purpose integration surface and should not ordinarily be called directly by customer code. Its documented consumers are the higher-level HZ public APIs and the Oracle Forms–based Customer Master and Receivables letter setup screens, which invoke these procedures as part of condition-attribute maintenance. Concurrent programs that seed or migrate word replacement conditions may also reach it indirectly. The header comment (ARHWRCAB.pls 120.0, dated 2004) indicates the package originated in Receivables and is treated as not-shipped-for-support, meaning modifications carry a lower support ceiling. In all cases, callers must manage x_object_version_number correctly: pass FND_API.G_MISS_NUM or NULL on insert, supply a current version on lock and update, and retain the incremented value returned from UPDATE_ROW for any subsequent operation on the same row.