Results for “fun_rich_message_pkg”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

FUN_RICH_MESSAGE_PKG is an Oracle E-Business Suite PL/SQL package owned by the APPS schema. Its purpose is to support rich messages — message definitions whose content exceeds the capacity of ordinary FND_MESSAGE text and is therefore stored and returned as a CLOB (Character Large Object). Classic FND_MESSAGE-based messages in EBS are limited in length and are plain text; rich messages remove that constraint and allow substantially larger content, including content that requires token substitution at runtime.

The package serves the Oracle Financials family (the FUN prefix) but is implemented as a general-purpose rich message retrieval mechanism. It exposes routines to initialize a token substitution list, register name/value token pairs, resolve a storage definition into its CLOB content, and perform substitution of tokens inside that CLOB. The package is classified as OTHER in the ETRM metadata, meaning it is not a public, externally supported business API such as an open interface or an accounting API; it is an internal utility used by the applications to render long messages.

The presence of both a PL/SQL entry point and a Java entry point reflects the two environments in which rich messages must be rendered. Server-side PL/SQL code uses the PL/SQL function, while Java-based middle-tier components use the Java-oriented function and perform their own substitutions, leaving only the message retrieval to the database.

Key Procedures and Functions

• INIT_TOKEN_LIST — Initializes the package's internal token list, clearing any previously registered tokens so that a new substitution context can be built. It is the first call in any sequence that will perform token substitution.
• ADD_TOKEN — Registers a single token name and its replacement value into the initialized token list. Multiple calls accumulate the set of tokens that will be applied to the message body during substitution.
• CLOB_REPLACE — Performs token substitution directly within a CLOB. It takes the CLOB as an IN OUT NOCOPY parameter together with a search string and a replacement string, and returns the resulting CLOB. The NOCOPY hint indicates the package's intent to avoid copying large LOB values, which matters for performance when messages are sizeable. This is the routine most directly associated with the user's search term clob_replace.
• GET_MESSAGE_JAVA — Retrieves the CLOB content of a rich message identified by application short name and message name, for callers running in Java. Token substitution is expected to be handled on the Java side.
• GET_MESSAGE — The PL/SQL counterpart, returning the CLOB content of a rich message identified by application short name and message name for callers running in the database tier.

The package specification also contains a commented-out token record type and token table type declaration, indicating the token collection was at one point defined in the specification and has since been moved to the body.

Tables Accessed

The documented dependencies are FND_APPLICATION, DBMS_LOB, and PLITBLM, all referenced through APPS synonyms. FND_APPLICATION is the standard Oracle Application Object Library table that maps application short names to application identifiers; it is required to resolve the APPLICATION_SHORT_NAME argument passed to GET_MESSAGE and GET_MESSAGE_JAVA into the internal application identifier used to locate the message definition. DBMS_LOB is the Oracle-supplied LOB package and is used to read, manipulate, and return the CLOB content, consistent with the CLOB_REPLACE routine's need to operate on large character objects without full materialization. PLITBLM is a small PL/SQL table lookup package used internally by the applications layer. No other package in the documented set references FUN_RICH_MESSAGE_PKG, confirming its role as a leaf utility invoked directly by forms, Java components, or custom code rather than as a dependency of other shared packages.

Usage Notes

The package is typically invoked in a short, ordered sequence. The caller first calls INIT_TOKEN_LIST to establish a clean substitution context, then calls ADD_TOKEN one or more times to register the runtime values that must appear in the final text. The caller then obtains the raw message body via GET_MESSAGE from PL/SQL or GET_MESSAGE_JAVA from Java, and applies CLOB_REPLACE to substitute tokens within that body. Because CLOB_REPLACE accepts the CLOB as an IN OUT NOCOPY parameter, callers should be aware that the input value may be modified in place, and any original unsubstituted copy should be preserved separately if it is needed later.

Typical invocations originate from Oracle Forms through the appropriate PL/SQL libraries, from concurrent programs and other server-side PL/SQL that need to emit long formatted messages, and from customizations that must reproduce the standard rich message behavior. Because the package is classified as OTHER and is not a published, supported API, customizations that call it should treat the signature as subject to change across releases and should avoid assuming behavior beyond what is described above. The documented signature set is identical in behavior for the 12.1.1 and 12.2.2 releases.