Search Results cln_np_utils_pkg




Overview
Explore in AI Chat

Overview

CLN_NP_UTILS_PKG is a utility package body in the Oracle E-Business Suite Notification Processing (CLN) module. Its stated purpose, documented in the package header comment, is to bundle all utility functions of the Notification Processing module that relate to the processing of inbound messages. The package was created by Viswanthan Umapathy on October 16, 2003, and carries a header revision of 115.0 dated October 31, 2003. In the context of Oracle EBS 12.1.1 and 12.2.2, it belongs to the collaboration messaging infrastructure that supports Oracle Collaborative Planning and related supply chain notification flows, where inbound documents and status messages must be reflected back into collaboration records.

The package is owned by APPS and is classified under ETRM as an OTHER API type rather than a formal public API. It is not referenced by any other package according to the documented metadata, indicating that it is invoked directly by forms, workflows, or event subscribers rather than being a shared dependency of the application code base. A package-level variable l_debug_level is initialized from the profile option CLN_DEBUG_LEVEL, defaulting to 5, and the procedures route diagnostic output through cln_debug_pub with the debug mode set to FILE.

Key Procedures and Functions

The documented API surface consists of four procedures and functions:

  • UPDATE_COLLABORATION — Raises a collaboration update event so that a collaboration record is updated. All procedure parameters are passed through as event parameters. It initializes the API return status to FND_API.G_RET_STS_SUCCESS, sets the message CLN_CH_EVENT_RAISED with the token EVENT set to "Update", and obtains a new event key from the CLN_GENERIC_S sequence. Debug messages are emitted at levels 1 and 2 via cln_debug_pub.
  • ADD_COLLABORATION_MESSAGE — Adds a message against a collaboration, supporting the notification processing flow for inbound messages.
  • GET_FND_MESSSAGE — Retrieves a formatted Oracle Application Object Library message, presumably wrapping FND_MESSAGE calls so callers obtain consistent message text (note the spelling in the object name).
  • CALL_TAKE_ACTIONS — This is the routine most commonly located through the search term "call_take_actions". It invokes the take-action logic associated with notification processing, allowing the package to apply the actions resulting from an inbound message, such as status transitions or follow-up processing on a collaboration.

Tables Accessed

The documented table references, resolved through APPS synonyms, are limited and largely infrastructural rather than business-data-bearing:

  • CLN_GENERIC_S — A sequence used to generate event keys. UPDATE_COLLABORATION selects CLN_GENERIC_S.nextval into a local event key variable, which is then supplied as the Workflow event key when the collaboration update event is raised.
  • WF_PARAMETER_LIST_T — The Oracle Workflow parameter list type used to assemble the event parameters passed when raising the collaboration update event. Event parameters are populated from the procedure arguments.
  • DUAL — Used for the sequence selection and other singleton expressions.

The metadata does not document direct access to CLN business tables; any reads or writes of collaboration records occur indirectly through the raised Workflow event and the notification processing framework.

Usage Notes

CLN_NP_UTILS_PKG is an internal utility layer rather than a supported integration API. Because it is classified as OTHER and is referenced by zero other packages in the documented metadata, it should be treated as private implementation of the Notification Processing module. Typical invocation paths are inbound message processing routines, Oracle Workflow event subscriptions that react to collaboration events, and custom extensions that need to raise a collaboration update or apply take actions. When calling CALL_TAKE_ACTIONS from custom code, callers should expect the standard EBS API conventions used throughout the package: an OUT NOCOPY return status initialized to FND_API.G_RET_STS_SUCCESS and an OUT NOCOPY message data buffer, with diagnostic detail controlled by the CLN_DEBUG_LEVEL profile. Direct dependencies on this package body carry upgrade risk, since the object is not a published interface and its behavior may change between 12.1.1 and 12.2.2 maintenance levels.