Search Results set_option

Overview

XLA_UTILITY_PKG is the shared utility package of the Oracle Subledger Accounting (XLA) engine, delivered under the APPS schema with a source header dating to the 11i/12.0 era (xlacmutl.pkh 120.5). Its stated purpose is to provide a single wrapper layer for debugging, benchmarking, and testing facilities used throughout the XLA product family. Rather than embedding diagnostic code in every accounting program, the Subledger Accounting development team centralized trace, debug, statistics, and SRS file-handling routines in this one package, and thirty-nine other packages reference it.

The package is classified as OTHER in the ETRM metadata, reflecting the fact that it is an internal infrastructure component rather than a business-facing API. It exposes no accounting validation, no journal entry creation, and no subledger transaction logic. Its value lies entirely in observability: allowing developers and support analysts to raise the diagnostic verbosity of XLA processing, capture elapsed-time statistics for performance tuning, and route messages to the standard output, a concurrent program logfile, an HTML page, a flat file, or a pipe consumed by a separate concurrent request.

Key Procedures and Functions

The 23 documented program units divide into four functional clusters.

• Session option control: ACTIVATE, DEACTIVATE, SET_OPTION, and GET_OPTION_VALUE manage package-level options for the current session; GET_SESSION_INFO returns identifying context about that session.
• Trace control: ACTIVATE_TRACE and DEACTIVATE_TRACE bracket a tracing run, while SET_TRACE_ON and SET_TRACE_OFF toggle trace state. The user search term, deactivate_trace, corresponds directly to DEACTIVATE_TRACE, the routine that ends an active trace, flushes buffered output, and restores prior settings.
• Trace output: TRACE emits a message at a caller-supplied trace level, PRINT_TRACE_INFO renders the current trace configuration, and PRINT, PRINT_OUTPUTFILE, and PRINT_LOGFILE write messages to the active destination, the SRS output file, or the SRS logfile respectively.
• Statistics: ACTIVATE_STAT, DEACTIVATE_STAT, SET_STAT_ON, and SET_STAT_OFF control statistical collection; PRINT_STAT_INFO and GET_STAT_INFO report and return the gathered metrics.

The trace threshold is governed by the profile options xla_debug_mode (Yes/No), xla_debug_level (1 to 100), and xla_debug_timeout in seconds, so tracing granularity is tuned from the application rather than from code.

Tables Accessed

No application tables are referenced. The documented dependencies are all database or toolchain objects reached through APPS synonyms: DBMS_PIPE (delivering trace output to a waiting concurrent request), DBMS_SESSION (session state manipulation), DBMS_UTILITY (timing and diagnostic helpers for the statistics routines), HTP (HTML page generation), UTL_FILE (flat-file output), and V$PARAMETER (reading database initialization parameters relevant to the session).

Usage Notes

Two invocation patterns are documented. From a concurrent program or Oracle Forms 4.5 and later, the profile options drive the behavior automatically. From SQL*Plus, the canonical block is: call init_trace with a mode of OUTPUT or FILE and a location, execute the PL/SQL to be examined, then call trace_off. Message emission uses trace with a string and a trace level. The parallel statistics pattern calls init_stat, runs the code, then stat_off. Because the package depends on V$PARAMETER and DBMS_PIPE, privileges must be granted appropriately when the wrapper is used from custom code. Given its low-level role, releases are version-sensitive, and any direct call should be validated against the target 12.1.1 or 12.2.2 instance.