Results for “iex_debug_pub”

50+ results




Overview
Explore in AI Chat

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

APPS.IEX_DEBUG_PUB is a public diagnostic utility package in the Oracle E-Business Suite Collections (Advanced Collections / IEX) product family. Its business function is to provide a controlled, centralized debugging and trace facility that application code, concurrent programs, and forms-based logic can call to record runtime messages without requiring the calling module to manage file handles, directory resolution, or log-level filtering. The package writes messages both to the Oracle Application Object Library logging framework (FND_LOG) and, under configurable conditions, to an operating-system file opened through UTL_FILE.

Because debugging in a multiuser EBS environment must be selectively enabled to avoid performance degradation, IEX_DEBUG_PUB separates the decision of whether to log from the mechanics of how to log. A session-level debug threshold is compared against each message's declared debug level before any I/O occurs. The package is a PUB-class API, meaning it is intended for reuse by other development teams and custom code, and the ETRM metadata records that it is referenced by 88 other packages, confirming its role as a broadly shared instrumentation layer rather than a module-specific helper.

Key Procedures and Functions

  • OPENFILE (function) — Resolves the target directory and opens the debug file, returning the fully qualified path as its result. When no directory has been supplied, it derives one from the database parameter utl_file_dir, trimming to the first entry when the parameter holds a comma-separated list. When no file name is passed, it constructs a default file name from the database name and session identifier with an .IEX extension; otherwise it opens the caller-supplied file in append mode. Errors during opening are trapped and reported as a null return rather than propagated.
  • LOGMESSAGE (procedure) — The primary logging entry point. It conditionally forwards the message to FND_LOG at procedure level, and additionally writes a timestamped line to the debug file when the session's debug threshold is at or above the message's declared level. The file is flushed and closed after each write so that output is visible immediately.
  • SETDEBUGLEVEL (procedure) — Establishes the session-level verbosity threshold that governs which LOGMESSAGE calls are actually persisted.
  • SETDEBUGFILEDIR (procedure) — Overrides the debug output directory, provided the supplied value is not null, allowing callers to redirect trace output away from the default derived from utl_file_dir.

Tables Accessed

  • V$PARAMETER — Read to obtain the utl_file_dir initialization parameter when no explicit directory has been set, providing the allowlisted directory from which the first entry is used.
  • DUAL — Used to derive the default debug file name from the database name and the session identifier.
  • V$DATABASE — Consulted as the source of the database name used in constructing that default file name.
  • UTL_FILE — The packaged PL/SQL file I/O interface through which debug output is opened, written, flushed, and closed on the database server.

Usage Notes

IEX_DEBUG_PUB is typically invoked from PL/SQL stored code, concurrent program logic, and forms-based server-side processing that needs diagnostic output. Callers first set a directory and debug level, then issue LOGMESSAGE calls at appropriate points. Because the actual file write is guarded by an FND_LOG runtime-level check and a package debug-level comparison, the facility is designed to be left in production code with negligible impact while debugging is disabled. The package is also compatible with the FND_LOG infrastructure, so messages surface in the standard EBS logging views. When using the file-based path, administrators must ensure the resolved directory is present in utl_file_dir and writable by the database server process; otherwise OPENFILE silently returns null and file output is suppressed, leaving only the FND_LOG channel active. This package is documented for EBS 12.1.1 and 12.2.2 and retains the same public interface across both releases.