Search Results message_with_context

Overview

APPS.MSC_LOG is a lightweight logging wrapper package belonging to the MSC (Advanced Supply Chain Planning / VCP) product family within Oracle EBS 12.1.1 and 12.2.2. Its design goal is not to provide logging facilities of its own, but to shield MSC application code from the Oracle Application Object Library (FND) logging API and to apply a consistent log-level gate before any message is emitted. Internally, every entry point in the package compares the caller-supplied LOG_LEVEL against FND_LOG.G_CURRENT_RUNTIME_LEVEL. If the requested level is lower than the currently active runtime level, the procedure returns immediately and no message is written; if the requested level meets or exceeds the active runtime level, the call is delegated to the corresponding FND_LOG procedure. This pattern gives MSC developers a single, uniform logging entry point and allows diagnostic output to be tuned at runtime — for example by raising or lowering the FND log level for the MSC modules — without redeploying code. The package is classified in the ETRM repository as OTHER (a utility package rather than a business API). The source header identifies the file as MSCLOGB.pls, version 120.0, last touched 2005/05/25, which places the original implementation well before the 12.1.1 release and explains why the same body appears essentially unchanged in 12.1.1 and 12.2.2.

Key Procedures and Functions

The documented interface exposes five callable units.

• STRING — The primary logging routine for plain text output. It accepts a log level, a module name, and the message, applies the runtime-level gate, and forwards the message to FND_LOG.STRING. This is the variant most commonly used for trace and debug statements in MSC batch and planning code.
• STRING_WITH_CONTEXT — An enriched variant of STRING that additionally carries execution context: an encoded flag plus node, node IP address, process ID, JVM ID, thread ID, audit session ID, and database instance. It delegates to FND_LOG.STRING_WITH_CONTEXT and is intended for environments (concurrent managers, OAF/Java-invoked processes) where correlating a message to a specific process, thread, or DB instance is valuable.
• MESSAGE — The boolean-message counterpart to STRING. It accepts a log level, a module, and a BOOLEAN pop message flag, applies the same log-level gate, and delegates to FND_LOG.MESSAGE. It is used where the diagnostic content is a simple TRUE/FALSE or yes/no condition rather than free text.
• MESSAGE_WITH_CONTEXT — The context-aware equivalent of MESSAGE, adding the same node, process, JVM, thread, session, and instance attributes described above and delegating to FND_LOG.MESSAGE_WITH_CONTEXT.
• TEST — A self-test / smoke-check entry point for the package itself, used to confirm that logging behaves as expected.

All five share the same guard: an early RETURN when the requested level is below FND_LOG.G_CURRENT_RUNTIME_LEVEL, otherwise a delegation to the matching FND_LOG routine. The package therefore adds no storage, formatting, or filtering logic of its own beyond the level check.

Tables Accessed

The ETRM metadata records no tables referenced through APPS synonyms for this package body. This is consistent with its design: all persistent handling of log messages is performed by the FND_LOG layer, while MSC_LOG itself is confined to control flow and parameter passing. No direct DML, no MSC or FND base tables, and no views are touched from within this package boundary.

Usage Notes

MSC_LOG is a developer-facing utility rather than an end-user feature. It is typically invoked from other MSC PL/SQL units — ETRM records that it is referenced by at least one other package — and would equally be appropriate inside custom extensions, concurrent program logic, or planning engine code maintained by an implementation team. Log output is only produced when the FND runtime log level for the relevant module is set at or above the level passed by the caller, so effective diagnostics depend on FND profile options such as FND: Debug Log Enabled and FND: Debug Log Level, configured through the standard Logging setup. Because the package is a thin facade over FND_LOG, it should not be used to write business audit trails or durable records; it is intended for transient diagnostic tracing. Customizations that require logging in MSC-adjacent code can safely call MSC_LOG.STRING or MSC_LOG.STRING_WITH_CONTEXT to inherit identical level-gating behavior and avoid duplicating the FND_LOG.G_CURRENT_RUNTIME_LEVEL comparison. Note that the package is supplied as an Oracle-owned object; changes should be made by wrapping it, not by altering the delivered body.