Search Results func_ent

Overview

The APPS.FII_MESSAGE package is a shared messaging and utility library used by the Oracle E-Business Suite Financial Intelligence (FII) product family. Its principal responsibility is the centralized retrieval, token substitution, and formatting of user-facing and log-facing messages. Rather than allowing individual FII programs to hard-code literals or duplicate message-resolution logic, the package exposes overloaded GET_MESSAGE functions that resolve a message name against the FII message repository and return the fully expanded text with token placeholders replaced by caller-supplied values.

The package is declared AUTHID CURRENT_USER, meaning that it executes with the privileges of the invoking schema rather than the definer. The source header (FIIUMSGS.pls 115.1, dated 2003/12/26) indicates a long-lived, stable utility that has been carried across the 11i and Release 12 code lines. It is referenced by 34 other packages, which confirms its role as a foundational dependency across the FII module set. In the context of a search for func_fail, this package is the definition point for the FUNC_FAIL routine used to record a function-level failure outcome.

Key Procedures and Functions

• GET_MESSAGE — The core retrieval routine, provided as a series of overloads that accept a message name and a show_num flag, plus zero through four token name/value pairs. Returns the resolved and expanded message string. The overloads allow callers to substitute up to four tokens without writing custom string manipulation.
• MSG_TKN_EXPAND — Performs token substitution against a supplied message string, accepting a single token name and value. Serves as the underlying expansion primitive used by the GET_MESSAGE overloads and available for direct use when the message text is already known.
• WRITE_BUFFER — Writes the message name and the actual expanded message (with token values applied) to a buffer. Documented arguments include the message name, the token count, and up to five token name/value pairs. Created by Srini Pala on 10-04-2001. This routine supports deferred or batched emission of diagnostic output.
• WRITE_LOG — Emits message content to the FII log destination for diagnostic and audit purposes.
• WRITE_OUTPUT — Emits message content to the program output destination, typically the concurrent program log or report output.
• SET_LANGUAGE — Establishes the language context used when resolving and expanding messages, ensuring translated text is returned for the active session language.
• FUNC_SUCC — Records or signals a successful function-level outcome.
• FUNC_FAIL — Records or signals a failed function-level outcome. This is the routine returned when searching for func_fail. It is used by calling programs to mark a discrete processing step as unsuccessful and to pair that status with an appropriate message emitted through the logging routines.
• FUNC_ENT — Records function entry, providing a trace marker at the start of a processing step.

Tables Accessed

The documented table reference for this package is DUAL, accessed through the APPS synonym layer. DUAL is used for single-row evaluations, such as resolving language context, evaluating conditional expressions, or confirming database connectivity within the messaging path. No application data tables are documented as being read or written by FII_MESSAGE; message text is resolved through the FII message infrastructure rather than through direct table access by the package itself. This keeps the package lightweight and safe to invoke from any FII code path.

Usage Notes

FII_MESSAGE is designed for invocation from PL/SQL rather than from Oracle Forms or concurrent program registration directly. The typical pattern is that an FII package or concurrent program calls GET_MESSAGE to obtain a formatted string, then passes that string to WRITE_LOG, WRITE_OUTPUT, or WRITE_BUFFER depending on the destination. The show_num parameter controls whether the message identifier is prefixed to the text, which is useful during debugging and undesirable in production output.

The FUNC_ENT, FUNC_SUCC, and FUNC_FAIL trio supports structured trace logging: a program marks entry, then marks either success or failure for each step. Callers of FUNC_FAIL should generally supply a companion message through GET_MESSAGE so that the failure is diagnosable from the log. Because the package is declared AUTHID CURRENT_USER, custom code invoking it must have appropriate execute grants and must run in a session where the FII message repository is accessible. Given that 34 packages reference this object, customizations should treat it as a stable interface and avoid modifications that could break dependent callers.