Search Results dbms_auto_report




Overview
Explore in AI Chat

Overview

SYS.DBMS_AUTO_REPORT is a server-side PL/SQL package that provides the underlying infrastructure for Oracle's Automatic Diagnostic Repository (ADR) automatic reporting facility, exposed within the EBS 12.1.1 and 12.2.2 technology stack. The package is declared with AUTHID CURRENT_USER, meaning its procedures execute with the privileges of the invoking user rather than the definer, which allows the repository capture logic to attribute activity to the calling session and database context. Its principal business function is to capture, persist, and later retrieve diagnostic "reports" that describe the state of a component at a point in time. These reports are catalogued against a rich set of identifying attributes — database identifier, instance, container database, session and serial number, component name, and up to three caller-supplied key values — so that support personnel and diagnostic tools can reconstruct the sequence of events that led to a fault.

Key Procedures and Functions

  • START_REPORT_CAPTURE / START_REPORT_CAPTURE_HELPER — Together these initiate a capture window. The helper routine performs the internal bookkeeping that the public entry point invokes; this is the pair most directly associated with the user search term start_report_capture_helper. A successful start establishes the session, snapshot, and component context under which subsequent reports are recorded, and returns a handle used by the matching finish call.
  • FINISH_REPORT_CAPTURE / FINISH_REPORT_CAPTURE_HELPER — These close the capture window opened by the start routines, committing the captured content to the repository and releasing the handle. The helper carries out the low-level write and validation steps, raising error ERR_FIN_CAPTURE (-13554) when a capture cannot be finalised.
  • REPORT_REPOSITORY_LIST_XML — Returns an XML document listing all repository reports matching the supplied filter criteria: activity period (active_since, active_upto), snapshot, database, instance, container DBID, session and serial, component name, key1 through key3, report level, an optional top-N count, and the base path required for Flex HTML resources.
  • REPORT_REPOSITORY_DETAIL_XML — Produces an XML rendering of a single report's detailed content, suitable for display by the diagnostic viewer.
  • REPORT_REPOSITORY_DETAIL — Returns the detail record for an individual report in non-XML form for programmatic consumption.

Tables Accessed

The ETRM metadata for this object does not enumerate tables referenced through APPS synonyms, and the package is owned by SYS rather than APPS. By design the package operates against the Automatic Workload Repository and ADR report repository catalogues, writing captured report rows during the finish phase and reading them back through the list and detail functions. Because the object sits in the SYS schema, ordinary EBS application code should treat the underlying storage as internal and interact only through the documented entry points.

Usage Notes

SYS.DBMS_AUTO_REPORT is not an application-facing API. It is invoked by diagnostic tooling — the ADR command interpreter, health monitor, and incident packaging utilities — and by the four dependent packages recorded in the metadata, which call the capture routines on behalf of monitored components. In an EBS context it may be reached indirectly when a concurrent program or form triggers automatic diagnostic collection on error. Customisation is not recommended: because the package executes with invoker's rights, any direct call inherits the caller's privilege set, and its internal helpers are intended solely for use by the public start/finish wrappers. Developers diagnosing a failure should use the public functions only to inspect the repository, never to write to it directly.