Search Results clear_framework
Overview
SYS.DBMS_REPORT is a core Oracle Database-supplied PL/SQL package that provides the underlying report generation and registration framework used by Oracle's diagnostic and performance infrastructure. Within the Oracle E-Business Suite 12.1.1 and 12.2.2 environments, this package is present as a VALID object owned by SYS and is exposed to the APPS schema through a public synonym. Although DBMS_REPORT is delivered as part of the database kernel rather than the EBS application code itself, its influence extends across EBS because numerous EBS-internal packages—such as PRVTEMX_ADMIN, PRVTEMX_PERF, PRVT_AWR_VIEWER, and PRVT_HDM—depend on its services to produce formatted diagnostic reports.
The package functions as a report framework abstraction layer. It allows report producers to register report definitions, components, and output formats; to build parameterized report references; and to render those reports into a variety of output formats including text, HTML, XSLT-transformed, and custom formats. In the EBS context it underpins the reporting capabilities surfaced through Oracle Enterprise Manager, Automatic Workload Repository (AWR), Active Session History (ASH), SQL Monitor, and SQL Tuning Advisor integrations.
Key Procedures and Functions
The documented API surface consists of 32 procedures and functions grouped into registration, retrieval, formatting, and utility concerns.
- Registration routines: REGISTER_COMPONENT, REGISTER_REPORT, REGISTER_XSLT_FORMAT, REGISTER_TEXT_FORMAT, REGISTER_CUSTOM_FORMAT, and REGISTER_SWF allow the framework to catalog report producers, their constituent components, and the output formats each report supports.
- Reference construction: BUILD_REPORT_REFERENCE_VARG and BUILD_REPORT_REFERENCE_STRUCT assemble a report reference from variable arguments or from a structured specification, while PARSE_REPORT_REFERENCE decomposes an existing reference back into its elements.
- Retrieval and lookup: GET_PARAM, GET_REPORT, GET_REPORT_WITH_SUMMARY, LOOKUP_COMPONENT_ID, and LOOKUP_REPORT_ID resolve stored parameters, report definitions, and internal identifiers.
- Formatting and transformation: FORMAT_REPORT, TRANSFORM_HTML_TO_TEXT, and ZLIB2BASE64_REPORT_XML convert report output between internal representations and consumable formats.
- Validation and lifecycle: VALIDATE_REPORT verifies a report definition, while CLEAR_FRAMEWORK resets the framework's in-session state.
- Utility: BUILD_GENERIC_TAG produces standard markup tags used during report assembly.
Tables Accessed
The ETRM metadata does not enumerate specific application tables accessed through APPS synonyms. Internally, DBMS_REPORT operates primarily against the WRI$_REPT_* dictionary tables, which include WRI$_REPT_ABSTRACT_T, WRI$_REPT_ADD M, WRI$_REPT_ASH, WRI$_REPT_AWRV, WRI$_REPT_CONFIG, WRI$_REPT_PERF, WRI$_REPT_SQLT, WRI$_REPT_SQLMONITOR, WRI$_REPT_STORAGE, WRI$_REPT_XPLAN, and related family members. These tables store report definitions, component registrations, format specifications, and cached report output. The package also relies on the XMLTYPE datatype for structured report content and the STANDARD package for base PL/SQL services.
Usage Notes
DBMS_REPORT is almost never invoked directly by EBS end users. Instead it is consumed indirectly by higher-level subsystems such as DBMS_ADDM, DBMS_AUTO_REPORT, DBMS_PERF, DBMS_SQLTUNE, DBMS_SQL_MONITOR, DBMS_STATS, DBMS_WORKLOAD_REPOSITORY, DBMS_XPLAN, and the EBS-specific PRVT_EMX and PRVT_HDM families. In EBS 12.1.1 and 12.2.2, diagnostic and performance reports accessed through the OAM (Oracle Applications Manager) Diagnostic and Performance dashboards, as well as through AWR and ASH reporting from within the EBS technology stack, traverse this package. Custom code should not write directly to the WRI$_REPT_* tables; instead it should register components and reports through the documented registration routines and invoke FORMAT_REPORT to render output. Because the package is owned by SYS and referenced by 49 other packages, it must be treated as a protected kernel dependency during EBS patching and cloning operations.