Using the Audit Data

JasperReports Server makes the audit data available to administrators through Domains and several prepared views and reports. These are located in the /Public/Audit folder of the repository.

Audit Reports in the Repository

There are two Domains and two sets of reports created for accessing audit data:

Audit Domain and Audit Reports – Use these to view the current audit data; they run against the active audit database.
Audit Archive Domain and Archived Audit Reports – Use these to run reports on archived data; they run against the archive database.

The contents of both Domains and reports are identical—they differ only in the database tables that are accessed in each case.

To create an Ad Hoc View based on the audit Domains, select Create > Ad Hoc View, select the Domains tab in the Data Chooser, and expand the folders to select one of the audit Domains.

Selecting an Audit Domain to Create an Ad Hoc View

For instructions on using Domains in reports, see the Ad Hoc chapter in JasperReports Server User Guide. For documentation of Domains in general, see the Domains chapter in the same manual.

The following sections explain the contents of the Domains and the reports that are provided.

Domain Items

The Domains expose the fields of the audit logging tables stored in the server’s internal database. As with all Domains, the database tables are joined, and the fields are presented as items that can be used in Ad Hoc views.

The following tables describe the items in both audit Domains (Audit Domain and Audit Archive Domain). These items correspond to the information that is recorded for each event. When creating a view based on either Domain, choose the items that correspond to the type of event you want to report on.

Domain items in the following table are used in general events as well as repository events:

Domain Item

Description

Date

Date event occurred.

Prop Long Value

clob value of event property, such as query.

Prop Type

Type of event property, such as destination folder, as per event map in configuration file.

Prop Value

string value of event property, such as folder name.

Time

Time event occurred.

Event Type

Type of event, such as save resource, as per event map in configuration file.

Request Type

Repository request type of event.

Resource Type

Repository type of resource accessed in event.

Resource URI

URI of repository resource.

Domain items in the following table are recorded for user events:

Domain Item

Description

E-mail

E-mail address of event user (user at time of event).

Enabled

Whether event user is currently a user.

External

Whether event user was an external user.

Full Name

Full name of event user.

Password Changed

Whether event was a change of password

Organization

Organization of event user.

User Name

UserID of event user.

Domain items in the following table are recorded for role events:

Domain Item

Description

External

Whether role was defined in an external system.

Role Name

Name of the role in the event.

Organization

Organization of the role in the event.

Domain items in the following table are recorded when a report is generated:

Domain Item

Description

Date

Date the report is generated.

Time

Time the report is generated.

Resource URI

URI of repository resource accessed for report.

Resource Type

Repository type of resource accessed for report.

Datasource URI

URI of data source accessed for report.

Query Execution Time

Time to execute the query in the database.

Report Rendering Time

Time to prepare query results for display.

Report Execution Time

Total time to execute the report (query execution + report rendering + overhead). Overhead includes tasks such as loading repository resources (report unit, data source, etc) and obtaining a DB connection from the data source.

Query

Specification of the report query.

User Name

UserID of event user.

Organization

Organization of event user.

Crosstab Group Field

Field name used in crosstab

Audit Reports and Ad Hoc Views

The audit reports and their views are blank by default, because auditing is disabled by default and no audit data exists. To view these reports, first enable auditing as described in section Configuring Auditing and Monitoring, then wait for user activity to generate events.

A number of Ad Hoc views based on the audit Domains are provided in the Public/Audit/Audit Reports folder. The same views and reports are also provided in the Archived Audit Reports subfolder. These reports are identical, except they use the Audit Archive Domain and run against the archived audit data. As with all audit material, these reports are visible only to administrators.

The reports are designed to cover common audit needs and can be used as-is. When auditing is enabled and audit events are being recorded, they will contain up-to-the-minute records of events on your server. You can run the reports or schedule them as needed.

The Ad Hoc view used to create each report is included as well. You can open these in the Ad Hoc editor to explore the audit data in real-time. You can also modify these views in the Ad Hoc Editor to generate new reports to suit your auditing requirements.

The following views and reports are provided:

Audit Report – Generic example of a an audit report showing commonly audited events.
Performance Crosstab Report – A crosstab that shows average performance of reports that were run.
Performance Report – Generates a list of reports that were run and sorted by run-time to identify slow reports.
Repository Resources Report – Shows repository resources and their associated events.
Resource Execution Report – Generates a list of reports that were run.
User Activity Report – Generates a list of reports run by a specific user.
Version: 
Feedback
randomness