REST Based Quality Control Reports

Summary

These reports utilize the DSpace REST API to provide a Collection Manager with

* an overview of their collections
* a tool to query metadata for consistency

When deploying the DSpace REST API, and institution may choose to make the API publicly accessible or to restrict access to the API.
If these reports are deployed in a protected manner, the reporting tools can be configured to bypass DSpace authorization when reporting on collections and items.

API Calls Used in these Reports

REST Reports - Summary of API Calls

Report Screen Shots

Collection QC Report

REST Reports - Collection Report Screenshots

Metadata Query Report

REST Reports - Metadata Query Screenshots

Installation and Configuration

Prerequisites

Installing in DSpace 6

This feature is scheduled to be a part of the DSpace 6 code base.

See https://github.com/DSpace/DSpace/pull/1086

Configuring Access of the Reporting Tools

The reports can be configured with anonymous access or the reports can be configured to bypass authorization checks.

Bypassing authorization checks allows collection owners to view the status of all items in the repository without authenticating through the REST API.  This option is recommended if you have secured access to your REST API.

If your REST API is publicly accessible, deploy the reports with anonymous access and consider providing an authorization token for access to the report calls.

Enabling Sort-able Report Tables

* Install sortable.js http://www.kryogenix.org/code/browser/sorttable/
* Add to /dspace/modules/rest/src/main/webapp/static/reports
* Include sortable.js in index.html and query.html

Installing in DSpace 5

This feature is not a part of the DSpace 5 code base.

See

• Install https://github.com/DSpace/DSpace/pull/1062

• This code also exists at https://github.com/Georgetown-University-Libraries/DSpace/tree/rest-reports-for-5_x

• Change the following code into restCollReport.js and restQuery.js to pull the correct id for each DSpace Object

CHANGE

var CollReport = function() {
Report.call(this);

var QueryReport = function() {
Report.call(this);

TO

var CollReport = function() {
Report.call(this);
this.getId = function(obj) {return obj.id;}

var QueryReport = function() {
Report.call(this);
this.getId = function(obj) {return obj.id;}