1 Preface
Release Notes
We thank these institutions for supporting their staff to take time to contribute to the DSpace project. Robin Taylor was the Release Coordinator for this release with endless help from DSpace Technical Lead Tim Donohue.
2 Introduction
The DSpace-Devel listserv is intended for DSpace developers working on the DSpace platform to share ideas and discuss code changes on the open source platform. The DSpace community depends on its members to formulate high-level functional requirements and architecture, and to facilitate programming, testing, documentation, and the project.
3 Functional Overview
- Data Model
- Plugin Manager
- Metadata
- Packager Plugins
- Crosswalk Plugins
- E-People and Groups
- E-Person
- Groups
- Authentication
- Authorization
- Ingest Process and Workflow
- Workflow Steps
- Supervision and Collaboration
- Handles
- Bitstream 'Persistent' Identifiers
- Storage Resource Broker (SRB) Support
- Search and Browse
- HTML Support
- OAI Support
- SWORD Support
- OpenURL Support
- Creative Commons Support
- Subscriptions
- Import and Export
- Registration
- Statistics
- System Statistics
- Item, Collection and Community Usage Statistics
- Checksum Checker
- Usage Instrumentation
- Choice Management and Authority Control
- Introduction and Motivation
Groups are another type of entity that can be granted permissions in an authorization system. If selected, the metadata and (optionally) a copy of the license text is stored with the item in the repository.
Definitions
It is a configurable framework that allows you to define plugin classes to control the selection of values for given DSpace metadata fields. It also allows you to configure fields to include an "authority" value along with a text metadata value.
About Authority Control
The source of authorization control is usually an external database or the authorizations are external to DSpace. Authority control is enforced wherever metadata values are changed, including unattended/batch broadcast, LNI and SWORD packet broadcast, and the admin user interface.
Some Terminology
4 Installation
- For the Impatient
- Prerequisite Software
- UNIX-like OS or Microsoft Windows
- Oracle Java JDK 6 (standard SDK is fine, you don't need J2EE)
- is currently unsupported
- Apache Maven 2.2.x or higher (Java build tool)
- requires usage of Maven 2.2.x
Please note that DSpace currently requires Oracle Java 6 (standard SDK is fine, you don't need J2EE). Only Oracle's Java has been tested with each release and is known to work correctly.
Configuring a Proxy
- Apache Ant 1.8 or later (Java build tool)
- Relational Database: (PostgreSQL or Oracle)
- Servlet Engine: (Apache Tomcat 5.5 or 6, Jetty, Caucho Resin or equivalent)
- Perl (only required for [dspace]/bin/dspace-info.pl)
- Installation Instructions
- Overview of Install Options
- Overview of DSpace Directories
- Installation
- Advanced Installation
You will also need to create a user account for DSpace (eg dspace) and ensure that it has permission to add and remove tables in the database. After unpacking the file, the user can change ownership of dspace-1.6-release to user 'dspace'.
4.4.1 'cron' Jobs
Multilingual Installation
According to the languages you want to support, you need to make sure that all the i18n related files are available, see the multilingual support section for multilingual user interface for the JSPUI or the multilingual support for XMLUI in the configuration documentation.
DSpace over HTTPS
The solution is to use HTTPS (HTTP over SSL, i.e. Secure Socket Layer, an encrypted transport), which protects your passwords from capture. The following sections show how to configure the most commonly used Java Servlet containers to support HTTP over SSL.
To enable the HTTPS support in Tomcat 5.0
Finally, when you get the signed certificate from your CA, import it into the keystore with a command like the following example: (cert is in the file signed-cert.pem). Create a Java keystore for your server with the password changeit, and install your server certificate under the alias "tomcat".
To use SSL on Apache HTTPD with mod_jk
The Handle Server
To use the Handle system, you must configure a Handle server. This tells the Handle server to get information about individual Handles from the DSpace code.
Updating Existing Handle Prefixes
- Google and HTML sitemaps
- DSpace Statistics
- Manually Installing/Updating GeoLite Database File
- Windows Installation
- Pre-requisite Software
- Installation Steps
- Checking Your Installation
- Known Bugs
- Common Problems
- Common Installation Issues
- General DSpace Issues
Create a database named dspace owned by user dspace, with UTF-8 encoding Update paths in [dspace-source]\dspace\config\dspace.cfg. Also make sure to change all parameters with file paths to match, dspace.dir = C:/DSpace.
5 Upgrading a DSpace Installation
Upgrading From 1.7.x to 1.8.x
- Backup your DSpace
- Upgrade Steps
Assetstore: Backup the directory ([dspace]/assetstore by default and all other assetstores configured in [dspace]/config/dspace.cfg settings "assetstore.dir" and "assetstore.dir.#") Configuration: Backup the entire contents of the directory [dspace]/config. New settings for RSS feeds (see "webui.feed.podcast.*" (see page 192)) in dspace.cfg, which now support richer features such as iTunes podcast and iTunesU publishing. Several major configuration sections have now been removed from dspace.cfg.
Optional Upgrade Step: Fix Broken File Statistics
Upgrading From 1.7 to 1.7.x
- Upgrade Steps
In the notes below [dspace] refers to the installation directory for your existing DSpace installation and the source directory for DSpace 1.7.2. Asset store ([dspace]/assetstore by default, and any other asset store configured in the "assetstore.dir" and "assetstore.dir.#" settings).
Upgrading From 1.6.x to 1.7.x
- Upgrade Steps
Give each filter plugin 'human understandable' names.named.org.dspace.app.mediafilter.FormatFilter = \ org.dspace.app.mediafilter.PDFFilter = PDF Text Extractor, \ org.dspace.app.mediafilter.HTMLFilter = Text Extractor HTML, \ org.dspace.app.mediafilter.WordFilter = Word Text Extractor, . Each DSpaceControlledVocabulary plugin has three configuration options:. vocabulary.plugin._plugin_.hierarchy.store =
Upgrading From 1.6 to 1.6.x
- Upgrade Steps
Update the installed DSpace directory with the new code and libraries. cd [dspace-source]/dspace/target/dspace-[version]-build.dir ant -Dconfig=[dspace]/config/dspace.cfg update. If you are using Creative Commons licenses in your DSpace submission, Update the database. process, you will need to run the 1.5.x to 1.6.x database upgrade script again.
Upgrading From 1.5.x to 1.6.x
- Upgrade Steps
This folder contains the compiled binary distribution of DSpace. Before rebuilding DSpace, the above command will 'clean' all previously compiled code and ensure that your local DSpace JAR files are updated from the remote maven repository. In the DSpace 1.6 release there are Authority Control features and that requires indexes to be regenerated.
- Upgrade Steps
You will find the result in [dspace-source]/dspace/target/dspace-1.5.2-build.dir/; inside this directory is the compiled binary distribution of DSpace. LDAP server, use the following stackable authentication .. plugin.sequence.org.dspace.authenticate.AuthenticationMethod.
Upgrading From 1.4.2 to 1.5
- Upgrade Steps
Specify which strategy to use to select the style for an item plugin.single.org.dspace.app.webui.util.StyleSelection. One of the most important new features of DSpace 1.5 is the browsing and search indexes.
Upgrading From 1.4.1 to 1.4.2
- Upgrade Steps
Copy the webapps files from your [dspace]/webapps directory to the Deploy webapps.
Upgrading From 1.4 to 1.4.x
- Upgrade Steps
If webui.html.max-depth-guess is not present in dspace.cfg, the default value is used. Copy the .war web application files in [dspace-1.4.x-source]/build to the webapps subdirectory of your servlet container (eg Tomcat).
Upgrading From 1.3.2 to 1.4.x
- Upgrade Steps
For Oracle [dspace-1.4.x-source]/etc/oracle/database_schema_13-14.sql DSpace database to update the schema. Copy the .war webapp files in [dspace-1.4-source]/build to the webapps subdirectory of your servlet container (eg Tomcat).
Upgrading From 1.3.1 to 1.3.2
- Upgrade Steps
Get the new DSpace 1.3.2 source code from the DSpace page on SourceForge and unzip it somewhere. Copy the .war web application files in [dspace-1.3.2-source]/build to the webapps subfolder of your servlet container (e.g. Tomcat).
Upgrading From 1.2.x to 1.3.x
- Upgrade Steps
Grab the new DSpace 1.3.x source code from the DSpace page on SourceForge and unzip somewhere. Go to the [dspace-1.3.x-source] directory and run update:ant -Dconfig=[dspace]/config/dspace.cfg.
Upgrading From 1.2.1 to 1.2.2
- Upgrade Steps
Copy the webapp .war files to [dspace-1.3.x-source]/build in the webapps sub-directory of your servlet container (eg Tomcat). Get the new DSpace 1.2.2 source code from the DSpace page on SourceForge and unzip somewhere.
Upgrading From 1.2 to 1.2.1
- Upgrade Steps
For example, if dspace.war is installed in [tomcat]/webapps/dspace.war, you should delete it. Copy the webapp .war files to [dspace-1.2.1-source]/build in the webapps sub-directory of your servlet container (eg Tomcat).
Upgrading From 1.1.x to 1.2
- Upgrade Steps
The tool included with the DSpace 1.2 codebase will then update the actual data in the relational database. See the dspace.cfg distributed with the source code to see what these parameters are and how to use them.
Upgrading From 1.1 to 1.1.1
- Upgrade Steps
Core metadata will not have changed (access date and so on), the 'last modified' date in the database for each will have changed. You should also consider sending a notice to the OAI. so combines know to update their systems.
Upgrading From 1.0.1 to 1.1
- Upgrade Steps
If you have modified the site 'skin' (jsp/local/layout/header-default.jsp) you will need to add the Unicode header ie:. to the
element. If you have any locally edited JSPs, you need to add this page directive to the top of them all:.6 Configuration
General Configuration
- Input Conventions
- Update Reminder
Always make the same changes to the source version of dspace.cfg except the runtime file. This will copy the source dspace.cfg (along with other configuration files) to the runtime directory ( ).
The dspace.cfg Configuration Properties File
- The dspace.cfg file
- Main DSpace Configurations
- DSpace Database Configuration
- DSpace Email Settings
Wording of E-mail Messages
- File Storage
- SRB (Storage Resource Brokerage) File Storage
- Logging Configuration
- Configuring Lucene Search Indexes
- Handle Server Configuration
- Delegation Administration : Authorization System Configuration
- Restricted Item Visibility Settings
- Proxy Settings
- Configuring Media Filters
- Crosswalk and Packager Plugin Settings
Example value: core.authorization.community-admin.item.delete = true Informational note: Authorization for a delegated community administrator to delete items. Example value: core.authorization.community-admin.item.policies = true Informational note: Authorization for a delegated community administrator to manage the item.
Configurable MODS Dissemination Crosswalk
The subsections below give configuration details based on the type of cross paths and packager plugins you need to implement.
XSLT-based Crosswalks
The path value is the path to the file containing the transition style table (relative to /[dspace]/config). The distribution gateway must also be configured with an XML namespace (including prefix and URI) and an XML schema for its output format.
Testing XSLT Crosswalks
Add the -l option to pass the ingestion crosswalk a list of elements instead of an entire document, as if the list form of the ingest() method had been called.
Configurable Qualified Dublin Core (QDC) dissemination crosswalk
The attribute name is a concatenation of the metadata schema, element name and optionally the qualifier. The value of the property is an XML fragment, the element whose value will be set to the value of the metadata field in the property key.
Configuring Crosswalk Plugins
The QDC crosswalk properties file is a list of properties that describe how DSpace metadata elements should be converted to Qualified DC XML output document elements. For example, the contributor.author element in the base Dublin schema would be: dc.contributor.author.
Configuring Packager Plugins
Event System Configuration
34;Consumer" og "Dispatcher" henvises til:http://wiki.dspace.org/index.php/EventSystemPrototype Property: event.dispatcher.default.class.
Embargo
Therefore, you may consider configuring both 'terms' and 'withdrawal date' to use the same metadata field. Once the fields defined for conditions and lift date are assigned in dspace.cfg and created and configured wherever they will be used, you can start embargoing items simply by entering the data (dates if you are using the default setting) in the conditions field.
Extending Embargo Functionality
In this way, during the workflow you will only see the terms and after product installation only the promise date. The default setter recognizes only two expressions for 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 embargo (the default value for this is 'forever', but this can be changed in dspace.cfg to 'toujours', 'unendlich' etc.).
Step-by-Step Setup Examples
Checksum Checker Settings
Item Export and Download Settings
Subscription Emails
Hiding Metadata
Settings for the Submission Process
Configuring Creative Commons License
WEB User Interface Configurations
Browse Index Configuration
Defining the Indexes
Please note that the prefix>.
Defining Sort Options
Browse Index Normalization Rule Configuration
However, clicking through from either will result in the same set of items (that is, any item that contains either representation in the appropriate field). Currently, you need to edit your metadata to clean up the index presentation.
Other Browse Options
As of version 1.5.2 of DSpace, multilingual MARC21 title sorting is configured by default, as shown in the example above. To use the previous header order (prior to the 1.5.2 release), comment out the configuration in your dspace.cfg file.
Browse Index Authority Control Configuration
- Author (Multiple metadata value) Display
- Links to Other Browse Contexts
- Recent Submissions
- Submission License Substitution Variables
- Syndication Feed (RSS) Settings
- OpenSearch Support
- Content Inline Disposition Threshold
- Multi-file HTML Document/Site Settings
- Sitemap Settings
- Authority Control Settings
Value: webui.feed.item.description = dc.title, dc.contributor.author, \ dc.contributor.editor, dc.description.abstract, \ dc.description. If webui.html.max-depth-guess is 1 or less, DSpace will not serve it.
