Search Results log_entering_method

Overview

APPS.JTF_DEBUG_PUB is a public PL/SQL utility package in Oracle E-Business Suite that provides a centralized debugging and diagnostic logging framework for the Oracle Applications technology stack. Its primary business function is to allow developers, support engineers, and administrators to capture runtime diagnostic information — method entry and exit, parameter values, unexpected errors, statements, and events — into a controlled logging mechanism without requiring changes to the underlying business code. The package is classified as PUBLIC (PUB) in ETRM, which means its procedures and functions are callable from custom code, other Oracle Applications packages, and dependent modules across the EBS schema. Because debugging information in a multi-tier EBS environment can originate on the database, middle tier, or client, JTF_DEBUG_PUB also defines a PL/SQL collection type (Debug_Tbl_Type) that carries debug records between environments before they are persisted. In Oracle EBS 12.1.1 and 12.2.2, the package is a foundational element of the FND logging infrastructure and is referenced by fifteen other packages, making it a shared dependency for application diagnostics.

Key Procedures and Functions

JTF_DEBUG_PUB exposes twenty-two documented procedures and functions. The formatting routines — FORMATNUMBER, FORMATDATE, FORMATCHAR, FORMATBOOLEAN, FORMATINDENT, and FORMATSEPERATOR — return a VARCHAR2 representation of a named parameter and its value, producing the padded, indented, and separated text that makes log output readable. GETVERSION returns the package header information, allowing callers to identify the code revision in use.

• Logging routines: DEBUG writes debugging information to a file or log destination; LOG_DEBUG records a general debug message; LOG_STATEMENT captures a SQL or procedural statement; LOG_EVENT records an application event.
• Method tracing: LOG_ENTERING_METHOD and LOG_EXITING_METHOD bracket a program unit to record entry into and exit from a procedure or function, which is the specific facility associated with the user search term "log_exiting_method". LOG_PARAMETERS records the input values passed to a program unit and is typically paired with IS_LOG_PARAMETERS_ON, which reports whether parameter logging is currently enabled.
• Error handling: HANDLE_EXCEPTIONS, LOG_EXCEPTION, and LOG_UNEXPECTED_ERROR capture exception conditions and stack context, and G_EXC_OTHERS supplies a constant for the generic OTHERS exception handler.
• Message and session utilities: GET_MESSAGES retrieves accumulated messages; SET_ICX_SESSION_ID associates debug output with the current Oracle Applications session, enabling correlation of client, middle-tier, and database activity.

Tables Accessed

The package reads and writes diagnostic data through APPS synonyms. Log output is persisted primarily in FND_LOG_MESSAGES, the central repository for EBS runtime log records. FND_NEW_MESSAGES provides the message framework used to retrieve and present logged content, and JTF_DEBUG_S stores package-level debug configuration or state. Utility dynamic SQL and session operations rely on DUAL and the DBMS_TRANSACTION and DBMS_UTILITY built-in packages, while PLITBLM supports PL/SQL table handling. UTL_FILE allows DEBUG to write debugging information to an operating-system file when a file name and path are supplied and file output is implemented. V$PARAMETER is queried to read database initialization settings that govern logging behavior.

Usage Notes

JTF_DEBUG_PUB is invoked from Forms, concurrent programs, workflow, and custom PL/SQL code wherever developers need traceability without altering functional logic. The conventional pattern is to call LOG_ENTERING_METHOD at the start of a procedure and LOG_EXITING_METHOD before each return path, optionally preceded by LOG_PARAMETERS when IS_LOG_PARAMETERS_ON returns true. Because parameter logging can be toggled at runtime, the same instrumented code can run quietly in production and become verbose during troubleshooting. Administrators and support analysts enable logging through profile options and then read results from the FND log inquiry screens backed by FND_LOG_MESSAGES. SET_ICX_SESSION_ID should be called before logging in an EBS session so that messages can be traced back to the originating user and request. Developers writing custom instrumentation should call these public APIs rather than inserting directly into FND_LOG_MESSAGES, thereby preserving the formatting, session correlation, and error-handling conventions that the package enforces.