Search Results iby_debug_pub




Overview
Explore in AI Chat

Overview

IBY_DEBUG_PUB is a public PL/SQL package belonging to the Oracle Payments (IBY) module in Oracle E-Business Suite, delivered under the APPS schema. Its single purpose is to centralize diagnostic message handling across the payments infrastructure. Rather than requiring each payments program to code its own conditional logging logic, IBY_DEBUG_PUB provides a consistent, reusable entry point for routing debug messages to the FND logging framework and, where applicable, to the concurrent manager log file.

The package is classified as PUB in the ETRM 12.2.2 metadata, meaning it is part of the supported public API surface and may be safely referenced by customer extensions and other Oracle modules. It is heavily embedded in the product: the metadata records that 42 other packages reference it, confirming its role as a shared utility within the Payments application. The package body carries a header revision tag (120.2.12010000.6, dated 2010), indicating it has been stable across the 12.1.1 and 12.2.2 releases.

Key Procedures and Functions

The documented API surface consists of two procedure names, ADD and LOG, spanning three overloaded procedure declarations in the package body.

  • ADD — The primary debug-writing routine. One overload accepts a message, an integer debug level, and a module identifier; a second, simplified overload accepts only the message and delegates to the first using the package-level defaults G_DEBUG_LEVEL and G_DEBUG_MODULE. ADD compares the supplied debug level against the current FND runtime logging level (fnd_log.G_CURRENT_RUNTIME_LEVEL) and writes to the FND log only when the message level is at or above the active threshold. Additionally, when the code is executing inside a concurrent request, the message is also written to the concurrent program log via FND_FILE.PUT_LINE. A WHEN OTHERS exception handler silently suppresses all errors so that diagnostic code can never disrupt business processing.
  • LOG — An unconditional logging variant. LOG accepts a module, message, and debug level. Unlike ADD, it always writes the message to the concurrent program log when running in a concurrent request context, regardless of the runtime log level, and writes to the FND log only when the debug level matches or exceeds the current threshold. LOG likewise swallows exceptions with a NULL handler.

Tables Accessed

The ETRM metadata for this package lists no direct table references through APPS synonyms. This is consistent with the source, which interacts exclusively with the FND logging and concurrent processing infrastructure: the FND_LOG package (specifically fnd_log.string and the G_CURRENT_RUNTIME_LEVEL global) and the FND_FILE package for concurrent log output. Configuration of what actually gets recorded is therefore governed by the FND profile options that control runtime logging levels, not by any payments-specific table.

Usage Notes

IBY_DEBUG_PUB is invoked programmatically, not through a forms-based user interface. Standard usage occurs in three contexts:

  • Concurrent programs — Payments batch processes that call ADD or LOG within a running request benefit from the dual output: messages appear both in the FND log and, for LOG calls (or ADD calls made in-request), directly in the concurrent program log file viewable from the Requests form.
  • Custom PL/SQL — Because the package is classified PUB and owned by APPS, developers extending Oracle Payments can call ADD or LOG from custom code to participate in the same logging framework and honor the same runtime log-level profile settings.
  • Nested Oracle packages — The 42 documented dependent packages illustrate that ADD is the standard internal idiom for defensive diagnostics; callers pass a debug level so that verbose messages cost nothing unless the administrator raises the runtime logging threshold.

Administrators control output volume by adjusting the FND runtime log level for the relevant module; setting it low produces extensive diagnostics, while a high setting effectively silences ADD calls.