How to recover information about a deleted report

How to recover information about a deleted report



It is possible to set up the system to record information about actions taken in different modules so they can be viewed later. 

This document is intended to outline how to set up the system to log details about deleted reports. 

This log will include information to allow users to retrieve the SQL used in the report if it needs to be recreated.

This will only work for reports that have been deleted AFTER the settings below have been altered.

Step 1 - Enable the ReportsLog system preference

Recording information about changes made to sql reports in the Reports module requires the system preference ReportsLog to be enabled. This will need to be set before the report is deleted.

To enable the ReportsLog, go to KOHA administration > Global System Preferences and search for ReportsLog.



This will take you to a system preference of the same name. Set this system preference to Log when reports are added deleted or changed and hit Save all Logging preferences.


How to view information about deleted reports

Once the ReportsLog has been set to log information it will be possible to use the Log Viewer tool to see information about any reports deleted from that point forward. To do this, go to Tools > Additional Tools > Log Viewer.



This will bring you to the Log Viewer tool, which facilitates searching for recorded information about any actions taken in the different modules of KOHA. This tool depends on a variety of system preferences to determine which actions to record information about, which is why the ReportsLog system preference needed to be set before any report was deleted in order for it to be searchable here. 



Setting the Log Viewer to find information on deleted reports

The Log Viewer can be set to search for actions completed in the different areas of KOHA by using the menus in the different boxes of the tool. In order to set it to search for information about deleted reports the two menus to use are Modules and Actions.


In the Modules menu, scroll down the different options and click on Reports. In the Actions menu, click Delete. Once these have been selected, hit Submit.

It is possible to use some of the other menus and cells to report more specifically, for example, using the Display from and the Display to options allows setting a date range to search for when the action would have taken place. This can be useful in limiting the number of results if there are a lot of deleted reports on your system. Also, the Log Viewer works similarly to SQL reports, in that the more lines it needs to return the more resources it uses. This means if there are a large number of lines to report it may slow the system and using the different parameter options can help reduce the resources being used. If you want more information on how to use the other aspects of the tool to make the search more specific please contact Interleaf Technology directly. 

Reading the log viewer results

After selecting the appropriate options from the different menus and hitting Submit the results will appear in a table below the Log Viewer.

The table will include the following cells:

Date:

The date and time the action was completed, in this case when the report was deleted.

Librarian:

The staff member who completed the action, in this case the staff member who deleted the report.

Module:

The area of KOHA the action occurred in, in this case Reports.

Action:

The operation that was completed, in this case a deletion.

Object:

The specific record or thing that the action was taken on. In this case this cell displays the id number of the report that was deleted.

Info:

This contains specifics about the action that was completed. In this case it shows the title of the report, in this case anon, and the sql that made up the report before it was deleted. This will allow you to extract the original SQL if you need to recreate the deleted report. 

Interface:

This shows whether the action happened on the staff side, the OPAC or the SIP machine. In this case it is the intranet, otherwise known as the staff side.

Version History 

Version

Date

Detail

Author

1.0

30/12/2019

Document Created

Holly Cooper

1.1

06/01/2020

Added comments about retrieving SQL

Charles Quain

2.0

26/05/2020

Transferred to Zoho

Daphne Hoolahan

2.1
16/02/2021
Clarifying Language and adding TOC
Holly Cooper




Retention Policy

Permanent

X


    • Related Articles

    • Restore Deleted Item Records Plugin

      This document outlines how to install and use a plugin which allows deleted item records to be restored based on the date(s) that they were deleted. Step 1 - Download the Plugin Go ...
    • How to Find and Run a SQL Report

      What are reports for? Reports are used to find and present data about the information on the system in a structured manner. This information is drawn from tables storing all information about the system which can be found here: ...
    • Overview of some SQL Report Functions

      Overview of SQL Report Functions This FAQ is an example of a simple report describing the “anatomy” of the SQL code used.  Details about the different functions are outlined in the table below the report.  Some functions are mandatory to use in order ...
    • Running the overdue report with filters

      This document will outline how to enable filters for the Overdues report under the Circulation module. By default, the Overdues report will run automatically when the Overdues button is clicked. This can be an issue on sites with a lot of overdues, ...
    • How to Find and Run an SQL Report

      What are reports for? Reports are used to find and present data about the information on the system in a structured manner. This information is drawn from tables storing all information about the system which can be found here: ...