Search Results write_output

Overview

QP_DEBUG_UTIL is a utility package owned by APPS in the Oracle E-Business Suite, classified as a UTIL (utility) API within the ETRM repository. Its principal role is to provide a standardized, reusable instrumentation and diagnostic framework for Oracle Advanced Pricing (QP) and related modules. The package centralizes debug message emission, trace timing, call-stack bookkeeping, and structured data dumps so that developers and support engineers can diagnose pricing engine behavior without altering functional code. Although the package resides in the QP schema product area, its mechanism relies on the shared OE_DEBUG_PUB infrastructure, meaning that messages routed through QP_DEBUG_UTIL surface in the Oracle Order Management / Advanced Pricing debug output stream controlled by the QP_DEBUG and ONT_DEBUG_LEVEL profile options. The 19 documented procedures support both real-time tracing and offline diagnostics, including CSV extraction of query, cursor, and table data for analysis outside the EBS runtime.

Key Procedures and Functions

The package exposes a coherent set of diagnostic entry points. WRITE_OUTPUT is the low-level message emitter; it chunks long strings into 500-byte segments and forwards them to OE_DEBUG_PUB.ADD, applying indentation and trimming based on the active QP_DEBUG setting. TSTART, TSTOP, TDUMP, and TFLUSH form the timing and trace lifecycle: TSTART marks the beginning of an instrumented region, TSTOP closes it and accumulates elapsed time, TDUMP emits accumulated timing data, and TFLUSH forces buffered trace content to the output destination. ISQPDEBUGON and ISTIMELOGDEBUGON are predicate functions that allow calling code to branch on whether debug or time-logging is currently enabled, avoiding overhead when tracing is off.

The CSV-oriented procedures—PRINT_TABLE_DATA_CSV, PRINT_QUERY_DATA_CSV, PRINT_CURSOR_DATA_CSV, PRINT_QUERYLIST_DATA_CSV, PRINT_SUPPORT_CSV, and PRINT_DEVELOPMENT_CSV—serialize result sets and diagnostic payloads into comma-separated form, typically for support escalation or development triage. SETCURRENTEVENT establishes the active trace event context, while ADDSUMMARYTIMELOG and DUMPSUMMARYTIMELOG manage aggregated timing summaries across instrumented events. SETATTRIBUTE and GETATTRIBUTE provide a simple key/value attribute store used to attach contextual metadata to trace sessions. Together these procedures cover message output, timing, event context, attributes, and structured data export.

Tables Accessed

The package references DBMS_SQL, DBMS_UTILITY, UTL_FILE, DUAL, and PLITBLM through APPS synonyms. DUAL supports trivial single-row evaluation. DBMS_SQL and the PLITBLM associative-array construct underpin the dynamic cursor and query inspection routines used by the CSV printing procedures. UTL_FILE supports file-based output for CSV generation, while DBMS_UTILITY supplies low-level utilities such as call-stack inspection that complement the package's own t_CallStack collections. No application data tables are directly read or written; the package operates purely against infrastructure and diagnostic sources.

Usage Notes

QP_DEBUG_UTIL is invoked primarily from other PL/SQL packages in the pricing and order management stack—seven packages reference it—rather than directly from forms or concurrent programs. Developers embed TSTART/TSTOP pairs and WRITE_OUTPUT calls around business logic, gating them with ISQPDEBUGON so that overhead is incurred only when QP_DEBUG is set to a tracing mode (for example 'M'). Behavior of message formatting is sensitive to QP_DEBUG values 'P', 'S', and 'M', which control trimming and indentation. The CSV routines are typically called during support investigations to extract query, cursor, or table data into a file for offline review. Because output routes through OE_DEBUG_PUB, standard debug log capture mechanisms apply. The EXCEPTION handler in WRITE_OUTPUT disables further debugging by setting g_qp_Debug to 'X', preventing recursive failures during tracing.