Search Results g_miss_token_tbl

Overview

EGO_UTIL_PK is a utility package owned by the APPS schema that supports the Publication Framework components of Oracle E-Business Suite. The Publication Framework underpins the Product Information Management (PIM) and Product Data Hub (PDH) family of applications, which manage item master data, catalogs, and content publication across the enterprise. Rather than exposing a rich business API, EGO_UTIL_PK acts as a low-level helper: it defines the common token data structures used to pass substitution values into user-facing messages, and it provides wrappers that place messages onto, and retrieve messages from, the EBS Forms message stack. Because the package is classified as OTHER in the ETRM 12.2.2 metadata, it is not a released public API; it is instead an internal building block consumed by other EGO packages.

Key Procedures and Functions

The package exposes two documented procedures, both scoped to the Publication Framework. Notably, both are implemented with AUTHID CURRENT_USER, so they execute with the privileges of the calling schema.

• PUT_FND_STACK_MSG — Pushes a formatted message onto the Oracle Forms message stack. The caller supplies the application short name, the message text, and, optionally, a token collection used to substitute placeholder values into the message. When no token collection is supplied, the procedure defaults to G_MISS_TOKEN_TBL, the package’s predefined empty token table, which signals “no substitutions.” This procedure is the primary mechanism by which Publication Framework code surfaces errors, warnings, and informational notices to end users in an EBS form.
• COUNT_AND_GET — Retrieves the accumulated messages from the Forms message stack, returning both the count of messages and the concatenated message data through its two OUT parameters. It is typically paired with the message-posting routines so that callers can capture stack contents and then decide whether to continue processing or abort the transaction.

These procedures are supported by two declared types and one global constant. TOKEN_REC is a record comprising a token name and a token value; TOKEN_TBL is a PL/SQL associative array of those records indexed by BINARY_INTEGER. The most relevant declaration in the context of this search is G_MISS_TOKEN_TBL, a package-level global of type TOKEN_TBL that is initialized as an empty collection. It functions as the canonical “missing” token argument and is referenced as the default value in the PUT_FND_STACK_MSG signature.

Tables Accessed

ETRM documents a single table reference: PLITBLM, reached through an APPS synonym. PLITBLM is the Oracle Forms message table, and access to it is consistent with the package’s role of writing to and reading from the Forms message stack via PUT_FND_STACK_MSG and COUNT_AND_GET. No other base tables are recorded as being directly accessed by this package.

Usage Notes

EGO_UTIL_PK is invoked indirectly rather than directly by end users. It is typical for Publication Framework packages, concurrent-program logic, and custom extensions built on top of PIM/PDH to call PUT_FND_STACK_MSG when they need to raise a message inside an EBS form, passing a populated TOKEN_TBL when the message text contains substitution tokens and relying on the default G_MISS_TOKEN_TBL otherwise. A caller that then needs to inspect what was posted calls COUNT_AND_GET to obtain the message count and message data before branching on the result. ETRM records that this package is referenced by one other package, confirming its role as a shared dependency rather than a top-level entry point. Because the package is undocumented as a public API and is marked “noship,” developers should treat it as internal and avoid calling it from custom code where a supported alternative exists.