Installing and using the Unused Authority Report plugin

Installing and using the Unused Authority Report plugin


Installing and using the Unused Authority Report plugin

This tool enables library staff to check if there are any authorities on their site that are not in use on any catalogue records. 

Step 1: Download the plugin

Step 2: Upload Plugin to Koha

Go to Koha administration > Plugins > Manage plugins.


If plugins have been enabled on your system there will be the option to upload plugins.

If plugins have not been enabled on your system please create a ticket to have this completed, or check the FAQ section for any tutorials related to this.

Once you have clicked Upload plugin you will be taken to a new page where you will be prompted to choose a file to upload.

Upload the plugin file downloaded earlier.

Once this has been successfully uploaded the Unused Authority Report plugin will appear:


Step 3: Configure the plugin

Once the plugin is installed, click the Actions button on the table row and a dropdown menu will appear with the option to Run report.



Clicking Run report will open a new page, where the parameters for which authorities should be reported on can be set. 



The options for this report are:


Output Data to:


This dropdown menu determines if the results of the report should appear in a Display List or CSV File.


Selecting a Display List will cause the results to appear within the application screen.


Selecting a CSV File will cause the results to be downloaded as a file to the device. 


The next line, Start record id: and Ending record id:, limits the authorities to be checked to a specific range of authority ids. The authority number can be found in the 001 control field in the authority record.


Records created on limits the report to checking actions taken on a specific date.


There is a warning about not overriding the limit of records that can be checked by the plugin at once. It is not wise to ignore this warning as this report can be very resource intensive and the site may slow if a large number of records are checked at once. If there are a large amount of authorities to be checked, do it in batches of id numbers.


If you decide to ignore this warning, it is possible to define the number of authorities to be checked at once in the box to the right of the line You can override this limit here at your own risk.


Authority type is a dropdown menu that gives the option to limit the type of authority to be checked. 


It is possible to use any combination of the limiting parameters, or use any of them in isolation. 


Once these parameters are set, click Run Report.



Step 4: Report Results

Once the output is set as Display List and the report is run, the results will appear on the screen as a table.




Version History

Version

Date

Detail

Author

1.0

07/08/20

Document created

Holly Cooper

1.2

11/08/20

Edits

Holly Cooper

2.021/10/20Migrated to Zoho as draftHolly Cooper
2.121/10/20CompletedHolly Cooper




Retention Policy

Permanent










    • Related Articles

    • Merging Authority Records

      Merging Authority Records To merge bibliographic records together you will want to go to the Cataloging module and perform a search. If you see duplicates on that search results screen you can check the boxes next to the duplicates and click the ...
    • 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 ...
    • Installing GOBI plugin

      How to install the GOBI plugin This plugin is designed to provide an easy integration for the GOBI Library Solutions from EBSCO.   It registers purchase orders into Koha based on the GOBI message it receives. It is intended to serve as a testbed so ...
    • Force Delete Plugin

      Force Delete Plugin It is very important to note that records deleted using this plugin cannot be retrieved. Unlike records deleted in batch or one at a time at the item or bibliographic screen which may be retrievable from the deleted_biblio table ...
    • Ebrary MARC Records

      Ebrary MARC Records Ebrary records are regularly updated, with the library receiving files of MARC records to add to the collection and files of existing records to be deleted from the collection.  Files of ebook records will not include item ...