DSpace Manual
		Next

DSpace Manual

Release 1.6 RC1

The DSpace Foundation

<webmaster@dspace.org>

Licensed under a Creative Commons Attribution 3.0 United States License

2009-12-02 23:21:00 EST

Revision History
Revision Version 1.6 RC1	This text generated: 2009-12-03 23:21:00 EST	JAT

Abstract

Table of Contents

Preface

1. DSpace System Documentation: Introduction

2. DSpace System Documentation: Functional Overview

2.1. Data Model

2.2. Plugin Manager

2.3. Metadata

2.4. Packager Plugins

2.5. Crosswalk Plugins

2.6. E-People and Groups

2.6.1. E-Person
2.6.2. Groups

2.7. Authentication

2.8. Authorization

2.9. Ingest Process and Workflow

2.9.1. Workflow Steps

2.10. Supervision and Collaboration

2.11. Handles

2.12. Bitstream 'Persistent' Identifiers

2.13. Storage Resource Broker (SRB) Support

2.14. Search and Browse

2.15. HTML Support

2.16. OAI Support

2.17. OpenURL Support

2.18. Creative Commons Support

2.19. Subscriptions

2.20. Import and Export

2.21. Registration

2.22. Statistics

2.23. Checksum Checker

2.24. Usage Instrumentation

3. DSpace System Documentation: Installation

3.1. For the Impatient

3.2. Prerequisite Software

3.2.1. UNIX-like OS or Microsoft Windows
3.2.2. Java JDK 5 or later (standard SDK is fine, you don't need J2EE)
3.2.3. Apache Maven 2.0.8 or later (Java build tool)
3.2.4. Apache Ant 1.7 or later (Java build tool)
3.2.5. Relational Database: (PostgreSQL or Oracle).
3.2.6. Servlet Engine: (Jakarta Tomcat 4.x, Jetty, Caucho Resin or equivalent).
3.2.7. Perl (required for [dspace]/bin/dspace-info.pl)

3.3. Installation Options

3.3.1. Overview of Install Options
3.3.2. Overview of DSpace Directories
3.3.3. Installation

3.4. Advanced Installation

3.4.1. 'cron' Jobs

3.4.2. Multilingual Installation

3.4.3. DSpace over HTTPS

3.4.3.1. To enable the HTTPS support in Tomcat 5.0:
3.4.3.2. To use SSL on Apache HTTPD with mod_jk:

3.4.4. The Handle Server

3.4.4.1. Updating Existing Handle Prefixes

3.4.5. Google and HTML sitemaps

3.5. Windows Installation

3.5.1. Pre-requisite Software
3.5.2. Installation Steps

3.6. Checking Your Installation

3.7. Known Bugs

3.8. Common Problems

4. DSpace System Documentation: Upgrading a DSpace Installation

4.1. Upgrading from 1.5.x to 1.6
4.2. Upgrading From 1.5 or 1.5.1 to 1.5.2
4.3. Upgrading From 1.4.2 to 1.5
4.4. Upgrading From 1.4.1 to 1.4.2
4.5. Upgrading From 1.4 to 1.4.x
4.6. Upgrading From 1.3.2 to 1.4.x
4.7. Upgrading From 1.3.1 to 1.3.2
4.8. Upgrading From 1.2.x to 1.3.x
4.9. Upgrading From 1.2.1 to 1.2.2
4.10. Upgrading From 1.2 to 1.2.1
4.11. Upgrading From 1.1 (or 1.1.1) to 1.2
4.12. Upgrading From 1.1 to 1.1.1
4.13. Upgrading From 1.0.1 to 1.1

5. DSpace System Documentation: Configuration

5.1. General Configuration

5.1.1. Input Conventions
5.1.2. Update Reminder

5.2. The dspace.cfg Configuration Properties File

5.2.1. The dspace.cfg file

5.2.2. Main DSpace Configurations

5.2.3. DSpace Database Configuration

5.2.4. DSpace Email Settings

5.2.4.1. Wording of E-mail Messages

5.2.5. File Storage

5.2.6. SRB (Storage Resource Brokerage) File Storage

5.2.7. Handle Server Configuration

5.2.8. Stackable Authentication Method(s)

5.2.8.1. Authentication by Password
5.2.8.2. X.509 Certificate Authentication
5.2.8.3. Example of a Custom Authentication Method
5.2.8.4. Configuring IP Authentication
5.2.8.5. Configuring LDAP Authentication

5.2.9. Shibboleth Authentication Configuration Settings

5.2.10. Logging Configuration

5.2.11. Configuring Lucene Search Indexes

5.2.12. Proxy Settings

5.2.13. Configuring Media Filters

5.2.14. Configurable MODS Dissemination Crosswalk

5.2.15. XSLT-based Crosswalks

5.2.15.1. Testing XSLT Crosswalks

5.2.16. Configurable Qualified Dublin Core (QDC) dissemination crosswalk

5.2.17. Configuring Crosswalk Plugins

5.2.18. Configuring Packager Plugins

5.2.19. Event System Configuration

5.2.20. Checksum Checker Settings

5.2.21. Item Export and Download Settings

5.2.22. Subscription Emails

5.2.23. Settings for the Submission Process

5.2.24. Configuring Creative Commons License

5.2.25. WEB User Interface Configurations

5.2.26. Browse Index Configuration

5.2.26.1. Defining the Indexes.
5.2.26.2. Defining Sort Options
5.2.26.3. Browse Index Normalization Rule Configuration
5.2.26.4. Other Browse Options

5.2.27. Author (Multiple metadata value) Display

5.2.28. Links to Other Browse Contexts

5.2.29. Recent Submissions

5.2.30. Syndication Feed (RSS) Settings

5.2.31. Content Inline Disposition Threshold

5.2.32. Multi-file HTML Document/Site Settings

5.2.33. Sitemap Settings

5.2.34. Upload File Settings

5.2.35. Statistical Report Configuration Setting

5.2.36. JSP Web Interface (JSPUI) Settings

5.2.37. Configuring Multilingual Support

5.2.37.1. Setting the Default Language for the Application
5.2.37.2. Supporting More Than One Language

5.2.38. Item Mapper

5.2.39. Display of Group Membership

5.2.40. SFX Server

5.2.41. Item Recommendation Setting

5.2.42. Controlled Vocabulary Settings

5.2.43. XMLUI Specific Configuration

5.2.44. OAI-PMH Configuration and Activation

5.2.44.1. OAI-PMH Configuration
5.2.44.2. Activating Additional OAI-PMH Crosswalks

5.2.45. Delegation Administration

5.2.46. Batch Metadata Editing

5.2.47. Hiding Metadata

5.3. Optional or Advanced Configuration Settings

5.3.1. The Metadata Format and Bitstream Format Registries

5.3.1.1. Metadata Format Registries
5.3.1.2. Bitstream Format Registry

5.3.2. XPDF Filter

5.3.2.1. Installation
5.3.2.2. Install XPDF Tools
5.3.2.3. Installation within DSpace

5.3.3. Creating a new Media/Format Filter

5.3.3.1. Creating a simple Media Filter
5.3.3.2. Creating a Dynamic or "Self-Named" Format Filter

5.3.4. Configuration Files for Other Applications

5.3.5. Configuring Usage Instrumentation Plugins

5.3.5.1. The Passive Plugin
5.3.5.2. The Tab File Logger Plugin
5.3.5.3. The XML Logger Plugin

5.3.6. SWORD Configuration

5.3.7. OpenSearch Support

5.3.8. Embargo

6. DSpace System Documentation: JPSUI Configuration and Customization

6.1. Configuration
6.2. Customizing the JSP pages

7. DSpace System Documentation: Manakin [XMLUI] Configuration and Customization

7.1. Manakin Configuration Property Keys

7.2. Configuring Themes and Aspects

7.2.1. Aspects
7.2.2. Themes

7.3. Multilingual Support

7.4. Creating a New Theme

7.5. Adding Static Content

8. DSpace System Documentation: System Administration

8.1. Community and Collection Structure Importer

8.1.1. Limitation

8.2. Package Importer and Exporter

8.2.1. Ingesting
8.2.2. Disseminating
8.2.3. METS packages

8.3. Item Importer and Exporter

8.3.1. DSpace Simple Archive Format

8.3.2. Importing Items

8.3.2.1. Adding Items to a Collection
8.3.2.2. Replacing Items in Collection
8.3.2.3. Deleting or Unimporting Items in a Collection
8.3.2.4. Other Options

8.3.3. Exporting Items

8.4. Transferring Items Between DSpace Instances

8.5. Item Update

8.5.1. DSpace simple Archive Format
8.5.2. ItemUpdate Commands
8.5.3. CLI Examples

8.6. Registering (Not Importing) Bitstreams

8.6.1. Accessible Storage
8.6.2. Registering Items Using the Item Importer
8.6.3. Internal Identification and Retrieval of Registered Items
8.6.4. Exporting Registered Items
8.6.5. METS Export of Registered Items
8.6.6. Deleting Registered Items

8.7. METS Tools

8.7.1. The Export Tool
8.7.2. The AIP Format
8.7.3. Limitations

8.8. MediaFilters: Transforming DSpace Content

8.9. Sub-Community Management

8.10. Batch Metadata Editing

8.10.1. Export Function

8.10.1.1. Exporting Process

8.10.2. Import Function

8.10.2.1. Importing Process

8.10.3. The CSV Files

8.11. Checksum Checker

8.11.1. Checker Execution Mode
8.11.2. Checker Results Pruning
8.11.3. Checker Reporting
8.11.4. Cron or Automatic Execution of Checksum Checker
8.11.5. Automated Checksum Checkers' Results

8.12. Embargo

8.13. Browse Index Creation

8.13.1. Running the Indexing Programs
8.13.2. Indexing Customization

9. DSpace System Documentation: Storage Layer

9.1. RDBMS

9.1.1. Maintenance and Backup
9.1.2. Configuring the RDBMS Component

9.2. Bitstream Store

9.2.1. Backup

9.2.2. Configuring the Bitstream Store

9.2.2.1. Configuring Traditonal Storage
9.2.2.2. Configuring SRB Storage

10. DSpace System Documentation: Directories and Files

10.1. Overview
10.2. Source Directory Layout
10.3. Installed Directory Layout
10.4. Contents of JSPUI Web Application
10.5. Contents of XMLUI Web Application (aka Manakin)
10.6. Log Files

11. DSpace System Documentation: Architecture

11.1. Overview

12. DSpace System Documentation: Application Layer

12.1. Web User Interface

12.1.1. Web UI Files

12.1.2. The Build Process

12.1.3. Servlets and JSPs

12.1.4. Custom JSP Tags

12.1.5. Internationalization

12.1.5.1. Message Key Convention
12.1.5.2. Which Languages are currently supported?

12.1.6. HTML Content in Items

12.1.7. Thesis Blocking

12.2. OAI-PMH Data Provider

12.2.1. Sets
12.2.2. Unique Identifier
12.2.3. Access control
12.2.4. Modification Date (OAI Date Stamp)
12.2.5. 'About' Information
12.2.6. Deletions
12.2.7. Flow Control (Resumption Tokens)

12.3. DSpace Command Launcher

12.3.1. Older Versions
12.3.2. Command Launcher Structure

13. DSpace System Documentation: Business Logic Layer

13.1. Core Classes

13.1.1. The Configuration Manager (ConfigurationManager)
13.1.2. Constants
13.1.3. Context
13.1.4. Email
13.1.5. LogManager
13.1.6. Utils

13.2. Content Management API

13.2.1. Other Classes
13.2.2. Modifications
13.2.3. What's In Memory?
13.2.4. Dublin Core Metadata
13.2.5. Support for Other Metadata Schemas
13.2.6. Packager Plugins

13.3. Plugin Manager

13.3.1. Concepts

13.3.2. Using the Plugin Manager

13.3.2.1. Types of Plugin
13.3.2.2. Self-Named Plugins
13.3.2.3. Obtaining a Plugin Instance
13.3.2.4. Lifecycle Management
13.3.2.5. Getting Meta-Information

13.3.3. Implementation

13.3.3.1. PluginManager Class
13.3.3.2. SelfNamedPlugin Class
13.3.3.3. Errors and Exceptions

13.3.4. Configuring Plugins

13.3.4.1. Configuring Singleton (Single) Plugins
13.3.4.2. Configuring Sequence of Plugins
13.3.4.3. Configuring Named Plugins
13.3.4.4. Configuring the Reusable Status of a Plugin

13.3.5. Validating the Configuration

13.3.6. Use Cases

13.3.6.1. Managing the MediaFilter plugins transparently
13.3.6.2. A Singleton Plugin
13.3.6.3. Plugin that Names Itself
13.3.6.4. Stackable Authentication

13.4. Workflow System

13.5. Administration Toolkit

13.6. E-person/Group Manager

13.7. Authorization

13.7.1. Special Groups
13.7.2. Miscellaneous Authorization Notes

13.8. Handle Manager/Handle Plugin

13.9. Search

13.9.1. Current Lucene Implementation
13.9.2. Indexed Fields
13.9.3. Harvesting API

13.10. Browse API

13.10.1. Using the API
13.10.2. Index Maintenance
13.10.3. Caveats

13.11. Checksum checker

13.12. OpenSearch Support

13.13. Embargo

14. DSpace System Documentation: Customizing and Configuring Submission User Interface

14.1. Understanding the Submission Configuration File

14.1.1. The Structure of item-submission.xml

14.1.2. Defining Steps (<step>) within the item-submission.xml

14.1.2.1. Where to place your <step> definitions
14.1.2.2. The ordering of <step> definitions matters!
14.1.2.3. Structure of the <step> Definition

14.2. Reordering/Removing Submission Steps

14.3. Assigning a custom Submission Process to a Collection

14.3.1. Getting A Collection's Handle

14.4. Custom Metadata-entry Pages for Submission

14.4.1. Introduction

14.4.2. Describing Custom Metadata Forms

14.4.3. The Structure of input-forms.xml

14.4.3.1. Adding a Collection Map
14.4.3.2. Adding a Form Set
14.4.3.3. Adding Value-Pairs

14.4.4. Deploying Your Custom Forms

14.5. Configuring the File Upload step

14.6. Creating new Submission Steps

14.6.1. Creating a Non-Interactive Step

15. DSpace System Documentation: DRI Schema Reference

15.1. Introduction

15.1.1. The Purpose of DRI
15.1.2. The Development of DRI

15.2. DRI in Manakin

15.2.1. Themes
15.2.2. Aspect Chains

15.3. Common Design Patterns

15.3.1. Localization and Internationalization
15.3.2. Standard attribute triplet
15.3.3. Structure-oriented markup

15.4. Schema Overview

15.5. Merging of DRI Documents

15.6. Version Changes

15.6.1. Changes from 1.0 to 1.1

15.7. Element Reference

15.7.1. BODY
15.7.2. cell
15.7.3. div
15.7.4. DOCUMENT
15.7.5. field
15.7.6. figure
15.7.7. head
15.7.8. help
15.7.9. hi
15.7.10. instance
15.7.11. item
15.7.12. label
15.7.13. list
15.7.14. META
15.7.15. metadata
15.7.16. OPTIONS
15.7.17. p
15.7.18. pageMeta
15.7.19. params
15.7.20. reference
15.7.21. referenceSet
15.7.22. repository
15.7.23. repositoryMeta
15.7.24. row
15.7.25. table
15.7.26. trail
15.7.27. userMeta
15.7.28. value
15.7.29. xref

16. DSpace System Documentation: Version History

16.1. Changes in DSpace 1.5.2

16.1.1. General Improvements
16.1.2. Bug fixes and smaller patches

16.2. Changes in DSpace 1.5.1

16.2.1. General Improvements
16.2.2. Bug fixes and smaller patches

16.3. Changes in DSpace 1.5

16.3.1. General Improvements
16.3.2. Bug fixes and smaller patches

16.4. Changes in DSpace 1.4.1

16.4.1. General Improvements
16.4.2. Bug fixes

16.5. Changes in DSpace 1.4

16.5.1. General Improvements
16.5.2. Bug fixes

16.6. Changes in DSpace 1.3.2

16.6.1. General Improvements
16.6.2. Bug fixes

16.7. Changes in DSpace 1.3.1

16.7.1. Bug fixes

16.8. Changes in DSpace 1.3

16.8.1. General Improvements
16.8.2. Bug fixes

16.9. Changes in DSpace 1.2.2

16.9.1. General Improvements
16.9.2. Bug fixes
16.9.3. Changes in JSPs

16.10. Changes in DSpace 1.2.1

16.10.1. General Improvements
16.10.2. Bug fixes
16.10.3. Changed JSPs

16.11. Changes in DSpace 1.2

16.11.1. General Improvments
16.11.2. Administration
16.11.3. Import/Export/OAI
16.11.4. Miscellaneous
16.11.5. JSP file changes between 1.1 and 1.2

16.12. Changes in DSpace 1.1.1

16.12.1. Bug fixes
16.12.2. Improvements

16.13. Changes in DSpace 1.1

A. DSpace System Documentation: Appendix A

A.1. Default Dublin Core Metadata Registry
A.2. Default Bitstream Format Registry

Index

List of Tables

2.1. MIT Libraries' Definitions of Bitstream Format Support Levels
2.2. Objects in the DSpace Data Model
5.1. The dspace.cfg Main Properties
8.1. Command Help Table
8.2. Structure Importer Command Table
8.3. Import Items Command Table
8.4. Export Items Command Table
8.5. ItemUpdate Command Table
8.6. Mets Export Command table
8.7. Community Filiator Command table
8.8. Batch Editing Metatdata Export Command Table
8.9. Batch Editing Metatdata Import Command Table
8.10. Checksum Checker Information Table
8.11. Embargo Manager Command Table
8.12. Browse Index Command Table
10.1. DSpace Log File Locations
11.1. Source Code Packages
12.1. Locations of Web UI Source Files

		Next
		Preface