Dspace 6.X Documentation
Total Page:16
File Type:pdf, Size:1020Kb
DSpace 6.x Documentation DSpace 6.x Documentation Author: The DSpace Developer Team Date: 27 June 2018 URL: https://wiki.duraspace.org/display/DSDOC6x Page 1 of 924 DSpace 6.x Documentation Table of Contents 1 Introduction ___________________________________________________________________________ 7 1.1 Release Notes ____________________________________________________________________ 8 1.1.1 6.3 Release Notes ___________________________________________________________ 8 1.1.2 6.2 Release Notes __________________________________________________________ 11 1.1.3 6.1 Release Notes _________________________________________________________ 12 1.1.4 6.0 Release Notes __________________________________________________________ 14 1.2 Functional Overview _______________________________________________________________ 22 1.2.1 Online access to your digital assets ____________________________________________ 23 1.2.2 Metadata Management ______________________________________________________ 25 1.2.3 Licensing _________________________________________________________________ 27 1.2.4 Persistent URLs and Identifiers _______________________________________________ 28 1.2.5 Getting content into DSpace __________________________________________________ 30 1.2.6 Getting content out of DSpace ________________________________________________ 33 1.2.7 User Management __________________________________________________________ 35 1.2.8 Access Control ____________________________________________________________ 36 1.2.9 Usage Metrics _____________________________________________________________ 37 1.2.10 Digital Preservation ________________________________________________________ 39 1.2.11 System Design ___________________________________________________________ 40 2 Installing DSpace ______________________________________________________________________ 43 2.1 For the Impatient _________________________________________________________________ 44 2.2 Hardware Recommendations ________________________________________________________ 44 2.3 Prerequisite Software ______________________________________________________________ 44 2.3.1 UNIX-like OS or Microsoft Windows ____________________________________________ 45 2.3.2 Java JDK 7 or 8 (OpenJDK or Oracle JDK) ______________________________________ 45 2.3.3 Apache Maven 3.0.5 or above (3.3.9+)* (Java build tool) ____________________________ 46 2.3.4 Apache Ant 1.8 or later (Java build tool) _________________________________________ 47 2.3.5 Relational Database: (PostgreSQL or Oracle) ____________________________________ 47 2.3.6 Servlet Engine (Apache Tomcat 7 or later, Jetty, Caucho Resin or equivalent) ___________ 49 2.3.7 Git (code version control) ____________________________________________________ 51 2.4 Installation Instructions _____________________________________________________________ 51 2.4.1 Overview of Install Options ___________________________________________________ 51 2.4.2 Overview of DSpace Directories _______________________________________________ 52 2.4.3 Installation ________________________________________________________________ 53 2.5 Advanced Installation ______________________________________________________________ 62 2.5.1 'cron' jobs / scheduled tasks __________________________________________________ 62 2.5.2 Multilingual Installation ______________________________________________________ 63 2.5.3 DSpace over HTTPS ________________________________________________________ 63 2.5.4 The Handle Server _________________________________________________________ 69 2.5.5 Google and HTML sitemaps __________________________________________________ 72 27-Jun-2018 https://wiki.duraspace.org/display/DSDOC6x Page 2 of 924 DSpace 6.x Documentation 2.5.6 Statistics _________________________________________________________________ 73 2.5.7 External database connection pool _____________________________________________ 73 2.6 Windows Installation _______________________________________________________________ 75 2.7 Checking Your Installation __________________________________________________________ 75 2.8 Known Bugs _____________________________________________________________________ 75 2.9 Common Problems ________________________________________________________________ 76 2.9.1 Common Installation Issues __________________________________________________ 76 2.9.2 General DSpace Issues _____________________________________________________ 77 3 Upgrading DSpace ____________________________________________________________________ 79 3.1 Release Notes / Significant Changes __________________________________________________ 81 3.2 Backup your DSpace ______________________________________________________________ 82 3.3 Update Prerequisite Software (as necessary) ___________________________________________ 82 3.4 Upgrade Steps ___________________________________________________________________ 83 3.5 Troubleshooting Upgrade Issues _____________________________________________________ 91 3.5.1 "Ignored" Flyway Migrations __________________________________________________ 91 3.5.2 Manually Upgrading Solr Indexes ______________________________________________ 92 4 Using DSpace ________________________________________________________________________ 94 4.1 Authentication and Authorization _____________________________________________________ 94 4.1.1 Authentication Plugins _______________________________________________________ 94 4.1.2 Embargo ________________________________________________________________ 118 4.1.3 Managing User Accounts ___________________________________________________ 139 4.1.4 Request a Copy __________________________________________________________ 143 4.2 Exporting Content and Metadata ____________________________________________________ 152 4.2.1 OAI ____________________________________________________________________ 152 4.2.2 Exchanging Content Between Repositories _____________________________________ 171 4.2.3 SWORDv1 Client _________________________________________________________ 172 4.2.4 Linked (Open) Data ________________________________________________________ 173 4.3 Ingesting Content and Metadata ____________________________________________________ 185 4.3.1 Submission User Interface __________________________________________________ 186 4.3.2 Configurable Workflow _____________________________________________________ 228 4.3.3 Importing and Exporting Content via Packages __________________________________ 242 4.3.4 Importing and Exporting Items via Simple Archive Format __________________________ 249 4.3.5 Registering Bitstreams via Simple Archive Format ________________________________ 262 4.3.6 Importing Items via basic bibliographic formats (Endnote, BibTex, RIS, TSV, CSV) and online services (OAI, arXiv, PubMed, CrossRef, CiNii) ___________________________________________ 265 4.3.7 Importing Community and Collection Hierarchy __________________________________ 276 4.3.8 SWORDv1 Server _________________________________________________________ 278 4.3.9 SWORDv2 Server _________________________________________________________ 285 4.3.10 Ingesting HTML Archives __________________________________________________ 298 4.4 Items and Metadata ______________________________________________________________ 299 4.4.1 Authority Control of Metadata Values __________________________________________ 299 4.4.2 Batch Metadata Editing _____________________________________________________ 303 4.4.3 DOI Digital Object Identifier __________________________________________________ 312 27-Jun-2018 https://wiki.duraspace.org/display/DSDOC6x Page 3 of 924 DSpace 6.x Documentation 4.4.4 Item Level Versioning ______________________________________________________ 323 4.4.5 Mapping Items ____________________________________________________________ 333 4.4.6 Metadata Recommendations ________________________________________________ 334 4.4.7 Moving Items _____________________________________________________________ 336 4.4.8 ORCID Integration _________________________________________________________ 336 4.4.9 PDF Citation Cover Page ___________________________________________________ 350 4.4.10 Updating Items via Simple Archive Format _____________________________________ 353 4.5 Managing Community Hierarchy ____________________________________________________ 356 4.5.1 Sub-Community Management _______________________________________________ 356 4.6 Statistics and Metrics _____________________________________________________________ 358 4.6.1 DSpace Google Analytics Statistics ___________________________________________ 358 4.6.2 Elasticsearch Usage Statistics _______________________________________________ 360 4.6.3 SOLR Statistics ___________________________________________________________ 364 4.7 User Interfaces __________________________________________________________________ 390 4.7.1 Discovery _______________________________________________________________ 390 4.7.2 Localization L10n _________________________________________________________ 414 4.7.3 JSPUI Configuration and Customization ________________________________________ 419 4.7.4 XMLUI Configuration and Customization _______________________________________ 422 5 System Administration _________________________________________________________________ 491 5.1 Introduction to DSpace System Administration _________________________________________ 491 5.2 AIP Backup and Restore __________________________________________________________ 492 5.2.1 Background & Overview ____________________________________________________