Search Results add_collaboration_message




Overview
Explore in AI Chat

Overview

CLN_NP_UTILS_PKG is a utility package within the Oracle E-Business Suite Collaboration module, owned by the APPS schema and classified as an OTHER API in ETRM. Its stated purpose is to bundle the utility functions of the Notification Processing module that support the processing of inbound collaboration messages. The package was created in October 2003 (header version 115.0) and is declared with AUTHID CURRENT_USER, meaning its SQL statements execute with the privileges of the invoking user rather than the package owner. The package does not carry a formal public API classification, and the ETRM metadata records that it is referenced by zero other packages, which indicates it is typically invoked directly by module code, workflows, or custom extensions rather than through a dependency chain. In the context of Oracle EBS 12.1.1 and 12.2.2, the package functions as a thin procedural layer that raises collaboration events and resolves Oracle Application Object Library (FND) messages for the inbound message flow handled by the Collaboration/Notification Processing subsystem.

Key Procedures and Functions

The documented package exposes four procedures:

  • UPDATE_COLLABORATION — Raises a collaboration update event in order to update an existing collaboration record. All procedure parameters are passed through as event parameters, and the procedure returns status and message data through OUT parameters.
  • ADD_COLLABORATION_MESSAGE — Raises an event that appends messages into the collaboration history. The arguments include an internal control number, up to five reference values, and the detail message text; status and message data are returned through OUT parameters.
  • GET_FND_MESSSAGE — Retrieves the FND message corresponding to a supplied FND message name and substitutes token values into that message. The documented arguments are the FND message name, a token name, and the corresponding token value. This is the procedure associated with the search term "get_fnd_messsage"; note the spelling used in the package is MESSSAGE with three "s" characters, which is important when referencing the procedure in custom code.
  • CALL_TAKE_ACTIONS — Listed in ETRM as the fourth documented procedure, associated with invoking take-action processing within the notification/collaboration flow.

Tables Accessed

ETRM documents three objects referenced through APPS synonyms:

  • CLN_GENERIC_S — A Collaboration module sequence, used to generate surrogate identifiers for collaboration records and events.
  • WF_PARAMETER_LIST_T — The Oracle Workflow parameter list type, used to assemble the event parameter lists passed when the UPDATE_COLLABORATION and ADD_COLLABORATION_MESSAGE events are raised.
  • DUAL — Used for single-row PL/SQL evaluations, typically when resolving FND message text or sequence values.

Usage Notes

CLN_NP_UTILS_PKG is normally invoked from Collaboration module code that processes inbound messages and from Oracle Workflow event subscriptions that consume the raised collaboration events. GET_FND_MESSSAGE is commonly called when a customized or extended flow needs the localized FND message text for a known message name, with tokens substituted for runtime values; the message name must exist in FND_MESSAGES, and the token name must match a defined token for that message. Because the package is AUTHID CURRENT_USER and not referenced by other packages, custom code should call it directly and should include the CLN module in its dependency and patching analysis. The procedure name spelling (GET_FND_MESSSAGE) must be preserved exactly in any call specification.