Optional Upgrade Step: Fix Broken File Statistics
5.19 Upgrading From 1.0.1 to 1.1
In the notes below [dspace] refers to the install directory for your existing DSpace installation, and to the source directory for DSpace 1.1.1. Whenever you see these path [dspace-1.1.1-source]
references, be sure to replace them with the actual path names on your local system.
5.18.1 Upgrade Steps
Fortunately the changes in 1.1.1 are only code changes so the update is fairly simple.
Take down Tomcat.
It would be a good idea to update any of the third-party tools used by DSpace at this point (e.g.
PostgreSQL), following the instructions provided with the relevant tools.
In [dspace-1.1.1-source] run:
ant -Dconfig= [dspace]/config/dspace.cfg update
If you have locally modified JSPs of the following JSPs in your [dspace]/jsp/local directory, you might like to merge the changes in the new 1.1.1 versions into your locally modified ones. You can use the diff command to compare the 1.1 and 1.1.1 versions to do this. The changes are quite minor.
collection-home.jsp
admin/authorize-collection-edit.jsp admin/authorize-community-edit.jsp admin/authorize-item-edit.jsp admin/eperson-edit.jsp
Restart Tomcat.
5.19 Upgrading From 1.0.1 to 1.1
To upgrade from DSpace 1.0.1 to 1.1, follow the steps below. Your dspace.cfg does not need to be changed. In the notes below [dspace] refers to the install directory for your existing DSpace
installation, and [dspace-1.1-source] to the source directory for DSpace 1.1. Whenever you see these path references, be sure to replace them with the actual path names on your local system.
5.19.1 Upgrade Steps
1.
2.
3.
Take down Tomcat (or whichever servlet container you're using).
We recommend that you upgrade to the latest version of PostgreSQL (7.3.2). Included are some notes to help you do this (see the postgres-upgrade-notes.txt file). Note you will also have to upgrade Ant to version 1.5 if you do this.
Make the necessary changes to the DSpace database. These include a couple of minor schema changes, and some new indexes which should improve performance. Also, the names of a couple of database views have been changed since the old names were so long they were causing problems. First run psql to access your database (e.g. psql -U dspace -W and then enter the password), and enter these SQL commands:
ALTER TABLE bitstream ADD store_number INTEGER;
UPDATE bitstream SET store_number = 0;
ALTER TABLE item ADD last_modified TIMESTAMP;
CREATE INDEX last_modified_idx ON Item(last_modified);
CREATE INDEX eperson_email_idx ON EPerson(email);
CREATE INDEX item2bundle_item_idx on Item2Bundle(item_id);
CREATE INDEX bundle2bitstream_bundle_idx ON Bundle2Bitstream(bundle_id);
CREATE INDEX dcvalue_item_idx on DCValue(item_id);
CREATE INDEX collection2item_collection_idx ON Collection2Item(collection_id);
CREATE INDEX resourcepolicy_type_id_idx ON ResourcePolicy (resource_type_id,resource_id);
CREATE INDEX epersongroup2eperson_group_idx on EPersonGroup2EPerson(eperson_group_id);
CREATE INDEX handle_handle_idx ON Handle(handle);
CREATE INDEX sort_author_idx on ItemsByAuthor(sort_author);
CREATE INDEX sort_title_idx on ItemsByTitle(sort_title);
CREATE INDEX date_issued_idx on ItemsByDate(date_issued);
DROP VIEW CollectionItemsByDateAccessioned;
DROP VIEW CommunityItemsByDateAccessioned;
CREATE VIEW CommunityItemsByDateAccession as SELECT
Community2Item.community_id, ItemsByDateAccessioned.* FROM ItemsByDateAccessioned, Community2Item WHERE
ItemsByDateAccessioned.item_id = Community2Item.item_id;
CREATE VIEW CollectionItemsByDateAccession AS SELECT collection2item.collection_id,
itemsbydateaccessioned.items_by_date_accessioned_id, itemsbydateaccessioned.item_id,
itemsbydateaccessioned.date_accessioned FROM itemsbydateaccessioned, collection2item WHERE (itemsbydateaccessioned.item_id =
collection2item.item_id);
DSpace 3.x Documentation
4.
5.
6.
7.
8.
Fix your JSPs for Unicode. If you've modified the site 'skin' (jsp/local/layout/header-default.jsp) you'll need to add the Unicode header, i.e.:
<meta http-equiv="Content-Type" content="text/html;
charset=UTF-8">
to the <HEAD> element. If you have any locally-edited JSPs, you need to add this page directive to the top of all of them:
<%@ page contentType="text/html;charset=UTF-8" %>
(If you haven't modified any JSPs, you don't have to do anything.)
Copy the required Java libraries that we couldn't include in the bundle to the source tree. For example:
cd [dspace]/lib
cp *.policy activation.jar servlet.jar mail.jar [dspace-1.1-source]/lib
Compile up the new DSpace code, replacing [dspace]/config/dspace.cfg with the path to your current, LIVE configuration. (The second line, touch `find .`, is a precaution, which ensures that the new code has a current datestamp and will overwrite the old code. Note that those are back quotes.)
cd [dspace-1.1-source]
touch `find .`
ant
ant -Dconfig= [dspace]/config/dspace.cfg update
Update the database tables using the upgrader tool, which sets up the new >last_modified date in the item table:
Run [dspace]/bin/dsrun
org.dspace.administer.Upgrade101To11
Run the collection default authorization policy tool:
[dspace]/bin/dsrun
org.dspace.authorize.FixDefaultPolicies
9.
10.
11.
Fix the OAICat properties file. Edit [dspace]/config/templates/oaicat.properties. Change the line that says
Identify.deletedRecord=yes
To:
Identify.deletedRecord=persistent
This is needed to fix the OAI-PMH 'Identity' verb response. Then run [dspace]/bin/install-configs. Re-run the indexing to index abstracts and fill out the renamed database views:
[dspace]/bin/index-all
Restart Tomcat. Tomcat should be run with the following environment variable set, to ensure that Unicode is handled properly. Also, the default JVM memory heap sizes are rather small. Adjust -Xmx512M (512Mb maximum heap size) and -Xms64M (64Mb Java thread stack size) to suit your hardware.
JAVA_OPTS="-Xmx512M -Xms64M -Dfile.encoding=UTF-8"
DSpace 3.x Documentation
6 Configuration
There are a numbers of ways in which DSpace may be configured and/or customized. This chapter of the documentation will discuss the configuration of the software and will also reference customizations that may be performed in the chapter following.
For ease of use, the Configuration documentation is broken into several parts:
- addresses general conventions used with configuring not only the General Configuration (see page 145)
dspace.cfg file, but other configuration files which use similar conventions.
- specifies the basic The build.properties Configuration Properties File (see page 147)
file settings (these basic settings are used when building/installing/upgrading build.properties
DSpace)
- specifies the basic file The dspace.cfg Configuration Properties File (see page 148) dspace.cfg settings (these settings are used when DSpace is actually running)
- contain other more advanced settings that Optional or Advanced Configuration Settings (see page 223)
are optional in the dspace.cfg configuration file.
As of version 1.8 much of the DSpace configuration has been moved to discrete configuration files related to specific functionality and is documented in subsequent sections of this document.
The full table of contents follows:
General Configuration (see page 145) Input Conventions (see page 145) Update Reminder (see page 146) The (see page 147)
The (see page 148)
Main DSpace Configurations (see page 148) DSpace Database Configuration (see page 149) DSpace Email Settings (see page 151)
Wording of E-mail Messages (see page 154) File Storage (see page 154)
SRB (Storage Resource Brokerage) File Storage (see page 156) Logging Configuration (see page 158)
Configuring Lucene Search Indexes (see page 159)
Customize the advanced search form (see page 162) Handle Server Configuration (see page 163)
Delegation Administration : Authorization System Configuration (see page 164) Restricted Item Visibility Settings (see page 169)
Proxy Settings (see page 170)
Configuring Media Filters (see page 170)
Crosswalk and Packager Plugin Settings (see page 172)
Configurable MODS Dissemination Crosswalk (see page 172) XSLT-based Crosswalks (see page 174)
Testing XSLT Crosswalks (see page 175)
Configurable Qualified Dublin Core (QDC) dissemination crosswalk (see page 176) Configuring Crosswalk Plugins (see page 177)
Configuring Packager Plugins (see page 177) Event System Configuration (see page 177)
Embargo (see page 180)
Checksum Checker Settings (see page 181) Item Export and Download Settings (see page 182) Subscription Emails (see page 183)
Hiding Metadata (see page 183)
Settings for the Submission Process (see page 184) Configuring Creative Commons License (see page 184) WEB User Interface Configurations (see page 186) Browse Index Configuration (see page 190)
Defining the storage of the Browse Data (see page 190)
Configure the browse engine to use SOLR (see page 191) Configure the browse engine to use PostgreSQL (see page 192) Configure the browse engine to use Oracle (see page 192) Defining the Indexes. (see page 192)
Defining Sort Options (see page 193)
Browse Index Normalization Rule Configuration (see page 194) Other Browse Options (see page 195)
Browse Index Authority Control Configuration (see page 196) Author (Multiple metadata value) Display (see page 196)
Links to Other Browse Contexts (see page 197) Recent Submissions (see page 198)
Submission License Substitution Variables (see page 199) Syndication Feed (RSS) Settings (see page 199)
OpenSearch Support (see page 203)
Content Inline Disposition Threshold (see page 205) Multi-file HTML Document/Site Settings (see page 206) Sitemap Settings (see page 206)
Authority Control Settings (see page 207) JSPUI Upload File Settings (see page 208)
JSP Web Interface (JSPUI) Settings (see page 209)
DSpace 3.x Documentation
JSPUI Configuring Multilingual Support (see page 213)
Setting the Default Language for the Application (see page 213) Supporting More Than One Language (see page 214)
Changes in dspace.cfg (see page 214) Related Files (see page 214)
JSPUI Item Mapper (see page 215)
Display of Group Membership (see page 215) JSPUI / XMLUI SFX Server (see page 215)
JSPUI Item Recommendation Setting (see page 217) Controlled Vocabulary Settings (see page 217) XMLUI Specific Configuration (see page 219)
Optional or Advanced Configuration Settings (see page 223)
The Metadata Format and Bitstream Format Registries (see page 223) Metadata Format Registries (see page 223)
Bitstream Format Registry (see page 224) XPDF Filter (see page 224)
Installation Overview (see page 224) Install XPDF Tools (see page 224)
Fetch and install jai_imageio JAR (see page 225) Edit DSpace Configuration (see page 226) Build and Install (see page 227)
Configuring Usage Instrumentation Plugins (see page 227) The Passive Plugin (see page 227)
The Tab File Logger Plugin (see page 227) The XML Logger Plugin (see page 227)