Search Results py_log

Overview

APPS.PAY_PROC_LOGGING is a shared Oracle EBS PL/SQL utility package that provides the standard logging infrastructure for Oracle Payroll batch processing. Its header identifier, pycolog.pkb, confirms its role as the payroll "co-logging" package, and its procedures are called throughout the payroll processing engine to record entry, exit, and general tracing information to a log file. The package operates against a set of global state variables held in PAY_PROC_ENVIRONMENT_PKG — notably logging_category, logging_level, and process_env_type — to decide whether a given message should be written and how it should be indented. This design allows the same payroll code to run with verbose diagnostic logging enabled or effectively silent, without any change to the calling routines. In Oracle EBS 12.1.1 and 12.2.2 it is classified as API classification OTHER and is referenced by six other packages, underscoring its role as a foundational cross-cutting service rather than a business-facing API.

Key Procedures and Functions

• PY_ENTRY — Standard log entry point for batch processing. Writes an "In { routine_name" trace line, indented according to the current logging level, then increments the level.
• PY_EXIT — Standard log exit point for batch processing. Decrements the logging level, then writes a matching "Out } routine_name" line at the reduced indentation.
• PY_LOG — General-purpose logging call, used for the PY_GENERAL category, writing the caller's message when general logging is enabled.
• PY_LOG_WRT — Low-level writer that emits the print string directly to the log file; other routines in the package route through it.
• PY_LOG_TXT — Logging variant intended for text output, following the same category-gated pattern.
• PY_LOG_FORMULA — Logging variant intended for formula-related diagnostic output, typically used when tracing payroll formula execution.
• INIT_LOGGING — Initializes the logging subsystem, establishing the session's logging state at the start of a process.
• DEINIT_LOGGING — Tears down logging state at the end of a process, complementing INIT_LOGGING.
• INIT_FORM_LOGGING — Initializes logging for an Oracle Forms (client-side) context, providing an equivalent entry point for form-driven processing.
• DEINIT_FORM_LOGGING — Terminates form-context logging, released when the form session completes its logging.

Tables Accessed

Per the documented metadata, the only referenced object is the DBMS_LOB package (accessed via an APPS synonym). This indicates that log output — particularly for larger text or CLOB content, such as formula traces — is written using Oracle's built-in large object utilities rather than through direct DML against application tables. No payroll base tables or interface tables are documented as being queried or updated by this package; its state is maintained in memory through PAY_PROC_ENVIRONMENT_PKG and its output is directed to the log file.

Usage Notes

PAY_PROC_LOGGING is generally not invoked directly by end users. It is embedded within payroll processing code, where routines bracket their logic with PY_ENTRY and PY_EXIT and emit intermediate messages through PY_LOG and its variants. Because the six packages that reference it rely on its indentation and category filtering, custom payroll extensions that need consistent trace output should adopt the same conventions rather than writing directly to a file. The INIT_LOGGING and DEINIT_LOGGING pair is called once at the start and end of a batch or concurrent program session, while INIT_FORM_LOGGING and DEINIT_FORM_LOGGING serve the equivalent purpose for Oracle Forms sessions. Whether any message actually appears depends on the logging category and level configured in the payroll process environment, making the package safe to call unconditionally in production code.