Search Results token_tbl

Overview

CTO_MSG_PUB is a public PL/SQL package in the APPS schema that belongs to the Oracle Manufacturing product family, specifically the Configure-to-Order (CTO) module. Its documented purpose, taken directly from the package header, is to contain APIs that "control the error message handling." In practice, this package provides a lightweight, reusable mechanism by which CTO-related code — and any dependent module — can raise messages to the concurrent manager or calling application while associating those messages with dynamic substitution tokens. The package was created on 18-JAN-2002 by Shashi Bhaskaran and subsequently modified to introduce token handling (25-MAR-2002) and to expand the maximum token value length (17-MAR-2006, bug fix 5086585). The file is identified as CTOUMSGS.pls and its ETRM version string is 120.2. The API carries a PUB classification, meaning it is intended for external consumption rather than internal-only use, and it is referenced by approximately thirty other packages in the EBS instance.

Key Procedures and Functions

The package exposes two documented procedures:

• CTO_MESSAGE — The primary message-raising routine. It accepts an application short name, a message name, and an optional token collection. It resolves the message against the Oracle Message Dictionary for the specified application and optionally substitutes runtime values into the message text using the supplied tokens. Its signature uses a token table typed as CTO_MSG_PUB.token_tbl, defaulting to the package-level global G_MISS_TOKEN_TBL when no tokens are provided.
• COUNT_AND_GET — A companion routine that returns both the number of stacked messages and their concatenated payload. It is typically invoked after one or more CTO_MESSAGE calls to retrieve and clear the accumulated message buffer for downstream processing or display.

The token infrastructure is central to the package's design. The record type token_rec is defined as a pair of a token_name (VARCHAR2(30)) and a token_value (VARCHAR2(2000), enlarged from 250 in the 2006 patch). The collection type token_tbl is an associative array of token_rec indexed by BINARY_INTEGER, and the package-level global G_MISS_TOKEN_TBL serves as the default empty token set. This structure is the identifier a user searching for "token_tbl" would be directed to: it is the canonical token envelope used throughout the CTO messaging API.

Tables Accessed

The package operates against the PLITBLM table via an APPS synonym. PLITBLM is the standard Oracle Applications table used by the message-handling framework to store message text and token substitution definitions for the Oracle Message Dictionary (FND_NEW_MESSAGES family). CTO_MESSAGE reads this table to retrieve the base message payload for the given application and message name, then applies the caller's token values before the message is emitted. COUNT_AND_GET does not require additional table access; it consumes the in-memory message buffer already populated by prior emissions. No other tables are documented as being referenced by the package.

Usage Notes

CTO_MSG_PUB is designed to be invoked from PL/SQL code paths that participate in Configure-to-Order processing. Typical callers include CTO validation routines, CTO-related Concurrent Programs that need to post messages to the log file, and custom extensions that must raise CTO-specific errors in a consistent, token-aware format. Because the API is classified as PUB and is referenced by roughly thirty other packages, it should be treated as a stable integration point.

The standard invocation pattern is to call CTO_MESSAGE once per diagnostic message, passing the CTO application short name, the message name looked up in the Message Dictionary, and a populated token_tbl when the message contains substitution variables. After all messages for a logical operation have been issued, the caller invokes COUNT_AND_GET to retrieve the count and concatenated text, either for display in a form, for logging to a concurrent request output file, or for return to a calling batch process. Custom code should build the token table using the package's own token_rec and token_tbl types to guarantee type compatibility with CTO_MESSAGE. Developers extending CTO functionality should route all user-facing diagnostics through this package rather than writing directly to standard output, ensuring consistent token substitution and message retrieval behavior.