Page History
...
Report Screen Shots
Collection QC Report
REST Reports - Collection Report Screenshots with Annotated API Calls
Metadata Query Report
REST Reports - Metadata Query Screenshots with Annotated API Calls
Installation and Configuration
...
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
Disabling the REST Reports
The REST reports will be enabled by default in DSpace 6. To disable the execution of these reports, remove the following line from dspace-rest/src/main/webapp/WEB-INF/web.xml
Code Block | ||
---|---|---|
| ||
<servlet-mapping>
<servlet-name>default</servlet-name>
<url-pattern>/static/*</url-pattern>
</servlet-mapping> |
Configuring Access of the Reporting Tools
The reports can be configured with anonymous access or the reports can be configured to bypass authorization checks.
...
Code Block | ||
---|---|---|
| ||
# Enable/disable authorization for the reporting tools. # By default, the DSpace REST API will only return communities/collections/items that are accessible to a particular user. # If the REST API has been deployed in a protected manner, the reporting tools can be configured to bypass authorization checks. # This will allow all items/collections/communities to be returned to the report user. # Set the rest-reporting-authenticate option to false to bypass authorization rest-reporting-authenticate = false |
Configure the REST Reports that can be requested by name
Code Block |
---|
# Configure the report pages that can be requested by name # Create a map of named reports that are available to a report tool user # Each map entry should be prefixed with rest-report-url # The map key is a name for a report # The map value is a URL to a report page # A list of available reports will be available with the call /rest/reports. # If a request is sent to /rest/reports/[report key], the request will be re-directed to the specified URL # # This project currently contains 2 sample reports. Eventually, additional reports could be introduced through this mechanism. rest-report-url.collections = /rest/static/index.html rest-report-url.item-query = /rest/static/query.html |
Configure the database-specific format for a regex expression
Code Block |
---|
# The REST Report Tools may pass a regular expression test to the database. # The following configuration setting will construct a SQL regular expression test appropriate to your database engine rest-regex-clause = text_value ~ ? |
Configure the sets of filters of interest to your repository managers
Code Block |
---|
# A filter contains a set of tests that will be applied to an item to determine its inclusion in a particular report. # Private items and withdrawn items are frequently excluded from DSpace reports. # Additional filters can be configured to examine other item properties. # For instance, items containing an image bitstream often have different requirements from a item containing a PDF. # The DSpace REST reports come with a variety of filters that examine item properties, item bitstream properties, # and item authorization policies. The existing filters can be used as an example to construct institution specific filters # that will test conformity to a set of institutional policies. # plugin.sequence.org.dspace.rest.filter points to a list of classes that contain available filters. # Each class must implement the ItemFilterList interface. # ItemFilterDefs: Filters that examine simple item and bitstream type properties # ItemFilterDefsMisc: Filters that examine bitstream mime types and dependencies between bitstreams # ItemFilterDefsMeta: Filters that examine metadata properties # ItemFilterDefsPerm: Filters that examine item and bitstream authorization policies plugin.sequence.org.dspace.rest.filter.ItemFilterList = \ org.dspace.rest.filter.ItemFilterDefs,\ org.dspace.rest.filter.ItemFilterDefsMisc,\ org.dspace.rest.filter.ItemFilterDefsPerm # org.dspace.rest.filter.ItemFilterDefsMeta,\ |
Other filter configuration settings
The configuration file contains other settings that will control the behavior of the filters that you have enabled.
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
Code Block language xml title Uncomment the following in index.html and query.html <!-- <script src="sorttable.js"></script> -->
Enable sortable in the report code in restCollReport.js and restQueryReport.js
Code Block language js title CHANGE var CollReport = function() { Report.call(this); //If sortable.js is included, uncomment the following //this.hasSorttable = function(){return true;} var QueryReport = function() { Report.call(this); //If sortable.js is included, uncomment the following //this.hasSorttable = function(){return true;}
Code Block language js title CHANGE TO var CollReport = function() { Report.call(this); //If sortable.js is included, uncomment the following this.hasSorttable = function(){return true;} var QueryReport = function() { Report.call(this); //If sortable.js is included, uncomment the following this.hasSorttable = function(){return true;}
Installing in DSpace 5
This feature is not a part of the DSpace 5 code base. Please see the following notes to enable a DSpace 5 compatible version of these reports.
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
Code Block language js title Change the following in restCollReport.js and restQuery.js var CollReport = function() { Report.call(this); var QueryReport = function() { Report.call(this);
Code Block language js title Change 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;}