Search Results write_buffer

Overview

FII_MESSAGE is a shared utility package in the APPS schema that centralizes message retrieval, token substitution, and diagnostic logging for Oracle Financials Intelligence (FII) and related EBS modules. Its core purpose is to resolve a message name into the actual translated message text, expand any embedded tokens with runtime values, and either return that text to the caller or write it to an output or log buffer. The package is declared AUTHID CURRENT_USER, so it executes with the privileges of the calling session rather than the definer. The header comment ($Header: FIIUMSGS.pls 115.1 2003/12/26) and the Write_Buffer history note (created 10-04-2001 by Srini Pala) indicate the package has been part of the FII message infrastructure since the early 11i era and remains in place through 12.1.1 and 12.2.2.

Key Procedures and Functions

ETRM documents 13 procedures and functions. The following are the principal ones:

• GET_MESSAGE — The primary message-retrieval function. Four overloaded variants exist, distinguished by the number of token name/value pairs they accept (zero through four pairs). Each returns the message text, optionally with substituted token values, and takes a message name plus a show-number flag.
• MSG_TKN_EXPAND — A lower-level function that expands a single token inside a message string, given the token name and its value, and returns the resulting text.
• WRITE_BUFFER — Writes both the message name and the fully expanded message text (with token values applied) to an internal buffer. Its documented arguments are the message name, the token count, and up to five token name/value pairs. This private helper supports the GET_MESSAGE family's output handling.
• SET_LANGUAGE — Establishes the language context used when resolving and returning message text.
• WRITE_LOG — Records message or diagnostic information to the logging destination maintained by the package.
• FUNC_SUCC, FUNC_FAIL, FUNC_ENT — Standard entry, success, and failure markers used by the FII APIs to trace function execution and report outcomes consistently.
• WRITE_OUTPUT — Flushes or emits buffered message content to the caller's designated output.

All functions return VARCHAR2 where a string result is expected. No parameter lists are invented here; the signatures above are those exposed by the package specification.

Tables Accessed

The only documented table reference is DUAL, accessed through the APPS synonym. This is consistent with FII_MESSAGE acting as a pure PL/SQL utility: message definitions are supplied by the caller or resolved from the FND message tables built into the EBS framework, and the package itself needs no persistent application tables. Its work is in string assembly, token expansion, and buffer management rather than data storage.

Usage Notes

FII_MESSAGE is an infrastructure package rather than a business API. It is referenced by 34 other packages, which invoke GET_MESSAGE to produce localized, token-substituted user messages and use FUNC_ENT/FUNC_SUCC/FUNC_FAIL and WRITE_LOG to record execution status. Typical call sites include FII concurrent programs, forms-based transactions, and custom PL/SQL that needs standardized, translatable message output. Developers searching for write_buffer will find that it is a supporting function — not commonly called directly — that underpins GET_MESSAGE by persisting the message name and its expanded text to the package buffer for later retrieval by WRITE_OUTPUT. Because the package is classified as OTHER and is AUTHID CURRENT_USER, callers should ensure the session has the appropriate language and FND message context established (for example via SET_LANGUAGE) before relying on its returned text.