DSpace Manual
User Manual:
Open the PDF directly: View PDF 
.
Page Count: 901
| Download | |
| Open PDF In Browser | View PDF |
DSpace 6.x Documentation
DSpace 6.x
Documentation
Author:
The DSpace Developer Team
Date:
13 July 2017
URL:
https://wiki.duraspace.org/display/DSDOC6x
Page 1 of 901
DSpace 6.x Documentation
Table of Contents
1 Introduction ___________________________________________________________________________ 7
1.1
1.2
Release Notes ____________________________________________________________________ 8
1.1.1
6.1 Release Notes ___________________________________________________________ 8
1.1.2
6.0 Release Notes __________________________________________________________ 11
Functional Overview _______________________________________________________________ 18
1.2.1
Online access to your digital assets ____________________________________________ 19
1.2.2
Metadata Management ______________________________________________________ 21
1.2.3
Licensing _________________________________________________________________ 23
1.2.4
Persistent URLs and Identifiers ________________________________________________ 24
1.2.5
Getting content into DSpace __________________________________________________ 26
1.2.6
Getting content out of DSpace ________________________________________________ 29
1.2.7
User Management __________________________________________________________ 31
1.2.8
Access Control ____________________________________________________________ 32
1.2.9
Usage Metrics _____________________________________________________________ 33
1.2.10
Digital Preservation ________________________________________________________ 35
1.2.11
System Design ___________________________________________________________ 36
2 Installing DSpace ______________________________________________________________________ 39
2.1
For the Impatient _________________________________________________________________ 40
2.2
Hardware Recommendations ________________________________________________________ 40
2.3
Prerequisite Software ______________________________________________________________ 40
2.4
2.5
2.3.1
UNIX-like OS or Microsoft Windows ____________________________________________ 41
2.3.2
Java JDK 7 or 8 (OpenJDK or Oracle JDK) ______________________________________ 41
2.3.3
Apache Maven 3.0.5 or above (3.3.9+)* (Java build tool) ____________________________ 42
2.3.4
Apache Ant 1.8 or later (Java build tool) _________________________________________ 43
2.3.5
Relational Database: (PostgreSQL or Oracle) ____________________________________ 43
2.3.6
Servlet Engine (Apache Tomcat 7 or later, Jetty, Caucho Resin or equivalent) ___________ 45
Installation Instructions _____________________________________________________________ 47
2.4.1
Overview of Install Options ___________________________________________________ 47
2.4.2
Overview of DSpace Directories _______________________________________________ 48
2.4.3
Installation ________________________________________________________________ 48
Advanced Installation ______________________________________________________________ 58
2.5.1
'cron' jobs / scheduled tasks __________________________________________________ 58
2.5.2
Multilingual Installation ______________________________________________________ 58
2.5.3
DSpace over HTTPS ________________________________________________________ 59
2.5.4
The Handle Server _________________________________________________________ 64
2.5.5
Google and HTML sitemaps __________________________________________________ 67
2.5.6
Statistics _________________________________________________________________ 68
2.6
Windows Installation _______________________________________________________________ 68
2.7
Checking Your Installation __________________________________________________________ 69
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 2 of 901
DSpace 6.x Documentation
2.8
Known Bugs _____________________________________________________________________ 69
2.9
Common Problems ________________________________________________________________ 69
2.9.1
Common Installation Issues __________________________________________________ 70
2.9.2
General DSpace Issues _____________________________________________________ 71
3 Upgrading DSpace ____________________________________________________________________ 73
3.1
Release Notes / Significant Changes __________________________________________________ 74
3.2
Backup your DSpace ______________________________________________________________ 76
3.3
Update Prerequisite Software (as necessary) ___________________________________________ 76
3.4
Upgrade Steps ___________________________________________________________________ 77
3.5
Troubleshooting Upgrade Issues _____________________________________________________ 84
3.5.1
"Ignored" Flyway Migrations __________________________________________________ 84
3.5.2
Manually Upgrading Solr Indexes ______________________________________________ 85
4 Using DSpace ________________________________________________________________________ 87
4.1
4.2
4.3
Authentication and Authorization _____________________________________________________ 87
4.1.1
Authentication Plugins _______________________________________________________ 87
4.1.2
Embargo ________________________________________________________________ 109
4.1.3
Managing User Accounts ___________________________________________________ 130
4.1.4
Request a Copy __________________________________________________________ 134
Exporting Content and Metadata ____________________________________________________ 143
4.2.1
OAI ____________________________________________________________________ 143
4.2.2
Exchanging Content Between Repositories _____________________________________ 162
4.2.3
SWORDv1 Client _________________________________________________________ 163
4.2.4
Linked (Open) Data ________________________________________________________ 164
Ingesting Content and Metadata ____________________________________________________ 176
4.3.1
Submission User Interface __________________________________________________ 177
4.3.2
Configurable Workflow _____________________________________________________ 219
4.3.3
Importing and Exporting Content via Packages __________________________________ 233
4.3.4
Importing and Exporting Items via Simple Archive Format __________________________ 240
4.3.5
Registering Bitstreams via Simple Archive Format ________________________________ 253
4.3.6
Importing Items via basic bibliographic formats (Endnote, BibTex, RIS, TSV, CSV) and online
services (OAI, arXiv, PubMed, CrossRef, CiNii) ___________________________________________ 256
4.4
4.3.7
Importing Community and Collection Hierarchy __________________________________ 267
4.3.8
SWORDv1 Server _________________________________________________________ 269
4.3.9
SWORDv2 Server _________________________________________________________ 276
4.3.10
Ingesting HTML Archives __________________________________________________ 287
Items and Metadata ______________________________________________________________ 288
4.4.1
Authority Control of Metadata Values __________________________________________ 288
4.4.2
Batch Metadata Editing _____________________________________________________ 292
4.4.3
DOI Digital Object Identifier __________________________________________________ 301
4.4.4
Item Level Versioning ______________________________________________________ 312
4.4.5
Mapping Items ____________________________________________________________ 322
4.4.6
Metadata Recommendations ________________________________________________ 324
4.4.7
Moving Items _____________________________________________________________ 326
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 3 of 901
DSpace 6.x Documentation
4.5
4.4.8
ORCID Integration _________________________________________________________ 326
4.4.9
PDF Citation Cover Page ___________________________________________________ 339
4.4.10
Updating Items via Simple Archive Format _____________________________________ 342
Managing Community Hierarchy ____________________________________________________ 345
4.5.1
4.6
4.7
Sub-Community Management _______________________________________________ 345
Statistics and Metrics _____________________________________________________________ 347
4.6.1
DSpace Google Analytics Statistics ___________________________________________ 347
4.6.2
Elasticsearch Usage Statistics _______________________________________________ 349
4.6.3
SOLR Statistics ___________________________________________________________ 353
User Interfaces __________________________________________________________________ 379
4.7.1
Discovery _______________________________________________________________ 379
4.7.2
Localization L10n _________________________________________________________ 402
4.7.3
JSPUI Configuration and Customization ________________________________________ 407
4.7.4
XMLUI Configuration and Customization _______________________________________ 410
5 System Administration _________________________________________________________________ 479
5.1
Introduction to DSpace System Administration _________________________________________ 479
5.2
AIP Backup and Restore __________________________________________________________ 480
5.3
5.4
5.5
5.6
5.7
5.2.1
Background & Overview ____________________________________________________ 481
5.2.2
Running the Code _________________________________________________________ 486
5.2.3
Command Line Reference __________________________________________________ 499
5.2.4
Configuration in 'dspace.cfg' _________________________________________________ 506
5.2.5
Common Issues or Error Messages ___________________________________________ 509
5.2.6
DSpace AIP Format _______________________________________________________ 510
Ant targets and options ___________________________________________________________ 529
5.3.1
Options _________________________________________________________________ 530
5.3.2
Targets _________________________________________________________________ 531
Command Line Operations ________________________________________________________ 531
5.4.1
Executing command line operations ___________________________________________ 532
5.4.2
Available operations _______________________________________________________ 532
5.4.3
Executing streams of commands _____________________________________________ 534
5.4.4
Database Utilities _________________________________________________________ 534
Mediafilters for Transforming DSpace Content _________________________________________ 535
5.5.1
MediaFilters: Transforming DSpace Content ____________________________________ 536
5.5.2
ImageMagic Media Filters ___________________________________________________ 542
Performance Tuning DSpace _______________________________________________________ 544
5.6.1
Review the number of DSpace webapps you have installed in Tomcat ________________ 545
5.6.2
Give Tomcat (DSpace UIs) More Memory ______________________________________ 545
5.6.3
Choosing the size of memory spaces allocated to DSpace _________________________ 547
5.6.4
Give the Command Line Tools More Memory ___________________________________ 548
5.6.5
Give PostgreSQL Database More Memory ______________________________________ 549
5.6.6
SOLR Statistics Performance Tuning __________________________________________ 549
Scheduled Tasks via Cron _________________________________________________________ 550
5.7.1
13-Jul-2017
Recommended Cron Settings ________________________________________________ 550
https://wiki.duraspace.org/display/DSDOC6x
Page 4 of 901
DSpace 6.x Documentation
5.8
Search Engine Optimization ________________________________________________________ 553
5.8.1
Ensuring your DSpace is indexed _____________________________________________ 553
5.8.2
Google Scholar Metadata Mappings ___________________________________________ 560
5.9
Troubleshooting Information ________________________________________________________ 561
5.10
Validating CheckSums of Bitstreams ________________________________________________ 561
5.10.1
Checksum Checker _______________________________________________________ 562
6 DSpace Development _________________________________________________________________ 567
6.1
6.2
6.3
Advanced Customisation __________________________________________________________ 567
6.1.1
Additions module __________________________________________________________ 567
6.1.2
Maven WAR Overlays ______________________________________________________ 567
6.1.3
DSpace Source Release ____________________________________________________ 567
6.1.4
DSpace Service Manager ___________________________________________________ 568
REST API ______________________________________________________________________ 571
6.2.1
What is DSpace REST API __________________________________________________ 572
6.2.2
Introduction to Jersey for developers __________________________________________ 582
6.2.3
Configuration for DSpace REST ______________________________________________ 582
6.2.4
Recording Proxy Access by Tools ____________________________________________ 583
6.2.5
Additional Information ______________________________________________________ 583
6.2.6
REST Based Quality Control Reports __________________________________________ 583
Curation System _________________________________________________________________ 602
6.3.1
Changes in 1.8 ___________________________________________________________ 603
6.3.2
Tasks ___________________________________________________________________ 603
6.3.3
Activation ________________________________________________________________ 604
6.3.4
Writing your own tasks _____________________________________________________ 604
6.3.5
Task Invocation ___________________________________________________________ 605
6.3.6
Asynchronous (Deferred) Operation ___________________________________________ 609
6.3.7
Task Output and Reporting __________________________________________________ 609
6.3.8
Task Properties ___________________________________________________________ 610
6.3.9
Task Annotations _________________________________________________________ 612
6.3.10
Scripted Tasks __________________________________________________________ 613
6.3.11
Bundled Tasks __________________________________________________________ 614
6.3.12
Curation tasks in Jython ___________________________________________________ 623
6.4
Date parser tester ________________________________________________________________ 625
6.5
Services to support Alternative Identifiers _____________________________________________ 625
6.5.1
6.6
6.7
Versioning and Identifier Service _____________________________________________ 626
Batch Processing ________________________________________________________________ 630
Extensible control panel ___________________________________________________________ 632
6.7.1
Configuration _____________________________________________________________ 632
7 DSpace Reference ___________________________________________________________________ 635
7.1
Configuration Reference __________________________________________________________ 635
7.1.1
General Configuration ______________________________________________________ 638
7.1.2
The local.cfg Configuration Properties File ______________________________________ 644
7.1.3
The dspace.cfg Configuration Properties File ____________________________________ 647
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 5 of 901
DSpace 6.x Documentation
7.2
7.3
7.4
7.5
7.6
7.1.4
Optional or Advanced Configuration Settings ____________________________________ 722
7.1.5
Command-line Access to Configuration Properties _______________________________ 730
Directories and Files ______________________________________________________________ 731
7.2.1
Overview ________________________________________________________________ 731
7.2.2
Source Directory Layout ____________________________________________________ 732
7.2.3
Installed Directory Layout ___________________________________________________ 733
7.2.4
Contents of JSPUI Web Application ___________________________________________ 734
7.2.5
Contents of XMLUI Web Application (aka Manakin) _______________________________ 734
7.2.6
Log Files ________________________________________________________________ 735
Metadata and Bitstream Format Registries ____________________________________________ 737
7.3.1
Default Dublin Core Metadata Registry (DC) ____________________________________ 737
7.3.2
Dublin Core Terms Registry (DCTERMS) _______________________________________ 740
7.3.3
Local Metadata Registry (local) _______________________________________________ 743
7.3.4
Default Bitstream Format Registry ____________________________________________ 745
Architecture ____________________________________________________________________ 747
7.4.1
Overview ________________________________________________________________ 747
7.4.2
Application Layer __________________________________________________________ 749
7.4.3
Business Logic Layer ______________________________________________________ 760
7.4.4
DSpace Services Framework ________________________________________________ 790
7.4.5
Storage Layer ____________________________________________________________ 796
History ________________________________________________________________________ 805
7.5.1
Changes in 6.x ___________________________________________________________ 806
7.5.2
Changes in 5.x ___________________________________________________________ 816
7.5.3
Changes in 4.x ___________________________________________________________ 834
7.5.4
Changes in 3.x ___________________________________________________________ 849
7.5.5
Changes in 1.8.x __________________________________________________________ 858
7.5.6
Changes in 1.7.x __________________________________________________________ 865
7.5.7
Changes in 1.6.x __________________________________________________________ 873
7.5.8
Changes in 1.5.x __________________________________________________________ 880
7.5.9
Changes in 1.4.x __________________________________________________________ 887
7.5.10
Changes in 1.3.x _________________________________________________________ 890
7.5.11
Changes in 1.2.x _________________________________________________________ 892
7.5.12
Changes in 1.1.x _________________________________________________________ 897
DSpace Item State Definitions ______________________________________________________ 898
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 6 of 901
DSpace 6.x Documentation
1 Introduction
DSpace is an open source software platform that enables organisations to:
capture and describe digital material using a submission workflow module, or a variety of programmatic
ingest options
distribute an organisation's digital assets over the web through a search and retrieval system
preserve digital assets over the long term
This system documentation includes a functional overview of the system, which is a good introduction to the
capabilities of the system, and should be readable by non-technical folk. Everyone should read this section first
because it introduces some terminology used throughout the rest of the documentation.
For people actually running a DSpace service, there is an installation guide, and sections on configuration and
the directory structure.
Finally, for those interested in the details of how DSpace works, and those potentially interested in modifying
the code for their own purposes, there is a detailed architecture section.
Other good sources of information are:
The DSpace Public API Javadocs. Build these with the command mvn javadoc:javadoc
The DSpace Wiki contains stacks of useful information about the DSpace platform and the work people
are doing with it. You are strongly encouraged to visit this site and add information about your own work.
Useful Wiki areas are:
A list of DSpace resources (Web sites, mailing lists etc.)
Technical FAQ
Registry of projects using DSpace
Guidelines for contributing back to DSpace
www.dspace.org has announcements and contains useful information about bringing up an instance of
DSpace at your organization.
The DSpace Community List. Join DSpace-Community to ask questions or join discussions about nontechnical aspects of building and running a DSpace service. It is open to all DSpace users. Ask
questions, share news, and spark discussion about DSpace with people managing other DSpace sites.
Watch DSpace-Community for news of software releases, user conferences, and announcements from
the DSpace Federation.
The DSpace Technical List. DSpace developers help answer installation and technology questions,
share information and help each other solve technical problems through the DSpace-Tech mailing list.
Post questions or contribute your expertise to other developers working with the system.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 7 of 901
DSpace 6.x Documentation
The DSpace Development List. Join Discussions among DSpace Developers. The DSpace-Devel listserv
is for DSpace developers working on the DSpace platform to share ideas and discuss code changes to
the open source platform. Join other developers to shape the evolution of the DSpace software. The
DSpace community depends on its members to frame functional requirements and high-level
architecture, and to facilitate programming, testing, documentation and to the project.
Additional support options are available in the DSpace Support Guide
1.1 Release Notes
Online Version of Documentation also available
This documentation was produced with Confluence software. A PDF version was generated directly
from Confluence. An online, updated version of this 6.x Documentation is also available at: https://wiki.
duraspace.org/display/DSDOC6x
Welcome to Release 6.1, a bug-fix release for the DSpace 6.x platform. Any previous version of DSpace may
be upgraded to DSpace 6 directly. For more information, please see Upgrading DSpace.
1.1.1 6.1 Release Notes
We highly recommend ALL users of DSpace 6.x upgrade to 6.1
DSpace 6.1 contains security fixes for the XMLUI and JSPUI and REST. To ensure your 6.x site is
secure, we highly recommend ALL DSpace 6.x users upgrade to DSpace 6.1 .
DSpace 6.1 upgrade instructions are available at: Upgrading DSpace
DSpace 6.1 is a security & bug fix release to resolve several issues located in previous 6.x releases. As it only
provides bug/security fixes, DSpace 6.1 should constitute an easy upgrade from DSpace 6.x for most users. No
database changes or additional configuration changes should be necessary when upgrading from DSpace 6.x
to 6.1.
Major bug fixes include:
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 8 of 901
DSpace 6.x Documentation
Security fixes for both JSPUI and XMLUI:
[HIGH SEVERITY] Basic (Traditional) Workflow approval process is vulnerable to unauthorized
manipulations.(https://jira.duraspace.org/browse/DS-3647 - requires a JIRA account to access.)
Discovered by Pascal Becker (The Library Code / TU Berlin).
[LOW SEVERITY] DSpace failed to check if policies had valid dates when checking access
permissions.(https://jira.duraspace.org/browse/DS-3619 - requires a JIRA account to access.)
Discovered by Pascal Becker (The Library Code / TU Berlin).
Security fixes for REST API:
[HIGH SEVERITY] A user with submit permissions can bypass workflow approvals by depositing
via REST API.(https://jira.duraspace.org/browse/DS-3281 - requires a JIRA account to access.)
Discovered by Emilio Lorenzo.
[LOW SEVERITY] The "find-by-metadata" path publicly exposes metadata from access-restricted
items.(https://jira.duraspace.org/browse/DS-3628 - requires a JIRA account to access.)
Reported by Bram Luyten (Atmire).
General bug fixes (to all UIs):
Performance improvements at API layer: DS-3558, DS-3552
Submitters (who are not Admins) could not remove bitstreams from their in progress submission:
DS-3446
Full text searching was only possible in the first bitstream (file): DS-2952
Configurable Workflow was throwing "Authorization is Denied" errors: DS-3367
IP Authorization range restrictions were not working properly: DS-3463
Item Versioning was not saving properly: DS-3381
Improve the text of database migration errors: DS-3571
Improve cache management for command line processes: DS-3579
Resolve CSV line break issue in bulk edit: DS-3245
Resolve error with null referrer to feedback page: DS-3601
Support all UTF-8 characters in configuration files: DS-3568
Fix update-handle-prefix script to no longer update handle suffix: DS-3632
XMLUI bug fixes:
/handleresolver path was no longer working: DS-3366
Display a restricted image thumbnail for access restricted bitstreams: DS-2789
Fix broken images when running Mirage 2 on Jetty: DS-3289
Archived submissions were being displayed chronologically instead of reverse chronologically: DS3334
On Move Item page, the list of Collections was sorted by Collection name, instead of being first
grouped by Community: DS-3336
ORCID / Authority Lookup button was no longer working in Mirage 2: DS-3387
Improve error message when user attempts to update an e-mail address to an existing address:
DS-3584
Allow localization of input-forms.xml with XMLUI: DS-3598
Fix error when uploading large files (>2GB) via a web browser: DS-2359
Various other minor bug fixes
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 9 of 901
DSpace 6.x Documentation
JSPUI bug fixes
READ access rights not being respected on Collection homepage: DS-3441
Fix issue where database connections were being kept open on some JSPUI pages: DS-3582
Oracle support bug fixes:
Oracle migrations took forever because of missing indexes: DS-3378
Community and Collection handles were not properly migrated between 5.x and 6.x: DS-3409
OAI-PMH bug fixes:
DIM crosswalks repeated authority information: DS-2947
REST API bug fixes:
Support for Shibboleth added: DS-3108
Solr Statistics fixes:
Item Statistics displayed UUID instead of file name: DS-3164
Sharding statistics corrupted some fields and was unstable: DS-3436, DS-3457, DS-3458
AIP Backup and Restore fixes:
Failed AIP imports left files in assetstore: DS-2227
Could not restore items from AIP if embargo lift date was in the past: hDS-3348
Replication Task Suite plugin was not working with 6.0: DS-3389
Minor improvements include:
SEO improvement: Add configurable support for whitelisting specific file formats for Google Scholar
citation_pdf_url tag: DS-3127
Add support for *.docx files (newer MS Word) to indexing process (via media filters). See DS-1140
Add ability to multi-select options in XMLUI's My Submission page. See DS-3448
Filter labels were missing in XMLUI's search screen. See DS-3573
Minor improvements to logging and error reporting.
In addition, this release fixes a variety of minor bugs in the 6.x releases. For more information, see the Changes
in 6.x section.
6.1 Acknowledgments
The 6.1 release was led by the DSpace Committers.
The following individuals provided code or bug fixes to the 6.1 release: Pascal-Nicolas Becker (pnbecker),
Andrew Bennet (AndrewBennet), Andrea Bollini (abollini), Terry Brady (terrywbrady), Per Broman (pbroman),
Samuel Cambien (samuelcambien), Yana De Pauw, Tom Desair (tomdesair), Peter Dietz (peterdietz), Roeland
Dillen, Tim Donohue (tdonohue), edusperoni, Frederic-Atmire, Generalelektrix, Claudia Juergen (cjuergen),
Bram Luyten (bram-atmire), Enrique Martínez Zúñiga (enrique), Ivan Masar (helix84), Miika Nurminen
(minurmin), Alan Orth (alanorth), Andrea Pascarelli (lap82), Hardy Pottinger (hardyoyo), Toni Prieto (toniprieto).
Christian Scheible (christian-scheible), Andrea Schweer (aschweer), Kim Shepherd (kshepherd), Alexander
Sulfrian (AlexanderS), Jonas Van Goolen (jonas-atmire), Philip Vissenaekens (PhilipVis), and Mark Wood
(mwoodiupui).
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 10 of 901
DSpace 6.x Documentation
1.1.2 6.0 Release Notes
The following is a list of the new features included for the 6.x platform (not an exhaustive list):
DSpace 6.0 ships with a number of new features. Certain features are automatically enabled by default while
others require deliberate activation.
The following non-exhaustive list contains the major new features in 6.0
Major Java API refactor, supporting UUIDs and Hibernate. The DSpace
Java API has been refactored significantly to make it more modular, and
make it easier to achieve future RoadMap modularity goals. For more
detailed information, see DSpace Service based api or DS-2701. This
feature was contributed by Kevin Van de Velde of @mire, with support
/help from the DSpace Committers.
Hibernate allows us more stability in our database layer
(decreases the likelihood of database specific bugs), and
potentially allows us to support additional database platforms in
the future
UUIDs provide all objects with stable, globally unique identifiers
(instead of existing incremental, non-unique database identifiers).
This simplifies the management of identifiers in our object model.
See also DS-1782.
The Java API itself is now split into three "layers" which are all now
initialized via Spring
Service layer, which contains DSpace business logic
Database Access Object (DAO) layer, which contains
specific Hibernate database queries to locate/find individual
objects
Database Object layer, which provides access to specific
database columns, object properties via Hibernate
Most sites will not notice this major API refactor, as the upgrade is
seamless. However, if you've performed major (Java-level)
customizations, you may need to refactor your own customizations to use
this newly refactored API. Some examples are on the DSpace Service
based api page.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 11 of 901
DSpace 6.x Documentation
Enhanced (Reloadable) Configuration System. See Configuration
Reference, Enhanced Configuration Scheme and DS-2654. This feature
was contributed by Tim Donohue of DuraSpace.
Provides easier management of local configurations via a new
local.cfg file. Any configurations (from *.cfg files) can be
overridden in DSpace by simply copying them into your local.cfg
and changing the value. See Configuration Reference
Many configurations now automatically reload as soon as you save
your local.cfg file. This means you don't need to restart Tomcat
every time you need to change a configuration.
Please note: Unfortunately, at this time, some
configurations do still get cached in the XMLUI or JSPUI (or
similar). So, while many will reload, not all of them yet
support this feature.
Enhanced file (bitstream) storage plugins, including support for Amazon
S3 file storage. This feature was contributed by Peter Dietz of Longsight.
Configuring the Bitstream Store (also see https://github.com
/DSpace/DSpace/pull/1159 and DS-1117)
Configurable site healthcheck (i.e. repository status) reports via email.
This feature was contributed by Jozef Misutka of Lindat.
Healthcheck reports (also see DS-2659).
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 12 of 901
DSpace 6.x Documentation
XMLUI new features
New framework for metadata import from external sources
(including an out-of-the-box plugin supporting PubMed, and
hopefully more coming soon). This concept was previously only
supported in JSPUI. Screencast example: http://screencast.com/t
/QBImSGbAUZ. These features were contributed by @mire. The
PubMed metadata import plugin was also contributed by the
Netherlands Cancer Institute.
Framework to support metadata import from external
sources: DS-2876
PubMed metadata import plugin: DS-2880
Extensible administrative control panel, allowing institutions to
override or customize the tabs in the XMLUI administrative "control
panel" (see also DS-2625). This feature was contributed by Jozef
Misutka of Lindat.
Export of XMLUI search results to CSV for batch metadata editing.
This feature was previously only supported in JSPUI. See also DS1262. This feature was contributed by William Welling of Texas
A&M
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 13 of 901
DSpace 6.x Documentation
REST API new features
REST Based Quality Control Reports for collection manager. See
also DS-2583. This feature was contributed by Terry Brady of
Georgetown University
See Metadata Query Report on demo.dspace.org
See Collection Filter Report on demo.dspace.org
Support for all authentication methods via REST (e.g. Shibboleth,
LDAP, etc). See also DS-2898.
New /registries endpoint which provides access to the
metadata registries via REST. See also DS-2539. This feature was
contributed by Terry Brady of Georgetown University.
REST API now provides a version via /status endpoint (inherits
the version of DSpace API). See DS-2619. This feature was
contributed by Ivan Masár.
Search/Discovery enhancements
All searches now default to boolean AND. See DS-2809. This
enhancement was contributed by Andrea Schweer.
New "Has File" facet, which allows you to easily filter by items that
have one or more files. See DS-2648. This enhancement was
contributed by Christian Scheible.
Full text indexing of Excel spreadsheets, so that they are now
searchable. See DS-2629. This enhancement was contributed by
Ed Goulet.
Right-to-left text in PDFs is now indexed for searching. See DS1187. This enhancement was contributed by Saiful Amin
Other enhancements:
PDFBox was upgraded to version 2.0 (DS-3035). A new PDFBox
Thumbnail generator was also added and enabled by default (DS3052). These features were contributed by Ivan Masár.
OAI-PMH was upgraded for compliance with the OpenAIRE 3.0
guidelines for literature repositories. This enhancement was
contributed by Pedro Príncipe.
Features Removed or Replaced in 6.0
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 14 of 901
DSpace 6.x Documentation
The build.properties configuration file has been replaced
by an enhanced local.cfg configuration file. The new local.
cfg allows you to easily override any configuration (from dspace.
cfg or modules/*.cfg files) by simply copying it into your
local.cfg and specifying a new value. It also provides enhanced
configuration options as detailed in the Configuration Reference
documentation. The old build.properties file is no longer
used nor supported.
WARNING: As part of adding this new configuration
scheme, many of the configuration settings in DSpace
(primarily those in modules/*.cfg files) had to be
renamed or prepended with the name of the module. This
means that 5.x (or below) configurations are no longer
guaranteed to be compatible with 6.x. If possible, we
recommend starting with fresh configs (see below), and
moving all your locally customized settings into the new
local.cfg file.
The PDF Citation Cover Page configuration file has been
renamed (from disseminate-citation.cfg to citationpage.cfg). See this feature's documentation for more details.
The legacy search engine (based on Apache Lucene) and
legacy Browse system (based on database tables) have been
removed from DSpace 6.0 or above. Instead, DSpace now only
uses Discovery (based on Apache Solr) for all Search/Browse
capabilities. See DS-2160. The legacy browse system was
removed by Kevin Van de Velde. The legacy search system was
removed by Tim Donohue.
The DSpace Lightweight Networking Interface (LNI), supporting
WebDAV / SOAP / RPC API, has been removed from DSpace
6.0 or above. We recommend using REST or SWORD (v1 or v2)
as a replacement. However, if you still require it, the old
(unmaintained) LNI codebase is still available at https://github.com
/DSpace/dspace-lni. This change was contributed by Robin Taylor
of University of Edinburgh.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 15 of 901
DSpace 6.x Documentation
Support for SRB (Storage Resource Broker) file storage has
been removed from DSpace 6.0 or above. As it was unmaintained
(and seemingly unused) for many years, this feature was removed
along with its configurations. As a replacement, a new file storage
plugin system was added, featuring a traditional local file storage
option (default) and an Amazon S3 file storage option (see Storage
Layer documentation, especially Configuring the Bitstream Store).
For more information on the removal of SRB support, also see DS3055. This change was contributed by Peter Dietz of Longsight.
The user groups Administrator and Anonymous cannot be
renamed or deleted. If you had renamed them, they will be
renamed back to the stock names during the upgrade. DSpace is
now dependent on these specific names due to internal changes.
This change was contributed by Mark Wood of IUPUI.
XPDF PDF Thumbnail generation has been removed. Please
use the ImageMagick or PDFBox thumbnail generators instead.
See DS-2159. This change was contributed by Mark Wood of
IUPUI.
The default strategy to create new handles for versioned
Items has changed. If you have Item Level Versioning enabled
and you have versioned Items in your DSpace installation, you
may want to change the configuration to continue using the
mechanism to create handles as it was in DSpace 4 and 5. You
can find more informations here: Item Level
Versioning#IdentifierServiceOverride.
Elasticsearch Usage Statistics feature is deprecated in the 6.0
release. While they still function, and you can continue to use
them, in a future DSpace release they will be removed. If you are
looking for a usage statistics option, we recommend instead using
the default SOLR Statistics engine and/or DSpace's integration
with Google Analytics. See DS-2897 for more information.
A full list of all changes / bug fixes in 6.x is available in the Changes in 6.x section.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 16 of 901
DSpace 6.x Documentation
The following individuals have contributed directly to this release of DSpace: Tim Donohue, Mark H. Wood,
Pascal-Nicolas Becker, Kevin Van de Velde, Ivan Masár, Hardy Pottinger, Terry Brady, Andrea Schweer, Philip
Vissenaekens, Peter Dietz, Jonas Van Goolen, Tom Desair, Dylan MEEUS, Luigi Andrea Pascarelli, William
Welling, Christian Scheible, Andrea Bollini, Aleksander Kotyski-Burya, Ondej Košarko, Jozef Mišutka, Chris
Wilper, Ilja Sidoroff, Roeland Dillen, Bram Luyten, Marsa Haoua, Claudia Jürgen, Kim Shepherd, Art Lowel, Ivo
Prajer, Petr Karel, Mini Pillai, Facundo Gabriel Adorno, Luiz Claudio Santos, Robin Taylor, Tim Van den
Langenbergh, Arnaud de Bossoreille, Bill Tantzen, Tiago Guimarães, Oriol Olivé Comadira, Àlex Magaz Graça,
Anne Lawrence, Brad Dewar, Bruno Nocera Zanette, David Baker, Ed Goulet, Mateusz Neumann, Monika
Mevenkamp, Pablo Buenaposada, Patricio Marrone, Petya Kohts, Eike Kleiner, Antoine Snyers, Bjorn Jaspers,
Chris Herron, Dan Scott, David Cook, Davor Cubranic, José Carvalho, Jozsef Marton, Juan Manuel Catá,
Panagiotis Koutsourakis, Pantelis Karamolegkos, Pedro Príncipe, Philippe Gray, Rodrigo Prado de Jesus,
RomanticCat, Saiful Amin, junwei1229, Keith Gilbertson, Nicolas Schwab, Pablo Buenaposada, Michael
Marttila, samuel, tmtvl, and others who reviewed and commented on their work. Many of these could not do this
work without the support (release time and financial) of their associated institutions. We offer thanks to those
institutions for supporting their staff to take time to contribute to the DSpace project.
A big thank you also goes out to the DSpace Community Advisory Team (DCAT), who helped the developers to
prioritize and plan out several of the new features that made it into this release. The current DCAT members
include: Augustine Gitonga, Bram Luyten, Bharat Chaudhari, Claire Bundy, Dibyendra Hyoju, Elin Stangeland,
Felicity A Dykas, Iryna Kuchma, James Evans, Jim Ottaviani, Kate Dohe, Kathleen Schweitzberger, Leonie
Hayes, Lilly Li, Maureen Walsh, Pauline Ward, Roger Weaver, Sarah Molloy, Sarah Potvin, Steve Van Tuyl,
Terry Brady, Yan Han and Valorie Hollister.
We apologize to any contributor accidentally left off this list. DSpace has such a large, active development
community that we sometimes lose track of all our contributors. Our ongoing list of all known people/institutions
that have contributed to DSpace software can be found on our DSpace Contributors page. Acknowledgments to
those left off will be made in future releases.
Want to see your name appear in our list of contributors? All you have to do is report an issue, fix a bug,
improve our documentation or help us determine the necessary requirements for a new feature! Visit our Issue
Tracker to report a bug, or join dspace-devel mailing list to take part in development work. If you'd like to help
improve our current documentation, please get in touch with one of our Committers with your ideas. You don't
even need to be a developer! Repository managers can also get involved by volunteering to join the DSpace
Community Advisory Team and helping our developers to plan new features.
The Release Team consisted of:
Tim Donohue (DuraSpace)
Kevin Van de Velde (@mire)
Pascal-Nicolas Becker (Technische Universität Berlin)
Additional thanks to Tim Donohue from DuraSpace for keeping all of us focused on the work at hand, for
calming us when we got excited, and for the general support for the DSpace project.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 17 of 901
DSpace 6.x Documentation
1.2 Functional Overview
The following sections describe the various functional aspects of the DSpace system.
Online access to your digital assets
Full-text search
Navigation
Supported file types
Optimized for Google Indexing
OpenURL Support
Support for modern browsers
Metadata Management
Metadata
Choice Management and Authority Control
Licensing
Collection and Community Licenses
License granted by the submitter to the repository
Creative Commons Support for DSpace Items
Persistent URLs and Identifiers
Handles
Bitstream 'Persistent' Identifiers
Getting content into DSpace
The Manual DSpace Submission and Workflow System
Workflow Steps
Submission Workflow in DSpace
Command line import facilities
Registration for externally hosted files
SWORD Support
Getting content out of DSpace
OAI Support
Command Line Export Facilities
Packager Plugins
Crosswalk Plugins
Supervision and Collaboration
User Management
User Accounts (E-Person)
Subscriptions
Groups
Access Control
Authentication
Authorization
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 18 of 901
DSpace 6.x Documentation
Usage Metrics
Item, Collection and Community Usage Statistics
System Statistics
Digital Preservation
Checksum Checker
System Design
Data Model
Amazon S3 Support
1.2.1 Online access to your digital assets
The online presentation of your content in an organized tree of Communities and Collections is a main feature
of DSpace. Users can access pages for individual items, these are metadata descriptions together with files
available for download. The structure is summarised in this diagram (click to see the image at full size).
Full-text search
DSpace can process uploaded text based contents for full-text searching. This means that not only the
metadata you provide for a given file will be searchable, but all of its contents will be indexed as well. This
allows users to search for specific keywords that only appear in the actual content and not in the provided
description.
Navigation
DSpace allows users to find their way to relevant content in a number of ways, including:
Searching for one or more keywords in metadata or extracted full-text
Faceted browsing through any field provided in the item description.
Through external reference, such as a Handle
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 19 of 901
DSpace 6.x Documentation
By clicking on Community and Collection titles to explore their contents
Another important mechanism for discovery in DSpace is the browse. This is the process whereby the user
views a particular index, such as the title index, and navigates around it in search of interesting items. The
browse subsystem provides a simple API for achieving this by allowing a caller to specify an index, and a
subsection of that index. The browse subsystem then discloses the portion of the index of interest. Indices that
may be browsed are item title, item issue date, item author, and subject terms. Additionally, the browse can be
limited to items within a particular collection or community.
For more information on Search/Browse functionality in DSpace, see Discovery.
Supported file types
DSpace can accommodate any type of uploaded file. While DSpace is most known for hosting text based
materials including scholarly communication and electronic theses and dissertations (ETDs), there are many
stakeholders in the community who use DSpace for multimedia, data and learning objects. While some
restrictions apply, DSpace can even serve as a store for HTML Archives.
Files that have been uploaded to DSpace are often referred to as "Bitstreams". The reason for this is mainly
historic and tracks back to the technical implementation. After ingestion, files in DSpace are stored on the file
system as a stream of bits without the file extension.
By default, DSpace only recognizes specific file types, as defined in its Bitstream Format Registry. The default
Bitstream Format Registry recognizes many common file formats, but it can be enhanced at your local
institution via the Admin User Interface.
Optimized for Google Indexing
The Duraspace community fosters a close relation with Google to ensure optimal indexing of DSpace content,
primarily in the Google Search and Google Scholar products. For the purpose of Google Scholar indexing,
DSpace added specific metadata in the page head tags facilitating indexing in Scholar. More information can be
retrieved on the Google Scholar Metadata Mappings page. Popular DSpace repositories often generate over
60% of their visits from Google pages.
OpenURL Support
DSpace supports the OpenURL protocol in a rather simple fashion. If your institution has an SFX server,
DSpace will display an OpenURL link on every item page, automatically using the Dublin Core metadata.
Additionally, DSpace can respond to incoming OpenURLs. Presently it simply passes the information in the
OpenURL to the search subsystem. A list of results is then displayed, which usually gives the relevant item (if it
is in DSpace) at the top of the list.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 20 of 901
DSpace 6.x Documentation
Support for modern browsers
The DSpace developer community aims to rely on modern web standards and well tested libraries where
possible. As a rule of thumb, users can expect that the DSpace web interfaces work on modern web browsers.
DSpace developers routinely test new interface developments on recent versions of Firefox, Safari and
Chrome. Because of fast moving, automatic, incremental updates to these browsers, support is no longer
targeted at specific versions of these browsers. The community attempts to support the latest official version
and up to 2 older versions of Microsoft's Internet Explorer.
In some cases, modern interfaces are developed alongside older interfaces that no longer receive active
maintenance or improvements. This is particularly true for the original themes for the XML User Interface such
as "Kubrick", "Classic" and "Reference". These themes still reside in the code base but are not optimized for
modern browsers.
1.2.2 Metadata Management
Metadata
Broadly speaking, DSpace holds three sorts of metadata about archived content:
Descriptive Metadata: DSpace can support multiple flat metadata schemas for describing an item. A
qualified Dublin Core metadata schema loosely based on the Library Application Profile set of elements
and qualifiers is provided by default. This default schema is described in more detail in Metadata and
Bitstream Format Registries. However, you can configure multiple schemas and select metadata fields
from a mix of configured schemas to describe your items. Other descriptive metadata about items (e.g.
metadata described in a hierarchical schema) may be held in serialized bitstreams.
Administrative Metadata: This includes preservation metadata, provenance and authorization policy
data. Most of this is held within DSpace's relational DBMS schema. Provenance metadata (prose) is
stored in Dublin Core records. Additionally, some other administrative metadata (for example, bitstream
byte sizes and MIME types) is replicated in Dublin Core records so that it is easily accessible outside of
DSpace.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 21 of 901
DSpace 6.x Documentation
Structural Metadata: This includes information about how to present an item, or bitstreams within an
item, to an end-user, and the relationships between constituent parts of the item. As an example,
consider a thesis consisting of a number of TIFF images, each depicting a single page of the thesis.
Structural metadata would include the fact that each image is a single page, and the ordering of the TIFF
images/pages. Structural metadata in DSpace is currently fairly basic; within an item, bitstreams can be
arranged into separate bundles as described above. A bundle may also optionally have a primary
bitstream. This is currently used by the HTML support to indicate which bitstream in the bundle is the first
HTML file to send to a browser. In addition to some basic technical metadata, a bitstream also has a
'sequence ID' that uniquely identifies it within an item. This is used to produce a 'persistent' bitstream
identifier for each bitstream. Additional structural metadata can be stored in serialized bitstreams, but
DSpace does not currently understand this natively.
Choice Management and Authority Control
This is a configurable framework that lets you define plug-in classes to control the choice of values for specified
DSpace metadata fields. It also lets you configure fields to include "authority" values along with the textual
metadata value. The choice-control system includes a user interface in both the Configurable Submission UI
and the Admin UI (edit Item pages) that assists the user in choosing metadata values.
Introduction and Motivation
Definitions
Choice Management
This is a mechanism that generates a list of choices for a value to be entered in a given metadata field.
Depending on your implementation, the exact choice list might be determined by a proposed value or query, or
it could be a fixed list that is the same for every query. It may also be closed (limited to choices produced
internally) or open, allowing the user-supplied query to be included as a choice.
Authority Control
This works in addition to choice management to supply an authority key along with the chosen value, which is
also assigned to the Item's metadata field entry. Any authority-controlled field is also inherently choicecontrolled.
About Authority Control
The advantages we seek from an authority controlled metadata field are:
1. There is a simple and positive way to test whether two values are identical, by comparing authority
keys.
Comparing plain text values can give false positive results e.g. when two different people have a
name that is written the same.
It can also give false negative results when the same name is written different ways, e.g. "J.
Smith" vs. "John Smith".
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 22 of 901
DSpace 6.x Documentation
2. Help in entering correct metadata values. The submission and admin UIs may call on the authority to
check a proposed value and list possible matches to help the user select one.
3. Improved interoperability. By sharing a name authority with another application, your DSpace can
interoperate more cleanly with other applications.
For example, a DSpace institutional repository sharing a naming authority with the campus social
network would let the social network construct a list of all DSpace Items matching the shared
author identifier, rather than by error-prone name matching.
When the name authority is shared with a campus directory, DSpace can look up the email
address of an author to send automatic email about works of theirs submitted by a third party.
That author does not have to be an EPerson.
4. Authority keys are normally invisible in the public web UIs. They are only seen by administrators editing
metadata. The value of an authority key is not expected to be meaningful to an end-user or site visitor.
Authority control is different from the controlled vocabulary of keywords already implemented in the
submission UI:
1. Authorities are external to DSpace. The source of authority control is typically an external database or
network resource.
Plug-in architecture makes it easy to integrate new authorities without modifying any core code.
2. This authority proposal impacts all phases of metadata management.
The keyword vocabularies are only for the submission UI.
Authority control is asserted everywhere metadata values are changed, including unattended
/batch submission, SWORD package submission, and the administrative UI.
Some Terminology
Authority
An authority is a source of fixed values for a given domain, each unique value identified by a
key.
.
For example, the OCLC LC Name Authority Service.
Authority
The information associated with one of the values in an authority; may include alternate
Record
spellings and equivalent forms of the value, etc.
Authority
An opaque, hopefully persistent, identifier corresponding to exactly one record in the authority.
Key
1.2.3 Licensing
DSpace offers support for licenses on different levels
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 23 of 901
DSpace 6.x Documentation
Collection and Community Licenses
Each community and collection in the hierarchy of a DSpace repository can contain its own license terms. This
allows an institution to use the repository both for collections where certain rights are reserved and others from
which the content may be accessed and distributed more freely.
License granted by the submitter to the repository
At the end of the manual submission process, the submitter is asked to grant the repository service an
appropriate distribution license. This license can be easily customized on a per collection basis. In its most
common form, the submitter grants to the repository service a non-exclusive distribution license, meaning that
he officially gives the repository service the right to share his or her work with the world.
Creative Commons Support for DSpace Items
DSpace provides support for Creative Commons licenses to be attached to items in the repository. They
represent an alternative to traditional copyright. To learn more about Creative Commons, visit their website.
Support for license selection is controlled by a site-wide configuration option, and since license selection
involves interaction with the Creative Commons website, additional parameters may be configured to work with
a proxy server. If the option is enabled, users may select a Creative Commons license during the submission
process, or select to don't assign a Creative Commons license at all. If a selection is made, metadata and a
copy of the license in the RDF format is stored along with the item in the repository. There is also an indication text and a Creative Commons icon - in the item display page of the web user interface when an item is licensed
under Creative Commons. The RDF license is embedded in the html page of the item to allow machine
understanding of the licensing terms. For specifics of how to configure and use Creative Commons licenses,
see the configuration section.
1.2.4 Persistent URLs and Identifiers
Handles
Researchers require a stable point of reference for their works. The simple evolution from sharing of citations to
emailing of URLs broke when Web users learned that sites can disappear or be reconfigured without notice,
and that their bookmark files containing critical links to research results couldn't be trusted in the long term. To
help solve this problem, a core DSpace feature is the creation of a persistent identifier for every item, collection
and community stored in DSpace. To persist identifiers, DSpace requires a storage- and location- independent
mechanism for creating and maintaining identifiers. DSpace uses the CNRI Handle System for creating these
identifiers. The rest of this section assumes a basic familiarity with the Handle system.
DSpace uses Handles primarily as a means of assigning globally unique identifiers to objects. Each site running
DSpace needs to obtain a unique Handle 'prefix' from CNRI, so we know that if we create identifiers with that
prefix, they won't clash with identifiers created elsewhere.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 24 of 901
DSpace 6.x Documentation
Presently, Handles are assigned to communities, collections, and items. Bundles and bitstreams are not
assigned Handles, since over time, the way in which an item is encoded as bits may change, in order to allow
access with future technologies and devices. Older versions may be moved to off-line storage as a new
standard becomes de facto. Since it's usually the item that is being preserved, rather than the particular bit
encoding, it only makes sense to persistently identify and allow access to the item, and allow users to access
the appropriate bit encoding from there.
Of course, it may be that a particular bit encoding of a file is explicitly being preserved; in this case, the
bitstream could be the only one in the item, and the item's Handle would then essentially refer just to that
bitstream. The same bitstream can also be included in other items, and thus would be citable as part of a
greater item, or individually.
The Handle system also features a global resolution infrastructure; that is, an end-user can enter a Handle into
any service (e.g. Web page) that can resolve Handles, and the end-user will be directed to the object (in the
case of DSpace, community, collection or item) identified by that Handle. In order to take advantage of this
feature of the Handle system, a DSpace site must also run a 'Handle server' that can accept and resolve
incoming resolution requests. All the code for this is included in the DSpace source code bundle.
Handles can be written in two forms:
hdl:1721.123/4567
http://hdl.handle.net/1721.123/4567
The above represent the same Handle. The first is possibly more convenient to use only as an identifier;
however, by using the second form, any Web browser becomes capable of resolving Handles. An end-user
need only access this form of the Handle as they would any other URL. It is possible to enable some browsers
to resolve the first form of Handle as if they were standard URLs using CNRI's Handle Resolver plug-in, but
since the first form can always be simply derived from the second, DSpace displays Handles in the second
form, so that it is more useful for end-users.
It is important to note that DSpace uses the CNRI Handle infrastructure only at the 'site' level. For example, in
the above example, the DSpace site has been assigned the prefix '1721.123'. It is still the responsibility of the
DSpace site to maintain the association between a full Handle (including the '4567' local part) and the
community, collection or item in question.
Bitstream 'Persistent' Identifiers
Similar to handles for DSpace items, bitstreams also have 'Persistent' identifiers. They are more volatile than
Handles, since if the content is moved to a different server or organization, they will no longer work (hence the
quotes around 'persistent'). However, they are more easily persisted than the simple URLs based on database
primary key previously used. This means that external systems can more reliably refer to specific bitstreams
stored in a DSpace instance.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 25 of 901
DSpace 6.x Documentation
Each bitstream has a sequence ID, unique within an item. This sequence ID is used to create a persistent ID, of
the form:
dspace url/bitstream/handle/sequence ID/filename
For example:
https://dspace.myu.edu/bitstream/123.456/789/24/foo.html
The above refers to the bitstream with sequence ID 24 in the item with the Handle hdl:123.456/789. The foo.html
is really just there as a hint to browsers: Although DSpace will provide the appropriate MIME type, some
browsers only function correctly if the file has an expected extension.
1.2.5 Getting content into DSpace
The Manual DSpace Submission and Workflow System
Rather than being a single subsystem, ingesting is a process that spans several. Below is a simple illustration of
the current ingesting process in DSpace.
DSpace Ingest Process
The batch item importer is an application, which turns an external SIP (an XML metadata document with some
content files) into an "in progress submission" object. The Web submission UI is similarly used by an end-user
to assemble an "in progress submission" object.
Depending on the policy of the collection to which the submission in targeted, a workflow process may be
started. This typically allows one or more human reviewers or 'gatekeepers' to check over the submission and
ensure it is suitable for inclusion in the collection.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 26 of 901
DSpace 6.x Documentation
When the Batch Ingester or Web Submit UI completes the InProgressSubmission object, and invokes the next
stage of ingest (be that workflow or item installation), a provenance message is added to the Dublin Core which
includes the filenames and checksums of the content of the submission. Likewise, each time a workflow
changes state (e.g. a reviewer accepts the submission), a similar provenance statement is added. This allows
us to track how the item has changed since a user submitted it.
Once any workflow process is successfully and positively completed, the InProgressSubmission object is
consumed by an "item installer", that converts the InProgressSubmission into a fully blown archived item in
DSpace. The item installer:
Assigns an accession date
Adds a "date.available" value to the Dublin Core metadata record of the item
Adds an issue date if none already present
Adds a provenance message (including bitstream checksums)
Assigns a Handle persistent identifier
Adds the item to the target collection, and adds appropriate authorization policies
Adds the new item to the search and browse index
Workflow Steps
A collection's workflow can have up to three steps. Each collection may have an associated e-person group for
performing each step; if no group is associated with a certain step, that step is skipped. If a collection has no eperson groups associated with any step, submissions to that collection are installed straight into the main
archive.
In other words, the sequence is this: The collection receives a submission. If the collection has a group
assigned for workflow step 1, that step is invoked, and the group is notified. Otherwise, workflow step 1 is
skipped. Likewise, workflow steps 2 and 3 are performed if and only if the collection has a group assigned to
those steps.
When a step is invoked, the submission is put into the 'task pool' of the step's associated group. One member of
that group takes the task from the pool, and it is then removed from the task pool, to avoid the situation where
several people in the group may be performing the same task without realizing it.
The member of the group who has taken the task from the pool may then perform one of three actions:
Workflow
Possible actions
Step
1
Can accept submission for inclusion, or reject submission.
2
Can edit metadata provided by the user with the submission, but cannot change the submitted
files. Can accept submission for inclusion, or reject submission.
3
Can edit metadata provided by the user with the submission, but cannot change the submitted
files. Must then commit to archive; may not reject submission.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 27 of 901
DSpace 6.x Documentation
Submission Workflow in DSpace
If a submission is rejected, the reason (entered by the workflow participant) is e-mailed to the submitter, and it is
returned to the submitter's 'My DSpace' page. The submitter can then make any necessary modifications and resubmit, whereupon the process starts again.
If a submission is 'accepted', it is passed to the next step in the workflow. If there are no more workflow steps
with associated groups, the submission is installed in the main archive.
One last possibility is that a workflow can be 'aborted' by a DSpace site administrator. This is accomplished
using the administration UI.
The reason for this apparently arbitrary design is that is was the simplest case that covered the needs of the
early adopter communities at MIT. The functionality of the workflow system will no doubt be extended in the
future.
Command line import facilities
DSpace includes batch tools to import items in a simple directory structure, where the Dublin Core metadata is
stored in an XML file. This may be used as the basis for moving content between DSpace and other systems.
For more information see Item Importer and Exporter.
DSpace also includes various package importer tools, which support many common content packaging formats
like METS. For more information see Package Importer and Exporter.
Registration for externally hosted files
Registration is an alternate means of incorporating items, their metadata, and their bitstreams into DSpace by
taking advantage of the bitstreams already being in accessible computer storage. An example might be that
there is a repository for existing digital assets. Rather than using the normal interactive ingest process or the
batch import to furnish DSpace the metadata and to upload bitstreams, registration provides DSpace the
metadata and the location of the bitstreams. DSpace uses a variation of the import tool to accomplish
registration.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 28 of 901
DSpace 6.x Documentation
SWORD Support
SWORD (Simple Web-service Offering Repository Deposit) is a protocol that allows the remote deposit of items
into repositories. SWORD was further developed in SWORD version 2 to add the ability to retrieve, update, or
delete deposits. DSpace supports the SWORD protocol via the 'sword' web application and SWord v2 via the
swordv2 web application. The specification and further information can be found at http://swordapp.org.
1.2.6 Getting content out of DSpace
OAI Support
The Open Archives Initiative has developed a protocol for metadata harvesting. This allows sites to
programmatically retrieve or 'harvest' the metadata from several sources, and offer services using that
metadata, such as indexing or linking services. Such a service could allow users to access information from a
large number of sites from one place.
DSpace exposes the Dublin Core metadata for items that are publicly (anonymously) accessible. Additionally,
the collection structure is also exposed via the OAI protocol's 'sets' mechanism. OCLC's open source OAICat
framework is used to provide this functionality.
You can also configure the OAI service to make use of any crosswalk plugin to offer additional metadata
formats, such as MODS.
DSpace's OAI service does support the exposing of deletion information for withdrawn items, but not for items
that are 'expunged' (see above). DSpace also supports OAI-PMH resumption tokens.
Command Line Export Facilities
DSpace includes batch tools to export items in a simple directory structure, where the Dublin Core metadata is
stored in an XML file. This may be used as the basis for moving content between DSpace and other systems.
For more information see Item Importer and Exporter.
DSpace also includes various package exporter tools, which support many common content packaging formats
like METS. For more information see Package Importer and Exporter.
Packager Plugins
Packagers are software modules that translate between DSpace Item objects and a self-contained external
representation, or "package". A Package Ingester interprets, or ingests, the package and creates an Item. A
Package Disseminator writes out the contents of an Item in the package format.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 29 of 901
DSpace 6.x Documentation
A package is typically an archive file such as a Zip or "tar" file, including a manifest document which contains
metadata and a description of the package contents. The IMS Content Package is a typical packaging standard.
A package might also be a single document or media file that contains its own metadata, such as a PDF
document with embedded descriptive metadata.
Package ingesters and package disseminators are each a type of named plugin (see Plugin Manager), so it is
easy to add new packagers specific to the needs of your site. You do not have to supply both an ingester and
disseminator for each format; it is perfectly acceptable to just implement one of them.
Most packager plugins call upon Crosswalk Plugins to translate the metadata between DSpace's object model
and the package format.
More information about calling Packagers to ingest or disseminate content can be found in the Package
Importer and Exporter section of the System Administration documentation.
Crosswalk Plugins
Crosswalks are software modules that translate between DSpace object metadata and a specific external
representation. An Ingestion Crosswalk interprets the external format and crosswalks it to DSpace's internal
data structure, while a Dissemination Crosswalk does the opposite.
For example, a MODS ingestion crosswalk translates descriptive metadata from the MODS format to the
metadata fields on a DSpace Item. A MODS dissemination crosswalk generates a MODS document from the
metadata on a DSpace Item.
Crosswalk plugins are named plugins (see Plugin Manager), so it is easy to add new crosswalks. You do not
have to supply both an ingester and disseminator for each format; it is perfectly acceptable to just implement
one of them.
There is also a special pair of crosswalk plugins which use XSL stylesheets to translate the external metadata
to or from an internal DSpace format. You can add and modify XSLT crosswalks simply by editing the DSpace
configuration and the stylesheets, which are stored in files in the DSpace installation directory.
The Packager plugins and OAH-PMH server make use of crosswalk plugins.
Supervision and Collaboration
In order to facilitate, as a primary objective, the opportunity for thesis authors to be supervised in the
preparation of their e-theses, a supervision order system exists to bind groups of other users (thesis
supervisors) to an item in someone's pre-submission workspace. The bound group can have system policies
associated with it that allow different levels of interaction with the student's item; a small set of default policy
groups are provided:
Full editorial control
View item contents
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 30 of 901
DSpace 6.x Documentation
No policies
Once the default set has been applied, a system administrator may modify them as they would any other
policy set in DSpace
This functionality could also be used in situations where researchers wish to collaborate on a particular
submission, although there is no particular collaborative workspace functionality.
1.2.7 User Management
Although many of DSpace's functions such as document discovery and retrieval can be used anonymously,
some features (and perhaps some documents) are only available to certain "privileged" users. E-People and
Groups are the way DSpace identifies application users for the purpose of granting privileges. This identity is
bound to a session of a DSpace application such as the Web UI or one of the command-line batch programs.
Both E-People and Groups are granted privileges by the authorization system described below.
User Accounts (E-Person)
DSpace holds the following information about each e-person:
E-mail address
First and last names
Whether the user is able to log in to the system via the Web UI, and whether they must use an X509
certificate to do so;
A password (encrypted), if appropriate
A list of collections for which the e-person wishes to be notified of new items
Whether the e-person 'self-registered' with the system; that is, whether the system created the e-person
record automatically as a result of the end-user independently registering with the system, as opposed to
the e-person record being generated from the institution's personnel database, for example.
The network ID for the corresponding LDAP record, if LDAP authentication is used for this E-Person.
Subscriptions
As noted above, end-users (e-people) may 'subscribe' to collections in order to be alerted when new items
appear in those collections. Each day, end-users who are subscribed to one or more collections will receive an
e-mail giving brief details of all new items that appeared in any of those collections the previous day. If no new
items appeared in any of the subscribed collections, no e-mail is sent. Users can unsubscribe themselves at
any time. RSS feeds of new items are also available for collections and communities.
Groups
Groups are another kind of entity that can be granted permissions in the authorization system. A group is
usually an explicit list of E-People; anyone identified as one of those E-People also gains the privileges granted
to the group.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 31 of 901
DSpace 6.x Documentation
However, an application session can be assigned membership in a group without being identified as an EPerson. For example, some sites use this feature to identify users of a local network so they can read restricted
materials not open to the whole world. Sessions originating from the local network are given membership in the
"LocalUsers" group and gain the corresponding privileges.
Administrators can also use groups as "roles" to manage the granting of privileges more efficiently.
1.2.8 Access Control
Authentication
Authentication is when an application session positively identifies itself as belonging to an E-Person and/or
Group. In DSpace 1.4 and later, it is implemented by a mechanism called Stackable Authentication: the DSpace
configuration declares a "stack" of authentication methods. An application (like the Web UI) calls on the
Authentication Manager, which tries each of these methods in turn to identify the E-Person to which the session
belongs, as well as any extra Groups. The E-Person authentication methods are tried in turn until one
succeeds. Every authenticator in the stack is given a chance to assign extra Groups. This mechanism offers the
following advantages:
Separates authentication from the Web user interface so the same authentication methods are used for
other applications such as non-interactive Web Services
Improved modularity: The authentication methods are all independent of each other. Custom
authentication methods can be "stacked" on top of the default DSpace username/password method.
Cleaner support for "implicit" authentication where username is found in the environment of a Web
request, e.g. in an X.509 client certificate.
Authorization
DSpace's authorization system is based on associating actions with objects and the lists of EPeople who can
perform them. The associations are called Resource Policies, and the lists of EPeople are called Groups. There
are two built-in groups: 'Administrators', who can do anything in a site, and 'Anonymous', which is a list that
contains all users. Assigning a policy for an action on an object to anonymous means giving everyone
permission to do that action. (For example, most objects in DSpace sites have a policy of 'anonymous' READ.)
Permissions must be explicit - lack of an explicit permission results in the default policy of 'deny'. Permissions
also do not 'commute'; for example, if an e-person has READ permission on an item, they might not necessarily
have READ permission on the bundles and bitstreams in that item. Currently Collections, Communities and
Items are discoverable in the browse and search systems regardless of READ authorization.
The following actions are possible:
Collection
ADD/REMOVE
13-Jul-2017
add or remove items (ADD = permission to submit items)
https://wiki.duraspace.org/display/DSDOC6x
Page 32 of 901
DSpace 6.x Documentation
DEFAULT_ITEM_READ
inherited as READ by all submitted items
DEFAULT_BITSTREAM_READ
inherited as READ by Bitstreams of all submitted items. Note: only affects
Bitstreams of an item at the time it is initially submitted. If a Bitstream is
added later, it does not get the same default read policy.
COLLECTION_ADMIN
collection admins can edit items in a collection, withdraw items, map other
items into this collection.
Item
ADD/REMOVE
add or remove bundles
READ
can view item (item metadata is always viewable)
WRITE
can modify item
Bundle
ADD/REMOVE
add or remove bitstreams to a bundle
Bitstream
READ
view bitstream
WRITE
modify bitstream
Note that there is no 'DELETE' action. In order to 'delete' an object (e.g. an item) from the archive, one must
have REMOVE permission on all objects (in this case, collection) that contain it. The 'orphaned' item is
automatically deleted.
Policies can apply to individual e-people or groups of e-people.
1.2.9 Usage Metrics
DSpace is equipped with SOLR based infrastructure to log and display pageviews and file downloads.
Item, Collection and Community Usage Statistics
Usage statistics can be retrieved from individual item, collection and community pages. These Usage Statistics
pages show:
Total page visits (all time)
Total Visits per Month
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 33 of 901
DSpace 6.x Documentation
File Downloads (all time)*
Top Country Views (all time)
Top City Views (all time)
*File Downloads information is only displayed for item-level statistics. Note that downloads from separate
bitstreams are also recorded and represented separately. DSpace is able to capture and store File Download
information, even when the bitstream was downloaded from a direct link on an external website.
System Statistics
Various statistical reports about the contents and use of your system can be automatically generated by the
system. These are generated by analyzing DSpace's log files. Statistics can be broken down monthly.
The report includes following sections
A customizable general overview of activities in the archive, by default including:
Number of items archived
Number of bitstream views
Number of item page views
Number of collection page views
Number of community page views
Number of user logins
Number of searches performed
Number of license rejections
Number of OAI Requests
Customizable summary of archive contents
Broken-down list of item viewings
A full break-down of all performed actions
User logins
Most popular searches
Log Level Information
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 34 of 901
DSpace 6.x Documentation
Processing information!stats_genrl_overview.png!
The results of statistical analysis can be presented on a by-month and an in-total report, and are
available via the user interface. The reports can also either be made public or restricted to administrator
access only.
1.2.10 Digital Preservation
Checksum Checker
The purpose of the checker is to verify that the content in a DSpace repository has not become corrupted or
been tampered with. The functionality can be invoked on an ad-hoc basis from the command line, or configured
via cron or similar. Options exist to support large repositories that cannot be entirely checked in one run of the
tool. The tool is extensible to new reporting and checking priority approaches.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 35 of 901
DSpace 6.x Documentation
1.2.11 System Design
Data Model
Data Model Diagram
The way data is organized in DSpace is intended to reflect the structure of the organization using the DSpace
system. Each DSpace site is divided into communities, which can be further divided into sub-communities
reflecting the typical university structure of college, department, research center, or laboratory.
Communities contain collections, which are groupings of related content. A collection may appear in more than
one community.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 36 of 901
DSpace 6.x Documentation
Each collection is composed of items, which are the basic archival elements of the archive. Each item is owned
by one collection. Additionally, an item may appear in additional collections; however every item has one and
only one owning collection.
Items are further subdivided into named bundles of bitstreams. Bitstreams are, as the name suggests, streams
of bits, usually ordinary computer files. Bitstreams that are somehow closely related, for example HTML files
and images that compose a single HTML document, are organized into bundles.
In practice, most items tend to have these named bundles:
ORIGINAL – the bundle with the original, deposited bitstreams
THUMBNAILS – thumbnails of any image bitstreams
TEXT – extracted full-text from bitstreams in ORIGINAL, for indexing
LICENSE – contains the deposit license that the submitter granted the host organization; in other words,
specifies the rights that the hosting organization have
CC_LICENSE – contains the distribution license, if any (a icenommons license) associated with the item.
This license specifies what end users downloading the content can do with the content
Each bitstream is associated with one Bitstream Format. Because preservation services may be an important
aspect of the DSpace service, it is important to capture the specific formats of files that users submit. In
DSpace, a bitstream format is a unique and consistent way to refer to a particular file format. An integral part of
a bitstream format is an either implicit or explicit notion of how material in that format can be interpreted. For
example, the interpretation for bitstreams encoded in the JPEG standard for still image compression is defined
explicitly in the Standard ISO/IEC 10918-1. The interpretation of bitstreams in Microsoft Word 2000 format is
defined implicitly, through reference to the Microsoft Word 2000 application. Bitstream formats can be more
specific than MIME types or file suffixes. For example, application/ms-word and .doc span multiple versions of
the Microsoft Word application, each of which produces bitstreams with presumably different characteristics.
Each bitstream format additionally has a support level, indicating how well the hosting institution is likely to be
able to preserve content in the format in the future. There are three possible support levels that bitstream
formats may be assigned by the hosting institution. The host institution should determine the exact meaning of
each support level, after careful consideration of costs and requirements. MIT Libraries' interpretation is shown
below:
Supported
The format is recognized, and the hosting institution is confident it can make bitstreams of
this format usable in the future, using whatever combination of techniques (such as migration,
emulation, etc.) is appropriate given the context of need.
Known
The format is recognized, and the hosting institution will promise to preserve the bitstream asis, and allow it to be retrieved. The hosting institution will attempt to obtain enough
information to enable the format to be upgraded to the 'supported' level.
Unsupported The format is unrecognized, but the hosting institution will undertake to preserve the
bitstream as-is and allow it to be retrieved.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 37 of 901
DSpace 6.x Documentation
Each item has one qualified Dublin Core metadata record. Other metadata might be stored in an item as a
serialized bitstream, but we store Dublin Core for every item for interoperability and ease of discovery. The
Dublin Core may be entered by end-users as they submit content, or it might be derived from other metadata as
part of an ingest process.
Items can be removed from DSpace in one of two ways: They may be 'withdrawn', which means they remain in
the archive but are completely hidden from view. In this case, if an end-user attempts to access the withdrawn
item, they are presented with a 'tombstone,' that indicates the item has been removed. For whatever reason, an
item may also be 'expunged' if necessary, in which case all traces of it are removed from the archive.
Object
Example
Community
Laboratory of Computer Science; Oceanographic Research Center
Collection
LCS Technical Reports; ORC Statistical Data Sets
Item
A technical report; a data set with accompanying description; a video recording of a lecture
Bundle
A group of HTML and image bitstreams making up an HTML document
Bitstream
A single HTML file; a single image file; a source code file
Bitstream
Microsoft Word version 6.0; JPEG encoded image format
Format
Amazon S3 Support
DSpace offers two means for storing bitstreams. The first is in the file system on the server. The second is
using Amazon S3. For more information, see Storage Layer
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 38 of 901
DSpace 6.x Documentation
2 Installing DSpace
For the Impatient
Hardware Recommendations
Prerequisite Software
UNIX-like OS or Microsoft Windows
Java JDK 7 or 8 (OpenJDK or Oracle JDK)
Apache Maven 3.0.5 or above (3.3.9+)* (Java build tool)
Configuring a Proxy
Apache Ant 1.8 or later (Java build tool)
Relational Database: (PostgreSQL or Oracle)
PostgreSQL 9.4 or later (with pgcrypto installed)
Oracle 10g or later
Servlet Engine (Apache Tomcat 7 or later, Jetty, Caucho Resin or equivalent)
Installation Instructions
Overview of Install Options
Overview of DSpace Directories
Installation
Advanced Installation
'cron' jobs / scheduled tasks
Multilingual Installation
DSpace over HTTPS
Enabling the HTTPS support in Tomcat itself (running on ports 8080 and 8443)
Using SSL on Apache HTTPD in front of Tomcat (running on ports 80 and 443)
The Handle Server
To install your Handle resolver on the host where DSpace runs:
To install a Handle resolver on a separate machine:
Updating Existing Handle Prefixes
Google and HTML sitemaps
Statistics
Windows Installation
Checking Your Installation
Known Bugs
Common Problems
Common Installation Issues
General DSpace Issues
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 39 of 901
DSpace 6.x Documentation
2.1 For the Impatient
Since some users might want to get their test version up and running as fast as possible, offered below is an
unsupported outline of getting DSpace to run quickly in a Unix-based environment using the DSpace source
release.
Only experienced unix admins should even attempt the following without going to the detailed
Installation Instructions
useradd -m dspace
gzip xzf dspace-6.x-src-release.tar.gz
createuser --username=postgres --no-superuser --pwprompt dspace
createdb --username=postgres --owner=dspace --encoding=UNICODE dspace
psql --username=postgres dspace -c "CREATE EXTENSION pgcrypto;"
cd [dspace-source]/dspace/config/
cp local.cfg.EXAMPLE local.cfg
vi local.cfg
mkdir [dspace]
chown dspace [dspace]
su - dspace
cd [dspace-source]
mvn package
cd [dspace-source]/dspace/target/dspace-installer
ant fresh_install
cp -r [dspace]/webapps/* [tomcat]/webapps
/etc/init.d/tomcat start
[dspace]/bin/dspace create-administrator
2.2 Hardware Recommendations
You can install and run DSpace on most modern PC, laptop or server hardware. However, if you intend to run
DSpace for a large community of potential end users, carefully review the Hardware Recommendations in the
User FAQ
2.3 Prerequisite Software
The list below describes the third-party components and tools you'll need to run a DSpace server. These are
just guidelines. Since DSpace is built on open source, standards-based tools, there are numerous other
possibilities and setups.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 40 of 901
DSpace 6.x Documentation
Also, please note that the configuration and installation guidelines relating to a particular tool below are here for
convenience. You should refer to the documentation for each individual component for complete and up-to-date
details. Many of the tools are updated on a frequent basis, and the guidelines below may become out of date.
2.3.1 UNIX-like OS or Microsoft Windows
UNIX-like OS (Linux, HP/UX, Mac OSX, etc.) : Many distributions of Linux/Unix come with some of the
dependencies below pre-installed or easily installed via updates. You should consult your particular
distribution's documentation or local system administrators to determine what is already available.
Microsoft Windows: After verifying all prerequisites below, see the Windows Installation section for
Windows tailored instructions
2.3.2 Java JDK 7 or 8 (OpenJDK or Oracle JDK)
OpenJDK download and installation instructions can be found here http://openjdk.java.net/install/. Most
operating systems provide an easy path to install OpenJDK. Just be sure to install the full JDK (development
kit), and not the JRE (which is often the default example).
Oracle's Java can be downloaded from the following location: http://www.oracle.com/technetwork/java/javase
/downloads/index.html. Make sure to download the appropriate version of the Java SE JDK.
Make sure to install the JDK and not just the JRE
At this time, DSpace requires the full JDK (Java Development Kit) be installed, rather than just the
JRE (Java Runtime Environment). So, please be sure that you are installing the full JDK and not just
the JRE.
Be aware that Tomcat 7 uses Java 1.6 to compile JSPs by default. See information about Tomcat
below on how to configure it to use Java 1.7 for JSPs. Tomcat 8 uses Java 1.7 for JSPs by default. If
you use another Servlet Container please refer to its documentation on this matter.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 41 of 901
DSpace 6.x Documentation
Optional ElasticSearch Usage Statistics feature has its own Java requirements
If you plan to use the (optional) Elasticsearch Usage Statistics feature in DSpace, the ElasticSearch
backend provides its own recommendations regarding Java version.
http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/setup.html
"Elasticsearch is built using Java, and requires at least Java 7 in order to run. Only Oracle’s Java and
the OpenJDK are supported. We recommend installing the Java 8 update 20 or later , or Java 7
update 55 or later . Previous versions of Java 7 are known to have bugs that can cause index
corruption and data loss."
(However, if you plan to use the Solr-based Usage Statistics that are enabled by default within
DSpace, you can ignore these additional requirements.)
2.3.3 Apache Maven 3.0.5 or above (3.3.9+)* (Java build tool)
Maven is necessary in the first stage of the build process to assemble the installation package for your DSpace
instance. It gives you the flexibility to customize DSpace using the existing Maven projects found in the [dspace-
source]/dspace/modules directory or by adding in your own Maven project to build the installation package for
DSpace, and apply any custom interface "overlay" changes.
*
If you will be building the Mirage 2 theme, you will need Maven 3.3.9 or above (see DS-2458 for
details as to why).
Maven can be downloaded from the following location: http://maven.apache.org/download.html
Configuring a Proxy
You can configure a proxy to use for some or all of your HTTP requests in Maven. The username and password
are only required if your proxy requires basic authentication (note that later releases may support storing your
passwords in a secured keystore‚ in the mean time, please ensure your settings.xml file (usually ${user.home}/.
m2/settings.xml) is secured with permissions appropriate for your operating system).
Example:
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 42 of 901
DSpace 6.x Documentation
.
.
true
http
proxy.somewhere.com
8080
proxyuser
somepassword
www.google.com|*.somewhere.com
.
.
2.3.4 Apache Ant 1.8 or later (Java build tool)
Apache Ant is required for the second stage of the build process (deploying/installing the application). First,
Maven is used to construct the installer ([dspace-source]/dspace/target/dspace-installer), after
which Ant is used to install/deploy DSpace to the installation directory.
Ant can be downloaded from the following location: http://ant.apache.org
2.3.5 Relational Database: (PostgreSQL or Oracle)
PostgreSQL 9.4 or later (with pgcrypto installed)
DSpace 6 requires Postgres 9.4+ with the pgcrypto extension enabled
PostgreSQL users MUST ensure they are running 9.4 or above AND have the pgcrypto extension
installed and enabled.
The pgcrypto extension allows DSpace to create UUIDs (universally unique identifiers) for all objects
in DSpace, which means that (internal) object identifiers are now globally unique and no longer tied to
database sequences.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 43 of 901
DSpace 6.x Documentation
PostgreSQL can be downloaded from http://www.postgresql.org/. It is also provided via many operating
system package managers
If the version of Postgres provided by your package manager is outdated, you may wish to use
one of the official PostgreSQL provided repositories:
Linux users can select their OS of choice for detailed instructions on using the official
PostgreSQL apt or yum repository: http://www.postgresql.org/download/linux/
Windows users will need to use the windows installer: http://www.postgresql.org/download
/windows/
Mac OSX users can choose their preferred installation method: http://www.postgresql.org
/download/macosx/
Install the pgcrypto extension. It will also need to be enabled on your DSpace Database (see Installation
instructions below for more info).
On most Linux operating systems (Ubuntu, Debian, RedHat), this extension is provided in the
"postgresql-contrib" package in your package manager. So, ensure you've installed "postgresqlcontrib".
On Windows, this extension should be provided automatically by the installer (check your
"[PostgreSQL]/share/extension" folder for files starting with "pgcrypto")
Unicode (specifically UTF-8) support must be enabled (but this is enabled by default).
Once installed, you need to enable TCP/IP connections (DSpace uses JDBC):
In postgresql.conf: uncomment the line starting: listen_addresses = 'localhost'.
This is the default, in recent PostgreSQL releases, but you should at least check it.
Then tighten up security a bit by editing pg_hba.conf and adding this line: host dspace
dspace 127.0.0.1 255.255.255.255 md5. This should appear before any lines matching
all databases, because the first matching rule governs.
Then restart PostgreSQL.
Oracle 10g or later
Details on acquiring Oracle can be downloaded from the following location: http://www.oracle.com
/database/. You will need to create a database for DSpace. Make sure that the character set is one of the
Unicode character sets. DSpace uses UTF-8 natively, and it is suggested that the Oracle database use
the same character set. You will also need to create a user account for DSpace (e.g. dspace) and ensure
that it has permissions to add and remove tables in the database. Refer to the Quick Installation for more
details.
NOTE: If the database server is not on the same machine as DSpace, you must install the Oracle
client to the DSpace server and point tnsnames.ora and listener.ora files to the database
the Oracle server.
For people interested in switching from PostgreSQL to Oracle (or visa versa), you may be able to
inves
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 44 of 901
DSpace 6.x Documentation
2.3.6 Servlet Engine (Apache Tomcat 7 or later, Jetty, Caucho
Resin or equivalent)
Tomcat 8 Version
Tomcat 8.0.32 (found e.g. in Debian 9 Stretch and Ubuntu 16.04 Xenial) has a bug which will cause
PropertyBatchUpdateException or StringIndexOutOfBoundsException. This was fixed in 8.0.33. More
information can be found in DS-3142.
Tomcat 7 Version
If you are using Tomcat 7, we recommend running Tomcat 7.0.30 or above. Tomcat 7.0.29 and lower
versions suffer from a memory leak. As a result, those versions of tomcat require an unusual high
amount of memory to run DSpace. This has been resolved as of Tomcat 7.0.30. More information can
be found in DS-1553
Apache Tomcat 7 or later. Tomcat can be downloaded from the following location: http://tomcat.apache.
org.
Note that DSpace will need to run as the same user as Tomcat, so you might want to install and
run Tomcat as a user called 'dspace'. Set the environment variable TOMCAT_USER
appropriately.
You need to ensure that Tomcat has a) enough memory to run DSpace and b) uses UTF-8 as its
default file encoding for international character support. So ensure in your startup scripts (etc) that
the following environment variable is set: JAVA_OPTS="-Xmx512M -Xms64M -Dfile.
encoding=UTF-8"
Modifications in [tomcat]/conf/server.xml : You also need to alter Tomcat's default
configuration to support searching and browsing of multi-byte UTF-8 correctly. You need to add a
configuration option to the element in [tomcat]/config/server.xml: URIEncoding="
UTF-8" e.g. if you're using the default Tomcat config, it should read:
jsp
org.apache.jasper.servlet.JspServlet
fork
false
xpoweredBy
false
compilerSourceVM
1.7
compilerTargetVM
1.7
3
Jetty or Caucho Resin DSpace will also run on an equivalent servlet Engine, such as Jetty (http://www.
mortbay.org/jetty/index.html) or Caucho Resin (http://www.caucho.com/). Jetty and Resin are configured
for correct handling of UTF-8 by default.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 46 of 901
DSpace 6.x Documentation
2.4 Installation Instructions
2.4.1 Overview of Install Options
Two different distributions are available for DSpace, both of which require you to build the distribution using
Apache Maven 3. The steps that are required to execute the build are identical. In a nutshell, the binary release
build will download pre-compiled parts of DSpace, while the building the source release will compile most of
DSpace's source code on your local machine.
It's important to notice that both releases will require outgoing internet connections on the machine or server
where you are executing the build, because maven needs to download 3rd party dependencies that are not
even included in the DSpace source release distribution.
Binary Release (dspace--release.zip)
This distribution will be adequate for most cases of running a DSpace instance. It is intended to be
the quickest way to get DSpace installed and running while still allowing for customization of the
themes and branding of your DSpace instance.
This method allows you to customize DSpace configurations (in dspace.cfg) or user interfaces,
using basic pre-built interface "overlays".
It downloads "precompiled" libraries for the core dspace-api, supporting servlets, taglibraries,
aspects and themes for the dspace-xmlui, dspace-xmlui and other webservice/applications.
This approach only exposes selected parts of the application for customization. All other modules
are downloaded from the 'Maven Central Repository' The directory structure for this release is the
following:
[dspace-source]
dspace/ - DSpace 'build' and configuration module
Source Release (dspace--src-release.zip)
This method is recommended for those who wish to develop DSpace further or alter its underlying
capabilities to a greater degree.
It contains all dspace code for the core dspace-api, supporting servlets, taglibraries, aspects and
themes for Manakin (dspace-xmlui), and other webservice/applications.
Provides all the same capabilities as the binary release. The directory structure for this release is
more detailed:
[dspace-source]
dspace - DSpace 'build' and configuration module
dspace-api - Java API source module
dspace-jspui - JSP-UI source module
dspace-oai - OAI-PMH source module
dspace-rdf - RDF source module
dspace-rest - REST API source module
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 47 of 901
DSpace 6.x Documentation
dspace-services - Common Services module
dspace-sword - SWORD (Simple Web-serve Offering Repository Deposit) deposit
service source module
dspace-swordv2 - SWORDv2 source module
dspace-xmlui - XML-UI (Manakin) source module
dspace-xmlui-mirage2 - Mirage 2 theme for the XMLUI
pom.xml - DSpace Parent Project definition
2.4.2 Overview of DSpace Directories
Before beginning an installation, it is important to get a general understanding of the DSpace directories and the
names by which they are generally referred. (Please attempt to use these below directory names when asking
for help on the DSpace Mailing Lists, as it will help everyone better understand what directory you may be
referring to.)
DSpace uses three separate directory trees. Although you don't need to know all the details of them in order to
install DSpace, you do need to know they exist and also know how they're referred to in this document:
1. The installation directory, referred to as [dspace]. This is the location where DSpace is installed and
running. It is the location that is defined in the dspace.cfg as "dspace.dir". It is where all the DSpace
configuration files, command line scripts, documentation and webapps will be installed.
2. The source directory, referred to as [dspace-source] . This is the location where the DSpace
release distribution has been unpacked. It usually has the name of the archive that you expanded such
as dspace--release or dspace--src-release. Normally it is the directory
where all of your "build" commands will be run.
3. The web deployment directory. This is the directory that contains your DSpace web application(s).This
corresponds to [dspace]/webapps by default. However, if you are using Tomcat, you may decide to
copy your DSpace web applications from [dspace]/webapps/ to [tomcat]/webapps/ (with
[tomcat] being wherever you installed Tomcat‚ also known as $CATALINA_HOME).
For details on the contents of these separate directory trees, refer to directories.html. Note that the
[dspace-source] and [dspace] directories are always separate!
If you ever notice that many files seems to have duplicates under [dspace-source]/dspace/target do not
worry about it. This "target" directory will be used by Maven for the build process and you should not change
any file in it unless you know exactly what you are doing.
2.4.3 Installation
This method gets you up and running with DSpace quickly and easily. It is identical in both the Default Release
and Source Release distributions.
1.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 48 of 901
DSpace 6.x Documentation
1. Create the DSpace user. This needs to be the same user that Tomcat (or Jetty etc.) will run as. e.g. as
root run:
useradd -m dspace
2. Download the latest DSpace release. There are two version available with each release of DSpace: (
dspace-n.x-release. and dspace-n.x-src-release.zzz); you only need to choose one. If you want a copy of
all underlying Java source code, you should download the dspace-n.x-src-release.xxxWithin each
version, you have a choice of compressed file format. Choose the one that best fits your environment.
a. Alternatively, you may choose to check out the latest release from the DSpace GitHub Repository.
In this case, you'd be checking out the full Java source code. You'd also want to be sure to
checkout the appropriate tag or branch. For more information on using / developing from the
GitHub Repository, see: Development with Git
3. Unpack the DSpace software. After downloading the software, based on the compression file format,
choose one of the following methods to unpack your software:
a. Zip file. If you downloaded dspace-6.x-release.zip do the following:
unzip dspace-6.x-release.zip
b. .gz file. If you downloaded dspace-6.x-release.tar.gz do the following:
gunzip -c dspace-6.x-release.tar.gz | tar -xf -
c. .bz2 file. If you downloaded _dspace-6.x-release.tar.bz do the following:
bunzip2 dspace-6.x-release.tar.bz | tar -xf -
For ease of reference, we will refer to the location of this unzipped version of the DSpace release
as [dspace-source] in the remainder of these instructions. After unpacking the file, the user may
wish to change the ownership of the dspace-6.x-release to the "dspace" user. (And you may need
to change the group).
4. Database Setup
Also see "Relational Database" prerequisite notes above
PostgreSQL:
A PostgreSQL JDBC driver is configured as part of the default DSpace build. You no longer
need to copy any PostgreSQL jars to get PostgreSQL installed.
Create a dspace database user (this user can have any name, but we'll assume you name
them "dspace"). This is entirely separate from the dspace operating-system user created
above:
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 49 of 901
DSpace 6.x Documentation
createuser --username=postgres --no-superuser --pwprompt dspace
You will be prompted (twice) for a password for the new dspace user. Then you'll be
prompted for the password of the PostgreSQL superuser (postgres).
Create a dspace database, owned by the dspace PostgreSQL user. Similar to the
previous step, this can only be done by a "superuser" account in PostgreSQL (e.g.
postgres):
createdb --username=postgres --owner=dspace --encoding=UNICODE dspace
You will be prompted for the password of the PostgreSQL superuser ( postgres).
Finally, you MUST enable the pgcrypto extension on your new dspace database. Again,
this can only be enabled by a "superuser" account (e.g. postgres)
# Login to the database as a superuser, and enable the pgcrypto extension on this
database
psql --username=postgres dspace -c "CREATE EXTENSION pgcrypto;"
The "CREATE EXTENSION" command should return with no result if it succeeds. If it fails
or throws an error, it is likely you are missing the required pgcrypto extension (see
Database Prerequisites above).
Alternative method: How to enable pgcrypto via a separate database schema.
While the above method of enabling pgcrypto is perfectly fine for the majority of
users, there may be some scenarios where a database administrator would prefer to
install extensions into a database schema that is separate from the DSpace tables.
Developers also may wish to install pgcrypto into a separate schema if they plan to
"clean" (recreate) their development database frequently. Keeping extensions in a
separate schema from the DSpace tables will ensure developers would NOT have to
continually re-enable the extension each time you run a "./dspace database
clean". If you wish to install pgcrypto in a separate schema here's how to do that:
# Login to the database as a superuser
psql --username=postgres dspace
# Create a new schema in this database named "extensions" (or whatever
you want to name it)
CREATE SCHEMA extensions;
# Enable this extension in this new schema
CREATE EXTENSION pgcrypto SCHEMA extensions;
# Determine what your database "search_path" is set to
# (the search_path is where your database will look for extensions)
SHOW search_path;
# Update your database's "search_path" to also search the new "extensions"
schema.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 50 of 901
DSpace 6.x Documentation
# You are just
list.
ALTER DATABASE
extensions;
# Grant rights
user
GRANT USAGE ON
appending it on the end of the existing comma-separated
dspace SET search_path TO [existing-search_path-list],
to call functions in the extensions schema to your dspace
SCHEMA extensions TO dspace;
Oracle:
Setting up DSpace to use Oracle is a bit different now. You will need still need to get a copy
of the Oracle JDBC driver, but instead of copying it into a lib directory you will need to
install it into your local Maven repository. (You'll need to download it first from this location:
http://www.oracle.com/technetwork/database/enterprise-edition/jdbc-112010-090769.html.)
Run the following command (all on one line):
mvn install:install-file
-Dfile=ojdbc6.jar
-DgroupId=com.oracle
-DartifactId=ojdbc6
-Dversion=11.2.0.4.0
-Dpackaging=jar
-DgeneratePom=true
You need to compile DSpace with an Oracle driver (ojdbc6.jar) corresponding to your
Oracle version - update the version in [dspace-source]/pom.xml E.g.:
com.oracle
ojdbc6
11.2.0.4.0
Create a database for DSpace. Make sure that the character set is one of the Unicode
character sets. DSpace uses UTF-8 natively, and it is required that the Oracle database
use the same character set. Create a user account for DSpace (e.g. dspace) and ensure
that it has permissions to add and remove tables in the database.
NOTE: You will need to ensure the proper db.* settings are specified in your local.cfg
file (see next step), as the defaults for all of these settings assuming a PostgreSQL
database backend.
db.url = jdbc:oracle:thin:@host:port/SID
# e.g. db.url = jdbc:oracle:thin:@//localhost:1521/xe
# NOTE: in db.url, SID is the SID of your database defined in tnsnames.ora
# the default Oracle port is 1521
# You may also use a full SID definition, e.g.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 51 of 901
DSpace 6.x Documentation
# db.url = jdbc:oracle:thin:@(description=(address_list=(address=(protocol=TCP)
(host=localhost)(port=1521)))(connect_data=(service_name=DSPACE)))
# Oracle driver and dialect
db.driver = oracle.jdbc.OracleDriver
db.dialect = org.hibernate.dialect.Oracle10gDialect
# Specify DB username, password and schema to use
db.username =
db.password =
db.schema = ${db.username}
# For Oracle, schema is equivalent to the username of your database account,
# so this may be set to ${db.username} in most scenarios
Later, during the Maven build step, don't forget to specify mvn -Ddb.name=oracle
package
5. Initial Configuration (local.cfg): Create your own [dspace-source]/dspace/config/local.cfg
configuration file (you may wish to simply copy the provided [dspace-source]/dspace/config
/local.cfg.EXAMPLE). This local.cfg file can be used to store any configuration changes that you
wish to make which are local to your installation (see local.cfg configuration file documentation). ANY
setting may be copied into this local.cfg file from the dspace.cfg or any other *.cfg file in order to override
the default setting (see note below). For the initial installation of DSpace, there are some key settings
you'll likely want to override, those are provided in the [dspace-source]/dspace/config/local.
cfg.EXAMPLE. (NOTE: Settings followed with an asterisk (*) are highly recommended, while all others
are optional during initial installation and may be customized at a later time)
dspace.dir* - must be set to the [dspace] (installation) directory (NOTE: On Windows be sure
to use forward slashes for the directory path! For example: "C:/dspace" is a valid path for
Windows.)
dspace.hostname - fully-qualified domain name of web server (or "localhost" if you just want to
run DSpace locally for now)
dspace.baseUrl* - complete URL of this server's DSpace home page (including port), but
without any context eg. /xmlui, /oai, etc.
dspace.name - "Proper" name of your server, e.g. "My Digital Library".
solr.server* - complete URL of the Solr server. DSpace makes use of Solr for indexing
purposes.
default.language - Default language for all metadata values (defaults to "en_US")
db.url* - The full JDBC URL to your database (examples are provided in the local.cfg.
EXAMPLE)
db.driver* - Which database driver to use, based on whether you are using PostgreSQL or
Oracle
db.dialect* - Which database dialect to use, based on whether you are using PostgreSQL or
Oracle
db.username* - the database username used in the previous step.
db.password* - the database password used in the previous step.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 52 of 901
DSpace 6.x Documentation
db.schema* - the database scheme to use (examples are provided in the local.cfg.EXAMPLE)
mail.server - fully-qualified domain name of your outgoing mail server.
mail.from.address - the "From:" address to put on email sent by DSpace.
mail.feedback.recipient - mailbox for feedback mail.
mail.admin - mailbox for DSpace site administrator.
mail.alert.recipient - mailbox for server errors/alerts (not essential but very useful!)
mail.registration.notify- mailbox for emails when new users register (optional)
Your local.cfg file can override ANY settings from other *.cfg files in DSpace
The provided local.cfg.EXAMPLE only includes a small subset of the configuration
settings available with DSpace. It provides a good starting point for your own local.cfg
file.
However, you should be aware that ANY configuration can now be copied into your
local.cfg to override the default settings. This includes ANY of the settings
/configurations in:
The primary dspace.cfg file ([dspace]/config/dspace.cfg)
Any of the module configuration files ([dspace]/config/modules/*.cfg
files)
Individual settings may also be commented out or removed in your local.cfg, in order
to re-enable default settings.
See the Configuration Reference section for more details.
6. DSpace Directory: Create the directory for the DSpace installation (i.e. [dspace]). As root (or a user
with appropriate permissions), run:
mkdir [dspace]
chown dspace [dspace]
(Assuming the dspace UNIX username.)
7. Build the Installation Package: As the dspace UNIX user, generate the DSpace installation package.
cd [dspace-source]
mvn package
Building with Oracle Database Support
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 53 of 901
DSpace 6.x Documentation
Without any extra arguments, the DSpace installation package is initialized for PostgreSQL. If
you want to use Oracle instead, you should build the DSpace installation package as follows:
mvn -Ddb.name=oracle package
Enabling and building the Mirage 2 theme (for XMLUI)
Mirage 2 is a responsive theme for the XML User Interface, added as a new feature in DSpace
5. It has not yet replaced the Mirage 1 theme as the XMLUI default theme.
The Mirage 2 build requires git to be installed on your server. Install git before attempting the
Mirage 2 build.
To enable Mirage 2, add the following to the section of [dspace-source]/dspace
/config/xmlui.xconf , replacing the currently active theme:
element:reloadable="true" cachingAllowed="false"
These settings are extremely useful to have when you are first getting started with
DSpace, as they let you tweak the DSpace XMLUI (XSLTs or CSS) or JSPUI (JSPs) and
see your changes get automatically reloaded by Tomcat (without having to restart
Tomcat). However, it is worth noting that the Apache Tomcat documentation
recommends Production sites leave the default values in place (reloadable="
false" cachingAllowed="true"), as allowing Tomcat to automatically reload all
changes may result in "significant runtime overhead".
It is entirely up to you whether to keep these Tomcat settings in place. We just
recommend beginning with them, so that you can more easily customize your site
without having to require a Tomcat restart. Smaller DSpace sites may not notice any
performance issues with keeping these settings in place in Production. Larger DSpace
sites may wish to ensure that Tomcat performance is more streamlined.
Technique B. Simple and complete. You copy only (or all) of the DSpace Web application(s) you
wish to use from the [dspace]/webapps directory to the appropriate directory in your Tomcat/Jetty
/Resin installation. For example:
cp -R [dspace]/webapps/* [tomcat]/webapps* (This will copy all the web applications to
Tomcat).
cp -R [dspace]/webapps/jspui [tomcat]/webapps* (This will copy only the jspui web
application to Tomcat.)
11. Administrator Account: Create an initial administrator account from the command line:
[dspace]/bin/dspace create-administrator
12. Initial Startup! Now the moment of truth! Start up (or restart) Tomcat/Jetty/Resin. Visit the base URL(s)
of your server, depending on which DSpace web applications you want to use. You should see the
DSpace home page. Congratulations! Base URLs of DSpace Web Applications:
a.
JSP User Interface - (e.g.) http://dspace.myu.edu:8080/jspui
XML User Interface (aka. Manakin) - (e.g.) http://dspace.myu.edu:8080/xmlui
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 57 of 901
a.
DSpace 6.x Documentation
OAI-PMH Interface - (e.g.) http://dspace.myu.edu:8080/oai/request?
verb=Identify (Should return an XML-based response)
In order to set up some communities and collections, you'll need to login as your DSpace Administrator (which
you created with create-administrator above) and access the administration UI in either the JSP or XML
user interface.
2.5 Advanced Installation
The above installation steps are sufficient to set up a test server to play around with, but there are a few other
steps and options you should probably consider before deploying a DSpace production site.
2.5.1 'cron' jobs / scheduled tasks
A few DSpace features require that a script is run regularly (via cron, or similar):
the e-mail subscription feature that alerts users of new items being deposited;
the 'media filter' tool, that generates thumbnails of images and extracts the full-text of documents for
indexing;
the 'checksum checker' that tests the bitstreams in your repository for corruption;
the sitemap generator, which enhances the ability of major search engines to index your content and
make it findable;
the curation system queueing feature, which allows administrators to "queue" tasks (to run at a later
time) from the Admin UI;
and Discovery (search & browse), OAI-PMH and Usage Statistics all receive performance benefits from
regular re-optimization
For much more information on recommended scheduled tasks, please see Scheduled Tasks via Cron.
2.5.2 Multilingual Installation
In order to deploy a multilingual version of DSpace you have to configure two parameters in [dspace-source]
/dspace/config/local.cfg:
default.locale, e.g. default.locale = en
webui.supported locales, e.g. webui.supported.locales = en, de
The Locales might have the form country, country_language, country_language_variant.
According to the languages you wish to support, you have to make sure that all the i18n related files are
available. See the Configuring Multilingual Support section for the JSPUI or the Multilingual Support for XMLUI
in the configuration documentation.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 58 of 901
DSpace 6.x Documentation
2.5.3 DSpace over HTTPS
If your DSpace is configured to have users login with a username and password (as opposed to, say, client
Web certificates), then you should consider using HTTPS. Whenever a user logs in with the Web form (e.g.
dspace.myuni.edu/dspace/password-login) their DSpace password is exposed in plain text on the network. This
is a very serious security risk since network traffic monitoring is very common, especially at universities. If the
risk seems minor, then consider that your DSpace administrators also login this way and they have ultimate
control over the archive.
The solution is to use HTTPS (HTTP over SSL, i.e. Secure Socket Layer, an encrypted transport), which
protects your passwords against being captured. You can configure DSpace to require SSL on all
"authenticated" transactions so it only accepts passwords on SSL connections.
The following sections show how to set up the most commonly-used Java Servlet containers to support HTTP
over SSL.
Enabling the HTTPS support in Tomcat itself (running on ports 8080 and
8443)
Loosely based on http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html.
1. For Production use: Follow this procedure to set up SSL on your server. Using a "real" server certificate
ensures your users' browsers will accept it without complaints. In the examples below,
$CATALINA_BASE is the directory under which your Tomcat is installed.
a. Create a Java keystore for your server with the password changeit, and install your server
certificate under the alias "tomcat". This assumes the certificate was put in the file server.pem:
$JAVA_HOME/bin/keytool -import -noprompt -v -storepass changeit
-keystore $CATALINA_BASE/conf/keystore -alias tomcat -file
myserver.pem
b. Install the CA (Certifying Authority) certificate for the CA that granted your server cert, if
necessary. This assumes the server CA certificate is in ca.pem:
$JAVA_HOME/bin/keytool -import -noprompt -storepass changeit
-trustcacerts -keystore $CATALINA_BASE/conf/keystore -alias ServerCA
-file ca.pem
c. Optional – ONLY if you need to accept client certificates for the X.509 certificate stackable
authentication module See the configuration section for instructions on enabling the X.509
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 59 of 901
c.
DSpace 6.x Documentation
authentication method. Load the keystore with the CA (certifying authority) certificates for the
authorities of any clients whose certificates you wish to accept. For example, assuming the client
CA certificate is in client1.pem:
$JAVA_HOME/bin/keytool -import -noprompt -storepass changeit
-trustcacerts -keystore $CATALINA_BASE/conf/keystore
-file client1.pem
-alias client1
d. Now add another Connector tag to your server.xml Tomcat configuration file, like the example
below. The parts affecting or specific to SSL are shown in bold. (You may wish to change some
details such as the port, pathnames, and keystore password)
# Obviously, replace the ServerName with your DSpace site URL
ServerName my.dspace.edu
## Apache HTTP Server Logging Settings - modify how you see fit
ErrorLog ${APACHE_LOG_DIR}/my.dspace.edu-error.log
CustomLog ${APACHE_LOG_DIR}/my.dspace.edu-access.log combined
# Possible values include: debug, info, notice, warn, error, crit, alert,
emerg.
LogLevel warn
# There are many more configurations available for Virtual Hosts,
# see the documentation for more details
# http://httpd.apache.org/docs/2.4/vhosts/
iv. If you want your site to also respond to SSL requests, you'll need to install and enable "
mod_ssl" and create a second Virtual Host to respond to port 443 requests. An example is
provided below. But much more details are available in the Apache HTTP SSL
Documentation and the mod_ssl documentation
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 62 of 901
iv.
DSpace 6.x Documentation
# Obviously, replace the ServerName with your DSpace site URL
ServerName my.dspace.edu
# You can have SSL Apache logging settings here too (see the port 80 example
above)
# Configure your SSL Certificate (you must create one, obviously)
# See the "keytool" instructions above for examples of creating this
certificate
# There are also many good guides on the web for generating SSL certificates f
or Apache
SSLEngine on
SSLCertificateChainFile /path/to/your/chainfile.crt
SSLCertificateFile
/path/to/your/public-cert.crt
SSLCertificateKeyFile
/path/to/your/private-key.key
# More information on SSL configurations can be found in the mod_ssl
documentation
# http://httpd.apache.org/docs/2.4/mod/mod_ssl.html
Extra SSL Configurations for X.509 Client Certificates authentication
If you are using X.509 Client Certificates for authentication: add these
configuration options to the appropriate httpd configuration file, e.g. ssl.conf, and
be sure they are in force for the virtual host and namespace locations dedicated
to DSpace:
## SSLVerifyClient can be "optional" or "require"
SSLVerifyClient optional
SSLVerifyDepth 10
SSLCACertificateFile /path/to/your/client-CA-certificate
SSLOptions StdEnvVars ExportCertData
v. In each of your Apache HTTP Virtual Hosts (see above), use "ProxyPass" configurations to
configure the redirects from Apache HTTP Server to Apache Tomcat. The exact
configurations depend on whether you want to redirect ALL requests to Tomcat, or just
certain paths. Here's a basic example. But much more information and examples can be
found in the mod_proxy documentation
# These are just examples. THEY LIKELY WILL NEED MODIFICATION.
# Again, remember to add these to your EXISTING settings
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 63 of 901
DSpace 6.x Documentation
... (existing settings) ...
# If there's a single path you do NOT want redirected, you can use ! to ignore
it
# In this case any requests to "/ignored_path" will be handled by Apache HTTPD
and NOT forwarded to Tomcat
ProxyPass /ignored_path !
# These configurations say: By default, redirect ALL requests to port 8009
# (The port MUST match the port of your Tomcat AJP Connector. By default this
usually is 8009)
ProxyPass
ProxyPassReverse
/
/
ajp://localhost:8009/
ajp://localhost:8009/
# You may also wish to provide additional "mod_proxy" configurations,
# for more examples and details see the documentation at
# http://httpd.apache.org/docs/2.4/mod/mod_proxy.html
b. OPTION 2: Alternatively, use "mod_jk" Apache module to redirect requests to Tomcat (via AJP
Connector). For information on configuring mod_jk, please see the Apache Tomcat Connector
documentation (specifically the "How To" on using the Tomcat Connector with Apache HTTP
Server). You may also refer to our wiki guide for installing DSpace with ModJk.
4. Finally, restart your Apache HTTP Server and test things out.
a. If you hit any issues, it is recommended to search around for guides to running Apache HTTP
Server and Apache Tomcat using either "mod_proxy" or "mod_jk". DSpace does not require any
unique configurations with regards to this redirection from Apache to Tomcat. So, any guides that
generally explain how to redirect requests from Apache to Tomcat should also work for DSpace.
2.5.4 The Handle Server
First a few facts to clear up some common misconceptions:
You don't have to use CNRI's Handle system. At the moment, you need to change the code a little to use
something else (e.g PURLs) but that should change soon.
You'll notice that while you've been playing around with a test server, DSpace has apparently been
creating handles for you looking like hdl:123456789/24 and so forth. These aren't really Handles, since
the global Handle system doesn't actually know about them, and lots of other DSpace test installs will
have created the same IDs. They're only really Handles once you've registered a prefix with CNRI (see
below) and have correctly set up the Handle server included in the DSpace distribution. This Handle
server communicates with the rest of the global Handle infrastructure so that anyone that understands
Handles can find the Handles your DSpace has created.
If you want to use the Handle system, you'll need to set up a Handle server. One is included with
DSpace. Note that this is not required in order to evaluate DSpace; you only need one if you are running
a production service. You'll need to obtain a Handle prefix from the central CNRI Handle site.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 64 of 901
DSpace 6.x Documentation
A Handle server runs as a separate process that receives TCP requests from other Handle servers, and issues
resolution requests to a global server or servers if a Handle entered locally does not correspond to some local
content. The Handle protocol is based on TCP, so it will need to be installed on a server that can send and
receive TCP on port 2641.
You can either use a Handle server running on the same machine as DSpace, or you can install it on a
separate machine. Installing it on the same machine is a little bit easier. If you install it on a separate machine,
you can use one Handle server for more than one DSpace installation.
To install your Handle resolver on the host where DSpace runs:
1. To configure your DSpace installation to run the handle server, run the following command:
[dspace]/bin/dspace make-handle-config [dspace]/handle-server
Ensure that [dspace]/handle-server matches whatever you have in dspace.cfg for the handle.dir property.
a. If you are using Windows, the proper command is:
[dspace]/bin/dspace dsrun net.handle.server.SimpleSetup [dspace]/handle-server
Ensure that [dspace]/handle-server matches whatever you have in dspace.cfg for the handle.dir
property.
2. Edit the resulting [dspace]/handle-server/config.dct file to include the following lines in the "server_config"
clause:
"storage_type" = "CUSTOM"
"storage_class" = "org.dspace.handle.HandlePlugin"
This tells the Handle server to get information about individual Handles from the DSpace code.
3. Once the configuration file has been generated, you will need to go to http://hdl.handle.net/4263537/5014
to upload the generated sitebndl.zip file. The upload page will ask you for your contact information. An
administrator will then create the naming authority/prefix on the root service (known as the Global Handle
Registry), and notify you when this has been completed. You will not be able to continue the handle
server installation until you receive further information concerning your naming authority.
4. When CNRI has sent you your naming authority prefix, you will need to edit the config.dct file. The file
will be found in /[dspace]/handle-server. Look for "300:0.NA/YOUR_NAMING_AUTHORITY". Replace
YOUR_NAMING_AUTHORITY with the assigned naming authority prefix sent to you.
5. Now start your handle server (as the dspace user):
[dspace]/bin/start-handle-server
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 65 of 901
5.
DSpace 6.x Documentation
a. If you are using Windows, there is a corresponding 'start-handle-server.bat' script:
[dspace]/bin/start-handle-server.bat
Note that since the DSpace code manages individual Handles, administrative operations such as Handle
creation and modification aren't supported by DSpace's Handle server.
To install a Handle resolver on a separate machine:
The Handle server you use must be dedicated to resolve Handles from DSpace. You cannot use a Handle
server that is in use with other software already. You can use CNRI's Handle Software -- all you have to do is to
add to it a plugin that is provided by DSpace. The following instructions were tested with CNRI's Handle
software version 7.3.1. You can do the following steps on another machine than the machine DSpace runs on,
but you have to copy some files from the machine on which DSpace is installed.
1. Download the CNRI Handle Software: http://www.handle.net/download.html. In the tarball you'll find an
INSTALL.txt with installation instructions -- follow it.
2. After installing the CNRI Handle Software you should have two directories: once that contains the CNRI
software and one that contains the configuration of you local Handle Server. For the rest of this
instruction we assume that the directory containing the CNRI Software is /hs/hsj-7.3.1 and the
directory containing the configuration of your local server is /hs/srv_1. (We use the same paths here
as CNRIs INSTALL.txt.)
3. Download the plugin from https://github.com/DSpace/Remote-Handle-Resolver/releases. Select a
release. You can get the source and build it yourself, or just use the JAR file included in the release. In
either case, once you have a dspace-remote-handle-resolver-VERSION.jar, copy it to the
directory containing the CNRI software (/hs/hsj-7.3.1/lib).
4. Create the directory /hs/srv_1/logs.
5. Create the following two files in /hs/srv_1.log4j-handle-plugin.properties
log4j.rootCategory=INFO, A1log4j.appender.A1=org.apache.log4j.
DailyRollingFileAppenderlog4j.appender.A1.File=/hs/srv_1/logs/handle-plugin.
loglog4j.appender.A1.DatePattern='.'yyyy-MM-ddlog4j.appender.A1.layout=org.
apache.log4j.PatternLayoutlog4j.appender.A1.layout.ConversionPattern=%d %-5
p %c @ %m%nlog4j.logger.org.apache.axis.handlers.http.HTTPAuthHandler=INFO
Change the path in the third line, if necessary.handle-dspace-plugin.cfg
dspace.handle.endpoint1 = http://example.org/dspace/handleresolver
If you are using XMLUI take a look in [dspace-install]/config/dspace.cfg, change the URL
above to the value of your dspace.url and add /handleresolver to the end of it. If you are using
JSPUI take a look in [dspace-install]/config/dspace.cfg, change the URL above to the value
of your dspace.url and add /json/hdlresolver to the end of it. If you run more than one DSpace
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 66 of 901
DSpace 6.x Documentation
Installation, you may add more DSpace Endpoints. Just increase the number at the end of the key for
each: endpoint2, endpoint3....
6. Edit the file /hs/srv_1/config.dct to include the following lines in the "server_config" clause:
"storage_type" = "CUSTOM""storage_class" = "org.dspace.handle.
MultiRemoteDSpaceRepositoryHandlePlugin"
7. Copy /hs/hsj-7.3.1/bin/hdl-server to /hs/srv_1/start-hdl-server.
8. Edit /hs/srv_1/start-hdl-server:
a. Find the last line that begins with HDLHOME=
b. Below that line add the following one: HDLHOME="/hs/hsj-7.3.1/"
c. Find a line that contains exec java ... net.handle.server.Main ...
d. Add "-Dlog4j.configuration=file:///hs/srv_1/log4j-handle-plugin.
properties -Ddspace.handle.plugin.configuration=/hs/srv_1/handle-dspaceplugin.cfg" right in front of net.handle.server.Main.
9. If your handle server is running, stop it.
10. From now on you should start this handle server using /hs/srv_1/start-hdl-server
Please note: The Handle Server will only start if it is able to connect to at least one running DSpace
Installation. It only resolves the handles of the DSpace Installations that were running when it was started.
Updating Existing Handle Prefixes
If you need to update the handle prefix on items created before the CNRI registration process you can run the
[dspace]/bin/dspace update-handle-prefix script. You may need to do this if you loaded items prior to CNRI
registration (e.g. setting up a demonstration system prior to migrating it to production). The script takes the
current and new prefix as parameters. For example:
[dspace]/bin/dspace update-handle-prefix 123456789 1303
This script will change any handles currently assigned prefix 123456789 to prefix 1303, so for example handle
123456789/23 will be updated to 1303/23 in the database.
2.5.5 Google and HTML sitemaps
To aid web crawlers index the content within your repository, you can make use of sitemaps. There are
currently two forms of sitemaps included in DSpace: Google sitemaps and HTML sitemaps.
Sitemaps allow DSpace to expose its content without the crawlers having to index every page. HTML sitemaps
provide a list of all items, collections and communities in HTML format, whilst Google sitemaps provide the
same information in gzipped XML format.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 67 of 901
DSpace 6.x Documentation
To generate the sitemaps, you need to run [dspace]/bin/dspace generate-sitemaps This creates the sitemaps in
[dspace]/sitemaps/
The sitemaps can be accessed from the following URLs (DSpace demo site is provided as example):
http://demo.dspace.org/xmlui/sitemap - Index sitemap
http://demo.dspace.org/xmlui/sitemap?map=0 - First list of items (up to 50,000)
http://demo.dspace.org/xmlui/sitemap?map=n - Subsequent lists of items (e.g. 50,0001 to 100,000) etc...
HTML sitemaps follow the same procedure:
http://demo.dspace.org/xmlui/htmlmap - Index HTML based sitemap
etc...
When running [dspace]/bin/dspace generate-sitemaps the script informs Google that the sitemaps have been
updated. For this update to register correctly, you must first register your Google sitemap index page ( /dspace
/sitemap) with Google at http://www.google.com/webmasters/sitemaps/. If your DSpace server requires the use
of a HTTP proxy to connect to the Internet, ensure that you have set http.proxy.host and http.proxy.port in
[dspace]/config/dspace.cfg
The URL for pinging Google, and in future, other search engines, is configured in [dspace]/config/dspace.cfg
using the sitemap.engineurls setting where you can provide a comma-separated list of URLs to 'ping'.
You can generate the sitemaps automatically every day using an additional cron job:
# Generate sitemaps at 6:00 am local time each day
0 6 * * * [dspace]/bin/dspace generate-sitemaps
More information on why we highly recommend enabling sitemaps can be found at Search Engine
Optimization (SEO).
2.5.6 Statistics
DSpace uses the Apache Solr application underlaying the statistics. There is no need to download any separate
software. All the necessary software is included. To understand all of the configuration property keys, the user
should refer to DSpace Statistic Configuration for detailed information.
2.6 Windows Installation
Essentially installing on Windows is the same as installing on Unix so please refer back to the main Installation
Instructions section.
Download the DSpace source from SourceForge and unzip it (WinZip will do this)
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 68 of 901
DSpace 6.x Documentation
If you install PostgreSQL, it's recommended to select to install the pgAdmin III tool. It provides a nice
User Interface for interacting with PostgreSQL databases.
For all path separators use forward slashes (e.g. "/"). For example: "C:/dspace" is a valid Windows path.
But, be warned that "C:\dspace" IS INVALID and will cause errors.
2.7 Checking Your Installation
The administrator needs to check the installation to make sure all components are working. Here is list of
checks to be performed. In brackets after each item, it the associated component or components that might be
the issue needing resolution.
System is up and running. User can see the DSpace home page. [Tomcat/Jetty, firewall, IP assignment,
DNS]
Database is running and working correctly. Attempt to create a user, community or collection.
[PostgreSQL, Oracle] Run the database connection testing command to see if other issues are being
reported: [dspace]/bin/dspace database test
Email subsystem is running. The user can issue this command to test the email system: [dspace]/bin
/dspace test-email It attempts to send a test email to the email address that is set in dspace.cfg (mail.
admin). If it fails, you will get messages informing you as to why, referring you to the DSpace
documentation.
2.8 Known Bugs
In any software project of the scale of DSpace, there will be bugs. Sometimes, a stable version of DSpace
includes known bugs. We do not always wait until every known bug is fixed before a release. If the software is
sufficiently stable and an improvement on the previous release, and the bugs are minor and have known
workarounds, we release it to enable the community to take advantage of those improvements.
The known bugs in a release are documented in the KNOWN_BUGS file in the source package.
Please see the DSpace bug tracker for further information on current bugs, and to find out if the bug has
subsequently been fixed. This is also where you can report any further bugs you find.
2.9 Common Problems
In an ideal world everyone would follow the above steps and have a fully functioning DSpace. Of course, in the
real world it doesn't always seem to work out that way. This section lists common problems that people
encounter when installing DSpace, and likely causes and fixes. This is likely to grow over time as we learn
about users' experiences.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 69 of 901
DSpace 6.x Documentation
2.9.1 Common Installation Issues
Database errors occur when you run ant fresh_install: There are two common errors that
occur.
If your error looks like this:
[java] 2004-03-25 15:17:07,730 INFO
org.dspace.storage.rdbms.InitializeDatabase @ Initializing Database
[java] 2004-03-25 15:17:08,816 FATAL
org.dspace.storage.rdbms.InitializeDatabase @ Caught exception:
[java] org.postgresql.util.PSQLException: Connection refused. Check
that the hostname and port are correct and that the postmaster is
accepting TCP/IP connections.
[java]
at
org.postgresql.jdbc1.AbstractJdbc1Connection.openConnection(AbstractJd
bc1Connection.java:204)
[java]
at org.postgresql.Driver.connect(Driver.java:139)
it usually means you haven't yet added the relevant configuration parameter to your PostgreSQL
configuration (see above), or perhaps you haven't restarted PostgreSQL after making the change.
Also, make sure that the db.username and db.password properties are correctly set in [dspace]
/config/dspace.cfg. An easy way to check that your DB is working OK over TCP/IP is to try this on
the command line:
psql -U dspace -W -h localhost
Enter the dspace database password, and you should be dropped into the psql tool with a
dspace=> prompt.
Another common error looks like this:
[java] 2004-03-25 16:37:16,757 INFO
org.dspace.storage.rdbms.InitializeDatabase @ Initializing Database
[java] 2004-03-25 16:37:17,139 WARN
org.dspace.storage.rdbms.DatabaseManager @ Exception initializing DB
pool
[java] java.lang.ClassNotFoundException: org.postgresql.Driver
[java]
at java.net.URLClassLoader$1.run(URLClassLoader.java:198)
[java]
at java.security.AccessController.doPrivileged(Native
Method)
[java]
at
java.net.URLClassLoader.findClass(URLClassLoader.java:186)
This means that the PostgreSQL JDBC driver is not present in [dspace]/lib. See above.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 70 of 901
DSpace 6.x Documentation
GeoLiteCity Database file fails to download or install, when you run ant fresh_install: There
are two common errors that may occur:
If your error looks like this:
[get] Error getting http://geolite.maxmind.com/download/geoip/database/GeoLiteCity.dat.
gz to /usr/local/dspace/config/GeoLiteCity.dat.gz
BUILD FAILED
/dspace-release/dspace/target/dspace-installer/build.xml:931: java.net.
ConnectException: Connection timed out
it means that you likely either (a) don't have an internet connection to download the necessary
GeoLite Database file (used for DSpace Statistics), or (b) the GeoLite Database file's URL is no
longer valid.
Another common message looks like this:
[echo] WARNING : FAILED TO DOWNLOAD GEOLITE DATABASE FILE
[echo]
(Used for DSpace Solr Usage Statistics)
Again, this means the GeoLite Database file cannot be downloaded or is unavailable for some
reason. You should be able to resolve this issue by following the "Manually Installing/Updating
GeoLite Database File" instructions.
2.9.2 General DSpace Issues
Tomcat doesn't shut down: If you're trying to tweak Tomcat's configuration but nothing seems to make
a difference to the error you're seeing, you might find that Tomcat hasn't been shutting down properly,
perhaps because it's waiting for a stale connection to close gracefully which won't happen.
To see if this is the case, try running: ps -ef | grep java and look for Tomcat's Java
processes. If they stay around after running Tomcat's shutdown.sh script, trying running kill on
them (or kill -9 if necessary), then starting Tomcat again.
Database connections don't work, or accessing DSpace takes forever: If you find that when you try
to access a DSpace Web page and your browser sits there connecting, or if the database connections
fail, you might find that a 'zombie' database connection is hanging around preventing normal operation.
To see if this is the case, try running: ps -ef | grep postgres
You might see some processes like this:
dspace 16325 1997 0
idle in transaction
13-Jul-2017
Feb 14
?
0:00 postgres: dspace dspace
https://wiki.duraspace.org/display/DSDOC6x
127.0.0.1
Page 71 of 901
DSpace 6.x Documentation
This is normal. DSpace maintains a 'pool' of open database connections, which are re-used to
avoid the overhead of constantly opening and closing connections. If they're 'idle' it's OK; they're
waiting to be used.
However sometimes, if something went wrong, they might be stuck in the middle of a query, which
seems to prevent other connections from operating, e.g.:
dspace 16325
SELECT
1997
0
Feb 14
?
0:00 postgres: dspace dspace
127.0.0.1
This means the connection is in the middle of a SELECT operation, and if you're not using
DSpace right that instant, it's probably a 'zombie' connection. If this is the case, try running kill
on the process, and stopping and restarting Tomcat.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 72 of 901
DSpace 6.x Documentation
3 Upgrading DSpace
These instructions are valid for any of the following upgrade paths:
Upgrading ANY prior version (1.x.x, 3.x, 4.x or 5.x) of DSpace to DSpace 6.x (latest version)
For more information about new features or major changes in previous releases of DSpace, please
refer to following:
Releases - Provides links to release notes for all prior releases of DSpace
Version History - Provides detailed listing of all changes in all prior releases of DSpace
Upgrading database structure/data is now automated!
The underlying DSpace database structure changes and data migrations are now AUTOMATED
(using FlywayDB). This means that you no longer need to manually run SQL scripts. Instead, the first
time you run DSpace, it will auto-update your database structure (as needed) and migrate all your
data to be compatible with the installed version of DSpace. This allows you to concentrate your
upgrade efforts on customizing your site without having to worry about migrating your data!
For example, if you were running DSpace 1.4, and you wish to upgrade to DSpace 5, you can follow
the simplified instructions below. As soon as you point your DSpace 5 installation against the older
DSpace 1.4-compatible database, your database tables (and data) will automatically be migrated to be
compatible with DSpace 5.
See below for a specific note on troubleshooting "ignored" migrations (a rare circumstance, but known
to happen if you upgrade from DSpace 5 to a later version of DSpace).
Discovery re-index
The FlywayDB migration will trigger a re-index of your Discovery search index after deployment. Some
repository content will be not be discover-able until this process is complete. For large repository
instances, this process could take some time to complete.
Please refrain for customizing the DSpace database tables. It will complicate your next
upgrade!
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 73 of 901
DSpace 6.x Documentation
With the addition of our automated database upgrades, we highly recommend AGAINST customizing
the DSpace database tables/structure or backporting any features that change the DSpace tables
/structure. Doing so will often cause the automated database upgrade process to fail (and therefore
will complicate your next upgrade).
If you must add features requiring new database tables/structure, we recommend creating new tables
(instead of modifying existing ones), as that is usually much less disruptive to our automated database
upgrade.
Test Your Upgrade Process
In order to minimize downtime, it is always recommended to first perform a DSpace upgrade using a
Development or Test server. You should note any problems you may have encountered (and also how
to resolve them) before attempting to upgrade your Production server. It also gives you a chance to
"practice" at the upgrade. Practice makes perfect, and minimizes problems and downtime.
Additionally, if you are using a version control system, such as subversion or git, to manage your
locally developed features or modifications, then you can do all of your upgrades in your local version
control system on your Development server and commit the changes. That way your Production
server can just checkout your well tested and upgraded code.
In the notes below [dspace] refers to the install directory for your existing DSpace installation, and
[dspace-source] to the source directory for DSpace 5.x. Whenever you see these path references,
be sure to replace them with the actual path names on your local system.
Release Notes / Significant Changes
Backup your DSpace
Update Prerequisite Software (as necessary)
Upgrade Steps
Troubleshooting Upgrade Issues
"Ignored" Flyway Migrations
Manually Upgrading Solr Indexes
3.1 Release Notes / Significant Changes
DSpace 6.0 features some significant changes which you may wish to be aware of before beginning your
upgrade:
The build.properties configuration file has been replaced by an enhanced local.cfg
configuration file. The new local.cfg allows you to easily override any configuration (from dspace.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 74 of 901
DSpace 6.x Documentation
cfg or modules/*.cfg files) by simply copying it into your local.cfg and specifying a new value. It
also provides enhanced configuration options as detailed in the Configuration Reference documentation.
The old build.properties file is no longer used nor supported.
WARNING: As part of adding this new configuration scheme, many of the configuration settings in
DSpace (primarily those in modules/*.cfg files) had to be renamed or prepended with the
name of the module. This means that 5.x (or below) configurations are no longer guaranteed to be
compatible with 6.x. If possible, we recommend starting with fresh configs (see below), and
moving all your locally customized settings into the new local.cfg file.
WARNING: Users of Curation Tasks should note that changes to the DSpace configuration
support have significantly changed the way that Task Properties work. Please see Curation
System for details.
The PDF Citation Cover Page configuration file has been renamed (from disseminate-citation.
cfg to citation-page.cfg). See this features documentation for more details.
The legacy search engine (based on Apache Lucene) and legacy Browse system (based on
database tables) have been removed from DSpace 6.0 or above. Instead, DSpace now only uses
Discovery (based on Apache Solr) for all Search/Browse capabilities.
The DSpace Lightweight Networking Interface (LNI), supporting WebDAV / SOAP / RPC API, has
been removed from DSpace 6.0 or above. We recommend using REST or SWORD (v1 or v2) as a
replacement. However, if you still require it, the old (unmaintained) LNI codebase is still available at
https://github.com/DSpace/dspace-lni
Support for SRB (Storage Resource Broker) file storage has been removed from DSpace 6.0 or
above. As it was unmaintained (and seemingly unused) for many years, this feature was removed along
with its configurations. As a replacement, a new file storage plugin system was added, featuring a
traditional local file storage option (default) and an Amazon S3 file storage option (see Storage Layer
documentation, especially Configuring the Bitstream Store). For more information on the removal of SRB
support, also see DS-3055.
The user groups Administrator and Anonymous cannot be renamed or deleted. If you had renamed
them, they will be renamed back to the stock names during the upgrade. DSpace is now dependent on
these specific names due to internal changes.
XPDF PDF Thumbnail generation has been removed. Please use the ImageMagick or PDFBox
thumbnail generators instead.
The default strategy to create new handles for versioned Items has changed. If you have Item Level
Versioning enabled and you have versioned Items in your DSpace installation, you may want to change
the configuration to continue using the mechanism to create handles as it was in DSpace 4 and 5. You
can find more informations here: Item Level Versioning#IdentifierServiceOverride.
Elasticsearch Usage Statistics feature is deprecated in the 6.0 release. While they still function, and
you can continue to use them, in a future DSpace release they will be removed. If you are looking for a
usage statistics option, we recommend instead using the default SOLR Statistics engine and/or
DSpace's integration with Google Analytics. See DS-2897 for more information.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 75 of 901
DSpace 6.x Documentation
3.2 Backup your DSpace
Before you start your upgrade, it is strongly recommended that you create a backup of your DSpace instance.
Backups are easy to recover from; a botched install/upgrade is very difficult if not impossible to recover from.
The DSpace specific things to backup are: configs, source code modifications, database, and assetstore. On
your server that runs DSpace, you might additionally consider checking on your cron/scheduled tasks, servlet
container, and database.
Make a complete backup of your system, including:
Database: Make a snapshot/dump of the database. For the PostgreSQL database use Postgres'
pg_dump command. For example:
pg_dump -U [database-user] -f [backup-file-location] [database-name]
Assetstore: Backup the directory ([dspace]/assetstore by default, and any other assetstores
configured in the [dspace]/config/dspace.cfg "assetstore.dir" and "assetstore.dir.#" settings)
Configuration: Backup the entire directory content of [dspace]/config.
Customizations: If you have custom code, such as themes, modifications, or custom scripts, you will
want to back them up to a safe location.
Statistics data: what to back up depends on what you were using before: the options are the default
SOLR Statistics, deprecated Elasticsearch Usage Statistics, or the legacy statistics. Legacy stats utilizes
the dspace.log files, Elasticsearch stats stores data in [dspace]/elasticsearch, SOLR Statistics
stores data in [dspace]/solr/statistics. A simple copy of the data directory should give you a
point of recovery, should something go wrong in the update process. We can't stress this enough, your
users depend on these statistics more than you realize. You need a backup.
3.3 Update Prerequisite Software (as necessary)
DSpace 6.x requires the following versions of prerequisite software:
Java 7 or 8 (Oracle or OpenJDK)
Apache Maven 3.0.5 or above
Apache Ant 1.8 or above
Database
PostgreSQL 9.4 or above (with pgcrypto installed), OR
Oracle 10g or above
Tomcat 7 or above
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 76 of 901
DSpace 6.x Documentation
If you're using a theme based on Mirage 2, you will need Maven 3.1 or above. If you are building with mirage2.
deps.included=false (more information at https://github.com/DSpace/DSpace/tree/master/dspace-xmluimirage2) then the following dependencies may need to be updated as well:
node, to version 6 or above
npm, to version 3.10.8 or above
Refer to the Prerequisite Software section of "Installing DSpace" for more details around configuring and
installing these prerequisites.
3.4 Upgrade Steps
1. Ensure your database is compatible: Starting with DSpace 6.x, there are new database requirements
for DSpace (refer to the Prerequisite Software section of "Installing DSpace" for full details).
a. PostgreSQL databases: PostgreSQL 9.4 or above is required and the "pgcrypto" extension must
be installed.
i. Notes on installing pgcrypto
1. On most Linux operating systems (Ubuntu, Debian, RedHat), this extension is
provided in the "postgresql-contrib" package in your package manager. So, ensure
you've installed "postgresql-contrib".
2. On Windows, this extension should be provided automatically by the installer (check
your "[PostgreSQL]/share/extension" folder for files starting with "pgcrypto")
ii. Enabling pgcrypto on your DSpace database. (Additional options/notes in the Installation
Documentation)
# Login to your "dspace" database as a superuser
psql --username=postgres dspace
# Enable the pgcrypto extension on this database
CREATE EXTENSION pgcrypto;
b. Oracle databases: Oracle database have no additional requirements at this time.
2. Download DSpace 6.x: Either download DSpace 6.x from DSpace.org or check it out directly from the
Github repository.
a. NOTE: If you downloaded DSpace do not unpack it on top of your existing installation. Refer to
Installation Instructions, Step 3 for unpacking directives.
3. Merge any User Interface customizations or other customizations (if needed or desired). If you
have made any local customizations to your DSpace installation they may need to be migrated over to
the new DSpace.
a. NOTE: If you are upgrading across many versions of DSpace at once (e.g. from 1.x.x to 6.x), you
may find it easier to first upgrade DSpace, and then attempt to migrate over your various
customizations. Because each major version of DSpace tends to add new configurations and
features to the User Interface, older customizations may require more work to "migrate" to the
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 77 of 901
a.
DSpace 6.x Documentation
latest version of DSpace. In some situations, it may even be easier to "start fresh", and just recustomize the brand new User Interface with your local color scheme, header/footer, etc.
b. Customizations are typically housed in one of the following places:
i. JSPUI modifications: [dspace-source]/dspace/modules/jspui/src/main
/webapp/
ii. XMLUI modifications: [dspace-source]/dspace/modules/xmlui/src/main
/webapp/
iii. Config modifications: [dspace]/config
c. For highly customized DSpace instances, note that the format of the following configuration files
has changed. If you have customized these configuration files, carefully re-integrate your custom
settings.
i. dspace/config/dspace.cfg
Note the separator needed between element names: https://github.com/DSpace
/DSpace/blob/dspace-6.0-rc3/dspace/config/dspace.cfg#L1020
ii. dspace/config/spring/api/discovery.xml
The following property has been removed
section of src/dspace/config
/xmlui.xconf , replacing the currently active theme:
which acts as a proxy to your Tomcat (or other servlet
container) running DSpace. More information on Apache VirtualHost settings can be found at: https://httpd.
apache.org/docs/2.2/vhosts/
#### SAMPLE MOD_SHIB CONFIGURATION FOR APACHE2 (it may require local modifications based on your
Apache setup) ####
# While this sample VirtualHost is for HTTPS requests (recommended for Shibboleth, obviously),
# you may also need/want to create one for HTTP (*:80)
...
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 92 of 901
DSpace 6.x Documentation
# PLEASE NOTE: We have omitted many Apache settings (ServerName, LogLevel, SSLCertificateFile,
etc)
# which you may need/want to add to your VirtualHost
# As long as Shibboleth module is installed, enable all Shibboleth/mod_shib related settings
# Shibboleth recommends turning on UseCanonicalName
# See "Prepping Apache" in https://wiki.shibboleth.net/confluence/display/SHIB2
/NativeSPApacheConfig
UseCanonicalName On
# Most DSpace instances will want to use Shibboleth "Lazy Session", which ensures that
users
# can access DSpace without first authenticating via Shibboleth.
# This section turns on Shibboleth "Lazy Session". Also ensures that once they have
authenticated
# (by accessing /Shibboleth.sso/Login path), then their Shib session is kept alive
setting for your
# DSpace Service Provider, then you may need to tell Apache which "id" to redirect Shib
requests to.
# Just uncomment this and change the value "my-dspace-id" to the associated @id attribute
value.
#ShibRequestSetting applicationId my-dspace-id
# If a user attempts to access the DSpace shibboleth login page, force them to authenticate
via Shib
AuthType shibboleth
ShibRequireSession On
# Please note that setting ShibUseHeaders to "On" is a potential security risk.
# You may wish to set it to "Off". See the mod_shib docs for details about this setting:
# https://wiki.shibboleth.net/confluence/display/SHIB2
/NativeSPApacheConfig#NativeSPApacheConfig-AuthConfigOptions
# Here's a good guide to configuring Apache + Tomcat when this setting is "Off":
# https://www.switch.ch/de/aai/support/serviceproviders/sp-access-rules.
html#javaapplications
ShibUseHeaders On
require valid-user
# Ensure /Shibboleth.sso path (in Apache) can be accessed
# By default it may be inaccessible if your Apache security is tight.
Order deny,allow
Allow from all
# Also ensure Shibboleth/mod_shib responds to this path
SetHandler shib
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 93 of 901
DSpace 6.x Documentation
# Finally, you may need to ensure requests
# to Tomcat (as they need to be handled by
# NOTE: THIS SETTING IS LIKELY ONLY NEEDED
# ALL REQUESTS TO TOMCAT (e.g. ProxyPass /
# ProxyPass /Shibboleth.sso !
to /Shibboleth.sso are NOT redirected
mod_shib instead).
IF YOU ARE USING mod_proxy TO REDIRECT
ajp://localhost:8009/)
...
Sample shibboleth2.xml Configuration
In addition, here's a sample "ApplicationOverride" configuration for "shibboleth2.xml". This particular
"ApplicationOverride" is configured to use the Test IdP provided by http://www.testshib.org/ and is just meant as
an example. In order to enable it for testing purposes, you must specify ShibRequestSetting
applicationId testshib in your Apach mod_shib configuration (see above).
-->
SAML2 SAML1
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 94 of 901
DSpace 6.x Documentation
DSpace Shibboleth Configuration Options
Authentication Methods:
DSpace supports authentication using NetID, or email address. A user's NetID is a unique identifier from the
IdP that identifies a particular user. The NetID can be of almost any form such as a unique integer, string, or
with Shibboleth 2.0 you can use "targeted ids". You will need to coordinate with your shibboleth federation or
identity provider. There are three ways to supply identity information to DSpace:
1) NetID from Shibboleth Header (best)
The NetID-based method is superior because users may change their email address with the identity provider.
When this happens DSpace will not be able to associate their new address with their old account.
2) Email address from Shibboleth Header (okay)
In the case where a NetID header is not available or not found DSpace will fall back to identifying a user basedupon their email address.
3) Tomcat's Remote User (worst)
In the event that neither Shibboleth headers are found then as a last resort DSpace will look at Tomcat's remote
user field. This is the least attractive option because Tomcat has no way to supply additional attributes about a
user. Because of this the autoregister option is not supported if this method is used.
Identity Scheme Migration Strategies:
If you are currently using Email based authentication (either 1 or 2) and want to upgrade to NetID based
authentication then there is an easy path. Simply enable shibboleth to pass the NetID attribute and set the netidheader below to the correct value. When a user attempts to log in to DSpace first DSpace will look for an
EPerson with the passed NetID, however when this fails DSpace will fall back to email based authentication.
Then DSpace will update the user's EPerson account record to set their netted so all future authentications for
this user will be based upon netted. One thing to note is that DSpace will prevent an account from switching
NetIDs. If an account all ready has a NetID set and then they try and authenticate with a different NetID the
authentication will fail.
EPerson Metadata:
One of the primary benefits of using Shibboleth based authentication is receiving additional attributes about
users such as their names, telephone numbers, and possibly their academic department or graduation
semester if desired. DSpace treats the first and last name attributes differently because they (along with email
address) are the three pieces of minimal information required to create a new user account. For both first and
last name supply direct mappings to the Shibboleth headers. In additional to the first and last name DSpace
supports other metadata fields such as phone, or really anything you want to store on an eperson object.
Beyond the phone field, which is accessible in the user's profile screen, none of these additional metadata fields
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 95 of 901
DSpace 6.x Documentation
will be used by DSpace out-of-the box. However if you develop any local modification you may access these
attributes from the EPerson object. The Vireo ETD workflow system utilizes this to aid students when submitting
an ETD.
Role-based Groups:
DSpace is able to place users into pre-defined groups based upon values received from Shibboleth. Using this
option you can place all faculty members into a DSpace group when the correct affiliation's attribute is provided.
When DSpace does this they are considered 'special groups', these are really groups but the user's
membership within these groups is not recorded in the database. Each time a user authenticates they are
automatically placed within the pre-defined DSpace group, so if the user loses their affiliation then the next time
they login they will no longer be in the group.
Depending upon the shibboleth attributed use in the role-header it may be scoped. Scoped is shibboleth
terminology for identifying where an attribute originated from. For example a students affiliation may be
encoded as "student@tamu.edu". The part after the @ sign is the scope, and the preceding value is the value.
You may use the whole value or only the value or scope. Using this you could generate a role for students and
one institution different than students at another institution. Or if you turn on ignore-scope you could ignore the
institution and place all students into one group.
The values extracted (a user may have multiple roles) will be used to look up which groups to place the user
into. The groups are defined as "role." which is a comma separated list of DSpace groups.
Configuration
[dspace]/config/modules/authentication-shibboleth.cfg
File:
Property:
authentication-shibboleth.lazysession
Example
authentication-shibboleth.lazysession = true
Value:
Informational
Whether to use lazy sessions or active sessions. For more DSpace instances, you will likely
Note:
want to use lazy sessions. Active sessions will force every user to authenticate via
Shibboleth before they can access your DSpace (essentially resulting in a "dark archive").
Property:
authentication-shibboleth.lazysession.loginurl
Example
authentication-shibboleth.lazysession.loginurl = /Shibboleth.sso/Login
Value:
Informational
The url to start a shibboleth session (only for lazy sessions). Generally this setting will be "
Note:
/Shibboleth.sso/Login"
Property:
authentication-shibboleth.lazysession.secure
authentication-shibboleth.lazysession.secure = true
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 96 of 901
DSpace 6.x Documentation
Configuration
[dspace]/config/modules/authentication-shibboleth.cfg
File:
Example
Value:
Informational
Force HTTPS when authenticating (only for lazy sessions). Generally this is recommended
Note:
to be "true".
Property:
authentication-shibboleth.netid-header
Example
authentication-shibboleth.netid-header = SHIB-NETID
Value:
Informational
The HTTP header where shibboleth will supply a user's NetID. This HTTP header should be
Note:
specified as an Attribute within your Shibboleth "attribute-map.xml" configuration file.
Property:
authentication-shibboleth.email-header
Example
authentication-shibboleth.email-header = SHIB-MAIL
Value:
Informational
The HTTP header where the shibboleth will supply a user's email address. This HTTP
Note:
header should be specified as an Attribute within your Shibboleth "attribute-map.xml"
configuration file.
Property:
authentication-shibboleth.email-use-tomcat-remote-user
Example
authentication-shibboleth.email-use-tomcat-remote-user = false
Value:
Informational
Used when a netid or email headers are not available should Shibboleth authentication fall
Note:
back to using Tomcat's remote user feature? Generally this is not recommended. See the
"Authentication Methods" section above.
Property:
authentication-shibboleth.reconvert.attributes
Example
authentication-shibboleth.reconvert.attributes = false
Value
Informational
Shibboleth attributes are by default UTF-8 encoded. Some servlet container automatically
Note:
converts the attributes from ISO-8859-1 (latin-1) to UTF-8. As the attributes already were
UTF-8 encoded it may be necessary to reconvert them. If you set this property true, DSpace
converts all shibboleth attributes retrieved from the servlet container from UTF-8 to ISO8859-1 and uses the result as if it were UTF-8. This procedure restores the shibboleth
attributes if the servlet container wrongly converted them from ISO-8859-1 to UTF-8. Set
this true, if you notice character encoding problems within shibboleth attributes.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 97 of 901
DSpace 6.x Documentation
Configuration
[dspace]/config/modules/authentication-shibboleth.cfg
File:
Property:
authentication-shibboleth.autoregister
Example
authentication-shibboleth.autoregister = true
Value:
Informational
Should we allow new users to be registered automatically?
Note:
Property:
authentication-shibboleth.sword.compatibility
Example
authentication-shibboleth.sword.compatibility = false
Value:
Informational
SWORD compatibility will allow this authentication method to work when using SWORD.
Note:
SWORD relies on username and password based authentication and is entirely incapable of
supporting shibboleth. This option allows you to authenticate username and passwords for
SWORD sessions with out adding another authentication method onto the stack. You will
need to ensure that a user has a password. One way to do that is to create the user via the
create-administrator command line command and then edit their permissions.
WARNING: If you enable this option while ALSO having "PasswordAuthentication" enabled,
then you should ensure that "PasswordAuthentication" is listed prior to "ShibAuthentication"
in your authentication.cfg file. Otherwise, ShibAuthentication will be used to authenticate all
of your users INSTEAD OF PasswordAuthentication.
Property:
authentication-shibboleth.firstname-header
Example
authentication-shibboleth.firstname-header = SHIB_GIVENNAME
Value:
Informational
The HTTP header where the shibboleth will supply a user's given name. This HTTP header
Note:
should be specified as an Attribute within your Shibboleth "attribute-map.xml" configuration
file.
Property:
authentication-shibboleth.lastname-header
Example
authentication-shibboleth.lastname-header = SHIB_SN
Value:
Informational
The HTTP header where the shibboleth will supply a user's surname. This HTTP header
Note:
should be specified as an Attribute within your Shibboleth "attribute-map.xml" configuration
file.
Property:
13-Jul-2017
authentication-shibboleth.eperson.metadata
https://wiki.duraspace.org/display/DSDOC6x
Page 98 of 901
DSpace 6.x Documentation
Configuration
[dspace]/config/modules/authentication-shibboleth.cfg
File:
Example
Value:
authentication-shibboleth.eperson.metadata = \
SHIB-telephone => phone, \
SHIB-cn => cn
Informational
Additional user attributes mapping, multiple attributes may be stored for each user. The left
Note:
side is the Shibboleth-based metadata Header and the right side is the eperson metadata
field to map the attribute to.
Property:
authentication-shibboleth.eperson.metadata.autocreate
Example
authentication-shibboleth.eperson.metadata.autocreate = true
Value:
Informational
If the eperson metadata field is not found, should it be automatically created?
Note:
Property:
authentication-shibboleth.role-header
Example
authentication-shibboleth.role-header = SHIB_SCOPED_AFFILIATION
Value:
Informational
The shibboleth header to do role-based mappings (see section on roll based mapping
Note:
section above)
Property:
authentication-shibboleth.role-header.ignore-scope
Example
authentication-shibboleth.role-header.ignore-scope = true
Value:
Informational
Weather to ignore the attribute's scope (everything after the @ sign for scoped attributes)
Note:
Property:
authentication-shibboleth.role-header.ignore-value
Example
authentication-shibboleth.role-header.ignore-value = false
Value:
Informational
Weather to ignore the attribute's value (everything before the @ sign for scoped attributes)
Note:
Property:
13-Jul-2017
authentication-shibboleth.role.[affiliation-attribute]
https://wiki.duraspace.org/display/DSDOC6x
Page 99 of 901
DSpace 6.x Documentation
Configuration
[dspace]/config/modules/authentication-shibboleth.cfg
File:
Example
Value:
role.faculty = Faculty, Member \
role.staff = Staff, Member \
role.student = Students, Member
Informational
Mapping of affiliation values to DSpace groups. See the "Role-based Groups" section above
Note:
for more info.
LDAP Authentication
Enabling LDAP Authentication
To enable LDAP Authentication, you must ensure the org.dspace.authenticate.LDAPAuthentication
class is listed as one of the AuthenticationMethods in the following configuration:
Configuration
[dspace]/config/modules/authentication.cfg
File:
Property:
plugin.sequence.org.dspace.authenticate.AuthenticationMethod
Example
Value:
plugin.sequence.org.dspace.authenticate.AuthenticationMethod = org.dspace.
authenticate.LDAPAuthentication
Configuring LDAP Authentication
If LDAP is enabled, then new users will be able to register by entering their username and password without
being sent the registration token. If users do not have a username and password, then they can still register and
login with just their email address the same way they do now.
If you want to give any special privileges to LDAP users, create a stackable authentication method to
automatically put people who have a netid into a special group. You might also want to give certain email
addresses special privileges. Refer to the Custom Authentication Code section below for more information
about how to do this.
Here is an explanation of each of the different LDAP configuration parameters:
Configuration
[dspace]/config/modules/authentication-ldap.cfg
File:
Property:
13-Jul-2017
authentication-ldap.enable
https://wiki.duraspace.org/display/DSDOC6x
Page 100 of 901
DSpace 6.x Documentation
Configuration
[dspace]/config/modules/authentication-ldap.cfg
File:
Example
authentication-ldap.enable = false
Value:
Informational
This setting will enable or disable LDAP authentication in DSpace. With the setting off,
Note:
users will be required to register and login with their email address. With this setting on,
users will be able to login and register with their LDAP user ids and passwords.
Property:
authentication-ldap.autoregister
Example
authentication-ldap.autoregister = true
Value:
Informational
This will turn LDAP autoregistration on or off. With this on, a new EPerson object will be
Note:
created for any user who successfully authenticates against the LDAP server when they first
login. With this setting off, the user must first register to get an EPerson object by entering
their ldap username and password and filling out the forms.
Property:
authentication-ldap.provider_url
Example
authentication-ldap.provider_url = ldap://ldap.myu.edu/o=myu.edu\,
Value:
ou=mydept
Informational
This is the url to your institution's LDAP server. You may or may not need the /o=myu.edu
Note:
part at the end. Your server may also require the ldaps:// protocol. (This field has no default
value)
Property:
authentication-ldap.starttls
Example
authentication-ldap.starttls = false
Value:
Informational
Should we issue StartTLS after establishing TCP connection in order to initiate an encrypted
Note:
connection?
Note: This (TLS) is different from LDAPS:
TLS is a tunnel for plain LDAP and is typically recognized on the same port (standard
LDAP port: 389)
LDAPS is a separate protocol, deprecated in favor of the standard TLS method.
(standard LDAPS port: 636)
Property:
authentication-ldap.id_field
authentication-ldap.id_field = uid
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 101 of 901
DSpace 6.x Documentation
Configuration
[dspace]/config/modules/authentication-ldap.cfg
File:
Example
Value:
Explanation:
This is the unique identifier field in the LDAP directory where the username is stored. (This
field has no default value)
Property:
authentication-ldap.object_context
Example
authentication-ldap.object_context = ou=people\,o=myu.edu
Value:
Informational
This is the LDAP object context to use when authenticating the user. By default, DSpace will
Note:
use this value to create the user's DN in order to attempt to authenticate them. It is
appended to the id_field and username. For example uid=username\,ou=people\,
o=myu.edu. You will need to modify this to match your LDAP configuration. (This field has
no default value)
If your users do NOT all exist under a single "object_context" in LDAP, then you should
ignore this setting and INSTEAD use the Hierarchical LDAP Authentication settings below
(especially see "search.user" or "search.anonymous")
Property:
authentication-ldap.search_context
Example
authentication-ldap.search_context = ou=people
Value:
Informational
This is the search context used when looking up a user's LDAP object to retrieve their data
Note:
for autoregistering. With autoregister=true, when a user authenticates without an
EPerson object we search the LDAP directory to get their name (id_field) and email
address (email_field) so that we can create one for them. So after we have
authenticated against uid=username,ou=people,o=byu.edu we now search in ou=people for
filtering on [uid=username]. Often the search_context is the same as the
object_context parameter. But again this depends on your LDAP server configuration.
(This field has no default value, and it MUST be specified when either search.
anonymous=true or search.user is specified)
Property:
authentication-ldap.email_field
Example
authentication-ldap.email_field = mail
Value:
Informational
This is the LDAP object field where the user's email address is stored. "mail" is the most
Note:
common for LDAP servers. (This field has no default value)
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 102 of 901
DSpace 6.x Documentation
Configuration
[dspace]/config/modules/authentication-ldap.cfg
File:
If the "email_field" is unspecified, or the user has no email address in LDAP, his/her
username (id_field value) will be saved as the email in DSpace (or appended to
netid_email_domain, when specified)
Property:
authentication-ldap.netid_email_domain
Example
authentication-ldap.netid_email_domain = @example.com
Value:
Informational
If your LDAP server does not hold an email address for a user (i.e. no email_field), you
Note:
can use the following field to specify your email domain. This value is appended to the netid
(id_field) in order to make an email address (which is then stored in the DSpace
EPerson). For example, a netid of 'user' and netid_email_domain as @example.com
would set the email of the user to be user@example.com
Please note: this field will only be used if "email_field" is unspecified OR the user in
question has no email address stored in LDAP. If both "email_field" and "
netid_email_domain" are unspecified, then the "id_field" will be used as the email
address.
Property:
authentication-ldap.surname_field
Example
authentication-ldap.surname_field = sn
Value:
Informational
This is the LDAP object field where the user's last name is stored. "sn" is the most common
Note:
for LDAP servers. If the field is not found the field will be left blank in the new eperson
object. (This field has no default value)
Property:
authentication-ldap.givenname_field
Example
authentication-ldap.givenname_field = givenName
Value:
Informational
This is the LDAP object field where the user's given names are stored. I'm not sure how
Note:
common the givenName field is in different LDAP instances. If the field is not found the field
will be left blank in the new eperson object. (This field has no default value)
Property:
authentication-ldap.phone_field
Example
authentication-ldap.phone_field = telephoneNumber
Value:
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 103 of 901
DSpace 6.x Documentation
Configuration
[dspace]/config/modules/authentication-ldap.cfg
File:
Informational
This is the field where the user's phone number is stored in the LDAP directory. If the field is
Note:
not found the field will be left blank in the new eperson object. (This field has no default
value)
Property:
authentication-ldap.login.specialgroup
Example
authentication-ldap.login.specialgroup = group-name
Value:
Informational
If specified, all user sessions successfully logged in via LDAP will automatically become
Note:
members of this DSpace Group (for the remainder of their current, logged in session). This
DSpace Group must already exist (it will not be automatically created).
This is useful if you want a DSpace Group made up of all internal authenticated users. This
DSpace Group can then be used to bestow special permissions on any users who have
authenticated via LDAP (e.g. you could allow anyone authenticated via LDAP to view
special, on campus only collections or similar)
Property:
login.groupmap.*
Example
authentication-ldap.login.groupmap.1 = ou=Students:ALL_STUDENTS
Value:
authentication-ldap.login.groupmap.2 = ou=Employees:ALL_EMPLOYEES
authentication-ldap.login.groupmap.3 = ou=Faculty:ALL_FACULTY
Informational
The left part of the value (before the ":") must correspond to a portion of a user's DN (unless
Note:
"login.group.attribute" is specified..please see below). The right part of the value
corresponds to the name of an existing DSpace group.
For example, if the authenticated user's DN in LDAP is in the following form:
cn=jdoe,OU=Students,OU=Users,dc=example,dc=edu
that user would get assigned to the ALL_STUDENTS DSpace group for the remainder of
their current session.
However, if that same user later graduates and is employed by the university, their DN in
LDAP may change to:
cn=jdoe,OU=Employees,OU=Users,dc=example,dc=edu
Upon logging into DSpace after that DN change, the authenticated user would now be
assigned to the ALL_EMPLOYEES DSpace group for the remainder of their current session.
Note: This option can be used independently from the login.specialgroup option, which will
put all LDAP users into a single DSpace group. Both options may be used together.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 104 of 901
DSpace 6.x Documentation
Configuration
[dspace]/config/modules/authentication-ldap.cfg
File:
Property:
authentication-ldap.login.groupmap.attribute
Example
authentication-ldap.login.groupmap.attribute = group
Value:
Informational
The value of the "login.groupmap.attribute" should specify the name of a single
Note:
LDAP attribute. If this property is uncommented, it changes the meaning of the left part of "
login.groupmap.*" (see above) as follows:
If the authenticated user has this LDAP attribute, look up the value of this LDAP
attribute in the left part (before the ":") of the login.groupmap.* value
If that LDAP value is found in any "login.groupmap.*" field, assign this authenticated
user to the DSpace Group specified by the right part (after the ":") of the login.
groupmap.* value.
For example:
login.groupmap.attribute = group
login.groupmap.1 = mathematics:Mathematics_Group
The above would ensure that any authenticated users where their LDAP "group" attribute
equals "mathematics" would be added to the DSpace Group named "Mathematics_Group"
for the remainder of their current session. However, if that same user logged in later with a
new LDAP "group" value of "computer science", he/she would no longer be a member of the
"Mathematics_Group" in DSpace.
Enabling Hierarchical LDAP Authentication
Please note, that DSpace doesn't contain the LDAPHierarchicalAuthentication class anymore.
This functionality is now supported by LDAPAuthentication, which uses the same configuration
options.
If your users are spread out across a hierarchical tree on your LDAP server, you may wish to have DSpace
search for the user name in your tree. Here's how it works:
1. DSpace gets the user name from the login form
2. DSpace binds to LDAP as an administrative user with right to search in DNs (LDAP may be configured to
allow anonymous users to search)
3. DSpace searches for the user name as within DNs (username is a part of full DN)
4. DSpace binds with the found full DN and password from login form
5.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 105 of 901
DSpace 6.x Documentation
5. DSpace logs user in if LDAP reports successful authentication; refuses login otherwise
Configuring Hierarchical LDAP Authentication
Hierarchical LDAP Authentication shares all the above standard LDAP configurations, but has some additional
settings.
You can optionally specify the search scope. If anonymous access is not enabled on your LDAP server, you will
need to specify the full DN and password of a user that is allowed to bind in order to search for the users.
Configuration
[dspace]/config/modules/authentication-ldap.cfg
File:
Property:
authentication-ldap.search_scope
Example
authentication-ldap.search_scope = 2
Value:
Informational
This is the search scope value for the LDAP search during autoregistering (
Note:
autoregister=true). This will depend on your LDAP server setup, and is only really
necessary if your users are spread out across a hierarchical tree on your LDAP server. This
value must be one of the following integers corresponding to the following values:
object scope : 0
one level scope : 1
subtree scope : 2
Please note that "search_context" in the LDAP configurations must also be specified.
Property:
authentication-ldap.search.anonymous
Example
authentication-ldap.search.anonymous = true
Value:
Informational
If true, DSpace will anonymously search LDAP (in the "search_context") for the DN of
Note:
the user trying to login to DSpace. This setting is "false" by default. By default, DSpace will
either use "search.user" to authenticate for the LDAP search (if search.user is specified),
or will use the "object_context" value to create the user's DN.
Property:
authentication-ldap.search.user
authentication-ldap.search.password
Example
authentication-ldap.search.user = cn=admin\,ou=people\,o=myu.edu
Value:
authentication-ldap.search.password = password
Informational
Note:
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 106 of 901
DSpace 6.x Documentation
Configuration
[dspace]/config/modules/authentication-ldap.cfg
File:
The full DN and password of a user allowed to connect to the LDAP server and search (in
the "search_context") for the DN of the user trying to login. By default, if unspecified,
DSpace will either search LDAP anonymously for the user's DN (when search.
anonymous=true), or will use the "object_context" value to create the user's DN.
IP Authentication
Enabling IP Authentication
To enable IP Authentication, you must ensure the org.dspace.authenticate.IPAuthentication class
is listed as one of the AuthenticationMethods in the following configuration:
Configuration
[dspace]/config/modules/authentication.cfg
File:
Property:
plugin.sequence.org.dspace.authenticate.AuthenticationMethod
Example Value:
plugin.sequence.org.dspace.authenticate.AuthenticationMethod = org.dspace.
authenticate.IPAuthentication
Configuring IP Authentication
Configuration File:
[dspace]/config/modules/authentication-ip.cfg
Once enabled, you are then able to map DSpace groups to IP addresses in authentication-ip.cfg by
setting ip.GROUPNAME = iprange[, iprange ...], e.g:
authentication-ip.MY_UNIVERSITY = 10.1.2.3, \
13.5, \
# Partial IP
11.3.4.5/24, \
# with CIDR
12.7.8.9/255.255.128.0, \
# with netmask
2001:18e8::32
# IPv6 too
# Full IP
Negative matches can be set by prepending the entry with a '-'. For example if you want to include all of a class
B network except for users of a contained class c network, you could use: 111.222,-111.222.333.
Notes:
If the Groupname contains blanks you must escape the spaces, e.g. "Department\ of\ Statistics"
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 107 of 901
DSpace 6.x Documentation
If your DSpace installation is hidden behind a web proxy, remember to set the useProxies
configuration option within the 'Logging' section of dspace.cfg to use the IP address of the user rather
than the IP address of the proxy server.
X.509 Certificate Authentication
Enabling X.509 Certificate Authentication
The X.509 authentication method uses an X.509 certificate sent by the client to establish his/her identity. It
requires the client to have a personal Web certificate installed on their browser (or other client software) which
is issued by a Certifying Authority (CA) recognized by the web server.
1. See the HTTPS installation instructions to configure your Web server. If you are using HTTPS with
Tomcat, note that the tag must include the attribute clientAuth="true" so the server
requests a personal Web certificate from the client.
2. Add the org.dspace.authenticate.X509Authentication plugin first to the list of stackable
authentication methods in the value of the configuration key plugin.sequence.org.dspace.
authenticate.AuthenticationMethod
Configuration
[dspace]/config/modules/authentication.cfg
File:
Property:
plugin.sequence.org.dspace.authenticate.AuthenticationMethod
Example
Value:
plugin.sequence.org.dspace.authenticate.AuthenticationMethod = org.dspace.
authenticate.X509Authentication
plugin.sequence.org.dspace.authenticate.AuthenticationMethod = org.dspace.
authenticate.PasswordAuthentication
Configuring X.509 Certificate Authentication
Configuration File:
[dspace]/config/modules/authentication-x509.cfg
1. You must also configure DSpace with the same CA certificates as the web server, so it can accept and
interpret the clients' certificates. It can share the same keystore file as the web server, or a separate one,
or a CA certificate in a file by itself. Configure it by oneof these methods, either the Java keystore
authentication-x509.keystore.path = path to Java keystore file
authentication-x509.keystore.password = password to access the keystore
...or the separate CA certificate file (in PEM or DER format):
authentication-x509.ca.cert =
13-Jul-2017
path to certificate file for CA whose client certs to accept.
https://wiki.duraspace.org/display/DSDOC6x
Page 108 of 901
DSpace 6.x Documentation
2. Choose whether to enable auto-registration: If you want users who authenticate successfully to be
automatically registered as new E-Persons if they are not already, set the autoregister configuration
property to true. This lets you automatically accept all users with valid personal certificates. The default
is false.
TODO: document the remaining authentication-x509.* properties
Example of a Custom Authentication Method
Also included in the source is an implementation of an authentication method used at MIT, edu.mit.dspace.
MITSpecialGroup. This does not actually authenticate a user, it only adds the current user session to a special
(dynamic) group called 'MIT Users' (which must be present in the system!). This allows us to create
authorization policies for MIT users without having to manually maintain membership of the MIT users group.
By keeping this code in a separate method, we can customize the authentication process for MIT by simply
adding it to the stack in the DSpace configuration. None of the code has to be touched.
You can create your own custom authentication method and add it to the stack. Use the most similar existing
method as a model, e.g. org.dspace.authenticate.PasswordAuthentication for an "explicit" method
(with credentials entered interactively) or org.dspace.authenticate.X509Authentication for an
implicit method.
4.1.2 Embargo
What is an Embargo?
DSpace 3.0 New Embargo Functionality
Configuring and using Embargo in DSpace 3.0+
Introduction
dspace.cfg
Submission Process
item-submission.xml
Simple Embargo Settings
AccessStep
UploadWithEmbargoStep
Advanced Embargo Settings
AccessStep
UploadWithEmbargoStep
Restrict list of displayed groups to specific (sub)groups
Private/Public Item
Pre-3.0 Embargo Migration Routine
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 109 of 901
DSpace 6.x Documentation
Technical Specifications
Introduction
ResourcePolicy
Item
Item.inheritCollectionDefaultPolicies(Collection c)
AuthorizeManager
Withdraw Item
Reinstate Item
Pre-DSpace 3.0 Embargo Compatibility
Pre-DSpace 3.0 Embargo
Embargo model and life-cycle
Terms assignment
Terms interpretation/imposition
Embargo period
Embargo lift
Post embargo
Configuration
Operation
Extending embargo functionality
Setter
Lifter
What is an Embargo?
An embargo is a temporary access restriction placed on metadata or bitstreams. Its scope or duration may vary,
but the fact that it eventually expires is what distinguishes it from other content restrictions. For example, it is
not unusual for content destined for DSpace to come with permanent restrictions on use or access based on
license-driven or other IP-based requirements that limit access to institutionally affiliated users. Restrictions
such as these are imposed and managed using standard administrative tools in DSpace, typically by attaching
specific policies to Items, Collections, Bitstreams, etc. Embargo functionality was originally introduced as part of
DSpace 1.6, enabling embargoes on the level of items that applied to all bitstreams included in the item. In
DSpace 3.0, this functionality has been extended for the XML User Interface, enabling embargoes on the level
of individual bitstreams.
DSpace 3.0 New Embargo Functionality
Embargoes can be applied per item and per bitstream. The item level embargo will be the default for every
bitstream, although it could be customized at bitstream level.
As a DSpace administrator, you can choose to integrate either Simple or Advanced dialog screens as part of
the item submission process. These are outlined in detail in the sections Simple Embargo Settings and
Advanced Embargo Settings.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 110 of 901
DSpace 6.x Documentation
This preference is stored in the dspace.cfg value webui.submission.restrictstep.enableAdvancedForm. If not
set, the default is for Simple Embargo.
Configuration name changed
Please note that the configuration parameter name has been changed in DSpace 4.0 from xmlui.
submission.restrictstep.enableAdvancedForm to webui.submission.restrictstep.enableAdvancedForm
On the level of an individual item, a new Private/Public state has been introducted to control the visibility of item
metadata in the different indexes serving the DSpace web interface (search, browse, discovery), as well as
machine interfaces (REST-API, OAI-PMH, …)
The following functionality has been added in DSpace 3.0:
Browse private items
Submission Process
Simple/Advanced Access Step
Upload with embargo step
Edit Item
Make it Private
Make it Public
The following functionality has been modified in DSpace 3.0:
Edit Item
Edit Bitstream
Wildcard Policy Admin Tool
Configuring and using Embargo in DSpace 3.0+
Introduction
The following sections describe the steps needed to configure and use the new Embargo functionality in
DSpace.
Note: when the embargo will be set at item level or bitstream level a new ResourcePolicy will be added.
dspace.cfg
As already mentioned the user will be given the opportunity to choose between:
Simple Embargo Settings
Advanced Embargo Settings
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 111 of 901
DSpace 6.x Documentation
To switch between the two, you need to set following variable in the dspace.cfg file. A value of false (the
default) enables the simple settings while a value of true enables the advanced settings.
webui.submission.restrictstep.enableAdvancedForm=false
Submission Process
item-submission.xml
To enable the new embargo, changes are required to the item-submission.xml file, located in your config
directory. This file determines which steps are executed in the submission of a new item.
Two new submission steps have been introduced in the file. By default, they are not activated yet:
AccessStep: the step in which the user can set the embargo at item level, effectively restricting access to
the item metadata.
UploadWithEmbargoStep: the step in which the user can set the embargo at bitstream level. If this step
is enabled, the old UploadStep must be disabled. Leaving both steps enabled will result in a
system failure.
Here is an extract from the new file:
To enable the new Embargo, ensure that the new steps are uncommented and the old UploadStep is
commented out.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 112 of 901
DSpace 6.x Documentation
Simple Embargo Settings
Using the simple embargo settings, submitters will be able to define embargoes bound to specific dates, that
are applied to all anonymous and default read access. To keep the interface simple, options to apply
embargoes for particular groups of DSpace users are not shown. The simple embargo settings interface
assumes that embargoes always start immediately upon submission, so only end dates are configurable.
AccessStep
The simple AccessStep Embargo form renders three options for the user:
Private item: to hide an item's metadata from all search and browse indexes, as well as external
interfaces such as OAI-PMH.
Embargo Access until Specific Date: to indicate a date until which the item will be embargoed.
Reason: to elaborate on the specific reason why an item is under embargo.
When Embargo is set, it applies to Anonymous or to any other Group that is indicated to have default read
access for that specific collection.
This shows how the Access step is rendered, using the simple embargo settings:
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 113 of 901
DSpace 6.x Documentation
UploadWithEmbargoStep
The simple UploadWithEmbargoStep form renders two new fields for the user:
Embargo Access until Specific Date: to indicate a date until which the bitstream will be embargoed.
When left empty, no embargo will be applied.
Reason: to elaborate on the specific reason why the bitstream is under embargo.
These fields will be preloaded with the values set in the AccessStep.
The following picture shows the form for the Upload step, rendered using the simple embargo settings with
preloaded values:
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 114 of 901
DSpace 6.x Documentation
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 115 of 901
DSpace 6.x Documentation
Advanced Embargo Settings
The Advanced Embargo settings are really designed with a submitter in mind who is aware of user groups in
DSpace and has understanding of how Resource Policies work.
AccessStep
The Advanced AccessStep Embargo step allows the users to manage more fine-grained resource policies to
attach to the item.
The form will render the following fields:
Policies List: list of the custom policies already added.
Private Item: whether to hide an item's metadata from all search and browse indexes, as well as external
interfaces such as OAI-PMH.
Name: to give a name to the policy.
Groups: to indicate the user groups to which the policy will apply.
Visible/Embargoed: whether the Item will be visible or embargoed for that specific group.
Embargo Access until Specific Date: to indicate a date until which the item will be embargoed.
Reason: to elaborate on the specific reason why the policy is applied.
The last two fields will be enabled only when Embargoed has been selected.
This step gives the opportunity to the user to manage the policy manually, so that combinations such as the
following will be possible:
Set Embargo for Anonymous
Set Embargo for anyone, except for the users belonging to a specific group
Set Embargo for specific groups, but not for other groups ...
Here is a screenshot of the Access step form that will be rendered for the advanced embargo settings:
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 116 of 901
DSpace 6.x Documentation
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 117 of 901
DSpace 6.x Documentation
UploadWithEmbargoStep
UploadWithEmbargoStep for Advanced Embargo settings displays an additional Policies button next to Edit in
the list of uploaded files.
Clicking it brings you to the a page where you can edit existing policies on the bitstream and add new ones.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 118 of 901
DSpace 6.x Documentation
When the button is pushed, a form similar to the one in the AccessStep will be rendered, making it possible to
manage the policies at bitstream level.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 119 of 901
DSpace 6.x Documentation
Restrict list of displayed groups to specific (sub)groups
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 120 of 901
DSpace 6.x Documentation
For large instances of DSpace, the list of Groups can be quite long. Groups can be nested. This means that not
only EPersons can be members of groups, but groups themselves can belong to other groups.
When advanced embargo settings are enabled, you can limit the list of groups displayed to the submitters to
subgroups of a particular group.
To use this feature, assign the super group name to following configuration value in dspace.cfg:
webui.submission.restrictstep.groups=name_of_the_supergroup
Configuration name changed
Please note that the configuration parameter name has been changed in DSpace 4.0 from xmlui.
submission.restrictstep.groups to webui.submission.restrictstep.groups
Once a specific group is configured as supergroup here, only the groups belonging to the indicated group will
be loaded in the selection dialogs. By default, all groups are loaded.
Private/Public Item
It is also possible to adjust the Private/Public state of an item after it has been archived in the repository.
Here is a screenshot showing the updated Edit Item dialog:
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 121 of 901
DSpace 6.x Documentation
Private items are not retrievable through the DSpace search, browse or Discovery indexes.
Therefor, an admin-only view has been created to browse all private items. Here is a screenshot of this new
form:
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 122 of 901
DSpace 6.x Documentation
Pre-3.0 Embargo Migration Routine
A migration routine has been developed to migrate the current Embargo to the new one.
To execute it, run the following command:
./dspace migrate-embargo -a
Technical Specifications
Introduction
The following sections illustrate the technical changes that have been made to the back-end to add the new
Advanced Embargo functionality.
ResourcePolicy
When an embargo is set at item level or bitstream level, a new ResourcePolicy will be added.
Three new attributes have been introduced in the ResourcePolicy class:
rpname: resource policy name
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 123 of 901
DSpace 6.x Documentation
rptype: resource policy type
rpdescription: resource policy description
While rpname and rpdescription are fields manageable by users, the rptype is managed by DSpace itself. It
represents a type that a resource policy can assume, among the following:
TYPE_SUBMISSION: all the policies added automatically during the submission process
TYPE_WORKFLOW: all the policies added automatically during the workflow stage
TYPE_CUSTOM: all the custom policies added by users
TYPE_INHERITED: all the policies inherited from the enclosing object (for Item, a Collection; for
Bitstream, an Item).
Here is an example of all information contained in a single policy record:
policy_id: 4847
resource_type_id: 2
resource_id: 89
action_id: 0
eperson_id:
epersongroup_id: 0
start_date: 2013-01-01
end_date:
rpname: Embargo Policy
rpdescription: Embargoed through 2012
rptype: TYPE_CUSTOM
Item
To manage Private/Public state a new boolean attribute has been added to the Item:
isDiscoverable
When an Item is private, the attribute will assume the value false.
Item.inheritCollectionDefaultPolicies(Collection c)
This method has been adjusted to leave custom policies, added by the users, in place and add the default
collection policies only if there are no custom policies.
AuthorizeManager
Some methods have been changed on AuthorizeManager to manage the new fields and some convenience
methods have been introduced:
public static List findPoliciesByDSOAndType(Context c, DSpaceObject o, String
type);
public static void removeAllPoliciesByDSOAndTypeNotEqualsTo(Context c, DSpaceObject o, String
type);
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 124 of 901
DSpace 6.x Documentation
public static boolean isAnIdenticalPolicyAlreadyInPlace(Context c, DSpaceObject o, ResourcePolicy
rp);
public static ResourcePolicy createOrModifyPolicy(ResourcePolicy policy, Context context, String
name, int idGroup, EPerson ePerson, Date embargoDate, int action, String reason, DSpaceObject dso);
Withdraw Item
The feature to withdraw an item from the repository has been modified to keep all the custom policies in place.
Reinstate Item
The feature to reinstate an item in the repository has been modified to preserve existing custom policies.
Pre-DSpace 3.0 Embargo Compatibility
The Pre-DSpace 3.0 embargo functionality (see below) has been modified to adjust the policies setter and lifter.
These classes now also set the dates within the policy objects themselves in addition to setting the date in the
item metadata.
Pre-DSpace 3.0 Embargo
Embargo model and life-cycle
Functionally, the embargo system allows you to attach "terms" to an item before it is placed into the repository,
which express how the embargo should be applied. What do we mean by "terms" here? They are really any
expression that the system is capable of turning into (1) the time the embargo expires, and (2) a concrete set of
access restrictions. Some examples:
"2020-09-12" - an absolute date (i.e. the date embargo will be lifted)
"6 months" - a time relative to when the item is accessioned
"forever" - an indefinite, or open-ended embargo
"local only until 2015" - both a time and an exception (public has no access until 2015, local users OK
immediately)
"Nature Publishing Group standard" - look-up to a policy somewhere (typically 6 months)
These terms are interpreted by the embargo system to yield a specific date on which the embargo can be
removed (or "lifted"), and a specific set of access policies. Obviously, some terms are easier to interpret than
others (the absolute date really requires none at all), and the default embargo logic understands only the most
basic terms (the first and third examples above). But as we will see below, the embargo system provides you
with the ability to add your own interpreters to cope with any terms expressions you wish to have. This date that
is the result of the interpretation is stored with the item. The embargo system detects when that date has
passed, and removes the embargo ("lifts it"), so the item bitstreams become available. Here is a more detailed
life-cycle for an embargoed item:
Terms assignment
The first step in placing an embargo on an item is to attach (assign) "terms" to it. If these terms are missing, no
embargo will be imposed. As we will see below, terms are carried in a configurable DSpace metadata field, so
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 125 of 901
DSpace 6.x Documentation
assigning terms just means assigning a value to a metadata field. This can be done in a web submission user
interface form, in a SWORD deposit package, a batch import, etc. - anywhere metadata is passed to DSpace.
The terms are not immediately acted upon, and may be revised, corrected, removed, etc, up until the next stage
of the life-cycle. Thus a submitter could enter one value, and a collection editor replace it, and only the last
value will be used. Since metadata fields are multivalued, theoretically there can be multiple terms values, but in
the default implementation only one is recognized.
Terms interpretation/imposition
In DSpace terminology, when an Item has exited the last of any workflow steps (or if none have been defined
for it), it is said to be "installed" into the repository. At this precise time, the interpretation of the terms occurs,
and a computed "lift date" is assigned, which like the terms is recorded in a configurable metadata field. It is
important to understand that this interpretation happens only once, (just like the installation), and cannot be
revisited later. Thus, although an administrator can assign a new value to the metadata field holding the terms
after the item has been installed, this will have no effect on the embargo, whose "force" now resides entirely in
the "lift date" value. For this reason, you cannot embargo content already in your repository (at least using
standard tools). The other action taken at installation time is the actual imposition of the embargo. The default
behavior here is simply to remove the read policies on all the bundles and bitstreams except for the "LICENSE"
or "METADATA" bundles. See the Extending embargo functionality section below for how to alter this
behavior. Also note that since these policy changes occur before installation, there is no time during which
embargoed content is "exposed" (accessible by non-administrators). The terms interpretation and imposition
together are called "setting" the embargo, and the component that performs them both is called the embargo
"setter".
Embargo period
After an embargoed item has been installed, the policy restrictions remain in effect until removed. This is not an
automatic process, however: a "lifter" must be run periodically to look for items whose "lift date" has passed.
Note that this means the effective removal of an embargo does not occur on the lift date, but on the earliest
date after the lift date that the lifter is run. Typically, a nightly cron-scheduled invocation of the lifter is more than
adequate, given the granularity of embargo terms. Also note that during the embargo period, all metadata of the
item remains visible.This default behavior can be changed. One final point to note is that the "lift date", although
it was computed and assigned during the previous stage, is in the end a regular metadata field. That means, if
there are extraordinary circumstances that require an administrator (or collection editor - anyone with edit
permissions on metadata) to change the lift date, this can be done. Thus, one can "revise" the lift date without
reference to the original terms. This date will be checked the next time the "lifter" is run. One could immediately
lift the embargo by setting the lift date to the current day, or change it to "forever" to indefinitely postpone lifting.
Embargo lift
When the lifter discovers an item whose lift date is in the past, it removes ("lifts") the embargo. The default
behavior of the lifter is to add the resource policies that would have been added had the embargo not been
imposed. That is, it replicates the standard DSpace behavior, in which an item inherits its policies from its
owning collection. As with all other parts of the embargo system, you may replace or extend the default
behavior of the lifter (see Extending embargo functionality below). You may wish, e.g., to send an email to an
administrator or other interested parties when an embargoed item becomes available.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 126 of 901
DSpace 6.x Documentation
Post embargo
After the embargo has been lifted, the item ceases to respond to any of the embargo life-cycle events. The
values of the metadata fields reflect essentially historical or provenance values. With the exception of the
additional metadata fields, the item is indistinguishable from items that were never subject to embargo.
Configuration
DSpace embargoes utilize standard metadata fields to hold both the "terms" and the "lift date". Which fields you
use are configurable, and no specific metadata element is dedicated or pre-defined for use in embargo. Rather,
you must specify exactly what field you want the embargo system to examine when it needs to find the terms or
assign the lift date.
The properties that specify these assignments live in dspace.cfg:
# DC metadata field to hold the user-supplied embargo terms
embargo.field.terms = SCHEMA.ELEMENT.QUALIFIER
# DC metadata field to hold computed "lift date" of embargo
embargo.field.lift = SCHEMA.ELEMENT.QUALIFIER
You replace the placeholder values with real metadata field names. If you only need the "default" embargo
behavior - which essentially accepts only absolute dates as "terms" - this is the only configuration required,
except as noted below.
There is also a property for the special date of "forever":
# string in terms field to indicate indefinite embargo
embargo.terms.open = forever
which you may change to suit linguistic or other preference.
You are free to use existing metadata fields, or create new fields. If you choose the latter, you must understand
that the embargo system does not create or configure these fields: i.e. you must follow all the standard
documented procedures for actually creating them (i.e. adding them to the metadata registry, or to display
templates, etc) - this does not happen automatically. Likewise, if you want the field for "terms" to appear in
submission screens and workflows, you must follow the documented procedure for configurable submission
(basically, this means adding the field to input-forms.xml). The flexibility of metadata configuration makes if easy
for you to restrict embargoes to specific collections, since configurable submission can be defined per
collection.
Key recommendations:
1. Use a local metadata schema. Breaking compliance with the standard Dublin Core in the default
metadata registry can create a problem for the portability of data to/from of your repository.
2.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 127 of 901
DSpace 6.x Documentation
2. If using existing metadata fields, avoid any that are automatically managed by DSpace. For example,
fields like "date.issued" or "date.accessioned" are normally automatically assigned, and thus must not be
recruited for embargo use.
3. Do not place the field for "lift date" in submission screens. This can potentially confuse submitters
because they may feel that they can directly assign values to it. As noted in the life-cycle above, this is
erroneous: the lift date gets assigned by the embargo system based on the terms. Any pre-existing value
will be over-written. But see next recommendation for an exception.
4. As the life-cycle discussion above makes clear, after the terms are applied, that field is no longer
actionable in the embargo system. Conversely, the "lift date" field is not actionable until the application.
Thus you may want to consider configuring both the "terms" and "lift date" to use the same metadata
field. In this way, during workflow you would see only the terms, and after item installation, only the lift
date. If you wish the metadata to retain the terms for any resaon, use 2 distinct fields instead.
Operation
After the fields defined for terms and lift date have been assigned in dspace.cfg, and created and configured
wherever they will be used, you can begin to embargo items simply by entering data (dates, if using the default
setter) in the terms field. They will automatically be embargoed as they exit workflow. For the embargo to be
lifted on any item, however, a new administrative procedure must be added: the "embargo lifter" must be
invoked on a regular basis. This task examines all embargoed items, and if their "lift date" has passed, it
removes the access restrictions on the item. Good practice dictates automating this procedure using cron jobs
or the like, rather than manually running it.
The lifter is available as a target of the 1.6 DSpace launcher - see launcher documentation for details.
Extending embargo functionality
The 1.6 embargo system supplies a default "interpreter/imposition" class (the "Setter") as well as a "Lifter", but
they are fairly rudimentary in several respects.
Setter
The default setter recognizes only two expressions of terms: either a literal, non-relative date in the fixed format
"yyyy-mm-dd" (known as ISO 8601), or a special string used for open-ended embargo (the default configured
value for this is "forever", but this can be changed in dspace.cfg to "toujours", "unendlich", etc). It will perform a
minimal sanity check that the date is not in the past. Similarly, the default setter will only remove all read
policies as noted above, rather than applying more nuanced rules (e.g allow access to certain IP groups, deny
the rest). Fortunately, the setter class itself is configurable and you can "plug in" any behavior you like, provided
it is written in java and conforms to the setter interface. The dspace.cfg property:
# implementation of embargo setter plugin - replace with local implementation if applicable
plugin.single.org.dspace.embargo.EmbargoSetter = org.dspace.embargo.DefaultEmbargoSetter
controls which setter to use.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 128 of 901
DSpace 6.x Documentation
Lifter
The default lifter behavior as described above - essentially applying the collection policy rules to the item - might
also not be sufficient for all purposes. It also can be replaced with another class:
implementation of embargo lifter plugin - - replace with local implementation if applicable
plugin.single.org.dspace.embargo.EmbargoLifter = org.dspace.embargo.DefaultEmbargoLifter
Pre-3.0 Embargo Lifter Commands
If you have implemented the pre DSpace 3.0 Embargo feature, you will need to run it periodically to check for
Items with expired embargoes and lift them.
Command used:
[dspace]/bin/dspace embargo-lifter
Java class:
org.dspace.embargo.EmbargoManager
Arguments short and (long)
Description
forms):
-c or --check
ONLY check the state of embargoed Items, do NOT lift any embargoes
-i or --identifier
Process ONLY this handle identifier(s), which must be an Item. Can be
repeated.
-l or --lift
Only lift embargoes, do NOT check the state of any embargoed items.
-n or --dryrun
Do no change anything in the data model, print message instead.
-v or --verbose
Print a line describing the action taken for each embargoed item found.
-q or --quiet
No output except upon error.
-h or --help
Display brief help screen.
You must run the Embargo Lifter task periodically to check for items with expired embargoes and lift them from
being embargoed. For example, to check the status, at the CLI:
[dspace]/bin/dspace embargo-lifter -c
To lift the actual embargoes on those items that meet the time criteria, at the CLI:
[dspace]/bin/dspace embargo-lifter -l
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 129 of 901
DSpace 6.x Documentation
4.1.3 Managing User Accounts
When a user registers an account for the purpose of subscribing to change notices, submitting content, or the
like, DSpace creates an EPerson record in the database. Administrators can manipulate these records in
several ways.
Please note that when a user has submitted content, his EPerson record cannot be deleted because there are
references to it from the submitted item(s). If it is necessary to prevent further use of such an account, it can be
marked "cannot log in".
From the browser: XMLUI
TBS
From the browser: JSPUI
TBS
From the command line
The user command
The dspace user command adds, lists, modifies, and deletes EPerson records.
To create a new user account:
[dspace]/bin/dspace user --add --email jquser@example.com -g John -s User --password hiddensecret
[dspace]/bin/dspace user --add --netid jquser --telephone 555-555-1234 --password hiddensecret
One of the options --email or --netid is required to name the record. The complete options are:
-
--add
required
--email
email address
--netid
"netid" (a username in an external system such as a directory – see Authentication
a
m
n
-
Methods for details)
--password
a password for the account. Required.
--givenname
First or given name
p
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 130 of 901
DSpace 6.x Documentation
g
-s
--surname
Last or surname
-t
--telephone
Telephone number
-l
--language
Preferred language
-c
--
Certificate required? See X.509 Authentication for details.
requireCertificate
To list accounts:
[dspace]/bin/dspace user --list
This simply lists some characteristics of each EPerson.
short
long
meaning
-L
--list
required
To modify an account:
[dspace]/bin/dspace user --modify -m george@example.com
short
long
meaning
-M
--modify
required
-m
--email
identify the account by email address
-n
--netid
identify the account by netid
-g
--givenname
First or given name
-s
--surname
Last or surname
-t
--telephone
telephone number
-l
--language
preferred language
-c
--requireCertificate
certificate required?
-C
--canLogIn
is the account enabled or disabled?
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 131 of 901
DSpace 6.x Documentation
short
long
meaning
-i
--newEmail
set or change email address
-I
--newNetid
set or change netid
To delete an account:
[dspace]/bin/dspace user --delete -n martha
short
long
meaning
-d
--delete
required
-m
--email
identify the account by email address
-n
--netid
identify the account by netid
The Groomer
This tool inspects all user accounts for several conditions.
short
long
meaning
-a
--aging
find accounts not logged in since a given date
-u
--unsalted
find accounts not using salted password hashes
-b
--before
date cutoff for --aging
-d
--delete
delete disused accounts (used with --aging)
Find accounts with unsalted passwords
Earlier versions of DSpace used an "unsalted hash" method to protect user passwords. Recent versions use a
salted hash. You can find accounts which have never been converted to salted hashing:
Discovering accounts with unsalted password hashes
[DSpace]/bin/dsrun org.dspace.eperson.Groomer -u
The output is a list of email addresses for matching accounts.
Find (and perhaps delete) disused accounts
You can list accounts which have not logged on since a given date:
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 132 of 901
DSpace 6.x Documentation
Discovering disused accounts
[DSpace]/bin/dsrun org.dspace.eperson.Groomer -a -b 07/20/1969
The output is a tab-separated-value table of the EPerson ID, last login date, email address, netid, and full name
for each matching account.
You can also have the tool delete matching accounts:
Deleting disused accounts
[DSpace]/bin/dsrun org.dspace.eperson.Groomer -a -b 07/20/1969 -d
Email Subscriptions
/**/
Introduction
Adding new subscriptions
System configuration for sending out daily emails
Introduction
Registered users can subscribe to collections in DSpace. After subscribing, users will receive a daily email
containing the new and modified items in the collections they are subscribed to.
Adding new subscriptions
Adding new subscriptions is only available to users who are logged in.
In the XML User interface, new subscriptions are added on the users Profile page.
In the JSP User Interface, a specific dialog "Receive Email Updates" is available from the dropdown in the top
right corner.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 133 of 901
DSpace 6.x Documentation
Receive email updates
System configuration for sending out daily emails
To send out the subscription emails you need to invoke the sub-daily script from the DSpace command
launcher. It is advised to setup this script as a scheduled task using cron.
This script can be run with a parameter -t for testing purposes. When this parameter is passed, the log level is
set to DEBUG to ensure that more diagnostic information will be added to the dspace logfile.
4.1.4 Request a Copy
Introduction
Requesting a copy using the XML User Interface
Requesting a copy using the JSP User Interface
(Optional) Requesting a copy with Help Desk workflow
Email templates
Configuration parameters
Selecting Request a Copy strategy via Spring Configuration
Introduction
The request a copy functionality was added to DSpace as a measure to facilitate access in those cases when
uploaded content can not be openly shared with the entire world immediately after submission into DSpace. It
gives users an efficient way to request access to the original submitter of the item, who can approve this access
with the click of a button. This practice complies with most applicable policies as the submitter interacts directly
with the requester on a case by case basis.
Requesting a copy using the XML User Interface
Users can request a copy by clicking the file thumbnail or the blue lock symbol displayed on files that are
restricted to them.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 134 of 901
DSpace 6.x Documentation
Restricted Item XMLUI
The request form asks the user for his or her name, email address and message where the reason for
requesting access can be entered.
After clicking request copy at the bottom of this form, the original submitter of the item will receive an email
containing the details of the request. The email also contains a link with a token that brings the original
submitter to a page where he or she can either grant or reject access. If the original submitter can not evaluate
the request, he or she can forward this email to the right person, who can use the link containing the token
without having to log into DSpace.
Each of these buttons registers the choice of the submitter, displaying the following form in which an additional
reason for granting or rejecting the access can be added.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 135 of 901
DSpace 6.x Documentation
After hitting send, the contents of this form will be sent together with the associated files to the email address of
the requester. In case the access is rejected, only the reason will be sent to the requester.
After responding positively to a request for copy, the person who approved is presented with an optional form to
ask the repository administrator to alter the access rights of the item, allowing unrestricted open access to
everyone.
Requesting a copy using the JSP User Interface
Users can request a copy by clicking the green "Request a Copy" button for files that are restricted to them.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 136 of 901
DSpace 6.x Documentation
Restricted item JSPUI
The request form asks the user for his or her name, email address and message where the reason for
requesting access can be entered.
After clicking request copy at the bottom of this form, the original submitter of the item will receive an email
containing the details of the request. The email also contains a link with a token that brings the original
submitter to a page where he or she can either grant or reject access. If the original submitter can not evaluate
the request, he or she can forward this email to the right person, who can use the link containing the token
without having to log into DSpace.
After approving or rejecting the request for a copy, the contents of the form will be sent together with the
associated files to the email address of the requester. In case the access is rejected, only the reason will be
sent to the requester.
(Optional) Requesting a copy with Help Desk workflow
(Optional) Request Item with HelpDesk intermediary, is steered towards having your Repository Support staff
act as a helpdesk that receives all incoming RequestItem requests, and then processes them. This adds the
options of "Initial Reply to Requestor" to let the requestor know that their request is being worked on, and an
option "Author Permission Request" which allows the helpdesk to email the author of the document, as not all
documents are deposited by the author, or the author will need to be tracked down by a support staff, as
DSpace might not have their current email address.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 137 of 901
DSpace 6.x Documentation
Initial Reply to Requester
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 138 of 901
DSpace 6.x Documentation
Author permission request, includes information about the original request (requester name, requester email,
requester's reason for requesting). The author/submitter's name and email address will be pre-populated in the
form from the submitter, but the email address and author name are editable, as the submitter's of content to
DSpace aren't always the author.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 139 of 901
DSpace 6.x Documentation
Email templates
Most of the email templates used by Request a Copy are treated just like other email templates in DSpace. The
templates can be found in the /config/emails directory and can be altered just by changing the contents and
restarting tomcat.
request_item. template for the message that will be sent to the administrator of the repository, after the
original submitter requests to have the permissions changed for this item.
admin
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 140 of 901
DSpace 6.x Documentation
request_item. template for the message that will be sent to the original submitter of an item with the
request for copy.
author
The templates for emails that the requester receives, that could have been customized by the approver in the
aforementioned dialog are not managed as separate email template files. These defaults are stored in the
Messages.properties file under the keys
itemRequest.response.body.approve
Default message for informing the requester of the
approval
itemRequest.response.body.reject
Default message for informing the requester of the
rejection
itemRequest.response.body.contactAuthor
Default message for the helpdesk to contact the author
itemRequest.response.body.
Default message for the helpdesk to contact the requester
contactRequester
Configuration parameters
Request a copy is enabled in DSpace 4 by default. Only two configuration parameters in dspace.cfg relate to
Request a Copy:
Property:
request.item.type
Example
request.item.type = all
Value
Informational
This parameter manages who can file a request for an item. The parameter is optional. When
Note
it is empty or commented out, request a copy is disabled across the entire repository. When
set to all, any user can file a request for a copy. When set to logged, only registered users
can file a request for copy.
Property:
mail.helpdesk
Example
mail.helpdesk = foo@bar.com
Value
Informational
In JSPUI, the email address assigned to this parameter will receive the emails both for
Note
granting or rejecting request a copy requests, as well as requests to change item policies. In
XMLUI, the parameter will also receive these requests to change item policies. However, the
actual requests for copy in XMLUI will initially be directed at the email address of the original
submitter. When this email address can not be retrieved, the address in mail.helpdesk will
be used as a fallback.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 141 of 901
DSpace 6.x Documentation
This parameter is optional. If it is empty or commented out, it will default to mail.admin.
WARNING: This setting is only utilized if the RequestItemHelpdeskStrategy bean is
enabled in [dspace]/config/spring/api/requestitem.xml (see below)
Property:
request.item.helpdesk.override
Example
request.item.helpdesk.override = true
Value
Informational
Should all Request Copy emails go to the mail.helpdesk instead of the item submitter?
Note
Default is false, which sends Item Requests to the item submitter.
WARNING: This setting is only utilized if the RequestItemHelpdeskStrategy bean is
enabled in [dspace]/config/spring/api/requestitem.xml (see below)
Selecting Request a Copy strategy via Spring Configuration
The process that DSpace uses to determine who is the recipient of the Item Request is configurable in this
Spring file: [dspace]/config/spring/api/requestitem.xml
By default the RequestItemMetadataStrategy is enabled, but falls back to the Item Submitter eperson's
name and email. You can configure the RequestItemMetadataStrategy to load the author's name and
email address if you set that information into an item metadata field. For example:
Another common request strategy is the use a single Helpdesk email address to receive all of these requests
(see corresponding helpdesk configs in dspace.cfg above). If you wish to use the Helpdesk Strategy, you must
first comment out the default RequestItemMetadataStrategy, bean and uncomment this bean:
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 142 of 901
DSpace 6.x Documentation
Contexts could be seen as virtual distinct OAI interfaces, so with this one could have things like:
http://www.example.com/oai/request
http://www.example.com/oai/driver
http://www.example.com/oai/openaire
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 150 of 901
DSpace 6.x Documentation
With this ingredients it is possible to build a robust solution that fulfills all requirements of Driver, OpenAIRE and
also other project-specific requirements. As shown in Figure 1, with contexts one could select a subset of all
available items in the data source. So when entering the OpenAIRE context, all OAI-PMH request will be
restricted to that subset of items.
At this stage, contexts could be seen as sets (also defined in the basic OAI-PMH protocol). The magic of XOAI
happens when one need specific metadata format to be shown in each context. Metadata requirements by
Driver slightly differs from the OpenAIRE ones. So for each context one must define its specific transformer. So,
contexts could be seen as an extension to the concept of sets.
To implement an OAI interface from the XOAI core library, one just need to implement the datasource interface.
OAI 2.0
OAI 2.0 is a separate webapp which is a complete substitute for the old "oai" webapp. OAI 2.0 has a
configurable data source, by default it will not query the DSpace SQL database at the time of the OAI-PMH
request. Instead, it keeps the required metadata in its Solr index (currently in a separate "oai" Solr core) and
serves it from there. It's also possible to set OAI 2.0 to only use the database for querying purposes if
necessary, but this decreases performance significantly. Furthermore, it caches the requests, so doing the
same query repeatedly is very fast. In addition to that it also compiles DSpace items to make uncached
responses much faster.
Details about OAI 2.0 internals can be found here.
As of DSpace 6, the OAI 2.0 Server only uses Solr for its indexing. The previous capability to use
Database indexing has been removed.
Indexing OAI content
OAI 2.0 uses Solr for all indexing of content.
The Solr index can be updated at your convenience, depending on how fresh you need the information to be.
Typically, the administrator sets up a nightly cron job to update the Solr index from the SQL database.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 151 of 901
DSpace 6.x Documentation
OAI Manager
OAI manager is a utility that allows one to do certain administrative operations with OAI. You can call it from the
command line using the dspace launcher:
Syntax
[dspace]/bin/dspace oai [parameters]
Actions
import Imports DSpace items into OAI Solr index (also cleans OAI cache)
clean-cache Cleans the OAI cache
Parameters
-o Optimize index after indexing
-c Clears the Solr index before indexing (it will import all items again)
-v Verbose output
-h Shows an help text
Scheduled Tasks
In order to refresh the OAI Solr index, it is required to run the [dspace]/bin/dspace oai import
command periodically. You can add the following task to your crontab:
0 3 * * * [dspace]/bin/dspace oai import
Note that [dspace] should be replaced by the correct value, that is, the value defined in dspace.cfg
parameter dspace.dir.
Client-side stylesheet
The OAI-PMH response is an XML file. While OAI-PMH is primarily used by harvesting tools and usually not
directly by humans, sometimes it can be useful to look at the OAI-PMH requests directly - usually when setting
it up for the first time or to verify any changes you make. For these cases, XOAI provides an XSLT stylesheet to
transform the response XML to a nice looking, human-readable and interactive HTML. The stylesheet is linked
from the XML response and the transformation takes place in the user's browser (this requires a recent
browser, older browsers will only display the XML directly). Most automated tools are interested only in the XML
file itself and will not perform the transformation. If you want, you can change which stylesheet will be used by
placing it into the [dspace]/webapps/oai/static directory (or into the [dspace-src]/dspace-xoai
/dspace-xoai-webapp/src/main/webapp/static after which you have to rebuild DSpace), modifying
the "stylesheet" attribute of the "Configuration" element in [dspace]/config/crosswalks/oai/xoai.xml
and restarting your servlet container.
Metadata Formats
By default OAI 2.0 provides 12 metadata formats within the /request context:
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 152 of 901
DSpace 6.x Documentation
1. OAI_DC
2. DIDL
3. DIM
4. ETDMS
5. METS
6. MODS
7. OAI-ORE
8. QDC
9. RDF
10. MARC
11. UKETD_DC
12. XOAI
At /driver context it provdes:
1. OAI_DC
2. DIDL
3. METS
And at /openaire context it provides:
1. OAI_DC
2. METS
Encoding problems
There are two main potential sources of encoding problems:
a) The servlet connector port has to use the correct encoding. E.g. for Tomcat, this would be
Add/Remove Metadata Formats
Each context could have its own metadata formats. So to add/remove metadata formats to/from it, just need add
/remove its reference within xoai.xml, for example, imagine one need to remove the XOAI schema from:
Then one would have:
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 155 of 901
DSpace 6.x Documentation
It is also possible to create new metadata format by creating a specific XSLT for it. All already defined XSLT for
DSpace can be found in the [dspace]/config/crosswalks/oai/metadataFormats directory. So after producing
a new one, add the following information (location marked using brackets) inside the element in
[dspace]/config/crosswalks/oai/xoai.xml:
[PREFIX]
metadataFormats/[XSLT]
[NAMESPACE]
[SCHEMA_LOCATION]
where:
Parameter
Description
IDENTIFIER
The identifier used within context configurations to reference this specific format,
must be unique within all Metadata Formats available.
PREFIX
The prefix used in OAI interface (metadataPrefix=PREFIX).
XSLT
The name of the XSLT file within [dspace]/config/crosswalks/oai
/metadataFormats directory
NAMESPACE
XML Default Namespace of the created Schema
SCHEMA_LOCATION
URI Location of the XSD of the created Schema
NOTE: Changes in [dspace]/config/crosswalks/oai/xoai.xml requires reloading/restarting the servlet container.
Add/Remove Metadata Fields
The internal DSpace fields (Dublin Core) are exposed in the internal XOAI format (xml). All other metadata
formats exposed via OAI are mapped from this XOAI format using XSLT (xoai.xsl itself is just an identity
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 156 of 901
DSpace 6.x Documentation
transformation). These XSLT stylesheets are found in the [dspace]/config/crosswalks/oai/metadataFormats
directory. So e.g. oai_dc.xsl is a transformation from the XOAI format to the oai_dc format (unqualified Dublin
Core).
Therefore exposing any DSpace metadata field in any OAI format is just a matter of modifying the
corresponding output format stylesheet (This assumes the general knowledge of how XSLT works. For a
tutorial, see e.g. http://www.w3schools.com/xsl/).
For example, if you have a DC field "local.note.librarian" that you want to expose in oai_dc as (please
note that this is not a valid DC field and thus breaks compatibility), then edit oai_dc.xsl and add the following
lines just above the closing tag :
If you need to add/remove metadata fields, you're changing the output format. Therefore it is recommended to
create a new metadata format as a copy of the one you want to modify. This way the old format will remain
available along with the new one and any upgrades to the original format during DSpace upgrades will not
overwrite your customizations. If you need the format to have the same name as the original format (e.g. the
default oai_dc format), you can create a new context in xoai.xsl containing your modified format with the original
name, which will be available as /oai/context-name.
NOTE: Please, keep in mind that the OAI provider caches the transformed output, so you have to run
[dspace]/bin/dspace oai clean-cache after any .xsl modification and reload the OAI page for the
changes to take effect. When adding/removing metadata formats, making changes in [dspace]/config/crosswalks
/oai/xoai.xml requires reloading/restarting the servlet container.
Driver/OpenAIRE compliance
The default OAI 2.0 installation provides two new contexts. They are:
Driver context, which only exposes Driver compliant items;
OpenAIRE context, which only exposes OpenAIRE compliant items;
However, in order to be exposed DSpace items must be compliant with Driver/OpenAIRE guide-lines.
Driver Compliance
DRIVER Guidelines for Repository Managers and Administrators on how to expose digital scientific resources
using OAI-PMH and Dublin Core Metadata, creating interoperability by homogenizing the repository output. The
OAI-PMH driver set is based on DRIVER Guidelines 2.0.
This set is used to expose items of the repository that are available for open access. It’s not necessary for all
the items of the repository to be available for open access.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 157 of 901
DSpace 6.x Documentation
What specific metadata values are expected?
To have items in this set, you must configure your input-forms.xml file in order to comply with the DRIVER
Guidelines:
Must have a publication date - dc.date.issued (already configured in DSpace items)
dc.language must use ISO639-3
the value of dc.type must be one of the 16 types named in the guidelines
How do you easily add those metadata values?
As DRIVER guidelines use Dublin Core, all the needed items are already registered in DSpace. You just need
to configure the deposit process.
OpenAIRE compliance
The OpenAIRE Guidelines 2.0 provide the OpenAIRE compatibility to repositories and aggregators. By
implementing these Guidelines, repository managers are facilitating the authors who deposit their publications
in the repository in complying with the EC Open Access requirements. For developers of repository platforms,
the Guidelines provide guidance to add supportive functionalities for authors of EC-funded research in future
versions.
The name of the set in OAI-PMH is "ec_fundedresources" and will expose the items of the repository that
comply with these guidelines. These guidelines are based on top of DRIVER guidelines. See version 2.0 of the
Guidelines.
See the Application Profile of OpenAIRE.
What specific metadata values are expected?
These are the OpenAIRE metadata values only, to check these and driver metadata values check page 11 of
the OpenAIRE guidelines 2.0.
dc:relation with the project ID (see p.8)
dc:rights with the access rights information from vocabulary (possible values here)
Optionally:
dc:date with the embargo end date (recommended for embargoed items)
info:eu-repo/date/embargoEnd/2011-05-12
How do you easily add those metadata values?
Have a dc:relation field in input-forms.xml with a list of the projects. You can also use the OpenAIRE
Authority Control Addon to facilitate the process of finding the project.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 158 of 901
DSpace 6.x Documentation
Just use a combo-box for dc:rights to input the 4 options:
info:eu-repo/semantics/closedAccess
info:eu-repo/semantics/embargoedAccess
info:eu-repo/semantics/restrictedAccess
info:eu-repo/semantics/openAccess
Use an input-box for dc:date to insert the embargo end date
Relevant Links
OAI 2.0 is a standard part of DSpace 3.0
Download & Install OAI 2.0 for DSpace 1.8.x: http://www.lyncode.com/dspace/addons/xoai/
Sanity check your OAI interface with the OAI Validator
There is a very useful validator for OAI interfaces available at http://validator.oaipmh.com, we urge you to use
this validator to confirm your OAI interface is in fact usable.
Frequently asked questions and issues
TODO fill out based on notes from the March DCAT call: DCAT Meeting March 2016
OAI-PMH Data Provider 2.0 (Internals)
OAI-PMH Data Provider 2.0 (Internals)
Sets
Unique Identifier
Access control
Modification Date (OAI Date Stamp)
"About" Information
Deletions
Flow Control (Resumption Tokens)
OAI-PMH Data Provider 2.0 (Internals)
The DSpace platform supports the Open Archives Initiative Protocol for Metadata Harvesting (OAI-PMH)
version 2.0 as a data provider. This is accomplished using the XOAI OAI-PMH Java Toolkit.
The DSpace build process builds a Web application archive, [dspace-source]/build/oai.war), in much the same
way as the Web UI build process described above. The only differences are that the JSPs are not included.
This "webapp" is deployed to receive and respond to OAI-PMH requests via HTTP. In a typical configuration,
this is deployed at oai, containing request, driver and openaire contexts, for example:
http://dspace.myu.edu/oai/request?verb=Identify
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 159 of 901
DSpace 6.x Documentation
The "base URL" of this DSpace deployment would be:
http://dspace.myu.edu/oai/request
But one could also provide the Driver or OpenAIRE contexts:
http://dspace.myu.edu/oai/driver
http://dspace.myu.edu/oai/openaire
It is this URL that should be registered with www.openarchives.org.
DSpace provides implementations of the XOAI data sources interfaces.
Sets
OAI-PMH allows repositories to expose an hierarchy of sets in which records may be placed. A record can be in
zero or more sets.
DSpace exposes collections and communities as sets.
Each community and collection has a corresponding OAI set, discoverable by harvesters via the ListSets verb.
The setSpec is based on the community/collection handle, with the "/" converted to underscore to form a legal
setSpec. The setSpec is prefixed by "com_" or "col_" for communities and collections, respectively (this is a
change in set names in DSpace 3.0 / OAI 2.0). For example:
col_1721.1_1234
Naturally enough, the community/collection name is also the name of the corresponding set.
Unique Identifier
Every item in OAI-PMH data repository must have an unique identifier, which must conform to the URI syntax.
As of DSpace 1.2, Handles are not used; this is because in OAI-PMH, the OAI identifier identifies the metadata
record associated with the resource. The resource is the DSpace item, whose resource identifier is the Handle.
In practical terms, using the Handle for the OAI identifier may cause problems in the future if DSpace instances
share items with the same Handles; the OAI metadata record identifiers should be different as the different
DSpace instances would need to be harvested separately and may have different metadata for the item.
The OAI identifiers that DSpace uses are of the form:
oai:PREFIX:handle
For example:
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 160 of 901
DSpace 6.x Documentation
oai:dspace.myu.edu:123456789/345
If you wish to use a different scheme, this can easily be changed by editing the value of identifier.prefix at
[dspace]/config/modules/oai.cfg file.
Access control
OAI provides no authentication/authorisation details, although these could be implemented using standard
HTTP methods. It is assumed that all access will be anonymous for the time being.
A question is, "is all metadata public?" Presently the answer to this is yes; all metadata is exposed via OAIPMH, even if the item has restricted access policies. The reasoning behind this is that people who do actually
have permission to read a restricted item should still be able to use OAI-based services to discover the content.
But, exposed data could be changed by changing the XSLT defined at [dspace]/config/crosswalks/oai
/metadataFormats.
Modification Date (OAI Date Stamp)
OAI-PMH harvesters need to know when a record has been created, changed or deleted. DSpace keeps track
of a "last modified" date for each item in the system, and this date is used for the OAI-PMH date stamp. This
means that any changes to the metadata (e.g. admins correcting a field, or a withdrawal) will be exposed to
harvesters.
"About" Information
As part of each record given out to a harvester, there is an optional, repeatable "about" section which can be
filled out in any (XML-schema conformant) way. Common uses are for provenance and rights information, and
there are schemas in use by OAI communities for this. Presently DSpace does not provide any of this
information, but XOAI core library allows its definition. This requires to dive into code and perform some
changes.
Deletions
DSpace keeps track of deletions (withdrawals). These are exposed via OAI, which has a specific mechansim for
dealing with this. Since DSpace keeps a permanent record of withdrawn items, in the OAI-PMH sense DSpace
supports deletions "persistently". This is as opposed to "transient" deletion support, which would mean that
deleted records are forgotten after a time.
Once an item has been withdrawn, OAI-PMH harvests of the date range in which the withdrawal occurred will
find the "deleted" record header. Harvests of a date range prior to the withdrawal will not find the record, despite
the fact that the record did exist at that time.
As an example of this, consider an item that was created on 2002-05-02 and withdrawn on 2002-10-06. A
request to harvest the month 2002-10 will yield the "record deleted" header. However, a harvest of the month
2002-05 will not yield the original record.
Note that presently, the deletion of "expunged" items is not exposed through OAI.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 161 of 901
DSpace 6.x Documentation
Flow Control (Resumption Tokens)
An OAI data provider can prevent any performance impact caused by harvesting by forcing a harvester to
receive data in time-separated chunks. If the data provider receives a request for a lot of data, it can send part
of the data with a resumption token. The harvester can then return later with the resumption token and continue.
DSpace supports resumption tokens for "ListRecords", "ListIdentifiers" and "ListSets" OAI-PMH requests.
Each OAI-PMH ListRecords request will return at most 100 records (by default) but it could be configured in the
[dspace]/config/crosswalks/oai/xoai.xml file.
When a resumption token is issued, the optional completeListSize and cursor attributes are included. OAI 2.0
resumption tokens are persistent, so expirationDate of the resumption token is undefined, they do not expire.
Resumption tokens contain all the state information required to continue a request and it is encoded in Base64.
4.2.2 Exchanging Content Between Repositories
Transferring Content via Export and Import
Transferring Communities, Collections, or Items using Packages
Transferring Items using Simple Archive Format
Transferring Items using OAI-ORE/OAI-PMH Harvester
Copying Items using the SWORD Client
Transferring Content via Export and Import
To migrate content from one DSpace to another, you can export content from the Source DSpace and import it
into the Destination DSpace.
Transferring Communities, Collections, or Items using Packages
Starting with DSpace 1.7, you can transfer any DSpace content (Communities, Collections or Items) from one
DSpace to another by utilizing the AIP Backup and Restore tool. This tool allows you to export content into a
series of Archival Information Packages (AIPs). These AIPs can be used to restore content (from a backup) or
move/migrate content to another DSpace installation.
For more information see AIP Backup and Restore.
Transferring Items using Simple Archive Format
Where items are to be moved between DSpace instances (for example from a test DSpace into a production
DSpace) the Item Exporter and Item Importer can be used.
First, you should export the DSpace Item(s) into the Simple Archive Format, as detailed at: Importing and
Exporting Items via Simple Archive Format. Be sure to use the --migrate option, which removes fields that
would be duplicated on import. Then import the resulting files into the other instance.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 162 of 901
DSpace 6.x Documentation
Transferring Items using OAI-ORE/OAI-PMH Harvester
If you are using the XMLUI in both DSpace instances, you may also choose to enable the OAI-ORE Harvester.
This OAI-ORE Harvester allows one DSpace installation to harvest Items (via OAI-ORE) from another DSpace
Installation (or any other system supporting OAI-ORE). Items are harvested from a remote DSpace Collection
into a local DSpace Collection. Harvesting can also be scheduled to run automatically (or by demand).
For more information see Harvesting Items from XMLUI via OAI-ORE or OAI-PMH
Copying Items using the SWORD Client
4.2.3 SWORDv1 Client
The embedded SWORD Client allows a user (currently restricted to an administrator) to copy an item to a
SWORD server. This allows your DSpace installation to deposit items into another SWORD-compliant
repository (including another DSpace install).
At present this functionality has only been developed for the XMLUI and is disabled by default.
Enabling the SWORD Client
Configuring the SWORD Client
Enabling the SWORD Client
To enable the SWORD Client uncomment the SwordClient Aspect in [dspace]/config/xmlui.xconf
file.
and a DOI to http://dx.doi.org/. Altogether, DSpace Linked Data support
spans all three Layers: the storage layer with a triple store, the business logic with classes to convert stored
contents into RDF, and the application layer with a module to publish RDF serializations. Just like DSpace
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 166 of 901
DSpace 6.x Documentation
allows you to choose Oracle or Postgresql as the relational database, you may choose between different triple
stores. The only requirements are that the triple store must support SPARQL 1.1 Query Language and
SPARQL 1.1 Graph Store HTTP Protocol which DSpace uses to store, update, delete and load converted data
in/out of the triple store and uses the triple store to provide the data over a SPARQL endpoint.
Store public data only in the triple store!
The triple store should contain only data that are public, because the DSpace access restrictions won't
affect the SPARQL endpoint. For this reason, DSpace converts only archived, discoverable (nonprivate) Items, Collections and Communities which are readable for anonymous users. Please
consider this while configuring and/or extending DSpace Linked Data support.
The org.dspace.rdf.conversion package contains the classes used to convert the repository content to RDF.
The conversion itself is done by plugins. The org.dspace.rdf.conversion.ConverterPlugin interface is really
simple, so take a look at it you if can program in Java and want to extend the conversion. The only thing
important is that plugins must only create RDF that can be made publicly available, as the triple store provides it
using a sparql endpoint for which the DSpace access restrictions do not apply. Plugins converting metadata
should check whether a specific metadata field needs to be protected or not (see org.dspace.app.util.
MetadataExposure on how to check that). The MetadataConverterPlugin is heavily configurable (see below)
and is used to convert the metadata of Items. The StaticDSOConverterPlugin can be used to add static RDF
Triples (see below). The SimpleDSORelationsConverterPlugin creates links between items and collections,
collections and communities, subcommunitites and their parents, and between top-level communities and the
information representing the repository itself.
As different repositories uses different persistent identifiers to address their content, different algorithms to
create URIs used within the converted data can be implemented. Currently HTTP(S) URIs of the repository
(called local URIs), Handles and DOIs can be used. See the configuration part of this document for further
information. If you want to add another algorithm, take a look at the org.dspace.rdf.storage.URIGenerator
interface.
Install a Triple Store
In addition to a normal DSpace installation you have to install a triple store. You can use any triple store that
supports SPARQL 1.1 Query Language and SPARQL 1.1 Graph Store HTTP Protocol. If you do not have one
yet, you can use Apache Fuseki. Download Fuseki from its official download page and unpack the downloaded
archive. The archive contains several scripts to start Fuseki. Use the start script appropriate to the OS of your
choice with the options '--localhost --config=/config/modules/rdf/fuseki-assembler.ttl'. Instead of
changing to the directory into which you unpacked Fuseki, you may set the variable FUSEKI_HOME. If you're
using Linux and bash, you unpacked Fuseki to /usr/local/jena-fuseki-1.0.1 and you installed DSpace to [dspaceinstall], this would look like this:
export FUSEKI_HOME=/usr/local/jena-fuseki-1.0.1 ; $FUSKI_HOME/fuseki-server --localhost --config
[dspace-install]/config/modules/rdf/fuseki-assembler.ttl
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 167 of 901
DSpace 6.x Documentation
Fuseki's archive contains a script to start Fuseki automatically at startup as well.
Make Fuseki connect to localhost only, by using the argument --localhost when launching if you use
the configuration provided with DSpace! The configuration contains a writeable SPARQL endpoint that
allows any connection to change/delete the content of your triple store.
Use Apache mod proxy, mod rewrite or any other appropriate web server/proxy to make localhost:3030
/dspace/sparql readable from the internet. Use the address under which it is accessible as the address
of your public sparql endpoint (see the property public.sparql.endpoint in the configuration reference
below.).
The configuration provided within DSpace makes it store the files for the triple store under [dspace-install]
/triplestore. Using this configuration, Fuseki provides three SPARQL endpoints: two read-only endpoints and
one that can be used to change the data of the triple store. You should not use this configuration if you let
Fuseki connect to the internet directly as it would make it possible for anyone to delete, change or add
information to the triple store. The option --localhost tells Fuseki to listen only on the loopback device. You can
use Apache mod_proxy or any other web or proxy server to make the read-only SPARQL endpoint accessible
from the internet. With the configuration described, Fueski listens to the port 3030 using HTTP. Using the
address http://localhost:3030/ you can connect to the Fuseki Web UI. http://localhost:3030/dspace/data
addresses a writeable SPARQL 1.1 HTTP Graph Store Protocol endpoint, and http://localhost:3030/dspace/get
a read-only one. Under http://localhost:3030/dspace/sparql a read-only SPARQL 1.1 Query Language endpoint
can be found. The first one of these endpoints must be not accessible by the internet, while the last one
should be accessible publicly.
Default configuration and what you should change
In the file [dspace-source]/dspace/config/dspace.cfg you should look for the property event.
dispatcher.default.consumers and add rdf there. Adding rdf there makes DSpace update the triple
store automatically as the publicly available content of the repository changes.
As the Linked Data support of DSpace is highly configurable this section gives a short list of things you probably
want to configure before using it. Below you can find more information on what is possible to configure.
In the file [dspace-source]/dspace/config/modules/rdf.cfg you want to configure the address of the
public sparql endpoint and the address of the writable endpoint DSpace use to connect to the triple store (the
properties rdf.public.sparql.endpoint, rdf.storage.graphstore.endpoint). In the same file you
want to configure the URL that addresses the dspace-rdf module which is depending on where you deployed it
(property rdf.contextPath) and switch content negotiation on (set property rdf.contentNegotiation.
enable = true).
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 168 of 901
DSpace 6.x Documentation
In the file [dspace-source]/dspace/config/modules/rdf/constant-data-general.ttl you
should change the links to the Web UI of the repository and the public readable SPARQL endpoint. The URL of
the public SPARQL endpoint should point to a URL that is proxied by a webserver to the Triple Store. See the
section Install a Triple Store above for further information.
In the file [dspace-source]/dspace/config/modules/rdf/constant-data-site.ttl you may add
any triples that should be added to the description of the repository itself.
If you want to change the way the metadata fields are converted, take a look into the file [dspace-source]
/dspace/config/modules/rdf/metadata-rdf-mapping.ttl. This is also the place to add information
on how to map metadata fields that you added to DSpace. There is already a quite acceptable default
configuration for the metadata fields which DSpace supports out of the box. If you want to use some specific
prefixes in RDF serializations that support prefixes, you have to edit [dspace-source]/dspace/config
/modules/rdf/metadata-prefixes.ttl.
Configuration Reference
There are several configuration files to configure DSpace's LOD support. The main configuration file can be
found under [dspace-source]/dspace/config/modules/rdf.cfg. Within DSpace we use Spring to
define which classes to load. For DSpace's LOD support this is done within [dspace-source]/dspace
/config/spring/api/rdf.xml. All other configuration files are positioned in the directory [dspacesource]/dspace/config/modules/rdf/. Configurations in rdf.cfg can be modified directly, or
overridden via your local.cfg config file (see Configuration Reference). You'll have to configure where to find
and how to connect to the triple store. You may configure how to generate URIs to be used within the generated
Linked Data and how to convert the contents stored in DSpace into RDF. We will guide you through the
configuration file by file.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 169 of 901
DSpace 6.x Documentation
[dspace-source]/dspace/config/modules/rdf.cfg
Property:
rdf.contentNegotiation.enable
Example
rdf.contentNegotiation.enable = true
Value:
Informational Defines whether content negotiation should be activated. Set this true, if you use Linked Data
Note:
support.
Property:
rdf.contextPath
Example
rdf.contextPath = ${dspace.baseUrl}/rdf
Value:
Informational The content negotiation needs to know where to refer if anyone asks for RDF serializations of
Note:
content stored within DSpace. This property sets the URL where the dspace-rdf module can
be reached on the Internet (depending on how you deployed it).
Property:
rdf.public.sparql.endpoint
Example
rdf.public.sparql.endpoint = http://${dspace.baseUrl}/sparql
Value:
Informational Address of the read-only public SPARQL endpoint supporting SPARQL 1.1 Query Language.
Note:
Property:
rdf.storage.graphstore.endpoint
Example
rdf.storage.graphstore.endpoint = http://localhost:3030/dspace/data
Value:
Informational Address of a writable SPARQL 1.1 Graph Store HTTP Protocol endpoint. This address is used
Note:
to create, update and delete converted data in the triple store. If you use Fuseki with the
configuration provided as part of DSpace 5, you can leave this as it is. If you use another
Triple Store or configure Fuseki on your own, change this property to point to a writeable
SPARQL endpoint supporting the SPARQL 1.1 Graph Store HTTP Protocol.
Property:
rdf.storage.graphstore.authentication
Example
rdf.storage.graphstore.authentication = no
Value:
Informational Defines whether to use HTTP Basic authentication to connect to the writable SPARQL 1.1
Note:
Graph Store HTTP Protocol endpoint.
Properties:
rdf.storage.graphstore.login
rdf.storage.graphstore.password
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 170 of 901
DSpace 6.x Documentation
Example
rdf.storage.graphstore.login = dspace
Values:
rdf.storage.graphstore.password =ecapsd
Informational Credentials for the HTTP Basic authentication if it is necessary to connect to the writable
Note:
SPARQL 1.1 Graph Store HTTP Protocol endpoint.
Property:
rdf.storage.sparql.endpoint
Example
rdf.storage.sparql.endpoint = http://localhost:3030/dspace/sparql
Value:
Informational Besides a writable SPARQL 1.1 Graph Store HTTP Protocol endpoint, DSpace needs a
Note:
SPARQL 1.1 Query Language endpoint, which can be read-only. This property allows you to
set an address to be used to connect to such a SPARQL endpoint. If you leave this property
empty the property ${rdf.public.sparql.endpoint} will be used instead.
Properties:
rdf.storage.sparql.authentication
rdf.storage.sparql.login
rdf.storage.sparql.password
Example
rdf.storage.sparql.authentication = yes
Values:
rdf.storage.sparql.login = dspace
rdf.storage.sparql.password = ecapsd
Informational As for the SPARQL 1.1 Graph Store HTTP Protocol you can configure DSpace to use HTTP
Note:
Basic authentication to authenticate against the (read-only) SPARQL 1.1 Query Language
endpoint.
Property:
rdf.converter.DSOtypes
Example
rdf.converter.DSOtypes = SITE, COMMUNITY, COLLECTION, ITEM
Value:
Informational Define which kind of DSpaceObjects should be converted. Bundles and Bitstreams will be
Note:
converted as part of the Item they belong to. Don't add EPersons here unless you really know
what you are doing. All converted data is stored in the triple store that provides a publicly
readable SPARQL endpoint. So all data converted into RDF is exposed publicly. Every DSO
type you add here must have an HTTP URI to be referenced in the generated RDF, which is
another reason not to add EPersons here currently.
The following properties configure the StaticDSOConverterPlugin.
Properties:
rdf.constant.data.GENERAL
rdf.constant.data.COLLECTION
rdf.constant.data.COMMUNITY
rdf.constant.data.ITEM
rdf.constant.data.SITE
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 171 of 901
DSpace 6.x Documentation
Example
rdf.constant.data.GENERAL = ${dspace.dir}/config/modules/rdf/constant-data-general.ttl
Values:
rdf.constant.data.COLLECTION = ${dspace.dir}/config/modules/rdf/constant-data-collection.ttl
rdf.constant.data.COMMUNITY = ${dspace.dir}/config/modules/rdf/constant-data-community.ttl
rdf.constant.data.ITEM = ${dspace.dir}/config/modules/rdf/constant-data-item.ttl
rdf.constant.data.SITE = ${dspace.dir}/config/modules/rdf/constant-data-site.ttl
Informational These properties define files to read static data from. These data should be in RDF, and by
Note:
default Turtle is used as serialization. The data in the file referenced by the property ${rdf.
constant.data.GENERAL} will be included in every Entity that is converted to RDF. E.g. it can
be used to point to the address of the public readable SPARQL endpoint or may contain the
name of the institution running DSpace.
The other properties define files that will be included if a DSpace Object of the specified type
(collection, community, item or site) is converted. This makes it possible to add static content
to every Item, every Collection, ...
The following properties configure the MetadataConverterPlugin.
Property:
rdf.metadata.mappings
Example
rdf.metadata.mappings = ${dspace.dir}/config/modules/rdf/metadata-rdf-mapping.ttl
Value:
Informational Defines the file that contains the mappings for the MetadataConverterPlugin. See below the
Note:
description of the configuration file [dspace-source]/dspace/config/modules/rdf/metadata-rdfmapping.ttl.
Property:
rdf.metadata.schema
Example
rdf.metadata.schema = file://${dspace.dir}/config/modules/rdf/metadata-rdf-schema.ttl
Value:
Informational Configures the URL used to load the RDF Schema of the DSpace Metadata RDF mapping
Note:
Vocabulary. Using a file:// URI makes it possible to convert DSpace content without having an
internet connection. The version of the schema has to be the right one for the used code. In
DSpace 5.0 we use the version 0.2.0. This Schema can be found here as well: http://digitalrepositories.org/ontologies/dspace-metadata-mapping/0.2.0. The newest version of the
Schema can be found here: http://digital-repositories.org/ontologies/dspace-metadatamapping/.
Property:
rdf.metadata.prefixes
Example
rdf.metadata.prefixes = ${dspace.dir}/config/modules/rdf/metadata-prefixes.ttl
Value:
Informational If you want to use prefixes in RDF serializations that support prefixes, you can define these
Note:
13-Jul-2017
prefixes in the file referenced by this property.
https://wiki.duraspace.org/display/DSDOC6x
Page 172 of 901
DSpace 6.x Documentation
The following properties configure the SimpleDSORelationsConverterPlugin
Property:
rdf.simplerelations.prefixes
Example
rdf.simplerelations.prefixes = ${dspace.dir}/config/modules/rdf/simple-relations-prefixes.ttl
Value:
Informational If you want to use prefixes in RDF serializations that support prefixes, you can define these
Note:
prefixes in the file referenced by this property.
Property:
rdf.simplerelations.site2community
Example
rdf.simplerelations.site2community = http://purl.org/dc/terms/hasPart, http://digital-repositories.
Value:
org/ontologies/dspace/0.1.0#hasCommunity
Informational Defines the predicates used to link from the data representing the whole repository to the top
Note:
level communities. Defining multiple predicates separated by commas will result in multiple
triples.
Property:
rdf.simplerelations.community2site
Example
rdf.simplerelations.community2site = http://purl.org/dc/terms/isPartOf, http://digital-repositories.
Value:
org/ontologies/dspace/0.1.0#isPartOfRepository
Informational Defines the predicates used to link from the top level communities to the data representing the
Note:
whole repository. Defining multiple predicates separated by commas will result in multiple
triples.
Property:
rdf.simplerelations.community2subcommunity
Example
rdf.simplerelations.community2subcommunity = http://purl.org/dc/terms/hasPart, http://digital-
Value:
repositories.org/ontologies/dspace/0.1.0#hasSubcommunity
Informational Defines the predicates used to link from communities to their subcommunities. Defining
Note:
multiple predicates separated by commas will result in multiple triples.
Property:
rdf.simplerelations.subcommunity2community
Example
rdf.simplerelations.subcommunity2community = http://purl.org/dc/terms/isPartOf, http://digital-
Value:
repositories.org/ontologies/dspace/0.1.0#isSubcommunityOf
Informational Defines the predicates used to link from subcommunities to the communities they belong to.
Note:
Defining multiple predicates separated by commas will result in multiple triples.
Property:
rdf.simplerelations.community2collection
Example
rdf.simplerelations.community2collection = http://purl.org/dc/terms/hasPart, http://digital-
Value:
repositories.org/ontologies/dspace/0.1.0#hasCollection
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 173 of 901
DSpace 6.x Documentation
Informational Defines the predicates used to link from communities to their collections. Defining multiple
Note:
predicates separated by commas will result in multiple triples.
Property:
rdf.simplerelations.collection2community
Example
rdf.simplerelations.collection2community = http://purl.org/dc/terms/isPartOf, http://digital-
Value:
repositories.org/ontologies/dspace/0.1.0#isPartOfCommunity
Informational Defines the predicates used to link from collections to the communities they belong to.
Note:
Defining multiple predicates separated by commas will result in multiple triples.
Property:
rdf.simplerelations.collection2item
Example
rdf.simplerelations.collection2item = http://purl.org/dc/terms/hasPart, http://digital-repositories.
Value:
org/ontologies/dspace/0.1.0#hasItem
Informational Defines the predicates used to link from collections to their items. Defining multiple predicates
Note:
separated by commas will result in multiple triples.
Property:
rdf.simplerelations.item2collection
Example
rdf.simplerelations.item2collection = http://purl.org/dc/terms/isPartOf, http://digital-repositories.
Value:
org/ontologies/dspace/0.1.0#isPartOfCollection
Informational Defines the predicates used to link from items to the collections they belong to. Defining
Note:
multiple predicates separated by commas will result in multiple triples.
Property:
rdf.simplerelations.item2bitstream
Example
rdf.simplerelations.item2bitstream = http://purl.org/dc/terms/hasPart, http://digital-repositories.
Value:
org/ontologies/dspace/0.1.0#hasBitstream
Informational Defines the predicates used to link from item to their bitstreams. Defining multiple predicates
Note:
separated by commas will result in multiple triples.
[dspace-source]/dspace/config/modules/rdf/constant-data-*.ttl
As described in the documentation of the configuration file [dspace-source]/dspace/config/modules/rdf.cfg, the
constant-data-*.ttl files can be used to add static RDF to the converted data. The data are written in Turtle, but if
you change the file suffix (and the path to find the files in rdf.cfg) you can use any other RDF serialization you
like to. You can use this, for example, to add a link to the public readable SPARQL endpoint, add a link to the
repository homepage, or add a triple to every community or collection defining it as an entity of a specific type
like a bibo:collection. The content of the file [dspace-source]/dspace/config/modules/rdf/constant-data-general.
ttl will be added to every DSpaceObject that is converted. The content of the file [dspace-source]/dspace/config
/modules/rdf/constant-data-community.ttl to every community, the content of the file [dspace-source]/dspace
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 174 of 901
DSpace 6.x Documentation
/config/modules/rdf/constant-data-collection.ttl to every collection and the content of the file [dspace-source]
/dspace/config/modules/rdf/constant-data-item.ttl to every Item. You can use the file [dspace-source]/dspace
/config/modules/rdf/constant-data-site.ttl to specify data representing the whole repository.
[dspace-source]/dspace/config/modules/rdf/metadata-rdf-mapping.ttl
This file should contain several metadata mappings. A metadata mapping defines how to map a specific
metadata field within DSpace to a triple that will be added to the converted data. The MetadataConverterPlugin
uses these metadata mappings to convert the metadata of a item into RDF. For every metadata field and value
it looks if any of the specified mappings matches. If one does, the plugin creates the specified triple and adds it
to the converted data. In the file you'll find a lot of examples on how to define such a mapping.
For every mapping a metadata field name has to be specified, e.g. dc.title, dc.identifier.uri. In addition you can
specify a condition that is matched against the field's value. The condition is specified as a regular expression
(using the syntax of the java class java.util.regex.Pattern). If a condition is defined, the mapping will be used
only on fields those values which are matched by the regex defined as condition.
The triple to create by a mapping is specified using reified RDF statements. The DSpace Metadata RDF
Mapping Vocabulary defines some placeholders that can be used. The most important placeholder is dm:
DSpaceObjectIRI which is replaced by the URI used to identify the entity being converted to RDF. That means if
a specific Item is converted the URI used to address this Item in RDF will be used instead of dm:
DSpaceObjectIRI. There are three placeholders that allow reuse of the value of a meta data field. dm:
DSpaceValue will be replace by the value as it is. dm:LiteralGenerator allows one to specify a regex and
replacement string for it (see the syntax of the java classes java.util.regex.Pattern and java.util.regex.Matcher)
and creates a Literal out of the field value using the regex and the replacement string. dm:ResourceGenerator
does the same as dm:LiteralGenerator but it generates a HTTP(S) URI that is used in place. So you can use
the resource generator to generate URIs containing modified field values (e.g. to link to classifications). If you
know regular expressions and turtle, the syntax should be quite self explanatory.
[dspace-source]/dspace/config/modules/rdf/fuseki-assembler.ttl
This is a configuration for the triple store Fuseki of the Apache Jena project. You can find more information on
the configuration it provides in the section Install a Triple Store above.
[dspace-source]/dspace/config/spring/api/rdf.xml
This file defines which classes are loaded by DSpace to provide the RDF functionality. There are two things you
might want to change: the class that is responsible to generate the URIs to be used within the converted data,
and the list of Plugins used during conversion. To change the class responsible for the URIs, change the
following line:
) within the item-submission.xml
Where to place your definitions
The ordering of definitions matters!
Structure of the Definition
Reordering/Removing/Adding Submission Steps
Assigning a custom Submission Process to a Collection
Getting A Collection's Handle
Custom Metadata-entry Pages for Submission
Introduction
Describing Custom Metadata Forms
The Structure of input-forms.xml
Adding a Collection Map
Getting A Collection's Handle
Adding a Form Set
Forms and Pages
Composition of a Field
Item type Based Metadata Collection
Automatically Omitted Fields
Configuring Controlled Vocabularies
Adding Value-Pairs
Example
Deploying Your Custom Forms
Configuring the File Upload step
Creating new Submission Steps
Creating a Non-Interactive Step
Configuring StartSubmissionLookupStep
About the Biblio-Transformation-Engine
StartSubmissionLookupStep in action!
SubmissionLookup service configuration file
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 177 of 901
DSpace 6.x Documentation
Default Submission Process
The DSpace Submission process consists of a series of "steps", where each "step" corresponds to one or more
UI pages. By default, the DSpace Submission process includes the following steps, in this order:
1. "Select Collection" step: If not already selected, the user must select a collection to deposit the Item into.
2. "Describe" step: This is where the user may enter descriptive metadata about the Item. This step may
consist of one or more pages of metadata entry. By default, there are two pages of metadata-entry. For
information on modifying the metadata entry pages, please see Custom Metadata-entry Pages for
Submission section below.
3. "Upload" step: This is where the user may upload one or more files to associate with the Item. For more
information on file upload, also see Configuring the File Upload step below.
4. "Review" step: This is where the user may review all previous information entered, and correct anything
as needed.
5. "License" step: This is where the user must agree to the repository distribution license in order to
complete the deposit. This repository distribution license is defined in the [dspace]/config
/default.license file. It can also be customized per-collection from the Collection Admin UI. If you
are using XMLUI, the default license may be formatted using Simple HTML Fragment Markup.
6. "Complete" step: The deposit is now completed. The Item will either become immediately available or
undergo a workflow approval process (depending on the Collection policies). For more information on the
workflow approval process see: Configurable Workflow.
To modify or reorganize these submission steps, just modify the [dspace]/config/item-submission.
xml file. Please see the section below on Reordering/Removing/Adding Submission Steps.
You can also choose to have different submission processes for different DSpace Collections. For more details,
please see the section below on Assigning a custom Submission Process to a Collection.
DSpace 4.0 has removed the "Initial Questions" step by default
Prior to DSpace 4.0, the "Initial Questions" step preceded all "Describe" steps. However, it was
removed by default in DSpace 4.0.
You may still choose to re-enable the "Initial Questions" step, as needed. However, please note the
warning below about the auto-assigning of Dates in the "Initial Questions" step.
Optional Steps
DSpace also ships with several optional steps which you may choose to enable if you wish. In no particular
order:
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 178 of 901
DSpace 6.x Documentation
"Access" step: This step allows the user to (optionally) modify access rights or set an embargo during the
deposit of an Item. For more information on this step, and Embargo options in general, please see the
Embargo documentation.
"CC License" step: This step allows the user to (optionally) assign a Creative Commons license to a
particular Item. Please see the Configuring Creative Commons License section of the Configuration
documentation for more details.
"Start Submission Lookup" step: This step allows the user to search or load metadata from an external
service (arXiv online, bibtex file, etc.) and prefill the submission form. For more information on enabling
and using it, please see the section on Configuring StartSubmissionLookupStep below.
"Initial Questions" step: This step asks users a simple set of "initial questions" which help to determine
which metadata fields are displayed in the "Describe" step (see above). These initial questions include:
Multiple Titles: The item has more than one title, e.g. a translated title (If selected, then users will
be asked for an alternative title in the Describe step)
Published Before: The item has been published or publicly distributed before (If selected, then
users will be asked for a publication date and publisher in the Describe step).
Initial Questions will auto-assign a publication date when "Published Before" is
unselected
Please note, if you enable Initial Questions, and your users do NOT select "Published
Before" option, then DSpace will auto-assign a publication date (dc.date.issued) to that
particular Item.
It may be entirely accurate for some types of content (e.g. for gray literature or even
theses/dissertations) to auto-assign this publication date. As such, you may wish to still
enable "Initial Questions" if your repository is mainly for previously unpublished content.
You may also choose to only enable it for specific Collections – see Assigning a custom
Submission Process to a Collection section below.
However, if the Item actually was published in some other location, this will result in an
incorrect publication date being reported by DSpace. This tendency for an incorrect
publication date has been reported by Google Scholar to DSpace developers (see: DS1481), which is why the "Initial Questions" are now disabled by default (see DS-1655).
To enable any of these optional submission steps, just uncomment the step definition within the [dspace]
/config/item-submission.xml file. Please see the section below on Reordering/Removing/Adding
Submission Steps.
You can also choose to enable certain steps only for specific DSpace Collections. For more details, please see
the section below on Assigning a custom Submission Process to a Collection.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 179 of 901
DSpace 6.x Documentation
Understanding the Submission Configuration File
The [dspace]/config/item-submission.xml contains the submission configurations for both the
DSpace JSP user interface (JSPUI) or the DSpace XML user interface (XMLUI or Manakin). This configuration
file contains detailed documentation within the file itself, which should help you better understand how to best
utilize it.
The Structure of item-submission.xml
org.dspace.submit.step.SelectCollectionStep
false
...
...
...
Because this file is in XML format, you should be familiar with XML before editing this file. By default, this file
contains the "traditional" Item Submission Process for DSpace, which consists of the following Steps (in this
order):
Select Collection -> Describe -> Upload -> Verify -> License -> Complete
If you would like to customize the steps used or the ordering of the steps, you can do so within the section of the item-submission.xml .
In addition, you may also specify different Submission Processes for different DSpace Collections. This can be
done in the section. The item-submission.xml file itself documents the syntax required to
perform these configuration changes.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 180 of 901
DSpace 6.x Documentation
Defining Steps ( ) within the item-submission.xml
This section describes how Steps of the Submission Process are defined within the item-submission.xml.
Where to place your definitions
definitions can appear in one of two places within the item-submission.xml configuration file.
1. Within the section
This is for globally defined definitions (i.e. steps which are used in multiple definitions). Steps defined in this section must define a unique id which can be used to
reference this step.
For example:
...
...
The above step definition could then be referenced from within a as simply
definition
This is for steps which are specific to a single definition.
For example:
...
The ordering of definitions matters!
The ordering of the tags within a definition directly corresponds to the order in
which those steps will appear!
For example, the following defines a Submission Process where the License step directly precedes the Initial
Questions step (more information about the structure of the information under each tag can be found in
the section on Structure of the Definition below):
submit.progressbar.license
org.dspace.submit.step.LicenseStep
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 181 of 901
DSpace 6.x Documentation
org.dspace.app.webui.submit.step.JSPLicenseStep
org.dspace.app.xmlui.aspect.submission.submit.LicenseStep
false
submit.progressbar.initial-questions
org.dspace.submit.step.InitialQuestionsStep
org.dspace.app.webui.submit.step.JSPInitialQuestionsStep
org.dspace.app.xmlui.aspect.submission.submit.InitialQuestionsStep
true
...[other steps]...
Structure of the Definition
The same definition is used by both the DSpace JSP user interface (JSPUI) an the DSpace XML user
interface (XMLUI or Manakin). Therefore, you will notice each definition contains information specific to
each of these two interfaces.
The structure of the Definition is as follows:
submit.progressbar.describe
org.dspace.submit.step.DescribeStep
org.dspace.app.webui.submit.step.JSPDescribeStep
org.dspace.app.xmlui.aspect.submission.submit.DescribeStep
true
Each step contains the following elements. The required elements are so marked:
heading: Partial I18N key (defined in Messages.properties for JSPUI or messages.xmlfor XMLUI) which
corresponds to the text that should be displayed in the submission Progress Bar for this step. This partial
I18N key is prefixed within either the Messages.properties or messages.xml file, depending on the
interface you are using. Therefore, to find the actual key, you will need to search for the partial key with
the following prefix:
XMLUI: prefix is xmlui.Submission. (e.g. "xmlui.Submission.submit.progressbar.describe" for
'Describe' step)
JSPUI: prefix is jsp. (e.g. "jsp.submit.progressbar.describe" for 'Describe' step)The 'heading' need
not be defined if the step should not appear in the progress bar (e.g. steps which perform
automated processing, i.e. non-interactive, should not appear in the progress bar).
processing-class (Required): Full Java path to the Processing Class for this Step. This Processing
Class must perform the primary processing of any information gathered in this step, for both the XMLUI
and JSPUI. All valid step processing classes must extend the abstract org.dspace.submit.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 182 of 901
DSpace 6.x Documentation
AbstractProcessingStep class (or alternatively, extend one of the pre-existing step processing
classes in org.dspace.submit.step.*)
jspui-binding: Full Java path of the JSPUI "binding" class for this Step. This "binding" class should
initialize and call the appropriate JSPs to display the step's user interface. A valid JSPUI "binding" class
must extend the abstract org.dspace.app.webui.submit.JSPStep class. This property need not
be defined if you are using the XMLUI interface, or for steps which only perform automated processing, i.
e. non-interactive steps.
xmlui-binding: Full Java path of the XMLUI "binding" class for this Step. This "binding" class should
generate the Manakin XML (DRI document) necessary to generate the step's user interface. A valid
XMLUI "binding" class must extend the abstract org.dspace.app.xmlui.submission.
AbstractSubmissionStep class. This property need not be defined if you are using the JSPUI
interface, or for steps which only perform automated processing, i.e. non-interactive steps.
workflow-editable: Defines whether or not this step can be edited during the Edit Metadata process with
the DSpace approval/rejection workflow process. Possible values include true and false. If undefined,
defaults to true (which means that workflow reviewers would be allowed to edit information gathered
during that step).
Reordering/Removing/Adding Submission Steps
The removal of existing steps and reordering of existing steps is a relatively easy process!
Reordering steps
1. Locate the tag which defines the Submission Process that you are using. If
you are unsure which Submission Process you are using, it's likely the one with name="traditional",
since this is the traditional DSpace submission process.
2. Reorder the tags within that tag. Be sure to move the entire
tag (i.e. everything between and including the opening and closing tags).
Hint #1: The defining the Review/Verify step only allows the user to review information
from steps which appear before it. So, it's likely you'd want this to appear as one of your last few
steps
Hint #2: If you are using it, the defining the Initial Questions step should always appear
before the Upload or Describe steps since it asks questions which help to set up those later
steps.
Removing one or more steps
1. Locate the tag which defines the Submission Process that you are using. If
you are unsure which Submission Process you are using, it's likely the one with name="traditional",
since this is the traditional DSpace submission process.
2. Comment out (i.e. surround with ) the tags which you want to remove from that
tag. Be sure to comment out the entire tag (i.e. everything between and
including the opening and closing tags).
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 183 of 901
2.
DSpace 6.x Documentation
Hint #1: You cannot remove the Select a Collection step, as an DSpace Item cannot exist without
belonging to a Collection.
Hint #2: If you decide to remove the defining the Initial Questions step, you should be
aware that this may affect your Describe and Upload steps! The Initial Questions step asks
questions which help to initialize these later steps. If you decide to remove the Initial Questions
step you may wish to create a custom, automated step which will provide default answers for the
questions asked!
Adding one or more optional steps
1. Locate the tag which defines the Submission Process that you are using. If
you are unsure which Submission Process you are using, it's likely the one with name="traditional",
since this is the traditional DSpace submission process.
2. Uncomment (i.e. remove the ) the tag(s) which you want to add to that
tag. Be sure to uncomment the entire tag (i.e. everything between
and including the opening and closing tags).
Assigning a custom Submission Process to a Collection
Assigning a custom submission process to a Collection in DSpace involves working with the submission-map
section of the item-submission.xml. For a review of the structure of the item-submission.xml see the section
above on Understanding the Submission Configuration File.
Each name-map element within submission-map associates a collection with the name of a submission
definition. Its collection-handle attribute is the Handle of the collection. Its submission-name attribute is the
submission definition name, which must match the name attribute of a submission-process element (in the
submission-definitions section of item-submission.xml.
For example, the following fragment shows how the collection with handle "12345.6789/42" is assigned the
"custom" submission process:
...
It's a good idea to keep the definition of the default name-map from the example input-forms.xml so there is
always a default for collections which do not have a custom form set.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 184 of 901
DSpace 6.x Documentation
Getting A Collection's Handle
You will need the handle of a collection in order to assign it a custom form set. To discover the handle, go to the
"Communities & Collections" page under "Browse" in the left-hand menu on your DSpace home page. Then,
find the link to your collection. It should look something like:
http://myhost.my.edu/dspace/handle/12345.6789/42
The underlined part of the URL is the handle. It should look familiar to any DSpace administrator. That is what
goes in the collection-handle attribute of your name-map element.
Custom Metadata-entry Pages for Submission
Introduction
This section explains how to customize the Web forms used by submitters and editors to enter and modify the
metadata for a new item. These metadata web forms are controlled by the Describe step within the Submission
Process. However, they are also configurable via their own XML configuration file ([dspace]/config/input-forms.
xml).
You can customize the "default" metadata forms used by all collections, and also create alternate sets of
metadata forms and assign them to specific collections. In creating custom metadata forms, you can choose:
The number of metadata-entry pages.
Which fields appear on each page, and their sequence.
Labels, prompts, and other text associated with each field.
List of available choices for each menu-driven field.
NOTE: The cosmetic and ergonomic details of metadata entry fields remain the same as the fixed metadata
pages in previous DSpace releases, and can only be altered by modifying the appropriate stylesheet and JSP
pages.
All of the custom metadata-entry forms for a DSpace instance are controlled by a single XML file, input-forms.
xml, in the config subdirectory under the DSpace home, [dspace]/config/input-forms.xml. DSpace comes with a
sample configuration that implements the traditional metadata-entry forms, which also serves as a welldocumented example. The rest of this section explains how to create your own sets of custom forms.
DSpace Custom Submission Form Template.ods is a workbook to facilitate creating custom submission forms.
The information below is summarized in columns. The "traditional form fields" sheet lists the default submission
fields. The "custom form fields" sheet can be used to facilitate creating a custom submission form. See the
"notes" sheet for more detail.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 185 of 901
DSpace 6.x Documentation
Describing Custom Metadata Forms
The description of a set of pages through which submitters enter their metadata is called a form (although it is
actually a set of forms, in the HTML sense of the term). A form is identified by a unique symbolic name. In the
XML structure, the form is broken down into a series of pages: each of these represents a separate Web page
for collecting metadata elements.
To set up one of your DSpace collections with customized submission forms, first you make an entry in the form-
map. This is effectively a table that relates a collection to a form set, by connecting the collection's Handle to
the form name. Collections are identified by handle because their names are mutable and not necessarily
unique, while handles are unique and persistent.
A special map entry, for the collection handle "default", defines the default form set. It applies to all collections
which are not explicitly mentioned in the map. In the example XML this form set is named traditional (for the
"traditional" DSpace user interface) but it could be named anything.
The Structure of input-forms.xml
The XML configuration file has a single top-level element, input-forms, which contains three elements in a
specific order. The outline is as follows:
<-- Map of Collections to Form Sets -->
<-- Form Set Definitions -->
...
<-- Name/Value Pairs used within Multiple Choice Widgets -->
...
...
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 186 of 901
DSpace 6.x Documentation
Adding a Collection Map
Each name-map element within form-map associates a collection with the name of a form set. Its collection-
handle attribute is the Handle of the collection, and its form-name attribute is the form set name, which must
match the name attribute of a form element.
For example, the following fragment shows how the collection with handle "12345.6789/42" is attached to the
"TechRpt" form set:
It's a good idea to keep the definition of the default name-map from the example input-forms.xml so there is
always a default for collections which do not have a custom form set.
Getting A Collection's Handle
You will need the handle of a collection in order to assign it a custom form set. To discover the handle, go to the
"Communities & Collections" page under "Browse" in the left-hand menu on your DSpace home page. Then,
find the link to your collection. It should look something like:
http://myhost.my.edu/dspace/handle/12345.6789/42
The underlined part of the URL is the handle. It should look familiar to any DSpace administrator. That is what
goes in the collection-handle attribute of your name-map element.
Adding a Form Set
You can add a new form set by creating a new form element within the form-definitions element. It has one
attribute, name, which as seen above must match the value of the name-map for the collections it is to be used
for.
Forms and Pages
The content of the form is a sequence of page elements. Each of these corresponds to a Web page of forms for
entering metadata elements, presented in sequence between the initial "Describe" page and the final "Verify"
page (which presents a summary of all the metadata collected).
A form must contain at least one and at most six pages. They are presented in the order they appear in the
XML. Each page element must include a number attribute, that should be its sequence number, e.g.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 187 of 901
DSpace 6.x Documentation
The page element, in turn, contains a sequence of field elements. Each field defines an interactive dialog where
the submitter enters one of the Dublin Core metadata items.
Composition of a Field
Each field contains the following elements, in the order indicated. The required sub-elements are so marked:
dc-schema (Required) : Name of metadata schema employed, e.g. dc for Dublin Core. This value must
match the value of the schema element defined in dublin-core-types.xml
dc-element (Required) : Name of the Dublin Core element entered in this field, e.g. contributor.
dc-qualifier: Qualifier of the Dublin Core element entered in this field, e.g. when the field is contributor.
advisor the value of this element would be advisor. Leaving this out means the input is for an unqualified
DC element.
language: If set to true a drop down menu will be shown, containing languages. The selected language
will be used as language tag of the metadata field. This feature is currently supported by JSPUI only and
only valid for fields of input-type onebox, twobox or textarea. A compulsory argument value-pairs-name
must be given containing the name of the value pair that contains all the languages: e.g. true . If the submission
configuration contains a language element and the XMLUI is used, no language is stored, even not the
default one.
repeatable: Value is true when multiple values of this field are allowed, false otherwise. When you mark
a field repeatable, the UI servlet will add a control to let the user ask for more fields to enter additional
values. Intended to be used for arbitrarily-repeating fields such as subject keywords, when it is
impossible to know in advance how many input boxes to provide.
label (Required): Text to display as the label of this field, describing what to enter, e.g. " Your Advisor's
Name".
input-type(Required): Defines the kind of interactive widget to put in the form to collect the Dublin Core
value. Content must be one of the following keywords:
onebox – A single text-entry box.
twobox – A pair of simple text-entry boxes, used for repeatable values such as the DC subject
item. Note: The 'twobox' input type is rendered the same as a 'onebox' in the XML-UI, but both
allow for ease of adding multiple values.
textarea – Large block of text that can be entered on multiple lines, e.g. for an abstract.
name – Personal name, with separate fields for family name and first name. When saved they are
appended in the format 'LastName, FirstName'
date – Calendar date. When required, demands that at least the year be entered.
series – Series/Report name and number. Separate fields are provided for series name and
series number, but they are appended (with a semicolon between) when saved.
dropdown – Choose value(s) from a "drop-down" menu list. Note: You must also include a value
for the value-pairs-name attribute to specify a list of menu entries from which to choose. Use this
to make a choice from a restricted set of options, such as for the language item.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 188 of 901
DSpace 6.x Documentation
qualdrop_value – Enter a "qualified value", which includes both a qualifier from a drop-down
menu and a free-text value. Used to enter items like alternate identifiers and codes for a submitted
item, e.g. the DC identifier field. Note: As for the dropdown type, you must include the value-pairs-
name attribute to specify a menu choice list.
list – Choose value(s) from a checkbox or radio button list. If the repeatable attribute is set to true,
a list of checkboxes is displayed. If the repeatable attribute is set to false, a list of radio buttons is
displayed. Note: You must also include a value for the value-pairs-name attribute to specify a list
of values from which to choose.
hint (Required): Content is the text that will appear as a "hint", or instructions, next to the input fields.
Can be left empty, but it must be present.
required: When this element is included with any content, it marks the field as a required input. If the
user tries to leave the page without entering a value for this field, that text is displayed as a warning
message. For example, You must enter a title. Note that leaving the required
element empty will not mark a field as required, e.g.:workflow Note that it is considered a configuration error to limit a
field's scope while also requiring it - an exception will be generated when this combination is
detected.
Look at the example input-forms.xml and experiment with a a trial custom form to learn this
specification language thoroughly. It is a very simple way to express the layout of data-entry
forms, but the only way to learn all its subtleties is to use it.
For the use of controlled vocabularies see the Configuring Controlled Vocabularies section.
Item type Based Metadata Collection
This feature is available for use with the XMLUI since DSpace 3.0 and with JSPUI since 3.1. A field can be
made visible depending on the value of dc.type. A new field element, , has been introduced to
facilitate this. In this example the field will only be visible if a value of "thesis" or "ebook" has been entered into
dc.type on an earlier page:
dc
identifier
isbn
thesis,ebook
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 189 of 901
DSpace 6.x Documentation
Automatically Omitted Fields
You may notice that some fields are automatically skipped when a custom form page is displayed, depending
on the kind of item being submitted. This is because the DSpace user-interface engine skips Dublin Core fields
which are not needed, according to the initial description of the item. For example, if the user indicates there are
no alternate titles on the first "Describe" page (the one with a few checkboxes), the input for the title.alternative
DC element is automatically omitted, even on custom submission pages.
When a user initiates a submission, DSpace first displays what we'll call the "initial-questions page". By default,
it contains three questions with check-boxes:
1. The item has more than one title, e.g. a translated title Controls title.alternative field.
2. The item has been published or publicly distributed before Controls DC fields:
date.issued
publisher
identifier.citation
3. The item consists of more than one file Does not affect any metadata input fields.
The answers to the first two questions control whether inputs for certain of the DC metadata fields will
displayed, even if they are defined as fields in a custom page. Conversely, if the metadata fields controlled by a
checkbox are not mentioned in the custom form, the checkbox is omitted from the initial page to avoid confusing
or misleading the user.
The two relevant checkbox entries are "The item has more than one title, e.g. a translated title", and "The item
has been published or publicly distributed before". The checkbox for multiple titles trigger the display of the field
with dc-element equal to "title" and dc-qualifier equal to "alternative". If the controlling collection's form set does
not contain this field, then the multiple titles question will not appear on the initial questions page.
Configuring Controlled Vocabularies
DSpace now supports controlled vocabularies to confine the set of keywords that users can use while
describing items. The need for a limited set of keywords is important since it eliminates the ambiguity of a free
description system, consequently simplifying the task of finding specific items of information. The controlled
vocabulary allows the user to choose from a defined set of keywords organised in an tree (taxonomy) and then
use these keywords to describe items while they are being submitted.
The taxonomies are described in XML following this (very simple) structure:
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 190 of 901
DSpace 6.x Documentation
...
You are free to use any application you want to create your controlled vocabularies. A simple text editor should
be enough for small projects. Bigger projects will require more complex tools. You may use Protegé to create
your taxonomies, save them as OWL and then use a XML Stylesheet (XSLT) to transform your documents to
the appropriate format. Future enhancements to this add-on should make it compatible with standard schemas
such as OWL or RDF.
New vocabularies should be placed in [dspace]/config/controlled-vocabularies/ and must be
according to the structure described.
Vocabularies need to be associated with the correspondant DC metadata fields. Edit the file [dspace]
/config/input-forms.xml and place a "vocabulary" tag under the "field" element that you want to
control. Set value of the "vocabulary" element to the name of the file that contains the vocabulary, leaving
out the extension (the add-on will only load files with extension "*.xml"). For example:
dc
subject
true
onebox
Enter appropriate subject keywords or phrases below.
srsc
The vocabulary element has an optional boolean attribute closed that can be used to force input only with the
Javascript of controlled-vocabulary add-on. The default behaviour (i.e. without this attribute) is as set closed="
false". This allow the user also to enter the value in free way.
The following vocabularies are currently available by default:
nsi - nsi.xml - The Norwegian Science Index
srsc - srsc.xml - Swedish Research Subject Categories
Adding Value-Pairs
Finally, your custom form description needs to define the "value pairs" for any fields with input types that refer to
them. Do this by adding a value-pairs element to the contents of form-value-pairs. It has the following required
attributes:
value-pairs-name – Name by which an input-type refers to this list.
dc-term – Dublin Core field for which this choice list is selecting a value.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 191 of 901
DSpace 6.x Documentation
Each value-pairs element contains a sequence of pair sub-elements, each of which in turn contains two
elements:
displayed-value – Name shown (on the web page) for the menu entry.
stored-value – Value stored in the DC element when this entry is chosen. Unlike the HTML select tag,
there is no way to indicate one of the entries should be the default, so the first entry is always the default
choice.
Example
Here is a menu of types of common identifiers:
Gov't Doc #
govdoc
URI
uri
ISBN
isbn
It generates the following HTML, which results in the menu widget below. (Note that there is no way to indicate
a default choice in the custom input XML, so it cannot generate the HTML SELECTED attribute to mark one of
the options as a pre-selected default.)
Deploying Your Custom Forms
The DSpace web application only reads your custom form definitions when it starts up, so it is important to
remember:
You must always restart Tomcat (or whatever servlet container you are using) for changes made to the
input-forms.xml file take effect.
Any mistake in the syntax or semantics of the form definitions, such as poorly formed XML or a reference to a
nonexistent field name, will cause a fatal error in the DSpace UI. The exception message (at the top of the stack
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 192 of 901
DSpace 6.x Documentation
trace in the dspace.log file) usually has a concise and helpful explanation of what went wrong. Don't forget to
stop and restart the servlet container before testing your fix to a bug.
Configuring the File Upload step
The Upload step in the DSpace submission process has two configuration options which can be set with your
[dspace]/config/dspace.cfg configuration file. They are as follows:
upload.max- The maximum size of a file (in bytes) that can be uploaded from the JSPUI (not applicable
for the XMLUI). It defaults to 536870912 bytes (512MB). You may set this to -1 to disable any file size
limitation.
Note: Increasing this value or setting to -1 does not guarantee that DSpace will be able to
successfully upload larger files via the web, as large uploads depend on many other factors
including bandwidth, web server settings, internet connection speed, etc.
webui.submit.upload.required - Whether or not all users are required to upload a file when they submit an
item to DSpace. It defaults to 'true'. When set to 'false' users will see an option to skip the upload step
when they submit a new item.
Creating new Submission Steps
First, a brief warning: Creating a new Submission Step requires some Java knowledge, and is therefore
recommended to be undertaken by a Java programmer whenever possible
That being said, at a higher level, creating a new Submission Step requires the following (in this relative order):
1. (Required) Create a new Step Processing class
This class must extend the abstract org.dspace.submit.AbstractProcessingStep class
and implement all methods defined by that abstract class.
This class should be built in such a way that it can process the input gathered from either the
XMLUI or JSPUI interface.
2. (For steps using JSPUI) Create the JSPs to display the user interface. Create a new JSPUI "binding"
class to initialize and call these JSPs.
Your JSPUI "binding" class must extend the abstract class org.dspace.app.webui.submit.
JSPStep and implement all methods defined there. It's recommended to use one of the classes in
org.dspace.app.webui.submit.step.* as a reference.
Any JSPs created should be loaded by calling the showJSP() method of the org.dspace.app.
webui.submit.JSPStepManager class
If this step gathers information to be reviewed, you must also create a Review JSP which will
display a read-only view of all data gathered during this step. The path to this JSP must be
returned by your getReviewJSP() method. You will find examples of Review JSPs (named similar
to review-[step].jsp) in the JSP submit/ directory.
3. (For steps using XMLUI) Create an XMLUI "binding" Step Transformer which will generate the DRI XML
which Manakin requires.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 193 of 901
3.
DSpace 6.x Documentation
The Step Transformer must extend and implement all necessary methods within the abstract class
org.dspace.app.xmlui.submission.AbstractSubmissionStep
It is useful to use the existing classes in org.dspace.app.xmlui.submission.submit.* as
references
4. (Required) Add a valid Step Definition to the item-submission.xmlconfiguration file.
This may also require that you add an I18N (Internationalization) key for this step's heading. See
the sections on Configuring Multilingual Support for JSPUI or Configuring Multilingual Support for
XMLUI for more details.
For more information on definitions within the item-submission.xml, see the section
above on Defining Steps () within the item-submission.xml.
Creating a Non-Interactive Step
Non-interactive steps are ones that have no user interface and only perform backend processing. You may find
a need to create non-interactive steps which perform further processing of previously entered information.
To create a non-interactive step, do the following:
1. Create the required Step Processing class, which extends the abstract org.dspace.submit.
AbstractProcessingStep class. In this class add any processing which this step will perform.
2. Add your non-interactive step to your item-submission.xml at the place where you wish this step to be
called during the submission process. For example, if you want it to be called immediately after the
existing 'Upload File' step, then place its configuration immediately after the configuration for that 'Upload
File' step. The configuration should look similar to the following:
org.dspace.submit.step.MyNonInteractiveStep
false
Note: Non-interactive steps will not appear in the Progress Bar! Therefore, your submitters will not even know
they are there. However, because they are not visible to your users, you should make sure that your noninteractive step does not take a large amount of time to finish its processing and return control to the next step
(otherwise there will be a visible time delay in the user interface).
Configuring StartSubmissionLookupStep
StartSubmissionLookupStep is a new submission step, available since DSpace 4.0 contributed by CINECA, that
extends the basic SelectCollectionStep allowing the user to search or load metadata from an external service
(arxiv online, bibtex file, etc.) and prefill the submission form. Thanks to the EKT works it is underpinned by the
Biblio Transformation Engine ( https://github.com/EKT/Biblio-Transformation-Engine ) framework.
To enable the StartSubmissionLookupStep you only need to change the configuration of the id="collection" step
to match the following
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 194 of 901
DSpace 6.x Documentation
item-submission.xml excerpt
org.dspace.submit.step.StartSubmissionLookupStep
org.dspace.app.webui.submit.step.JSPStartSubmissionLookupStep
org.dspace.app.xmlui.aspect.submission.submit.SelectCollectionStep
false
UI compatibility
The new step is available only for JSP UI. Nonetheless, if you run both UIs and want the JSP UI
benefit of the new step you can configure it as processing class also for XML as it degrades gracefully
to the standard SelectCollectionStep logic
About the Biblio-Transformation-Engine
The BTE is a Java framework developed by the Hellenic National Documentation Centre ( EKT) and consists of
programmatic APIs for filtering and modifying records that are retrieved from various types of data sources (eg.
databases, files, legacy data sources) as well as for outputting them in appropriate standards formats (eg.
database files, txt, xml, Excel). The framework includes independent abstract modules that are executed
seperately, offering in many cases alternative choices to the user depending of the input data set, the
transformation workflow that needs to be executed and the output format that needs to be generated.
The basic idea behind the BTE is a standard workflow that consists of three steps, a data loading step, a
processing step (record filtering and modification) and an output generation. A data loader provides the system
with a set of Records, the processing step is responsible for filtering or modifying these records and the output
generator outputs them in the appropriate format.
The standard BTE version offers several predefined Data Loaders as well as Output Generators for basic
bibliographic formats. However, Spring Dependency Injection can be utilized to load custom data loaders,
filters, modifiers and output generators.
StartSubmissionLookupStep in action!
When StartSubmissionLookupStep is enabled, the user comes up with the following screen when a new
submission is initiated:
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 195 of 901
DSpace 6.x Documentation
There are four accordion tabs (default configuration hides the third tab):
1) Search for identifier: In this tab, the user can search for an identifier in the supported online services
(currently, arXiv, PubMed, CrossRef and CiNii are supported). The publication results are presented in the tab
"Results" in which the user can select the publication to proceed with. This means that a new submission form
will be initiated with the form fields prefilled with metadata from the selected publication.
Currently, there are four identifiers that are supported (DOI, PubMed ID, arXiv ID and NAID (CiNii ID) ). But
these can be extended - refer to the following paragraph regarding the SubmissionLookup service configuration
file.
User can fill in any of the four identifiers. DOI is preferable. Keep in mind that the service can integrate results
for the same publication from the three different providers so filling any of the four identifiers will pretty much do
the work. If identifiers for different publications are provided, the service will return a list of publications which
will be shown to user to select. The selected publication will make it to the submission form in which some fields
will be pre-filled with the publication metadata. The mapping from the input metadata (from arXiv or Pubmed or
CrossRef or CiNii) to the DSpace metadata schema (and thus, the submission form) is configured in the Spring
XML file that is discussed later on - you can see a table at the very end of this chapter.
Through the same file, a user can also extend the providers that the SubmissionLookup service can search
publication from.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 196 of 901
DSpace 6.x Documentation
2) Upload a file: In this tab, the user can upload a file, select the type (bibtex. csv, etc.), see the publications in
the "Results" tab and then either select one to proceed with the submission or make all of them "Workspace
Items" that can be found in the "Unfinished Submissions" section in the "My DSpace" page.
The "preview mode" in the figure above has the following functionality:
"ON": The list of the publications in the uploaded file will be show to the user to select the one for the
submission. The selected publication's metadata will pre-fill the submission form's fields according to
configuration in the Spring XML configuration file.
"OFF": All the publications of the uploaded file will be imported in the user's MyDSpace page as "Unfinished
Submissions" while the first one will go thought the submission process.
(Regarding the pubmed, crossref and arxiv file upload, you can find the attached file named "sample-files.zip"
that contains samples of these three file types)
3) Free search: In this tab, the user can freely search for Title, Author and Year in the four supported providers
(PubMed, CrossRef, Arxiv and CiNii). By default, the four providers are configured to be disabled for free search
but you can enable it via the configuration file. Thus, initially this accordion tab is not shown to the user except
for a data loader is declared as a "search provider" - refer to the following paragraphs.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 197 of 901
DSpace 6.x Documentation
The process is the same as in the previous cases. A result of publications is presented to the user to select the
one to preceed with the submission.
4) Default mode submission: In this tab, the user can proceed to the default manual submission. The
SubmissionLookup service will not run and the submission form will be empty for the user to start filling it.
SubmissionLookup service configuration file
The StartSubmissionLookupStep rely on business logic provided by the SubmissionLookup service that can be
heavily extended and customized and is build on top of the BTE.
The basic idea behind BTE is that the system holds the metadata in an internal format using a specific key for
each metadata field. DataLoaders load the record using the aforementioned keys, while the output generator
needs to map these keys to DSpace metadata fields.
The BTE configuration file is located in path: [dspace]/config/spring/api/bte.xml and it's a Spring
XML configuration file that consists of Java beans. (If these terms are unknown to you, please refer to Spring
Dependency Injection web site for more information.)
The service is broken down into two phases. In the first phase, the imported publications' metadata are
converted to an intermediate format while in the second phase, the intermediate format is converted to DSpace
metadata schema
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 198 of 901
DSpace 6.x Documentation
Explanation of beans:
submit.progressbar.lookup
org.dspace.submit.step.XMLUIStartSubmissionLookupStep
org.dspace.app.xmlui.aspect.submission.submit.StartSubmissionLookupStep
true
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 206 of 901
DSpace 6.x Documentation
Features
lookup publications from remote sources
Support for multiple implementations
Abstraction of input format
The importer framework does not enforce a specific input format. Each importer implementation defines which
input format it expects from a remote source. The import framework uses generics to achieve this. Each
importer implementation will have a type set of the record type it receives from the remote source's response.
This type set will also be used by the framework to use the correct MetadataFieldMapping for a certain
implementation. Read Implementation of an import source for more information and how to enable the
framework.
Transformation to DSpace item
The framework produces an 'ImportRecord' that is completely decoupled from DSPace. It contains a set of
metadata DTO's that contain the notion of schema,element and qualifier. The specific implementation is
responsible for populating this set. It is then very simple to create a DSPace item from this list.
Relation with BTE
While there is some overlap between this framework and BTE, this framework supports some features that are
hard to implement using the BTE. It has explicit support to deal with network failure and throttling imposed by
the data source. It also has explicit support for distinguishing between network caused errors and invalid
requests to the source. Furthermore the framework doesn't impose any restrictions on the format in which the
data is retrieved. It uses java generics to support different source record types. A reference implementation of
using XML records is provided for which a set of metadata can be generated from any xpath expression (or
composite of xpath expressions). Unless 'advanced' processing is necessary (e.g. lookup of authors in an LDAP
directory) this metadata mapping can be simply configured using spring. No code changes necessary. A
mixture of advanced and simple (xpath) mapping is also possible.
This design is also in line with the roadmap to create a Modular Framework as detailed in https://wiki.duraspace.
org/display/DSPACE/Design+-+Module+Framework+and+Registry This modular design also allows it to be
completely independent of the user interface layer, be it JSPUI, XMLUI, command line or the result of the new
UI projects: https://wiki.duraspace.org/display/DSPACE/Design+-+Single+UI+Project
Implementation of an import source
Each importer implementation must at least implement interface org.dspace.importer.external.service.
components.MetadataSource and implement the inherited methods.
One can also choose to implement class org.dspace.importer.external.service.components.
AbstractRemoteMetadataSource next to the MetadataSource interface. This class contains functionality to
handle request timeouts and to retry requests.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 207 of 901
DSpace 6.x Documentation
A third option is to implement class org.dspace.importer.external.service.AbstractImportSourceService. This
class already implements both the MetadataSource interface and Source class. AbstractImportSourceService
has a generic type set 'RecordType'. In the importer implementation this type set should be the class of the
records received from the remote source's response (e.g. when using axiom to get the records from the remote
source's XML response, the importer implementation's type set isorg.apache.axiom.om.OMElement).
Implementing the AbstractImportSourceService allows the importer implementation to use the framework's buildin support to transform a record received from the remote source to an object of class * org.dspace.importer.
external.datamodel.ImportRecord containing DSpace metadata fields, as explained here: Metadata mapping.
Inherited methods
Method getImportSource() should return a unique identifier. Importer implementations should not be called
directly, but class org.dspace.importer.external.service.ImportService should be called instead. This class
contains the same methods as the importer implementations, but with an extra parameter 'url'. This url
parameter should contain the same identifier that is returned by the getImportSource() method of the importer
implementation you want to use.
The other inherited methods are used to query the remote source.
Metadata mapping
When using an implementation of AbstractImportSourceService, a mapping of remote record fields to DSpace
metadata fields can be created.
first create an implementation of class AbstractMetadataFieldMapping with the same type set used for the
importer implementation.
Then create a spring configuration file in [dspace.dir]/config/spring/api.
Each DSpace metadata field that will be used for the mapping must first be configured as a spring bean of class
org.dspace.importer.external.metadatamapping.MetadataFieldConfig.
<
bean
id
=
"dc.title"
class
=
"org.dspace.importer.external.metadatamapping.MetadataFieldConfig"
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 208 of 901
DSpace 6.x Documentation
>
<
constructor-arg
value
=
"dc.title"
/>
Now this metadata field can be used to create a mapping. To add a mapping for the "dc.title" field declared
above, a new spring bean configuration of a class class org.dspace.importer.external.metadatamapping.
contributor.MetadataContributor needs to be added. This interface contains a type argument. The type needs to
match the type used in the implementation of AbstractImportSourceService. The responsibility of each
MetadataContributor implementation is to generate a set of metadata from the retrieved document. How it does
that is completely opaque to the AbstractImportSourceService but it is assumed that only one entity (i.e. item) is
fed to the metadatum contributor.
For example java SimpleXpathMetadatumContributor implements
MetadataContributor can parse a fragment of xml and generate one or more metadata
values.
This bean expects 2 property values:
field: A reference to the configured spring bean of the DSpace metadata field. e.g. the "dc.title" bean
declared above.
query: The xpath expression used to select the record value returned by the remote source.
<
bean
id
=
"titleContrib"
class
=
"org.dspace.importer.external.metadatamapping.contributor.SimpleXpathMetadatumContributor"
>
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 209 of 901
DSpace 6.x Documentation
<
property
name
=
"field"
ref
=
"dc.title"
/>
<
property
name
=
"query"
value
=
"dc:title"
/>
Multiple record fields can also be combined into one value. To implement a combined mapping first create a
SimpleXpathMetadatumContributor as explained above for each part of the field.
<
bean
id
=
"lastNameContrib"
class
=
"org.dspace.importer.external.metadatamapping.contributor.SimpleXpathMetadatumContributor"
>
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 210 of 901
DSpace 6.x Documentation
<
property
name
=
"field"
ref
=
"dc.contributor.author"
/>
<
property
name
=
"query"
value
=
"x:authors/x:author/x:surname"
/>
<
bean
id
=
"firstNameContrib"
class
=
"org.dspace.importer.external.metadatamapping.contributor.SimpleXpathMetadatumContributor"
>
<
property
name
=
"field"
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 211 of 901
DSpace 6.x Documentation
ref
=
"dc.contributor.author"
/>
<
property
name
=
"query"
value
=
"x:authors/x:author/x:given-name"
/>
Note that namespace prefixes used in the xpath queries are configured in bean "FullprefixMapping" in the same
spring file.
<
util
:
map
id
=
"FullprefixMapping"
key-type
=
"java.lang.String"
value-type
=
"java.lang.String"
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 212 of 901
DSpace 6.x Documentation
>
<
description
>Defines the namespace mappin for the SimpleXpathMetadatum contributors
<
entry
key
=
"http://purl.org/dc/elements/1.1/"
value
=
"dc"
/>
<
entry
key
=
"http://www.w3.org/2005/Atom"
value
=
"x"
/>
Then create a new list in the spring configuration containing references to all SimpleXpathMetadatumContributor
beans that need to be combined.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 213 of 901
DSpace 6.x Documentation
<
util
:
list
id
=
"combinedauthorList"
value-type
=
"org.dspace.importer.external.metadatamapping.contributor.MetadataContributor"
list-class
=
"java.util.LinkedList"
>
<
ref
bean
=
"lastNameContrib"
/>
<
ref
bean
=
"firstNameContrib"
/>
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 214 of 901
DSpace 6.x Documentation
Finally create a spring bean configuration of classorg.dspace.importer.external.metadatamapping.contributor.
CombinedMetadatumContributor. This bean expects 3 values:
field: A reference to the configured spring bean of the DSpace metadata field. e.g. the "dc.title" bean
declared above.
metadatumContributors: A reference to the list containing all the single record field mappings that need
to be combined.
separator: These characters will be added between each record field value when they are combined into
one field.
<
bean
id
=
"authorContrib"
class
=
"org.dspace.importer.external.metadatamapping.contributor.CombinedMetadatumContributor"
>
<
property
name
=
"separator"
value
=
", "
/>
<
property
name
=
"metadatumContributors"
ref
=
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 215 of 901
DSpace 6.x Documentation
"combinedauthorList"
/>
<
property
name
=
"field"
ref
=
"dc.contributor.author"
/>
Each contributor must also be added to the "MetadataFieldMap" used by the MetadataFieldMapping
implementation. Each entry of this map maps a metadata field bean to a contributor. For the contributors
created above this results in the following configuration:
<
util
:
map
id
=
"org.dspace.importer.external.metadatamapping.MetadataFieldConfig"
value-type
=
"org.dspace.importer.external.metadatamapping.contributor.MetadataContributor"
>
<
entry
key-ref
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 216 of 901
DSpace 6.x Documentation
=
"dc.title"
value-ref
=
"titleContrib"
/>
<
entry
key-ref
=
"dc.contributor.author"
value-ref
=
"authorContrib"
/>
Note that the single field mappings used for the combined author mapping are not added to this list.
Framework Sources Implementations
PubMed Integration
Introduction
First read the base documentation on external importing This documentation explains the implementation of the
importer framework using PubMed (http://www.ncbi.nlm.nih.gov/pubmed) as an example.
Enabling PubMed Lookup (XMLUI Only)
The PubMed specific integration of the external sources import requires the following to be active.The PubMed
lookup is done during the "XMLUIStartSubmissionLookupStep" and this can be enabled by adjusting one step
in the [dspace.dir]/config/item-submission.xml. Uncommenting this step will permit the user to do
the PubMed based lookups during their submission.
item-submission.xml
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 217 of 901
DSpace 6.x Documentation
After uncommenting hat step, simply restart your servlet container, and this lookup step will be available within
your deposit process.
Publication Lookup URL
To be able to do the lookup for our configured import-service, we need to be able to know what URL to use to
check for publications. This URL the publication-lookup.url setting defined within the [dspace.dir]
/config/modules/publication-lookup.cfg. You may choose to modify this setting or override it within
your local.cfg.
This setting can be modified in one of two ways:
You can choose to specific a single, specific URL. This will tell the lookup service to only use one
location to lookup publication information. Valid URLs are any that are defined as a baseAddress for
beans within the [src]/dspace-api/src/main/resources/spring/spring-dspace-addonimport-services.xml Spring config file.
For example, this setting will ONLY use PubMed for lookups: publication-lookup.
url=http://eutils.ncbi.nlm.nih.gov/entrez/eutils/
By default, publication-lookup.url is set to an asterisk ('*'). This default value will attempt to
lookup the publication using ALL configured importServices in the [src]/dspace-api/src/main
/resources/spring/spring-dspace-addon-import-services.xml Spring config file
PubMed Metadata Mapping
The PubMed metadata mappings are defined in the [dspace.dir]/config/spring/api/pubmedintegration.xml Spring configuration file. These metadata mappings can be tweaked as desired. The
format of this file is described in the "Metadata mapping" section above
PubMed specific classes Config
These classes are simply implementations based of the base classes defined in importer/external. They add
characteristic behavior for services/mapping for the PubMed specific data.
Metadata mapping classes
"PubmedFieldMapping". An implementation of AbstractMetadataFieldMapping, linking to the bean that
serves as the entry point of other metadata mapping
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 218 of 901
DSpace 6.x Documentation
"PubmedDateMetadatumContributor"/"PubmedLanguageMetadatumContributor". Pubmed specific
implementations of the "MetadataContributor" interface
Service classes
"GeneratePubmedQueryService". Generates the pubmed query which is used to retrieve the records.
This is based on a given item.
"PubmedImportMetadataSourceServiceImpl". Child class of "AbstractImportMetadataSourceService",
retrieving the records from pubmed.
Simple HTML Fragment Markup
A few features of the XMLUI submission user interface, such as the deposit license text, can be marked up
using a subset of HTML. Only these elements may be used:
h1
h2
h3
h4
h5
p
a
b
i
u
ol
li
img
Do not try to make the content into a complete HTML document. It is just a fragment which will be textually
inserted (not framed) into a larger document.
4.3.2 Configurable Workflow
Introduction
Instructions for Enabling Configurable Reviewer Workflow in XMLUI
[dspace]/config/xmlui.xconf
[dspace]/config/spring/api/core-services.xml
[dspace]/config/spring/api/core-factory-services.xml
[dspace]/config/hibernate.cfg.xml
Data Migration
Workflowitem conversion/migration scripts
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 219 of 901
DSpace 6.x Documentation
Automatic migration
Java based migration
Configuration
Main workflow configuration
workflow-map
workflow
roles
step
Workflow actions configuration
API configuration
User Selection Action
Processing Action
User Interface configuration
Authorizations
Database
cwf_workflowitem
cwf_collectionrole
cwf_workflowitemrole
cwf_pooltask
cwf_claimtask
cwf_in_progress_user
Additional workflow steps/actions and features
Optional workflow steps: Select single reviewer workflow
Optional workflow steps: Score review workflow
Workflow overview features
Known Issues
Curation System
Existing issues
Introduction
Configurable Workflows are an optional feature that may be enabled for use only within DSpace XMLUI.
The primary focus of the workflow framework is to create a more flexible solution for the administrator to
configure, and even to allow an application developer to implement custom steps, which may be configured in
the workflow for the collection through a simple configuration file. The concept behind this approach was
modeled on the configurable submission system already present in DSpace.
For more information, see the Configurable Workflow Introductory Video
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 220 of 901
DSpace 6.x Documentation
Instructions for Enabling Configurable Reviewer Workflow in XMLUI
Please note that enabling the Configurable Reviewer Workflow makes changes to the structure of your
database that are currently irreversible in any graceful manner, so please backup your database in
advance to allow you to restore to that point should you wish to do so. It should also be noted that only
the XMLUI has been changed to cope with the database changes. The JSPUI will no longer work if the
Configurable Reviewer Workflow is enabled.
[dspace]/config/xmlui.xconf
The submission aspect has been split up into muliple aspects: one submission aspect for the submission
process, one workflow aspect containing the code for the original workflow and one xmlworkflow aspect
containing the code for the new XML configurable workflow framework. In order to enable one of the two
aspects, either the workflow or xmlworkflow aspect should be enabled in the [dspace]/config/xmlui.
xconf configuration file. This means that the xmlui.xconf configuration for the original workflow is the following:
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 224 of 901
DSpace 6.x Documentation
workflow-map
The workflow map contains a mapping between collections in DSpace and a workflow configuration. Similar to
the configuration of the submission process, the mapping can be done based on the handle of the collection.
The mapping with "default" as the value for the collection mapping, will be used for the collections not occurring
in other mapping tags. Each mapping is defined by a "name-map" tag with two attributes:
collection: can either be a collection handle or "default"
workflow: the value of this attribute points to one of the workflow configurations defined by the "workflow"
tags
workflow
The workflow element is a repeatable XML element and the configuration between two "workflow" tags
represents one workflow process. It requires the following 2 attributes:
id: a unique identifier used for the identification of the workflow and used in the workflow to collection
mapping
start: the identifier of the first step of the workflow, this will be the entry point of this workflow-process.
When a new item has been committed to a collection that uses this workflow, the step configured in the
"start" attribute will he the first step the item will go through.
roles
Each workflow process has a number of roles defined between the "roles" tags. A role represents one or more
DSpace EPersons or Groups and can be used to assign them to one or more steps in the workflow process.
One role is represented by one "role" tag and has the following attributes:
id: a unique identifier (in one workflow process) for the role
description: optional attribute to describe the role
scope: optional attribute that is used to find our group and must have one of the following values:
collection: The collection value specifies that the group will be configured at the level of the
collection. This type of groups is the same as the type that existed in the original workflow system.
In case no value is specified for the scope attribute, the workflow framework assumes the role is a
collection role.
repository: The repository scope uses groups that are defined at repository level in DSpace. The
name attribute should exactly match the name of a group in DSpace.
item: The item scope assumes that a different action in the workflow will assign a number of
EPersons or Groups to a specific workflow-item in order to perform a step. These assignees can
be different for each workflow item.
name: The name specified in the name attribute of a role will be used to lookup an eperson group in
DSpace. The lookup will depend on the scope specified in the "scope" attribute:
collection: The workflow framework will look for a group containing the name specified in the name
attribute and the ID of the collection for which this role is used.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 225 of 901
DSpace 6.x Documentation
repository: The workflow framework will look for a group with the same name as the name
specified in the name attribute
item: in case the item scope is selected, the name of the role attribute is not required
internal: optional attribute which isn't really used at the moment, false by default
step
The step element represents one step in the workflow process. A step represents a number of actions that must
be executed by one specified role. In case no role attribute is specified, the workflow framework assumes that
the DSpace system is responsible for the execution of the step and that no user interface will be available for
each of the actions in this step. The step element has the following attributes in order to further configure it:
id: The id attribute specifies a unique identifier for the step, this id will be used when configuring other
steps in order to point to this step. This identifier can also be used when configuring the start step of the
workflow item.
nextStep: This attribute specifies the step that will follow once this step has been completed under
normal circumstances. If this attribute is not set, the workflow framework will assume that this step is an
endpoint of the workflow process and will archive the item in DSpace once the step has been completed.
userSelectionMethod: This attribute defines the UserSelectionAction that will be used to determine how
to attache users to this step for a workflow-item. The value of this attribute must refer to the identifier of
an action bean in the workflow-actions.xml. Examples of the user attachment to a step are the currently
used system of a task pool or as an alternative directly assigning a user to a task.
role: optional attribute that must point to the id attribute of a role element specified for the workflow. This
role will be used to define the epersons and groups used by the userSelectionMethod.
RequiredUsers
{alternate.step.id}
Each step contains a number of actions that the workflow item will go through. In case the action has a user
interface, the users responsible for the exectution of this step will have to execute these actions before the
workflow item can proceed to the next action or the end of the step.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 226 of 901
DSpace 6.x Documentation
There is also an optional subsection that can be defined for a step part called "alternativeOutcome". This can be
used to define outcomes for the step that differ from the one specified in the nextStep attribute. Each action
returns an integer depending on the result of the action. The default value is "0" and will make the workflow item
proceed to the next action or to the end of the step.
In case an action returns a different outcome than the default "0", the alternative outcomes will be used to
lookup the next step. The alternativeOutcome element contains a number of steps, each having a status
attribute. This status attribute defines the return value of an action. The value of the element will be used to
lookup the next step the workflow item will go through in case an action returns that specified status.
Workflow actions configuration
API configuration
The workflow actions configuration is located in the [dspace]/config/spring/api/ directory and is named
"workflow-actions.xml". This configuration file describes the different Action Java classes that are used by the
workflow framework. Because the workflow framework uses Spring framework for loading these action classes,
this configuration file contains Spring configuration.
This file contains the beans for the actions and user selection methods referred to in the workflow.xml. In order
for the workflow framework to work properly, each of the required actions must be part of this configuration.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 227 of 901
DSpace 6.x Documentation
Two types of actions are configured in this Spring configuration file:
User selection action: This type of action is always the first action of a step and is responsible for the
user selection process of that step. In case a step has no role attached, no user will be selected and the
NoUserSelectionAction is used.
Processing action: This type of action is used for the actual processing of a step. Processing actions
contain the logic required to execute the required operations in each step. Multiple processing actions
can be defined in one step. These user and the workflow item will go through these actions in the order
they are specified in the workflow configuration unless an alternative outcome is returned by one of them.
User Selection Action
Each user selection action that is used in the workflow config refers to a bean definition in this workflow-actions.
xml configuration. In order to create a new user selection action bean, the following XML code is used:
This bean defines a new UserSelectionActionConfig and the following child tags:
constructor-arg: This is a constructor argument containing the ID the task. This is the same as the id
attribute of the bean and is used by the workflow config to refer to this action.
property processingAction: This tag refers the the ID of the API bean, responsible for the implementation
of the API side of this action. This bean should also be configured in this XML.
property requiresUI: In case this property is true, the workflow framework will expect a user interface for
the action. Otherwise the framework will automatically execute the action and proceed to the next one.
Processing Action
Processing actions are configured similar to the user selection actions. The only difference is that these
processing action beans are implementations of the WorkflowActionConfig class instead of the
UserSelectionActionConfig class.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 228 of 901
DSpace 6.x Documentation
User Interface configuration
The configuration file for the workflow user interface actions is located in the [dspace]/config/spring
/xmlui/ and is named "workflow-actions-xmlui.xml". BEach bean defined here has an id which is the action
identifier and the class is a classpath which links to the xmlui class responsible for generating the User Interface
side of the workflow action. Each of the class defined here must extend the org.dspace.app.xmlui.
aspect.submission.workflow.AbstractXMLUIAction class, this class contains some basic settings for
an action and has a method called addWorkflowItemInformation() which will render the given item with a
show full link so you don't have to write the same code in each of your actions if you want to display the item.
The id attribute used for the beans in the configuration must correspond to the id used in the workflow
configuration. In case an action requires a User Interface class, the workflow framework will look for a UI class
in this configuration file.
Authorizations
Currently, the authorizations are always granted and revoked based on the tasks that are available for certain
users and groups. The types of authorization policies that is granted for each of these is always the same:
READ
WRITE
ADD
DELETE
Database
The workflow uses a separate metadata schema named workflow. The fields this schema contains can be
found in the [dspace]/config/registries directory and in the file workflow-types.xml. This schema
is only used when using the score reviewing system at the moment, but one could always use this schema if
metadata is required for custom workflow steps.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 229 of 901
DSpace 6.x Documentation
The following tables have been added to the DSpace database. All tables are prefixed with 'cwf_' to avoid any
confusion with the existing workflow related database tables:
cwf_workflowitem
The cwf_workflowitem table contains the different workflowitems in the workflow. This table has the following
columns:
workflowitem_id: The identifier of the workflowitem and primary key of this table
item_id: The identifier of the DSpace item to which this workflowitem refers.
collection_id: The collection to which this workflowitem is submitted.
multiple_titles: Specifies whether the submission has multiple titles (important for submission steps)
published_before: Specifies whether the submission has been published before (important for
submission steps)
multiple_files: Specifies whether the submission has multiple files attached (important for submission
steps)
cwf_collectionrole
The cwf_collectionrole table represents a workflow role for one collection. This type of role is the same as the
roles that existed in the original workflow meaning that for each collection a separate group is defined to
described the role. The cwf_collectionrole table has the following columns:
collectionrol_id: The identifier of the collectionrole and the primaty key of this table
role_id: The identifier/name used by the workflow configuration to refer to the collectionrole
collection_id: The collection identifier for which this collectionrole has been defined
group_id: The group identifier of the group that defines the collection role
cwf_workflowitemrole
The cwf_workflowitemrole table represents roles that are defined at the level of an item. These roles are
temporary roles and only exist during the execution of the workflow for that specific item. Once the item is
archived, the workflowitemrole is deleted. Multiple rows can exist for one workflowitem with e.g. one row
containing a group and a few containing epersons. All these rows together make up the workflowitemrole The
cwf_workflowitemrole table has the following columns:
workflowitemrole_id: The identifier of the workflowitemrole and the primaty key of this table
role_id: The identifier/name used by the workflow configuration to refer to the workflowitemrole
workflowitem_id: The cwf_workflowitem identifier for which this workflowitemrole has been defined
group_id: The group identifier of the group that defines the workflowitemrole role
eperson_id: The eperson identifier of the eperson that defines the workflowitemrole role
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 230 of 901
DSpace 6.x Documentation
cwf_pooltask
The cwf_pooltask table represents the different task pools that exist for a workflowitem. These task pools can
be available at the beginning of a step and contain all the users that are allowed to claim a task in this step.
Multiple rows can exist for one task pool containing multiple groups and epersons. The cwf_pooltask table has
the following columns:
pooltask_id: The identifier of the pooltask and the primaty key of this table
workflowitem_id: The identifier of the workflowitem for which this task pool exists
workflow_id: The identifier of the workflow configuration used for this workflowitem
step_id: The identifier of the step for which this task pool was created
action_id: The identifier of the action that needs to be displayed/executed when the user selects the task
from the task pool
eperson_id: The identifier of an eperson that is part of the task pool
group_id: The identifier of a group that is part of the task pool
cwf_claimtask
The cwf_claimtask table represents a task that has been claimed by a user. Claimed tasks can be assigned to
users or can be the result of a claim from the task pool. Because a step can contain multiple actions, the
claimed task defines the action at which the user has arrived in a particular step. This makes it possible to stop
working halfway the step and continue later. The cwf_claimtask table contains the following columns:
claimtask_id: The identifier of the claimtask and the primary key of this table
workflowitem_id: The identifier of the workflowitem for which this task exists
workflow_id: The id of the workflow configuration that was used for this workflowitem
step_id: The step that is currenlty processing the workflowitem
action_id: The action that should be executed by the owner of this claimtask
owner_id: References the eperson that is responsible for the execution of this task
cwf_in_progress_user
The cwf_in_progess_user table keeps track of the different users that are performing a certain step. This table
is used because some steps might require multiple users to perform the step before the workflowitem can
proceed. The cwf_in_progress_user table contains the following columns:
in_progress_user_id: The identifier of the in progress user and the primary key of this table
workflowitem_id: The identifier of the workflowitem for which the user is performing or has performed the
step.
user_id: The identifier of the eperson that is performing or has performe the task
finished: Keeps track of the fact that the user has finished the step or is still in progress of the execution
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 231 of 901
DSpace 6.x Documentation
Additional workflow steps/actions and features
Optional workflow steps: Select single reviewer workflow
This workflow makes it possible to assign a single user to review an item. This workflow configuration skips the
task pool option meaning that the assigned reviewer no longer needs to claim the task. The configuration
consists of the following 2 steps.
AssignStep: During the assignstep, a user has the ability to select a responsible user to review the
workflowitem. This means that for each workflowitem, a different user can be selected. Because a user is
assigned, the task pool is no longer required.
ReviewStep: The start of the reviewstep is different than the typical task pool. Instead of having a task
pool, the user will be automatically assigned to the task. However, the user still has the option to reject
the task (in case he or she is not responsible for the assigned task) or review the item. In case the user
rejects the task, the workflowitem will be sent to the another step in the workflow as an alternative to the
default outcome.
Optional workflow steps: Score review workflow
The score review system allows reviewers to give the reviewed item a rating. Depending on the results of the
rating, the item will be approved to go to the next workflow step or will be sent to an alternative step. The scrore
review workflow consists of the following 2 steps.
ScoreReviewStep: The group of responsible users for the score reviewing will be able to claim the task
from the taskpool. Dependingn on the configuration, a different number of users can be required to
execute the task. This means that the task will be available in the task pool until the required number of
users has at least claimed the task. Once everyone of them has finished the task, the next (automatic)
processing step is activated.
EvaluationStep: During the evaluationstep, no user interface is required. The workflow system will
automatically execute the step that evaluates the different scores. In case the average score is more
than a configurable percentage, the item is approved, otherwise it is rejected.
Workflow overview features
A new features has been added to the XML based workflow that resembles the features available in the JSPUI
of DSpace that allows administrators to abort workflowitems. The feature added to the XMLUI allows
administrators to look at the status of the different workflowitems and look for workflowitems based on the
collection to which they have been submitted. Besides that, the administrator has the ability to permanently
delete the workflowitem or send the item back to the submitter.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 232 of 901
DSpace 6.x Documentation
Known Issues
Curation System
The DSpace 1.7 version of the curation system integration into the original DSpace workflow only exists in the
WorkflowManager.advance() method. Before advancing to the next workflow step or archiving the Item, a check
is performed to see whether any curation tasks need to be executed/scheduled. The problem is that this check
is based on the hardcoded workflow steps that exist in the original workflow. These hardcoded checks are done
in the WorkflowCurator and will need to be changed.
Existing issues
What happens with collection roles after config changes
What with workflowitems after config changes
What with undefined outcomes
Config checker
Configurable authorizations?
4.3.3 Importing and Exporting Content via Packages
Package Importer and Exporter
Supported Package Formats
Ingesting
Ingestion Modes & Options
Ingesting a Single Package
Ingesting Multiple Packages at Once
Restoring/Replacing using Packages
Default Restore Mode
Restore, Keep Existing Mode
Force Replace Mode
Disseminating
Disseminating a Single Object
Disseminating Multiple Objects at Once
Archival Information Packages (AIPs)
METS packages
Package Importer and Exporter
This command-line tool gives you access to the Packager plugins. It can ingest a package to create a new
DSpace Object (Community, Collection or Item), or disseminate a DSpace Object as a package.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 233 of 901
DSpace 6.x Documentation
To see all the options, invoke it as:
[dspace]/bin/dspace packager --help
This mode also displays a list of the names of package ingestion and dissemination plugins that are currently
installed in your DSpace. Each Packager plugin also may allow for custom options, which may provide you
more control over how a package is imported or exported. You can see a listing of all specific packager options
by invoking --help (or -h) with the --type (or -t) option:
[dspace]/bin/dspace packager --help --type METS
The above example will display the normal help message, while also listing any additional options available to
the "METS" packager plugin.
Supported Package Formats
DSpace comes with several pre-configured package ingestion and dissemination plugins, which allow you to
import/export content in a variety of formats.
Pre-Configured Submission Package (SIP) Types
AIP - Ingests content which is in the DSpace Archival Information Package (AIP) format. This is used as
part of the DSpace AIP Backup and Restore process
DSPACE-ROLES - Ingests DSpace users/groups in the DSPACE-ROLES XML Schema. This is primarily
used by the DSpace AIP Backup and Restore process to ingest/replace DSpace Users & Groups.
METS - Ingests content which is in the DSpace METS SIP format
PDF - Ingests a single PDF file (where basic metadata is extracted from the file properties in the PDF
Document).
Pre-Configured Dissemination Package (DIP) Types
AIP - Exports content which is in the DSpace Archival Information Package (AIP) format. This is used as
part of the DSpace AIP Backup and Restore process
DSPACE-ROLES - Exports DSpace users/groups in the DSPACE-ROLES XML Schema. This is
primarily used by the DSpace AIP Backup and Restore process to export DSpace Users & Groups.
METS - Exports content in the DSpace METS SIP format
For a list of all package ingestion and dissemination plugins that are currently installed in your DSpace, you can
execute:
[dspace]/bin/dspace packager --help
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 234 of 901
DSpace 6.x Documentation
Some packages ingestion and dissemination plugins also have custom options/parameters. For example, to
see a listing of the custom options for the "METS" plugin, you can execute:
[dspace]/bin/dspace packager --help --type METS
Ingesting
Ingestion Modes & Options
When ingesting packages DSpace supports several different "modes". (Please note that not all packager
plugins may support all modes of ingestion)
1. Submit/Ingest Mode (-s option, default) – submit package to DSpace in order to create a new object(s)
2. Restore Mode (-r option) – restore pre-existing object(s) in DSpace based on package(s). This also
attempts to restore all handles and relationships (parent/child objects). This is a specialized type of
"submit", where the object is created with a known Handle and known relationships.
3. Replace Mode (-r -f option) – replace existing object(s) in DSpace based on package(s). This also
attempts to restore all handles and relationships (parent/child objects). This is a specialized type of
"restore" where the contents of existing object(s) is replaced by the contents in the AIP(s). By default, if a
normal "restore" finds the object already exists, it will back out (i.e. rollback all changes) and report which
object already exists.
Ingesting a Single Package
To ingest a single package from a file, give the command:
[dspace]/bin/dspace packager -e [user-email] -p [parent-handle] -t [packager-name] /full/path/to/pa
ckage
Where [user-email] is the e-mail address of the E-Person under whose authority this runs; [parent-handle] is the
Handle of the Parent Object into which the package is ingested, [packager-name] is the plugin name of the
package ingester to use, and /full/path/to/package is the path to the file to ingest (or "-" to read from the
standard input).
Here is an example that loads a PDF file with internal metadata as a package:
[dspace]/bin/dspace packager -e admin@myu.edu -p 4321/10 -t PDF thesis.pdf
This example takes the result of retrieving a URL and ingests it:
wget -O - http://alum.mit.edu/jarandom/my-thesis.pdf | [dspace]/bin/dspace packager -e admin@myu.
edu -p 4321/10 -t PDF -
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 235 of 901
DSpace 6.x Documentation
Ingesting Multiple Packages at Once
Some Packager plugins support bulk ingest functionality using the --all (or -a) flag. When --all is used, the
packager will attempt to ingest all child packages referenced by the initial package (and continue on
recursively). Some examples follow:
For a Site-based package - this would ingest all Communities, Collections & Items based on the located
package files
For a Community-based package - this would ingest that Community and all SubCommunities,
Collections and Items based on the located package files
For a Collection - this would ingest that Collection and all contained Items based on the located package
files
For an Item – this just ingest the Item (including all Bitstreams & Bundles) based on the package file.
Here is a basic example of a bulk ingest 'packager' command template:
[dspace]/bin/dspace packager -s -a -t AIP -e -p
for example:
[dspace]/bin/dspace packager -s -a -t AIP -e admin@myu.edu -p 4321/12 collection-aip.zip
The above command will ingest the package named "collection-aip.zip" as a child of the specified Parent Object
(handle="4321/12"). The resulting object is assigned a new Handle (since -s is specified). In addition, any child
packages directly referenced by "collection-aip.zip" are also recursively ingested (a new Handle is also
assigned for each child AIP).
Not All Packagers Support Bulk Ingest
Because the packager plugin must know how to locate all child packages from an initial package file,
not all plugins can support bulk ingest. Currently, in DSpace the following Packager Plugins support
bulk ingest capabilities:
METS Packager Plugin
AIP Packager Plugin
Restoring/Replacing using Packages
Restoring is slightly different than just ingesting. When restoring, the packager makes every attempt to restore
the object as it used to be (including its handle, parent object, etc.).
There are currently three restore modes:
1.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 236 of 901
DSpace 6.x Documentation
1. Default Restore Mode (-r) = Attempt to restore object (and optionally children). Rollback all changes if
any object is found to already exist.
2. Restore, Keep Existing Mode (-r -k) = Attempt to restore object (and optionally children). If an object is
found to already exist, skip over it (and all children objects), and continue to restore all other non-existing
objects.
3. Force Replace Mode (-r -f) = Restore an object (and optionally children) and overwrite any existing
objects in DSpace. Therefore, if an object is found to already exist in DSpace, its contents are replaced
by the contents of the package. WARNING: This mode is potentially dangerous as it will permanently
destroy any object contents that do not currently exist in the package. You may want to first perform a
backup, unless you are sure you know what you are doing!
Default Restore Mode
By default, the restore mode (-r option) will rollback all changes if any object is found to already exist. The user
will be informed if which object already exists within their DSpace installation.
Use this 'packager' command template:
[dspace]/bin/dspace packager -r -t AIP -e
For example:
[dspace]/bin/dspace packager -r -t AIP -e admin@myu.edu aip4567.zip
Notice that unlike -s option (for submission/ingesting), the -r option does not require the Parent Object (-p
option) to be specified if it can be determined from the package itself.
In the above example, the package "aip4567.zip" is restored to the DSpace installation with the Handle
provided within the package itself (and added as a child of the parent object specified within the package itself).
If the object is found to already exist, all changes are rolled back (i.e. nothing is restored to DSpace)
Restore, Keep Existing Mode
When the "Keep Existing" flag (-k option) is specified, the restore will attempt to skip over any objects found to
already exist. It will report to the user that the object was found to exist (and was not modified or changed). It
will then continue to restore all objects which do not already exist. This flag is most useful when attempting a
bulk restore (using the --all (or -a) option.
One special case to note: If a Collection or Community is found to already exist, its child objects are also
skipped over. So, this mode will not auto-restore items to an existing Collection.
Here's an example of how to use this 'packager' command:
[dspace]/bin/dspace packager -r -a -k -t AIP -e
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 237 of 901
DSpace 6.x Documentation
For example:
[dspace]/bin/dspace packager -r -a -k -t AIP -e admin@myu.edu aip4567.zip
In the above example, the package "aip4567.zip" is restored to the DSpace installation with the Handle
provided within the package itself (and added as a child of the parent object specified within the package itself).
In addition, any child packages referenced by "aip4567.zip" are also recursively restored (the -a option
specifies to also restore all child pacakges). They are also restored with the Handles & Parent Objects provided
with their package. If any object is found to already exist, it is skipped over (child objects are also skipped). All
non-existing objects are restored.
Force Replace Mode
When the "Force Replace" flag (-f option) is specified, the restore will overwrite any objects found to already
exist in DSpace. In other words, existing content is deleted and then replaced by the contents of the package
(s).
Potential for Data Loss
Because this mode actually destroys existing content in DSpace, it is potentially dangerous and may
result in data loss! It is recommended to always perform a full backup (assetstore files & database)
before attempting to replace any existing object(s) in DSpace.
Here's an example of how to use this 'packager' command:
[dspace]/bin/dspace packager -r -f -t AIP -e
For example:
[dspace]/bin/dspace packager -r -f -t AIP -e admin@myu.edu aip4567.zip
In the above example, the package "aip4567.zip" is restored to the DSpace installation with the Handle
provided within the package itself (and added as a child of the parent object specified within the package itself).
In addition, any child packages referenced by "aip4567.zip" are also recursively ingested. They are also
restored with the Handles & Parent Objects provided with their package. If any object is found to already exist,
its contents are replaced by the contents of the appropriate package.
If any error occurs, the script attempts to rollback the entire replacement process.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 238 of 901
DSpace 6.x Documentation
Disseminating
Disseminating a Single Object
To disseminate a single object as a package, give the command:
[dspace]/bin/dspace packager -d -e [user-email] -i [handle] -t [packager-name] [file-path]
Where [user-email] is the e-mail address of the E-Person under whose authority this runs; [handle] is the
Handle of the Object to disseminate; [packager-name] is the plugin name of the package disseminator to use;
and [file-path] is the path to the file to create (or "-" to write to the standard output). For example:
[dspace]/bin/dspace packager -d -e admin@myu.edu -i 4321/4567 -t METS 4567.zip
The above code will export the object of the given handle (4321/4567) into a METS file named "4567.zip".
Disseminating Multiple Objects at Once
To export an object hierarchy, use the -a (or --all) package parameter.
For example, use this 'packager' command template:
[dspace]/bin/dspace packager -d -a -e [user-email] -i [handle] -t [packager-name][file-path]
for example:
[dspace]/bin/dspace packager -d -a -t METS -e admin@myu.edu -i 4321/4567 4567.zip
The above code will export the object of the given handle (4321/4567) into a METS file named "4567.zip". In
addition it would export all children objects to the same directory as the "4567.zip" file.
Archival Information Packages (AIPs)
As of DSpace 1.7, DSpace now can backup and restore all of its contents as a set of AIP Files. This includes all
Communities, Collections, Items, Groups and People in the system.
This feature came out of a requirement for DSpace to better integrate with DuraCloud (http://www.duracloud.org
), and other backup storage systems. One of these requirements is to be able to essentially "backup" local
DSpace contents into the cloud (as a type of offsite backup), and "restore" those contents at a later time.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 239 of 901
DSpace 6.x Documentation
Essentially, this means DSpace can export the entire hierarchy (i.e. bitstreams, metadata and relationships
between Communities/Collections/Items) into a relatively standard format (a METS-based, AIP format). This
entire hierarchy can also be re-imported into DSpace in the same format (essentially a restore of that content in
the same or different DSpace installation).
For more information, see the section on AIP backup & Restore for DSpace.
METS packages
Since DSpace 1.4 release, the software includes a package disseminator and matching ingester for the DSpace
METS SIP (Submission Information Package) format. They were created to help end users prepare sets of
digital resources and metadata for submission to the archive using well-defined standards such as METS,
MODS, and PREMIS. The plugin name is METS by default, and it uses MODS for descriptive metadata.
The DSpace METS SIP profile is available at: DSpaceMETSSIPProfile
4.3.4 Importing and Exporting Items via Simple Archive Format
Item Importer and Exporter
DSpace Simple Archive Format
Configuring metadata_[prefix].xml for Different Schema
Importing Items
Adding Items to a Collection from a directory
Adding Items to a Collection from a zipfile
Replacing Items in Collection
Deleting or Unimporting Items in a Collection
Other Options
UI Batch Import (JSPUI)
UI Batch Import (XMLUI)
Exporting Items
Item Importer and Exporter
DSpace has a set of command line tools for importing and exporting items in batches, using the DSpace Simple
Archive Format. Apart from the offered functionality, these tools serve as an example for users who aim to
implement their own item importer.
DSpace Simple Archive Format
The basic concept behind the DSpace's Simple Archive Format is to create an archive, which is a directory
containing one subdirectory per item. Each item directory contains a file for the item's descriptive metadata, and
the files that make up the item.
archive_directory/
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 240 of 901
DSpace 6.x Documentation
item_000/
dublin_core.xml
-- qualified Dublin Core metadata for metadata fields belonging to
the dc schema
metadata_[prefix].xml
-- metadata in another schema, the prefix is the name of the
schema as registered with the metadata registry
contents
-- text file containing one line per filename
collections
-- text file that contains the handles of the collections the
item will belong two. Optional. Each handle in a row.
-- Collection in first line will be the owning collection
file_1.doc
-- files to be added as bitstreams to the item
file_2.pdf
item_001/
dublin_core.xml
contents
file_1.png
...
The dublin_core.xml or metadata_[prefix].xml file has the following format, where each metadata
element has it's own entry within a tagset. There are currently three tag attributes available in the
tagset:
- the Dublin Core element
- the element's qualifier
- (optional)ISO language code for element
A Tale of Two Cities
1990
J'aime les Printemps<
/dcvalue>
(Note the optional language tag attribute which notifies the system that the optional title is in French.)
Every metadata field used, must be registered via the metadata registry of the DSpace instance first, see
Metadata and Bitstream Format Registries.
Recommended Metadata
It is recommended to minimally provide "dc.title" and, where applicable, "dc.date.issued". Obviously
you can (and should) provide much more detailed metadata about the Item. For more information see:
Metadata Recommendations.
The contents file simply enumerates, one file per line, the bitstream file names. See the following example:
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 241 of 901
DSpace 6.x Documentation
file_1.doc
file_2.pdf
license
Please notice that the license is optional, and if you wish to have one included, you can place the file in the ...
/item_001/ directory, for example.
The bitstream name may optionally be followed by any of the following:
\tbundle:BUNDLENAME
\tpermissions:PERMISSIONS
\tdescription:DESCRIPTION
\tprimary:true
Where '\t' is the tab character.
'BUNDLENAME' is the name of the bundle to which the bitstream should be added. Without specifying the
bundle, items will go into the default bundle, ORIGINAL.
'PERMISSIONS' is text with the following format: -[r|w] 'group name'
'DESCRIPTION' is text of the files description.
Primary is used to specify the primary bitstream.
Configuring metadata_[prefix].xml for Different Schema
It is possible to use other Schema such as EAD, VRA Core, etc. Make sure you have defined the new scheme
in the DSpace Metada Schema Registry.
1. Create a separate file for the other schema named metadata_[prefix].xml, where the [prefix] is
replaced with the schema's prefix.
2. Inside the xml file use the dame Dublin Core syntax, but on the element include the
attribute schema=[prefix].
3. Here is an example for ETD metadata, which would be in the file metadata_etd.xml:
Computer Science
Masters
Michigan Institute of Technology
Importing Items
Before running the item importer over items previously exported from a DSpace instance, please first refer to
Transferring Items Between DSpace Instances.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 242 of 901
DSpace 6.x Documentation
Command used:
[dspace]/bin/dspace import
Java class:
org.dspace.app.itemimport.ItemImport
Arguments short and (long) forms:
Description
-a or --add
Add items to DSpace ‡
-r or --replace
Replace items listed in mapfile ‡
-d or --delete
Delete items listed in mapfile ‡
-s or --source
Source of the items (directory)
-c or --collection
Destination Collection by their Handle or database ID
-m or --mapfile
Where the mapfile for items can be found (name and directory)
-e or --eperson
Email of eperson doing the importing
-w or --workflow
Send submission through collection's workflow
-n or --notify
Kicks off the email alerting of the item(s) has(have) been imported
-t or --test
Test run‚ do not actually import items
-p or --template
Apply the collection template
-R or --resume
Resume a failed import (Used on Add only)
-h or --help
Command help
-z or --zip
Name of zipfile
‡ These are mutually exclusive.
The item importer is able to batch import unlimited numbers of items for a particular collection using a very
simple CLI command and 'arguments'
Adding Items to a Collection from a directory
To add items to a collection, you gather the following information:
eperson
Collection ID (either Handle (e.g. 123456789/14) or Database ID (e.g. 2)
Source directory where the items reside
Mapfile. Since you don't have one, you need to determine where it will be (e.g. /Import/Col_14/mapfile)
At the command line:
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 243 of 901
DSpace 6.x Documentation
[dspace]/bin/dspace import --add --eperson=joe@user.com --collection=CollectionID -source=items_dir --mapfile=mapfile
or by using the short form:
[dspace]/bin/dspace import -a -e joe@user.com -c CollectionID -s items_dir -m mapfile
The above command would cycle through the archive directory's items, import them, and then generate a map
file which stores the mapping of item directories to item handles. SAVE THIS MAP FILE. Using the map file you
can use it for replacing or deleting (unimporting) the file.
Testing. You can add --test (or -t) to the command to simulate the entire import process without actually
doing the import. This is extremely useful for verifying your import files before doing the actual import.
Adding Items to a Collection from a zipfile
To add items to a collection, you gather the following information:
eperson
Collection ID (either Handle (e.g. 123456789/14) or Database ID (e.g. 2)
Source directory where your zipfile containing the items resides
Zipfile
Mapfile. Since you don't have one, you need to determine where it will be (e.g. /Import/Col_14/mapfile)
At the command line:
[dspace]/bin/dspace import --add --eperson=joe@user.com --collection=CollectionID -source=items_dir --zip=filename.zip --mapfile=mapfile
or by using the short form:
[dspace]/bin/dspace import -a -e joe@user.com -c CollectionID -s items_dir -z filename.zip -m
mapfile
The above command would unpack the zipfile, cycle through the archive directory's items, import them, and
then generate a map file which stores the mapping of item directories to item handles. SAVE THIS MAP FILE.
Using the map file you can use it for replacing or deleting (unimporting) the file.
Testing. You can add --test (or -t) to the command to simulate the entire import process without actually
doing the import. This is extremely useful for verifying your import files before doing the actual import.
Replacing Items in Collection
Replacing existing items is relatively easy. Remember that mapfile you were supposed to save? Now you will
use it. The command (in short form):
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 244 of 901
DSpace 6.x Documentation
[dspace]/bin/dspace import -r -e joe@user.com -c collectionID -s items_dir -m mapfile
Long form:
[dspace]/bin/dspace import --replace --eperson=joe@user.com --collection=collectionID -source=items_dire --mapfile=mapfile
Deleting or Unimporting Items in a Collection
You are able to unimport or delete items provided you have the mapfile. Remember that mapfile you were
supposed to save? The command is (in short form):
[dspace]/bin/dspace import -e joe@user.com -d -m mapfile
In long form:
[dspace]/bin/dspace import --eperson=joe@user.com --delete --mapfile mapfile
Other Options
Workflow. The importer usually bypasses any workflow assigned to a collection. But add the -workflow (-w) argument will route the imported items through the workflow system.
Templates. If you have templates that have constant data and you wish to apply that data during batch
importing, add the --template (-p) argument.
Resume. If, during importing, you have an error and the import is aborted, you can use the --resume (R) flag that you can try to resume the import where you left off after you fix the error.
Specifying the owning collection on a per-item basis from the command line administration tool
If you omit the -c flag, which is otherwise mandatory, the ItemImporter searches for a file named
"collections" in each item directory. This file should contain a list of collections, one per line, specified
either by their handle, or by their internal db id. The ItemImporter then will put the item in each of the
specified collections. The owning collection is the collection specified in the first line of the collections file.
If both the -c flag is specified and the collections file exists in the item directory, the ItemImporter will
ignore the collections file and will put the item in the collection specified on the command line.
Since the collections file can differ between item directories, this gives you more fine-grained control of
the process of batch adding items to collections.
Importing with BTE
The DSpaceOutputGenerator, which writes the metadata into the DSpace Simple Archive Format, has
been updated to produce the collections file, if a metadata field named "collections" (reserved word)
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 245 of 901
DSpace 6.x Documentation
exists in the original metadata. This is mainly applicable to the CSV input format which is more flexible,
but could also be implemented with a Modifier that adds the "collections" field to each Record in the BTE
pipeline.
Important note: an entry with the "collections" key should be in the output map that is used by the
DSpaceOutputGenerator.
More info in Importing Items via basic bibliographic formats (Endnote, BibTex, RIS, TSV, CSV) and
online services (OAI, arXiv, PubMed, CrossRef, CiNii).
UI Batch Import (JSPUI)
Batch import can also take place via the Administrator's UI. The steps to follow are:
A. Prepare the data
1. Items, i.e. the metadata and their bitstreams, must be in the Simple Archive Format describer earlier in
this chapter. Thus, for each item there must be a separate directory that contains the corresponding files
of the specific item.
2. Moreover, in each item directory, there can be another file that describes the collection or the collections
that this item will be added to. The name of this file must be "collections" and it is optional. It has the
following format:
Each line contains the handle of the collection. The collection in the first line is the owning collection
while the rest are the other collection the item should belong to.
3. Compress the item directories into a zip file. Please note that you need to zip the actual item directories
and not just the directory that contains the item directories. Thus, the final zip file must directly contain
the item directories.
4. Place the zip file in a public domain URL, like Dropbox or Google Drive or wherever you have access to
do so. Since such a zip file can be very big in size, the batch import UI needs the URL to download it for
a public location rather than just upload it and get a timeout exception
B. Import the items via the UI
1. Login as an administrator
2. Find the menu on the top right of the page, and select the "Administer" option
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 246 of 901
DSpace 6.x Documentation
3. Select the "Batch Import" option from the "Content" drop down menu on the top of the page
4. Fill in the form that appears as follows:
Field #1: select the type of the input data that you want to batch import. Be sure to select "Simple Archive
Format" in this drop down menu
Field #2: Copy/Paste the public URL where the zip file mentioned earlier is located
Filed #3: Select the owning collection of the items you are importing. This field is optional meaning that if
you leave it empty, you are supposed to include per item collection information (via the "collections" file
mentioned before) in the Simple Archive Format
Field #4: Select the other collections the item will belong to. You can select more than one collection by
just holding down the Ctrl key on your keyboard. If you select the owning collection in this multiselect
input control, it will be ignored at the very end.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 247 of 901
DSpace 6.x Documentation
Comments:
1) If you select an owning collection from this form, then the "collections" file that may be included in the item
will be ignored.
2) If you do not specify an owning collection, and for some items no "collections" file exists in the item directory,
then the item will not be imported in DSpace
Finally, when you submit the form you will receive a message informing you that the import process is being
executed in the background (since it may take long). At the end, you will receive a success or failure email (to
the email address of your DSpace account) informing you of the status of the import.
C. View past batch imports (that have be done via the UI)
1. Login
2. Visit "My DSpace" page
3.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 248 of 901
DSpace 6.x Documentation
3. On the next page, you can see the history of batch imports. For each import, the following information is
available:
The status of the batch import (success or failure)
The number of items that the user tried to import
The number of items that were actually imported
Moreover, the user can take the following actions:
Download the map file that was produced during the import. This file contains a list of items that were
imported with the corresponding handle assigned to them by DSpace.
Delete the imported items. Everything that was imported will be deleted (including the history directory in
the "[dspace]/import" directory)
In case of failure, the user can "Resume" the import. The user is taken to the upload form again, but the
system recognizes the initial import (and the map file) in order to resume the old import. There is a red
label in the form that informs the user about the "Resume" form.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 249 of 901
DSpace 6.x Documentation
UI Batch Import (XMLUI)
A SimpleArchiveFormat package can be imported by an administrator in XMLUI. The SimpleArchiveFormat
package needs to be compressed into a ZIP file, and it be will be uploaded to XMLUI through the browser.
DSpace will then process that ZIP, and ingest items into DSpace. A stable network connection is
recommended, as your browser will need to upload a potentially large ZIP file, and then wait while DSpace
processes that ZIP file.
While logged in as an administrator, click on Batch Import (ZIP):
Then, choose the owning collection from the collection dropdown, and browse to the ZIP file on your computer
that has the SimpleArchiveFormat ZIP file.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 250 of 901
DSpace 6.x Documentation
If successful, you will get a green message with a list of handles that were imported. It is what is considered the
"map file".
If an error occurred, you will get a red error message with the issue:
Exporting Items
The item exporter can export a single item or a collection of items, and creates a DSpace simple archive in the
aforementioned format for each exported item. The items are exported in a sequential order in which they are
retrieved from the database. As a consequence, the sequence numbers of the item subdirectories (item_000,
item_001) are not related to DSpace handle or item ids.
Command
[dspace]/bin/dspace export
used:
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 251 of 901
DSpace 6.x Documentation
Java class:
org.dspace.app.itemexport.ItemExport
Arguments
Description
short and
(long) forms:
-t or --
Type of export. COLLECTION will inform the program you want the whole collection. ITEM will
type
be only the specific item. (You will actually key in the keywords in all caps. See examples
below.)
-i or --id
The ID or Handle of the Collection or Item to export.
-d or --
The destination path where you want the file of items to be placed.
dest
-n or --
Sequence number to begin export the items with. Whatever number you give, this will be the
number
name of the first directory created for your export. The layout of the export directory is the
same as the layout used for import.
-m or --
Export the item/collection for migration. This will remove the handle and metadata that will be
migrate
re-created in the new instance of DSpace.
-x or --
Do not export bitstreams, see the usage scenario below.
excludebitstreams
-h or --
Brief Help.
help
Exporting a Collection
The CLI command to export the items of a collection:
[dspace]/bin/dspace export --type=COLLECTION --id=collectionID_or_handle --dest=/path/to
/destination --number=seq_num
Short form:
[dspace]/bin/dspace export -t COLLECTION -i collectionID_or_handle -d /path/to/destination -n
seq_num
Exporting a Single Item
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 252 of 901
DSpace 6.x Documentation
The keyword COLLECTION means that you intend to export an entire collection. The ID can either be the
database ID or the handle. The exporter will begin numbering the simple archives with the sequence number
that you supply. To export a single item use the keyword ITEM and give the item ID as an argument:
[dspace]/bin/dspace export --type=ITEM --id=itemID_or_handle --dest=/path/to/destination -number=seq_num
Short form:
[dspace]/bin/dspace export -t ITEM -i itemID_or_handle -d /path/to/destination -n seq_num
Each exported item will have an additional file in its directory, named "handle". This will contain the handle that
was assigned to the item, and this file will be read by the importer so that items exported and then imported to
another machine will retain the item's original handle.
The -m Argument
Using the -m argument will export the item/collection and also perform the migration step. It will perform the
same process that the next section Exchanging Content Between Repositories performs. We recommend that
section to be read in conjunction with this flag being used.
The -x Argument
Using the -x argument will do the standard export except for the bitstreams which will not be exported. If you
have full SAF without bitstreams and you have the bitstreams archive (which might have been imported into
DSpace earlier) somewhere near, you could symlink original archive files into SAF directories and have an
exported collection which almost doesn't occupy any space but otherwise is identical to the exported collection
(i.e. could be imported into DSpace). In case of huge collections -x mode might be substantially faster than full
export.
4.3.5 Registering Bitstreams via Simple Archive Format
Overview
Accessible Storage
Registering Items Using the Item Importer
Internal Identification and Retrieval of Registered Items
Exporting Registered Items
Deleting Registered Items
Registering is not Importing
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 253 of 901
DSpace 6.x Documentation
The procedures below will not import the actual bitstreams into DSpace. They will merely inform
DSpace of an existing location where these Bitstreams can be found. Please refer to Importing and
Exporting Items via Simple Archive Format for information on importing metadata and bitstreams.
Overview
Registration is an alternate means of incorporating items, their metadata, and their bitstreams into DSpace by
taking advantage of the bitstreams already being in storage accessible to DSpace. An example might be that
there is a repository for existing digital assets. Rather than using the normal interactive ingest process or the
batch import to furnish DSpace the metadata and to upload bitstreams, registration provides DSpace the
metadata and the location of the bitstreams. DSpace uses a variation of the import tool to accomplish
registration.
Accessible Storage
To register an item its bitstreams must reside on storage accessible to DSpace and therefore referenced by an
asset store number in dspace.cfg. The configuration file dspace.cfg establishes one or more asset stores
through the use of an integer asset store number. This number relates to a directory in the DSpace host's file
system or a set of SRB account parameters. This asset store number is described in The dspace.cfg
Configuration Properties File section and in the dspace.cfg file itself. The asset store number(s) used for
registered items should generally not be the value of the assetstore.incoming property since it is unlikely that
you will want to mix the bitstreams of normally ingested and imported items and registered items.
Registering Items Using the Item Importer
DSpace uses the same import tool that is used for batch import except that several variations are employed to
support registration. The discussion that follows assumes familiarity with the import tool.
The DSpace Simple Archive Format for registration does not include the actual content files (bitstreams) being
registered. The format is however a directory full of items to be registered, with a subdirectory per item. Each
item directory contains a file for the item's descriptive metadata (dublin_core.xml) and a file listing the item's
content files (contents), but not the actual content files themselves.
The dublin_core.xml file for item registration is exactly the same as for regular item import.
The contents file, like that for regular item import, lists the item's content files, one content file per line, but each
line has the one of the following formats:
-r
-r
-r
-r
-s
-s
-s
-s
n
n
n
n
-f
-f
-f
-f
filepath
filepath\tbundle:bundlename
filepath\tbundle:bundlename\tpermissions: -[r|w] 'group name'
filepath\tbundle:bundlename\tpermissions: -[r|w] 'group
name'\tdescription: some text
where
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 254 of 901
DSpace 6.x Documentation
-r indicates this is a file to be registered
-s n indicates the asset store number (n)
-f filepath indicates the path and name of the content file to be registered (filepath)
\t is a tab character
bundle:bundlename is an optional bundle name
permissions: -[r|w] 'group name' is an optional read or write permission that can be attached
to the bitstream
description: some text is an optional description field to add to the file
The bundle, that is everything after the filepath, is optional and is normally not used.
The command line for registration is just like the one for regular import:
[dspace]/bin/dspace import -a -e joe@user.com -c collectionID -s items_dir -m mapfile
(or by using the long form)
[dspace]/bin/dspace import --add --eperson=joe@user.com --collection=collectionID -source=items_dir --map=mapfile
The --workflow and --test flags will function as described in Importing Items.
The --delete flag will function as described in Importing Items but the registered content files will not be
removed from storage. See Deleting Registered Items.
The --replace flag will function as described in Importing Items but care should be taken to consider different
cases and implications. With old items and new items being registered or ingested normally, there are four
combinations or cases to consider. Foremost, an old registered item deleted from DSpace using --replace
will not be removed from the storage. See Deleting Registered Items. where is resides. A new item added to
DSpace using --replace will be ingested normally or will be registered depending on whether or not it is
marked in the contents files with the -r.
Internal Identification and Retrieval of Registered Items
Once an item has been registered, superficially it is indistinguishable from items ingested interactively or by
batch import. But internally there are some differences:
First, the randomly generated internal ID is not used because DSpace does not control the file path and name
of the bitstream. Instead, the file path and name are that specified in the contents file.
Second, the store_number column of the bitstream database row contains the asset store number specified in
the contents file.
Third, the internal_id column of the bitstream database row contains a leading flag (-R) followed by the
registered file path and name. For example, -Rfilepath where filepath is the file path and name relative to
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 255 of 901
DSpace 6.x Documentation
the asset store corresponding to the asset store number. The asset store could be traditional storage in the
DSpace server's file system or an SRB account.
Fourth, an MD5 checksum is calculated by reading the registered file if it is in local storage.
Registered items and their bitstreams can be retrieved transparently just like normally ingested items.
Exporting Registered Items
Registered items may be exported as described in Exporting Items. If so, the export directory will contain actual
copies of the files being exported but the lines in the contents file will flag the files as registered. This means
that if DSpace items are "round tripped" (see Transferring Items Between DSpace Instances) using the exporter
and importer, the registered files in the export directory will again registered in DSpace instead of being
uploaded and ingested normally.
Deleting Registered Items
If a registered item is deleted from DSpace, (either interactively or by using the --delete or --replace flags
described in Importing and Exporting Items via Simple Archive Format) the item will disappear from DSpace but
its registered content files will remain in place just as they were prior to registration. Bitstreams not registered
but added by DSpace as part of registration, such as license.txt files, will be deleted.
4.3.6 Importing Items via basic bibliographic formats (Endnote,
BibTex, RIS, TSV, CSV) and online services (OAI, arXiv, PubMed,
CrossRef, CiNii)
These facilities were developed separately for JSPUI and XMLUI.
Using JSPUI
About the Biblio-Transformation-Engine (BTE)
BTE in DSpace
BTE Configuration
UI for administrators
Case Studies
Using XMLUI
Introduction
Features
Abstraction of input format
Transformation to DSpace item
Relation with BTE
Implementation of an import source
Inherited methods
Metadata mapping
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 256 of 901
DSpace 6.x Documentation
Deprecated
According to the discussion in DS-2876-Framework to better support metadata import from external
sourcesClosed, DSpace 6 is very likely the last version where imports through BTE are supported. In
future versions, it is likely that 2016 Framework for live import from external sources will be extended
to match and exceed all functionality offered by BTE enabled imports.
Using JSPUI
This functionality is an extension of that provided by Importing and Exporting Items via Simple Archive
Format so please read that section before continuing. It is underpinned by the Biblio Transformation
Engine (https://github.com/EKT/Biblio-Transformation-Engine )
About the Biblio-Transformation-Engine (BTE)
The BTE is a Java framework developed by the Hellenic National Documentation Centre (EKT, www.ekt.gr )
and consists of programmatic APIs for filtering and modifying records that are retrieved from various types of
data sources (eg. databases, files, legacy data sources) as well as for outputing them in appropriate standards
formats (eg. database files, txt, xml, Excel). The framework includes independent abstract modules that are
executed seperately, offering in many cases alternative choices to the user depending of the input data set, the
transformation workflow that needs to be executed and the output format that needs to be generated.
The basic idea behind the BTE is a standard workflow that consists of three steps, a data loading step, a
processing step (record filtering and modification) and an output generation. A data loader provides the system
with a set of Records, the processing step is responsible for filtering or modifying these records and the output
generator outputs them in the appropriate format.
The standard BTE version offers several predefined Data Loaders as well as Output Generators for basic
bibliographic formats. However, Spring Dependency Injection can be utilized to load custom data loaders,
filters, modifiers and output generators.
BTE in DSpace
The functionality of batch importing items in DSpace using the BTE has been incorporated in the
"import" script already used in DSpace for years.
In the import script, there is a new option (option "-b") to import using the BTE and an option -i to declare the
type of the input format. All the other options are the same apart from option "-s" that in this case points to a file
(and not a directory as it used to) that is the file of the input data. However, in the case of batch BTE import, the
option "-s" is not obligatory since you can configure the input from the Spring XML configuration file discussed
later on. Keep in mind, that if option "-s" is defined, import will take that option into consideration instead of the
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 257 of 901
DSpace 6.x Documentation
one defined in the Spring XML configuration.
Thus, to import metadata from the various input formats use the following commands:
Input
Command
BibTeX
[dspace]/bin/dspace import -b -m mapFile -e example@email.com -c
(*.bib)
123456789/1 -s path-to-my-bibtex-file -i bibtex
CSV (*.
[dspace]/bin/dspace import -b -m mapFile -e example@email.com -c
csv)
123456789/1 -s path-to-my-csv-file -i csv
TSV (*.
[dspace]/bin/dspace import -b -m mapFile -e example@email.com -c
tsv)
123456789/1 -s path-to-my-tsv-file -i tsv
RIS (*.
[dspace]/bin/dspace import -b -m mapFile -e example@email.com -c
ris)
123456789/1 -s path-to-my-ris-file -i ris
EndNote
[dspace]/bin/dspace import -b -m mapFile -e example@email.com -c
123456789/1 -s path-to-my-endnote-file -i endnote
OAI-PMH
[dspace]/bin/dspace import -b -m mapFile -e example@email.com -c
123456789/1 -s path-to-my-oai-file -i oai
arXiv
[dspace]/bin/dspace import -b -m mapFile -e example@email.com -c
123456789/1 -s path-to-my-arxiv-file -i arxivXML
PubMed
[dspace]/bin/dspace import -b -m mapFile -e example@email.com -c
123456789/1 -s path-to-my-pubmed-file -i pubmedXML
CrossRef [dspace]/bin/dspace import -b -m mapFile -e example@email.com -c
123456789/1 -s path-to-my-crossref-file -i crossrefXML
CiNii
[dspace]/bin/dspace import -b -m mapFile -e example@email.com -c
123456789/1 -s path-to-my-crossref-file -i ciniifXML
Keep in mind that the value of the "-e" option must be a valid email of a DSpace user and value of the "-c"
option must be the target collection handle. Attached, you can find a .zip file ( sample-files.zip) that includes
examples of the file formats that are mentioned above.
BTE Configuration
The basic idea behind BTE is that the system holds the metadata in an internal format using a specific key for
each metadata field. DataLoaders load the record using the aforementioned keys, while the output generator
needs to map these keys to DSpace metadata fields.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 258 of 901
DSpace 6.x Documentation
The BTE configuration file is located in path: [dspace]/config/spring/api/bte.xml and it's a Spring
XML configuration file that consists of Java beans. (If these terms are unknown to you, please refer to Spring
Dependency Injection web site for more information.)
Explanation of beans:
You can add as many filters and modifiers you like to batchImportLinearWorkflow , they will run the one after
the other in the specified order.
Using XMLUI
Introduction
Features
Abstraction of input format
Transformation to DSpace item
Relation with BTE
Implementation of an import source
Inherited methods
Metadata mapping
Introduction
This documentation explains the features and the usage of the importer framework.
Features
Look up publications from remote sources.
Support for multiple implementations.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 263 of 901
DSpace 6.x Documentation
Abstraction of input format
The importer framework does not enforce a specific input format. Each importer implementation defines which
input format it expects from a remote source. The import framework uses generics to achieve this. Each
importer implementation will have a type set of the record type it receives from the remote source's response.
This type set will also be used by the framework to use the correct MetadataFieldMapping for a certain
implementation. Read Implementation of an import source for more information.
Transformation to DSpace item
The framework produces an 'ImportRecord' that is completely decoupled from DSPace. It contains a set of
metadata DTO's that contain the notion of schema,element and qualifier. The specific implementation is
responsible for populating this set. It is then very simple to create a DSPace item from this list.
Relation with BTE
While there is some overlap between this framework and BTE, this framework supports some features that are
hard to implement using the BTE. It has explicit support to deal with network failure and throttling imposed by
the data source. It also has explicit support for distinguishing between network caused errors and invalid
requests to the source. Furthermore the framework doesn't impose any restrictions on the format in which the
data is retrieved. It uses java generics to support different source record types. A reference implementation of
using XML records is provided for which a set of metadata can be generated from any xpath expression (or
composite of xpath expressions). Unless 'advanced' processing is necessary (e.g. lookup of authors in an LDAP
directory) this metadata mapping can be simply configured using spring. No code changes necessary. A
mixture of advanced and simple (xpath) mapping is also possible.
This design is also in line with the roadmap to create a Modular Framework as detailed in https://wiki.duraspace.
org/display/DSPACE/Design+-+Module+Framework+and+Registry This modular design also allows it to be
completely independent of the user interface layer, be it JSPUI, XMLUI, command line or the result of the new
UI projects: https://wiki.duraspace.org/display/DSPACE/Design+-+Single+UI+Project
Implementation of an import source
Each importer implementation must at least implement interface org.dspace.importer.external.service.other.
Imports and implement the inherited methods.
One can also choose to implement class org.dspace.importer.external.service.other.Source next to the Imports
interface. This class contains functionality to handle request timeouts and to retry requests.
A third option is to implement class org.dspace.importer.external.service.AbstractImportSourceService. This
class already implements both the Imports interface and Source class. AbstractImportSourceService has a
generic type set 'RecordType'. In the importer implementation this type set should be the class of the records
received from the remote source's response (e.g. when using axiom to get the records from the remote source's
XML response, the importer implementation's type set is org.apache.axiom.om.OMElement).
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 264 of 901
DSpace 6.x Documentation
Implementing the AbstractImportSourceService allows the importer implementation to use the framework's buildin support to transform a record received from the remote source to an object of class org.dspace.importer.
external.datamodel.ImportRecord containing DSpace metadata fields, as explained here: Metadata mapping.
Inherited methods
Method getImportSource() should return a unique identifier. Importer implementations should not be called
directly, but class org.dspace.importer.external.service.ImportService should be called instead. This class
contains the same methods as the importer implementatons, but with an extra parameter 'url'. This url
parameter should contain the same identifier that is returned by the getImportSource() method of the importer
implementation you want to use.
The other inherited methods are used to query the remote source.
Metadata mapping
When using an implementation of AbstractImportSourceService, a mapping of remote record fields to DSpace
metadata fields can be created. First create an implementation of class AbstractMetadataFieldMapping with the
same type set used for the importer implementation. Then create a Spring configuration file in [dspace.dir]/config
/spring/api. Each DSpace metadata field that will be used for the mapping must first be configured as a spring
bean of class org.dspace.importer.external.metadatamapping.MetadataFieldConfig.
Now this metadata field can be used to create a mapping. To add a mapping for the "dc.title" field declared
above, a new spring bean configuration of a class class org.dspace.importer.external.metadatamapping.
contributor.MetadataContributor needs to be added. This interface contains a type argument. The type needs to
match the type used in the implementation of AbstractImportSourceService. The responsibility of each
MetadataContributor implementation is to generate a set of metadata from the retrieved document. How it does
that is completely opaque to the AbstractImportSourceService but it is assumed that only one entity (i.e. item) is
fed to the metadatum contributor.
For example java SimpleXpathMetadatumContributor implements
MetadataContributor can parse a fragment of xml and generate one or more metadata
values.
This bean expects 2 property values:
field: A reference to the configured spring bean of the DSpace metadata field. e.g. the "dc.title" bean
declared above.
query: The xpath expression used to select the record value returned by the remote source.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 265 of 901
DSpace 6.x Documentation
Multiple record fields can also be combined into one value. To implement a combined mapping first create a
SimpleXpathMetadatumContributor as explained above for each part of the field.
Note that namespace prefixes used in the xpath queries are configured in bean "FullprefixMapping" in the same
spring file.
Defines the namespace mappin for the SimpleXpathMetadatum contributors
Then create a new list in the spring configuration containing references to all SimpleXpathMetadatumContributor
beans that need to be combined.
Finally create a Spring bean configuration of class org.dspace.importer.external.metadatamapping.contributor.
CombinedMetadatumContributor. This bean expects 3 values:
field: A reference to the configured spring bean of the DSpace metadata field. e.g. the "dc.title" bean
declared above.
metadatumContributors: A reference to the list containing all the single record field mappings that need
to be combined.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 266 of 901
DSpace 6.x Documentation
separator: These characters will be added between each record field value when they are combined into
one field.
Each contributor must also be added to the "MetadataFieldMap" used by the MetadataFieldMapping
implementation. Each entry of this map maps a metadata field bean to a contributor. For the contributors
created above this results in the following configuration:
Note that the single field mappings used for the combined author mapping are not added to this list.
4.3.7 Importing Community and Collection Hierarchy
Community and Collection Structure Importer
Usage
XML Import Format
Limitations
Community and Collection Structure Importer
This Command-Line tool gives you the ability to import a community and collection structure directory from a
source XML file.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 267 of 901
DSpace 6.x Documentation
Usage
Command used:
[dspace]/bin/dspace structure-builder
Java class:
org.dspace.administer.StructBuilder
Argument: short and long (if available) forms:
Description of the argument
-f
Source xml file.
-o
Output xml file.
-e
Email of DSpace Administrator.
XML Import Format
The administrator need to build the source xml document in the following format:
Community Name
Descriptive text
Introductory text
Special copyright notice
Sidebar text
Sub Community Name
...[ad infinitum]...
Collection Name
Descriptive text
Introductory text
Special copyright notice
Sidebar text
Special licence
Provenance information
The resulting output document will be as follows:
Community Name
Descriptive text
Introductory text
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 268 of 901
DSpace 6.x Documentation
Special copyright notice
Sidebar text
Sub Community Name
...[ad infinitum]...
Collection Name
Descriptive text
Introductory text
Special copyright notice
Sidebar text
Special licence
Provenance information
This command-line tool gives you the ability to import a community and collection structure directly from a
source XML file. It is executed as follows:
[dspace]/bin/dspace structure-builder -f /path/to/source.xml -o path/to/output.xml -e admin@user.
com
This will examine the contents of source.xml, import the structure into DSpace while logged in as the supplied
administrator, and then output the same structure to the output file, but including the handle for each imported
community and collection as an attribute.
Limitations
Currently this does not export community and collection structures, although it should only be a small
modification to make it do so
4.3.8 SWORDv1 Server
SWORD (Simple Web-service Offering Repository Deposit) is a protocol that allows the remote deposit of items
into repositories. DSpace implements the SWORD protocol via the 'sword' web application. The version of
SWORD v1 currently supported by DSpace is 1.3. The specification and further information can be found at
http://swordapp.org.
SWORD is based on the Atom Publish Protocol and allows service documents to be requested which describe
the structure of the repository, and packages to be deposited.
Enabling SWORD Server
Configuring SWORD Server
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 269 of 901
DSpace 6.x Documentation
Deposit to SWORD Server
Enabling SWORD Server
To enable DSpace's SWORD server, just make sure the [dspace]/webapps/sword/ web application is
available from your Servlet Container (usually Tomcat).
Configuring SWORD Server
These are the SWORD (v1) configurations. They may be edited directly or overridden in your local.cfg config
(see Configuration Reference).
Configuration
[dspace]/config/modules/sword-server.cfg
File:
Property:
sword-server.mets-ingester.package-ingester
Example
sword-server.mets-ingester.package-ingester = METS
Value:
Informational
The property key tell the SWORD METS implementation which package ingester to use to
Note:
install deposited content. This should refer to one of the classes configured for:
plugin.named.org.dspace.content.packager.PackageIngester
The value of sword.mets-ingester.package-ingester tells the system which named plugin for
this interface should be used to ingest SWORD METS packages.
Properties:
mets.default.ingest.crosswalk.EPDCX
mets.default.ingest.crosswalk.*
(NOTE: These configs are in the dspace.cfg file as they are used by many interfaces)
Example
mets.submission.crosswalk.EPDCX = EPDCX
Value:
Informational
Define the metadata types which can be accepted/handled by SWORD during ingest of a
Note:
package. Currently, EPDCX (EPrints DC XML) is the recommended default metadata
format, but others are supported.
Property:
crosswalk.submission.EPDCX.stylesheet
(NOTE: This configuration is in the dspace.cfg file)
Example
crosswalk.submission.EPDCX.stylesheet = crosswalks/sword-swap-
Value:
ingest.xsl
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 270 of 901
DSpace 6.x Documentation
Configuration
[dspace]/config/modules/sword-server.cfg
File:
Informational
Define the stylesheet which will be used by the self-named XSLTIngestionCrosswalk class
Note:
when asked to load the SWORD configuration (as specified above). This will use the
specified stylesheet to crosswalk the incoming SWAP metadata to the DIM format for
ingestion.
Property:
sword-server.deposit.url
Example
Value:
sword-server.deposit.url = http://www.myu.ac.uk/sword/deposit
Informational
The base URL of the SWORD deposit. This is the URL from which DSpace will construct
Note:
the deposit location URLs for collections. The default is ${dspace.baseUrl}/sword
/deposit (where dspace.baseUrl is defined in your dspace.cfg file). In the event that
you are not deploying DSpace as the ROOT application in the servlet container, this will
generate incorrect URLs, and you should override the functionality by specifying in full as
shown in the example value.
Property:
sword-server.servicedocument.url
Example
Value:
sword-server.servicedocument.url = http://www.myu.ac.uk/sword/servicedocument
Informational
The base URL of the SWORD service document. This is the URL from which DSpace will
Note:
construct the service document location URLs for the site, and for individual collections. The
default is ${dspace.baseUrl}/sword/servicedocument (where dspace.baseUrl is
defined in your dspace.cfg file). In the event that you are not deploying DSpace as the
ROOT application in the servlet container, this will generate incorrect URLs, and you should
override the functionality by specifying in full as shown in the example value.
Property:
sword-server.media-link.url
Example
Value:
sword-server.media-link.url = http://www.myu.ac.uk/sword/media-link
Informational
The base URL of the SWORD media links. This is the URL which DSpace will use to
Note:
construct the media link URLs for items which are deposited via sword. The default is
${dspace.baseUrl}/sword/media-link (where dspace.baseUrl is defined in your
dspace.cfg file). In the event that you are not deploying DSpace as the ROOT application
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 271 of 901
DSpace 6.x Documentation
Configuration
[dspace]/config/modules/sword-server.cfg
File:
in the servlet container, this will generate incorrect URLs, and you should override the
functionality by specifying in full as shown in the example value.
Property:
sword-server.generator.url
Example
Value:
sword-server.generator.url = http://www.dspace.org/ns/sword/1.3.1
Informational
The URL which identifies the SWORD software which provides the sword interface. This is
Note:
the URL which DSpace will use to fill out the atom:generator element of its atom
documents. The default is: http://www.dspace.org/ns/sword/1.3.1
If you have modified your SWORD software, you should change this URI to identify your
own version. If you are using the standard 'dspace-sword' module you will not, in general,
need to change this setting.
Property:
sword-server.updated.field
Example
sword-server.updated.field = dc.date.updated
Value:
Informational
The metadata field in which to store the updated date for items deposited via SWORD.
Note:
Property:
sword-server.slug.field
Example
sword-server.slug.field = dc.identifier.slug
Value:
Informational
The metadata field in which to store the value of the slug header if it is supplied.
Note:
Properties:
sword-server.accept-packaging.METSDSpaceSIP.identifier
sword-server.accept-packaging.METSDSpaceSIP.q
Example
Value:
13-Jul-2017
sword-server.accept-packaging.METSDSpaceSIP.identifier = http://purl.org/net
/sword-types/METSDSpaceSIP
sword-server.accept-packaging.METSDSpaceSIP.q = 1.0
https://wiki.duraspace.org/display/DSDOC6x
Page 272 of 901
DSpace 6.x Documentation
Configuration
[dspace]/config/modules/sword-server.cfg
File:
Informational
The accept packaging properties, along with their associated quality values where
Note:
appropriate. This is a Global Setting; these will be used on all DSpace collections
Property:
sword-server.accepts
Example
sword-server.accepts = application/zip, foo/bar
Value:
Informational
A comma separated list of MIME types that SWORD will accept.
Note:
Properties:
sword-server.accept-packaging.[handle].METSDSpaceSIP.identifier
sword-server.accept-packaging.[handle].METSDSpaceSIP.q
Example
Value:
Informational
sword-server.accept-packaging.[handle].METSDSpaceSIP.identifier = http://purl.org
/net/sword-types/METSDSpaceSIP
sword-server.accept-packaging.[handle].METSDSpaceSIP.q = 1.0
Collection Specific settings: these will be used on the collections with the given handles.
Note:
Property:
sword-server.expose-items
Example
sword-server.expose-items = false
Value:
Informational
Should the server offer up items in collections as sword deposit targets. This will be effected
Note:
by placing a URI in the collection description which will list all the allowed items for the
depositing user in that collection on request. NOTE: this will require an implementation of
deposit onto items, which will not be forthcoming for a short while.
Property:
sword-server.expose-communities
Example
sword-server.expose-communities = false
Value:
Informational
Should the server offer as the default the list of all Communities to a Service Document
Note:
request. If false, the server will offer the list of all collections, which is the default and
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 273 of 901
DSpace 6.x Documentation
Configuration
[dspace]/config/modules/sword-server.cfg
File:
recommended behavior at this stage. NOTE: a service document for Communities will not
offer any viable deposit targets, and the client will need to request the list of Collections in
the target before deposit can continue.
Property:
sword-server.max-upload-size
Example
sword-server.max-upload-size = 0
Value:
Informational
The maximum upload size of a package through the sword interface, in bytes. This will be
Note:
the combined size of all the files, the metadata and any manifest data. It is NOT the same
as the maximum size set for an individual file upload through the user interface. If not set, or
set to 0, the sword service will default to no limit.
Property:
sword-server.keep-original-package
Example
sword-server.keep-original-package = true
Value:
Informational
Whether or not DSpace should store a copy of the original sword deposit package. NOTE:
Note:
this will cause the deposit process to run slightly slower, and will accelerate the rate at
which the repository consumes disk space. BUT, it will also mean that the deposited
packages are recoverable in their original form. It is strongly recommended, therefore, to
leave this option turned on. When set to "true", this requires that the configuration option
upload.temp.dir (in dspace.cfg) is set to a valid location.
Property:
sword-server.bundle.name
Example
sword-server.bundle.name = SWORD
Value:
Informational
The bundle name that SWORD should store incoming packages under if sword.keep-
Note:
original-package is set to true. The default is "SWORD" if not value is set
Properties:
sword-server.keep-package-on-fail
sword-server.failed-package.dir
Example
Value:
sword-server.keep-package-on-fail=true
sword-server.failed-package.dir=${dspace.dir}/upload
Informational
In the event of package ingest failure, provide an option to store the package on the file
Note:
system. The default is false.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 274 of 901
DSpace 6.x Documentation
Configuration
[dspace]/config/modules/sword-server.cfg
File:
Property:
sword-server.identify-version
Example
sword-server.identify-version = true
Value:
Informational
Should the server identify the sword version in a deposit response. It is recommended to
Note:
leave this unchanged.
Property:
sword-server.on-behalf-of.enable
Example
sword-server.on-behalf-of.enable = true
Value:
Informational
Should mediated deposit via sword be supported. If enabled, this will allow users to deposit
Note:
content packages on behalf of other users.
Property:
sword-server.restore-mode.enable
Example
sword-server.restore-mode.enable = true
Value:
Informational
Should the sword server enable restore-mode when ingesting new packages. If this is
Note:
enabled the item will be treated as a previously deleted item from the repository. If the item
had previously been assigned a handle then that same handle will be restored to activity. If
that item had not been previously assign a handle, then a new handle will be assigned.
Property:
plugin.named.org.dspace.sword.SWORDingester
Example
Value:
plugin.named.org.dspace.sword.SWORDIngester = \
org.dspace.sword.SWORDMETSIngester = http://purl.org/net/sword-types
/METSDSpaceSIP \
org.dspace.sword.SimpleFileIngester = SimpleFileIngester
Informational
Configure the plugins to process incoming packages. The form of this configuration is as per
Note:
the Plugin Manager's Named Plugin documentation: plugin.named.[interface] =
[implementation] = [package format identifier] (see dspace.cfg).
Package ingesters should implement the SWORDIngester interface, and will be loaded
when a package of the format specified above in: sword-server.accept-packaging.
[package format].identifier = [package format identifier] is received. In
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 275 of 901
DSpace 6.x Documentation
Configuration
[dspace]/config/modules/sword-server.cfg
File:
the event that this is a simple file deposit, with no package format, then the class named by
"SimpleFileIngester" will be loaded and executed where appropriate. This case will only
occur when a single file is being deposited into an existing DSpace Item.
Deposit to SWORD Server
If you'd like to deposit content to your repository via the installed SWORD Server, you'll need to select a
SWORD Client to do so.
A variety of SWORDv1 Clients (in various languages/tools) are available off of http://swordapp.org/swordv1/
The DSpace XMLUI also comes with an optional SWORDv1 Client which can be enabled to deposit
content from one DSpace to another.
Finally, it's also possible to simply deposit a valid SWORD Zip package via common Linux commandline
tools (e.g. curl). For example:
# Deposit a SWORD Zip package named "sword-package.zip" into a DSpace Collection (Handle 1234
56789/2) as user "test@dspace.org"
# (Please note that you WILL need to obviously modify the Collection location, user/password
and name of the SWORD package)
curl -i --data-binary "@sword-package.zip" -H "Content-Disposition:filename=sword-package.
zip" -H "Content-Type:application/zip" -H "X-Packaging:http://purl.org/net/sword-types
/METSDSpaceSIP" -u test@dspace.org:[password] http://[dspace.url]/sword/deposit/123456789/2
# Template 'curl' command:
#curl -i --data-binary "@[zip-package-name]" -H "Content-Disposition:filename=[zip-packagename]" -H "Content-Type:application/zip" -H "X-Packaging:http://purl.org/net/sword-types
/METSDSpaceSIP" -u [user]:[password] http://[dspace.url]/sword/deposit/[collection-handle]
4.3.9 SWORDv2 Server
SWORD (Simple Web-service Offering Repository Deposit) is a protocol that allows the remote deposit of items
into repositories. DSpace implements the SWORD protocol via the 'sword' web application. The specification
and further information can be found at http://swordapp.org/.
SWORD is based on the Atom Publish Protocol and allows service documents to be requested which describe
the structure of the repository, and packages to be deposited.
Enabling SWORD v2 Server
Configuring SWORD v2 Server
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 276 of 901
DSpace 6.x Documentation
Enabling SWORD v2 Server
To enable DSpace's SWORD v2 server, just make sure the [dspace]/webapps/swordv2/ web application
is available from your Servlet Container (usually Tomcat).
Configuring SWORD v2 Server
These are the SWORD (v2) configurations. They may be edited directly or overridden in your local.cfg config
(see Configuration Reference).
Configuration
[dspace]/config/modules/swordv2-server.cfg
File:
Property:
swordv2-server.url
Example
Value:
Informational
swordv2-server.url = http://www.myu.ac.uk/swordv2
The base url of the SWORD 2.0 system. This defaults to ${dspace.baseUrl}/swordv2 (where dspace
Note:
Property:
swordv2-server.collection.url
Example
Value:
swordv2-server.collection.url = http://www.myu.ac.uk/swordv2/collection
Informational
The base URL of the SWORD collection. This is the URL from which DSpace will construct the deposit loca
Note:
${dspace.baseUrl}/swordv2/collection (where dspace.baseUrl is defined in your dspace.cfg
Property:
swordv2-server.servicedocument.url
Example
Value:
swordv2-server.servicedocument.url = http://www.myu.ac.uk/swordv2/servicedocument
Informational
The service document URL of the SWORD collection. The base URL of the SWORD service document. Thi
Note:
service document location urls for the site, and for individual collections. This defaults to ${dspace.baseU
dspace.baseUrl is defined in your dspace.cfg file).
Property:
13-Jul-2017
swordv2-server.accept-packaging.collection
https://wiki.duraspace.org/display/DSDOC6x
Page 277 of 901
DSpace 6.x Documentation
Configuration
[dspace]/config/modules/swordv2-server.cfg
File:
Example
Value:
Informational
swordv2-server.accept-packaging.collection.METSDSpaceSIP = http://purl.org/net/sword/package/METS
swordv2-server.accept-packaging.collection.SimpleZip = http://purl.org/net/sword/package/SimpleZi
swordv2-server.accept-packaging.collection.Binary = http://purl.org/net/sword/package/Binary
The accept packaging properties, along with their associated quality values where appropriate.
Note:
Property:
swordv2-server.accept-packaging.item
Example
Value:
swordv2-server.accept-packaging.item.METSDSpaceSIP = http://purl.org/net/sword/package/METSDSpace
swordv2-server.accept-packaging.item.SimpleZip = http://purl.org/net/sword/package/SimpleZip
swordv2-server.accept-packaging.item.Binary = http://purl.org/net/sword/package/Binary
Informational
The accept packaging properties for items. It is possible to configure this for specific collections by adding th
Note:
example swordv2-server.accept-packaging.collection.[handle].METSDSpaceSIP = http:
/METSDSpaceSIP
Property:
swordv2-server.accepts
Example
Value:
Informational
swordv2-server.accepts = application/zip, image/jpeg
A comma-separated list of MIME types that SWORD will accept. To accept all mimetypes, the value can be
Note:
Property:
swordv2-server.expose-communities
Example
Value:
swordv2-server.expose-communities = false
Informational
Whether or not the server should expose a list of all the communities to a service document request. As dep
Note:
recommended to leave this set to false.
Property:
swordv2-server.max-upload-size
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 278 of 901
DSpace 6.x Documentation
Configuration
[dspace]/config/modules/swordv2-server.cfg
File:
Example
Value:
swordv2-server.max-upload-size = 0
Informational
The maximum upload size of a package through the SWORD interface (measured in bytes). This will be the
Note:
manifest file in a package - this is different to the maximum size of a single bitstream.
If this is set to 0, no maximum file size will be enforced.
Property:
swordv2-server.keep-original-package
Example
Value:
Informational
swordv2-server.keep-original-package = true
Should DSpace store a copy of the orignal SWORD deposit package?
Note:
This will cause the deposit process to be slightly slower and for more disk to be used, however original files
option enabled.
Property:
swordv2-server.bundle.name
Example
Value:
Informational
swordv2-server.bundle.name = SWORD
The bundle name that SWORD should store incoming packages within if swordv2-server.keep-origi
Note:
Property:
swordv2-server.bundle.deleted
Example
Value:
swordv2-server.bundle.deleted = DELETED
Informational
The bundle name that SWORD should use to store deleted bitstreams if swordv2-server.versions.ke
Note:
individual files are updated or removed via SWORD. If the entire Media Resource (files in the ORIGINAL bu
entirety in a bundle of its own
Property:
13-Jul-2017
swordv2-server.keep-package-on-fail
https://wiki.duraspace.org/display/DSDOC6x
Page 279 of 901
DSpace 6.x Documentation
Configuration
[dspace]/config/modules/swordv2-server.cfg
File:
Example
Value:
swordv2-server.keep-package-on-fail = false
Informational
In the event of package ingest failure, provide an option to store the package on the file system. The default
Note:
swordv2-server.failed-package-dir setting.
Property:
swordv2-server.failed-package-dir
Example
Value:
Informational
swordv2-server.failed-package-dir = /dspace/upload
If swordv2-server.keep-package-on-fail is set to true, this is the location where the package would
Note:
Property:
swordv2-server.on-behalf-of.enable
Example
Value:
Informational
swordv2-server.on-behalf-of.enable = true
Should DSpace accept mediated deposits? See the SWORD specification for a detailed explanation of depo
Note:
Property:
swordv2-server.on-behalf-of.update.mediators
Example
Value:
swordv2-server.on-behalf-of.update.mediators = admin@mydspace.edu, mediator@myd
Informational
Which user accounts are allowed to do updates on items which already exist in DSpace, on-behalf-of other
Note:
If this is left blank, or omitted, then all accounts can mediate updates to items, which could be a security risk
authenticated user is a "legitimate" mediator
Property:
swordv2-server.verbose-description.receipt.enable
Example
Value:
13-Jul-2017
swordv2-server.verbose-description.receipt.enable = false
https://wiki.duraspace.org/display/DSDOC6x
Page 280 of 901
DSpace 6.x Documentation
Configuration
[dspace]/config/modules/swordv2-server.cfg
File:
Informational
Should the deposit receipt include a verbose description of the deposit? For use by developers - recommen
Note:
Property:
swordv2-server.verbose-description.error.enable
Example
Value:
swordv2-server.verbose-description.error.enable = true
Informational
should the error document include a verbose description of the error? For use by developers, although you
Note:
production systems
Property:
swordv2-server.error.alternate.url
Example
Value:
swordv2-server.error.alternate.url = http://mydspace.edu/xmlui/contact
Informational
The error document can contain an alternate url, which the client can use to follow up any issues. For exam
Note:
XMLUI
Property:
swordv2-server.error.alternate.content-type
Example
Value:
swordv2-server.error.alternate.content-type = text/html
Informational
The swordv2-server.error.alternate.url may have an associated content type, such as text/ht
Note:
indicate to the client what content type it can expect if it follows that url.
Property:
swordv2-server.generator.url
Example
Value:
Informational
swordv2-server.generator.url = http://www.dspace.org/ns/sword/2.0/
The URL which identifies DSpace as the software that is providing the SWORD interface.
Note:
Property:
13-Jul-2017
swordv2-server.generator.version
https://wiki.duraspace.org/display/DSDOC6x
Page 281 of 901
DSpace 6.x Documentation
Configuration
[dspace]/config/modules/swordv2-server.cfg
File:
Example
Value:
Informational
swordv2-server.generator.version = 2.0
The version of the SWORD interface.
Note:
Property:
swordv2-server.auth-type
Example
Value:
Informational
swordv2-server.auth-type = Basic
Which form of authentication to use. Normally this is set to Basic in order to use HTTP Basic.
Note:
Property:
swordv2-server.upload.tempdir
Example
Value:
Informational
swordv2-server.upload.tempd = /dspace/upload
The location where uploaded files and packages are stored while being processed.
Note:
Property:
swordv2-server.updated.field
Example
Value:
Informational
swordv2-server.updated.field = dc.date.updated
The metadata field in which to store the updated date for items deposited via SWORD.
Note:
Property:
swordv2-server.slug.field
Example
Value:
Informational
swordv2-server.slug.field = dc.identifier.slug
The metadata field in which to store the value of the slug header if it is supplied.
Note:
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 282 of 901
DSpace 6.x Documentation
Configuration
[dspace]/config/modules/swordv2-server.cfg
File:
Property:
swordv2-server.author.field
Example
Value:
Informational
swordv2-server.author.field = dc.contributor.author
The metadata field in which to store the value of the atom entry author if it supplied.
Note:
Property:
swordv2-server.title.field
Example
Value:
Informational
swordv2-server.title.field = dc.title
The metadata field in which to store the value of the atom entry title if it supplied.
Note:
Property:
swordv2-server.disseminate-packaging
Example
Value:
Informational
swordv2-server.disseminate-packaging.METSDSpaceSIP = http://purl.org/net/sword/package/METSDSpace
swordv2-server.disseminate-packaging.SimpleZip = http://purl.org/net/sword/package/SimpleZip
Supported packaging formats for the dissemination of packages.
Note:
Property:
swordv2-server.statement.bundles
Example
Value:
swordv2-server.statement.bundles = ORIGINAL, SWORD, LICENSE
Informational
Which bundles should the Statement include in its list of aggregated resources? The Statement will automa
Note:
identified by the ${bundle.name} property, provided that bundle is also listed here (i.e. if you want Origina
should add the SWORD bundle to this list)
Property:
plugin.single.org.dspace.sword2.WorkflowManager
Example
Value:
13-Jul-2017
plugin.single.org.dspace.sword2.WorkflowManager = org.dspace.sword2.WorkflowManagerDefault
https://wiki.duraspace.org/display/DSDOC6x
Page 283 of 901
DSpace 6.x Documentation
File:
Informational
Which workflow manager to use.
Note:
Property:
swordv2-server.workflowmanagerdefault.always-update-metadata
Example
Value
swordv2-server.workflowmanagerdefault.always-update-metadata = true
Informational
Should the WorkflowManagerDefault plugin allow updates to the item's metadata to take place on items wh
Note
the workflow, archive, or withdrawn) ?
Property:
swordv2-server.workflowmanagerdefault.file-replace.enable
Example
Value
swordv2-server.workflowmanagerdefault.file-replace.enable = false
Informational
Should the server allow PUT to individual files?
Note
If this is enabled, then DSpace may be used with the DepositMO SWORD extensions, BUT the caveat is th
replace, so this is equivalent to a DELETE and then a POST, which violates the RESTfulness of the server.
identifier as the file it was replacing. As such it is STRONGLY RECOMMENDED to leave this option turned
enabled client environments
Property:
swordv2-server.mets-ingester.package-ingester
Example
Value:
Informational
swordv2-server.mets-ingester.package-ingester = METS
Which package ingester to use for METS packages.
Note:
Property:
swordv2-server.restore-mode.enable
Example
Value:
swordv2-server.restore-mode.enable = false
Informational
Should the SWORD server enable restore-mode when ingesting new packages. If this is enabled the item w
Note:
repository. If the item has previously been assigned a handle then that same handle will be restored to activ
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 284 of 901
DSpace 6.x Documentation
Configuration
[dspace]/config/modules/swordv2-server.cfg
File:
Property:
swordv2-server.simpledc.*
Example
Value:
Informational
swordv2-server.simpledc.abstract = dc.description.abstractsimpledc.date = dc.datesimpledc.rights
Configuration of metadata field mapping used by the SimpleDCEntryIngester, SimpleDCEntryDisseminator
Note:
Property:
swordv2-server.atom.*
Example
Value
swordv2-server.atom.author = dc.contributor.author
Informational
Configuration of metadata field mapping used by the SimpleDCEntryIngester, SimpleDCEntryDisseminator
Note:
Property:
swordv2-server.metadata.replaceable
Example
Value
swordv2-server.metadata.replaceable = dc.description.abstract, dc.rights, dc.ti
Informational
Used by SimpleDCEntryIngester: Which metadata fields can be replaced during a PUT to the Item of an Ato
Note
which will be removed when a new PUT comes through (irrespective of whether there is a new incoming va
Property:
swordv2-server.multipart.entry-first
Example
Value:
swordv2-server.multipart.entry-first = false
Informational
The order of precedence for importing multipart content. If this is set to true then metadata in the package
Note:
the metadata in the atom entry will override that from the package.
Property:
swordv2-server.workflow.notify
Example
Value:
swordv2-server.workflow.notify = true
If the workflow gets started (the collection being deposited into has a workflow configured), should a notifica
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 285 of 901
DSpace 6.x Documentation
Configuration
[dspace]/config/modules/swordv2-server.cfg
File:
Informational
Note:
Property:
swordv2-server.versions.keep
Example
Value:
swordv2-server.versions.keep = true
Informational
When content is replaced, should the old version be kept? This creates a copy of the ORIGINAL bundle with
Note:
DD is the date the copy was created, and X is an integer from 0 upwards.
Property:
swordv2-server.state.*
Example
Value:
Informational
swordv2-server.state.workspace.uri = http://localhost:8080/xmlui/state/inprogress
swordv2-server.state.workspace.description = The item is in the user workspace
swordv2-server.state.workflow.uri = http://localhost:8080/xmlui/state/inreview
swordv2-server.state.workflow.description = The item is undergoing review prior to acceptance in
Pairs of states (URI and description) than items can be in. Typical states are workspace, workflow, arch
Note:
Property:
swordv2-server.workspace.url-template
Example
Value
swordv2-server.workspace.url-template = http://mydspace.edu/xmlui/submit?worksp
Informational
URL template for links to items in the workspace (items in the archive will use the handle). The #wsid# url
Note
the item. The example above shows how to construct this URL for XMLUI.
Other configuration options exist that define the mapping between mime types, ingesters, and disseminators. A
typical configuration looks like this:
plugin.named.org.dspace.sword2.SwordContentIngester = \
org.dspace.sword2.SimpleZipContentIngester = http://purl.org/net/sword/package/SimpleZip, \
org.dspace.sword2.SwordMETSIngester = http://purl.org/net/sword/package/METSDSpaceSIP, \
org.dspace.sword2.BinaryContentIngester = http://purl.org/net/sword/package/Binary
plugin.single.org.dspace.sword2.SwordEntryIngester = \
org.dspace.sword2.SimpleDCEntryIngester
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 286 of 901
DSpace 6.x Documentation
plugin.single.org.dspace.sword2.SwordEntryDisseminator = \
org.dspace.sword2.SimpleDCEntryDisseminator
# note that we replace ";" with "_" as ";" is not permitted in the PluginManager names
plugin.named.org.dspace.sword2.SwordContentDisseminator = \
org.dspace.sword2.SimpleZipContentDisseminator = http://purl.org/net/sword/package/SimpleZip, \
org.dspace.sword2.FeedContentDisseminator = application/atom+xml, \
org.dspace.sword2.FeedContentDisseminator = application/atom+xml_type_feed
# note that we replace ";" with "_" as ";" is not permitted in the PluginManager names
plugin.named.org.dspace.sword2.SwordStatementDisseminator = \
org.dspace.sword2.AtomStatementDisseminator = atom, \
org.dspace.sword2.OreStatementDisseminator = rdf, \
org.dspace.sword2.AtomStatementDisseminator = application/atom+xml_type_feed, \
org.dspace.sword2.OreStatementDisseminator = application/rdf+xml
4.3.10 Ingesting HTML Archives
For the most part, at present DSpace simply supports uploading and downloading of bitstreams as-is. This is
fine for the majority of commonly-used file formats – for example PDFs, Microsoft Word documents,
spreadsheets and so forth. HTML documents (Web sites and Web pages) are far more complicated, and this
has important ramifications when it comes to digital preservation:
Web pages tend to consist of several files – one or more HTML files that contain references to each
other, and stylesheets and image files that are referenced by the HTML files.
Web pages also link to or include content from other sites, often imperceptibly to the end-user. Thus, in a
few year's time, when someone views the preserved Web site, they will probably find that many links are
now broken or refer to other sites than are now out of context.In fact, it may be unclear to an end-user
when they are viewing content stored in DSpace and when they are seeing content included from
another site, or have navigated to a page that is not stored in DSpace. This problem can manifest when
a submitter uploads some HTML content. For example, the HTML document may include an image from
an external Web site, or even their local hard drive. When the submitter views the HTML in DSpace, their
browser is able to use the reference in the HTML to retrieve the appropriate image, and so to the
submitter, the whole HTML document appears to have been deposited correctly. However, later on,
when another user tries to view that HTML, their browser might not be able to retrieve the included image
since it may have been removed from the external server. Hence the HTML will seem broken.
Often Web pages are produced dynamically by software running on the Web server, and represent the
state of a changing database underneath it.
Dealing with these issues is the topic of much active research. Currently, DSpace bites off a small, tractable
chunk of this problem. DSpace can store and provide on-line browsing capability for self-contained, non-dynamic
HTML documents. DSpace allows relative links between HTML documents stored together in a single item to
work. In practical terms, this means:
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 287 of 901
DSpace 6.x Documentation
No dynamic content (CGI scripts and so forth)
All links to preserved content must be relative links, that do not refer to 'parents' above the 'root' of the
HTML document/site:
diagram.gif is OK
image/foo.gif is OK
../index.html is only OK in a file that is at least a directory deep in the HTML document/site
hierarchy
/stylesheet.css is not OK (the link will break)
http://somedomain.com/content.html is not OK (the link will continue to link to the external site
which may change or disappear)
Any 'absolute links' (e.g. http://somedomain.com/content.html) are stored 'as is', and will continue to link
to the external content (as opposed to relative links, which will link to the copy of the content stored in
DSpace.) Thus, over time, the content referred to by the absolute link may change or disappear.
4.4 Items and Metadata
Authority Control of Metadata Values
Batch Metadata Editing
DOI Digital Object Identifier
Item Level Versioning
Mapping Items
Metadata Recommendations
Moving Items
ORCID Integration
PDF Citation Cover Page
Updating Items via Simple Archive Format
4.4.1 Authority Control of Metadata Values
WORK IN PROGRESS
Introduction
Simple choice management for DSpace submission forms
Example
Use simple choice management to add language tags to metadata fields
Hierarchical Taxonomies and Controlled Vocabularies
How to invoke a controlled vocabulary from input-forms.xml
Authority Control: Enhancing DSpace metadata fields with Authority Keys
How it looks in the DSpace user interface
How it works
Original source:
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 288 of 901
DSpace 6.x Documentation
WORK IN PROGRESS
Introduction
With DSpace you can describe digital objects such as text files, audio, video or data to facilitate easy retrieval
and high quality search results. These descriptions are organized into metadata fields that each have a specific
designation. For example: dc.title stores the title of an object, while dc.subject is reserved for subject keywords.
For many of these fields, including title and abstract, free text entry is the proper choice, as the values are likely
to be unique. Other fields are likely to have values drawn from controlled sets. Such fields include unique
names, subject keywords, document types and other classifications. For those kinds of fields the overall quality
of the repository metadata increases if values with the same meaning are normalized across all items.
Additional benefits can be gained if unique identifiers are associated as well in addition to canonical text values
associated with a particular metadata field.
This page covers features included in the DSpace submission forms that allow repository managers to enforce
the usage of normalized terms for those fields where this is required in their institutional use cases. DSpace
offers simple and straightforward features, such as definitions of simple text values for dropdowns, as well as
more elaborate integrations with external vocabularies such as the Library of Congress Naming Authority.
Simple choice management for DSpace submission forms
The DSpace Submission forms, defined in the input-forms.xml file, allows the inclusion of value pairs that can
be organized in lists in order to populate dropdowns or other multiple choice elements. If you explore the default
input-forms.xml file, you can see that a number of such value pair lists are already pre defined.
Example
Gov't Doc #
govdoc
URI
uri
ISBN
isbn
It generates the following HTML, which results in the menu widget below.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 289 of 901
DSpace 6.x Documentation
A list of value pairs has following required attributes:
value-pairs-name – Name by which an input-type refers to this list.
dc-term – Dublin Core field for which this choice list is selecting a value.
Each value-pairs element contains a sequence of pair sub-elements, each of which in turn contains two
elements:
displayed-value – Name shown (on the web page) for the menu entry.
stored-value – Value stored in the DC element when this entry is chosen. Unlike the HTML select tag,
there is no way to indicate one of the entries should be the default, so the first entry is always the default
choice.
Use simple choice management to add language tags to metadata fields
DSpace uses the simple choice management to provide a controlled list of language tags. Out of the box
DSpace comes with a list of ISO language tags. You can add further language lists or use the provided one to
let submitters tag languages of metadata fields. Take a look at the part of this documentation about the
configuration of the Submission User Interface. This feature is currently supported in JSPUI only.
Hierarchical Taxonomies and Controlled Vocabularies
The value pairs system works well for short and flat lists of choices. DSpace offers a second way of structuring
and managing more complex, hierarchical controlled vocabularies. In contrast to the value pairs system, these
controlled vocabularies are managed in separate XML files in the [dspace]/config/controlledvocabularies/ directory instead of being entered straight into input-forms.xml
The taxonomies are described in XML according to this structure:
...
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 290 of 901
DSpace 6.x Documentation
As you can see, each node element has an id and label attribute. It can contain the isComposedBy element,
which in its turn, consists of a list of other nodes.
You are free to use any application you want to create your controlled vocabularies. A simple text editor should
be enough for small projects. Bigger projects will require more complex tools. You may use Protegé to create
your taxonomies, save them as OWL and then use a XML Stylesheet (XSLT) to transform your documents to
the appropriate format. Future enhancements to this add-on should make it compatible with standard schemas
such as OWL or RDF.
How to invoke a controlled vocabulary from input-forms.xml
Vocabularies need to be associated with the correspondent DC metadata fields. Edit the file [dspace]
/config/input-forms.xml and place a "vocabulary" tag under the "field" element that you want to
control. Set value of the "vocabulary" element to the name of the file that contains the vocabulary, leaving
out the extension (the add-on will only load files with extension "*.xml"). For example:
dc
subject
true
onebox
Enter appropriate subject keywords or phrases below.
srsc
The vocabulary element has an optional boolean attribute closed that can be used to force input only with the
Javascript of controlled-vocabulary add-on. The default behaviour (i.e. without this attribute) is closed="
false". This allows the user to enter values as free text in addition to selecting them from the controlled
vocabulary.
The following vocabularies are currently available by default:
nsi - nsi.xml - The Norwegian Science Index
srsc - srsc.xml - Swedish Research Subject Categories
Authority Control: Enhancing DSpace metadata fields with Authority Keys
The aforementioned features only deal with text representations of controlled values. DSpace also offers
support for adding authority keys and confidence values to a specific text value entered in a metadata field. The
following terminology applies in the description of this area of DSpace functionality:
Authority An authority is an external source of fixed values for a given domain, each unique value
identified by a key. For example, the OCLC LC Name Authority Service, ORCID or VIAF.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 291 of 901
DSpace 6.x Documentation
Authority Record The information associated with one of the values in an authority; may include
alternate spellings and equivalent forms of the value, etc.
Authority Key An opaque, hopefully persistent, identifier corresponding to exactly one record in the
authority.
The fact that this functionality deals with external sources of authority makes it inherently different from the
functionality for controlled vocabularies. Another difference is that the authority control is asserted everywhere
metadata values are changed, including unattended/batch submission, SWORD package submission, and the
administrative UI.
How it looks in the DSpace user interface
The difference between an authority controlled metadata field and a non-authority controlled metadata field can
be seen in the Edit interface for an accepted item.
Authority controlled author field edit
This example shows a value for an author name that has been linked with an authority key. The green thumb
represents the associated confidence value "Accepted": This authority value has been confirmed as accurate by
an interactive user or authoritative policy.
How it works
TODO
Original source:
Authority Control of Metadata Values original development proposal for DSpace 1.6
4.4.2 Batch Metadata Editing
Batch Metadata Editing Tool
Export Function
Web Interface Export
Command Line Export
Import Function
Web Interface Import
Command Line Import
CSV Format
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 292 of 901
DSpace 6.x Documentation
File Structure
Editing the CSV
Editing Collection Membership
Adding Metadata-Only Items
Deleting Metadata
Performing 'actions' on items
Migrating Data or Exchanging data
Common Issues
Batch Metadata Editing Tool
DSpace provides a batch metadata editing tool. The batch editing tool is able to produce a comma delimited file
in the CSV format. The batch editing tool facilitates the user to perform the following:
Batch editing of metadata (e.g. perform an external spell check)
Batch additions of metadata (e.g. add an abstract to a set of items, add controlled vocabulary such as
LCSH)
Batch find and replace of metadata values (e.g. correct misspelled surname across several records)
Mass move items between collections
Mass deletion, withdrawal, or re-instatement of items
Enable the batch addition of new items (without bitstreams) via a CSV file
Re-order the values in a list (e.g. authors)
For information about configuration options for the Batch Metadata Editing tool, see Batch Metadata Editing
Configuration
Export Function
Web Interface Export
Batch metadata exports (to CSV) can be performed from the Administrative menu:
Login as an Administrative user
Browse to the Community or Collection you wish to export, and click "Export Metadata" link to export to a
downloadable CSV
In XMLUI, "Export Metadata" can be found in the "Context" menu on a Community/Collection
homepage
In JSPUI, "Export Metadata" can be found in the "Admin Tools" menu on a Community/Collection
homepage
Or search for items within your repository, and click "Export Metadata" in the search results to export to a
downloadable CSV
In XMLUI, perform a search, and click on "Export Search Metadata" in the "Context" menu. By
default, this option is only available to Administrators (xmlui.search.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 293 of 901
DSpace 6.x Documentation
metadata_export=admin), but you can optionally allow any logged in user to export this
metadata (xmlui.search.metadata_export=user), or anyone (xmlui.search.
metadata_export=anonymous).
In JSPUI, perform a search, and click on the "Export Metadata" button above the search results.
Please see below documentation for more information on the CSV format and actions that can be performed by
editing the CSV.
Command Line Export
The following table summarizes the basics.
Command
[dspace]/bin/dspace metadata-export
used:
Java class:
org.dspace.app.bulkedit.MetadataExport
Arguments
Description
short and
(long) forms):
-f or --file
Required. The filename of the resulting CSV.
-i or --id
The Item, Collection, or Community handle or Database ID to export. If not specified, all
items will be exported.
-a or --all
Include all the metadata fields that are not normally changed (e.g. provenance) or those
fields you configured in the [dspace]/config/modules/bulkedit.cfg to be ignored
on export.
-h or --help
Display the help page.
To run the batch editing exporter, at the command line:
[dspace]/bin/dspace metadata-export -f name_of_file.csv -i 1023/24
Example:
[dspace]/bin/dspace metadata-export -f /batch_export/col_14.csv -i /1989.1/24
In the above example we have requested that a collection, assigned handle ' 1989.1/24' export the entire
collection to the file 'col_14.csv' found in the '/batch_export' directory.
Please see below documentation for more information on the CSV format and actions that can be performed by
editing the CSV .
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 294 of 901
DSpace 6.x Documentation
Import Function
Importing large CSV files
It is not recommended to import CSV files of more than 1,000 lines (i.e. 1,000 items). When importing
files larger than this, it may be difficult for an Administrator to accurately verify the changes that the
import tool states it will make. In addition, depending on the memory available to the DSpace site,
large files may cause 'Out Of Memory' errors part way through the import process.
Web Interface Import
Batch metadata imports (from CSV) can be performed from the Administrative menu:
First, complete all editing of the CSV and save your changes
Login as an Administrative User
Click "Import Metadata" and select the CSV file
In XMLUI, "Import Metadata" can be found under the "Administrative" menu on any page
In JSPUI, "Import Metadata" can be found under the "Administer" menu (under your user account
dropdown). On the Adminstration Tools page, select "Import Metadata" from the "Content"
dropdown
After uploading the CSV, you will be presented with a summary of all changes that will be performed in
the system. You can review these changes and choose whether to apply them or cancel.
Command Line Import
The following table summarizes the basics.
Command used:
[dspace]/bin/dspace metadata-import
Java class:
org.dspace.app.bulkedit.MetadataImport
Arguments short and
Description
(long) forms:
-f or --file
Required. The filename of the CSV file to load.
-s or --silent
Silent mode. The import function does not prompt you to make sure you wish to
make the changes.
-e or --email
The email address of the user. This is only required when adding new items.
-w or --workflow
When adding new items, the program will queue the items up to use the
Collection Workflow processes.
-n or --notify
13-Jul-2017
when adding new items using a workflow, send notification emails.
https://wiki.duraspace.org/display/DSDOC6x
Page 295 of 901
DSpace 6.x Documentation
-t or --template
When adding new items, use the Collection template, if it exists.
-h or --help
Display the brief help page.
Silent Mode should be used carefully. It is possible (and probable) that you can overlay the wrong data and
cause irreparable damage to the database.
To run the batch importer, at the command line:
[dspace]/bin/dspace metadata-import -f name_of_file.csv
Example
[dspace]/bin/dspace metadata-import -f /dImport/col_14.csv
If you are wishing to upload new metadata without bitstreams, at the command line:
[dspace]/bin/dspace metadata-import -f /dImport/new_file.csv -e joe@user.com -w -n -t
In the above example we threw in all the arguments. This would add the metadata and engage the workflow,
notification, and templates to all be applied to the items that are being added.
CSV Format
The CSV (comma separated values) files that this tool can import and export abide by the RFC4180 CSV
format. This means that new lines, and embedded commas can be included by wrapping elements in double
quotes. Double quotes can be included by using two double quotes. The code does all this for you, and any
good csv editor such as Excel or OpenOffice will comply with this convention.
All CSV files are also in UTF-8 encoding in order to support all languages.
File Structure
The first row of the CSV must define the metadata values that the rest of the CSV represents. The first column
must always be "id" which refers to the item's internal database ID. All other columns are optional. The
other columns contain the dublin core metadata fields that the data is to reside.
A typical heading row looks like:
id,collection,dc.title,dc.contributor,dc.date.issued,etc,etc,etc.
Subsequent rows in the csv file relate to items. A typical row might look like:
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 296 of 901
DSpace 6.x Documentation
350,2292,Item title,"Smith, John",2008
If you want to store multiple values for a given metadata element, they can be separated with the double-pipe '||'
(or another character that you defined in your modules/bulkedit.cfg file). For example:
Horses||Dogs||Cats
Elements are stored in the database in the order that they appear in the CSV file. You can use this to order
elements where order may matter, such as authors, or controlled vocabulary such as Library of Congress
Subject Headings.
Editing the CSV
If you are editing with Microsoft Excel, be sure to open the CSV in Unicode/UTF-8 encoding
By default, Microsoft Excel may not correctly open the CSV in Unicode/UTF-8 encoding. This means
that special characters may be improperly displayed and also can be "corrupted" during re-import of
the CSV.
You need to tell Excel this CSV is Unicode, by importing it as follows. ( Please note these instructions
are valid for MS Office 2007 and 2013. Other Office versions may vary )
First, open Excel (with an empty sheet/workbook open)
Select "Data" tab
Click "From Text" button (in the "External Data" section)
Select your CSV file
Wizard Step 1
Choose "Delimited" option
Start import at row: 1
In the "File origin" selectbox, select "65001 : Unicode (UTF-8)"
NOTE: these encoding options are sorted alphabetically, so "Unicode (UTF-8)"
appears near the bottom of the list.
Click Next
Wizard Step 2
Select "Comma" as the only delimiter
Click Next
Wizard Step 3
Select "Text" as the "Column data format" (Unfortunately, this must be done for each
column individually in Excel)
At a minimum, you MUST ensure all date columns (e.g. dc.date.issued) are
treated as "Text" so that Excel doesn't autoconvert DSpace's YYYY-MM-DD
format into MM/DD/YYYY
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 297 of 901
DSpace 6.x Documentation
To avoid such autoconversion, it is safest to ensure each column is treated as
"Text". Unfortunately, this means selecting each column one-by-one and choosing
"Text" as the "Column data format".
Click Finish
Choose whether to open CSV in the existing sheet or a new one
Tips to Simplify the Editing Process
When editing a CSV, here's a couple of basic tips to keep in mind:
1. The "id" column MUST remain intact. This column also must always have a value in it.
2. To simplify the CSV, you can simply remove any columns you do NOT wish to edit (except for
"id" column, see #1). Don't worry, removing the entire column won't delete metadata (see #3)
3. When importing a CSV file, the importer will overlay the metadata onto what is already in the
repository to determine the differences. It only acts on the contents of the CSV file, rather than
on the complete item metadata. This means that the CSV file that is exported can be
manipulated quite substantially before being re-imported. Rows (items) or Columns (metadata
elements) can be removed and will be ignored.
a. For example, if you only want to edit "dc.subject", you can remove ALL columns
EXCEPT for "id" and "dc.subject" so that you can just manipulate the "dc.subject" field.
On import, DSpace will see that you've only included the "dc.subject" field in your CSV
and therefore will only update the "dc.subject" metadata field for any items listed in that
CSV.
4. Because removing an entire column does NOT delete metadata value(s), if you actually wish to
delete a metadata value you should leave the column intact, and simply clear out the
appropriate row's value (in that column).
Editing Collection Membership
Items can be moved between collections by editing the collection handles in the 'collection' column. Multiple
collections can be included. The first collection is the 'owning collection'. The owning collection is the primary
collection that the item appears in. Subsequent collections (separated by the field separator) are treated as
mapped collections. These are the same as using the map item functionality in the DSpace user interface. To
move items between collections, or to edit which other collections they are mapped to, change the data in the
collection column.
Adding Metadata-Only Items
New metadata-only items can be added to DSpace using the batch metadata importer. To do this, enter a plus
sign '+' in the first 'id' column. The importer will then treat this as a new item. If you are using the command line
importer, you will need to use the -e flag to specify the user email address or id of the user that is registered as
submitting the items.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 298 of 901
DSpace 6.x Documentation
Deleting Metadata
It is possible to perform metadata deletes across the board of certain metadata fields from an exported file. For
example, let's say you have used keywords (dc.subject) that need to be removed en masse. You would leave
the column (dc.subject) intact, but remove the data in the corresponding rows.
Performing 'actions' on items
It is possible to perform certain 'actions' on items. This is achieved by adding an 'action' column to the CSV file
(after the id, and collection columns). There are three possible actions:
1. 'expunge' This permanently deletes an item. Use with care! This action must be enabled by setting
'allowexpunge = true' in modules/bulkedit.cfg
2. 'withdraw' This withdraws an item from the archive, but does not delete it.
3. 'reinstate' This reinstates an item that has previously been withdrawn.
If an action makes no change (for example, asking to withdraw an item that is already withdrawn) then, just like
metadata that has not changed, this will be ignored.
Migrating Data or Exchanging data
It is possible that you have data in one Dublin Core (DC) element and you wish to really have it in another. An
example would be that your staff have input Library of Congress Subject Headings in the Subject field (dc.
subject) instead of the LCSH field (dc.subject.lcsh). Follow these steps and your data is migrated upon import:
1. Insert a new column. The first row should be the new metadata element. (We will refer to it as the
TARGET)
2. Select the column/rows of the data you wish to change. (We will refer to it as the SOURCE)
3. Cut and paste this data into the new column (TARGET) you created in Step 1.
4. Leave the column (SOURCE) you just cut and pasted from empty. Do not delete it.
Common Issues
Metadata values in CSV export seem to have duplicate columns
Batch Metadata Editing Configuration
The Batch Metadata Editing Tool allows the administrator to extract from the DSpace database a set of records
for editing via a CSV file. It provides an easier way of editing large collections.
A full list of all available Batch Metadata Editing Configurations:
Configuration
[dspace]/config/modules/bulkedit.cfg
File:
Property:
bulkedit.valueseparator
bulkedit.valueseparator = ||
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 299 of 901
DSpace 6.x Documentation
Configuration
[dspace]/config/modules/bulkedit.cfg
File:
Example
Value:
Informational
The delimiter used to separate values within a single field. For example, this will place the
note
double pipe between multiple authors appearing in one record (Smith, William || Johannsen,
Susan). This applies to any metadata field that appears more than once in a record. The
user can change this to another character.
Property:
bulkedit.fieldseparator
Example
bulkedit.fieldseparator = ,
Value:
Informational
The delimiter used to separate fields (defaults to a comma for CSV). Again, the user could
note
change it something like '$'. If you wish to use a tab, semicolon, or hash (#) sign as the
delimiter, set the value to be tab, semicolon or hash.
bulkedit.fieldseparator = tab
Property:
bulkedit.authorityseparator
Example
bulkedit.authorityseparator = ::
Value:
Informational
The delimiter used to separate authority data (defaults to a double colon ::)
note
Property:
bulkedit.gui-item-limit
Example
bulkedit.gui-item-limit = 20
Value:
Informational
When using the WEBUI, this sets the limit of the number of items allowed to be edited in
note
one processing. There is no limit when using the CLI.
Property:
bulkedit.ignore-on-export
Example
Value:
13-Jul-2017
bulkedit.ignore-on-export = dc.date.accessioned, \
dc.date.available, \
dc.date.updated, dc.description.provenance
https://wiki.duraspace.org/display/DSDOC6x
Page 300 of 901
DSpace 6.x Documentation
Configuration
[dspace]/config/modules/bulkedit.cfg
File:
Informational
Metadata elements to exclude when exporting via the user interfaces, or when using the
note
command line version and not using the -a (all) option.
Property:
bulkedit.allowexpunge
Example
bulkedit.allowexpunge = false
Value:
Informational
Should the 'action' column allow the 'expunge' method. By default this is set to false
note
4.4.3 DOI Digital Object Identifier
Persistent Identifier
DOI Registration Agencies
Configure DSpace to use the DataCite API
dspace.cfg
Metadata conversion
Identifier Service
DOIs using DataCite and Item Level Versioning
Command Line Interface
'cron' job for asynchronous reservation/registration
Limitations of DataCite DOI support
Configure DSpace to use EZID service for registration of DOIs
Limitations of EZID DOI support
JSPUI specific configurations
Adding support for other Registration Agencies
Persistent Identifier
It is good practice to use Persistent Identifiers to address items in a digital repository. There are many different
systems for Persistent Identifiers: Handle , DOI , urn:nbn, purl and many more. It is far out of the scope of this
document to discuss the differences of all these systems. For several reasons the Handle System is deeply
integrated in DSpace, and DSpace makes intensive use of it. With DSpace 3.0 the Identifier Service was
introduced that makes it possible to also use external identifier services within DSpace.
DOIs are Persistent Identifiers like Handles are, but as many big publishing companies use DOIs they are quite
well-known to scientists. Some journals ask for DOIs to link supplemental material whenever an article is
submitted. Beginning with DSpace 4.0 it is possible to use DOIs in parallel to the Handle System within
DSpace. By "using DOIs" we mean automatic generation, reservation and registration of DOIs for every item
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 301 of 901
DSpace 6.x Documentation
that enters the repository. These newly registered DOIs will not be used as a means to build URLs to DSpace
items. Items will still rely on handle assignment for the item urls.
DOI Registration Agencies
To register a DOI one has to enter into a contract with a DOI registration agency which is a member of the
International DOI Foundation. Several such agencies exist. Different DOI registration agencies have different
policies. Some of them offer DOI registration especially or only for academic institutions, others only for
publishing companies. Most of the registration agencies charge fees for registering DOIs, and all of them have
different rules describing for what kind of item a DOI can be registered. To make it quite clear: to register DOIs
with DSpace you have to enter into a contract with a DOI registration agency.
DataCite is an international initiative to promote science and research, and a member of the International DOI
Foundation. The members of DataCite act as registration agencies for DOIs. Some DataCite members provide
their own APIs to reserve and register DOIs; others let their clients use the DataCite API directly. Starting with
version 4.0 DSpace supports the administration of DOIs by using the DataCite API directly or by using the API
from EZID (which is a service of the University of California Digital Library). This means you can administer
DOIs with DSpace if your registration agency allows you to use the DataCite API directly or if your registration
agency is EZID.
Configure DSpace to use the DataCite API
If you use a DOI registration agency that lets you use the DataCite API directly, you can follow the instructions
below to configure DSpace. In case EZID is your registration agency the configuration of DSpace is
documented here: Configure DSpace to use EZID service for registration of DOIs.
To use DOIs within DSpace you have to configure several parts of DSpace:
enter your DOI prefix and the credentials to use the API from DataCite in dspace.cfg,
configure the script which generates some metadata,
activate the DOI mechanism within DSpace,
configure a cron job which transmits the information about new and changed DOIs to the registration
agency.
dspace.cfg
After you enter into a contract with a DOI registration agency, they'll provide you with user credentials and a
DOI prefix. You have to enter these in the dspace cfg. Here is a list of DOI configuration options in dspace.cfg:
Configuration
[dspace]/config/dspace.cfg
File:
Property:
identifier.doi.user
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 302 of 901
DSpace 6.x Documentation
Configuration
[dspace]/config/dspace.cfg
File:
Example
Value:
identifier.doi.user = user123
Informational
Username to login into the API of the DOI registration agency. You'll get it from your DOI
Note:
registration agency.
Property:
identifier.doi.password
Example
Value:
identifier.doi.password = top-secret
Informational
Password to login into the API of the DOI registration agency. You'll get it from your DOI
Note:
registration agency.
Property:
identifier.doi.prefix
Example
Value:
identifier.doi.prefix = 10.5072
Informational
The prefix you got from the DOI registration agency. All your DOIs start with this prefix,
Note:
followed by a slash and a suffix generated from DSpace. The prefix can be compared with a
namespace within the DOI system.
Property:
identifier.doi.namespaceseparator
Example
Value:
identifier.doi.namespaceseparator = dspace-
Informational
This property is optional. If you want to use the same DOI prefix in several DSpace
Note:
installations or with other tools that generate and register DOIs it is necessary to use a
namespace separator. All the DOIs that DSpace generates will start with the DOI prefix,
followed by a slash, the namespace separator and some number generated by DSpace. For
example, if your prefix is 10.5072 and you want all DOIs generated by DSpace to look like
10.5072/dspace-1023 you have to set this as in the example value above.
Property:
crosswalk.dissemination.DataCite.publisher
Example
crosswalk.dissemination.DataCite.publisher = My University Press
Value:
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 303 of 901
DSpace 6.x Documentation
Configuration
[dspace]/config/dspace.cfg
File:
Informational
The name of the entity which published the item.
Note:
Property:
crosswalk.dissemination.DataCite.hostingInstitution
Example
crosswalk.dissemination.DataCite.hostingInstitution = My University
Value:
Informational
The name of the entity which hosts this instance of the object. If not configured, it will default
Note:
to the value of crosswalk.dissemination.DataCite.publisher.
Property:
crosswalk.dissemination.DataCite.dataManager
Example
crosswalk.dissemination.DataCite.dataManager = My University Department of Geology
Value:
Informational
If not configured, it will default to the value of crosswalk.dissemination.DataCite.publisher.
Note:
Please don't use the test prefix 10.5072 with DSpace. The test prefix 10.5072 differs from other
prefixes: It answers GET requests for all DOIs even for DOIs that are unregistered. DSpace checks
that it mint only unused DOIs and will create an Error: "Register DOI ... failed:
DOI_ALREADY_EXISTS". Your registration agency can provide you an individual test prefix, that you
can use for tests.
Metadata conversion
To reserve or register a DOI, DataCite requires that metadata be supplied which describe the object that the
DOI addresses. The file [dspace]/config/crosswalks/DIM2DataCite.xsl controls the conversion of metadata from
the DSpace internal format into the DataCite format. You have to add your DOI prefix, namespace separator
and the name of your institution to this file:
\[dspace\]/config/crosswalks/DIM2DataCite.xsl
10.5072-dspace-
My University
If you use other IdentifierProviders beside the DOIIdentifierProvider there will be more beans in this file.
Please pay attention to configure the property DATACITE_HOST. Per default it is set to the DataCite test
server. To reserve real DOIs you will have to change it to mds.datacite.org. Ask your registration agency if
you're not sure about the correct address.
DSpace should send updates to DataCite whenever the metadata of an item changes. To do so you have to
change the dspace.cfg again. You should remove the comments in front of the two following properties or add
them to the dspace.cfg:
\[dspace\]/config/dspace.cfg
event.consumer.doi.class = org.dspace.identifier.doi.DOIConsumer
event.consumer.doi.filters = Item+Modify_Metadata
Then you should add 'doi' to the property event.dispatcher.default.consumers. After adding it, this
property may look like this:
\[dspace\]/config/dspace.cfg
event.dispatcher.default.consumers = versioning, discovery, eperson, harvester, doi
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 306 of 901
DSpace 6.x Documentation
DOIs using DataCite and Item Level Versioning
If you enabled Item Level Versioning you should enable the VersionedDOIIdentifierProvider instead of
the DOIIdentifierProvider. The VersionedDOIIdentifierProvider ensures that newer versions of
the same Item gets a DOI looking as the DOI of the first version of and item, extended by a dot and the version
number. With DSpace 6 this also became the default for handles if Item Level Versioning is enabled. In the
configuration file [dspace]/config/spring/api/identifier-service.xml you'll find the possiblity to
enable the VersionedDOIIdentifierProvider. If you want to use versioned DOIS, please comment out
the DOIIdentifierProvider as only one of both DOIProviders should be enabled at the same time.
Command Line Interface
To make DSpace resistant to outages of DataCite we decided to separate the DOI support into two parts. When
a DOI should be generated, reserved or minted, DSpace does this in its own database. To perform registration
and/or reservation against the DOI registration agency a job has to be started using the command line.
Obviously this should be done by a cron job periodically. In this section we describe the command line interface,
in case you ever want to use it manually. In the next section you'll see the cron job that transfers all DOIs
designated for reservation and/or registration.
The command line interface in general is documented here: Command Line Operations.
The command used for DOIs is 'doi-organiser'. You can use the following options:
Option
Option
Parameter
Description
(short)
(long)
-d
--
Transmit information to the DOI registration agency about all DOIs that
delete-
were deleted.
all
--
DOI
Transmit information to the DOI registration agency that the specified DOI
delete-
was deleted. The DOI must already be marked for deletion; you cannot use
doi
this command to delete a DOI for an exisiting item.
-h
--help
Print online help.
-l
--list
List all DOIs whose changes were not committed to the registration agency
yet.
-q
--quiet
The doi-organiser sends error reports to the mail address configured in the
property alert.recipient in dspace.cfg. If you use this option no output
should be given to stdout. If you do not use this option the doi-organiser
writes information about successful and unsuccessful operations to stdout
and stderr. You can find information in dspace.log of course.
-r
13-Jul-2017
Transmit information about all DOIs that should be registered.
https://wiki.duraspace.org/display/DSDOC6x
Page 307 of 901
DSpace 6.x Documentation
Option
Option
(short)
(long)
Parameter
Description
DOI |
If a DOI is marked for registration, you can trigger the registration at the
-registerall
--
-s
register- ItemID |
DOI registration agency by this command. Specify either the DOI, the ID of
doi
the item, or its handle.
handle
--
Transmit to the DOI registration agency information about all DOIs that
reserve-
should be reserved.
all
--
-u
DOI |
If a DOI is marked for registration, you can trigger the registration at the
reserve- ItemID |
DOI registration agency by this command. Specify either the DOI, the ID of
doi
the item, or its handle.
handle
--
If a DOI is reserved for an item, the metadata of the item will be sent to
update-
DataCite. This command transmits new metadata for items whose
all
metadata were changed since the DOI was reserved.
--
DOI |
If a DOI needs an update of the metadata of the item it belongs to, you can
update-
ItemID |
trigger this update with this command. Specify either the DOI, the ID of the
doi
handle
item, or its handle.
Currently you cannot generate new DOIs with this tool. You can only send information about changes in your
local DSpace database to the registration agency.
'cron' job for asynchronous reservation/registration
When a DOI should be reserved, registered, deleted or its metadata updated, DSpace just writes this
information into its local database. A command line interface is supplied to send the necessary information to
the registration agency. This behavior makes it easier to react to outages or errors while using the API. This
information should be sent regularly, so it is a good idea to set up a cron job instead of doing it manually.
There are four commands that should be run regularly:
Update the metadata of all items that have changed since their DOI was reserved.
Reserve all DOIs marked for reservation
Register all DOIs marked for registration
Delete all DOIs marked for deletion
In DSpace, a DOI can have the state "registered", "reserved", "to be reserved", "to be registered", "needs
update", "to be deleted", or "deleted". After updating an item's metadata the state of its assigned DOI is set
back to the last state it had before. So, e.g., if a DOI has the state "to be registered" and the metadata of its
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 308 of 901
DSpace 6.x Documentation
item changes, it will be set to the state "needs update". After the update is performed its state is set to "to be
registered" again. Because of this behavior the order of the commands above matters: the update command
must be executed before all of the other commands above.
The cron job should perform the following commands with the rights of the user your DSpace installation runs
as:
[dspace]/bin/dspace
[dspace]/bin/dspace
[dspace]/bin/dspace
[dspace]/bin/dspace
doi-organiser
doi-organiser
doi-organiser
doi-organiser
-u
-s
-r
-d
-q
-q
-q
-q
The doi-organiser sends error messages as email and logs some additional information. The option -q tells
DSpace to be quiet. If you don't use this option the doi-organiser will print messages to stdout about every DOI
it successfully reserved, registered, updated or deleted. Using a cron job these messages would be sent as
email.
In case of an error, consult the log messages. If there is an outage of the API of your registration agency,
DSpace will not change the state of the DOIs so that it will do everything necessary when the cron job starts the
next time and the API is reachable again.
The frequency the cron job runs depends on your needs and your hardware. The more often you run the cron
job the faster your new DOIs will be available online. If you have a lot of submissions and want the DOIs to be
available really quickly, you probably should run the cron job every fifteen minutes. If there are just one or two
submissions per day, it should be enough to run the cron job twice a day.
To set up the cron job, you just need to run the following command as the dspace UNIX user:
crontab -e
The following line tells cron to run the necessary commands twice a day, at 1am and 1pm. Please notice that
the line starting with the numbers is one line, even it it should be shown as multiple lines in your browser.
# Send information about new and changed DOIs to the DOI registration agency:
0 1,13 * * * [dspace]/bin/dspace doi-organiser -u -q ; [dspace]/bin/dspace doi-organiser -s -q ;
[dspace]/bin/dspace doi-organiser -r -q ; [dspace]/bin/dspace doi-organiser -d -q
Limitations of DataCite DOI support
Every DSpace installation expects to be the only application that generates DOIs which start
with the prefix and the namespace separator you configured. DSpace does not check whether
a DOI it generates is reserved or registered already.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 309 of 901
DSpace 6.x Documentation
That means if you want to use other applications or even more than one DSpace installation to register DOIs
with the same prefix, you'll have to use a unique namespace separator for each of them. Also you should not
generate DOIs manually with the same prefix and namespace separator you configured within DSpace. For
example, if your prefix is 10.5072 you can configure one DSpace installation to generate DOIs starting with
10.5072/papers-, a second installation to generate DOIs starting with 10.5072/data- and another application to
generate DOIs starting with 10.5072/results-.
DOIs will be used in addition to Handles. This implementation does not replace Handles with DOIs in DSpace.
That means that DSpace will still generate Handles for every item, every collection and every community, and
will use those Handles as part of the URL of items, collections and communities.
DSpace currently generates DOIs for items only. There is no support to generate DOIs for Communities and
collections yet.
When using DSpace's support for the DataCite API probably not all information would be restored when using
the AIP Backup and Restore (see DS-1836). The DOIs included in metadata of Items will be restored, but
DSpace won't update the metadata of those items at DataCite anymore. You can even get problems when
minting new DOIs after you restored older once using AIP.
Configure DSpace to use EZID service for registration of DOIs
The EZID IdentifierProvider operates synchronously, so there is much less to configure. You will need to uncomment the org.dspace.identifier.EZIDIdentifierProvider bean in config/spring/api
/identifier-service.xml to enable DOI registration through EZID.
In config/dspace.cfg you will find a small block of settings whose names begin with identifier.doi.
ezid. You should uncomment these properties and give them appropriate values. Sample values for a test
account are supplied.
name
meaning
identifier.doi.ezid.
The "shoulder" is the DOI prefix issued to you by the EZID service. DOIs minted by
shoulder
this instance of DSpace will be the concatenation of the "shoulder" and a locally
unique token.
identifier.doi.ezid.
The username and password by which you authenticate to EZID.
user
identifier.doi.ezid.
password
identifier.doi.ezid.
You may specify a default value for the required datacite.publisher
publisher
metadatum, for use when the Item has no publisher.
Should match identifier.doi.ezid.publisher.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 310 of 901
DSpace 6.x Documentation
name
meaning
crosswalk.
dissemination.
DataCite.publisher
crosswalk.
Name of the hosting institution. If not configured, it will be set to the value of
dissemination.
crosswalk.dissemination.DataCite.publisher.
DataCite.
hostingInstitution
crosswalk.
Name of the data manager. If not configured, it will be set to the value of crosswalk.
dissemination.
dissemination.DataCite.publisher.
DataCite.
dataManager
Back in config/spring/api/identifier-service.xml you will see some other configuration of the
EZIDIdentiferProvider bean. In most situations, the default settings should work well. But, here's an
explanation of options available:
EZID Provider / Registrar settings: By default, the EZIDIdentifierProvider is configured to use the CDLib
provider (ezid.cdlib.org) in the EZID_SCHEME, EZID_HOST and EZID_PATH settings. In most situations,
the default values should work for you. However, you may need to modify these values (especially the
EZID_HOST) if you are registered with a different EZID provider. In that situation, please check with your
provider for valid "host" and "path" settings. If your provider provides EZID service at a particular path on
its host, you may set that in EZID_PATH.
NOTE: As of the writing of this documentation, the default CDLib provider settings should also
work for institutions that use Purdue (ezid.lib.purdue.edu) as a provider. Currently, Purdue and
CDLib currently share the same infrastructure, and both ezid.cdlib.org and ezid.lib.
purdue.edu point to the same location.
Metadata mappings: You can alter the mapping between DSpace and EZID metadata, should you
choose. The crosswalk property is a map from DSpace metadata fields to EZID fields, and can be
extended or changed. The key of each entry is the name of an EZID metadata field; the value is the
name of the corresponding DSpace field, from which the EZID metadata will be populated.
Crosswalking / Transforms: You can also supply transformations to be applied to field values using the
crosswalkTransform property. Each key is the name of an EZID metadata field, and its value is the
name of a Java class which will convert the value of the corresponding DSpace field to its EZID form.
The only transformation currently provided is one which converts a date to the year of that date, named
org.dspace.identifier.ezid.DateToYear. In the configuration as delivered, it is used to convert
the date of issue to the year of publication. You may create new Java classes with which to supply other
transformations, and map them to metadata fields here. If an EZID metadatum is not named in this map,
the default mapping is applied: the string value of the DSpace field is copied verbatim.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 311 of 901
DSpace 6.x Documentation
Limitations of EZID DOI support
DOIs will be used in addition to Handles. This implementation does not replace Handles with DOIs in DSpace.
That means that DSpace will continue to generate Handles for every item, every collection and every
community, and will use those Handles as part of the URL of items, collections and communities.
Currently, the EZIDIdentifierProvider has a known issue where it stores its DOIs in the dc.identifier field,
instead of using the dc.identifier.uri field (which is the one used by DataCite DOIs and Handles). See
DS-2199 for more details. This will be corrected in a future version of DSpace.
DSpace currently generates DOIs for items only. There is no support to generate DOIs for Communities and
Collections yet.
JSPUI specific configurations
You can configure whether the JSPUI should show DOIs or handles on item frontdoors. Heading an item
frontdoor there is an informational note containing a Persistent Identifier and the request to use it when one
wants to refer to this item. By setting the property webui.preferred.identifier to doi in dspace.cfg, you can
configure the JSPUI to use DOIs instead of handles which are used by default. This property also controls
which Persistent Identifiers are used in the Version History that is shown if Item Level Versioning is used and
version history is enabled.
Further more you can configure whether DOIs should contain a doi: prefix or not in the version history. The
property webui.identifier.strip-prefixes in dspace.cfg controls this. By default the doi: prefix is stripped (not
shown).
Adding support for other Registration Agencies
If you want DSpace to support other registration agencies, you just have to write a Java class that implements
the interface DOIConnector ([dspace-source]/dspace-api/src/main/java/org/dspace/identifier/doi/DOIConnector.
java). You might use the DataCiteConnector ([dspace-source]/dspace-api/src/main/java/org/dspace/identifier/doi
/DataCiteConnector.java) as an example. After developing your own DOIConnector, you configure DSpace as if
you were using the DataCite API directly. Just use your DOIConnector when configuring the IdentifierService
instead of the DataCiteConnector.
4.4.4 Item Level Versioning
What is Item Level Versioning?
Important warnings - read before enabling
Enabling Item Level Versioning
Steps for XML UI
Steps for JSP UI
Initial Requirements
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 312 of 901
DSpace 6.x Documentation
User Interface
General behaviour: Linear Versioning
Creating a new version of an item
View the history and older versions of an item
Architecture
Versioning model
Configuration
Versioning Service Override
Identifier Service Override
Version History Visibility
Allowing submitters to version their items (JSPUI only)
Identified Challenges & Known Issues in DSpace 4.0
Only Administrators and Collection/Community Administrators can add new versions
Conceptual compatibility with Embargo
Conceptual compatibility with Item Level Statistics
Exposing version history
Hide Submitter details in version table
Credits
What is Item Level Versioning?
Versioning is a new functionality to build the history of an item. Users will have the opportunity to create new
version of an existing item any time the will make a change.
Important warnings - read before enabling
AIP Backup & Restore functionality only works with the Latest Version of Items
If you are using the AIP Backup and Restore functionality to backup / restore / migrate DSpace
Content, you must be aware that the "Item Level Versioning" feature is not yet compatible with AIP
Backup & Restore. Using them together may result in accidental data loss. Currently the AIPs that
DSpace generates only store the latest version of an Item. Therefore, past versions of Items will
always be lost when you perform a restore / replace using AIP tools. See DS-1382.
DSpace 6 changed the way Handles are created for versioned Items
With version 6 the way DSpace crates Handles for versioned Items was changed. If you want to keep
the old behavior of DSpace 4 and 5 you have to enable the
VersionedHandleIdentifierProviderWithCanonicalHandles in the XML configuration files
[dspace]/config/spring/api/identifier-service.xml. See IdentifierServiceOverride
below for details and the comments in the configuration file.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 313 of 901
DSpace 6.x Documentation
Enabling Item Level Versioning
By default, Item Level Versioning is disabled in DSpace 3, 4, 5 and 6.
Starting from DSpace 4.0, Item Level Versioning is also supported in JSPUI.
Steps for XML UI
If you wish to enable this feature, you just have to uncomment the "Versioning" aspect in your [dspace]
/config/xmlui.xconf file (and restart your servlet container):
dc.date.accessioned
dc.description.provenance
Identifier Service Override
Persistent Identifiers are used to address Items within DSpace. The handle system is deeply integrated within
DSpace, but since version 4 DSpace can also mint DOIs. DSpace 4 and 5 supported one type of versioned
handle: The initial version of an Item got a handle, e.g. 10673/100. This handle was called the canonical one.
When a newer version was created, the canonical handle was moved to identify the newest version. The
previously newest version got a new handle build out of the canonical handle extended by a dot and the version
number. In the image below you see a version history of an item using this handle strategy.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 318 of 901
DSpace 6.x Documentation
The canonical handle will always point to the newest version of an Item. This makes sense if you hide the
version history. Normal users won't be able to find older versions and will always see just the newest one.
Please keep in mind, that older versions can be accessed by "guessing" the versioned Handle if you do not
remove the read policies manually. The downside of this identifier strategy is that there is no permanent handle
to cite the currently newest version, as it will get a new Handle when a newer version is created.
With DSpace 6 versioned DOIs (using DataCite as DOI registration agency) were added and the default
versioned Handle strategy was changed. Starting with DSpace 6 the
VersionedHandleIdentifierProvider creates a handle for the first version of an item. Every newer
version gets the same handle extended by a dot and the version number. To stay by the example from above,
the first version of an Item gets the Handle 10673/100, the second version 10673/100.2, the third version
10673.3 and so on. This strategy has the downside that there is no handle pointing always to the newest
version. But each version gets an identifier that can be use to cite exactly this version. If page numbers changes
in newer editions the old citations stay valid. This strategy makes sense especially if you present the version
history to all users. In the image below you see a version history using this strategy.
In DSpace 4 and 5 only the strategy using canonical handles (one handle that always points to the newest
version) were implemented. In DSpace 6 the strategy of creating a new handle for each version was
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 319 of 901
DSpace 6.x Documentation
implemented. With DSpace 6 this new strategy become the default. The strategy using canonical handle still
exists in DSpace but you have to enable the VersionedHandleIdentifierWithCanonicalHandles in
the file [dspace]/config/spring/api/identifier-serice.xml. With DSpace 6 versioned DOIs were
introduced using the strategy that every new version gets a new DOI (extended by a dot and the version
numbers for versions >= 2). To use versioned Handle you have to enable DOIs, you have to use DataCite as
registration agency and you have to enable the VersionedDOIIdentifierProvider in the named
configuration file.
You can configure which persistent identifiers should be used by editing following XML configuration file,
deployed under your dspace installation directory:
[dspace_installation_dir]/config/spring/api/identifier-service.xml
No changes to this file are required to enable Versioning. This file is currently only relevant if you want to keep
the identifier strategy from DSpace 4 and 5 or if you want to enable DOIs or even versioned DOIs.
Version History Visibility
By default, all users will be able to see the version history. To ensure that only administrators can see the
Version History, enable versioning.item.history.view.admin in the [dspace]/config/modules
/versioning.cfg OR in your local.cfg file.
versioning.item.history.view.admin=false
Allowing submitters to version their items (JSPUI only)
With DSpace 6.0 it became possible to allow submitters to create new versions of their own items. This
currently works in JSPUI only and is switched off by default to keep the same behavior as XMLUI. The new
versions are going through the normal workflow process if the collection is configured this way. To allow
submitters to create new versions of Item they originally submitted, you have to change the configuration
property versioning.submitterCanCreateNewVersion and set it to true.It is part of the configuration
file [dspace]/config/modules/versioning.cfg but can be overridden in your local.cfg too.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 320 of 901
DSpace 6.x Documentation
Identified Challenges & Known Issues in DSpace 4.0
Item Level Versioning has a substantial conceptual impact on many DSpace features. Therefore it has been
accepted into DSpace 3.0 as an optional feature and it is still an option feature in DSpace 4.0. Following
challenges have been identified in the current implementation. As an early adopter of the Item Level Versioning
feature, your input is greatly appreciated on any of these.
Only Administrators and Collection/Community Administrators can add new versions
There is currently no configuration option to allow submitters to create new versions of an item. This
functionality is restricted to Administrators and Collection/Community Administrators. In a context where original
submission of DSpace items is done by non-administrator users, it might also make sense to allow them to
create new versions. Especially given the fact that new versions have to pass through the workflow anyway.
Conceptual compatibility with Embargo
Lifting an embargo currently does not interact with Item Level Versioning. Additional implementation would be
required to ensure that lifting an embargo actually creates a new version of the item.
Conceptual compatibility with Item Level Statistics
Both on the level of pageviews and downloads, different versions of an item are treated as different items. As a
result, an end user will have the impression that the stats are being "reset" once a new version is installed,
because the previous downloads and pageviews are allocated to the previous version.
One possible solution would be to present an end user with aggregated statistics across all viewers, and give
administrators the possibility to view statistics per version.
Exposing version history
The version history is added on the bottom of a versioned item page. A repository administrator can either
decide to show this to all users, or restrict it to admins only. If it is shown to admins only, an end user will have
no way to find the way to an older version. Since DSpace 6 you can also configure if the submitter's name and
email address should be part of the version history or if they should be hidden. To show the submitter might
actually be useful if the editor account is always a generic institutional email address, but may conflict with local
privacy laws if any personal details are included.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 321 of 901
DSpace 6.x Documentation
Hide Submitter details in version table
In either the [dspace]/config/modules/versioning.cfg configuration file or your local.cfg, you can
customize the configuration option versioning.item.history.include.submitter. By default this is
set to false, which means that information about the submitter is only viewable by administrators. If you want to
expose the submitters information to everyone (which be useful if all submitters uses generic institutional email
addresses, but may conflict with local privacy laws if personal details are included) you can set this
configuration property to true.
# The property item.history.include.submitter controls whether the name of
# the submitter of a version should be included in the version history of
# an item.
versioning.item.history.include.submitter=false
Credits
The initial contribution of Item Level Versioning to DSpace 3.0 was implemented by @mire with kind support
from:
MBLWHOI Library
Woods Hole Oceanographic Institution
Marine Biology Laboratory, Center for Library and Informatics, History and Philosophy of Science
program
Arizona State University, Center for Biology and Society
Dryad
The JSPUI compatibility has been added in DSpace 4.0 by CINECA
4.4.5 Mapping Items
Introduction
Using the Item Mapper
Implications
Mapping collection vs Owning collection
Mapping an item does not modify access rights
Introduction
The Item Mapper is a tool in the DSpace web user interface allowing repository managers to display the same
item in multiple collections at once. Thanks to this feature, a repository manager is not forced to duplicate items
to display them in different collections
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 322 of 901
DSpace 6.x Documentation
Using the Item Mapper
In the XML User Interface, the item mapper can be accessed from the "Context" menu from a collection
homepage.
In the JSP User Interface, the item mapper can be accessed from the "Admin Tools" menu on the right side of a
collection homepage.
Item Mapper - JSPUI Interface
Item Mapper - XMLUI Interface
The item mapper offers an interface to search for items in the repository with the goal of mapping them to the
collection from where you accessed the Item Mapper. While the JSPUI only offers a search for author names,
the XMLUI Item Mapper offers a broader search.
The list of items mapped into the current collection can be consulted through the Item Mapper page. While
JSPUI immediately shows the list of mapped items, the XMLUI requires you to click "Browse mapped items" in
order to access the list.
The list of mapped items provides the functionality to remove the mapping for selected items.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 323 of 901
DSpace 6.x Documentation
Implications
Mapping collection vs Owning collection
The relation between an item and the collection in which it is mapped is different from the relation that this item
has with the collection to which it was originally submitted. This second collection is referred to as the "owning"
collection. When an item is deleted from the owning collection, it automatically disappears from the mapping
collection. From within the mapping collection, the only thing that can be deleted is the mapping relation.
Removing this mapping relation does not affect the presence of the item in the owning collection.
Mapping an item does not modify access rights
When an item gets mapped into a collection, it does not receive new access rights. I t retains the authorizations
that it inherited from the collection that "owns" it. Collection admins who do not have read access to an item will
not be able to map them to other collections.
4.4.6 Metadata Recommendations
/**/
Recommended Metadata Fields
Local Fields
Recommended Metadata Fields
DSpace provides a broad list of metadata fields out of the box (see: Metadata and Bitstream Format Registries),
and a variety of options for adding content to DSpace (both from the UI and from other services). No matter
which Ingest option you use, DSpace recommends ensuring that the following metadata fields are specified:
Title (dc.title)
When submitting an Item via the DSpace web user interface, this field is required.
If you add an Item to DSpace through another means (SWORD, etc), it is recommend to specify a
title for an Item. Without a title, the Item will show up in DSpace a "Untitled".
Publication Date (dc.date.issued)
When submitting an Item via the DSpace web user interface, this field is required (by default).
However, your System Administrator can choose to enable the "Initial Questions" step
within the Submission User Interface. Enabling this step will cause the following to occur: If
the item is said to be "published", then the Publication Date will be required. If the item is
said to be "unpublished" then the Publication Date will be auto-set to today's date (date of
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 324 of 901
DSpace 6.x Documentation
submission). WARNING: Google Scholar has recommended against automatically
assigning this "dc.date.issued" field to the date of submission as it often results in incorrect
dates in Google Scholar results. See DS-1481 and DS-1745 for more details.
If you add and Item to DSpace through another means (SWORD, etc), it is recommended to
specify the date in which an Item was published, in ISO-8601 (e.g. 2007, 2008-01, or 2011-03-04).
This ensures DSpace can accurately report the publication date to services like Google Scholar. If
an item is unpublished, you can either chose to leave this blank, or pass in the literal string "today"
(which will tell DSpace to automatically set it to the date of ingest)
DSpace will not auto-assign a "dc.date.issued"
As of DSpace 4.0, the system will not assign a "dc.date.issued" when unspecified.
Previous versions of DSpace (3.0 or below) would set "dc.date.issued" to the date of
accession (dc.date.accessioned), if it was unspecified during ingest.
If you are adding content to DSpace without using the DSpace web user interface, there
are two recommended options for assigning "dc.date.issued"
If the item is previously published before, please set "dc.date.issued" to the date
of publication in ISO-8601(e.g. 2007, 2008-01, or 2011-03-04)
If the item has never been previously published, you may set "dc.date.
issued='today'" (the literal string "today"). This will cause DSpace to automatically
assign "dc.date.issued" to the date of accession (dc.date.accessioned), as it did
previously
You can also chose to leave "dc.date.issued" as unspecified, but then the
new Item will have an empty date within DSpace.
Obviously, we recommend specifying as much metadata as you can about a new Item. For a full list of
supported metadata fields, please see: Metadata and Bitstream Format Registries
Local Fields
You may encounter situations in which you will require an appropriate place to store information that does not
immediately fit with the description of a field in the default registry. The recommended practice in this situation is
to create new fields in a separate schema. You can choose your own name and prefix for this schema such as
local. or myuni.
It is generally discouraged to use any of the fields from the default schema as a place to store information that
doesn't correspond with the fields description. This is especially true if you are ever considering the option to
open up your repository metadata for external harvesting.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 325 of 901
DSpace 6.x Documentation
4.4.7 Moving Items
Moving Items via Web UI
Moving Items via the Batch Metadata Editor
Moving Items via Web UI
It is possible for administrators to move items one at a time using either the JSPUI or the XMLUI. When editing
an item, on the 'Edit item' screen select the 'Move Item' option. To move the item, select the new collection for
the item to appear in. When the item is moved, it will take its authorizations (who can READ / WRITE it) with it.
If you wish for the item to take on the default authorizations of the destination collection, tick the 'Inherit default
policies of destination collection' checkbox. This is useful if you are moving an item from a private collection to a
public collection, or from a public collection to a private collection.
Note: When selecting the 'Inherit default policies of destination collection' option, ensure that this will not
override system-managed authorizations such as those imposed by the embargo system.
Moving Items via the Batch Metadata Editor
Items may also be moved in bulk by using the CSV batch metadata editor (see Editing Collection Membership
section under Batch Metadata Editing).
4.4.8 ORCID Integration
Introduction
Use case and high level benefits
Enabling the ORCID authority control
Importing existing authors & keeping the index up to date
Different possible use cases for Index-authority script
Metadata value WITHOUT authority key in metadata
Metadata that already has an authority key from an external source (NOT auto-generated
by DSpace)
Metadata that has already a new dspace generated uid authority key
Processing on records in the authority cache
Submission of new DSpace items - Author lookup
Admin Edit Item
Editing existing items using Batch CSV Editing
Storage of related metadata
Configuration
Adding additional fields under ORCID
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 326 of 901
DSpace 6.x Documentation
Integration with other systems beside ORCID
FAQ
Which information from ORCID is currently indexed in the authority cache?
How can I index additional fields in the authority cache?
How can I use the information stored in the authority cache?
How to add additional metadata fields in the authority cache that are not related to ORCID?
What happens to data if another authority control was already present?
Where can I find the URL that is used to lookup ORCIDs?
Introduction
The ORCID integration adds ORCID compatibility to the existing solutions for Authority control in DSpace.
String names of authors are still being stored in DSpace metadata. The authority key field is leveraged to store
a uniquely generated internal ID that links the author to more extended metadata, including the ORCID ID and
alternative author names.
This extended metadata is stored and managed in a dedicated SOLR index, the DSpace authority cache.
Use case and high level benefits
The vision behind this project consists of the following two aspects:
Lowering the threshold to adopt ORCID for the members of the DSpace community
ORCID’s API has enabled developers across the globe to build points of integration between ORCID and third
party applications. Up until today, this meant that members of the DSpace community were still required to
implement front-end and back-end modifications to the DSpace source code in order to leverage these APIs. As
DSpace aims to provide turnkey Institutional Repository functionality, the platform is expected to provide more
functionality out of the box. Only an elite selection of members in the DSpace community has software
development resources readily available to implement this kind of functionality. By contributing a solution
directly to the core DSpace codebase, this threshold to adopt ORCID functionality in DSpace repositories is
effectively lowered. The ultimate goal is to allow easy adoption of ORCID without customization of the DSpace
software, by allowing repository administrators to enable or disable functionality by means of user friendly
configuration.
Address generic use cases with appealing end user functionality
This proposal aims to provide user friendly features for both repository administrators as well as non- technical
end users of the system. The addition of ORCID functionality to DSpace should not come at the cost of making
the system more difficult for administrators and end users to use. Scope With this vision in mind, the project
partners wanted to tackle the first phases for repository managers of existing DSpace repositories: ensuring that
ORCIDs are properly associated with new works entering the system, as well as providing functionality to
efficiently batch-update content already existing in the system, with unambiguous author identity information.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 327 of 901
DSpace 6.x Documentation
Enabling the ORCID authority control
JSPUI Support
In DSpace 5.0 the functionality only includes user interface functionality for the DSpace XML User
Interface.
XMLUI Theme Support
In DSpace 5.0 the functionality only adds support for the XMLUI Mirage and Mirage 2 themes. Older
XMLUI themes including Kubrick, Reference and Classic are currently unsupported.
If you wish to enable this feature, some changes are required to the dspace.cfg file. The first step is to
activate the authority as a valid option for authority control, this is done by adding/setting an additional plugin in
the plugin.named.org.dspace.content.authority.ChoiceAuthority property. An example of this
can be found below.
plugin.named.org.dspace.content.authority.ChoiceAuthority = \
org.dspace.content.authority.SolrAuthority = SolrAuthorAuthority
The feature relies on the following configuration parameters in dspace.cfg. To activate the default settings it
suffices to remove the comment hashes ("#") for the following lines. See the section at the bottom of this page
what these parameters mean exactly and how you can tweak the configuration.
solr.authority.server=${solr.server}/authority
choices.plugin.dc.contributor.author = SolrAuthorAuthority
choices.presentation.dc.contributor.author = authorLookup
authority.controlled.dc.contributor.author = true
authority.author.indexer.field.1=dc.contributor.author
The final part of configuration is to add the authority consumer in front of the list of event consumers. Add
"authority" in front of the list as displayed below.
event.dispatcher.default.consumers = authority, versioning, discovery, eperson, harvester
Importing existing authors & keeping the index up to date
When first enabled the authority index will be empty, to populate the authority index run the following script:
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 328 of 901
DSpace 6.x Documentation
[dspace]/bin/dspace index-authority
This will iterate over every metadata under authority control and create records of them in the authority index.
The metadata without an authority key will each be updated with an auto generated authority key. These will not
be matched in any way with other existing records. The metadata with an authority key that does not already
exist in the index will be indexed with those authority keys. The metadata with an authority key that already exist
in the index will be re-indexed the same way. These records remain unchanged.
Different possible use cases for Index-authority script
Metadata value WITHOUT authority key in metadata
“Luyten, Bram” is present in the metadata without any authority key.
GOAL: “Luyten, Bram” gets added in the cache ONCE
All occurences of “Luyten, Bram” in the DSpace item metadata will become linked with the same generated uid.
Metadata that already has an authority key from an external source (NOT auto-generated by
DSpace)
“Snyers, Antoine” is present with authority key “u12345”
The old authority key needs to be preserved in the item metadata and duplicated in the cache.
“u12345” will be copied to the authority cache and used as the authority key there.
Metadata that has already a new dspace generated uid authority key
Item metadata already contains an author with name “Haak, Danielle” and a uid in the authority field 3dda25716be8-4102-a47b-5748531ae286
This uid is preserved and no new record is being created in the authority index.
Processing on records in the authority cache
Running this script again will update the index and keep the index clean. For example if an author occurs in a
single item and that item is deleted the script will need to be run again to remove it from the index. When run
again it will remove all records that no longer have a link to existing authors in the database.
Submission of new DSpace items - Author lookup
The submissions forms have not changed much. The only thing you can notice is an extra button next to the
input fields for the author names. Next to the Add button, which is common for all repeatable fields, there is the
Lookup & Add button.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 329 of 901
DSpace 6.x Documentation
It's by clicking on that button that the Look-up User Interface appears. If an author name was filled in but not
added yet, the Lookup User Interface will immediately perform a search for that name. Otherwise the search
field remains empty and a list of known authors is displayed. The list of authors is updated as you type in the
search box.
Authors that already appear somewhere in the repository are differentiated from the authors that have been
retrieved from ORCID.
The authors retrieved from ORCID have their name italicized and they're listed after the authors that are found
in the repository.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 330 of 901
DSpace 6.x Documentation
Click on one of these names to see more information about them. The message "There's no one selected" will
vanish, making room for the author's information. The available information can vary: Authors imported from
ORCID have an orcid where the others do not. Authors that have been added without look-up only show their
last name and first name.
To add an author from the Look-up User Interface, you select the author in the list and then you click on the
"Add This Person" button.
To add an author without look-up, you don't go through the Look-up User Interface. Instead you simply use the
"Add" button in the submissions forms.
Admin Edit Item
In the edit metadata page, under the values for the dc.contributor.author fields, an extra line shows the author
ID together with a lock icon and a Lookup button. The author ID cannot be changed manually. However the
Lookup button will help you change the author name and ID at the same time.
Clicking the Lookup button brings back the Lookup User Interface. This works just the same way as in the
submission forms.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 331 of 901
DSpace 6.x Documentation
Editing existing items using Batch CSV Editing
Instructions on how to use the Batch CSV Editing are found on the Batch Metadata Editing documentation page
.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 332 of 901
DSpace 6.x Documentation
ORCID Integration is provided through the Batch CSV Editing feature with an extra available headers "ORCID:
dc.contributor.author". The usual CSV headers only contain the metadata fields: e.g. "dc.contributor.author". In
addition to the traditional header, another dc.contributor.author header can be added with the "ORCID:" prefix.
The values in this column are supposed to be ORCIDs.
For each of the ORCID authors a lookup will be done and their names will be added to the metadata. All the
non-ORCID authors will be added as well. The authority keys and solr records are added when the reported
changes are applied.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 333 of 901
DSpace 6.x Documentation
Storage of related metadata
ORCID authorities not only link a digital identifier to a name. It regroups a load of metadata going from
alternative names and email addresses to keywords about their works and much more. The metadata is
obtained by querying the ORCID web services. In order to avoid querying the ORCID web services every time,
all these related metadata is gathered in a "metadata authority cache" that DSpace can access directly.
In practice the cache is provided by an apache solr server. When a look-up is made and an author is chosen
that is not yet in the cache, a record is created from an ORCID profile and added to the cache with the list of
related metadata. The value of the Dublin Core metadata is based on the first and last name as they are set in
the ORCID profile. The authority key for this value links directly to the solr document's id. DSpace does not
provide a way to edit these records manually.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 334 of 901
DSpace 6.x Documentation
The information in the authority cache can be updated by running the following command line operation:
Command used:
[dspace]/bin/dspace dsrun org.dspace.authority.UpdateAuthorities
Arguments
description
-i
update specific solr records with the given internal ids (comma-separated)
-h
prints this help message
This will iterate over every solr record currently in use (unless the -i argument is provided), query the ORCID
web service for the latest data and update the information in the cache. If configured, the script will also update
the metadata of the items in the repository where applicable.
The configuration property can be set in config/modules/solrauthority.cfg, or overridden in your
local.cfg (see Configuration Reference).
solrauthority.auto-update-items = false | true
When set to true and this is script is run, if an authority record's information is updated the whole repository will
be scanned for this authority. Every metadata field with this authority key will be updated with the value of the
updated authority record.
Configuration
In the Enabling the ORCID authority control section, you have been told to add this block of configuration.
NOTE: for DSpace 6x you can use local.cfg for these
For all of the configuration options described below, you can use either dspace.cfg or local.cfg. Either
will work. It is possible that, when you compile your code with Maven, and you have tests enabled,
your build will fail. DSpace unit tests utilize parts of dspace.cfg, and the configuration options you will
utilize below are known to cause unit test errors. The easiest way to avoid this situation is to use the
local.cfg file.
solr.authority.server=${solr.server}/authority
choices.plugin.dc.contributor.author = SolrAuthorAuthority
choices.presentation.dc.contributor.author = authorLookup
authority.controlled.dc.contributor.author = true
authority.author.indexer.field.1=dc.contributor.author
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 335 of 901
DSpace 6.x Documentation
The ORCID Integration feature is an extension on the authority control in DSpace. Most of these properties are
extensively explained on the Authority Control of Metadata Values documentation page. These will be revisited
but first we cover the properties that have been newly added.
The solr.authority.server is the url to the solr core. Usually this would be on the solr.server
next to the oai, search and statistics cores.
authority.author.indexer.field.1 and the subsequent increments configure which fields will be
indexed in the authority cache. However before adding extra fields into the solr cache, please read the
section about Adding additional fields under ORCID.
That's it for the novelties. Moving on to the generic authority control properties:
With the authority.controlled property every metadata field that needs to be authority controlled is
configured. This involves every type of authority control, not only the fields for ORCID integration.
The choices.plugin should be configured for each metadata field under authority control. Setting the
value on SolrAuthorAuthority tells DSpace to use the solr authority cache for this metadatafield, cfr.
Storage of related metadata.
The choices.presention should be configured for each metadata field as well. The traditional values
for this property are select|suggest|lookup. A new value, authorLookup, has been added to be
used in combination with the SolrAuthorAuthority choices plugin. While the other values can still be used,
the authorLookup provides a richer user interface in the form of a popup on the submission page.
The browse indexes need to point to the new authority-controlled index: webui.browse.index.2 =
author:metadata:dc.contributor.*,dc.creator:text should become webui.browse.index.2
= author:metadataAuthority:dc.contributor.author:authority
More existing configuration properties are available but their values are independent of this feature and
their default values are usually fine: choices.closed , authority.required, authority.
minconfidence .
For the cache update script, one property can be set in config/modules/solrauthority.cfg:
auto-update-items = false | true
The default value for when the property is missing is false.
The final part of configuration is to add the authority consumer in front of the list of event consumers. Add
"authority" in front of the list as displayed below.
event.dispatcher.default.consumers = authority, versioning, discovery, eperson, harvester
Without the consumer there is no automatic indexing of the authority cache and the metadata will not even have
authority keys.
Changes to the configuration always require a server restart before they're in effect.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 336 of 901
DSpace 6.x Documentation
Adding additional fields under ORCID
Other metadata fields besides "dc.contributor.author" can benefit from the ORCID authority control at the same
time. Here is an example of how to get the same ORCID functionality for the "dc.contributor.editor" metadata
field assuming that "dc.contributor.author" is already configured correctly. It can be achieved by modifying
configuration files only.
First add the same configuration fields that have been added for the "dc.contributor.author"
choices.plugin.dc.contributor.editor = SolrAuthorAuthority
choices.presentation.dc.contributor.editor = authorLookup
authority.controlled.dc.contributor.editor = true
authority.author.indexer.field.1=dc.contributor.author
authority.author.indexer.field.2=dc.contributor.editor
This is enough to get the look-up interface on the submission page and on the edit metadata page. The
authority keys will be added and indexed with the information from orcid just as it happens with the Authors.
But you're not completely done yet, There is one more configuration step. Because now when adding new
editors in the metadata that are not retrieved through the external look-up, their first and last name will not be
displayed in the look-up interface next time you look for them.
To fix this, open the file at config/spring/api/orcid-authority-services.xml and find this spring
bean:
The map inside the "fieldDefaults" property needs an additional entry for the editor field:
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 337 of 901
DSpace 6.x Documentation
With this last change everything is set up to work correctly. The rest of this configuration file is meant for JAVA
developers that wish to provide integration with other systems beside ORCID. Developers that wish to display
other fields than first and last name can also have a look in that section.
Note: Each metadata field has a separate set of authority records. Authority keys are not shared between
different metadata fields. E. g. multiple dc.contributor.author can have the same authority key and point to the
same authority record in the cache. But when an ORCID is chosen for a dc.contributor.editor field, a separate
record is made in the cache. Both records are updated from the same source and will contain the same
information. The difference is that when performing a look-up of a person that has been introduced as an
authority for an author field but not yet as an editor, it will show as record that is not yet present in the repository
cache.
Integration with other systems beside ORCID
The authority cache and look-up functionality can be extended to use other sources than ORCID or to show
more information in the look-up interface. However some JAVA development is necessary for this. Specific
instructions can be found in the readme file of the org.dspace.authority package.
FAQ
Which information from ORCID is currently indexed in the authority cache?
Here is a breakdown of the fields stored in the solr cache.
The system/dspace related fields are: id, field, value, deleted, creation_date, last_modified_date, authority_type
.
The fields with data coming directly from ORCID are: first_name, last_name, name_variant, orcid_id,
label_researcher_url, label_keyword, label_external_identifier, label_biography, label_country. The field
all_labels contains all the values from the other fields starting with "label_".
How can I index additional fields in the authority cache?
There is currently no configuration to control which fields are indexed. The only way to achieve this is to modify
the source code.
List of the files at work for this job:
config/spring/api/orcid-authority-services.xml: OrcidSource contains the URL for orcid's REST
API.
org.dspace.authority.orcid.Orcid makes the REST call
+ org.dspace.authority.orcid.xml.XMLtoBio converts the received XML to a java object (Bio).
+ org.dspace.authority.orcid.model.Bio
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 338 of 901
DSpace 6.x Documentation
+ org.dspace.authority.orcid.OrcidAuthorityValue#create(org.dspace.authority.orcid.model.Bio) inserts all the
values from Bio into the AuthorityValue subclass.
+ org.dspace.authority.orcid.OrcidAuthorityValue#getSolrInputDocument defines what's included in solr.
The files preceded with a '+' would be necessary to modify to add more info into the cache.
How can I use the information stored in the authority cache?
The look-up UI is currently the only place this information is sent to. However just a limited number of fields are
sent. The place in the source code to modify to get more fields there is org.dspace.authority.orcid.
OrcidAuthorityValue#choiceSelectMap. This is also documented in the readme of the org.dspace.authority
package.
How to add additional metadata fields in the authority cache that are not related to
ORCID?
Make the same configuration step as for adding additional fields under ORCID. Currently the ORCID
suggestions cannot be turned off for specific fields, that would require custom code.
What happens to data if another authority control was already present?
As long as the metadata does not get indexed, there will be no changes. However every time any metadata of
an item is modified, the metadata under authority control for that item will be re-indexed. When that happens a
record will be inserted in the solr cache. That record's ID will be the authority key of the metadata. This can be
done for all metadata at once with the index-authority script.
In short: authority keys that exist prior to enabling the solrauthority are kept. They just won't show in the look-up
until they are indexed.
Where can I find the URL that is used to lookup ORCIDs?
It is found in the config/spring/api/orcid-authority-services.xml configuration file. Look for the
, which is initialized with a URL of http://pub.orcid.org
4.4.9 PDF Citation Cover Page
Enabling PDF Cover Pages may affect your site's visibility in Google Scholar (and similar
search engines)
Google Scholar specifically warns against automatically generating PDF Cover Pages, as they can
break the metadata extraction techniques used by their search engine. Be aware that enabling PDF
Cover Pages may also cause those items to no longer be indexed by Google Scholar. For more
information, please see the "Indexing Repositories: Pitfalls and Best Practices" talk from Anurag
Acharya (co-creator of Google Scholar) presented at the Open Repositories 2015 conference.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 339 of 901
DSpace 6.x Documentation
A known issue with the current implementation of the PDF Citation Cover Page is that primarily only
English/Roman characters are supported. This is due to a limitation in the tool used to generate PDFs.
See DS-2224 for more details on this issue
Adding a cover page to retrieved documents from DSpace that include additional citation information has been
sought, as documents uploaded to the repository might have had their context stripped from them, when they
are just a PDF. Context that might have surrounded the document would be the journal, publisher, edition, and
more. Without that information, the document might just be a few pages of text, with no way to piece it together.
Since repository policy might be to include this information as metadata to the Item, this metadata can be added
to the citation cover page, so that the derivative PDF includes all of this information.
The citation cover page works by only storing the original PDF in DSpace, and then generating the citationcover-page PDF on-the-fly. An alternative set up would be to run the PDF Citation Coverpage Curation Task on
the DSpace repository contents, and then disseminate the pre-generated citation-version instead of generating
it on the fly.
Screenshot of generated citation cover page
Configuration settings for Citation Cover Page
Configuration file renamed to citation-page.cfg and configurations names have changed
As of DSpace 6.0, the configuration file for this feature was renamed from disseminate-citation.
cfg to citation-page.cfg. The renaming was to clarify the purpose of this configuration file, as its
previous name was misleading / confusing to some users.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 340 of 901
DSpace 6.x Documentation
In addition, all configurations below have now been prefixed with "citation-page" (e.g. the
enable_globally configuration has been renamed to citation-page.enable_globally)
In the {dspace.dir}/config/modules/citation-page.cfg file review the following fields to make sure
they are uncommented:
Property:
citation-page.enable_globally
Example
citation-page.enable_globally = true
Values:
Informational
Boolean to determine is citation-functionality is enabled globally for entire site. This will enable
Note:
the citation cover page generator for all PDFs.
Default: disabled
Property:
citation-page.enabled_collections
Example
citation-page.enabled_collections = 1811/123, 1811/234
Values:
Informational
List of collection handles to enable the cover page generator for bitstreams within.
Note:
Default: blank
Property:
citation-page.enabled_communities
Example
citation-page.enabled_communities = 1811/222, 1811/333
Values:
Informational
List of community handles to enable the cover page generator for bitstreams within.
Note:
Default: blank
Property:
citation-page.citation_as_first_page
Example
citation-page.citation_as_first_page = true
Values:
Informational
Should the citation page be the first page cover (true), or the last page (false).
Note:
Default: true, (first page)
Property:
citation-page.header1
Example
citation-page.header1 = University of Higher Education
Values:
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 341 of 901
DSpace 6.x Documentation
Property:
citation-page.enable_globally
Informational
First row of header, perhaps for institution / university name. Commas separate multiple
Note:
sections of the header (see screenshot above)
Default Value: DSpace Institution
Property:
citation-page.header2
Example
citation-page.header2 = Scholar Archive\, http://archive.example.com
Values:
Informational
Second row of header, perhaps put your DSpace instance branded name, and url to your
Note:
DSpace. A comma is used to separate instance name, and the URL
Default Value: DSpace Repository, http://dspace.org
Property:
citation-page.fields
Example
citation-page.fields = dc.date.issued, dc.title, dc.creator, dc.contributor.author, dc.publisher,
Values:
_line_, dc.identifier.citation, dc.identifier.uri
Informational
Metadata fields to display on the citation PDF. Specify in schema.element.qualifier form, and
Note:
separate fields by a comma. If you want to have a horizontal line break, use _line_
Default Value: dc.date.issued,dc.title,dc.creator,dc.contributor.author,dc.publisher,_line_,dc.
identifier.citation,dc.identifier.uri
Property:
citation-page.footer
Example
citation-page.footer = Downloaded from Scholar Archive at University of Higher Education\,
Values:
an open access institutional repository. All Rights Reserved.
Informational
Footer text at the bottom of the citation page. It might be some type of license or copyright
Note:
information, or just letting the recipient know where they downloaded the file from.
Default Value: Downloaded from DSpace Repository\, DSpace Institution's institutional
repository
NOTE: any commas appearing in this text should be escaped as "\,". See example above.
4.4.10 Updating Items via Simple Archive Format
Item Update Tool
DSpace Simple Archive Format
ItemUpdate Commands
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 342 of 901
DSpace 6.x Documentation
CLI Examples
Item Update Tool
ItemUpdate is a batch-mode command-line tool for altering the metadata and bitstream content of existing items
in a DSpace instance. It is a companion tool to ItemImport and uses the DSpace simple archive format to
specify changes in metadata and bitstream contents. Those familiar with generating the source trees for
ItemImporter will find a similar environment in the use of this batch processing tool.
For metadata, ItemUpdate can perform 'add' and 'delete' actions on specified metadata elements. For
bitstreams, 'add' and 'delete' are similarly available. All these actions can be combined in a single batch run.
ItemUpdate supports an undo feature for all actions except bitstream deletion. There is also a test mode, as
with ItemImport. However, unlike ItemImport, there is no resume feature for incomplete processing. There is
more extensive logging with a summary statement at the end with counts of successful and unsuccessful items
processed.
One probable scenario for using this tool is where there is an external primary data source for which the
DSpace instance is a secondary or down-stream system. Metadata and/or bitstream content changes in the
primary system can be exported to the simple archive format to be used by ItemUpdate to synchronize the
changes.
A note on terminology: item refers to a DSpace item. metadata element refers generally to a qualified or
unqualified element in a schema in the form [schema].[element].[qualifier] or [schema].
[element] and occasionally in a more specific way to the second part of that form. metadata field refers to a
specific instance pairing a metadata element to a value.
DSpace Simple Archive Format
As with ItemImporter, the idea behind the DSpace's simple archive format is to create an archive directory with
a subdirectory per item. There are a few additional features added to this format specifically for ItemUpdate.
Note that in the simple archive format, the item directories are merely local references and only used by
ItemUpdate in the log output.
The user is referred to the previous section DSpace Simple Archive Format.
Additionally, the use of a delete_contents is now available. This file lists the bitstreams to be deleted, one
bitstream ID per line. Currently, no other identifiers for bitstreams are usable for this function. This file is an
addition to the Archive format specifically for ItemUpdate.
The optional suppress_undo file is a flag to indicate that the 'undo archive' should not be written to disk. This file
is usually written by the application in an undo archive to prevent a recursive undo. This file is an addition to the
Archive format specifically for ItemUpdate.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 343 of 901
DSpace 6.x Documentation
ItemUpdate Commands
Command used:
[dspace]/bin/dspace itemupdate
Java class:
org.dspace.app.itemupdate.ItemUpdate
Arguments short and
Description
(long) forms:
-a or --
Repeatable for multiple elements. The metadata element should be in the form dc.x
addmetadata
or dc.x.y. The mandatory argument indicates the metadata fields in the dublin_core.
[metadata
xml file to be added unless already present (multiple fields should be separated by a
element]
semicolon ';'). However, duplicate fields will not be added to the item metadata
without warning or error.
-d or --
Repeatable for multiple elements. All metadata fields matching the element will be
deletemetadata
deleted.
[metadata
element]
-A or --
Adds bitstreams listed in the contents file with the bitstream metadata cited there.
addbitstreams
-D or --
Not repeatable. With no argument, this operation deletes bitstreams listed in the
deletebitstreams
deletes_contents file. Only bitstream IDs are recognized identifiers for this
[filter plug
operation. The optional filter argument is the classname of an implementation of
classname or
org.dspace.app.itemdupate.BitstreamFilter class to identify files for
alias]
deletion or one of the aliases (e.g. ORIGINAL, ORIGINAL_AND_DERIVATIVES,
TEXT, THUMBNAIL) which reference existing filters based on membership in a
bundle of that name. In this case, the delete_contents file is not required for any
item. The filter properties file will contains properties pertinent to the particular filer
used. Multiple filters are not allowed.
-h or --help
Displays brief command line help.
-e or --eperson
Email address of the person or the user's database ID (Required)
-s or --source
Directory archive to process (Required)
-i or --itemfield
Specifies the metadata field that contains the item's identifier; Default value is "dc.
identifier.uri" (Optional)
-t or --test
Runs the process in test mode with logging. But no changes applied to the DSpace
instance. (Optional)
-P or --provenance
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 344 of 901
DSpace 6.x Documentation
Prevents any changes to the provenance field to represent changes in the bitstream
content resulting from an Add or Delete. In other words, when this flag is specified,
no new provenance information is added to the DSpace Item when adding/deleting a
bitstream. No provenance statements are written for thumbnails or text derivative
bitstreams, in keeping with the practice of MediaFilterManager. (Optional)
-F or --filter-
The filter properties files to be used by the delete bitstreams action (Optional)
properties
-v or --verbose
Turn on verbose logging.
CLI Examples
Adding Metadata:
[dspace]/bin/dspace itemupdate -e joe@user.com -s [path/to/archive] -a dc.description
This will update all DSpace Items listed in your archive directory, adding a new dc.description metadata
field. Items will be located in DSpace based on the handle found in 'dc.identifier.uri' (since the -i argument
wasn't used, the default metadata field, dc.identifier.uri, from the dublin_core.xml file in the archive folder, is
used).
4.5 Managing Community Hierarchy
Sub-Community Management
4.5.1 Sub-Community Management
DSpace provides an administrative tool‚ 'CommunityFiliator'‚ for managing community sub-structure. Normally
this structure seldom changes, but prior to the 1.2 release sub-communities were not supported, so this tool
could be used to place existing pre-1.2 communities into a hierarchy. It has two operations, either establishing a
community to sub-community relationship, or dis-establishing an existing relationship.
The familiar parent/child metaphor can be used to explain how it works. Every community in DSpace can be
either a 'parent' community‚ meaning it has at least one sub-community, or a 'child' community‚ meaning it is a
sub-community of another community, or both or neither. In these terms, an 'orphan' is a community that lacks a
parent (although it can be a parent); 'orphans' are referred to as 'top-level' communities in the DSpace userinterface, since there is no parent community 'above' them. The first operation‚ establishing a parent/child
relationship - can take place between any community and an orphan. The second operation - removing a parent
/child relationship‚ will make the child an orphan.
Command used:
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 345 of 901
DSpace 6.x Documentation
[dspace]/bin/dspace community-filiator
Java class:
org.dspace.administer.CommunityFiliator
Arguments short and (long) forms:
Description
-s or --set
Set a parent/child relationship
-r or --remove
Remove a parent/child relationship
-c or --child
Child community (Handle or database ID)
-p or --parent
Parent community (Handle or database ID
-h or --help
Online help.
Set a parent/child relationship, issue the following at the CLI:
[dspace]/bin/dspace community-filiator --set --parent=parentID --child=childID
(or using the short form)
[dspace]/bin/dspace community-filiator -s -p parentID -c childID
where '-s' or '-set' means establish a relationship whereby the community identified by the '-p' parameter
becomes the parent of the community identified by the '-c' parameter. Both the 'parentID' and 'childID' values
may be handles or database IDs.
The reverse operation looks like this:
[dspace]/bin/dspace community-filiator --remove --parent=parentID --child=childID
(or using the short form)
[dspace]/bin/dspace community-filiator -r -p parentID -c childID
where '-r' or '-remove' means dis-establish the current relationship in which the community identified by
'parentID' is the parent of the community identified by 'childID'. The outcome will be that the 'childID' community
will become an orphan, i.e. a top-level community.
If the required constraints of operation are violated, an error message will appear explaining the problem, and
no change will be made. An example in a removal operation, where the stated child community does not have
the stated parent community as its parent: "Error, child community not a child of parent community".
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 346 of 901
DSpace 6.x Documentation
It is possible to effect arbitrary changes to the community hierarchy by chaining the basic operations together.
For example, to move a child community from one parent to another, simply perform a 'remove' from its current
parent (which will leave it an orphan), followed by a 'set' to its new parent.
It is important to understand that when any operation is performed, all the sub-structure of the child community
follows it. Thus, if a child has itself children (sub-communities), or collections, they will all move with it to its new
'location' in the community tree.
4.6 Statistics and Metrics
4.6.1 DSpace Google Analytics Statistics
Google Analytics Recording
For a number of years now it has been possible to record User Interface traffic by enabling the recording of
Google Analytics data within DSpace using the jspui.google.analytics.key or xmlui.google.analytics.key in the
DSpace configuration file dspace.cfg. Until DSpace version 5.0 only User Interface activity could be recorded,
that is to say that downloads initiated straight from a Google search (or any other search engine) were not
recorded. As of DSpace version 5.0 downloads are now recorded as Google 'Events', so that all item page
views and bitstream downloads are now recorded.
Google Analytics Reporting
As of DSpace version 5.0 it has also become possible to expose that recorded Google Analytics data within
DSpace. At present this is only available to those sites using themes based on the XMLUI Mirage2 theme but it
is hoped that further development will result in it being available for other XMLUI themes and for the JSPUI. The
data is retrieved from Google using the Google Analytics Reporting API v3. This feature is disabled by default,
to enable it please follow the instructions below.
Please read the documentation found at https://developers.google.com/analytics/devguides/reporting/core/v3/
and https://developers.google.com/accounts/docs/OAuth2ServiceAccount. It is the definitive documentation,
however, it is over detailed for our purposes so the critical steps are summarised below. The theory is that as a
developer you would create a Google project, write your application and store the code in the Google code
repository, then create a Google Service Account which your application could use to retrieve data from the
Google Analytics API. In our case we already have our application, DSpace, but we still have to go through the
motions of creating a project in order to be able to be able to generate the Service Account which we need to
allow DSpace to talk to the Google Analytics API.
1. Enable the Google Analytics XMLUI aspect by editing the configuration file {dspace.dir}/config/xmlui.
xconf.
2. Logon to the Google Developers Console https://console.developers.google.com/project with whatever
email address you use to access/manage your existing Google Analytics account(s).
3.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 347 of 901
DSpace 6.x Documentation
3. Create a new Google Project. The assumption is that you are developing some new software and will
make use of the Google code repository. This is not the case but you need to create the skeleton project
before you can proceed to the next step.
4. Enable the Analytics API for the project. In the sidebar on the left, expand APIs & auth. Next, click APIs.
In the list of APIs, make sure the status is ON for the Analytics API.
5. In the sidebar on the left, select Credentials.
6. Select OAuth / Create new Client ID, then in the subsequent popup screen select Service account.
This will automatically generate the required Service Account email address and certificate.
7. Go to your Google Analytics dashboard http://www.google.com/analytics/. Create an account for the
newly generated Service Account email address and give it permission to 'Read and Analyze' at account
level. See *Note below.
8. The generated certificate needs to be placed somewhere that your DSpace application can access and
be referenced as described below in the configuration section..
*Note:- The Google documentation specifies that the Service Account email address should only require 'Read
and Analyze' permission. However, it would appear this may not be the case and it may be necessary to grant
greater permissions, at least initially.
Configuration settings for Google Analytics Statistics
In the [dspace.dir]/config/modules/google-analytics.cfg file review the following fields. These
should be either edited directly or overridden in your local.cfg config file (see Configuration Reference).
Property:
google-analytics.application.name
Value:
Dummy Project
Informational
Not sure if this property is required but it was in the example code provided by Google.
Note:
Please do not delete.
Property:
google-analytics.table.id
Example
ga:12345678
Value:
Informational
Logon to the Google Analytics Dashboard and select the Property (or website in plain
Note:
English) that you wish to target. Then select the Admin section for the property. You should
then be able to select the 'view settings' for the view you are interested in. The View ID should
replace 12345678 below (note - confusingly the Reporting API documentation refers to the
View ID as Table ID).
Property:
google-analytics.account.email
Example
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx@developer.gserviceaccount.com
Value:
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 348 of 901
DSpace 6.x Documentation
Informational
The email address automatically generated when you created the Service Account.
Note:
Property:
google-analytics.certificate.location
Example
/home/example/dslweb--privatekey.p12
Value:
Informational
The certificate file automatically generated when you created the Service Account.
Note:
Property:
google-analytics.authorization.admin.usage
Example
true
Value:
Informational
Control if the statistics pages should be only shown to authorized users. If enabled, only the
Note:
administrators for the DSpaceObject will be able to view the statistics. If disabled, anyone with
READ permissions on the DSpaceObject will be able to view the statistics.
4.6.2 Elasticsearch Usage Statistics
Elasticsearch Usage Statistics feature is deprecated in 6.0
As of the DSpace 6.0 release, the Elasticsearch Usage Statistics feature is deprecated, and no new
enhancements/improvements will be added. We recommend instead using the default SOLR Statistics
engine and/or DSpace's integration with Google Analytics.
If you are already using Elasticsearch Usage Statistics, you may continue to use them until they are
fully removed in a future release. See DS-2897 for more information.
Added in DSpace 3.0 is an optional statistics engine using Elasticsearch, which may be enabled as an
alternative to the default SOLR Statistics engine (based on Apache SOLR). The motivation for adding
Elasticsearch was to find an alternative statistics processing engine that would handle the workload of a large
amount of statistics data. Additionally, the Elasticsearch statistics display offers another method for creating
statistical queries against your data. Elasticsearch Usage Statistics has been contributed by Peter Dietz of Ohio
State University's Knowledge Bank. The data source for Elasticsearch Statistics is DSpace Usage Events,
where Usage Event is a view or download of a DSpace Object (Bitstream, Item Page, Collection Page,
Community Page). Elasticsearch Statistics is bundled with DSpace, and requires no additional installation of
software, it just needs to be enabled. Elasticsearch is only available for use with XMLUI.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 349 of 901
DSpace 6.x Documentation
What data is being recorded?
The default information below is what DSpace will record about a Usage Event. In DSpace 3.0 the fields of data
collected is not configurable through a configuration setting.
Information about the User Requesting the Content
IP Address
Time of Request
DNS / Hostname
User Agent
isBot, a flag that DSpace thinks that user is a robot or not
Geographical Information about where the user is located:
Continent
Country
Country Code
City
Geographical Latitude/Longitude
Information about the DSpace Resource that was used
DSpace Object ID
DSpace Object Type: (Item, Bitstream, Collection, or Community)
If it is relevant, we also store the hierarchy of where this object exists within DSpace
Owning Community
Owning Collection
Owning Item
Enabling Elasticsearch Statistics
Elasticsearch Statistics is disabled by default in DSpace 3.0, the following steps will enable Elasticsearch so
that you can collect data, and present statistics reports.
Modify dspace/config/xmlui.xconf, and uncomment the aspect, Statistics Elasticsearch.
Enable Elastic Search Statistics in dspace/config/xmlui.xconf
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 350 of 901
DSpace 6.x Documentation
Modify dspace-xmlui/src/main/webapp/WEB-INF/spring/applicationContext.xml and uncomment the following
code block for ElasticSearchLoggerEventListener
Enable ElasticSearchLoggerEventListener
After making these two changes, you will then need to rebuild and restart DSpace.
Importing Legacy Data into Elasticsearch Statistics
Once Elasticsearch Statistics has been enabled, it will begin adding all new Usage Events to its data store. To
import your legacy data, you will need to import the data from the dspace.log files. There is no tool yet that
converts SOLR statistics data to Elasticsearch statistics data.
From the (Windows / Linux) terminal, you will need to use the DSpace Command Launcher to convert the
dspace.log files to a statistics log format. Then you will need to import the statistics log format files into DSpace
Statistics.
The Log Converter program converts log files from dspace.log into an intermediate format that can be inserted
into Elasticsearch Statistics.
Command used:
[dspace]/bin/dspace stats-log-converter
Java class:
org.dspace.statistics.util.ClassicDSpaceLogConverter
Arguments short and
Description
long forms):
Input file
-i or --in
Output file
-o or --out
Adds a wildcard at the end of input and output, so it would mean if -i dspace.
-m or --multiple
log -m was specified, dspace.log* would be converted. (i.e. all of the following:
dspace.log, dspace.log.1, dspace.log.2, dspace.log.3, etc.)
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 351 of 901
DSpace 6.x Documentation
If the log files have been created with DSpace 1.6 or newer
-n or --newformat
Display verbose output (helpful for debugging)
-v or --verbose
Help
-h or --help
An example form of this command would be [dspace]/bin/dspace stats-log-converter -i dspace.
log -o statistics.log -m -n
The Log Importer program takes the intermediate format data produced in the previous step, and imports it into
Elasticsearch Statistics.
Command used:
[dspace]/bin/dspace stats-log-importer-elasticsearch
Java class:
org.dspace.statistics.util.StatisticsImporterElasticSearch
Arguments short
Description
and long forms):
Input file
-i or --in
Adds a wildcard at the end of input and output, so it would mean if -i statistics.
-m or --multiple
log -m was specified, statistics.log* would be imported. (i.e. all of the following:
statistics.log, statistics.log.1, statistics.log.2, statistics.log.3, etc.)
To skip the reverse DNS lookups that work out where a user is from. (The DNS lookup
-s or --skipdns
finds the information about the host from its IP address, such as geographical location,
etc. This can be slow, and wouldn't work on a server not connected to the internet.)
Display verbose output (helpful for debugging)
-v or --verbose
Help
-h or --help
An example form of this command would be [dspace]/bin/dspace stats-log-importerelasticsearch -i statistics.log -m
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 352 of 901
DSpace 6.x Documentation
Viewing Data in Elasticsearch Statistics
In XMLUI, while logged in as an administrator, the Context Panel will have an additional "View Statistics" link
when you browse to a Community, Collection, or Item.
The Statistics Report includes:
Bitstreams with Most Downloads, for all time.
Bitstreams with Most Downloads, previous month.
Total Number of Downloads to Bitstreams within this container, broken down by month.
Number of hits per Country
This data is presented as either a Table or Line Graph, and requires JavaScript to draw the graphics.
4.6.3 SOLR Statistics
DSpace 1.6 and newer versions uses the Apache SOLR application underlying the statistics. SOLR enables
performant searching and adding to vast amounts of (usage) data.
Unlike previous versions, enabling statistics in DSpace does not require additional installation or customization.
All the necessary software is included.
What is exactly being logged ?
Common stored fields for all usage events
Unique stored fields for bitstream downloads
Unique stored fields for search queries
Unique stored fields for workflow events
Web User Interface Elements
Pageview and Download statistics
Home page
Community home page
Collection home page
Item home page
Search Query Statistics
Workflow Event Statistics
Architecture
Configuration settings for Statistics
Pre-1.6 Statistics settings
Upgrade Process for Statistics
Statistics Administration
Converting older DSpace logs into SOLR usage data
Statistics Client Utility
Statistics differences between DSpace 1.7.x and 1.8.0
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 353 of 901
DSpace 6.x Documentation
Displayed file statistics bundle configurable
Statistics differences between DSpace 1.6.x and 1.7.0
SOLR optimization added
SOLR Autocommit
Web UI Statistics Modification (XMLUI Only)
Modifying the number of months, for which statistics are displayed
Custom Reporting - Querying SOLR Directly
Resources
Examples
Top downloaded items by a specific user
Manually Installing/Updating GeoLite Database File
What is exactly being logged ?
DSpace 1.6 and newer
After the introduction of the SOLR Statistics logging in DSpace 1.6, every pageview and file download is logged
in a dedicated SOLR statistics core.
DSpace 3.0 and newer
In addition to the already existing logging of pageviews and downloads, DSpace 3.0 now also logs search
queries users enter in the DSpace search dialog and workflow events.
JSP UI Search Query logging
Due to the very recent addition of Discovery for search & faceted browsing in JSPUI, these search
queries are not yet logged. Regular (non-discovery) search queries are being logged in JSP UI.
Workflow Events logging
Only workflow events, initiated and executed by a physical user are being logged. Automated workflow
steps or ingest procedures are currently not being logged by the workflow events logger.
The logging happens at the server side, and doesn't require a javascript like Google Analytics does, to provide
usage data. Definition of which fields are to be stored happens in the file dspace/solr/statistics/conf/schema.
xml.
Although they are stored in the same index, the stored fields for views, search queries and workflow events are
different. A new field, statistics_type determines which kind of a usage event you are dealing with. The three
possible values for this field are view, search and workflow.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 354 of 901
DSpace 6.x Documentation
1167
251
42
36
20
18
9
0
Manually Installing/Updating GeoLite Database File
The GeoLite Database file (at [dspace]/config/GeoLiteCity.dat) is used by the Statistics engine to generate
location/country based reports. (Note: If you are not using DSpace Statistics, this file is not needed.)
In most cases, this file is installed automatically when you run ant fresh_install. However, if the file
cannot be downloaded & installed automatically, you may need to manually install it.
As this file is also sometimes updated by MaxMind.com, you may also wish to update it on occasion.
You have three options to install/update this file:
1. Attempt to re-run the automatic installer from your DSpace Source Directory ([dspace-source]). This will
attempt to automatically download the database file, unzip it and install it into the proper location:
ant update_geolite
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 365 of 901
1.
DSpace 6.x Documentation
NOTE: If the location of the GeoLite Database file is known to have changed, you can also run
this auto-installer by passing it the new URL of the GeoLite Database File: ant -Dgeolite=
[full-URL-of-geolite] update_geolite
2. OR, you can manually install the file by performing these steps yourself:
First, download the latest GeoLite Database file from http://geolite.maxmind.com/download/geoip
/database/GeoLiteCity.dat.gz
Next, unzip that file to create a file named GeoLiteCity.dat
Finally, move or copy that file to your DSpace installation, so that it is located at [dspace]
/config/GeoLiteCity.dat.
3. OR, you can combine the two alternatives above, by first downloading the GeoLiteCity.dat.gz file to a
location accessible to you, and then configure a .dspace.properties file in your home folder. For example,
create a .dspace.properties file in the home folder of the user who is running ant to deploy dspace, and
add the following line to it:
.dspace.properties
geolite=file:///path/to/your/downloaded/GeoLiteCity.dat.gz
This leaves the original downloading behavior intact, but overrides the URL for the GeoLite Database file from
the maxmind.com site to your own location. This typically speeds up the "download" step to about 1 second.
SOLR Statistics Maintenance
DSpace Log Converter
Filtering and Pruning Spiders
Export SOLR records to intermediate format for import into Elasticsearch
Export SOLR statistics, for backup and moving to another server
Import SOLR statistics, for restoring lost data or moving to another server
Reindex SOLR statistics, for upgrades or whenever the Solr schema for statistics is changed
Routine Solr Index Maintenance
Solr Sharding By Year
Technical implementation details
Testing Solr Shards
DSpace Log Converter
With the release of DSpace 1.6, new statistics software component was added. The use of Solr for statistics in
DSpace makes it possible to have a database of statistics. With this in mind, there is the issue of the older log
files and how a site can use them. The following command process is able to convert the existing log files and
then import them for Solr use. The user will need to perform this conversion only once.
The Log Converter program converts log files from dspace.log into an intermediate format that can be inserted
into Solr.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 366 of 901
DSpace 6.x Documentation
Command
[dspace]/bin/dspace stats-log-converter
used:
Java class:
org.dspace.statistics.util.ClassicDSpaceLogConverter
Arguments
Description
short and
long forms):
-i or --in
Input file
-o or --
Output file
out
-m or --
Adds a wildcard at the end of input and output, so it would mean if -i dspace.log -m was
multiple
specified, dspace.log* would be converted. (i.e. all of the following: dspace.log, dspace.log.1,
dspace.log.2, dspace.log.3, etc.)
-n or --
If the log files have been created with DSpace 1.6 or newer
newformat
-v or --
Display verbose output (helpful for debugging)
verbose
-h or --
Help
help
The command loads the intermediate log files that have been created by the aforementioned script into Solr.
Command
[dspace]/bin/dspace stats-log-importer
used:
Java
org.dspace.statistics.util.StatisticsImporter
class:
Arguments
Description
(short and
long
forms):
-i or --in input file
-m or --
Adds a wildcard at the end of the input, so it would mean dspace.log* would be imported
multiple
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 367 of 901
DSpace 6.x Documentation
-s or --
To skip the reverse DNS lookups that work out where a user is from. (The DNS lookup finds the
skipdns
information about the host from its IP address, such as geographical location, etc. This can be
slow, and wouldn't work on a server not connected to the internet.)
-v or --
Display verbose ouput (helpful for debugging)
verbose
-l or --
For developers: allows you to import a log file from another system, so because the handles
local
won't exist, it looks up random items in your local system to add hits to instead.
-h or --
Help
help
Although the DSpace Log Convertor applies basic spider filtering (googlebot, yahoo slurp, msnbot), it is far from
complete. Please refer to Filtering and Pruning Spiders for spider removal operations, after converting your old
logs.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 368 of 901
DSpace 6.x Documentation
Filtering and Pruning Spiders
Command used:
[dspace]/bin/dspace stats-util
Java class:
org.dspace.statistics.util.StatisticsClient
Arguments (short
Description
and long forms):
-b or --
Reindex the bitstreams to ensure we have the bundle name
reindexbitstreams
-r or --remove-
While indexing the bundle names remove the statistics about deleted bitstreams
deletedbitstreams
-u or --update-
Update Spider IP Files from internet into [dspace]/config/spiders. Downloads
spider-files
Spider files identified in dspace.cfg under property solr.spiderips.urls. See
Configuration settings for Statistics
-f or --delete-
Delete Spiders in Solr By isBot Flag. Will prune out all records that have isBot:true
spiders-byflag
-i or --delete-
Delete Spiders in Solr By IP Address, DNS name, or Agent name. Will prune out all
spiders-by-ip
records that match spider identification patterns.
-m or --mark-
Update isBot Flag in Solr. Marks any records currently stored in statistics that have IP
spiders
addresses matched in spiders files
-h or --help
Calls up this brief help table at command line.
Notes:
The usage of these options is open for the user to choose. If you want to keep spider entries in your repository,
you can just mark them using "-m" and they will be excluded from statistics queries when "solr.statistics.
query.filter.isBot = true" in the dspace.cfg. If you want to keep the spiders out of the solr
repository, just use the "-i" option and they will be removed immediately.
Spider IPs are specified in files containing one pattern per line. A line may be a comment (starting with "#" in
column 1), empty, or a single IP address or DNS name. If a name is given, it will be resolved to an address.
Unresolvable names are discarded and will be noted in the log.
There are guards in place to control what can be defined as an IP range for a bot. In [dspace]/config
/spiders, spider IP address ranges have to be at least 3 subnet sections in length 123.123.123 and IP
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 369 of 901
DSpace 6.x Documentation
Ranges can only be on the smallest subnet [123.123.123.0 - 123.123.123.255]. If not, loading that row will
cause exceptions in the dspace logs and exclude that IP entry.
Spiders may also be excluded by DNS name or Agent header value. Place one or more files of patterns in the
directories [dspace]/config/spiders/domains and/or [dspace]/config/spiders/agents. Each
line in a pattern file should be either empty, a comment starting with "#" in column 1, or a regular expression
which matches some names to be recognized as spiders.
Export SOLR records to intermediate format for import into Elasticsearch
Command used:
[dspace]/bin/dspace stats-util
Java class:
org.dspace.statistics.util.StatisticsClient
Arguments (short and long forms):
Description
-e or --export
Export SOLR view statistics data to usage statistics intermediate format
This exports the records to [dspace]/temp/usagestats_0.csv. This will chunk the files at 10,000 records
to new files. This can be imported with stats-log-importer to SOLR Statistics or stats-log-importerelasticsearch to Elasticsearch Usage Statistics (deprecated).
Export SOLR statistics, for backup and moving to another server
Command
[dspace]/bin/dspace solr-export-statistics
used:
Java class:
org.dspace.util.SolrImportExport
Arguments
Description
(short and
long forms):
- i or - -
optional, the name of the index to process. "statistics" is the default
index-name
-l or --
optionally export only integer many days worth of statistics
last
integer
-d or --
optional, directory to use for storing the exported files. By default, [dspace]/solr-export is
directory
used. If that is not appropriate (due to storage concerns), we recommend you use this option
to specify a more appropriate location.
- f or - -
optional, overwrite export file if it exists (DSpace 6.1 and later)
forceoverwrite
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 370 of 901
DSpace 6.x Documentation
Import SOLR statistics, for restoring lost data or moving to another server
Command
[dspace]/bin/dspace solr-import-statistics
used:
Java class:
org.dspace.util.SolrImportExport
Arguments
Description
(short and
long forms):
- i or - -
optional, the name of the index to process. "statistics" is the default
index-name
-c or --
optional, clears the contents of the existing stats core before importing
clear
-d or --
optional, directory which contains the files for importing. By default, [dspace]/solr-export
directory
is used. If that is not appropriate (due to storage concerns), we recommend you use this
option to specify a more appropriate location.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 371 of 901
DSpace 6.x Documentation
Reindex SOLR statistics, for upgrades or whenever the Solr schema for statistics is
changed
Command
[dspace]/bin/dspace solr-reindex-statistics
used:
Java class:
org.dspace.util.SolrImportExport
Arguments
Description
(short and
long forms):
- i or - -
optional, the name of the index to process. "statistics" is the default
index-name
-k or --
optional, tells the script to keep the intermediate export files for possible later use (by default
keep
all exported files are removed at the end of the reindex process).
-d or --
optional, directory to use for storing the exported files (temporarily, unless you also specify --
directory
keep, see above). By default, [dspace]/solr-export is used. If that is not appropriate
(due to storage concerns), we recommend you use this option to specify a more appropriate
location. Not sure about your space requirements? You can estimate the space required by
looking at the current size of [dspace]/solr/statistics
- f or - -
optional, overwrite export file if it exists (DSpace 6.1 and later)
forceoverwrite
NOTE: solr-reindex-statistics is safe to run on a live site. The script stores incoming usage data in a
temporary SOLR core, and then merges that new data into the reindexed data when the reindex process
completes.
Routine Solr Index Maintenance
Command used:
[dspace]/bin/dspace stats-util
Java class:
org.dspace.statistics.util.StatisticsClient
Arguments (short
Description
and long forms):
-o or --optimize
Run maintenance on the SOLR index. Recommended to run daily, to prevent your
servlet container from running out of memory
Notes:
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 372 of 901
DSpace 6.x Documentation
The usage of this this option is strongly recommended, you should run this script daily (from crontab or your
system's scheduler), to prevent your servlet container from running out of memory.
Solr Sharding By Year
Command used:
[dspace]/bin/dspace stats-util
Java class:
org.dspace.statistics.util.StatisticsClient
Arguments (short and
Description
long forms):
-s or --shard-solr-
Splits the data in the main core up into a separate solr core for each year, this will
index
upgrade the performance of the solr.
Notes:
Yearly Solr sharding is a routine that can drastically improve the performance of your DSpace SOLR statistics.
It was introduced in DSpace 3.0 and is not backwards compatible. The routine decreases the load created by
the logging of new usage events by reducing the size of the SOLR Core in which new usage data are being
logged. By running the script, you effectively split your current SOLR core, containing all of your usage events,
into different SOLR cores that each contain the data for one year. In case your DSpace has been logging usage
events for less than one year, you will see no notable performance improvements until you run the script after
the start of a new year. Both writing new usage events as well as read operations should be more performant
over several smaller SOLR Shards instead of one monolithic one.
It is highly recommended that you execute this script once at the start of every year. To ensure this is not
forgotten, you can include it in your crontab or other system scheduling software. Here's an example cron entry
(just replace [dspace] with the full path of your DSpace installation):
# At 12:00AM on January 1, "shard" the DSpace Statistics Solr index.
own Solr index - this improves performance.
Ensures each year has its
0 0 1 1 * [dspace]/bin/dspace stats-util -s
Repair of Shards Created Before DSpace 5.7 or DSpace 6.1
If you ran the shard process before upgrading to DSpace 5.7 or DSpace 6.1, the multi-value fields
such as owningComm and onwningColl are likely be corrupted. Previous versions of the shard
process lost the multi-valued nature of these fields. Without the multi-valued nature of these fields, it is
difficult to query for statistics records by community / collection / bundle.
You can verify this problem in the solr admin console by looking at the owningComm field on existing
records and looking for the presence of "\\," within that field.
The following process may be used to repair these records.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 373 of 901
DSpace 6.x Documentation
1. Backup your solr statistics-xxxx directories while tomcat is down.
2. Backup and delete the contents of the dspace-install/solr-export directory
3. For each "statistics-xxxx" shard that exists, export the repository
dspace solr-export-statistics -i statistics-xxxx -f
4. Run the following to repair records in the dspace-install/solr-export directory
for file in *
do
sed -E -e "s/[\\]+,/,/g" -i $file
done
5. For each shard that was exported, run the following import
dspace solr-import-statistics -i statistics-xxxx -f
If you repeat the query that was run previously, the fields containing "\\," should now contain an array
of owning community ids.
Shard Naming
Prior to the release of DSpace 6.1, the shard names created were off by one year in timezones with a
positive offset from GMT.Shards created subsequent to this release may appear to skip by one year.
See DS-3437-When sharding statistics, the destination shard name is off by one yearClosed
Technical implementation details
After sharding, the SOLR data cores are located in the [dspace.dir]/solr directory. There is no need to define the
location of each individual core in solr.xml because they are automatically retrieved at runtime. This retrieval
happens in the static method located in theorg.dspace.statistics.SolrLogger class. These cores are stored in the
statisticYearCores list each time a query is made to the solr these cores are added as shards by the
addAdditionalSolrYearCores method. The cores share a common configuration copied from your original
statistics core. Therefore, no issues should be resulting from subsequent ant updates.
The actual sharding of the of the original solr core into individual cores by year is done in the shardSolrIndex
method in the org.dspace.statistics.SolrLogger class. The sharding is done by first running a facet on the time to
get the facets split by year. Once we have our years from our logs we query the main solr data server for all
information on each year & download these as csv's. When we have all data for one year we upload it to the
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 374 of 901
DSpace 6.x Documentation
newly created core of that year by using the update csvhandler. One all data of one year has been uploaded
that data is removed from the main solr (by doing it this way if our solr crashes we do not need to start from
scratch).
Multiple Shard Fix (DSpace 6.1)
A bug exists in the DSpace 6.0 release that prevents tomcat from starting when multiple shards are
present.
To address this issue, the initialization of SOLR shards is deferred until the first SOLR related
requests are processed.
See DS-3457-Tomcat Restart Hangs after Sharding DSpace 6x StatisticsClosed
Testing Solr Shards
Testing Solr Shards
Testing Solr Shards
These notes detail how to test and manipulate SOLR statistics shards.
Testing CSV Export
The SOLR Admin Console provides a mechanism to test the CSV Export Process and Parameters
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 375 of 901
DSpace 6.x Documentation
Testing CSV Import
The SOLR Admin Console provides a mechanism to access the CSV Upload process. Unfortunately, it does not
all parameters to be provided.
Note that the multi-value field is corrupted if you import by this manner.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 376 of 901
DSpace 6.x Documentation
It is possible to csv import parameters using curl.
Running CSV Upload with curl
curl -F "data=@statistics-2006_export_2007-04.csv" "http://localhost/solr
/statistics-2006/update/csv?skip=_version_&csv.mv.escape=%5C&f.owningColl.
split=true&f.owningColl.separator=%7C&f.owningComm.split=true&f.owningComm.
separator=,&f.owningItem.split=true&f.owningItem.separator=%7C&f.bundleName.
split=true&f.bundleName.separator=%7C&stream.contentType=text%2Fcsv%3Bcharset%
3Dutf-8&commit=true&softCommit=false&waitSearcher=true&wt=javabin&version=2"
Creating a Shard in the Admin Console
While this is probably not necessary, it is possible to create an empty shard in the Solr Admin console.
Note that existing shards use the statistics directory as an "instance" directory.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 377 of 901
DSpace 6.x Documentation
Manually create a new shard
The new shard can be queried like the other ones
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 378 of 901
DSpace 6.x Documentation
4.7 User Interfaces
4.7.1 Discovery
What is DSpace Discovery
What is a Sidebar Facet
What is a Search Filter
What is a tag cloud facet
Discovery Changelist
DSpace 6.0
DSpace 5.0
DSpace 4.0
DSpace 3.0
DSpace 1.8
DSpace 1.7
Configuration files
General Discovery settings (config/modules/discovery.cfg)
Modifying the Discovery User Interface (config/spring/api/discovery.xml)
Structure Summary
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 379 of 901
DSpace 6.x Documentation
Default settings
Non indexed metadata fields
Search filters & sidebar facets Customization
Hierarchical (taxonomies based) sidebar facets
Sort option customization for search results
DiscoveryConfiguration
Configuring lists of sidebarFacets and searchFilters
Configuring and customizing search sort fields
Adding default filter queries (OPTIONAL)
Access Rights Awareness
Access Rights Awareness - technical details
Customizing the Recent Submissions display
Customizing hit highlighting & search snippets
Hit highlighting technical details
"More like this" configuration
"More like this" technical details
"Did you mean" spellcheck aid for search configuration
"Did you mean" spellcheck aid for search technical details
Customizing the "Tag Cloud" facet
Disabling the "Has file(s)" facet
Discovery Solr Index Maintenance
Advanced Solr Configuration
Internationalization
What is DSpace Discovery
The Discovery Module enables faceted searching & browsing for your repository.
Although these techniques are new in DSpace, they might feel familiar from other platforms like Aquabrowser or
Amazon, where facets help you to select the right product according to facets like price and brand. DSpace
Discovery offers very powerful browse and search configurations that were only possible with code
customization in the past.
Watch the DSpace Discovery introduction video
Since 6.0, Discovery is the only out-of-the-box Search and Browse infrastructure provided in DSpace.
What is a Sidebar Facet
From the user perspective, faceted search (also called faceted navigation, guided navigation, or parametric
search) breaks up search results into multiple categories, typically showing counts for each, and allows the user
to "drill down" or further restrict their search results based on those facets.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 380 of 901
DSpace 6.x Documentation
When you have successfully enabled Discovery in your DSpace, you will notice that the different enabled facets
are visualized in a "Discover" section in your sidebar, by default, right below the Browse options.
In this example, there are 3 Sidebar Facets, Author, Subject and Date Issued. It's important to know that
multiple metadata fields can be included in one facet. For example, the Author facet above includes values from
both dc.contributor.author as well as dc.creator.
Another important property of Sidebar Facets is that their contents are automatically updated to the context of
the page. On collection homepages or community homepages it will include information about the items
included in that particular collection or community.
What is a Search Filter
In a standard search operation, a user specifies his complete query prior to launching the operation. If the
results are not satisfactory, the user starts over again with a (slightly) altered query.
In a faceted search, a user can modify the list of displayed search results by specifying additional "filters" that
will be applied on the list of search results. In DSpace, a filter is a contain condition applied to specific facets. In
the example below, a user started with the search term "health", which yielded 500 results. After applying the
filter "public" on the facet "Subject", only 227 results remain. Each time a user selects a sidebar facet it will be
added as a filter. Active filters can be altered or removed in the 'filters' section of the search interface.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 381 of 901
DSpace 6.x Documentation
Another example: Using the standard search, a user would search for something like [wetland + "dc.
author=Mitsch, William J" + dc.subject="water quality" ]. With filtered search, they can start by searching
for [wetland ], and then filter the results by the other attributes, author and subject.
What is a tag cloud facet
Tag cloud facet is another way to display facets of your repository in a "tag cloud" form in which the importance
of each tag is show with font size or color. This format is useful for quickly perceiving the most prominent terms.
This is a classic "tag cloud" facet in a DSpace repository.
Discovery Changelist
DSpace 6.0
The legacy search engine (based on Apache Lucene) and legacy Browse system (based on database tables)
have been removed from DSpace 6.0 or above. Instead, DSpace now only uses Discovery for all Search
/Browse capabilities.
In addition, to support the new Configuration options, all of the Discovery configurations in discovery.cfg
have been prefixed with "discovery." (see configuration below).
DSpace 5.0
The new JSPUI-only tag cloud facet feature is disabled by default. In order to enable it, you will need to set up
the corresponding processor that the PluginManager will load to actually perform the tag cloud query on the
relevant pages. This is configured in the dspace.cfg configuration file using the following properties:
plugin.sequence.org .dspace.plugin.CommunityHomeProcessor
plugin.sequence.org .dspace.plugin.CollectionHomeProcessor
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 382 of 901
DSpace 6.x Documentation
plugin.sequence.org .dspace.plugin.SiteHomeProcessor
The tag cloud has been declared there for you but it is commented out.
DSpace 4.0
Starting from DSpace 4.0, Discovery is the default search and browse solution for DSpace.
General improvements:
Browse interfaces now also use Discovery index (rather than the legacy, now retired, Lucene index)
"Did you means" spell check aid for search
DSpace 3.0
Starting from DSpace 3.0, Discovery is also supported in JSPUI.
General improvements:
Hierarchical facets sidebar facets
Improved & more intuitive user interface
Access Rights Awareness (enabled by default). Access restricted or embargoed content is hidden from
anonymous search/browse.
Authority control & variants awareness (homonyms are shown separately in a facet if they have different
authority ID). All variant forms as recognized by the authority framework are indexed. See Authority
Framework
XMLUI-only:
Hit highlighting and search snippets support
"More like this" (related items)
Bugfixes and other changes
Auto-complete functionality has been removed in XMLUI from search queries due to performance issues.
JSPUI still supports auto-complete functionality without performance issues.
DSpace 1.8
Configuration moved from dspace.cfg into config/modules/discovery.cfg and config/spring
/api/discovery.xml
Individual communities and collections can have their own Discovery configuration.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 383 of 901
DSpace 6.x Documentation
Tokenization for Auto-complete values (see SearchFilter)
Alphanumeric sorting for Sidebarfacets
Possibility to avoid indexation of specific metadata fields.
Grouping of multiple metadata fields under the same SidebarFacet
DSpace 1.7
Sidebar browse facets that can be configured to use contents from any metadata field
Dynamically generated timespans for dates
Customizable "recent submissions" view on the repository homepage, collection and community pages
Hit highlighting & search snippets
Configuration files
The configuration for discovery is located in 2 separate files.
General settings: The discovery.cfg file located in the [dspace-install-dir]/config
/modules directory.
User Interface Configuration: The discovery.xml file is located in [dspace-install-dir]/config
/spring/api/ directory.
General Discovery settings ( config/modules/discovery.cfg )
The discovery.cfg file is located in the [dspace]/config/modules directory and contains following
properties. Any of these properties may be overridden in your local.cfg (see Configuration Reference):
Property:
discovery.search.server
Example
discovery.search.server=[http://localhost:8080/solr/search]
Value:
Informational
Discovery relies on a Solr index for storage and retrieval of its information. This parameter
Note:
determines the location of the Solr index.
Property:
discovery.index.authority.ignore[.field]
Example
discovery.index.authority.ignore=true
Value:
discovery.index.authority.ignore.dc.contributor.author=false
Informational
By default, Discovery will use the authority information in the metadata to disambiguate
Note:
homonyms. Setting this property to false will make the indexing process the same as the
metadata doesn't include authority information. The configuration can be different on a field
(..) basis, the property without field set the default value.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 384 of 901
DSpace 6.x Documentation
Property:
discovery.index.authority.ignore-prefered[.field]
Example
discovery.index.authority.ignore-prefered=true
Value:
discovery.index.authority.ignore-prefered.dc.contributor.author=false
Informational
By default, Discovery will use the authority information in the metadata to query the authority
Note:
for the preferred label. Setting this property to false will make the indexing process the same
as the metadata doesn't include authority information (i.e. the preferred form is the one
recorded in the metadata value). The configuration can be different on a field (.
.) basis, the property without field set the default value. If the authority
is a remote service, disabling this feature can greatly improve performance.
Property:
discovery.index.authority.ignore-variants[.field]
Example
discovery.index.authority.ignore-variants=true
Value:
discovery.index.authority.ignore-variants.dc.contributor.author=false
Informational
By default, Discovery will use the authority information in the metadata to query the authority
Note:
for variants. Setting this property to false will make the indexing process the same, as the
metadata doesn't include authority information. The configuration can be different on a perfield (..) basis, the property without field set the default value.
If authority is a remote service, disabling this feature can greatly improve performance.
Modifying the Discovery User Interface ( config/spring/api/discovery.xml )
The discovery.xml file is located in the [dspace]/config/spring/api directory.
Structure Summary
This file is in XML format, you should be familiar with XML before editing this file. The configurations are
organized together in beans, depending on the purpose these properties are used for.
This purpose can be derived from the class of the beans. Here's a short summary of classes you will encounter
throughout the file and what the corresponding properties in the bean are used for.
Download the configuration file and review it together with the following parameters
Class:
DiscoveryConfigurationService
Purpose:
Defines the mapping between separate Discovery configurations and individual collections
/communities
Default:
All communities, collections and the homepage (key=default) are mapped to defaultConfiguration,
also controls the metadata fields that should not be indexed in the search core (item provenance
for example).
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 385 of 901
DSpace 6.x Documentation
Class:
DiscoveryConfiguration
Purpose:
Groups configurations for sidebar facets, search filters, search sort options and recent
submissions
Default:
There is one configuration by default called defaultConfiguration
Class:
DiscoverySearchFilter
Purpose:
Defines that specific metadata fields should be enabled as a search filter
Default:
dc.title, dc.contributor.author, dc.creator, dc.subject.* and dc.date.issued are defined as search
filters
Class:
DiscoverySearchFilterFacet
Purpose:
Defines which metadata fields should be offered as a contextual sidebar browse options, each of
these facets has also got to be a search filter
Default:
dc.contributor.author, dc.creator, dc.subject.* and dc.date.issued
Class:
HierarchicalSidebarFacetConfiguration
Purpose:
Defines which metadata fields contain hierarchical data and should be offered as a contextual
sidebar option
Class:
DiscoverySortConfiguration
Purpose:
Further specifies the sort options to which a DiscoveryConfiguration refers
Default:
dc.title and dc.date.issued are defined as alternatives for sorting, other than Relevance (hardcoded)
Class:
DiscoveryHitHighlightingConfiguration
Purpose:
Defines which metadata fields can contain hit highlighting & search snippets
Default:
dc.title, dc.contributor.author, dc.subject, dc.description.abstract & full text from text files.
Class:
TagCloudFacetConfiguration
Purpose:
Defines the tag cloud appearance configuration bean and the search filter facets to appear in the
tag cloud form. You can have different "TagCloudFacetConfiguration" per community or
collection or the home page
Default settings
In addition to the summarized descriptions of the default values, following details help you to better understand
these defaults. If you haven't already done so, download the configuration file and review it together with the
following parameters.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 386 of 901
DSpace 6.x Documentation
The file contains one default configuration that defines following sidebar facets, search filters, sort fields and
recent submissions display:
Sidebar facets
searchFilterAuthor: groups the metadata fields dc.contributor.author & dc.creator with a facet
limit of 10, sorted by occurrence count
searchFilterSubject: groups all subject metadata fields (dc.subject.*) with a facet limit of 10,
sorted by occurrence count
searchFilterIssued: contains the dc.date.issued metadata field, which is identified with the type
"date" and sorted by specific date values
Search filters
searchFilterTitle: contains the dc.title metadata field
searchFilterAuthor: contains the dc.contributor.author & dc.creator metadata fields
searchFilterSubject: contains the dc.subject.* metadata fields
searchFilterIssued: contains the dc.date.issued metadata field with the type "date"
Sort fields
sortTitle: contains the dc.title metadata field
sortDateIssued: contains the dc.date.issued metadata field, this sort has the type date
configured.
defaultFilterQueries
The default configuration contains no defaultFilterQueries
The default filter queries are disabled by default but there is an example in the default
configuration in comments which allows discovery to only return items (as opposed to also
communities/collections).
Recent Submissions
The recent submissions are sorted by dc.date. accessioned which is a date and a maximum
number of 5 recent submissions are displayed.
Hit highlighting
The fields dc.title, dc.contributor.author & dc.subject can contain hit highlighting.
The dc.description.abstract & full text field are used to render search snippets.
Non indexed metadata fields
Community/Collections: dc.rights (copyright text)
Items: dc.description.provenance
Many of the properties contain lists that use references to point to the configuration elements. This way a
certain configuration type can be used in multiple discovery configurations so there is no need to duplicate
them.
Non indexed metadata fields
The discovery.xml file has configuration to not index certain metadata fields for communities/collections/items.
The configuration is handled in the "toIgnoreMetadataFields" property located in the "org.dspace.discovery.
configuration.DiscoveryConfigurationService" bean. Below is an example configuration that excludes dc.
description.provenance for items & dc.rights for communities/collections:
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 387 of 901
DSpace 6.x Documentation
By adding additional values to the appropriate lists additional metadata can be excluded from the search core, a
reindex is required after altering this file to ensure that the values are removed from the index.
Search filters & sidebar facets Customization
This section explains the properties for search filters & sidebar facets. Each sidebar facet must occur in the
reference list of the search filters. Below is an example configuration of a search filter that is not used as a
sidebar facet.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 388 of 901
DSpace 6.x Documentation
dc.title
The id & class attributes are mandatory for this type of bean. The properties that it contains are discussed
below.
indexFieldName (Required): A unique search filter name, the metadata will be indexed in Solr under this
field name.
metadataFields (Required): A list of the metadata fields that need to be included in the facet.
Sidebar facets extend the search filter and add some extra properties to it, below is an example of a search
filter that is also used as a sidebar facet.
dc.contributor.author
dc.creator
Note that the class has changed from DiscoverySearchFilter to SidebarFacetConfiguration this is needed to
support the extra properties.
facetLimit (optional): The maximum number of values to be shown. This property is optional, if none is
specified the default value "10" will be used. If the filter has the type date, this property will not be used
since dates are automatically grouped together.
sortOrder (optional):The sort order for the sidebar facets, it can either be COUNT or VALUE. The
default value is COUNT.
COUNT Facets will be sorted by the amount of times they appear in the repository
VALUE Facets will be sorted alphabetically
type(optional): the type of the sidebar facet it can either be "date" or "text", "text" is the default value.
text: The facets will be treated as is
date: Only the year will be stored in the Solr index. These years are automatically displayed in
ranges that get smaller when you select one.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 389 of 901
DSpace 6.x Documentation
Hierarchical (taxonomies based) sidebar facets
Discovery supports specialized drill down in hierarchically structured metadata fields. For this drill down to work,
the metadata in the field for which you enable this must be composed out of terms, divided by a splitter. For
example, you could have a dc.subject.taxonomy field in which you keep metadata like "CARTOGRAPHY::
PHOTOGRAMMETRY", in which Cartography and Photogrammetry are both terms, divided by the splitter "::".
The sidebar will only display the top level facets, when clicking on view more all the facet options will be
displayed.
dc.subject
Note that the class has changed from SidebarFacetConfiguration to HierarchicalSidebarFacetConfiguration
this is needed to support the extra properties.
splitter (required): The splitter used to split up the separate nodes
skipFirstNodeLevel (optional): Whether or not to show the root node level. For some hierarchical data
there is a single root node. In most cases it doesn't need to be shown since it isn't relevant. This
property is true by default.
Sort option customization for search results
This section explains the properties of an individual SortConfiguration, like sortTitle and sortDateIssued from the
default configuration. In order to create custom sort options, you can either modify specific properties of those
that already exist or create a totally new one from scratch.
Here's what the sortTitle SortConfiguration looks like:
The id & class attributes are mandatory for this type of bean. The properties that it contains are discussed
below.
metadataField (Required): The metadata field indicating the sort values
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 390 of 901
DSpace 6.x Documentation
type (optional): the type of the sort option can either be date or text, if none is defined text will be used.
DiscoveryConfiguration
The DiscoveryConfiguration Groups configurations for sidebar facets, search filters, search sort options and
recent submissions. If you want to show the same sidebar facets, use the same search filters, search options
and recent submissions everywhere in your repository, you will only need one DiscoveryConfiguration and you
might as well just edit the defaultConfiguration.
The DiscoveryConfiguration makes it very easy to use custom sidebar facets, search filters, ... on specific
communities or collection homepage. This is particularly useful if your collections are heterogeneous. For
example, in a collection with conference papers, you might want to offer a sidebar facet for conference date,
which might be more relevant than the actual issued date of the proceedings. In a collection with papers, you
might want to offer a facet for funding bodies or publisher, while these fields are irrelevant for items like learning
objects.
A DiscoveryConfiguration consists out of five parts
The list of applicable sidebarFacets
The list of applicable searchFilters
The list of applicable searchSortFields
Any default filter queries (optional)
The configuration for the Recent submissions display
The configuration of the tag cloud facet
Configuring lists of sidebarFacets and searchFilters
After modifying sidebarFacets and searchFilters, don't forget to reindex existing items by running
[dspace]/bin/dspace index-discovery -b, otherwise the changes will not appear.
Below is an example of how one of these lists can be configured. It's important that each of the bean references
corresponds to the exact name of the earlier defined facets, filters or sort options.
Each sidebar facet must also occur in the list of the search filters.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 391 of 901
DSpace 6.x Documentation
Configuring and customizing search sort fields
The search sort field configuration block contains the available sort fields and the possibility to configure a
default sort field and sort order.
Below is an example of the sort configuration.
The property name & the bean class are mandatory. The property field names are discusses below.
defaultSort (optional): The default field on which the search results will be sorted, this must be a
reference to an existing search sort field bean. If none is given relevance will be the default. Sorting
according to the internal relevance algorithm is always available, even though it's not explicitly mentioned
in the sortFields section.
defaultSortOrder (optional): The default sort order can either be asc or desc.
sortFields (mandatory): The list of available sort options, each element in this list must link to an existing
sort field configuration bean.
Adding default filter queries (OPTIONAL)
Default filter queries are applied on all search operations & sidebarfacet clicks. One useful application of default
filter queries is ensuring that all returned results are items. As a result, subcommunities and collections that are
returned as results of the search operation, are filtered out.
Similar to the lists above, the default filter queries are defined as a list. They are optional.
query1
query2
This property contains a simple list which in turn contains the queries. Some examples of possible queries:
search.resourcetype:2
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 392 of 901
DSpace 6.x Documentation
dc.subject:test
dc.contributor.author: "Van de Velde, Kevin"
...
Access Rights Awareness
By default, when searching and browsing using Discovery, you will only see items that you have access to. So,
your search/browse results may differ if you are logged into DSpace. This Access Rights Awareness feature
ensures that anonymous users (and search engines) are not able to access information (both files and
metadata) about embargoed or private items. It also provides you with more direct control over who can see
individual items within your DSpace.
How does Access Rights Awareness work?
Access Rights Awareness checks the "READ" access on the Item.
If the "Anonymous" group has "READ" access on the Item, then anonymous/public users will be able to view
that Item's metadata and locate that Item via DSpace's search/browse system. In addition, search engines will
also be able to index that Item's metadata. However, even with Anonymous READ set at the Item-level, you
may still choose to access-restrict the downloading/viewing of files within the Item. To do so, you would restrict
"READ" access on individual Bitstream(s) attached to the Item.
If the "Anonymous" group does NOT have "READ" access on the Item, then anonymous users will never see
that Item appear within their search/browse results (essentially the Item is "invisible" to them). In addition, that
Item will be invisible to search engines, so it will never be indexed by them. However, any users who have been
given READ access will be able to find/locate the item after logging into DSpace. For example, if a "Staff" group
was provided "READ" access on the Item, then members of that "Staff" group would be able to locate the item
via search/browse after logging into DSpace.
How can I disable Access Rights Awareness?
If you prefer to allow all access-restricted or embargoed Items to be findable within your DSpace, you can
choose to turn off Access Rights Awareness. However, please be aware that this means that restricting "READ"
access on an Item will not really do anything – the Item metadata will be available to the public no matter what
group(s) were given READ access on that Item.
This feature can be switched off by going to the [dspace.dir]/config/spring/api/discovery.xml file
& commenting out the bean & the alias shown below.
The property name & the bean class are mandatory. The property field names are discusses below.
metadataSortField (mandatory): The metadata field to sort on to retrieve the recent submissions
max (mandatory): The maximum number of results to be displayed as recent submissions
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 394 of 901
DSpace 6.x Documentation
type (optional): the type of the search filter. It can either be date or text, if none is defined text will be
used.
Customizing hit highlighting & search snippets
This paragraph only applies to XMLUI. JSPUI does not currently support "highlighting & search
snippets".
The hit highlighting configuration element contains all settings necessary to display search snippets & enable hit
highlighting.
Changes made to the configuration will not automatically be displayed in the user interface. By default,
only the following fields are displayed: dc.title, dc.contributor.author, dc.creator, dc.contributor, dc.date.
issued, dc.publisher, dc.description.abstract and fulltext.
If additional fields are required, look for the "itemSummaryList" template.
Below is an example configuration of hit highlighting.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 395 of 901
DSpace 6.x Documentation
The property name & the bean class are mandatory. The property field names are:
field (mandatory): The metadata field to be highlighted (can also be * if all the metadata fields should be
highlighted).
maxSize (optional): Limit the number of characters displayed to only the relevant part (use metadata
field as search snippet).
snippets (optional): The maximum number of snippets that can be found in one metadata field.
Hit highlighting technical details
The org.dspace.discovery.DiscoveryQuery object has a setter & getter for the hit highlighting configuration set
in Discovery configuration. If this configuration is given the resolveToSolrQuery method located in the org.
dspace.discovery.SolrServiceImpl class will use the standard Solr highlighting feature (http://wiki.apache.org/solr
/HighlightingParameters). The org.dspace.discovery.DiscoverResult class has a method to set the highlighted
fields for each object & field.
The rendering of search results is no longer handled by the METS format but uses a special type of list named
"TYPE_DSO_LIST". Each metadata field (& fulltext if configured) is added in the DRI and IF the field contains
hit higlighting the Java code will split up the string & add DRI highlights to the list. The XSL for the themes also
contains special rendering XSL for the DRI; for Mirage, the changes are located in the discovery.xsl file. For
themes using the old themes based on structural.xsl, look for the template matching " dri:list[@type='dsolist']".
"More like this" configuration
This paragraph only apply to XMLUI. The JSPUI does not currently support the "More like this"
feature.
The "more like this"-configuration element contains all the settings for displaying related items on an item
display page.
Below is an example of the "more like this" configuration.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 396 of 901
DSpace 6.x Documentation
dc.title
dc.contributor.author
dc.creator
dc.subject
The property name & the bean class are mandatory. The property field names are discussed below.
similarityMetadataFields: the metadata fields checked for similarity
minTermFrequency: The minimum number of matching terms accross the metadata fields above before
an item is found as related
max: The maximum number of related items displayed
minWordLength: The minimum word length below which words will be ignored
"More like this" technical details
The org.dspace.discovery.SearchService object has received a getRelatedItems() method. This method
requires an item & the more-like-this configuration bean from above. This method is implemented in the org.
dspace.discovery.SolrServiceImpl which uses the item as a query & uses the default Solr parameters for morelike-this to pass the bean configuration to solr (https://cwiki.apache.org/confluence/display/solr/MoreLikeThis).
The result will be a list of items or if none found an empty list. The rendering of this list is handled in the org.
dspace.app.xmlui.aspect.discovery.RelatedItems class.
"Did you mean" spellcheck aid for search configuration
DSpace 4 introduces the use of SOLR's SpellCheckComponent as an aid for search. When a user's search
does not return any hits, the user is presented with a suggestion for an alternative search query.
The feature currently only one line of configuration to discovery.xml. Changing the value from true to false will
disable the feature.
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 397 of 901
DSpace 6.x Documentation
This bean has two properties:
tagCloudConfiguration: is the bean which describes the actual appearance parameters
tagCloudFacets: the search filter facets which will be used for the tag cloud. If you leave the list empty,
no tag cloud will appear. If you declare more than one, such number of tag clouds will appear for each
search filter, one after the other.
The appearance configuration can have the following properties, as shown in the following bean:
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 398 of 901
DSpace 6.x Documentation
When tagCloud is rendered there are some CSS classes that you can change in order to change the
appearance of the tag cloud.
Class
Note
tagcloud
General class for the whole tagcloud
tagcloud_1
Specific tag class for tag of type 1 (based on score)
tagcloud_2
Specific tag class for tag of type 2 (based on score)
tagcloud_3
Specific tag class for tag of type 3 (based on score)
13-Jul-2017
https://wiki.duraspace.org/display/DSDOC6x
Page 399 of 901
DSpace 6.x Documentation
Disabling the "Has file(s)" facet
Since DSpace 6, a new "Has file(s)" facet has been enabled by default. This facet shows whether items have or
do not have any bitstreams in the "ORIGINAL" bundle.Should you want to turn this off, you can edit [dspace]/
config/spring/api/discovery.xml to remove the following line from the defaultConfiguration and
homepageConfiguration beans (in the sidebarFacets property):
Then restart your servlet container.
Discovery Solr Index Maintenance
Command
[dspace]/bin/dspace index-discovery [-cbhf[r - ]]
used:
Java
org.dspace.discovery.IndexClient
class:
Arguments
Description
(short and
long
forms):
called without any options, will update/clean an existing index
-b
(re)build index, wiping out current one if it exists
-c
clean existing index removing any documents that no longer exist in the db
-f
if updating existing index, force each handle to be reindexed even if uptodate
-h
print this help message
-i
Reindex an individual object (and any child objects). When run on an Item, it just reindexes that