Search Results get_message_prefixed

Overview

XLA_MESSAGES_PKG is the message-handling utility package belonging to the Subledger Accounting (XLA) module of Oracle E-Business Suite. Its principal business function is to resolve application message names into their translated text at runtime and to make that text available to XLA processing code, concurrent programs, and diagnostics. The package was originally created in December 1994 and was adapted for the XLA architecture in February 2001; the header identifier (xlacmmsg.pkh 120.2) confirms it is a long-standing, stable component that has changed little since the introduction of Subledger Accounting. In EBS 12.1.1 and 12.2.2 the package is owned by APPS and is classified in the ETRM repository as an OTHER API, meaning it is a supporting utility rather than a public integration interface.

Key Procedures and Functions

• GET_MESSAGE_PREFIXED — Returns the message text associated with a message, prefixed with the message number. This is the function most commonly located by developers searching for "get_message_prefixed". Because the prefix includes the numeric identifier, the returned string is particularly useful in exception handlers, log files, and error-stack tracing, where an operator must correlate a displayed error back to a specific message definition.
• GET_MESSAGE — Returns the message text associated with a message. The package exposes multiple overloads of this function so that callers may resolve a message by application short name and message name alone, or supply up to six token/value pairs for substitution into the message text. Each overload increases the number of tokens accepted, allowing messages containing up to six placeholders to be resolved completely.
• BUILD_MESSAGE — Constructs a message string for consumption by callers, complementing the retrieval functions by assembling the final text.

The package also exposes a global variable, g_message_number, which holds the number of the message currently being processed and which underpins the prefixed output.

Tables Accessed

The ETRM metadata for this object records no directly referenced tables through APPS synonyms. The reason is architectural: the package performs message lookup against the Oracle Forms/Application Object Library message infrastructure (the FND_MESSAGE / FND_NEW_MESSAGES and related message dictionary facilities) rather than against XLA transaction tables such as XLA_AE_HEADERS, XLA_AE_LINES, or XLA_DISTRIBUTION_LINKS. It therefore reads no subledger accounting data and writes no accounting data; its role is purely presentational.

Usage Notes

XLA_MESSAGES_PKG is not a public integration API and should not be treated as one. It is referenced by fourteen other packages within the XLA schema, where it provides consistent, translated error and informational text during subledger accounting event processing, journal entry creation, and validation. Typical invocations occur in PL/SQL exception handlers and validation routines, for example resolving a message by application short name and message name before raising an application error. Custom code that must reproduce the same error text as standard XLA processing may call GET_MESSAGE with the appropriate token pairs, or GET_MESSAGE_PREFIXED when the message number should be visible to the end user or support analyst. Because message text is language-dependent and resolved at runtime, the package automatically honors the session's language settings. Developers extending Subledger Accounting in release 12.1.1 or 12.2.2 should regard it as a read-only helper and should not modify or wrap its logic.