Search Results pv_msg_pub




Overview
Explore in AI Chat

Overview

APPS.PV_MSG_PUB is the public PL/SQL message-handling package for Oracle E-Business Suite, implemented as a package body owned by the APPS schema. Within the EBS messaging architecture, PV_MSG_PUB performs a role closely analogous to FND_MSG_PUB: it maintains a private, package-global store of API messages that callers accumulate during a transaction and then interrogate or drain on completion. The package declares a PL/SQL associative array type, Msg_Tbl_Type, defined as TABLE OF VARCHAR2(2000) INDEX BY BINARY_INTEGER, and instantiates a global message table (G_msg_tbl) together with a global message counter (G_msg_count) and a fetch index (G_msg_index). All state is held in these package globals for the duration of a database session.

The package exists to give developers a lightweight mechanism for registering, counting, retrieving, and emitting API messages without requiring direct manipulation of the underlying message table. Its header comment identifies the constants used as tokens for unexpected error messages, indicating its intended use in error-trapping and exception-reporting code paths.

Key Procedures and Functions

  • INITIALIZE — Clears the global message table and resets the associated global counter and index, preparing the package for a new transaction cycle.
  • COUNT_MSG — Returns the current number of messages held in the global message list.
  • COUNT_AND_GET — Returns the message count and concatenates the accumulated message text into a single output string, fetching each entry in turn and stopping once the buffer exceeds a fixed length limit.
  • ADD — Appends a message to the global message table and increments the message count.
  • DELETE_MSG — Removes a specific message from the list and adjusts the internal counters.
  • GET — Retrieves a single message by index, supporting both encoded and unencoded output.
  • RESET — Reinitializes the message table state, equivalent in effect to clearing the accumulated list.
  • CHECK_MSG_LEVEL — Applies or evaluates the message level threshold that governs which messages are retained or surfaced.
  • BUILD_EXC_MSG — Constructs an exception message string from the accumulated list for use in error reporting.
  • ADD_EXC_MSG — Adds a message derived from the current exception context.
  • DUMP_MSG — Dumps the contents of the global message table, the diagnostic routine the user searched for under the term "dump_msg."
  • DUMP_LIST — Dumps an arbitrary message list, providing a parallel debugging aid to DUMP_MSG.

Tables Accessed

The ETRM metadata records a single referenced table accessed through an APPS synonym: PLITBLM. This is consistent with a message-handling utility that reads message definitions or attributes from a foundation table while keeping working state entirely in PL/SQL memory. No transactional application tables are documented as being read or written by this package, confirming that PV_MSG_PUB is a utility package rather than a business-entity API.

Usage Notes

PV_MSG_PUB is classified as a PUB (public) API, meaning it is intended for invocation by external callers. In practice it is called from PL/SQL API routines, concurrent program logic, forms-based code, and custom extensions that follow the standard EBS pattern of INITIALIZE at the start of processing, repeated ADD during processing, and COUNT_MSG/GET or COUNT_AND_GET at the end to report results. The DUMP_MSG and DUMP_LIST routines are diagnostic aids used during development and debugging to display the contents of the message table; they should not be relied upon in production output paths. Because all state is session-global, callers must invoke INITIALIZE before reusing the package within a single session. The ETRM metadata records no dependent packages referencing PV_MSG_PUB, so it is typically invoked directly rather than through a wrapper API.