DSpace 6.x Documentation DSpace 6.x Documentation Author: The DSpace Developer Team Date: 08 September 2017 URL: https://wiki.duraspace.org/display/DSDOC6x Page 1 of 904 DSpace 6.x Documentation Table of Contents 1 Introduction ___________________________________________________________________________ 7 1.1 Release Notes ____________________________________________________________________ 8 1.1.1 6.2 Release Notes ___________________________________________________________ 8 1.1.2 6.1 Release Notes ___________________________________________________________ 9 1.1.3 6.0 Release Notes __________________________________________________________ 11 1.2 Functional Overview _______________________________________________________________ 19 1.2.1 Online access to your digital assets ____________________________________________ 20 1.2.2 Metadata Management ______________________________________________________ 22 1.2.3 Licensing _________________________________________________________________ 24 1.2.4 Persistent URLs and Identifiers ________________________________________________ 25 1.2.5 Getting content into DSpace __________________________________________________ 27 1.2.6 Getting content out of DSpace ________________________________________________ 30 1.2.7 User Management __________________________________________________________ 32 1.2.8 Access Control ____________________________________________________________ 33 1.2.9 Usage Metrics _____________________________________________________________ 34 1.2.10 Digital Preservation ________________________________________________________ 36 1.2.11 System Design ___________________________________________________________ 37 2 Installing DSpace ______________________________________________________________________ 40 2.1 For the Impatient _________________________________________________________________ 41 2.2 Hardware Recommendations ________________________________________________________ 41 2.3 Prerequisite Software ______________________________________________________________ 41 2.3.1 UNIX-like OS or Microsoft Windows ____________________________________________ 42 2.3.2 Java JDK 7 or 8 (OpenJDK or Oracle JDK) ______________________________________ 42 2.3.3 Apache Maven 3.0.5 or above (3.3.9+)* (Java build tool) ____________________________ 43 2.3.4 Apache Ant 1.8 or later (Java build tool) _________________________________________ 44 2.3.5 Relational Database: (PostgreSQL or Oracle) ____________________________________ 44 2.3.6 Servlet Engine (Apache Tomcat 7 or later, Jetty, Caucho Resin or equivalent) ___________ 46 2.4 Installation Instructions _____________________________________________________________ 48 2.4.1 Overview of Install Options ___________________________________________________ 48 2.4.2 Overview of DSpace Directories _______________________________________________ 49 2.4.3 Installation ________________________________________________________________ 49 2.5 Advanced Installation ______________________________________________________________ 59 2.5.1 'cron' jobs / scheduled tasks __________________________________________________ 59 2.5.2 Multilingual Installation ______________________________________________________ 59 2.5.3 DSpace over HTTPS ________________________________________________________ 60 2.5.4 The Handle Server _________________________________________________________ 65 2.5.5 Google and HTML sitemaps __________________________________________________ 69 2.5.6 Statistics _________________________________________________________________ 70 2.6 Windows Installation _______________________________________________________________ 70 08-Sep-2017 https://wiki.duraspace.org/display/DSDOC6x Page 2 of 904 DSpace 6.x Documentation 2.7 Checking Your Installation __________________________________________________________ 70 2.8 Known Bugs _____________________________________________________________________ 70 2.9 Common Problems ________________________________________________________________ 71 2.9.1 Common Installation Issues __________________________________________________ 71 2.9.2 General DSpace Issues _____________________________________________________ 72 3 Upgrading DSpace ____________________________________________________________________ 74 3.1 Release Notes / Significant Changes __________________________________________________ 75 3.2 Backup your DSpace ______________________________________________________________ 77 3.3 Update Prerequisite Software (as necessary) ___________________________________________ 77 3.4 Upgrade Steps ___________________________________________________________________ 78 3.5 Troubleshooting Upgrade Issues _____________________________________________________ 85 3.5.1 "Ignored" Flyway Migrations __________________________________________________ 85 3.5.2 Manually Upgrading Solr Indexes ______________________________________________ 86 4 Using DSpace ________________________________________________________________________ 88 4.1 Authentication and Authorization _____________________________________________________ 88 4.1.1 Authentication Plugins _______________________________________________________ 88 4.1.2 Embargo ________________________________________________________________ 110 4.1.3 Managing User Accounts ___________________________________________________ 131 4.1.4 Request a Copy __________________________________________________________ 135 4.2 Exporting Content and Metadata ____________________________________________________ 144 4.2.1 OAI ____________________________________________________________________ 144 4.2.2 Exchanging Content Between Repositories _____________________________________ 163 4.2.3 SWORDv1 Client _________________________________________________________ 164 4.2.4 Linked (Open) Data ________________________________________________________ 165 4.3 Ingesting Content and Metadata ____________________________________________________ 177 4.3.1 Submission User Interface __________________________________________________ 178 4.3.2 Configurable Workflow _____________________________________________________ 220 4.3.3 Importing and Exporting Content via Packages __________________________________ 234 4.3.4 Importing and Exporting Items via Simple Archive Format __________________________ 241 4.3.5 Registering Bitstreams via Simple Archive Format ________________________________ 254 4.3.6 Importing Items via basic bibliographic formats (Endnote, BibTex, RIS, TSV, CSV) and online services (OAI, arXiv, PubMed, CrossRef, CiNii) ___________________________________________ 257 4.3.7 Importing Community and Collection Hierarchy __________________________________ 268 4.3.8 SWORDv1 Server _________________________________________________________ 270 4.3.9 SWORDv2 Server _________________________________________________________ 277 4.3.10 Ingesting HTML Archives __________________________________________________ 288 4.4 Items and Metadata ______________________________________________________________ 289 4.4.1 Authority Control of Metadata Values __________________________________________ 289 4.4.2 Batch Metadata Editing _____________________________________________________ 293 4.4.3 DOI Digital Object Identifier __________________________________________________ 302 4.4.4 Item Level Versioning ______________________________________________________ 313 4.4.5 Mapping Items ____________________________________________________________ 323 4.4.6 Metadata Recommendations ________________________________________________ 325 08-Sep-2017 https://wiki.duraspace.org/display/DSDOC6x Page 3 of 904 DSpace 6.x Documentation 4.4.7 Moving Items _____________________________________________________________ 326 4.4.8 ORCID Integration _________________________________________________________ 327 4.4.9 PDF Citation Cover Page ___________________________________________________ 340 4.4.10 Updating Items via Simple Archive Format _____________________________________ 343 4.5 Managing Community Hierarchy ____________________________________________________ 346 4.5.1 Sub-Community Management _______________________________________________ 346 4.6 Statistics and Metrics _____________________________________________________________ 348 4.6.1 DSpace Google Analytics Statistics ___________________________________________ 348 4.6.2 Elasticsearch Usage Statistics _______________________________________________ 350 4.6.3 SOLR Statistics ___________________________________________________________ 354 4.7 User Interfaces __________________________________________________________________ 380 4.7.1 Discovery _______________________________________________________________ 380 4.7.2 Localization L10n _________________________________________________________ 403 4.7.3 JSPUI Configuration and Customization ________________________________________ 408 4.7.4 XMLUI Configuration and Customization _______________________________________ 411 5 System Administration _________________________________________________________________ 480 5.1 Introduction to DSpace System Administration _________________________________________ 480 5.2 AIP Backup and Restore __________________________________________________________ 481 5.2.1 Background & Overview ____________________________________________________ 482 5.2.2 Running the Code _________________________________________________________ 487 5.2.3 Command Line Reference __________________________________________________ 500 5.2.4 Configuration in 'dspace.cfg' _________________________________________________