Results for “init_token_list”

8 results




Overview
Explore in AI Chat

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 APPS that supports the Oracle Common Modules messaging infrastructure. It provides the server-side engine used to retrieve and render "rich" (formatted, token-substituted) message text sourced from the Oracle EBS message repository. Rather than returning a plain VARCHAR2, the package assembles message content into a CLOB, allowing messages of arbitrary length and advanced text substitution to be handled without the 4000-byte ceiling that constrains standard message retrieval. This facility is used by Oracle Forms, Java-based components, and concurrent programs that need to display or transmit formatted, localized, and dynamic notification text.

The package is classified as OTHER in the ETRM repository, indicating it is a supporting utility package rather than a published business API. Its $Header comment (FUNXTMRULRTMUTB.pls 120.0) reflects its origin within the Oracle Common Modules technology stack, and it has been maintained as a steady-state utility without significant revision.

Key Procedures and Functions

  • INIT_TOKEN_LIST — Initializes the internal token list that the package uses to hold name/value substitution pairs. It resets the package-level collection and counter that drive token replacement during message rendering.
  • ADD_TOKEN — Registers a single substitution token and its replacement value into the in-memory token list. These tokens are applied when a rich message is fetched, allowing application data to be merged into the message text.
  • CLOB_REPLACE — Performs a token/string replacement operation directly against a CLOB. Implemented using DBMS_LOB primitives (ISOPEN, CREATETEMPORARY, INSTR, COPY, WRITEAPPEND, TRIM), it copies the source CLOB into a temporary CLOB, iterating over each occurrence of the search string, appending the replacement text, and returning the modified CLOB. This is the core text-substitution routine underpinning rich message rendering.
  • GET_MESSAGE — The primary public entry point that retrieves a rich message for a given application and message name, applying any registered tokens and returning the result as a CLOB.
  • GET_MESSAGE_JAVA — A companion entry point intended for invocation from Java clients, returning message content in a form consumable by Java-based EBS components (such as OA Framework or Forms Java beans).

A private helper, GET_MESSAGE_PRIVATE, is referenced internally by the public retrieval functions but is not part of the documented API surface.

Tables Accessed

  • FND_APPLICATION — Read to resolve and validate the application context (application short name/id) under which a message is defined. Message names are application-scoped, so this lookup establishes the correct namespace for retrieval.
  • DBMS_LOB — Although technically a PL/SQL built-in package, it is listed among referenced objects and is used extensively for temporary CLOB creation, searching, copying, appending, and trimming during replacement operations.
  • PLITBLM — The PL/SQL table/message backing structure accessed during message lookup and token handling.

Usage Notes

FUN_RICH_MESSAGE_PKG is typically invoked indirectly by the Oracle EBS framework rather than called directly by end users. It is exercised when a form, OA Framework page, or Java component requests a formatted message and requires token substitution or CLOB-scale text. Custom code performing multilingual or parameterized notifications may call ADD_TOKEN repeatedly, then GET_MESSAGE or GET_MESSAGE_JAVA, to obtain the fully rendered message. The package is referenced by no other documented packages, confirming it sits at the leaf of the dependency tree and is consumers-only. Note that the search term associated with this object is unrelated to its documented business purpose.