Old Release
This documentation relates to an old version of DSpace, version 6.x. Looking for another version? See all documentation.
Support for DSpace 6 ended on July 1, 2023. See Support for DSpace 5 and 6 is ending in 2023
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
DSpace 6
See https://github.com/DSpace/DSpace/pull/1086
DSpace 5
This feature is not a part of the DSpace 5 code base.
See
Install https://github.com/DSpace/DSpace/pull/1062
```
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;}```
This code also exists at https://github.com/Georgetown-University-Libraries/DSpace/tree/rest-reports-for-5_x
Add the following code into restCollReport.js and restQuery.js to pull the correct id for each DSpace Object
* **DSpace5** See [Using this code with DSpace5](https://github.com/DSpace-Labs/DSpace-REST-Reports/wiki/Using-these-reports-with-DSpace-5)
* Determine the access that you will grant to your REST api since these reporting tools can be configured to run without authentication.
* Update the dspace/config/modules/rest.cfg
* [Enabling Sortable Report Tables](https://github.com/DSpace-Labs/DSpace-REST-Reports/wiki/Enabling-Sortable-Report-Tables)