Version 1.7 for 1.7RC1 release.

git-svn-id: http://scm.dspace.org/svn/repo/dspace/trunk@5760 9c30dcfa-912a-0410-8fc2-9e0234be79fd
This commit is contained in:
Jeffrey Trimble
2010-11-06 19:33:17 +00:00
parent f88f1fd83f
commit 323126b90b
57 changed files with 22557 additions and 0 deletions

View File

@@ -0,0 +1,37 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>DSpace Documentation : Appendices</title>
<link rel="stylesheet" href="styles/site.css" type="text/css" />
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
<table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
<tr>
<td valign="top" class="pagebody">
<div class="pageheader">
<span class="pagetitle">
DSpace Documentation : Appendices
</span>
</div>
<div class="pagesubheading">
This page last changed on Dec 29, 2009 by <font color="#0050B2">mdiggory</font>.
</div>
</td>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td height="12" background="https://wiki.duraspace.org/images/border/border_bottom.gif"><img src="images/border/spacer.gif" width="1" height="1" border="0"/></td>
</tr>
<tr>
<td align="center"><font color="grey">Document generated by Confluence on Nov 06, 2010 19:27</font></td>
</tr>
</table>
</body>
</html>

688
dspace/docs/html/Appendix A.html Executable file
View File

@@ -0,0 +1,688 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>DSpace Documentation : Appendix A</title>
<link rel="stylesheet" href="styles/site.css" type="text/css" />
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
<table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
<tr>
<td valign="top" class="pagebody">
<div class="pageheader">
<span class="pagetitle">
DSpace Documentation : Appendix A
</span>
</div>
<div class="pagesubheading">
This page last changed on Nov 06, 2010 by <font color="#0050B2">jtrimble</font>.
</div>
<h1><a name="AppendixA-DSpaceSystemDocumentation%3AAppendixA"></a>DSpace System Documentation: Appendix A</h1>
<h2><a name="AppendixA-DefaultDublinCoreMetadataRegistry"></a>Default Dublin Core Metadata Registry</h2>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'> contributor </td>
<td class='confluenceTd'>&nbsp;</td>
<td class='confluenceTd'> A person, organization, or service responsible for the content of the resource. Catch-all for unspecified contributors. </td>
</tr>
<tr>
<td class='confluenceTd'> contributor </td>
<td class='confluenceTd'> advisor </td>
<td class='confluenceTd'> Use primarily for thesis advisor. </td>
</tr>
<tr>
<td class='confluenceTd'> contributor¹ </td>
<td class='confluenceTd'> author </td>
<td class='confluenceTd'>&nbsp;</td>
</tr>
<tr>
<td class='confluenceTd'> contributor </td>
<td class='confluenceTd'> editor </td>
<td class='confluenceTd'>&nbsp;</td>
</tr>
<tr>
<td class='confluenceTd'> contributor </td>
<td class='confluenceTd'> illustrator </td>
<td class='confluenceTd'>&nbsp;</td>
</tr>
<tr>
<td class='confluenceTd'> contributor </td>
<td class='confluenceTd'> other </td>
<td class='confluenceTd'>&nbsp;</td>
</tr>
<tr>
<td class='confluenceTd'> coverage </td>
<td class='confluenceTd'> spatial </td>
<td class='confluenceTd'> Spatial characteristics of content. </td>
</tr>
<tr>
<td class='confluenceTd'> coverage </td>
<td class='confluenceTd'> temporal </td>
<td class='confluenceTd'> Temporal characteristics of content. </td>
</tr>
<tr>
<td class='confluenceTd'> creator </td>
<td class='confluenceTd'>&nbsp;</td>
<td class='confluenceTd'> Do not use; only for harvested metadata. </td>
</tr>
<tr>
<td class='confluenceTd'> date </td>
<td class='confluenceTd'>&nbsp;</td>
<td class='confluenceTd'> Use qualified form if possible. </td>
</tr>
<tr>
<td class='confluenceTd'> date¹ </td>
<td class='confluenceTd'> accessioned </td>
<td class='confluenceTd'> Date DSpace takes possession of item. </td>
</tr>
<tr>
<td class='confluenceTd'> date¹ </td>
<td class='confluenceTd'> available </td>
<td class='confluenceTd'> Date or date range item became available to the public. </td>
</tr>
<tr>
<td class='confluenceTd'> date </td>
<td class='confluenceTd'> copyright </td>
<td class='confluenceTd'> Date of copyright. </td>
</tr>
<tr>
<td class='confluenceTd'> date </td>
<td class='confluenceTd'> created </td>
<td class='confluenceTd'> Date of creation or manufacture of intellectual content if different from date.issued. </td>
</tr>
<tr>
<td class='confluenceTd'> date¹ </td>
<td class='confluenceTd'> issued </td>
<td class='confluenceTd'> Date of publication or distribution. </td>
</tr>
<tr>
<td class='confluenceTd'> date </td>
<td class='confluenceTd'> submitted </td>
<td class='confluenceTd'> Recommend for theses/dissertations. </td>
</tr>
<tr>
<td class='confluenceTd'> identifier </td>
<td class='confluenceTd'>&nbsp;</td>
<td class='confluenceTd'> Catch-all for unambiguous identifiers not defined by qualified form; use identifier.other for a known identifier common to a local collection instead of unqualified form. </td>
</tr>
<tr>
<td class='confluenceTd'> identifier¹ </td>
<td class='confluenceTd'> citation </td>
<td class='confluenceTd'> Human-readable, standard bibliographic citation of non-DSpace format of this item </td>
</tr>
<tr>
<td class='confluenceTd'> identifier¹ </td>
<td class='confluenceTd'> govdoc </td>
<td class='confluenceTd'> A government document number </td>
</tr>
<tr>
<td class='confluenceTd'> identifier¹ </td>
<td class='confluenceTd'> isbn </td>
<td class='confluenceTd'> International Standard Book Number </td>
</tr>
<tr>
<td class='confluenceTd'> identifier¹ </td>
<td class='confluenceTd'> issn </td>
<td class='confluenceTd'> International Standard Serial Number </td>
</tr>
<tr>
<td class='confluenceTd'> identifier </td>
<td class='confluenceTd'> sici </td>
<td class='confluenceTd'> Serial Item and Contribution Identifier </td>
</tr>
<tr>
<td class='confluenceTd'> identifier¹ </td>
<td class='confluenceTd'> ismn </td>
<td class='confluenceTd'> International Standard Music Number </td>
</tr>
<tr>
<td class='confluenceTd'> identifier¹ </td>
<td class='confluenceTd'> other </td>
<td class='confluenceTd'> A known identifier type common to a local collection. </td>
</tr>
<tr>
<td class='confluenceTd'> identifier¹ </td>
<td class='confluenceTd'> uri </td>
<td class='confluenceTd'> Uniform Resource Identifier </td>
</tr>
<tr>
<td class='confluenceTd'> description¹ </td>
<td class='confluenceTd'>&nbsp;</td>
<td class='confluenceTd'> Catch-all for any description not defined by qualifiers. </td>
</tr>
<tr>
<td class='confluenceTd'> description¹ </td>
<td class='confluenceTd'> abstract </td>
<td class='confluenceTd'> Abstract or summary. </td>
</tr>
<tr>
<td class='confluenceTd'> description¹ </td>
<td class='confluenceTd'> provenance </td>
<td class='confluenceTd'> The history of custody of the item since its creation, including any changes successive custodians made to it. </td>
</tr>
<tr>
<td class='confluenceTd'> description¹ </td>
<td class='confluenceTd'> sponsorship </td>
<td class='confluenceTd'> Information about sponsoring agencies, individuals, or contractual arrangements for the item. </td>
</tr>
<tr>
<td class='confluenceTd'> description </td>
<td class='confluenceTd'> statementofresponsibility </td>
<td class='confluenceTd'> To preserve statement of responsibility from MARC records. </td>
</tr>
<tr>
<td class='confluenceTd'> description </td>
<td class='confluenceTd'> tableofcontents </td>
<td class='confluenceTd'> A table of contents for a given item. </td>
</tr>
<tr>
<td class='confluenceTd'> description </td>
<td class='confluenceTd'> uri </td>
<td class='confluenceTd'> Uniform Resource Identifier pointing to description of this item. </td>
</tr>
<tr>
<td class='confluenceTd'> format¹ </td>
<td class='confluenceTd'>&nbsp;</td>
<td class='confluenceTd'> Catch-all for any format information not defined by qualifiers. </td>
</tr>
<tr>
<td class='confluenceTd'> format¹ </td>
<td class='confluenceTd'> extent </td>
<td class='confluenceTd'> Size or duration. </td>
</tr>
<tr>
<td class='confluenceTd'> format </td>
<td class='confluenceTd'> medium </td>
<td class='confluenceTd'> Physical medium. </td>
</tr>
<tr>
<td class='confluenceTd'> format¹ </td>
<td class='confluenceTd'> mimetype </td>
<td class='confluenceTd'> Registered MIME type identifiers. </td>
</tr>
<tr>
<td class='confluenceTd'> language </td>
<td class='confluenceTd'>&nbsp;</td>
<td class='confluenceTd'> Catch-all for non-ISO forms of the language of the item, accommodating harvested values. </td>
</tr>
<tr>
<td class='confluenceTd'> language¹ </td>
<td class='confluenceTd'> iso </td>
<td class='confluenceTd'> Current ISO standard for language of intellectual content, including country codes (e.g. "en_US"). </td>
</tr>
<tr>
<td class='confluenceTd'> publisher¹ </td>
<td class='confluenceTd'>&nbsp;</td>
<td class='confluenceTd'> Entity responsible for publication, distribution, or imprint. </td>
</tr>
<tr>
<td class='confluenceTd'> relation </td>
<td class='confluenceTd'>&nbsp;</td>
<td class='confluenceTd'> Catch-all for references to other related items. </td>
</tr>
<tr>
<td class='confluenceTd'> relation </td>
<td class='confluenceTd'> isformatof </td>
<td class='confluenceTd'> References additional physical form. </td>
</tr>
<tr>
<td class='confluenceTd'> relation </td>
<td class='confluenceTd'> ispartof </td>
<td class='confluenceTd'> References physically or logically containing item. </td>
</tr>
<tr>
<td class='confluenceTd'> relation¹ </td>
<td class='confluenceTd'> ispartofseries </td>
<td class='confluenceTd'> Series name and number within that series, if available. </td>
</tr>
<tr>
<td class='confluenceTd'> relation </td>
<td class='confluenceTd'> haspart </td>
<td class='confluenceTd'> References physically or logically contained item. </td>
</tr>
<tr>
<td class='confluenceTd'> relation </td>
<td class='confluenceTd'> isversionof </td>
<td class='confluenceTd'> References earlier version. </td>
</tr>
<tr>
<td class='confluenceTd'> relation </td>
<td class='confluenceTd'> hasversion </td>
<td class='confluenceTd'> References later version. </td>
</tr>
<tr>
<td class='confluenceTd'> relation </td>
<td class='confluenceTd'> isbasedon </td>
<td class='confluenceTd'> References source. </td>
</tr>
<tr>
<td class='confluenceTd'> relation </td>
<td class='confluenceTd'> isreferencedby </td>
<td class='confluenceTd'> Pointed to by referenced resource. </td>
</tr>
<tr>
<td class='confluenceTd'> relation </td>
<td class='confluenceTd'> requires </td>
<td class='confluenceTd'> Referenced resource is required to support function, delivery, or coherence of item. </td>
</tr>
<tr>
<td class='confluenceTd'> relation </td>
<td class='confluenceTd'> replaces </td>
<td class='confluenceTd'> References preceeding item. </td>
</tr>
<tr>
<td class='confluenceTd'> relation </td>
<td class='confluenceTd'> isreplacedby </td>
<td class='confluenceTd'> References succeeding item. </td>
</tr>
<tr>
<td class='confluenceTd'> relation </td>
<td class='confluenceTd'> uri </td>
<td class='confluenceTd'> References Uniform Resource Identifier for related item </td>
</tr>
<tr>
<td class='confluenceTd'> rights </td>
<td class='confluenceTd'>&nbsp;</td>
<td class='confluenceTd'> Terms governing use and reproduction. </td>
</tr>
<tr>
<td class='confluenceTd'> rights </td>
<td class='confluenceTd'> uri </td>
<td class='confluenceTd'> References terms governing use and reproduction. </td>
</tr>
<tr>
<td class='confluenceTd'> source </td>
<td class='confluenceTd'>&nbsp;</td>
<td class='confluenceTd'> Do not use; only for harvested metadata. </td>
</tr>
<tr>
<td class='confluenceTd'> source </td>
<td class='confluenceTd'> uri </td>
<td class='confluenceTd'> Do not use; only for harvested metadata. </td>
</tr>
<tr>
<td class='confluenceTd'> subject¹ </td>
<td class='confluenceTd'>&nbsp;</td>
<td class='confluenceTd'> Uncontrolled index term. </td>
</tr>
<tr>
<td class='confluenceTd'> subject </td>
<td class='confluenceTd'> classification </td>
<td class='confluenceTd'> Catch-all for value from local classification system. Global classification systems will receive specific qualifier </td>
</tr>
<tr>
<td class='confluenceTd'> subject </td>
<td class='confluenceTd'> ddc </td>
<td class='confluenceTd'> Dewey Decimal Classification Number </td>
</tr>
<tr>
<td class='confluenceTd'> subject </td>
<td class='confluenceTd'> lcc </td>
<td class='confluenceTd'> Library of Congress Classification Number </td>
</tr>
<tr>
<td class='confluenceTd'> subject </td>
<td class='confluenceTd'> lcsh </td>
<td class='confluenceTd'> Library of Congress Subject Headings </td>
</tr>
<tr>
<td class='confluenceTd'> subject </td>
<td class='confluenceTd'> mesh </td>
<td class='confluenceTd'> MEdical Subject Headings </td>
</tr>
<tr>
<td class='confluenceTd'> subject </td>
<td class='confluenceTd'> other </td>
<td class='confluenceTd'> Local controlled vocabulary; global vocabularies will receive specific qualifier. </td>
</tr>
<tr>
<td class='confluenceTd'> title¹ </td>
<td class='confluenceTd'>&nbsp;</td>
<td class='confluenceTd'> Title statement/title proper. </td>
</tr>
<tr>
<td class='confluenceTd'> title¹ </td>
<td class='confluenceTd'> alternative </td>
<td class='confluenceTd'> Varying (or substitute) form of title proper appearing in item, e.g. abbreviation or translation </td>
</tr>
<tr>
<td class='confluenceTd'> type¹ </td>
<td class='confluenceTd'>&nbsp;</td>
<td class='confluenceTd'> Nature or genre of content. </td>
</tr>
</tbody></table>
</div>
<p>¹Used by system. <b>DO NOT REMOVE</b></p>
<h2><a name="AppendixA-DefaultBitstreamFormatRegistry"></a>Default Bitstream Format Registry</h2>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'> <b>Mimetype</b> </td>
<td class='confluenceTd'> <b>Short Description</b> </td>
<td class='confluenceTd'> <b>Description</b> </td>
<td class='confluenceTd'> <b>Support Level</b> </td>
<td class='confluenceTd'> <b>Internal</b> </td>
<td class='confluenceTd'> <b>Extensions</b> </td>
</tr>
<tr>
<td class='confluenceTd'> application/octet-stream¹ </td>
<td class='confluenceTd'> Unknown </td>
<td class='confluenceTd'> Unknown data format </td>
<td class='confluenceTd'> Unknown </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'>&nbsp;</td>
</tr>
<tr>
<td class='confluenceTd'> text/plain¹ </td>
<td class='confluenceTd'> License </td>
<td class='confluenceTd'> Item-specific license agreed upon to submission </td>
<td class='confluenceTd'> Known </td>
<td class='confluenceTd'> true </td>
<td class='confluenceTd'>&nbsp;</td>
</tr>
<tr>
<td class='confluenceTd'> application/marc </td>
<td class='confluenceTd'> MARC </td>
<td class='confluenceTd'> Machine-Readable Cataloging records </td>
<td class='confluenceTd'> Known </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'>&nbsp;</td>
</tr>
<tr>
<td class='confluenceTd'> application/mathematica </td>
<td class='confluenceTd'> Mathematica </td>
<td class='confluenceTd'> Mathematica Notebook </td>
<td class='confluenceTd'> Known </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> ma </td>
</tr>
<tr>
<td class='confluenceTd'> application/msword </td>
<td class='confluenceTd'> Microsoft Word </td>
<td class='confluenceTd'> Microsoft Word </td>
<td class='confluenceTd'> Known </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> doc </td>
</tr>
<tr>
<td class='confluenceTd'> application/pdf </td>
<td class='confluenceTd'> Adobe PDF </td>
<td class='confluenceTd'> Adobe Portable Document Format </td>
<td class='confluenceTd'> Known </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> pdf </td>
</tr>
<tr>
<td class='confluenceTd'> application/postscript </td>
<td class='confluenceTd'> Postscript </td>
<td class='confluenceTd'> Postscript Files </td>
<td class='confluenceTd'> Known </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> ai, eps, ps </td>
</tr>
<tr>
<td class='confluenceTd'> application/sgml </td>
<td class='confluenceTd'> SGML </td>
<td class='confluenceTd'> SGML application (RFC 1874) </td>
<td class='confluenceTd'> Known </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> sgm, sgml </td>
</tr>
<tr>
<td class='confluenceTd'> application/vnd.ms-excel </td>
<td class='confluenceTd'> Microsoft Excel </td>
<td class='confluenceTd'> Microsoft Excel </td>
<td class='confluenceTd'> Known </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> xls </td>
</tr>
<tr>
<td class='confluenceTd'> application/vnd.ms-powerpoint </td>
<td class='confluenceTd'> Microsoft Powerpoint </td>
<td class='confluenceTd'> Microsoft Powerpoint </td>
<td class='confluenceTd'> Known </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> ppt </td>
</tr>
<tr>
<td class='confluenceTd'> application/vnd.ms-project </td>
<td class='confluenceTd'> Microsoft Project </td>
<td class='confluenceTd'> Microsoft Project </td>
<td class='confluenceTd'> Known </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> mpd, mpp, mpx </td>
</tr>
<tr>
<td class='confluenceTd'> application/vnd.visio </td>
<td class='confluenceTd'> Microsoft Visio </td>
<td class='confluenceTd'> Microsoft Visio </td>
<td class='confluenceTd'> Known </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> vsd </td>
</tr>
<tr>
<td class='confluenceTd'> application/wordperfect5.1 </td>
<td class='confluenceTd'> WordPerfect </td>
<td class='confluenceTd'> WordPerfect 5.1 document </td>
<td class='confluenceTd'> Known </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> wpd </td>
</tr>
<tr>
<td class='confluenceTd'> application/x-dvi </td>
<td class='confluenceTd'> TeX dvi </td>
<td class='confluenceTd'> TeX dvi format </td>
<td class='confluenceTd'> Known </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> dvi </td>
</tr>
<tr>
<td class='confluenceTd'> application/x-filemaker </td>
<td class='confluenceTd'> FMP3 </td>
<td class='confluenceTd'> Filemaker Pro </td>
<td class='confluenceTd'> Known </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> fm </td>
</tr>
<tr>
<td class='confluenceTd'> application/x-latex </td>
<td class='confluenceTd'> LateX </td>
<td class='confluenceTd'> LaTeX document </td>
<td class='confluenceTd'> Known </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> latex </td>
</tr>
<tr>
<td class='confluenceTd'> application/x-photoshop </td>
<td class='confluenceTd'> Photoshop </td>
<td class='confluenceTd'> Photoshop </td>
<td class='confluenceTd'> Known </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> pdd, psd </td>
</tr>
<tr>
<td class='confluenceTd'> application/x-tex </td>
<td class='confluenceTd'> TeX </td>
<td class='confluenceTd'> Tex/LateX document </td>
<td class='confluenceTd'> Known </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> tex </td>
</tr>
<tr>
<td class='confluenceTd'> audio/basic </td>
<td class='confluenceTd'> audio/basic </td>
<td class='confluenceTd'> Basic Audio </td>
<td class='confluenceTd'> Known </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> au, snd </td>
</tr>
<tr>
<td class='confluenceTd'> audio/x-aiff </td>
<td class='confluenceTd'> AIFF </td>
<td class='confluenceTd'> Audio Interchange File Format </td>
<td class='confluenceTd'> Known </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> aif, aifc, aiff </td>
</tr>
<tr>
<td class='confluenceTd'> audio/x-mpeg </td>
<td class='confluenceTd'> MPEG Audio </td>
<td class='confluenceTd'> MPEG Audio </td>
<td class='confluenceTd'> Known </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> abs, mpa, mpega </td>
</tr>
<tr>
<td class='confluenceTd'> audio/x-pn-realaudio </td>
<td class='confluenceTd'> RealAudio </td>
<td class='confluenceTd'> RealAudio file </td>
<td class='confluenceTd'> Known </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> ra, ram </td>
</tr>
<tr>
<td class='confluenceTd'> audio/x-wav </td>
<td class='confluenceTd'> WAV </td>
<td class='confluenceTd'> Broadcase Wave Format </td>
<td class='confluenceTd'> Known </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> wav </td>
</tr>
<tr>
<td class='confluenceTd'> image/gif </td>
<td class='confluenceTd'> GIF </td>
<td class='confluenceTd'> Graphics Interchange Format </td>
<td class='confluenceTd'> Known </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> gif </td>
</tr>
<tr>
<td class='confluenceTd'> image/jpeg </td>
<td class='confluenceTd'> JPEG </td>
<td class='confluenceTd'> Joint Photographic Experts Group/JPEG File Interchange Format (JFIF) </td>
<td class='confluenceTd'> Known </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> jpeg, jpg </td>
</tr>
<tr>
<td class='confluenceTd'> image/png </td>
<td class='confluenceTd'> image/png </td>
<td class='confluenceTd'> Portable Network Graphics </td>
<td class='confluenceTd'> Known </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> png </td>
</tr>
<tr>
<td class='confluenceTd'> image/tiff </td>
<td class='confluenceTd'> TIFF </td>
<td class='confluenceTd'> Tag Image File Format </td>
<td class='confluenceTd'> Known </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> tif, tiff </td>
</tr>
<tr>
<td class='confluenceTd'> image/x-ms-bmp </td>
<td class='confluenceTd'> BMP </td>
<td class='confluenceTd'> Microsoft Windows bitmap </td>
<td class='confluenceTd'> Known </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> bmp </td>
</tr>
<tr>
<td class='confluenceTd'> image/x-photo-cd </td>
<td class='confluenceTd'> Photo CD </td>
<td class='confluenceTd'> Kodak Photo CD image </td>
<td class='confluenceTd'> Known </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> pcd </td>
</tr>
<tr>
<td class='confluenceTd'> text/css </td>
<td class='confluenceTd'> CSS </td>
<td class='confluenceTd'> Cascading Style Sheets </td>
<td class='confluenceTd'> Known </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> css </td>
</tr>
<tr>
<td class='confluenceTd'> text/html </td>
<td class='confluenceTd'> HTML </td>
<td class='confluenceTd'> Hypertext Markup Language </td>
<td class='confluenceTd'> Known </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> htm, html </td>
</tr>
<tr>
<td class='confluenceTd'> text/plain </td>
<td class='confluenceTd'> Text </td>
<td class='confluenceTd'> Plain Text </td>
<td class='confluenceTd'> Known </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> asc, txt </td>
</tr>
<tr>
<td class='confluenceTd'> text/richtext </td>
<td class='confluenceTd'> RTF </td>
<td class='confluenceTd'> Rich Text Format </td>
<td class='confluenceTd'> Known </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> rtf </td>
</tr>
<tr>
<td class='confluenceTd'> text/xml </td>
<td class='confluenceTd'> XML </td>
<td class='confluenceTd'> Extensible Markup Language </td>
<td class='confluenceTd'> Known </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> xml </td>
</tr>
<tr>
<td class='confluenceTd'> video/mpeg </td>
<td class='confluenceTd'> MPEG </td>
<td class='confluenceTd'> Moving Picture Experts Group </td>
<td class='confluenceTd'> Known </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> mpe, mpeg, mpg </td>
</tr>
<tr>
<td class='confluenceTd'> video/quicktime </td>
<td class='confluenceTd'> Video Quicktime </td>
<td class='confluenceTd'> Video Quicktime </td>
<td class='confluenceTd'> Known </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> mov, qt </td>
</tr>
</tbody></table>
</div>
<p>¹ Used by system: do not remove</p>
</td>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td height="12" background="https://wiki.duraspace.org/images/border/border_bottom.gif"><img src="images/border/spacer.gif" width="1" height="1" border="0"/></td>
</tr>
<tr>
<td align="center"><font color="grey">Document generated by Confluence on Nov 06, 2010 19:27</font></td>
</tr>
</table>
</body>
</html>

541
dspace/docs/html/Application.html Executable file
View File

@@ -0,0 +1,541 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>DSpace Documentation : Application</title>
<link rel="stylesheet" href="styles/site.css" type="text/css" />
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
<table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
<tr>
<td valign="top" class="pagebody">
<div class="pageheader">
<span class="pagetitle">
DSpace Documentation : Application
</span>
</div>
<div class="pagesubheading">
This page last changed on Nov 06, 2010 by <font color="#0050B2">jtrimble</font>.
</div>
<h1><a name="Application-DSpaceSystemDocumentation%3AApplicationLayer"></a>DSpace System Documentation: Application Layer</h1>
<p>The following explains how the application layer is built and used.</p>
<h2><a name="Application-WebUserInterface"></a>Web User Interface</h2>
<p>The DSpace Web UI is the largest and most-used component in the application layer. Built on Java Servlet and JavaServer Page technology, it allows end-users to access DSpace over the Web via their Web browsers. As of Dspace 1.3.2 the UI meets both XHTML 1.0 standards and Web Accessibility Initiative (WAI) level-2 standard.</p>
<p>It also features an administration section, consisting of pages intended for use by central administrators. Presently, this part of the Web UI is not particularly sophisticated; users of the administration section need to know what they are doing&#33; Selected parts of this may also be used by collection administrators.</p>
<h3><a name="Application-WebUIFiles"></a>Web UI Files</h3>
<p>The Web UI-related files are located in a variety of directories in the DSpace source tree. Note that as of DSpace version 1.5, the deployment has changed. The build systems has moved to a maven-based system enabling the various projects (JSPUI, XMLUI, etc.) into separate projects. The system still uses the familar 'Ant' to deploy the webapps in later stages.</p>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'> <b>Location</b> </td>
<td class='confluenceTd'> <b>Description</b> </td>
</tr>
<tr>
<td class='confluenceTd'> <em>[dspace-source]/dspace-jspui/dspace-jspui-api/src/main/java/org/dspace/app/webui</em> </td>
<td class='confluenceTd'> Web UI source files </td>
</tr>
<tr>
<td class='confluenceTd'> <em>[dspace-source]/dspace-jspui/dspace-jspui-api/src/main/java/org/dspace/app/filters</em> </td>
<td class='confluenceTd'> Servlet Filters (Servlet 2.3 spec) </td>
</tr>
<tr>
<td class='confluenceTd'> <em>[dspace-source]/dspace-jspui/dspace-jspui-api/src/main/java/org/dspace/app/jsptag</em> </td>
<td class='confluenceTd'> Custom JSP tag class files </td>
</tr>
<tr>
<td class='confluenceTd'> <em>[dspace-source]/dspace-jspui/dspace-jspui-api/src/main/java/org/dspace/app/servlet</em> </td>
<td class='confluenceTd'> Servlets for main Web UI (controllers) </td>
</tr>
<tr>
<td class='confluenceTd'> <em>[dspace-source]/dspace-jspui/dspace-jspui-api/src/main/java/org/dspace/app/servlet/admin</em> </td>
<td class='confluenceTd'> Servlets that comprise the administration part of the Web UI </td>
</tr>
<tr>
<td class='confluenceTd'> <em>[dspace-source]/dspace-jspui/dspace-jspui-api/src/main/java/org/dspace/app/webui/util/</em> </td>
<td class='confluenceTd'> Miscellaneous classes used by the servlets and filters </td>
</tr>
<tr>
<td class='confluenceTd'> <em>[dspace-source]/dspace-jspui</em> </td>
<td class='confluenceTd'> The JSP files </td>
</tr>
<tr>
<td class='confluenceTd'> <em>[dspace-source]/dspace/modules/jspui/src/main/webapp</em> </td>
<td class='confluenceTd'> This is where you place customized versions of JSPsÄîsee 6. JSPUI Configuration and Customization </td>
</tr>
<tr>
<td class='confluenceTd'> <em>[dspace-source]/dspace/modules/xmlui/src/main/webapp</em> </td>
<td class='confluenceTd'> This is where you place customizations for the Manakin interfaceÄîsee 7. Manakin [XMLUI] Configuration and Customization </td>
</tr>
<tr>
<td class='confluenceTd'> <em>[dspace-source/dspace/modules/jspui/src/main/resources</em> </td>
<td class='confluenceTd'> This is where you can place you customize version of the <em>Messages.properties</em> file. </td>
</tr>
<tr>
<td class='confluenceTd'> <em>[dspace-source]/dspace-jspui/dspace-jspui-webapp/src/main/webapp/WEB-INF/dspace-tags.tld</em> </td>
<td class='confluenceTd'> Custom DSpace JSP tag descriptor </td>
</tr>
</tbody></table>
</div>
<p>.</p>
<p>.</p>
<h3><a name="Application-TheBuildProcess"></a>The Build Process</h3>
<p>The DSpace build process constructs a Web application archive, which is placed in <em>[dspace-source]/build/dspace.war</em>. The <em>build_wars</em> Ant target does the work. The process works as follows:</p>
<ul>
<li>All the DSpace source code is compiled.</li>
<li><em>[dspace-source]/etc/dspace-web.xml</em> is copied to <em>[dspace-source]/build</em> and the <em>@@dspace.dir@@</em> token inside it replaced with the DSpace installation directory (<em>dspace.dir</em> property from <em>dspace.cfg</em></li>
<li>The JSPs are all copied to <em>[dspace-source]/build/jsp</em></li>
<li>Customized JSPs from <em>[dspace-source]/jsp/local</em> are copied on top of these, thus 'overriding' the default versions</li>
<li><em>[dspace-source]/build/dspace.war</em> is built<br/>
The contents of <em>dspace.war</em> are:</li>
</ul>
<ul>
<li>(Top level) &#8211; the JSPs (customized versions from <em>[dspace-source]/jsp/local</em> will have overwritten the defaults from the DSpace source distribution)</li>
<li><em>WEB-INF/classes</em> &#8211; the compiled DSpace classes</li>
<li><em>WEB-INF/lib</em> &#8211; the third party library JAR files from <em>[dspace-source]/lib</em>, minus <em>servlet.jar</em> which will be available as part of Tomcat (or other servlet engine)</li>
<li><em>WEB-INF/web.xml</em> &#8211; web deployment descriptor, copied from <em>[dspace-source]/build/dspace-web.xml</em></li>
<li><em>WEB-INF/dspace-tags.tld</em> &#8211; tag descriptor<br/>
Note that this does mean there are multiple copies of the compiled DSpace code and third-party libraries in the system, so care must be taken to ensure that they are all in sync. (The storage overhead is a few megabytes, totally insignificant these days.) In general, when you change any DSpace code or JSP, it's best to do a complete update of both the installation (<em>[dspace]</em>), and to rebuild and redeploy the Web UI and OAI <em>.war</em> files, by running this in <em>[dspace-source]</em>:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">ant -D [dspace]/config/dspace.cfg update
</pre>
</div></div>
<p>and then following the instructions that command writes to the console.</p></li>
</ul>
<h3><a name="Application-ServletsandJSPs"></a>Servlets and JSPs</h3>
<p>The Web UI is loosely based around the MVC (model, view, controller) model. The content management API corresponds to the model, the Java Servlets are the controllers, and the JSPs are the views. Interactions take the following basic form:</p>
<ol>
<li>An HTTP request is received from a browser</li>
<li>The appropriate servlet is invoked, and processes the request by invoking the DSpace business logic layer public API</li>
<li>Depending on the outcome of the processing, the servlet invokes the appropriate JSP</li>
<li>The JSP is processed and sent to the browser<br/>
The reasons for this approach are:</li>
</ol>
<ul>
<li>All of the processing is done before the JSP is invoked, so any error or problem that occurs does not occur halfway through HTML rendering</li>
<li>The JSPs contain as little code as possible, so they can be customized without having to delve into Java code too much<br/>
The <em>org.dspace.app.webui.servlet.LoadDSpaceConfig</em> servlet is always loaded first. This is a very simple servlet that checks the <em>dspace-config</em> context parameter from the DSpace deployment descriptor, and uses it to locate <em>dspace.cfg</em>. It also loads up the Log4j configuration. It's important that this servlet is loaded first, since if another servlet is loaded up, it will cause the system to try and load DSpace and Log4j configurations, neither of which would be found.</li>
</ul>
<p>All DSpace servlets are subclasses of the <em>DSpaceServlet</em> class. The <em>DSpaceServlet</em> class handles some basic operations such as creating a DSpace <em>Context</em> object (opening a database connection etc.), authentication and error handling. Instead of overriding the <em>doGet</em> and <em>doPost</em> methods as one normally would for a servlet, DSpace servlets implement <em>doDSGet</em> or <em>doDSPost</em> which have an extra context parameter, and allow the servlet to throw various exceptions that can be handled in a standard way.</p>
<p>The DSpace servlet processes the contents of the HTTP request. This might involve retrieving the results of a search with a query term, accessing the current user's eperson record, or updating a submission in progress. According to the results of this processing, the servlet must decide which JSP should be displayed. The servlet then fills out the appropriate attributes in the <em>HttpRequest</em> object that represents the HTTP request being processed. This is done by invoking the <em>setAttribute</em> method of the <em>javax.servlet.http.HttpServletRequest</em> object that is passed into the servlet from Tomcat. The servlet then forwards control of the request to the appropriate JSP using the <em>JSPManager.showJSP</em> method.</p>
<p>The <em>JSPManager.showJSP</em> method uses the standard Java servlet forwarding mechanism is then used to forward the HTTP request to the JSP. The JSP is processed by Tomcat and the results sent back to the user's browser.</p>
<p>There is an exception to this servlet/JSP style: <em>index.jsp</em>, the 'home page', receives the HTTP request directly from Tomcat without a servlet being invoked first. This is because in the servlet 2.3 specification, there is no way to map a servlet to handle only requests made to '<em>/</em>'; such a mapping results in every request being directed to that servlet. By default, Tomcat forwards requests to '<em>/</em>' to <em>index.jsp</em>. To try and make things as clean as possible, <em>index.jsp</em> contains some simple code that would normally go in a servlet, and then forwards to <em>home.jsp</em> using the <em>JSPManager.showJSP</em> method. This means localized versions of the 'home page' can be created by placing a customized <em>home.jsp</em> in <em>[dspace-source]/jsp/local</em>, in the same manner as other JSPs.</p>
<p><em>[dspace-source]/jsp/dspace-admin/index.jsp</em>, the administration UI index page, is invoked directly by Tomcat and not through a servlet for similar reasons.</p>
<p>At the top of each JSP file, right after the license and copyright header, is documented the appropriate attributes that a servlet must fill out prior to forwarding to that JSP. No validation is performed; if the servlet does not fill out the necessary attributes, it is likely that an internal server error will occur.</p>
<p>Many JSPs containing forms will include hidden parameters that tell the servlets which form has been filled out. The submission UI servlet (<em>SubmissionController</em> is a prime example of a servlet that deals with the input from many different JSPs. The <em>step</em> and <em>page</em> hidden parameters (written out by the <em>SubmissionController.getSubmissionParameters()</em> method) are used to inform the servlet which page of which step has just been filled out (i.e. which page of the submission the user has just completed).</p>
<p>Below is a detailed, scary diagram depicting the flow of control during the whole process of processing and responding to an HTTP request. More information about the authentication mechanism is mostly described in the configuration section.</p>
<p><span class="image-wrap" style=""><img src="attachments/22022819/21954860.gif" style="border: 0px solid black"/></span></p>
<p>Flow of Control During HTTP Request Processing</p>
<h3><a name="Application-CustomJSPTags"></a>Custom JSP Tags</h3>
<p>The DSpace JSPs all use some custom tags defined in <em>/dspace/jsp/WEB-INF/dspace-tags.tld</em>, and the corresponding Java classes reside in <em>org.dspace.app.webui.jsptag</em>. The tags are listed below. The <em>dspace-tags.tld</em> file contains detailed comments about how to use the tags, so that information is not repeated here.</p>
<ul>
<li><b><em>layout</em></b>: Just about every JSP uses this tag. It produces the standard HTML header and <em>&lt;BODY&gt;_tag. Thus the content of each JSP is nested inside a &#95;&lt;dspace:layout&gt;</em> tag. The (XML-style)attributes of this tag are slightly complicated--see <em>dspace-tags.tld</em>. The JSPs in the source code bundle also provide plenty of examples.</li>
<li><b><em>sidebar</em></b>: Can only be used inside a <em>layout</em> tag, and can only be used once per JSP. The content between the start and end <em>sidebar</em> tags is rendered in a column on the right-hand side of the HTML page. The contents can contain further JSP tags and Java 'scriptlets'.</li>
<li><b><em>date</em></b>: Displays the date represented by an <em>org.dspace.content.DCDate</em> object. Just the one representation of date is rendered currently, but this could use the user's browser preferences to display a localized date in the future.</li>
<li><b><em>include</em></b>: Obsolete, simple tag, similar to <em>jsp:include</em>. In versions prior to DSpace 1.2, this tag would use the locally modified version of a JSP if one was installed in jsp/local. As of 1.2, the build process now performs this function, however this tag is left in for backwards compatibility.</li>
<li><b><em>item</em></b>: Displays an item record, including Dublin Core metadata and links to the bitstreams within it. Note that the displaying of the bitstream links is simplistic, and does not take into account any of the bundling structure. This is because DSpace does not have a fully-fledged dissemination architectural piece yet.Displaying an item record is done by a tag rather than a JSP for two reasons: Firstly, it happens in several places (when verifying an item record during submission or workflow review, as well as during standard item accesses), and secondly, displaying the item turns out to be mostly code-work rather than HTML anyway. Of course, the disadvantage of doing it this way is that it is slightly harder to customize exactly what is displayed from an item record; it is necessary to edit the tag code (<em>org.dspace.app.webui.jsptag.ItemTag</em>). Hopefully a better solution can be found in the future.</li>
<li><b><em>itemlist</em></b><b>,</b> <b><em>collectionlist</em></b><b>,</b> <b><em>communitylist</em></b>: These tags display ordered sequences of items, collections and communities, showing minimal information but including a link to the page containing full details. These need to be used in HTML tables.</li>
<li><b><em>popup</em></b>: This tag is used to render a link to a pop-up page (typically a help page.) If Javascript is available, the link will either open or pop to the front any existing DSpace pop-up window. If Javascript is not available, a standard HTML link is displayed that renders the link destination in a window named '<em>dspace.popup</em>'. In graphical browsers, this usually opens a new window or re-uses an existing window of that name, but if a window is re-used it is not 'raised' which might confuse the user. In text browsers, following this link will simply replace the current page with the destination of the link. This obviously means that Javascript offers the best functionality, but other browsers are still supported.</li>
<li><b><em>selecteperson</em></b>: A tag which produces a widget analogous to HTML <em>&lt;SELECT&gt;</em>, that allows a user to select one or multiple e-people from a pop-up list.</li>
<li><b><em>sfxlink</em></b>: Using an item's Dublin Core metadata DSpace can display an SFX link, if an SFX server is available. This tag does so for a particular item if the <em>sfx.server.url</em> property is defined in <em>dspace.cfg</em>.</li>
</ul>
<h3><a name="Application-Internationalization"></a>Internationalization</h3>
<p>The <a href="http://jakarta.apache.org/taglibs/doc/standard-1.0-doc/intro.html" title="Java Standard Tag Library v1.0">Java Standard Tag Library v1.0</a> is used to specify messages in the JSPs like this:</p>
<p>OLD:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">&lt;H1&gt;Search Results&lt;/H1&gt;</pre>
</div></div>
<p>NEW:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">&lt;H1&gt;&lt;fmt:message key=<span class="code-quote">"jsp.search.results.title"</span>/&gt;&lt;/H1&gt;</pre>
</div></div>
<p>This message can now be changed using the <em>config/language-packs/Messages.properties</em> file. (This must be done at build-time: <em>Messages.properties</em> is placed in the <em>dspace.war</em> Web application file.)</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">jsp.search.results.title = Search Results</pre>
</div></div>
<p>Phrases may have parameters to be passed in, to make the job of translating easier, reduce the number of 'keys' and to allow translators to make the translated text flow more appropriately for the target language.</p>
<p>OLD:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">&lt;P&gt;Results &lt;%= r.getFirst() %&gt; to &lt;%= r.getLast() %&gt; of &lt;%=r.getTotal() %&gt;&lt;/P&gt;</pre>
</div></div>
<p>NEW:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">&lt;fmt:message key=<span class="code-quote">"jsp.search.results.text"</span>&gt;
&lt;fmt:param&gt;&lt;%= r.getFirst() %&gt;&lt;/fmt:param&gt;
&lt;fmt:param&gt;&lt;%= r.getLast() %&gt;&lt;/fmt:param&gt;
&lt;fmt:param&gt;&lt;%= r.getTotal() %&gt;&lt;/fmt:param&gt;
&lt;/fmt:message&gt;</pre>
</div></div>
<p>(Note: JSTL 1.0 does not seem to allow JSP &lt;%= %&gt; expressions to be passed in as values of attribute in &lt;fmt:param value=""/&gt;)</p>
<p>The above would appear in the <em>Messages_xx.properties</em> file as:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">jsp.search.results.text = Results {0}-{1} of {2} </pre>
</div></div>
<p>Introducing number parameters that should be formatted according to the locale used makes no difference in the message key compared to atring parameters:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">jsp.submit.show-uploaded-file.size-in-bytes = {0} bytes</pre>
</div></div>
<p>In the JSP using this key can be used in the way belov:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">&lt;fmt:message key=<span class="code-quote">"jsp.submit.show-uploaded-file.size-in-bytes"</span>&gt;
&lt;fmt:param&gt;&lt;fmt:formatNumber&gt;&lt;%= bitstream.getSize()%&gt;&lt;/fmt:formatNumber&gt;&lt;/fmt:param&gt;
&lt;/fmt:message&gt;
</pre>
</div></div>
<p>(Note: JSTL offers a way to include numbers in the message keys as <em>jsp.foo.key = {0,number} bytes</em>. Setting the parameter as <em>&lt;fmt:param value="${variable}" /&gt;</em> workes when <em>variable</em> is a single variable name and doesn't work when trying to use a method's return value instead: <em>bitstream.getSize()</em>. Passing the number as string (or using the &lt;%= %&gt; expression) also does not work.)</p>
<p>Multiple <em>Messages.properties</em> can be created for different languages. See <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/util/ResourceBundle.html#getBundle(java.lang.String,%20java.util.Locale,%20java.lang.ClassLoader)" title="ResourceBundle.getBundle">ResourceBundle.getBundle</a>. e.g. you can add German and Canadian French translations:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">Messages_de.properties
Messages_fr_CA.properties</pre>
</div></div>
<p>The end user's browser settings determine which language is used. The English language file <em>Messages.properties</em> (or the default server locale) will be used as a default if there's no language bundle for the end user's preferred language. (Note that the English file is not called <em>Messages_en.properties</em> &#8211; this is so it is always available as a default, regardless of server configuration.)</p>
<p>The <em>dspace:layout</em> tag has been updated to allow dictionary keys to be passed in for the titles. It now has two new parameters: <em>titlekey</em> and <em>parenttitlekey</em>. So where before you'd do:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">&lt;dspace:layout title=<span class="code-quote">"Here"</span>
parentlink=<span class="code-quote">"/mydspace"</span>
parenttitle=<span class="code-quote">"My DSpace"</span>&gt;
</pre>
</div></div>
<p>You now do:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">&lt;dspace:layout titlekey=<span class="code-quote">"jsp.page.title"</span>
parentlink=<span class="code-quote">"/mydspace"</span>
parenttitlekey=<span class="code-quote">"jsp.mydspace"</span>&gt;
</pre>
</div></div>
<p>And so the layout tag itself gets the relevant stuff out of the dictionary. <em>title</em> and <em>parenttitle</em> still work as before for backwards compatibility, and the odd spot where that's preferable.</p>
<h4><a name="Application-MessageKeyConvention"></a>Message Key Convention</h4>
<p>When translating further pages, please follow the convention for naming message keys to avoid clashes.</p>
<p><b>For text in JSPs</b> use the complete path + filename of the JSP, then a one-word name for the message. e.g. for the title of <em>jsp/mydspace/main.jsp</em> use:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">jsp.mydspace.main.title</pre>
</div></div>
<p>Some common words (e.g. "Help") can be brought out into keys starting <em>jsp.</em> for ease of translation, e.g.:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">jsp.admin = Administer</pre>
</div></div>
<p>Other common words/phrases are brought out into 'general' parameters if they relate to a set (directory) of JSPs, e.g.</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">jsp.tools.general.delete = Delete</pre>
</div></div>
<p>Phrases that relate <b>strongly</b> to a topic (eg. MyDSpace) but used in many JSPs outside the particular directory are more convenient to be cross-referenced. For example one could use the key below in <em>jsp/submit/saved.jsp</em> to provide a link back to the user's <em>MyDSpace</em>:</p>
<p><em>(Cross-referencing of keys</em> <b><em>in general</em></b> <em>is not a good idea as it may make maintenance more difficult. But in some cases it has more advantages as the meaning is obvious.)</em></p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">jsp.mydspace.general.<span class="code-keyword">goto</span>-mydspace = Go to My DSpace</pre>
</div></div>
<p><b>For text in servlet code</b>, in custom JSP tags or wherever applicable use the fully qualified classname + a one-word name for the message. e.g.</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">org.dspace.app.webui.jsptag.ItemListTag.title = Title</pre>
</div></div>
<h4><a name="Application-WhichLanguagesarecurrentlysupported%3F"></a>Which Languages are currently supported?</h4>
<p>To view translations currently being developed, please refer to the <a href="http://wiki.dspace.org/I18nSupport" title="i18n page">i18n page</a> of the DSpace Wiki.</p>
<h3><a name="Application-HTMLContentinItems"></a>HTML Content in Items</h3>
<p>For the most part, the DSpace item display just gives a link that allows an end-user to download a bitstream. However, if a bundle has a primary bitstream whose format is of MIME type <em>text/html</em>, instead a link to the HTML servlet is given.</p>
<p>So if we had an HTML document like this:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">contents.html
chapter1.html
chapter2.html
chapter3.html
figure1.gif
figure2.jpg
figure3.gif
figure4.jpg
figure5.gif
figure6.gif</pre>
</div></div>
<p>The Bundle's primary bitstream field would point to the contents.html Bitstream, which we know is HTML (check the format MIME type) and so we know which to serve up first.</p>
<p>The HTML servlet employs a trick to serve up HTML documents without actually modifying the HTML or other files themselves. Say someone is looking at <em>contents.html</em> from the above example, the URL in their browser will look like this:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">https:<span class="code-comment">//dspace.mit.edu/html/1721.1/12345/contents.html</span></pre>
</div></div>
<p>If there's an image called <em>figure1.gif</em> in that HTML page, the browser will do HTTP GET on this URL:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">https:<span class="code-comment">//dspace.mit.edu/html/1721.1/12345/figure1.gif</span></pre>
</div></div>
<p>The HTML document servlet can work out which item the user is looking at, and then which Bitstream in it is called <em>figure1.gif</em>, and serve up that bitstream. Similar for following links to other HTML pages. Of course all the links and image references have to be relative and not absolute.</p>
<p>HTML documents must be "self-contained", as explained here. Provided that full path information is known by DSpace, any depth or complexity of HTML document can be served subject to those contraints. This is usually possible with some kind of batch import. If, however, the document has been uploaded one file at a time using the Web UI, the path information has been stripped. The system can cope with relative links that refer to a deeper path, e.g.</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">&lt;IMG SRC=<span class="code-quote">"images/figure1.gif"</span>&gt;</pre>
</div></div>
<p>If the item has been uploaded via the Web submit UI, in the Bitstream table in the database we have the 'name' field, which will contain the filename with no path (<em>figure1.gif</em>). We can still work out what <em>images/figure1.gif</em> is by making the HTML document servlet strip any path that comes in from the URL, e.g.</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">https:<span class="code-comment">//dspace.mit.edu/html/1721.1/12345/images/figure1.gif
</span> ^^^^^^^
Strip <span class="code-keyword">this</span></pre>
</div></div>
<p>BUT all the filenames (regardless of directory names) must be unique. For example, this wouldn't work:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">contents.html
chapter1.html
chapter2.html
chapter1_images/figure.gif
chapter2_images/figure.gif</pre>
</div></div>
<p>since the HTML document servlet wouldn't know which bitstream to serve up for:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">https:<span class="code-comment">//dspace.mit.edu/html/1721.1/12345/chapter1_images/figure.gif
</span>https:<span class="code-comment">//dspace.mit.edu/html/1721.1/12345/chapter2_images/figure.gif</span></pre>
</div></div>
<p>since it would just have <em>figure.gif</em></p>
<p>To prevent "infinite URL spaces" appearing (e.g. if a file <em>foo.html</em> linked to <em>bar/foo.html</em>, which would link to <em>bar/bar/foo.html</em>...) this behavior can be configured by setting the configuration property <em>webui.html.max-depth-guess</em>.</p>
<p>For example, if we receive a request for <em>foo/bar/index.html</em>, and we have a bitstream called just <em>index.html</em>, we will serve up that bitstream for the request if <em>webui.html.max-depth-guess</em> is 2 or greater. If <em>webui.html.max-depth-guess</em> is 1 or less, we would not serve that bitstream, as the depth of the file is greater. If <em>webui.html.max-depth-guess</em> is zero, the request filename and path must always exactly match the bitstream name. The default value (if that property is not present in <em>dspace.cfg</em>) is 3.</p>
<h3><a name="Application-ThesisBlocking"></a>Thesis Blocking</h3>
<p>The submission UI has an optional feature that came about as a result of MIT Libraries policy. If the <em>block.theses</em> parameter in <em>dspace.cfg</em> is <em>true</em>, an extra checkbox is included in the first page of the submission UI. This asks the user if the submission is a thesis. If the user checks this box, the submission is halted (deleted) and an error message displayed, explaining that DSpace should not be used to submit theses. This feature can be turned off and on, and the message displayed (<em>/dspace/jsp/submit/no-theses.jsp</em> can be localized as necessary.</p>
<h2><a name="Application-OAIPMHDataProvider"></a>OAI-PMH Data Provider</h2>
<p>The DSpace platform supports the <a href="http://www.openarchives.org/" title="Open Archives Initiative Protocol for Metadata Harvesting">Open Archives Initiative Protocol for Metadata Harvesting</a> (OAI-PMH) version 2.0 as a data provider. This is accomplished using the <a href="http://www.oclc.org/research/software/oai/cat.shtm" title="OAICat framework from OCLC">OAICat framework from OCLC</a>.</p>
<p>The DSpace build process builds a Web application archive, <em>[dspace-source]/build/oai.war</em>), in much the same way as the Web UI build process described above. The only differences are that the JSPs are not included, and <em>[dspace-source]/etc/oai-web.xml</em> is used as the deployment descriptor. This 'webapp' is deployed to receive and respond to OAI-PMH requests via HTTP. Note that typically it should <em>not</em> be deployed on SSL (<em>https:</em> protocol). In a typical configuration, this is deployed at <em>oai</em>, for example:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">http:<span class="code-comment">//dspace.myu.edu/oai/request?verb=Identify</span>
</pre>
</div></div>
<p>The 'base URL' of this DSpace deployment would be:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">http:<span class="code-comment">//dspace.myu.edu/oai/request</span>
</pre>
</div></div>
<p>It is this URL that should be registered with <a href="http://www.openarchives.org/" title="www.openarchives.org">www.openarchives.org</a>. Note that you can easily change the '<em>request</em>' portion of the URL by editing <em>[dspace-source]/etc/oai-web.xml</em> and rebuilding and deploying <em>oai.war</em>.</p>
<p>DSpace provides implementations of the OAICat interfaces <em>AbstractCatalog</em>, <em>RecordFactory</em> and <em>Crosswalk</em> that interface with the DSpace content management API and harvesting API (in the search subsystem).</p>
<p>Only the basic <em>oai_dc</em> unqualified Dublin Core metadata set export is enabled by default; this is particularly easy since all items have qualified Dublin Core metadata. When this metadata is harvested, the qualifiers are simply stripped; for example, <em>description.abstract</em> is exposed as unqualified <em>description</em>. The <em>description.provenance</em> field is hidden, as this contains private information about the submitter and workflow reviewers of the item, including their e-mail addresses. Additionally, to keep in line with OAI community practices, values of <em>contributor.author</em> are exposed as <em>creator</em> values.</p>
<p>Other metadata formats are supported as well, using other <em>Crosswalk</em> implementations; consult the <em>oaicat.properties</em> file described below. To enable a format, simply uncomment the lines beginning with <em>Crosswalks.&#42;</em>. Multiple formats are allowed, and the current list includes, in addition to unqualified DC: MPEG DIDL, METS, MODS. There is also an incomplete, experimental qualified DC.</p>
<p>Note that the current simple DC implementation (<em>org.dspace.app.oai.OAIDCCrosswalk</em>) does not currently strip out any invalid XML characters that may be lying around in the data. If your database contains a DC value with, for example, some ASCII control codes (form feed etc.) this may cause OAI harvesters problems. This should rarely occur, however. XML entities (such as <em>&gt;</em>) are encoded (e.g. to <em>&gt;</em>)</p>
<p>In addition to the implementations of the OAICat interfaces, there are two configuration files relevant to OAI support:</p>
<ul>
<li><b><em>oaicat.properties</em></b>: This resides as a template in <em>[dspace]/config/templates</em>, and the live version is written to <em>[dspace]/config</em>. You probably won't need to edit this; the <em>install-configs</em> script fills out the relevant deployment-specific parameters. You might want to change the <em>earliestDatestamp</em> field to accurately reflect the oldest datestamp in the system. (Note that this is the value of the <em>last_modified</em> column in the <em>Item</em> database table.)</li>
<li><b><em>oai-web.xml</em></b>: This standard Java Servlet 'deployment descriptor' is stored in the source as <em>[dspace-source]/etc/oai-web.xml</em>, and is written to <em>/dspace/oai/WEB-INF/web.xml</em>.
<h3><a name="Application-Sets"></a>Sets</h3></li>
</ul>
<p>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.</p>
<p>DSpace exposes collections as sets. The organization of communities is likely to change over time, and is therefore a less stable basis for selective harvesting.</p>
<p>Each collection has a corresponding OAI set, discoverable by harvesters via the ListSets verb. The setSpec is the Handle of the collection, with the ':' and '/' converted to underscores so that the Handle is a legal setSpec, for example:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">hdl_1721.1_1234
</pre>
</div></div>
<p>Naturally enough, the collection name is also the name of the corresponding set.</p>
<h3><a name="Application-UniqueIdentifier"></a>Unique Identifier</h3>
<p>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 <em>metadata record</em> associated with the <em>resource</em>. The <em>resource</em> is the DSpace item, whose <em>resource identifier</em> 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.</p>
<p>The OAI identifiers that DSpace uses are of the form:</p>
<p><em>oai:host name:handle</em></p>
<p>For example:</p>
<p><em>oai:dspace.myu.edu:123456789/345</em></p>
<p>If you wish to use a different scheme, this can easily be changed by editing the value of <em>OAI_ID_PREFIX</em> at the top of the <em>org.dspace.app.oai.DSpaceOAICatalog</em> class. (You do not need to change the code if the above scheme works for you; the code picks up the host name and Handles automatically from the DSpace configuration.)</p>
<h3><a name="Application-Accesscontrol"></a>Access control</h3>
<p>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.</p>
<p>A question is, "is all metadata public?" Presently the answer to this is yes; all metadata is exposed via OAI-PMH, 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.</p>
<p>If in the future, this 'expose all metadata' approach proves unsatisfactory for any reason, it should be possible to expose only publicly readable metadata. The authorisation system has separate permissions for READing and item and READing the content (bitstreams) within it. This means the system can differentiate between an item with public metadata and hidden content, and an item with hidden metadata as well as hidden content. In this case the OAI data repository should only expose items those with anonymous READ access, so it can hide the existence of records to the outside world completely. In this scenario, one should be wary of protected items that are made public after a time. When this happens, the items are "new" from the OAI-PMH perspective.</p>
<h3><a name="Application-ModificationDate%28OAIDateStamp%29"></a>Modification Date (OAI Date Stamp)</h3>
<p>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.</p>
<h3><a name="Application-%27About%27Information"></a>'About' Information</h3>
<p>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.</p>
<h3><a name="Application-Deletions"></a>Deletions</h3>
<p>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.</p>
<p>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 <em>not</em> find the record, despite the fact that the record did exist at that time.</p>
<p>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.</p>
<p>Note that presently, the deletion of 'expunged' items is not exposed through OAI.</p>
<h3><a name="Application-FlowControl%28ResumptionTokens%29"></a>Flow Control (Resumption Tokens)</h3>
<p>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.</p>
<p>DSpace supports resumption tokens for 'ListRecords' OAI-PMH requests. ListIdentifiers and ListSets requests do not produce a particularly high load on the system, so resumption tokens are not used for those requests.</p>
<p>Each OAI-PMH ListRecords request will return at most 100 records. This limit is set at the top of <em>org.dspace.app.oai.DSpaceOAICatalog.java</em> (<em>MAX_RECORDS</em>). A potential issue here is that if a harvest yields an exact multiple of <em>MAX_RECORDS</em>, the last operation will result in a harvest with no records in it. It is unclear from the OAI-PMH specification if this is acceptable.</p>
<p>When a resumption token is issued, the optional <em>completeListSize</em> and <em>cursor</em> attributes are not included. OAICat sets the <em>expirationDate</em> of the resumption token to one hour after it was issued, though in fact since DSpace resumption tokens contain all the information required to continue a request they do not actually expire.</p>
<p>Resumption tokens contain all the state information required to continue a request. The format is:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">from/until/setSpec/offset
</pre>
</div></div>
<p><em>from</em> and <em>until</em> are the ISO 8601 dates passed in as part of the original request, and <em>setSpec</em> is also taken from the original request. <em>offset</em> is the number of records that have already been sent to the harvester. For example:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">2003-01-01<span class="code-comment">//hdl_1721_1_1234/300</span>
</pre>
</div></div>
<p>This means the harvest is 'from'<br/>
<em>2003-01-01</em>, has no 'until' date, is for collection hdl:1721.1/1234, and 300 records have already been sent to the harvester. (Actually, if the original OAI-PMH request doesn't specify a 'from' or 'until, OAICat fills them out automatically to '0000-00-00T00:00:00Z' and '9999-12-31T23:59:59Z' respectively. This means DSpace resumption tokens will always have from and until dates in them.)</p>
<h2><a name="Application-DSpaceCommandLauncher"></a>DSpace Command Launcher</h2>
<p>Introduced in Release 1.6, the DSpace Command Launcher brings together the various command and scripts into a standard-practice for running CLI runtime programs.</p>
<h3><a name="Application-OlderVersions"></a>Older Versions</h3>
<p>Prior to Release 1.6, there were various scripts written that masked a more manual approach to running CLI programs. The user had to issue <em>[dspace]/bin/dsrun</em> and then java class that ran that program. With release 1.5, scripts were written to mask the <em>[dspace]/bin/dsrun</em> command. We have left the java class in the System Administration section since it does have value for debugging purposes and for those who wish to learn about DSpace<br/>
programming or wish to customize the code at any time.</p>
<h3><a name="Application-CommandLauncherStructure"></a>Command Launcher Structure</h3>
<p>There are two components to the command launcher: the dspace script and the launcher.xml. The DSpace command calls a java class which in turn refers to <em>launcher.xml</em> that is stored in the <em>[dspace]/config</em> directory</p>
<p><em>launcher.xml</em> is made of several components:</p>
<ul>
<li><em>&lt;command&gt;</em> begins the stanza for a comand</li>
<li><em>&lt;name&gt;</em>_<em>name of command</em>_<em>&lt;/name&gt;</em> the name of the command that you would use.</li>
<li><em>&lt;description&gt;</em>_<em>the description of the command</em>_<em>&lt;/description&gt;</em></li>
<li><em>&lt;step&gt; &lt;/step&gt;</em> User arguments are parsed and tested.</li>
<li><em>&lt;class&gt;</em>_<em>&lt;the java class that is being used to run the CLI program&gt;</em>_<em>&lt;/class&gt;</em><br/>
Prior to release 1.5 if one wanted to regenerate the browse index, one would have to issue the following commands manually:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">[dspace]/bin/dsrun org.dspace.browse.IndexBrowse -f -r
[dspace]/bin/dsrun org.dspace.browse.ItemCounter
[dspace]/bin/dsrun org.dspace.search.DSIndexer</pre>
</div></div>
<p>In release 1.5 a script was written and in release 1.6 the command <em>[dspace]/bin/dspace index-init</em> replaces the script. The stanza from <em>launcher.xml</em> show us how one can build more commands if needed:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">&lt;command&gt;
&lt;name&gt;index-update&lt;/name&gt;
&lt;description&gt;Update the search and browse indexes&lt;/description&gt;
&lt;step passuserargs=<span class="code-quote">"<span class="code-keyword">false</span>"</span>&gt;
&lt;class&gt;org.dspace.browse.IndexBrowse&lt;/class&gt;
&lt;argument&gt;-i&lt;/argument&gt;
&lt;/step&gt;
&lt;step passuserargs=<span class="code-quote">"<span class="code-keyword">false</span>"</span>&gt;
&lt;class&gt;org.dspace.browse.ItemCounter&lt;/class&gt;
&lt;/step&gt;
&lt;step passuserargs=<span class="code-quote">"<span class="code-keyword">false</span>"</span>&gt;
&lt;class&gt;org.dspace.search.DSIndexer&lt;/class&gt;
&lt;/step&gt;
&lt;/command&gt;</pre>
</div></div>
<p>.</p></li>
</ul>
<br/>
<div class="tabletitle">
<a name="attachments">Attachments:</a>
</div>
<div class="greybox" align="left">
<img src="images/icons/bullet_blue.gif" height="8" width="8" alt=""/>
<a href="attachments/22022819/21954860.gif">web-ui-flow.gif</a> (image/gif)
<br/>
</div>
</td>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td height="12" background="https://wiki.duraspace.org/images/border/border_bottom.gif"><img src="images/border/spacer.gif" width="1" height="1" border="0"/></td>
</tr>
<tr>
<td align="center"><font color="grey">Document generated by Confluence on Nov 06, 2010 19:27</font></td>
</tr>
</table>
</body>
</html>

View File

@@ -0,0 +1,135 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>DSpace Documentation : Architecture</title>
<link rel="stylesheet" href="styles/site.css" type="text/css" />
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
<table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
<tr>
<td valign="top" class="pagebody">
<div class="pageheader">
<span class="pagetitle">
DSpace Documentation : Architecture
</span>
</div>
<div class="pagesubheading">
This page last changed on Nov 06, 2010 by <font color="#0050B2">jtrimble</font>.
</div>
<h1><a name="Architecture-DSpaceSystemDocumentation%3AArchitecture"></a>DSpace System Documentation: Architecture</h1>
<h2><a name="Architecture-Overview"></a>Overview</h2>
<p>The DSpace system is organized into three layers, each of which consists of a number of components.</p>
<p><span class="image-wrap" style=""><img src="attachments/22022821/21954861.gif" style="border: 0px solid black"/></span></p>
<p>DSpace System Architecture</p>
<p>The storage layer is responsible for physical storage of metadata and content. The business logic layer deals with managing the content of the archive, users of the archive (e-people), authorization, and workflow. The application layer contains components that communicate with the world outside of the individual DSpace installation, for example the Web user interface and the <a href="http://www.openarchives.org/" title="Open Archives Initiative">Open Archives Initiative</a> protocol for metadata harvesting service.</p>
<p>Each layer only invokes the layer below it; the application layer may not used the storage layer directly, for example. Each component in the storage and business logic layers has a defined public API. The union of the APIs of those components are referred to as the Storage API (in the case of the storage layer) and the DSpace Public API (in the case of the business logic layer). These APIs are in-process Java classes, objects and methods.</p>
<p>It is important to note that each layer is <em>trusted</em>. Although the logic for <em>authorising actions</em> is in the business logic layer, the system relies on individual applications in the application layer to correctly and securely <em>authenticate</em> e-people. If a 'hostile' or insecure application were allowed to invoke the Public API directly, it could very easily perform actions as any e-person in the system.</p>
<p>The reason for this design choice is that authentication methods will vary widely between different applications, so it makes sense to leave the logic and responsibility for that in these applications.</p>
<p>The source code is organized to cohere very strictly to this three-layer architecture. Also, only methods in a component's public API are given the <em>public</em> access level. This means that the Java compiler helps ensure that the source code conforms to the architecture.</p>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'> <b>Packages within</b> </td>
<td class='confluenceTd'> <b>Correspond to components in</b> </td>
</tr>
<tr>
<td class='confluenceTd'> <em>org.dspace.app</em> </td>
<td class='confluenceTd'> Application layer </td>
</tr>
<tr>
<td class='confluenceTd'> <em>org.dspace</em> </td>
<td class='confluenceTd'> Business logic layer (except <em>storage</em> and <em>app</em>) </td>
</tr>
<tr>
<td class='confluenceTd'> <em>org.dspace.storage</em> </td>
<td class='confluenceTd'> Storage layer </td>
</tr>
</tbody></table>
</div>
<p>The storage and business logic layer APIs are extensively documented with Javadoc-style comments. Generate the HTML version of these by entering the [dspace-source]/dspace directory and running:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">mvn javadoc:javadoc
</pre>
</div></div>
<p>The resulting documentation will be at <em>[dspace-source]dspace-api/target/site/apidocs/index.html</em>. The package-level documentation of each package usually contains an overview of the package and some example usage. This information is not repeated in this architecture document; this and the Javadoc APIs are intended to be used in parallel.</p>
<p>Each layer is described in a separate section:</p>
<ul>
<li>Storage Layer
<ul>
<li>RDBMS</li>
<li>Bitstream Store</li>
</ul>
</li>
<li>Business Logic Layer
<ul>
<li>Core Classes</li>
<li>Content Management API</li>
<li>Workflow System</li>
<li>Administration Toolkit</li>
<li>E-person/Group Manager</li>
<li>Authorisation</li>
<li>Handle Manager/Handle Plugin</li>
<li>Search</li>
<li>Browse API</li>
<li>History Recorder</li>
<li>Checksum Checker</li>
</ul>
</li>
<li>Application Layer
<ul>
<li>Web User Interface</li>
<li>OAI-PMH Data Provider</li>
<li>Item Importer and Exporter</li>
<li>Transferring Items Between DSpace Instances</li>
<li>Registration</li>
<li>METS Tools</li>
<li>Media Filters</li>
<li>Sub-Community Management<br/>
2002-2008 The DSpace Foundation </li>
</ul>
</li>
</ul>
<br/>
<div class="tabletitle">
<a name="attachments">Attachments:</a>
</div>
<div class="greybox" align="left">
<img src="images/icons/bullet_blue.gif" height="8" width="8" alt=""/>
<a href="attachments/22022821/21954861.gif">architecture-600x450.gif</a> (image/gif)
<br/>
</div>
</td>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td height="12" background="https://wiki.duraspace.org/images/border/border_bottom.gif"><img src="images/border/spacer.gif" width="1" height="1" border="0"/></td>
</tr>
<tr>
<td align="center"><font color="grey">Document generated by Confluence on Nov 06, 2010 19:27</font></td>
</tr>
</table>
</body>
</html>

1079
dspace/docs/html/Business.html Executable file

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,404 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>DSpace Documentation : DSpace Builds</title>
<link rel="stylesheet" href="styles/site.css" type="text/css" />
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
<table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
<tr>
<td valign="top" class="pagebody">
<div class="pageheader">
<span class="pagetitle">
DSpace Documentation : DSpace Builds
</span>
</div>
<div class="pagesubheading">
This page last changed on Jan 05, 2010 by <font color="#0050B2">mdiggory</font>.
</div>
<table class="sectionMacro" border="0" cellpadding="5" cellspacing="0" width="100%"><tbody><tr>
<td class="confluenceTd" valign="top" width="50%">
<div class="panel" style="background-color: #ffffff;border-color: #6699ff;border-style: solid;border-width: 1px;"><div class="panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;border-bottom-color: #6699ff;background-color: #D5EFFF;"><b>DSpace 1.6 Downloads</b></div><div class="panelContent" style="background-color: #ffffff;">
<p>DSpace 1.6.0 Release Candiate 1:</p>
<p>
<div class="rssMacro">
<table>
<tr>
<th>
<a href="http://sourceforge.net/api/file/index/project-id/19984/rss?path=%2FDSpace%20Release%20Candidate%2F1.6.0-rc1%20%28patched%29"><img src="images/icons/rss.gif" border="0" height="15" width="27" align="right"/></a>
<a href="http://sourceforge.net/api/file/index/project-id/19984/rss?path=%2FDSpace%20Release%20Candidate%2F1.6.0-rc1%20%28patched%29">DSpace downloads</a>
<br />
<span class="smalltext">(Files from DSpace. Open Source Digital Asset Management system that enables services for access, provision, stewardship and re-use of digital assets with a focus on educational and research materials)</span>
</th>
</tr>
<tr>
<td valign="top">
<b><a href="http://sourceforge.net/projects/dspace/files%2FDSpace%20Release%20Candidate%2F1.6.0-rc1%20%28patched%29%2Fdspace-1.6.0-rc1-release.tar.bz2/download">/DSpace Release Candidate/1.6.0-rc1 (patched)/dspace-1.6.0-rc1-release.tar.bz2</a></b>
<br />
<span class="smalltext">/DSpace Release Candidate/1.6.0-rc1 (patched)/dspace-1.6.0-rc1-release.tar.bz2</span>
</td>
</tr>
<tr>
<td valign="top">
<b><a href="http://sourceforge.net/projects/dspace/files%2FDSpace%20Release%20Candidate%2F1.6.0-rc1%20%28patched%29%2Fdspace-1.6.0-rc1-release.tar.gz/download">/DSpace Release Candidate/1.6.0-rc1 (patched)/dspace-1.6.0-rc1-release.tar.gz</a></b>
<br />
<span class="smalltext">/DSpace Release Candidate/1.6.0-rc1 (patched)/dspace-1.6.0-rc1-release.tar.gz</span>
</td>
</tr>
<tr>
<td valign="top">
<b><a href="http://sourceforge.net/projects/dspace/files%2FDSpace%20Release%20Candidate%2F1.6.0-rc1%20%28patched%29%2Fdspace-1.6.0-rc1-release.zip/download">/DSpace Release Candidate/1.6.0-rc1 (patched)/dspace-1.6.0-rc1-release.zip</a></b>
<br />
<span class="smalltext">/DSpace Release Candidate/1.6.0-rc1 (patched)/dspace-1.6.0-rc1-release.zip</span>
</td>
</tr>
<tr>
<td valign="top">
<b><a href="http://sourceforge.net/projects/dspace/files%2FDSpace%20Release%20Candidate%2F1.6.0-rc1%20%28patched%29%2Fdspace-1.6.0-rc1-src-release.tar.bz2/download">/DSpace Release Candidate/1.6.0-rc1 (patched)/dspace-1.6.0-rc1-src-release.tar.bz2</a></b>
<br />
<span class="smalltext">/DSpace Release Candidate/1.6.0-rc1 (patched)/dspace-1.6.0-rc1-src-release.tar.bz2</span>
</td>
</tr>
<tr>
<td valign="top">
<b><a href="http://sourceforge.net/projects/dspace/files%2FDSpace%20Release%20Candidate%2F1.6.0-rc1%20%28patched%29%2Fdspace-1.6.0-rc1-src-release.tar.gz/download">/DSpace Release Candidate/1.6.0-rc1 (patched)/dspace-1.6.0-rc1-src-release.tar.gz</a></b>
<br />
<span class="smalltext">/DSpace Release Candidate/1.6.0-rc1 (patched)/dspace-1.6.0-rc1-src-release.tar.gz</span>
</td>
</tr>
<tr>
<td valign="top">
<b><a href="http://sourceforge.net/projects/dspace/files%2FDSpace%20Release%20Candidate%2F1.6.0-rc1%20%28patched%29%2Fdspace-1.6.0-rc1-src-release.zip/download">/DSpace Release Candidate/1.6.0-rc1 (patched)/dspace-1.6.0-rc1-src-release.zip</a></b>
<br />
<span class="smalltext">/DSpace Release Candidate/1.6.0-rc1 (patched)/dspace-1.6.0-rc1-src-release.zip</span>
</td>
</tr>
</table>
</div>
<b>DSpace 1.6.x Integration Builds</b>:</p>
<p>Ideally we should place links into a Bamboo build here... <a href="https://integration.nts.jhu.edu/bamboo/browse/DS-TNK/">https://integration.nts.jhu.edu/bamboo/browse/DS-TNK/</a><br/>
<div class="rssMacro">
<table>
<tr>
<th>
<a href="https://integration.nts.jhu.edu/bamboo/rss/createAllBuildsRssFeed.action?feedTypex3drssAllx26buildKeyx3dDS-TNK"><img src="images/icons/rss.gif" border="0" height="15" width="27" align="right"/></a>
<a href="https://integration.johnshopkins.edu/bamboo">Bamboo build results feed for all builds</a>
<br />
<span class="smalltext">(This feed is updated whenever a build gets built)</span>
</th>
</tr>
<tr>
<td valign="top">
<b><a href="https://integration.johnshopkins.edu/bamboo/browse/DC-BATCH-37">DC-BATCH-37 was SUCCESSFUL (with 4 tests): Dependant of &lt;a href=&quot;/bamboo/browse/DC-INGEST-157;jsessionid=4zvnneqvkmmd&quot;&gt;DC-INGEST-157&lt;/a&gt;</a></b>
<br />
<span class="smalltext"><p> This build occured because it is a dependant of <a href="/bamboo/browse/DC-INGEST-157;jsessionid=4zvnneqvkmmd">DC-INGEST-157</a>.</p>
<p>
The build has 0 failed tests and 4 successful tests.
</p></span>
</td>
</tr>
<tr>
<td valign="top">
<b><a href="https://integration.johnshopkins.edu/bamboo/browse/DC-INTEGRATION-86">DC-INTEGRATION-86 has FAILED (4 tests failed): Dependant of &lt;a href=&quot;/bamboo/browse/DC-INGEST-157;jsessionid=4zvnneqvkmmd&quot;&gt;DC-INGEST-157&lt;/a&gt;</a></b>
<br />
<span class="smalltext"><p> This build occured because it is a dependant of <a href="/bamboo/browse/DC-INGEST-157;jsessionid=4zvnneqvkmmd">DC-INGEST-157</a>.</p>
<p>
The build has 4 failed tests and 0 successful tests.
</p></span>
</td>
</tr>
<tr>
<td valign="top">
<b><a href="https://integration.johnshopkins.edu/bamboo/browse/DC-INGEST-157">DC-INGEST-157 was SUCCESSFUL (with 143 tests): Dependant of &lt;a href=&quot;/bamboo/browse/DC-ACCESS-169;jsessionid=4zvnneqvkmmd&quot;&gt;DC-ACCESS-169&lt;/a&gt;</a></b>
<br />
<span class="smalltext"><p> This build occured because it is a dependant of <a href="/bamboo/browse/DC-ACCESS-169;jsessionid=4zvnneqvkmmd">DC-ACCESS-169</a>.</p>
<p>
The build has 0 failed tests and 143 successful tests.
</p></span>
</td>
</tr>
<tr>
<td valign="top">
<b><a href="https://integration.johnshopkins.edu/bamboo/browse/DC-INTEGRATION-85">DC-INTEGRATION-85 has FAILED (4 tests failed): Dependant of &lt;a href=&quot;/bamboo/browse/DC-ACCESS-169;jsessionid=4zvnneqvkmmd&quot;&gt;DC-ACCESS-169&lt;/a&gt;</a></b>
<br />
<span class="smalltext"><p> This build occured because it is a dependant of <a href="/bamboo/browse/DC-ACCESS-169;jsessionid=4zvnneqvkmmd">DC-ACCESS-169</a>.</p>
<p>
The build has 4 failed tests and 0 successful tests.
</p></span>
</td>
</tr>
<tr>
<td valign="top">
<b><a href="https://integration.johnshopkins.edu/bamboo/browse/DC-ACCESS-169">DC-ACCESS-169 was SUCCESSFUL (with 61 tests): Dependant of &lt;a href=&quot;/bamboo/browse/DC-ARCHIVE-97;jsessionid=4zvnneqvkmmd&quot;&gt;DC-ARCHIVE-97&lt;/a&gt;</a></b>
<br />
<span class="smalltext"><p> This build occured because it is a dependant of <a href="/bamboo/browse/DC-ARCHIVE-97;jsessionid=4zvnneqvkmmd">DC-ARCHIVE-97</a>.</p>
<p>
The build has 0 failed tests and 61 successful tests.
</p></span>
</td>
</tr>
<tr>
<td valign="top">
<b><a href="https://integration.johnshopkins.edu/bamboo/browse/DC-DEPOSIT-43">DC-DEPOSIT-43 was SUCCESSFUL (with 37 tests): Dependant of &lt;a href=&quot;/bamboo/browse/DC-COMMON-42;jsessionid=4zvnneqvkmmd&quot;&gt;DC-COMMON-42&lt;/a&gt;</a></b>
<br />
<span class="smalltext"><p> This build occured because it is a dependant of <a href="/bamboo/browse/DC-COMMON-42;jsessionid=4zvnneqvkmmd">DC-COMMON-42</a>.</p>
<p>
The build has 0 failed tests and 37 successful tests.
</p></span>
</td>
</tr>
<tr>
<td valign="top">
<b><a href="https://integration.johnshopkins.edu/bamboo/browse/DC-ARCHIVE-97">DC-ARCHIVE-97 was SUCCESSFUL (with 37 tests): Dependant of &lt;a href=&quot;/bamboo/browse/DC-COMMON-42;jsessionid=4zvnneqvkmmd&quot;&gt;DC-COMMON-42&lt;/a&gt;</a></b>
<br />
<span class="smalltext"><p> This build occured because it is a dependant of <a href="/bamboo/browse/DC-COMMON-42;jsessionid=4zvnneqvkmmd">DC-COMMON-42</a>.</p>
<p>
The build has 0 failed tests and 37 successful tests.
</p></span>
</td>
</tr>
<tr>
<td valign="top">
<b><a href="https://integration.johnshopkins.edu/bamboo/browse/DC-INGEST-156">DC-INGEST-156 was SUCCESSFUL (with 143 tests): Dependant of &lt;a href=&quot;/bamboo/browse/DC-COMMON-42;jsessionid=4zvnneqvkmmd&quot;&gt;DC-COMMON-42&lt;/a&gt;</a></b>
<br />
<span class="smalltext"><p> This build occured because it is a dependant of <a href="/bamboo/browse/DC-COMMON-42;jsessionid=4zvnneqvkmmd">DC-COMMON-42</a>.</p>
<p>
The build has 0 failed tests and 143 successful tests.
</p></span>
</td>
</tr>
<tr>
<td valign="top">
<b><a href="https://integration.johnshopkins.edu/bamboo/browse/DC-COMMON-42">DC-COMMON-42 was SUCCESSFUL (with 58 tests): &lt;a href=&quot;https://integration.johnshopkins.edu/bamboo/browse/DC-COMMON-42/commit&quot;&gt;Updated by Elliot Metsger&lt;/a&gt;</a></b>
<br />
<span class="smalltext"><p>
DC-COMMON-42 has the following 1 changes:
</p>
<p>
Elliot Metsger made the following changes at 2010-11-01 21:50:38.247<br>
with the comment: DC-278 - Common: Remove id service API dependency on Spring 2.5.5<br>
<br>
Added test dependency on spring-orm 3.0.2.RELEASE.<br>
<br>
</p>
<ul>
<li>/common-services/trunk/dcs-id-impl-hibernate/pom.xml</li>
</ul>
<p>
The build has 0 failed tests and 58 successful tests.
</p></span>
</td>
</tr>
<tr>
<td valign="top">
<b><a href="https://integration.johnshopkins.edu/bamboo/browse/DC-BATCH-36">DC-BATCH-36 was SUCCESSFUL (with 4 tests): Dependant of &lt;a href=&quot;/bamboo/browse/DC-INGEST-155;jsessionid=4zvnneqvkmmd&quot;&gt;DC-INGEST-155&lt;/a&gt;</a></b>
<br />
<span class="smalltext"><p>
DC-BATCH-36 has the following 1 changes:
</p>
<p>
Elliot Metsger made the following changes at 2010-11-01 10:46:26.073<br>
with the comment: DC-385: Check for a null base directory in DirectoryCrawler.
</p>
<ul>
<li>/dcs-batch/trunk/dcs-batch-impl/src/main/java/org/dataconservancy/dcs/batch/impl/DirectoryCrawler.java</li>
</ul>
<p>
The build has 0 failed tests and 4 successful tests.
</p></span>
</td>
</tr>
<tr>
<td valign="top">
<b><a href="https://integration.johnshopkins.edu/bamboo/browse/DC-INTEGRATION-84">DC-INTEGRATION-84 has FAILED (4 tests failed): Dependant of &lt;a href=&quot;/bamboo/browse/DC-INGEST-155;jsessionid=4zvnneqvkmmd&quot;&gt;DC-INGEST-155&lt;/a&gt;</a></b>
<br />
<span class="smalltext"><p>
DC-INTEGRATION-84 has the following 1 changes:
</p>
<p>
Elliot Metsger made the following changes at 2010-11-01 16:14:44.347<br>
with the comment: DC-480: ensure that the atompub collection urls are valid, at least in the integration test environment anyway.
</p>
<ul>
<li>/dcs-integration/trunk/dcs-integration-deposit/src/test/java/org/dataconservancy/dcs/integration/deposit/ManualDepositIT.java</li>
</ul>
<p>
The build has 4 failed tests and 0 successful tests.
</p></span>
</td>
</tr>
<tr>
<td valign="top">
<b><a href="https://integration.johnshopkins.edu/bamboo/browse/DC-INGEST-155">DC-INGEST-155 was SUCCESSFUL (with 143 tests): Dependant of &lt;a href=&quot;/bamboo/browse/DC-DEPOSIT-42;jsessionid=4zvnneqvkmmd&quot;&gt;DC-DEPOSIT-42&lt;/a&gt;</a></b>
<br />
<span class="smalltext"><p>
DC-INGEST-155 has the following 1 changes:
</p>
<p>
Elliot Metsger made the following changes at 2010-11-01 11:26:21.147<br>
with the comment: DC-376 - Abdera is fighting the dcs configuration when generating service document urls<br>
<br>
Correcting typos.<br>
</p>
<ul>
<li>/dcs-ingest/trunk/dcs-ingest-deposit/src/main/java/org/dataconservancy/dcs/ingest/deposit/AtomEventStatusDocument.java</li>
</ul>
<p>
The build has 0 failed tests and 143 successful tests.
</p></span>
</td>
</tr>
<tr>
<td valign="top">
<b><a href="https://integration.johnshopkins.edu/bamboo/browse/DC-DEPOSIT-42">DC-DEPOSIT-42 was SUCCESSFUL (with 37 tests): Triggered by child &lt;a href=&quot;/bamboo/browse/DC-INTEGRATION;jsessionid=4zvnneqvkmmd&quot;&gt;DC-INTEGRATION&lt;/a&gt;</a></b>
<br />
<span class="smalltext"><p>
DC-DEPOSIT-42 has the following 1 changes:
</p>
<p>
Elliot Metsger made the following changes at 2010-11-01 11:44:30.557<br>
with the comment: DC-376 - Abdera is fighting the dcs configuration when generating service document urls<br>
<br>
Correcting typos.
</p>
<ul>
<li>/dc-deposit/trunk/dc-deposit-sword-server/src/main/java/org/dataconservancy/deposit/sword/server/impl/DefaultSWORDProvider.java</li>
</ul>
<p>
The build has 0 failed tests and 37 successful tests.
</p></span>
</td>
</tr>
<tr>
<td valign="top">
<b><a href="https://integration.johnshopkins.edu/bamboo/browse/DC-COMMON-41">DC-COMMON-41 has FAILED (1 tests failed): &lt;a href=&quot;https://integration.johnshopkins.edu/bamboo/browse/DC-COMMON-41/commit&quot;&gt;Updated by Elliot Metsger&lt;/a&gt;</a></b>
<br />
<span class="smalltext"><p>
DC-COMMON-41 has the following 1 changes:
</p>
<p>
Elliot Metsger made the following changes at 2010-11-01 11:16:56.44<br>
with the comment: DC-278 - Common: Remove id service API dependency on Spring 2.5.5<br>
<br>
Updated Spring to 3.0.2.RELEASE (consistent with other DCS projects) and updated the dependencies by moving them into the impl poms, and enumerating all spring artifacts.
</p>
<ul>
<li>/common-services/trunk/notify-impl/pom.xml</li>
<li>/common-services/trunk/dcs-id-impl-hibernate/pom.xml</li>
<li>/common-services/trunk/pom.xml</li>
</ul>
<p>
The build has 1 failed tests and 49 successful tests.
</p></span>
</td>
</tr>
</table>
</div>
<b>Older Versions</b>:</p>
<ul>
<li><a href="http://sourceforge.net/projects/dspace/files/">Browse...</a></li>
</ul>
</div></div>
</td>
<td class="confluenceTd" valign="top" width="50%">
<div class="panel" style="background-color: #ffffff;border-color: #6699ff;border-style: solid;border-width: 1px;"><div class="panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;border-bottom-color: #6699ff;background-color: #D5EFFF;"><b>DSpace 1.6 Compatible Services</b></div><div class="panelContent" style="background-color: #ffffff;">
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'> <b>DSpace Services Framework</b> </td>
<td class='confluenceTd'> <a href="http://scm.dspace.org/svn/repo/modules/dspace-services">DSpace Services Module SVN Repository </a> </td>
</tr>
<tr>
<td class='confluenceTd'> <b>DSpace Solr Foundation</b> </td>
<td class='confluenceTd'> <a href="http://scm.dspace.org/svn/repo/modules/dspace-solr">DSpace Solr Module SVN Repository </a> </td>
</tr>
<tr>
<td class='confluenceTd'> <b>DSpace REST API</b> </td>
<td class='confluenceTd'> <a href="https://scm.dspace.org/svn/repo/modules/rest/branches/dspace-rest-1.x">DSpace 1.x REST Module SVN Repository </a> </td>
</tr>
</tbody></table>
</div>
</div></div>
</td></tr></tbody></table>
<br/>
<div class="tabletitle">
<a name="attachments">Attachments:</a>
</div>
<div class="greybox" align="left">
<img src="images/icons/bullet_blue.gif" height="8" width="8" alt=""/>
<a href="attachments/22022818/21954859.pdf">DSpace_System_Documentation_1.6.0_rc1.pdf</a> (application/pdf)
<br/>
</div>
</td>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td height="12" background="https://wiki.duraspace.org/images/border/border_bottom.gif"><img src="images/border/spacer.gif" width="1" height="1" border="0"/></td>
</tr>
<tr>
<td align="center"><font color="grey">Document generated by Confluence on Nov 06, 2010 19:27</font></td>
</tr>
</table>
</body>
</html>

View File

@@ -0,0 +1,44 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>DSpace Documentation : DSpace Community Administration Guide</title>
<link rel="stylesheet" href="styles/site.css" type="text/css" />
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
<table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
<tr>
<td valign="top" class="pagebody">
<div class="pageheader">
<span class="pagetitle">
DSpace Documentation : DSpace Community Administration Guide
</span>
</div>
<div class="pagesubheading">
This page last changed on Dec 31, 2009 by <font color="#0050B2">mdiggory</font>.
</div>
<h1><a name="DSpaceCommunityAdministrationGuide-DSpaceCommunityAdministrationGuide"></a>DSpace Community Administration Guide</h1>
<p>The goal of this Documentation is best practices in maintaining the DSpace Community.</p>
<ul><li><a href="Technical Resources.html" title="Technical Resources">Technical Resources</a></li></ul>
<h4><a name="DSpaceCommunityAdministrationGuide-"></a></h4>
</td>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td height="12" background="https://wiki.duraspace.org/images/border/border_bottom.gif"><img src="images/border/spacer.gif" width="1" height="1" border="0"/></td>
</tr>
<tr>
<td align="center"><font color="grey">Document generated by Confluence on Nov 06, 2010 19:27</font></td>
</tr>
</table>
</body>
</html>

View File

@@ -0,0 +1,363 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>DSpace Documentation : DSpace Documentation</title>
<link rel="stylesheet" href="styles/site.css" type="text/css" />
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
<table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
<tr>
<td valign="top" class="pagebody">
<div class="pageheader">
<span class="pagetitle">
DSpace Documentation : DSpace Documentation
<img src="images/icons/home_16.gif" height="16" width="16" border="0" align="absmiddle"/>
</span>
</div>
<div class="pagesubheading">
This page last changed on Oct 18, 2010 by <font color="#0050B2">tdonohue</font>.
</div>
<table class="sectionMacro" border="0" cellpadding="5" cellspacing="0" width="100%"><tbody><tr>
<td class="confluenceTd" valign="top" width="50%">
<div class="panel" style="background-color: #ffffff;border-color: #6699ff;border-style: solid;border-width: 1px;"><div class="panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;border-bottom-color: #6699ff;background-color: #D5EFFF;"><b>DSpace pre-1.7.0 Documentation (UNRELEASED)</b></div><div class="panelContent" style="background-color: #ffffff;">
<p>DSpace System Documentation&nbsp; <a href="attachments/22022817/21954858.pdf">Download PDF Example</a>, <a href="attachments/22022817/21954857.zip">Download DocBook Archive Example</a></p>
<p><b>Table of Contents:</b></p>
<ul><li><a href="DSpace System Documentation.html" title="DSpace System Documentation">DSpace System Documentation</a><ul><li><a href="Preface.html" title="Preface">Preface</a></li><li><a href="Introduction.html" title="Introduction">Introduction</a></li><li><a href="Functional Overview.html" title="Functional Overview">Functional Overview</a></li><li><a href="Installation.html" title="Installation">Installation</a></li><li><a href="Upgrading a DSpace Installation.html" title="Upgrading a DSpace Installation">Upgrading a DSpace Installation</a></li><li><a href="Configuration.html" title="Configuration">Configuration</a><ul><li><a href="DSpace Statistics.html" title="DSpace Statistics">DSpace Statistics</a></li><li><a href="Embargo.html" title="Embargo">Embargo</a></li></ul></li><li><a href="JSPUI Configuration and Customization.html" title="JSPUI Configuration and Customization">JSPUI Configuration and Customization</a></li><li><a href="XMLUI Configuration and Customization.html" title="XMLUI Configuration and Customization">XMLUI Configuration and Customization</a></li><li><a href="System Administration.html" title="System Administration">System Administration</a><ul><li><a href="AipBackupRestore.html" title="AipBackupRestore">AipBackupRestore</a></li></ul></li><li><a href="Storage.html" title="Storage">Storage</a></li><li><a href="Directories.html" title="Directories">Directories</a></li><li><a href="Architecture.html" title="Architecture">Architecture</a><ul><li><a href="DSpace Services Framework.html" title="DSpace Services Framework">DSpace Services Framework</a></li></ul></li><li><a href="Application.html" title="Application">Application</a></li><li><a href="Business.html" title="Business">Business</a></li><li><a href="Submission User Interface.html" title="Submission User Interface">Submission User Interface</a></li><li><a href="DRI Schema Reference.html" title="DRI Schema Reference">DRI Schema Reference</a></li><li><a href="Appendices.html" title="Appendices">Appendices</a><ul><li><a href="Appendix A.html" title="Appendix A">Appendix A</a></li></ul></li><li><a href="History.html" title="History">History</a></li></ul></li><li><a href="DSpace Builds.html" title="DSpace Builds">DSpace Builds</a></li><li><a href="DSpace Community Administration Guide.html" title="DSpace Community Administration Guide">DSpace Community Administration Guide</a><ul><li><a href="Technical Resources.html" title="Technical Resources">Technical Resources</a></li></ul></li></ul>
</div></div>
</td>
<td class="confluenceTd" valign="top" width="50%">
<div class="panel" style="background-color: #ffffff;border-color: #6699ff;border-style: solid;border-width: 1px;"><div class="panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;border-bottom-color: #6699ff;background-color: #D5EFFF;"><b>DSpace Release Documentation</b></div><div class="panelContent" style="background-color: #ffffff;">
<ul>
<li>DSpace 1.6.2: <a href="http://www.dspace.org/1_6_2Documentation/DSpace-Manual.pdf">PDF</a> or <a href="http://www.dspace.org/1_6_2Documentation/">HTML</a></li>
<li>DSpace 1.6.1: <a href="http://www.dspace.org/1_6_1Documentation/DSpace-Manual.pdf">PDF</a> or <a href="http://www.dspace.org/1_6_1Documentation/">HTML</a></li>
<li>DSpace 1.6.0: <a href="http://www.dspace.org/1_6_0Documentation/DSpace-Manual.pdf">PDF</a> or <a href="http://www.dspace.org/1_6_0Documentation/">HTML</a></li>
<li>DSpace 1.5.2: <a href="http://www.dspace.org/1_5_2Documentation/DSpace-Manual.pdf">PDF</a> or <a href="http://www.dspace.org/1_5_2Documentation/">HTML</a></li>
<li>DSpace 1.5.1: <a href="http://www.dspace.org/1_5_1Documentation/DSpace-Manual.pdf">PDF</a> or <a href="http://www.dspace.org/1_5_1Documentation/">HTML</a></li>
<li>DSpace 1.5.0: <a href="http://www.dspace.org/1_5Documentation/">HTML</a></li>
<li><a href="https://wiki.duraspace.org/display/DSPACE/DSpaceResources#DSpaceResources-DocumentationandGuides">DSpace 1.4.x and prior releases</a></li>
</ul>
</div></div>
<div class="panel" style="background-color: #ffffff;border-color: #6699ff;border-style: solid;border-width: 1px;"><div class="panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;border-bottom-color: #6699ff;background-color: #D5EFFF;"><b>DSpace Release Downloads</b></div><div class="panelContent" style="background-color: #ffffff;">
<p><b>DSpace 1.6.2 Release</b>:</p>
<ul>
<li><b>Full Source Release</b> : <a href="http://sourceforge.net/projects/dspace/files/DSpace%20Stable/1.6.2/dspace-1.6.2-src-release.zip/download">Download (8MB)</a></li>
<li><b>Basic Release</b> (No source code included) : <a href="http://sourceforge.net/projects/dspace/files/DSpace%20Stable/1.6.2/dspace-1.6.2-release.zip/download">Download (4MB)</a></li>
</ul>
<p>Past releases are available from <a href="http://sourceforge.net/projects/dspace/files/">DSpace's SourceForge site</a>.</p>
<p>Developers may also checkout DSpace source code from our <a href="http://scm.dspace.org/svn/repo/dspace/">Subversion (SVN) repository</a>.</p>
</div></div>
<div class="panel" style="background-color: #ffffff;border-color: #6699ff;border-style: solid;border-width: 1px;"><div class="panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;border-bottom-color: #6699ff;background-color: #D5EFFF;"><b>Known Documentation Issues</b></div><div class="panelContent" style="background-color: #ffffff;">
<p>
<table cellspacing="0" class="grid" style="width: 100%">
<tr>
<th colspan="5" style="text-align: left; ">
<a rel="nofollow" href="https://jira.duraspace.org/secure/IssueNavigator.jspa?reset=true&amp;jqlQuery=project+%3D+DS+AND+resolution+%3D+Unresolved+AND+component+%3D+Documentation+ORDER+BY+priority+DESC&amp;tempMax=1000">JIRA Issues</a>&nbsp;(6&nbsp;issues)
</th>
</tr>
<tr>
<th style="text-align: left; text-transform: capitalize;">Key</th>
<th style="text-align: left; text-transform: capitalize;">Summary</th>
<th style="text-align: left; text-transform: capitalize;">Assignee</th>
<th style="text-align: left; text-transform: capitalize;">Reporter</th>
<th style="text-align: left; text-transform: capitalize;">Status</th>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="https://jira.duraspace.org/browse/DS-641">DS-641</a>
</td>
<td >
<a href="https://jira.duraspace.org/browse/DS-641">Page does not exist</a>
</td>
<td nowrap="true">
Unassigned
</td>
<td nowrap="true">
Hardik Mishra
</td>
<td nowrap="true">
<img src="https://jira.duraspace.org/images/icons/status_email.gif" alt="" border="0" /> Received
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="https://jira.duraspace.org/browse/DS-720">DS-720</a>
</td>
<td >
<a href="https://jira.duraspace.org/browse/DS-720">Solr statistics documentation in DSpace manual and DSDOC is out-of-date, wrong, and inconsistent with dspace.cfg</a>
</td>
<td nowrap="true">
Unassigned
</td>
<td nowrap="true">
Kim Shepherd
</td>
<td nowrap="true">
<img src="https://jira.duraspace.org/images/icons/status_email.gif" alt="" border="0" /> Received
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="https://jira.duraspace.org/browse/DS-640">DS-640</a>
</td>
<td >
<a href="https://jira.duraspace.org/browse/DS-640">Interal System Error when browsing with wrong argument</a>
</td>
<td nowrap="true">
Jeffrey Trimble
</td>
<td nowrap="true">
Hardik Mishra
</td>
<td nowrap="true">
<img src="https://jira.duraspace.org/images/icons/status_open.gif" alt="" border="0" /> Open
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="https://jira.duraspace.org/browse/DS-657">DS-657</a>
</td>
<td >
<a href="https://jira.duraspace.org/browse/DS-657">Remove old, out-of-date Documentation from SVN, once fully cleaned up on Wiki</a>
</td>
<td nowrap="true">
Jeffrey Trimble
</td>
<td nowrap="true">
Tim Donohue
</td>
<td nowrap="true">
<img src="https://jira.duraspace.org/images/icons/status_open.gif" alt="" border="0" /> Open
</td>
</tr>
<tr class="rowNormal">
<td nowrap="true">
<a href="https://jira.duraspace.org/browse/DS-535">DS-535</a>
</td>
<td >
<a href="https://jira.duraspace.org/browse/DS-535">Documentation patch to alleviate file ownership confusion</a>
</td>
<td nowrap="true">
Jeffrey Trimble
</td>
<td nowrap="true">
Mark H. Wood
</td>
<td nowrap="true">
<img src="https://jira.duraspace.org/images/icons/status_reopened.gif" alt="" border="0" /> Reopened
</td>
</tr>
<tr class="rowAlternate">
<td nowrap="true">
<a href="https://jira.duraspace.org/browse/DS-627">DS-627</a>
</td>
<td >
<a href="https://jira.duraspace.org/browse/DS-627">Documentation refers to install-configs script</a>
</td>
<td nowrap="true">
Jeffrey Trimble
</td>
<td nowrap="true">
Nick Nicholas
</td>
<td nowrap="true">
<img src="https://jira.duraspace.org/images/icons/status_open.gif" alt="" border="0" /> Open
</td>
</tr>
</table>
</p>
</div></div>
<div class="panel" style="background-color: #ffffff;border-color: #6699ff;border-style: solid;border-width: 1px;"><div class="panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;border-bottom-color: #6699ff;background-color: #D5EFFF;"><b>Recent Updates</b></div><div class="panelContent" style="background-color: #ffffff;">
<div class="recently-updated recently-updated-concise" >
<h4 class="sub-heading">Recently Updated</h4>
<fieldset class="hidden parameters">
<input type="hidden" id="changesUrl" value="/plugins/recently-updated/changes.action?theme=concise&pageSize=15&startIndex=0&spaceKeys=DSDOC">
</fieldset>
<div class="results-container">
<ul>
<li class="first update-item">
<span class="icon-container content-type-attachment-image"><a href="null/display/DSDOC" title="">1289054526595_com.k15t.scroll.image.cl.titlepage.logo</a></span>
<div class="update-item-desc">attached by <a class="confluence-userlink username:jtrimble url fn" href="null/display/~jtrimble">Jeffrey Trimble</a></div>
<div class="update-item-date">24 minutes ago</div>
</li>
<li class=" update-item">
<span class="icon-container content-type-page"><a href="null/display/DSDOC/Appendix+A" title="DSpace Documentation">Appendix A</a></span>
<div class="update-item-desc">updated by <a class="confluence-userlink username:jtrimble url fn" href="null/display/~jtrimble">Jeffrey Trimble</a></div>
<div class="update-item-changes">(<a href="null/pages/diffpagesbyversion.action?pageId=22022829&selectedPageVersions=2&selectedPageVersions=1">view change</a>)</div>
<div class="update-item-date">25 minutes ago</div>
</li>
<li class=" update-item">
<span class="icon-container content-type-page"><a href="null/display/DSDOC/History" title="DSpace Documentation">History</a></span>
<div class="update-item-desc">updated by <a class="confluence-userlink username:jtrimble url fn" href="null/display/~jtrimble">Jeffrey Trimble</a></div>
<div class="update-item-changes">(<a href="null/pages/diffpagesbyversion.action?pageId=22022839&selectedPageVersions=4&selectedPageVersions=3">view change</a>)</div>
<div class="update-item-date">25 minutes ago</div>
</li>
<li class=" update-item">
<span class="icon-container content-type-page"><a href="null/display/DSDOC/DRI+Schema+Reference" title="DSpace Documentation">DRI Schema Reference</a></span>
<div class="update-item-desc">updated by <a class="confluence-userlink username:jtrimble url fn" href="null/display/~jtrimble">Jeffrey Trimble</a></div>
<div class="update-item-changes">(<a href="null/pages/diffpagesbyversion.action?pageId=22022838&selectedPageVersions=6&selectedPageVersions=5">view change</a>)</div>
<div class="update-item-date">26 minutes ago</div>
</li>
<li class=" update-item">
<span class="icon-container content-type-page"><a href="null/display/DSDOC/Submission+User+Interface" title="DSpace Documentation">Submission User Interface</a></span>
<div class="update-item-desc">updated by <a class="confluence-userlink username:jtrimble url fn" href="null/display/~jtrimble">Jeffrey Trimble</a></div>
<div class="update-item-changes">(<a href="null/pages/diffpagesbyversion.action?pageId=22022830&selectedPageVersions=5&selectedPageVersions=4">view change</a>)</div>
<div class="update-item-date">26 minutes ago</div>
</li>
<li class=" update-item">
<span class="icon-container content-type-page"><a href="null/display/DSDOC/Business" title="DSpace Documentation">Business</a></span>
<div class="update-item-desc">updated by <a class="confluence-userlink username:jtrimble url fn" href="null/display/~jtrimble">Jeffrey Trimble</a></div>
<div class="update-item-changes">(<a href="null/pages/diffpagesbyversion.action?pageId=22022831&selectedPageVersions=4&selectedPageVersions=3">view change</a>)</div>
<div class="update-item-date">26 minutes ago</div>
</li>
<li class=" update-item">
<span class="icon-container content-type-page"><a href="null/display/DSDOC/Application" title="DSpace Documentation">Application</a></span>
<div class="update-item-desc">updated by <a class="confluence-userlink username:jtrimble url fn" href="null/display/~jtrimble">Jeffrey Trimble</a></div>
<div class="update-item-changes">(<a href="null/pages/diffpagesbyversion.action?pageId=22022819&selectedPageVersions=4&selectedPageVersions=3">view change</a>)</div>
<div class="update-item-date">26 minutes ago</div>
</li>
<li class=" update-item">
<span class="icon-container content-type-page"><a href="null/display/DSDOC/DSpace+Services+Framework" title="DSpace Documentation">DSpace Services Framework</a></span>
<div class="update-item-desc">updated by <a class="confluence-userlink username:jtrimble url fn" href="null/display/~jtrimble">Jeffrey Trimble</a></div>
<div class="update-item-changes">(<a href="null/pages/diffpagesbyversion.action?pageId=22022824&selectedPageVersions=5&selectedPageVersions=4">view change</a>)</div>
<div class="update-item-date">26 minutes ago</div>
</li>
<li class=" update-item">
<span class="icon-container content-type-page"><a href="null/display/DSDOC/Architecture" title="DSpace Documentation">Architecture</a></span>
<div class="update-item-desc">updated by <a class="confluence-userlink username:jtrimble url fn" href="null/display/~jtrimble">Jeffrey Trimble</a></div>
<div class="update-item-changes">(<a href="null/pages/diffpagesbyversion.action?pageId=22022821&selectedPageVersions=5&selectedPageVersions=4">view change</a>)</div>
<div class="update-item-date">27 minutes ago</div>
</li>
<li class=" update-item">
<span class="icon-container content-type-page"><a href="null/display/DSDOC/Directories" title="DSpace Documentation">Directories</a></span>
<div class="update-item-desc">updated by <a class="confluence-userlink username:jtrimble url fn" href="null/display/~jtrimble">Jeffrey Trimble</a></div>
<div class="update-item-changes">(<a href="null/pages/diffpagesbyversion.action?pageId=22022832&selectedPageVersions=4&selectedPageVersions=3">view change</a>)</div>
<div class="update-item-date">27 minutes ago</div>
</li>
<li class=" update-item">
<span class="icon-container content-type-page"><a href="null/display/DSDOC/Storage" title="DSpace Documentation">Storage</a></span>
<div class="update-item-desc">updated by <a class="confluence-userlink username:jtrimble url fn" href="null/display/~jtrimble">Jeffrey Trimble</a></div>
<div class="update-item-changes">(<a href="null/pages/diffpagesbyversion.action?pageId=22022822&selectedPageVersions=8&selectedPageVersions=7">view change</a>)</div>
<div class="update-item-date">27 minutes ago</div>
</li>
<li class=" update-item">
<span class="icon-container content-type-page"><a href="null/display/DSDOC/AipBackupRestore" title="DSpace Documentation">AipBackupRestore</a></span>
<div class="update-item-desc">updated by <a class="confluence-userlink username:jtrimble url fn" href="null/display/~jtrimble">Jeffrey Trimble</a></div>
<div class="update-item-changes">(<a href="null/pages/diffpagesbyversion.action?pageId=19989001&selectedPageVersions=130&selectedPageVersions=129">view change</a>)</div>
<div class="update-item-date">27 minutes ago</div>
</li>
<li class=" update-item">
<span class="icon-container content-type-page"><a href="null/display/DSDOC/System+Administration" title="DSpace Documentation">System Administration</a></span>
<div class="update-item-desc">updated by <a class="confluence-userlink username:jtrimble url fn" href="null/display/~jtrimble">Jeffrey Trimble</a></div>
<div class="update-item-changes">(<a href="null/pages/diffpagesbyversion.action?pageId=22022835&selectedPageVersions=17&selectedPageVersions=16">view change</a>)</div>
<div class="update-item-date">28 minutes ago</div>
</li>
<li class=" update-item">
<span class="icon-container content-type-page"><a href="null/display/DSDOC/JSPUI+Configuration+and+Customization" title="DSpace Documentation">JSPUI Configuration and Customization</a></span>
<div class="update-item-desc">updated by <a class="confluence-userlink username:jtrimble url fn" href="null/display/~jtrimble">Jeffrey Trimble</a></div>
<div class="update-item-changes">(<a href="null/pages/diffpagesbyversion.action?pageId=22022833&selectedPageVersions=4&selectedPageVersions=3">view change</a>)</div>
<div class="update-item-date">28 minutes ago</div>
</li>
<li class=" update-item">
<span class="icon-container content-type-page"><a href="null/display/DSDOC/Embargo" title="DSpace Documentation">Embargo</a></span>
<div class="update-item-desc">updated by <a class="confluence-userlink username:jtrimble url fn" href="null/display/~jtrimble">Jeffrey Trimble</a></div>
<div class="update-item-changes">(<a href="null/pages/diffpagesbyversion.action?pageId=22022842&selectedPageVersions=3&selectedPageVersions=2">view change</a>)</div>
<div class="update-item-date">28 minutes ago</div>
</li>
<li class="more-link-container">
<a class="more-link more-link-base" href="/plugins/recently-updated/changes.action?theme=concise&pageSize=15&startHandle=com.atlassian.confluence.pages.Page-22022841&spaceKeys=DSDOC&contentType=-mail,page,comment,blogpost,attachment,userinfo,spacedesc,personalspacedesc,status">
<span class="more-link-text">More</span>&nbsp;
<img class="waiting-image hidden" alt="Please wait" src="s/1814/37/_/images/icons/wait.gif">
</a>
</li>
</ul>
</div>
</div>
</div></div></td></tr></tbody></table>
<br/>
<div class="tabletitle">
<a name="attachments">Attachments:</a>
</div>
<div class="greybox" align="left">
<img src="images/icons/bullet_blue.gif" height="8" width="8" alt=""/>
<a href="attachments/22022817/21954858.pdf">DSpace_System_Documentation_1.6.0_rc1.pdf</a> (application/pdf)
<br/>
<img src="images/icons/bullet_blue.gif" height="8" width="8" alt=""/>
<a href="attachments/22022817/21954857.zip">DSpace_System_Documentation-6.zip</a> (application/zip)
<br/>
</div>
</td>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td height="12" background="https://wiki.duraspace.org/images/border/border_bottom.gif"><img src="images/border/spacer.gif" width="1" height="1" border="0"/></td>
</tr>
<tr>
<td align="center"><font color="grey">Document generated by Confluence on Nov 06, 2010 19:27</font></td>
</tr>
</table>
</body>
</html>

View File

@@ -0,0 +1,167 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>DSpace Documentation : DSpace Services Framework</title>
<link rel="stylesheet" href="styles/site.css" type="text/css" />
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
<table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
<tr>
<td valign="top" class="pagebody">
<div class="pageheader">
<span class="pagetitle">
DSpace Documentation : DSpace Services Framework
</span>
</div>
<div class="pagesubheading">
This page last changed on Nov 06, 2010 by <font color="#0050B2">jtrimble</font>.
</div>
<h1><a name="DSpaceServicesFramework-DSpaceServicesFramework"></a>DSpace Services Framework</h1>
<h2><a name="DSpaceServicesFramework-ConfiguringEventListeners"></a>Configuring Event Listeners</h2>
<p>Event Listeners can be created by overriding the the EventListener interface:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">&lt;?xml version=<span class="code-quote">"1.0"</span> encoding=<span class="code-quote">"UTF-8"</span>?&gt;
&lt;beans&gt;
&lt;bean id=<span class="code-quote">"dspace"</span> class=<span class="code-quote">"org.dspace.utils.DSpace"</span>/&gt;
&lt;bean id=<span class="code-quote">"dspace.eventService"</span>
factory-bean=<span class="code-quote">"dspace"</span>
factory-method=<span class="code-quote">"getEventService"</span>/&gt;
&lt;bean class=<span class="code-quote">"org.my.EventListener"</span>&gt;
&lt;property name=<span class="code-quote">"eventService"</span> &gt;
&lt;ref bean=<span class="code-quote">"dspace.eventService"</span>/&gt;
&lt;/property&gt;
&lt;/bean&gt;
&lt;/beans&gt;
</pre>
</div></div>
<h2><a name="DSpaceServicesFramework-ArchitecturalOverview"></a>Architectural Overview</h2>
<h3><a name="DSpaceServicesFramework-DSpaceKernel"></a>DSpace Kernel</h3>
<p>The DSpace Kernel manages the start up and access services in the DSpace Services framework. It is meant to allow for a simple way to control the core parts of DSpace and allow for flexible ways to startup the kernel. For example, the kernel can be run inside a single webapp along with a frontend piece (like JSPUI) or it can be started as part of the servlet container so that multiple webapps can use a single kernel (this increases speed and efficiency). The kernel is also designed to happily allow multiple kernels to run in a single servlet container using identifier keys.</p>
<h4><a name="DSpaceServicesFramework-Kernelregistration"></a>Kernel registration</h4>
<p>The kernel will automatically register itself as an MBean in when it starts up so that it can be managed. It allows startup and shutdown and provides direct access to the ServiceManager and the ConfigurationService. All the other core services can be retrieved from the ServiceManager by their APIs. <span class="image-wrap" style="display: block; text-align: center"><img src="attachments/22022824/21954868.png" style="border: 0px solid black"/></span></p>
<h4><a name="DSpaceServicesFramework-KernelStartupandAccess"></a>Kernel Startup and Access</h4>
<p>The kernel can be started and accessed through the use of Servlet Filter/ContextListeners which are provided as part of the DSpace 2 utilities. Developers don't need to understand what is going on behind the scenes and can simply write their applications and package them as webapps and take advantage of the services which are offered by DSpace 2. Access to the kernel is provided via the Kernel Manager and the DSpace object which will locate the kernel object and allow it to be used.&nbsp;</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">/* Instantiate the Utility <span class="code-object">Class</span> */
DSpace dspace = <span class="code-keyword">new</span> DSpace();
/* Access get the Service Manager by convenience method */
ServiceManager manager = dspace.getServiceManager();
/* Or access by convenience method <span class="code-keyword">for</span> <span class="code-keyword">default</span> services */
EventService service = dspace.getEventService();
</pre>
</div></div>
<h3><a name="DSpaceServicesFramework-ServiceManager"></a>Service Manager</h3>
<p>The ServiceManager abstracts the concepts of service lookups and lifecycle control. It also manages the configuration of services by allowing properties to be pushed into the services as they start up (mostly from the ConfigurationService). The ServiceManagerSystem abstraction allows the DSpace ServiceManager to use different systems to manage it's services. The current implementations include Spring and Guice. This allows DSpace 2 to have very little service management code but still be flexible and not tied to specific technology. Developers who are comfortable with those technologies can consume the services from a parent Spring ApplicationContext or a parent Guice Module. The abstraction also means that we can replace Spring/Guice or add other dependency injection systems later without requiring developers to change their code. The interface provides simple methods for looking up services by interface type for developers who do not want to have to use or learn a dependency injection system or are using one which is not currently supported.</p>
<p><span class="image-wrap" style="display: block; text-align: center"><img src="attachments/22022824/21954867.png" height="332" width="445" style="border: 0px solid black"/></span></p>
<h2><a name="DSpaceServicesFramework-"></a></h2>
<p>The DS2 kernel is compact so it can be completely started up in a unit test (technically integration test) environment (this is who we test the kernel and core services currently). This allows developers to execute code against a fully functional kernel while developing and then deploy their code with high confidence.</p>
<h2><a name="DSpaceServicesFramework-ProvidersandPlugins"></a>Providers and Plugins</h2>
<p>For developers (how we are trying to make your lives easier): The DS2 ServiceManager supports a plugin/provider system which is runtime hot-swappable. The implementor can register any service/provider bean or class with the DS2 kernel ServiceManager. The ServiceManager will manage the lifecycle of beans (if desired) and will instantiate and manage the lifecycle of any classes it is given. This can be done at any time and does not have to be done during Kernel startup. This allows providers to be swapped out at runtime without disrupting the service if desired. The goal of this system is to allow DS2 to be extended without requiring any changes to the core codebase or a rebuild of the code code.</p>
<h3><a name="DSpaceServicesFramework-Activators"></a>Activators</h3>
<p>Developers can use an activator to allow the system to startup their service or provider. It is a simple interface with 2 methods which are called to startup the provider(s) and later to shut them down. These simply allow a developer to run some arbitrary code in order to create and register services if desired. It is the method provided to add plugins directly to the system via configuration as the activators are just listed in the configuration file and the system starts them up in the order it finds them.</p>
<h3><a name="DSpaceServicesFramework-ProviderStacks"></a>Provider Stacks</h3>
<p>Utilities are provided to assist with stacking and ordering providers. The priority is handled via a priority number such that 1 is the highest priority and something like 10 would be lower. 0 indicates that priority is not important for this service and can be used to ensure the provider is placed at or near the end without having to set some arbitrarily high number.</p>
<p>The DSpace Services Framework is a backporting of the DSpace 2.0 Development Groups work in creating a reasonable and abstractable "Core Services" layer for DSpace components to operate within.&nbsp; The Services Framework represents a "best practices" for new DSpace architecture and implementation of exentsions to the DSpace application.&nbsp; DSpace Services are best described as a "Simple Registry" where plugins.&nbsp; The DS2 (<a href="http://wiki.dspace.org/index.php/DSpace_2.0">DSpace 2.0</a>) core services are the main services that make up a DS2 system. These includes services for things like user and permissions management and storage and caching. These services can be used by any developer writing DS2 plugins (e.g. statistics), providers (e.g. Authn), or user interfaces (e.g. JSPUI).</p>
<h2><a name="DSpaceServicesFramework-CoreServices"></a>Core Services</h2>
<p>The core services are all behind APIs so that they can be reimplemented without affecting developers who are using the services. Most of the services have plugin/provider points so that customizations can be added into the system without touching the core services code. For example, let's say a deployer has a specialized authentication system and wants to manage the authentication calls which come into the system. The implementor can simply implement an AuthenticationProvider and then register it with the DS2 kernel ServiceManager. This can be done at any time and does not have to be done during Kernel startup. This allows providers to be swapped out at runtime without disrupting the DS2 service if desired. It can also speed up development by allowing quick hot redeploys of code during development.</p>
<h3><a name="DSpaceServicesFramework-CachingService"></a>Caching Service</h3>
<p>Provides for a centralized way to handle caching in the system and thus a single point for configuration and control over all caches in the system. Provider and plugin developers are strongly encouraged to use this rather than implementing their own caching. The caching service has the concept of scopes so even storing data in maps or lists is discouraged unless there are good reasons to do so.</p>
<h3><a name="DSpaceServicesFramework-ConfigurationService"></a>Configuration Service</h3>
<p>The ConfigurationService controls the external and internal configuration of DSpace 2. It reads in properties files when the kernel starts up and merges them with any dynamic configuration data which is available from the services. The service allows settings to be updated as the system is running and also provides listeners which allow services to know when their configuration settings have changed and take action if desired. It is the central point to access and manage all the configuration settings in DSpace 2.</p>
<p>Manages the configuration of the DSpace 2 system. Can be used to manage configuration for providers and plugins also.</p>
<h3><a name="DSpaceServicesFramework-EventService"></a>EventService</h3>
<p>Handles events and provides access to listeners for consumption of events.</p>
<h3><a name="DSpaceServicesFramework-RequestService"></a>RequestService</h3>
<p>In DS2 a request is the concept of a request (HTTP) or an atomic transaction in the system. It is likely to be an HTTP request in many cases but it does not have to be. This service provides the core services with a way to manage atomic transactions so that when a request comes in which requires mutliple things to happen they can either all suceed or all fail without each service attempting to manage this independently. In a nutshell this simply allows identification of the current request and the ability to discover if it succeeded or failed when it ends. Nothing in the system will enforce usage of the service but we encourage developers who are interacting with the system to make use of this service so they know if the request they are participating in with has succeeded or failed and take appropriate actions.</p>
<h3><a name="DSpaceServicesFramework-SessionService"></a>SessionService</h3>
<p>In DS2 a session is like an HttpSession (and generally is actually one) so this service is here to allow developers to find information about the current session and to access information in it. The session identifies the current user (if authenticated) so it also serves as a way to track user sessions. Since we use HttpSession directly it is easy to mirror sessions across multiple servers in order to allow for no-interruption failover for users when servers go offline.</p>
<br/>
<div class="tabletitle">
<a name="attachments">Attachments:</a>
</div>
<div class="greybox" align="left">
<img src="images/icons/bullet_blue.gif" height="8" width="8" alt=""/>
<a href="attachments/22022824/21954867.png">DS2-kernel-diagram.png</a> (image/png)
<br/>
<img src="images/icons/bullet_blue.gif" height="8" width="8" alt=""/>
<a href="attachments/22022824/21954866.gif">Kernel Overview.gif</a> (image/gif)
<br/>
<img src="images/icons/bullet_blue.gif" height="8" width="8" alt=""/>
<a href="attachments/22022824/21954869.png">Kernel Overview.png</a> (image/png)
<br/>
<img src="images/icons/bullet_blue.gif" height="8" width="8" alt=""/>
<a href="attachments/22022824/21954868.png">dspace-services-kernel.png</a> (image/png)
<br/>
</div>
</td>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td height="12" background="https://wiki.duraspace.org/images/border/border_bottom.gif"><img src="images/border/spacer.gif" width="1" height="1" border="0"/></td>
</tr>
<tr>
<td align="center"><font color="grey">Document generated by Confluence on Nov 06, 2010 19:27</font></td>
</tr>
</table>
</body>
</html>

View File

@@ -0,0 +1,187 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>DSpace Documentation : DSpace Statistics</title>
<link rel="stylesheet" href="styles/site.css" type="text/css" />
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
<table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
<tr>
<td valign="top" class="pagebody">
<div class="pageheader">
<span class="pagetitle">
DSpace Documentation : DSpace Statistics
</span>
</div>
<div class="pagesubheading">
This page last changed on Nov 06, 2010 by <font color="#0050B2">jtrimble</font>.
</div>
<h1><a name="DSpaceStatistics-DSpaceStatistics"></a>DSpace Statistics</h1>
<p>DSpace uses the Apache Solr application underlaying the statistics. There is no need to download any separate software. All the necessary software is included.</p>
<h2><a name="DSpaceStatistics-UsageEventLoggingandUsageStatisticsGathering"></a>Usage Event Logging and Usage Statistics Gathering</h2>
<p>The DSpace Statistics Implementation is a Client/Server architecture based on Solr for collecting usage events in the JSPUI and XMLUI user interface applications of DSpace.&nbsp; Solr runs as a separate webapplication and an instance of Apache Http Client is utilized to allow parallel requests to log statistics events into this Solr instance.&nbsp; The Usage Event framework has a couple EventListeners installed which assist in&nbsp;[rest of sentence missing? - Kim]</p>
<h2><a name="DSpaceStatistics-ConfigurationsettingsforStatistics"></a>Configuration settings for Statistics</h2>
<p>In the dspace.cfg file review the following fields to make sure they are uncommented:</p>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> Property Name <br class="atl-forced-newline" /> </th>
<th class='confluenceTh'> Default Value <br class="atl-forced-newline" /> </th>
<th class='confluenceTh'> Type <br class="atl-forced-newline" /> </th>
<th class='confluenceTh'> Description <br class="atl-forced-newline" /> </th>
</tr>
<tr>
<td class='confluenceTd'> solr.log.server </td>
<td class='confluenceTd'> ${dspace.baseUrl}/solr/statistics </td>
<td class='confluenceTd'> String <br class="atl-forced-newline" /> </td>
<td class='confluenceTd'> Is used by the SolrLogger Client class to connect tot the Solr server over http and perform updates and queries. In most cases, this can (and should) be set to localhost. </td>
</tr>
<tr>
<td class='confluenceTd'> solr.spiderips.urls </td>
<td class='confluenceTd'> <br class="atl-forced-newline" />
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
http:<span class="code-comment">//iplists.com/google.txt, \
</span>http:<span class="code-comment">//iplists.com/inktomi.txt, \http://iplists.com/lycos.txt, \http://iplists.com/infoseek.txt, \http://iplists.com/altavista.txt \http://iplists.com/excite.txt, \
</span>http:<span class="code-comment">//iplists.com/misc.txt, \
</span>http:<span class="code-comment">//iplists.com/non_engines.txt</span>
</pre>
</div></div>
<p><a href="http://iplists.com/non_engines.txt">http://iplists.com/non_engines.txt</a> </p></td>
<td class='confluenceTd'> String <br class="atl-forced-newline" /> </td>
<td class='confluenceTd'> List of URLs to download spiders files into [dspace]/config/spiders. These files contain lists of known spider IPs and are utilized by the SolrLogger to flag usage events with an "isBot" field, or ignore them entirely. <br class="atl-forced-newline" />
<br class="atl-forced-newline" />
The "stats-util" command can be used to force an update of spider files, regenerate "isBot" fields on indexed events, and delete spiders from the index. For usage, run: <br class="atl-forced-newline" />
<br class="atl-forced-newline" />
<br class="atl-forced-newline" />
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
dspace stats-util -h
</pre>
</div></div>
<p>from your&nbsp;[dspace]/bin directory </p></td>
</tr>
<tr>
<td class='confluenceTd'> solr.dbfile <br class="atl-forced-newline" /> </td>
<td class='confluenceTd'> ${dspace.dir}/config/GeoLiteCity.dat </td>
<td class='confluenceTd'> String <br class="atl-forced-newline" /> </td>
<td class='confluenceTd'> The following referes to the GeoLiteCity database file utilized by the LocationUtils to calculate the location of client requests based on IP address. During the Ant build process (both fresh_install and update) this file will be downloaded from <a href="http://www.maxmind.com/app/geolitecity">http://www.maxmind.com/app/geolitecity</a> if a new version has been published or it is absent from your [dspace]/config directory. <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td class='confluenceTd'> solr.resolver.timeout </td>
<td class='confluenceTd'> 200 </td>
<td class='confluenceTd'> Integer </td>
<td class='confluenceTd'> Timeout in milliseconds for DNS resolution of origin hosts/IPs. Setting this value too high may result in solr exhausting your connection pool. </td>
</tr>
<tr>
<td class='confluenceTd'> useProxies <br class="atl-forced-newline" /> </td>
<td class='confluenceTd'> true <br class="atl-forced-newline" /> </td>
<td class='confluenceTd'> boolean <br class="atl-forced-newline" /> </td>
<td class='confluenceTd'> Will cause Statistics loging to look for X-Forward URI to detect clients IP that have accessed it through a Proxy service.&nbsp; Allows detection of client IP when accessing DSpace. [Note: This setting is found in the DSpace Logging sesction of dspace.cfg] </td>
</tr>
<tr>
<td class='confluenceTd'> statistics.item.authorization.admin </td>
<td class='confluenceTd'> true <br class="atl-forced-newline" /> </td>
<td class='confluenceTd'> boolean <br class="atl-forced-newline" /> </td>
<td class='confluenceTd'> Enables access control restriction on DSpace&nbsp; Statistics pages, Restrictions are based on access rights to Community, Collection and Item Pages. This will require the user to sign on to see that statistics. Setting the statistics to "false" will make them publicly available. </td>
</tr>
<tr>
<td class='confluenceTd'> solr.statistics.logBots </td>
<td class='confluenceTd'> true </td>
<td class='confluenceTd'> boolean </td>
<td class='confluenceTd'> If false, and IP is detected as a spider, the event is not logged. <br class="atl-forced-newline" />
If true, the event will be logged with the "isBot" field set to true. <br class="atl-forced-newline" />
(see solr.statistics.query.filter.&#42; for query filter options) </td>
</tr>
<tr>
<td class='confluenceTd'> solr.statistics.query.filter.spiderIp </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> boolean </td>
<td class='confluenceTd'> If true, statistics queries will filter out spider IPs &#45;&#45; use with caution, as this often results in extremely long query strings. </td>
</tr>
<tr>
<td class='confluenceTd'> solr.statistics.query.filter.isBot </td>
<td class='confluenceTd'> true </td>
<td class='confluenceTd'> boolean </td>
<td class='confluenceTd'> If true, statistics queries will filter out events flagged with the "isBot" field. This is the recommended method of filtering spiders from statistics. </td>
</tr>
</tbody></table>
</div>
<h3><a name="DSpaceStatistics-"></a></h3>
<h3><a name="DSpaceStatistics-UpgradeProcessforStatistics."></a>Upgrade Process for Statistics.</h3>
<p>Example of rebuild and redeploy DSpace (only if you have configured your distribution in this manner)</p>
<p>First approach the traditional DSpace build process for updating</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
cd [dspace-source]/dspace
mvn <span class="code-keyword">package</span>
cd [dspace-source]/dspace/target/dspace-&lt;version&gt;-build.dir
ant -Dconfig=[dspace]/config/dspace.cfg update
cp -R [dspace]/webapps/* [TOMCAT]/webapps
</pre>
</div></div>
<p>The last step is only used if you are not mounting <em>[~mdiggory:dspace]/webapps</em> directly into your Tomcat, Resin or Jetty host (the recommended practice)If you only need to build the statistics, and don't make any changes to other web applications, you can replace the copy step above with:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
cp -R dspace/webapps/solr TOMCAT/webapps
</pre>
</div></div>
<p><em>Again, only if you are not mounting [~mdiggory:dspace]/webapps directly into your Tomcat, Resin or Jetty host (the recommended practice)</em></p>
<p>Restart your webapps (Tomcat/Jetty/Resin)</p>
<h2><a name="DSpaceStatistics-Oldersettingthatarenocurrentlyutilizedinthereports"></a>Older setting that are no currently utilized in the reports</h2>
<p>Are the following Dspace.cfg fields still used by the new 1.6 Statistics? If not, we need to either document this well or remove them altogether:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
###### Statistical Report Configuration Settings ######
# should the stats be publicly available? should be set to <span class="code-keyword">false</span> <span class="code-keyword">if</span> you only
# want administrators to access the stats, or you <span class="code-keyword">do</span> not intend to generate
# any
report.<span class="code-keyword">public</span> = <span class="code-keyword">false</span>
# directory where live reports are stored
report.dir = ${dspace.dir}/reports/
</pre>
</div></div>
<p>These fields are not used by the new 1.6 Statistics, but are only related to the Statistics from previous DSpace releases</p>
</td>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td height="12" background="https://wiki.duraspace.org/images/border/border_bottom.gif"><img src="images/border/spacer.gif" width="1" height="1" border="0"/></td>
</tr>
<tr>
<td align="center"><font color="grey">Document generated by Confluence on Nov 06, 2010 19:27</font></td>
</tr>
</table>
</body>
</html>

View File

@@ -0,0 +1,38 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>DSpace Documentation : DSpace System Documentation</title>
<link rel="stylesheet" href="styles/site.css" type="text/css" />
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
<table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
<tr>
<td valign="top" class="pagebody">
<div class="pageheader">
<span class="pagetitle">
DSpace Documentation : DSpace System Documentation
</span>
</div>
<div class="pagesubheading">
This page last changed on Nov 06, 2010 by <font color="#0050B2">jtrimble</font>.
</div>
<p>The DSpace System Documentation</p>
<ul><li><a href="Preface.html" title="Preface">Preface</a></li><li><a href="Introduction.html" title="Introduction">Introduction</a></li><li><a href="Functional Overview.html" title="Functional Overview">Functional Overview</a></li><li><a href="Installation.html" title="Installation">Installation</a></li><li><a href="Upgrading a DSpace Installation.html" title="Upgrading a DSpace Installation">Upgrading a DSpace Installation</a></li><li><a href="Configuration.html" title="Configuration">Configuration</a><ul><li><a href="DSpace Statistics.html" title="DSpace Statistics">DSpace Statistics</a></li><li><a href="Embargo.html" title="Embargo">Embargo</a></li></ul></li><li><a href="JSPUI Configuration and Customization.html" title="JSPUI Configuration and Customization">JSPUI Configuration and Customization</a></li><li><a href="XMLUI Configuration and Customization.html" title="XMLUI Configuration and Customization">XMLUI Configuration and Customization</a></li><li><a href="System Administration.html" title="System Administration">System Administration</a><ul><li><a href="AipBackupRestore.html" title="AipBackupRestore">AipBackupRestore</a><ul><li><a href="DSpaceAIPFormat.html" title="DSpaceAIPFormat">DSpaceAIPFormat</a></li></ul></li></ul></li><li><a href="Storage.html" title="Storage">Storage</a></li><li><a href="Directories.html" title="Directories">Directories</a></li><li><a href="Architecture.html" title="Architecture">Architecture</a><ul><li><a href="DSpace Services Framework.html" title="DSpace Services Framework">DSpace Services Framework</a></li></ul></li><li><a href="Application.html" title="Application">Application</a></li><li><a href="Business.html" title="Business">Business</a></li><li><a href="Submission User Interface.html" title="Submission User Interface">Submission User Interface</a></li><li><a href="DRI Schema Reference.html" title="DRI Schema Reference">DRI Schema Reference</a></li><li><a href="Appendices.html" title="Appendices">Appendices</a><ul><li><a href="Appendix A.html" title="Appendix A">Appendix A</a></li></ul></li><li><a href="History.html" title="History">History</a></li></ul>
</td>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td height="12" background="https://wiki.duraspace.org/images/border/border_bottom.gif"><img src="images/border/spacer.gif" width="1" height="1" border="0"/></td>
</tr>
<tr>
<td align="center"><font color="grey">Document generated by Confluence on Nov 06, 2010 19:27</font></td>
</tr>
</table>
</body>
</html>

File diff suppressed because it is too large Load Diff

280
dspace/docs/html/Directories.html Executable file
View File

@@ -0,0 +1,280 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>DSpace Documentation : Directories</title>
<link rel="stylesheet" href="styles/site.css" type="text/css" />
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
<table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
<tr>
<td valign="top" class="pagebody">
<div class="pageheader">
<span class="pagetitle">
DSpace Documentation : Directories
</span>
</div>
<div class="pagesubheading">
This page last changed on Nov 06, 2010 by <font color="#0050B2">jtrimble</font>.
</div>
<h1><a name="Directories-DSpaceSystemDocumentation%3ADirectoriesandFiles"></a>DSpace System Documentation: Directories and Files</h1>
<h2><a name="Directories-Overview"></a>Overview</h2>
<p>A complete DSpace installation consists of three separate directory trees:</p>
<ul>
<li><b>The source directory:</b>: This is where (surprise&#33;) the source code lives. Note that the config files here are used only during the initial install process. After the install, config files should be changed in the install directory. It is referred to in this document as <em>[dspace-source]</em>.</li>
<li><b>The install directory:</b>: This directory is populated during the install process and also by DSpace as it runs. It contains config files, command-line tools (and the libraries necessary to run them), and usually&#45;<del>although not necessarily</del>&#45;the contents of the DSpace archive (depending on how DSpace is configured). After the initial build and install, changes to config files should be made in this directory. It is referred to in this document as <em>[dspace]</em>.</li>
<li><b>The web deployment directory:</b>: This directory is generated by the web server the first time it finds a dspace.war file in its webapps directory. It contains the unpacked contents of dspace.war, i.e. the JSPs and java classes and libraries necessary to run DSpace. Files in this directory should never be edited directly; if you wish to modify your DSpace installation, you should edit files in the source directory and then rebuild. The contents of this directory aren't listed here since its creation is completely automatic. It is usually referred to in this document as <em>[tomcat]/webapps/dspace</em>.</li>
</ul>
<h2><a name="Directories-SourceDirectoryLayout"></a>Source Directory Layout</h2>
<ul>
<li><em>[dspace-source]</em>
<ul>
<li><em>dspace/</em> &#45; Directory which contains all build and configuration information for DSpace
<ul>
<li><em>CHANGES</em> &#45; Detailed list of code changes between versions.</li>
<li><em>KNOWN_BUGS</em> &#45; Known bugs in the current version.</li>
<li><em>LICENSE</em> &#45; DSpace source code license.</li>
<li><em>README</em> &#45; Obligatory basic information file.</li>
<li><em>bin/</em> &#45; Some shell and Perl scripts for running DSpace command-line tasks.</li>
<li><em>config/</em> &#45; Configuration files:
<ul>
<li><em>controlled-vocabularies/</em> &#45; Fixed, limited vocabularies used in metadata entry</li>
<li><em>crosswalks/</em> &#45; Metadata crosswalks - property files or XSL stylesheets</li>
<li><em>dspace.cfg</em> &#45; The Main DSpace configuration file (You will need to edit this).</li>
<li><em>dc2mods.cfg</em> &#45; Mappings from Dublin Core metadata to <a href="http://www.loc.gov/standards/mods/" title="MODS">MODS</a> for the METS export.</li>
<li><em>default.license</em> &#45; The default license that users must grant when submitting items.</li>
<li><em>dstat.cfg</em> , <em>dstat.map</em> &#45; Configuration for statistical reports.</li>
<li><em>input-forms.xml</em> &#45; Submission UI metadata field configuration.</li>
<li><em>news-side.html</em> &#45; Text of the front-page news in the sidebar, only used in JSPUI.</li>
<li><em>news-top.html</em> &#45; Text of the front-page news in the top box, only used in teh JSPUI.</li>
<li><em>emails/</em> &#45; Text and layout templates for emails sent out by the system.</li>
<li><em>registries/</em> &#45; <b>Initial</b> contents of the bitstream format registry and Dublin Core element/qualifier registry. These are only used on initial system setup, after which they are maintained in the database.</li>
</ul>
</li>
<li><em>docs/</em> &#45; DSpace system documentation. The technical documentation for functionality, installation, configuration, etc.</li>
<li><em>etc/</em> &#45;<br/>
This directory contains administrative files needed for the install process and by developers, mostly database initialization and upgrade scripts. Any <em>.xml</em> files in <em>etc/</em> are common to all supported database systems.
<ul>
<li><em>postgres/</em> &#45; Versions of the database schema and updater SQL scripts for PostgreSQL.</li>
<li><em>oracle/</em> &#45; Versions of the database schema and updater SQL scripts for Oracle.</li>
</ul>
</li>
<li><em>modules/</em> &#45; The Web UI modules "overlay" directory. DSpace uses Maven to automatically look here for any customizations you wish to make to DSpace Web interfaces.
<ul>
<li><em>jspui</em> &#45; Contains all customizations for the JSP User Interface.
<ul>
<li><em>src/main/resources/</em> &#45; The overlay for JSPUI <em>Resources.</em> This is the location to place any custom Messages.properties files. <em>(Previously this file had been stored at: &#95;[dspace-source]/config/language-packs/Messages.properties</em>_</li>
<li><em>src/main/webapp/</em> &#45; The overlay for JSPUI Web Application. This is the location to place any custom JSPs to be used by DSpace.</li>
</ul>
</li>
<li><em>lni</em> &#45; Contains all customizations for the Lightweight Network Interface.</li>
<li><em>oai</em> &#45; Contains all customizations for the OAI-PMH Interface.</li>
<li><em>sword</em> &#45; Contains all customizations for the SWORD (Simple Web-service Offering Repository Deposit) Interface.</li>
<li><em>xmlui</em> &#45; Contains all customizations for the XML User Interface (aka Manakin).
<ul>
<li><em>src/main/webapp/</em> &#45; The overlay for XMLUI Web Application. This is the location to place custom Themes or Configurations.
<ul>
<li><em>i18n/</em> &#45; The location to place a custom version of the XMLUI's messages.xml (You have to manually create this folder)</li>
<li><em>themes/</em> &#45; The location to place custom Themes for the XMLUI (You have to manually create this folder).</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li><em>src/</em> &#45; Maven configurations for DSpace System. This directory contains the Maven and Ant build files for DSpace.</li>
<li><em>target/</em> &#45; (Only exists after building DSpace) This is the location Maven uses to build your DSpace installation package.
<ul>
<li><em>dspace-[version].dir</em> &#45; The location of the DSpace Installation Package (which can then be installed by running <em>ant update</em>)</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h2><a name="Directories-InstalledDirectoryLayout"></a>Installed Directory Layout</h2>
<p>Below is the basic layout of a DSpace installation using the default configuration. These paths can be configured if necessary.</p>
<ul>
<li><em>[dspace]</em>
<ul>
<li><em>assetstore/</em> &#45; asset store files</li>
<li><em>bin/</em> &#45; shell and Perl scripts</li>
<li><em>config/</em> &#45; configuration, with sub-directories as above</li>
<li><em>handle-server/</em> &#45; Handles server files</li>
<li><em>history/</em> &#45; stored history files (generally RDF/XML)</li>
<li><em>lib/</em> &#45; JARs, including dspace.jar, containing the DSpace classes</li>
<li><em>log/</em> &#45; Log files</li>
<li><em>reports/</em> &#45; Reports generated by statistical report generator</li>
<li><em>search/</em> &#45; Lucene search index files</li>
<li><em>upload/</em> &#45; temporary directory used during file uploads etc.</li>
<li><em>webapps/</em> &#45; location where DSpace installs all Web Applications</li>
</ul>
</li>
</ul>
<h2><a name="Directories-ContentsofJSPUIWebApplication"></a>Contents of JSPUI Web Application</h2>
<p>DSpace's Ant build file creates a <em>dspace-jspui-webapp/</em> directory with the following structure:</p>
<ul>
<li>(top level dir)
<ul>
<li>The JSPs</li>
<li><em>WEB-INF/</em>
<ul>
<li><em>web.xml</em> &#45; DSpace JSPUI Web Application configuration and Servlet mappings</li>
<li><em>dspace-tags.tld</em> &#45; DSpace custom tag descriptor</li>
<li><em>fmt.tld</em> &#45; JSTL message format tag descriptor, for internationalization</li>
<li><em>lib/</em> &#45; All the third-party JARs and pre-compiled DSpace API JARs needed to run JSPUI</li>
<li><em>classes/</em> &#45; Any additional necessary class files</li>
</ul>
</li>
</ul>
</li>
</ul>
<h2><a name="Directories-ContentsofXMLUIWebApplication%28akaManakin%29"></a>Contents of XMLUI Web Application (aka Manakin)</h2>
<p>DSpace's Ant build file creates a <em>dspace-xmlui-webapp/</em> directory with the following structure:</p>
<ul>
<li>(top level dir)
<ul>
<li><em>aspects/</em> &#45; Contains overarching Aspect Generator config and Prototype DRI (Digital Repository Interface) document for Manakin.</li>
<li><em>i18n/</em> &#45; Internationalization / Multilingual support. Contains the <em>messages.xml</em> English language pack by default.</li>
<li><em>themes/</em> &#45; Contains all out-of-the-box Manakin themes
<ul>
<li><em>Classic/</em> &#45; The classic theme, which makes the XMLUI look like classic DSpace</li>
<li><em>dri2xhtml/</em> &#45; The base theme, which converts XMLUI DRI (Digital Repository Interface) format into XHTML for display</li>
<li><em>Reference/</em> &#45; The default reference theme for XMLUI</li>
<li><em>template/</em> &#45; A theme template...useful as a starting point for your own custom theme(s)</li>
<li><em>dri2xhtml.xsl</em> &#45; The DRI-to-XHTML XSL Stylesheet. Uses the above 'dri2xhtml' theme to generate XHTML</li>
<li><em>themes.xmap</em> &#45; The Theme configuration file. It determines which theme(s) are used by XMLUI</li>
</ul>
</li>
<li><em>WEB-INF/</em>
<ul>
<li><em>lib/</em> &#45; All the third-party JARs and pre-compiled DSpace JARs needed to run XMLUI</li>
<li><em>classes/</em> &#45; Any additional necessary class files</li>
<li><em>cocoon.xconf</em> &#45; XMLUI's Apache Cocoon configuration</li>
<li><em>logkit.xconf</em> &#45; XMLUI's Apache Cocoon Logging configuration</li>
<li><em>web.xml</em> &#45; XMLUI Web Application configuration and Servlet mappings</li>
</ul>
</li>
</ul>
</li>
</ul>
<h2><a name="Directories-LogFiles"></a>Log Files</h2>
<p>The first source of potential confusion is the log files. Since DSpace uses a number of third-party tools, problems can occur in a variety of places. Below is a table listing the main log files used in a typical DSpace setup. The locations given are defaults, and might be different for your system depending on where you installed DSpace and the third-party tools. The ordering of the list is roughly the recommended order for searching them for the details about a particular problem or error.</p>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'> <b>Log File</b> </td>
<td class='confluenceTd'> <b>What's In It</b> </td>
</tr>
<tr>
<td class='confluenceTd'> <em>[dspace]/log/dspace.log</em> </td>
<td class='confluenceTd'> Main DSpace log file. This is where the DSpace code writes a simple log of events and errors that occur within the DSpace code. You can control the verbosity of this by editing the <em>[dspace-source]/config/templates/log4j.properties</em> file and then running "<em>ant init_configs</em>". </td>
</tr>
<tr>
<td class='confluenceTd'> <em>[tomcat]/logs/catalina.out</em> </td>
<td class='confluenceTd'> This is where Tomcat's standard output is written. Many errors that occur within the Tomcat code are logged here. For example, if Tomcat can't find the DSpace code (<em>dspace.jar</em>), it would be logged in <em>catalina.out</em>. </td>
</tr>
<tr>
<td class='confluenceTd'> <em>[tomcat]/logs/hostname_log.yyyy-mm-dd.txt</em> </td>
<td class='confluenceTd'> If you're running Tomcat stand-alone (without Apache), it logs some information and errors for specific Web applications to this log file. <em>hostname</em> will be your host name (e.g. <em>dspace.myu.edu</em>) and <em>yyyy-mm-dd</em> will be the date. </td>
</tr>
<tr>
<td class='confluenceTd'> <em>[tomcat]/logs/apache_log.yyyy-mm-dd.txt</em> </td>
<td class='confluenceTd'> If you're using Apache, Tomcat logs information about Web applications running through Apache (<em>mod_webapp</em>) in this log file (<em>yyyy-mm-dd</em> being the date.) </td>
</tr>
<tr>
<td class='confluenceTd'> <em>[apache]/error_log</em> </td>
<td class='confluenceTd'> Apache logs to this file. If there is a problem with getting <em>mod_webapp</em> working, this is a good place to look for clues. Apache also writes to several other log files, though <em>error_log</em> tends to contain the most useful information for tracking down problems. </td>
</tr>
<tr>
<td class='confluenceTd'> <em>[dspace]/log/handle-plug.log</em> </td>
<td class='confluenceTd'> The Handle server runs as a separate process from the DSpace Web UI (which runs under Tomcat's JVM). Due to a limitation of log4j's 'rolling file appenders', the DSpace code running in the Handle server's JVM must use a separate log file. The DSpace code that is run as part of a Handle resolution request writes log information to this file. You can control the verbosity of this by editing <em>[dspace-source]/config/templates/log4j-handle-plugin.properties</em>. </td>
</tr>
<tr>
<td class='confluenceTd'> <em>[dspace]/log/handle-server.log</em> </td>
<td class='confluenceTd'> This is the log file for CNRI's Handle server code. If a problem occurs within the Handle server code, before DSpace's plug-in is invoked, this is where it may be logged. </td>
</tr>
<tr>
<td class='confluenceTd'> <em>[dspace]/handle-server/error.log</em> </td>
<td class='confluenceTd'> On the other hand, a problem with CNRI's Handle server code might be logged here. </td>
</tr>
<tr>
<td class='confluenceTd'> <em>PostgreSQL log</em> </td>
<td class='confluenceTd'> PostgreSQL also writes a log file. This one doesn't seem to have a default location, you probably had to specify it yourself at some point during installation. In general, this log file rarely contains pertinent information--PostgreSQL is pretty stable, you're more likely to encounter problems with connecting via JDBC, and these problems will be logged in <em>dspace.log</em>. </td>
</tr>
</tbody></table>
</div>
<h3><a name="Directories-log4j.propertiesFile."></a>log4j.properties File.</h3>
<p>the file <em>[dspace]/config/log4j.properties</em> controls how and where log files are created. There are three sets of configurations in that file, called A1, A2, and A3. These are used to control the logs for DSpace, the checksum checker, and the XMLUI respectively. The important settings in this file are:</p>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">log4j.rootCategory=INFO,A
log4j.logger.org.dspace=INFO,A1</pre>
</div></div> </td>
<td class='confluenceTd'> These lines control what level of logging takes place. Normally they should be set to INFO, but if you need to see more information in the logs, set them to dEBUG and restart your web server </td>
</tr>
<tr>
<td class='confluenceTd'> <em>log4j.appender.A1=org.dspace.app.util.DailyFileAppender</em> </td>
<td class='confluenceTd'> This is the name of the log file creation method used. The DailyFileAppender creates a new date-stamped file every day or month. </td>
</tr>
<tr>
<td class='confluenceTd'> <em>log4j.appender.A1.File=${log.dir}/dspace.log</em> </td>
<td class='confluenceTd'> This sets the filename and location of where the log file will be stored. It iwll have a date stamp appended to the file name. </td>
</tr>
<tr>
<td class='confluenceTd'> <em>log4j.appender.A1.DatePattern=yyy-MM-DD</em> </td>
<td class='confluenceTd'> This defines the format for the date stamp that is appended to the log file names. If you wish to have log files created monthyl instead of daily, change this to <em>yyyy-MM</em> </td>
</tr>
<tr>
<td class='confluenceTd'> <em>log4j.appender.A1.MaxLogs=0</em> </td>
<td class='confluenceTd'> This defines how many log files will be created. You may wish to define a retention period for log files. If you set this to 365, logs older than a year will be deleted. By default this is set to 0 so that no logs are ever deleted. Ensure that you monitor the disk space used by the logs to make sure that you have enough space for them. It is often important to keep the log files for a long time in case you want to rebuild your statistics. </td>
</tr>
</tbody></table>
</div>
</td>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td height="12" background="https://wiki.duraspace.org/images/border/border_bottom.gif"><img src="images/border/spacer.gif" width="1" height="1" border="0"/></td>
</tr>
<tr>
<td align="center"><font color="grey">Document generated by Confluence on Nov 06, 2010 19:27</font></td>
</tr>
</table>
</body>
</html>

145
dspace/docs/html/Embargo.html Executable file
View File

@@ -0,0 +1,145 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>DSpace Documentation : Embargo</title>
<link rel="stylesheet" href="styles/site.css" type="text/css" />
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
<table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
<tr>
<td valign="top" class="pagebody">
<div class="pageheader">
<span class="pagetitle">
DSpace Documentation : Embargo
</span>
</div>
<div class="pagesubheading">
This page last changed on Nov 06, 2010 by <font color="#0050B2">jtrimble</font>.
</div>
<h1><a name="Embargo-EmbargoSupportinDSpace1.6"></a>Embargo Support in DSpace 1.6</h1>
<h2><a name="Embargo-Whatisanembargo%3F"></a>What is an embargo?</h2>
<p>An embargo is a temporary access restriction placed on content, commencing at time of accession. It's 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 or Collections, Bitstreams, etc. The embargo functionally introduced in 1.6, however, includes tools to automate the imposition and removal of restrictions in managed timeframes.</p>
<h3><a name="Embargo-Embargomodelandlifecycle"></a>Embargo model and life-cycle</h3>
<p>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:</p>
<p>"2020-09-12" - an absolute date (i.e. the date embargo will be lifted)<br/>
"6 months" - a time relative to when the item is accessioned<br/>
"forever" - an indefinite, or open-ended embargo<br/>
"local only until 2015" - both a time and an exception (public has no access until 2015, local users OK immediately)<br/>
"Nature Publishing Group standard" - look-up to a policy somewhere (typically 6 months)</p>
<p>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 in 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 and 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:</p>
<h4><a name="Embargo-Termsassignment"></a>Terms assignment</h4>
<p>The first step in placing an embargo on an item is to attach (assign) 'terms' to it.<br/>
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 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.</p>
<h4><a name="Embargo-Termsinterpretation%2Fimposition"></a>Terms interpretation/imposition</h4>
<p>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 section V. 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'.</p>
<h4><a name="Embargo-Embargoperiod"></a>Embargo period</h4>
<p>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' is past. Note that this means the effective removal of an embargo is <b>not</b> the lift date, but 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, they can do so. Thus, they can 'revise' the lift date without reference to the original terms. This date will be checked the next<br/>
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.</p>
<h4><a name="Embargo-Embargolift"></a>Embargo lift</h4>
<p>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<br/>
<b>that would have been added</b> had the embargo not been imposed. That is, it replicates the standard DSpace behavior, in which an item inherits it's 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 section V. below). You may wish, e.g. to send an email to an administrator or other interested parties, when an embargoed item becomes available.</p>
<h4><a name="Embargo-Postembargo"></a>Post embargo</h4>
<p>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, they are indistinguishable from items that were never subject to embargo.</p>
<h3><a name="Embargo-Configuration"></a>Configuration</h3>
<p>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 specify exactly what field you want the embargo system to examine when it needs to find the terms or assign the lift date.</p>
<p>The properties that specify these assignments live in dspace.cfg:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"># DC metadata field to hold the user-supplied embargo terms
embargo.field.terms = SCHEMA.ELEMENT.QUALIFIER}}
# DC metadata field to hold computed <span class="code-quote">"lift date"</span> of embargo
embargo.field.lift = SCHEMA.ELEMENT.QUALIFIER
</pre>
</div></div>
<p>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' ,<br/>
this is the only configuration required, except as noted below.</p>
<p>There is also a property for the special date of 'forever':</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"># string in terms field to indicate indefinite embargo
embargo.terms.open = forever
</pre>
</div></div>
<p>which you may change to suit linguistic or other preference.</p>
<p>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 <b>not</b> 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.</p>
<p>Key recommendations:</p>
<ol>
<li>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.</li>
<li>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.</li>
<li>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 <b>until</b> the application. Thus you may want to consider configuring both the 'terms' and 'lift date' to use the same metadata field. In this way,<br/>
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.</li>
</ol>
<h3><a name="Embargo-Operation"></a>Operation</h3>
<p>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.<br/>
The lifter is available as a target of the 1.6 DSpace launcher - see launcher documentation for details.</p>
<h3><a name="Embargo-Extendingembargofunctionality"></a>Extending embargo functionality</h3>
<p>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.</p>
<h4><a name="Embargo-Setter"></a>Setter</h4>
<p>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:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"># implementation of embargo setter plugin - replace with local implementation <span class="code-keyword">if</span> applicable
plugin.single.org.dspace.embargo.EmbargoSetter = org.dspace.embargo.DefaultEmbargoSetter
</pre>
</div></div>
<p>controls which setter to use.</p>
<h4><a name="Embargo-Lifter"></a>Lifter</h4>
<p>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:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"># implementation of embargo lifter plugin - - replace with local implementation <span class="code-keyword">if</span> applicable
plugin.single.org.dspace.embargo.EmbargoLifter = org.dspace.embargo.DefaultEmbargoLifter
</pre>
</div></div>
</td>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td height="12" background="https://wiki.duraspace.org/images/border/border_bottom.gif"><img src="images/border/spacer.gif" width="1" height="1" border="0"/></td>
</tr>
<tr>
<td align="center"><font color="grey">Document generated by Confluence on Nov 06, 2010 19:27</font></td>
</tr>
</table>
</body>
</html>

View File

@@ -0,0 +1,661 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>DSpace Documentation : Functional Overview</title>
<link rel="stylesheet" href="styles/site.css" type="text/css" />
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
<table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
<tr>
<td valign="top" class="pagebody">
<div class="pageheader">
<span class="pagetitle">
DSpace Documentation : Functional Overview
</span>
</div>
<div class="pagesubheading">
This page last changed on Nov 06, 2010 by <font color="#0050B2">jtrimble</font>.
</div>
<h1><a name="FunctionalOverview-DSpaceSystemDocumentation%3AFunctionalOverview"></a>DSpace System Documentation: Functional Overview</h1>
<p>The following sections describe the various functional aspects of the DSpace system.</p>
<h2><a name="FunctionalOverview-DataModel"></a>Data Model</h2>
<p><span class="image-wrap" style=""><img src="attachments/22022823/21954865.gif" style="border: 0px solid black"/></span></p>
<p>Data Model Diagram</p>
<p>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 <em>communities</em>, which can be further divided into <em>sub-communities</em> reflecting the typical university structure of college, departement, research center, or laboratory.</p>
<p>Communities contain <em>collections</em>, which are groupings of related content. A collection may appear in more than one community.</p>
<p>Each collection is composed of <em>items</em>, 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.</p>
<p>Items are further subdivided into named <em>bundles</em> of <em>bitstreams</em>. 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 organised into bundles.</p>
<p>In practice, most items tend to have these named bundles:</p>
<ul>
<li><em>ORIGINAL</em> &#8211; the bundle with the original, deposited bitstreams</li>
<li><em>THUMBNAILS</em> &#8211; thumbnails of any image bitstreams</li>
<li><em>TEXT</em> &#8211; extracted full-text from bitstreams in ORIGINAL, for indexing</li>
<li><em>LICENSE</em> &#8211; contains the deposit license that the submitter granted the host organization; in other words, specifies the rights that the hosting organization have</li>
<li><em>CC_LICENSE</em> &#8211; contains the distribution license, if any (a <a href="http://www.creativecommons.org" title="Creative Commons">Creative Commons</a> license) associated with the item. This license specifies what end users downloading the content can do with the content<br/>
Each bitstream is associated with one <em>Bitstream Format</em>. 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, <em>application/ms-word</em> and <em>.doc</em> span multiple versions of the Microsoft Word application, each of which produces bitstreams with presumably different characteristics.</li>
</ul>
<p>Each bitstream format additionally has a <em>support level</em>, 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:</p>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'> <b>Supported</b> </td>
<td class='confluenceTd'> The format is recognized, and the hosting institution is confident it can make bitstreams of this format useable in the future, using whatever combination of techniques (such as migration, emulation, etc.) is appropriate given the context of need. </td>
</tr>
<tr>
<td class='confluenceTd'> <b>Known</b> </td>
<td class='confluenceTd'> The format is recognized, and the hosting institution will promise to preserve the bitstream as-is, 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. </td>
</tr>
<tr>
<td class='confluenceTd'> <b>Unsupported</b> </td>
<td class='confluenceTd'> The format is unrecognized, but the hosting institution will undertake to preserve the bitstream as-is and allow it to be retrieved. </td>
</tr>
</tbody></table>
</div>
<p>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.</p>
<p>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.</p>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'> <b>Object</b> </td>
<td class='confluenceTd'> <b>Example</b> </td>
</tr>
<tr>
<td class='confluenceTd'> Community </td>
<td class='confluenceTd'> Laboratory of Computer Science; Oceanographic Research Center </td>
</tr>
<tr>
<td class='confluenceTd'> Collection </td>
<td class='confluenceTd'> LCS Technical Reports; ORC Statistical Data Sets </td>
</tr>
<tr>
<td class='confluenceTd'> Item </td>
<td class='confluenceTd'> A technical report; a data set with accompanying description; a video recording of a lecture </td>
</tr>
<tr>
<td class='confluenceTd'> Bundle </td>
<td class='confluenceTd'> A group of HTML and image bitstreams making up an HTML document </td>
</tr>
<tr>
<td class='confluenceTd'> Bitstream </td>
<td class='confluenceTd'> A single HTML file; a single image file; a source code file </td>
</tr>
<tr>
<td class='confluenceTd'> Bitstream Format </td>
<td class='confluenceTd'> Microsoft Word version 6.0; JPEG encoded image format </td>
</tr>
</tbody></table>
</div>
<h2><a name="FunctionalOverview-PluginManager"></a>Plugin Manager</h2>
<p>The PluginManager is a very simple component container. It creates and organizes components (plugins), and helps select a plugin in the cases where there are many possible choices. It also gives some limited control over the lifecycle of a plugin.</p>
<p>A plugin is defined by a Java interface. The consumer of a plugin asks for its plugin by interface. A Plugin is an instance of any class that implements the plugin interface. It is interchangeable with other implementations, so that any of them may be "plugged in".</p>
<p>The mediafilter is a simple example of a plugin implementation. Refer to the Business Logic Layer for more details on Plugins.</p>
<h2><a name="FunctionalOverview-Metadata"></a>Metadata</h2>
<p>Broadly speaking, DSpace holds three sorts of metadata about archived content:</p>
<ul>
<li><b>Descriptive Metadata</b>: DSpace can support multiple flat metadata schemas for describing an item.A qualified Dublin Core metadata schema loosely based on the <a href="http://www.dublincore.org/documents/library-application-profile/" title="Library Application Profile">Library Application Profile</a> set of elements and qualifiers is provided by default. The <a href="http://dspace.org/technology/metadata.html" title="set of elements and qualifiers used by MIT Libraries">set of elements and qualifiers used by MIT Libraries</a> comes pre-configured with the DSpace source code. 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. <em>Communities</em> and <em>collections</em> have some simple descriptive metadata (a name, and some descriptive prose), held in the DBMS.</li>
<li><b>Administrative Metadata</b>: This includes preservation metadata, provenance and authorization policy data. Most of this is held within DSpace's relation 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.</li>
<li><b>Structural Metadata</b>: 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 <em>primary bitstream</em>. 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, bitstreams also have 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.</li>
</ul>
<h2><a name="FunctionalOverview-PackagerPlugins"></a>Packager Plugins</h2>
<p><em>Packagers</em> are software modules that translate between DSpace Item objects and a self-contained external representation, or "package". A <em>Package Ingester</em> interprets, or <em>ingests</em>, the package and creates an Item. A <em>Package Disseminator</em> writes out the contents of an Item in the package format.</p>
<p>A package is typically an archive file such as a Zip or "tar" file, including a <em>manifest</em> document which contains metadata and a description of the package contents. The <a href="http://www.imsglobal.org/content/packaging/" title="IMS Content Package">IMS Content Package</a> 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.</p>
<p>Package ingesters and package disseminators are each a type of named plugin (see <a href="#FunctionalOverview-PluginManager">Plugin Manager</a>), 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.</p>
<p>Most packager plugins call upon <a href="#FunctionalOverview-CrosswalkPlugins">Crosswalk Plugins</a> to translate the metadata between DSpace's object model and the package format.</p>
<p>More information about calling Packagers to ingest or disseminate content can be found in the <a href="System Administration.html#SystemAdministration-PackageImporterandExporter">Package Importer and Exporter</a> section of the System Administration documentation.</p>
<h2><a name="FunctionalOverview-CrosswalkPlugins"></a>Crosswalk Plugins</h2>
<p><em>Crosswalks</em> are software modules that translate between DSpace object metadata and a specific external representation. An <em>Ingestion Crosswalk</em> interprets the external format and crosswalks it to DSpace's internal data structure, while a <em>Dissemination Crosswalk</em> does the opposite.</p>
<p>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.</p>
<p>Crosswalk plugins are named plugins (see <a href="#FunctionalOverview-PluginManager">Plugin Manager</a>), 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.</p>
<p>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.</p>
<p>The Packager plugins and OAH-PMH server make use of crosswalk plugins.</p>
<h2><a name="FunctionalOverview-EPeopleandGroups"></a>E-People and Groups</h2>
<p>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.</p>
<h3><a name="FunctionalOverview-EPerson"></a>E-Person</h3>
<p>DSpace hold the following information about each e-person:</p>
<ul>
<li>E-mail address</li>
<li>First and last names</li>
<li>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;</li>
<li>A password (encrypted), if appropriate</li>
<li>A list of collections for which the e-person wishes to be notified of new items</li>
<li>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.</li>
<li>The network ID for the corresponding LDAP record</li>
</ul>
<h3><a name="FunctionalOverview-Groups"></a>Groups</h3>
<p>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.</p>
<p>However, an application session can be assigned membership in a group <em>without</em> being identified as an E-Person. 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 corresonding privileges.</p>
<p>Administrators can also use groups as "roles" to manage the granting of privileges more efficiently.</p>
<h2><a name="FunctionalOverview-Authentication"></a>Authentication</h2>
<p><em>Authentication</em> is when an application session positively identifies itself as belonging to an E-Person and/or Group. In DSpace 1.4, it is implemented by a mechanism called <em>Stackable Authentication</em>: 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:</p>
<ul>
<li>Separates authentication from the Web user interface so the same authentication methods are used for other applications such as non-interactive Web Services</li>
<li>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.</li>
<li>Cleaner support for "implicit" authentication where username is found in the environment of a Web request, e.g. in an X.509 client certificate.</li>
</ul>
<h2><a name="FunctionalOverview-Authorization"></a>Authorization</h2>
<p>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 special 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.</p>
<p>The following actions are possible:</p>
<p><b>Collection</b></p>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'> ADD/REMOVE </td>
<td class='confluenceTd'> add or remove items (ADD = permission to submit items) </td>
</tr>
<tr>
<td class='confluenceTd'> DEFAULT_ITEM_READ </td>
<td class='confluenceTd'> inherited as READ by all submitted items </td>
</tr>
<tr>
<td class='confluenceTd'> DEFAULT_BITSTREAM_READ </td>
<td class='confluenceTd'> 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 <em>not</em> get the same default read policy. </td>
</tr>
<tr>
<td class='confluenceTd'> COLLECTION_ADMIN </td>
<td class='confluenceTd'> collection admins can edit items in a collection, withdraw items, map other items into this collection. </td>
</tr>
</tbody></table>
</div>
<p><b>Item</b></p>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'> ADD/REMOVE </td>
<td class='confluenceTd'> add or remove bundles </td>
</tr>
<tr>
<td class='confluenceTd'> READ </td>
<td class='confluenceTd'> can view item (item metadata is always viewable) </td>
</tr>
<tr>
<td class='confluenceTd'> WRITE </td>
<td class='confluenceTd'> can modify item </td>
</tr>
</tbody></table>
</div>
<p><b>Bundle</b></p>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'> ADD/REMOVE </td>
<td class='confluenceTd'> add or remove bitstreams to a bundle </td>
</tr>
</tbody></table>
</div>
<p><b>Bitstream</b></p>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'> READ </td>
<td class='confluenceTd'> view bitstream </td>
</tr>
<tr>
<td class='confluenceTd'> WRITE </td>
<td class='confluenceTd'> modify bitstream </td>
</tr>
</tbody></table>
</div>
<p>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.</p>
<p>Policies can apply to individual e-people or groups of e-people.</p>
<h2><a name="FunctionalOverview-IngestProcessandWorkflow"></a>Ingest Process and Workflow</h2>
<p>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.</p>
<p><span class="image-wrap" style=""><img src="attachments/22022823/21954864.gif" style="border: 0px solid black"/></span></p>
<p>DSpace Ingest Process</p>
<p>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.</p>
<p>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.</p>
<p>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.</p>
<p>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:</p>
<ul>
<li>Assigns an accession date</li>
<li>Adds a "date.available" value to the Dublin Core metadata record of the item</li>
<li>Adds an issue date if none already present</li>
<li>Adds a provenance message (including bitstream checksums)</li>
<li>Assigns a Handle persistent identifier</li>
<li>Adds the item to the target collection, and adds appropriate authorization policies</li>
<li>Adds the new item to the search and browse indices</li>
</ul>
<h3><a name="FunctionalOverview-WorkflowSteps"></a>Workflow Steps</h3>
<p>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 e-person groups associated with any step, submissions to that collection are installed straight into the main archive.</p>
<p>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.</p>
<p>When a step is invoked, the task of performing that workflow step put in the 'task pool' of the 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.</p>
<p>The member of the group who has taken the task from the pool may then perform one of three actions:</p>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'> <b>Workflow Step</b> </td>
<td class='confluenceTd'> <b>Possible actions</b> </td>
</tr>
<tr>
<td class='confluenceTd'> 1 </td>
<td class='confluenceTd'> Can accept submission for inclusion, or reject submission. </td>
</tr>
<tr>
<td class='confluenceTd'> 2 </td>
<td class='confluenceTd'> Can edit metadata provided by the user with the submission, but cannot change the submitted files. Can accept submission for inclusion, or reject submission. </td>
</tr>
<tr>
<td class='confluenceTd'> 3 </td>
<td class='confluenceTd'> 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. </td>
</tr>
</tbody></table>
</div>
<p><span class="image-wrap" style=""><img src="attachments/22022823/21954863.gif" style="border: 0px solid black"/></span></p>
<p><b>Submission Workflow in DSpace</b></p>
<p>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 re-submit, whereupon the process starts again.</p>
<p>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.</p>
<p>One last possibility is that a workflow can be 'aborted' by a DSpace site administrator. This is accomplished using the administration UI.</p>
<p>The reason for this apparently arbitrary design is that is was the simplist 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.</p>
<h2><a name="FunctionalOverview-SupervisionandCollaboration"></a>Supervision and Collaboration</h2>
<p>In order to facilitate, as a primary objective, the opportunity for thesis authors to be supervised in the preparation of their e-thesis, 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:</p>
<ul>
<li>Full editorial control</li>
<li>View item contents</li>
<li>No policies<br/>
Once the default set has been applied, a system administrator may modify them as they would any other policy set in DSpace</li>
</ul>
<p>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.</p>
<h2><a name="FunctionalOverview-Handles"></a>Handles</h2>
<p>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 long term. To help solve this problem, a core DSpace feature is the creation of persistent identifier for every item, collection and community stored in DSpace. To persist identifier, DSpace requires a storage&#45; and location&#45; independent mechanism for creating and maintaining identifiers. DSpace uses the <a href="http://www.handle.net/" title="CNRI Handle System">CNRI Handle System</a> for creating these identifiers. The rest of this section assumes a basic familiarity with the Handle system.</p>
<p>DSpace uses Handles primarily as a means of assigning globally unique identifiers to objects. Each site running DSpace needs to obtain a Handle 'prefix' from CNRI, so we know that if we create identifiers with that prefix, they won't clash with identifiers created elsewhere.</p>
<p>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 <em>item</em> 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.</p>
<p>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.</p>
<p>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.</p>
<p>Handles can be written in two forms:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">hdl:1721.123/4567
http:<span class="code-comment">//hdl.handle.net/1721.123/4567</span>
</pre>
</div></div>
<p>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 <a href="http://www.handle.net/resolver/index.html" title="CNRI's Handle Resolver plug-in">CNRI's Handle Resolver plug-in</a>, 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.</p>
<p>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.</p>
<h2><a name="FunctionalOverview-Bitstream%27Persistent%27Identifiers"></a>Bitstream 'Persistent' Identifiers</h2>
<p>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 organizaion, 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.</p>
<p>Each bitstream has a sequence ID, unique within an item. This sequence ID is used to create a persistent ID, of the form:</p>
<p><em>dspace url/bitstream/handle/sequence ID/filename</em></p>
<p>For example:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">https:<span class="code-comment">//dspace.myu.edu/bitstream/123.456/789/24/foo.html</span>
</pre>
</div></div>
<p>The above refers to the bitstream with sequence ID 24 in the item with the Handle <em>hdl:123.456/789</em>. The <em>foo.html</em> 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.</p>
<h2><a name="FunctionalOverview-StorageResourceBroker%28SRB%29Support"></a>Storage Resource Broker (SRB) Support</h2>
<p>DSpace offers two means for storing bitstreams. The first is in the file system on the server. The second is using <a href="http://www.sdsc.edu/srb" title="SRB (Storage Resource Broker)">SRB (Storage Resource Broker)</a>. Both are achieved using a simple, lightweight API.</p>
<p>SRB is purely an option but may be used in lieu of the server's file system or in addition to the file system. Without going into a full description, SRB is a very robust, sophisticated storage manager that offers essentially unlimited storage and straightforward means to replicate (in simple terms, backup) the content on other local or remote storage resources.</p>
<h2><a name="FunctionalOverview-SearchandBrowse"></a>Search and Browse</h2>
<p>DSpace allows end-users to discover content in a number of ways, including:</p>
<ul>
<li>Via external reference, such as a Handle</li>
<li>Searching for one or more keywords in metadata or extracted full-text</li>
<li>Browsing though title, author, date or subject indices, with optional image thumbnails<br/>
Search is an essential component of discovery in DSpace. Users' expectations from a search engine are quite high, so a goal for DSpace is to supply as many search features as possible. DSpace's indexing and search module has a very simple API which allows for indexing new content, regenerating the index, and performing searches on the entire corpus, a community, or collection. Behind the API is the Java freeware search engine <a href="http://jakarta.apache.org/lucene/" title="Lucene">Lucene</a>. Lucene gives us fielded searching, stop word removal, stemming, and the ability to incrementally add new indexed content without regenerating the entire index. The specific Lucene search indexes are configurable enabling institutions to customize which DSpace metadata fields are indexed.</li>
</ul>
<p>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.</p>
<h2><a name="FunctionalOverview-HTMLSupport"></a>HTML Support</h2>
<p>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 &#8211; 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:</p>
<ul>
<li>Web pages tend to consist of several files &#8211; one or more HTML files that contain references to each other, and stylesheets and image files that are referenced by the HTML files.</li>
<li>Web pages also link to or include content from other sites, often imperceptably 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.</li>
<li>Often Web pages are produced dynamically by software running on the Web server, and represent the state of a changing database underneath it.<br/>
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 <em>self-contained, non-dynamic</em> HTML documents. In practical terms, this means:</li>
</ul>
<ul>
<li>No dynamic content (CGI scripts and so forth)</li>
<li>All links to preserved content must be <em>relative links</em>, that do not refer to 'parents' above the 'root' of the HTML document/site:
<ul>
<li><em>diagram.gif</em> is OK</li>
<li><em>image/foo.gif</em> is OK</li>
<li><em>../index.html</em> is only OK in a file that is at least a directory deep in the HTML document/site hierarchy</li>
<li><em>/stylesheet.css</em> is not OK (the link will break)</li>
<li>_<a href="http://somedomain.com/content.html_">http://somedomain.com/content.html&#95;</a> is not OK (the link will continue to link to the external site which may change or disappear)</li>
</ul>
</li>
<li>Any 'absolute links' (e.g. _<a href="http://somedomain.com/content.html_">http://somedomain.com/content.html&#95;</a>) 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 refered to by the absolute link may change or disappear.</li>
</ul>
<h2><a name="FunctionalOverview-OAISupport"></a>OAI Support</h2>
<p>The <a href="http://www.openarchives.org/" title="Open Archives Initiative">Open Archives Initiative</a> has developed a <a href="http://www.openarchives.org/OAI/openarchivesprotocol.html" title="protocol for metadata harvesting">protocol for metadata harvesting</a>. 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.</p>
<p>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 <a href="http://www.oclc.org/research/software/oai/cat.shtm" title="OAICat">OAICat</a> framework is used to provide this functionality.</p>
<p>You can also configure the OAI service to make use of any crosswalk plugin to offer additional metadata formats, such as MODS.</p>
<p>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.</p>
<h2><a name="FunctionalOverview-OpenURLSupport"></a>OpenURL Support</h2>
<p>DSpace supports the <a href="http://www.sfxit.com/OpenURL/" title="OpenURL protocol">OpenURL protocol</a> from <a href="http://www.sfxit.com/" title="SFX">SFX</a>, 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.</p>
<h2><a name="FunctionalOverview-CreativeCommonsSupport"></a>Creative Commons Support</h2>
<p>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 <a href="http://creativecommons.org" title="their website">their website</a>. Support for the licenses is controlled by a site-wide configuration option, and since license selection involves redirection to 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 elect to skip Creative Commons licensing. If a selection is made a copy of the license text and RDF metadata 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.</p>
<h2><a name="FunctionalOverview-Subscriptions"></a>Subscriptions</h2>
<p>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.</p>
<h2><a name="FunctionalOverview-ImportandExport"></a>Import and Export</h2>
<p>DSpace also includes batch tools to import and 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.</p>
<p>There is also a METS-based export tool, which exports items as METS-based metadata with associated bitstreams referenced from the METS file.</p>
<h2><a name="FunctionalOverview-Registration"></a>Registration</h2>
<p>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.</p>
<h2><a name="FunctionalOverview-Statistics"></a>Statistics</h2>
<p>DSpace offers system statistics for administrator usage, as well as usage statistics on the level of items, communities and collections.</p>
<h3><a name="FunctionalOverview-SystemStatistics"></a>System Statistics</h3>
<p>Various statistical reports about the contents and use of your system can be automatically generated by the system. These are generated by analysing DSpace's log files. Statistics can be broken down monthly.</p>
<p>The report includes following sections</p>
<ul>
<li>A customisable general overview of activities in the archive, by default including:
<ul>
<li>Number of items archived</li>
<li>Number of bitstream views</li>
<li>Number of item page views</li>
<li>Number of collection page views</li>
<li>Number of community page views</li>
<li>Number of user logins</li>
<li>Number of searches performed</li>
<li>Number of license rejections</li>
<li>Number of OAI Requests</li>
</ul>
</li>
<li>Customisable summary of archive contents</li>
<li>Broken-down list of item viewings</li>
<li>A full break-down of all performed actions</li>
<li>User logins</li>
<li>Most popular searches</li>
<li>Log Level Information</li>
<li>Processing information&#33;stats_genrl_overview.png&#33;<br/>
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.</li>
</ul>
<h2><a name="FunctionalOverview-Item%2CCollectionandCommunityUsageStatistics"></a>Item, Collection and Community Usage Statistics</h2>
<p>Usage statistics can be retrieved from individual item, collection and community pages. These Usage Statistics pages show:</p>
<ul>
<li>Total page visits (all time)</li>
<li>Total Visits per Month</li>
<li>File Downloads (all time)&#42;</li>
<li>Top Country Views (all time)</li>
<li>Top City Views (all time)</li>
</ul>
<p>&#42;File Downloads information is only displayed for item-level statistics. Note that downloads from separate bitstreams are also recorded and represented separatly. DSpace is able to capture and store File Download information, even when the bitstream was downloaded from a direct link on an external website.</p>
<p><span class="image-wrap" style=""><img src="attachments/22022823/22675569.png" style="border: 1px solid black"/></span></p>
<h2><a name="FunctionalOverview-ChecksumChecker"></a>Checksum Checker</h2>
<p>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.</p>
<h2><a name="FunctionalOverview-UsageInstrumentation"></a>Usage Instrumentation</h2>
<p>DSpace can report usage events, such as bitstream downloads, to a pluggable event processor. This can be used for developing customized usage statistics, for example. Sample event processor plugins writes event records to a file as tab-separated values or XML.</p>
<h2><a name="FunctionalOverview-ChoiceManagementandAuthorityControl"></a>Choice Management and Authority Control</h2>
<p>This is a configurable framework that lets you define plug-in classes to control the choice of values for a given DSpace metadata fields. It also lets you configure fields to include "authority" values along with the textual metadata value. The chocie-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.</p>
<h3><a name="FunctionalOverview-IntroductionandMotivation"></a>Introduction and Motivation</h3>
<h4><a name="FunctionalOverview-Definitions"></a>Definitions</h4>
<p><b>Choice Management</b></p>
<p>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.</p>
<p><b>Authority Control</b></p>
<p>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 choice-controlled.</p>
<h4><a name="FunctionalOverview-AboutAuthorityControl"></a>About Authority Control</h4>
<p>The advantages we seek from an authority controlled metadata field are:</p>
<ol>
<li><b>There is a simple and positive way to test whether two values are identical</b>, by comparing authority keys.
<ul>
<li>Comparing plain text values can give false positive results e.g. when two different people have a name that is written the same.</li>
<li>It can also give false negative results when the same name is written different ways, e.g. "J. Smith" vs. "John Smith".</li>
</ul>
</li>
<li><b>Help in entering correct metadata values.</b> 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.</li>
<li><b>Improved interoperability.</b> By sharing a name authority with another application, your DSpace can interoperate more cleanly with other applications.
<ul>
<li>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.</li>
<li>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.</li>
</ul>
</li>
<li>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.<br/>
Authority control is different from the controlled vocabulary of keywords already implemented in the submission UI:</li>
</ol>
<ol>
<li><b>Authorities are external to DSpace.</b> The source of authority control is typically an external database or network resource.
<ul>
<li>Plug-in architecture makes it easy to integrate new authorities without modifying any core code.</li>
</ul>
</li>
<li>This authority proposal impacts all phases of metadata management.
<ul>
<li>The keyword vocabularies are only for the submission UI.</li>
<li>Authority control is asserted everywhere metadata values are changed, including unattended/batch submission, LNI and SWORD package submission, and the administrative UI.</li>
</ul>
</li>
</ol>
<h4><a name="FunctionalOverview-SomeTerminology"></a>Some Terminology</h4>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'> <b>Authority</b> </td>
<td class='confluenceTd'> An authority is a source of fixed values for a given domain, each unique value identified by a key. </td>
</tr>
<tr>
<td class='confluenceTd'> . </td>
<td class='confluenceTd'> For example, the OCLC LC Name Authority Service. </td>
</tr>
<tr>
<td class='confluenceTd'> <b>Authority Record</b> </td>
<td class='confluenceTd'> The information associated with one of the values in an authority; may include alternate spellings and equivalent forms of the value, etc. </td>
</tr>
<tr>
<td class='confluenceTd'> <b>Authority Key</b> </td>
<td class='confluenceTd'> An opaque, hopefully persistent, identifier corresponding to exactly one record in the authority. </td>
</tr>
</tbody></table>
</div>
<br/>
<div class="tabletitle">
<a name="attachments">Attachments:</a>
</div>
<div class="greybox" align="left">
<img src="images/icons/bullet_blue.gif" height="8" width="8" alt=""/>
<a href="attachments/22022823/21954865.gif">data-model.gif</a> (image/gif)
<br/>
<img src="images/icons/bullet_blue.gif" height="8" width="8" alt=""/>
<a href="attachments/22022823/21954863.gif">workflow.gif</a> (image/gif)
<br/>
<img src="images/icons/bullet_blue.gif" height="8" width="8" alt=""/>
<a href="attachments/22022823/21954864.gif">ingest.gif</a> (image/gif)
<br/>
<img src="images/icons/bullet_blue.gif" height="8" width="8" alt=""/>
<a href="attachments/22022823/22675569.png">item-visits.png</a> (image/png)
<br/>
</div>
</td>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td height="12" background="https://wiki.duraspace.org/images/border/border_bottom.gif"><img src="images/border/spacer.gif" width="1" height="1" border="0"/></td>
</tr>
<tr>
<td align="center"><font color="grey">Document generated by Confluence on Nov 06, 2010 19:27</font></td>
</tr>
</table>
</body>
</html>

896
dspace/docs/html/History.html Executable file
View File

@@ -0,0 +1,896 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>DSpace Documentation : History</title>
<link rel="stylesheet" href="styles/site.css" type="text/css" />
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
<table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
<tr>
<td valign="top" class="pagebody">
<div class="pageheader">
<span class="pagetitle">
DSpace Documentation : History
</span>
</div>
<div class="pagesubheading">
This page last changed on Nov 06, 2010 by <font color="#0050B2">jtrimble</font>.
</div>
<h1><a name="History-DSpaceSystemDocumentation%3AVersionHistory"></a>DSpace System Documentation: Version History</h1>
<p>Changes in DSpace 1.6.1</p>
<h3><a name="History-BugFixes"></a>Bug Fixes</h3>
<ul>
<li>DS-295 - CC License being assigned incorrect Mime Type during submission</li>
<li>DS-239 - java.net.MalformedURLException: unknow protocol: resource</li>
<li>DS-242 - Special groups shown for logged in user rather than for user being examined</li>
<li>DS-430 - Embargo</li>
<li>DS-469 - <em>DCDate.displayDate(false,*)</em> displays only year</li>
<li>DS-471 - Accessing site-level 'mets.xml' in XMLUI doesn't work properly for handle prefixes with periods (e.g. 2010.1)</li>
<li>DS-493 - Url in browser is incorrect after login</li>
<li>DS-497 - Date month and day get default values when user returns to describe form</li>
<li>DS-500 - Ukrainian for DSpace 1.6.0</li>
<li>DS-501 - Kubrick Theme - NaN in Item Browse</li>
<li>DS-506 - embargo-lifter command missing from <em>launcher.xml</em></li>
<li>DS-507 - Log Converter difference between docs (log-converter) and launcher (stats-log-converter)</li>
<li>DS-508 - Attachment spelled as attachement in DailyReportEmailer</li>
<li>DS-509 - Retrieving country names in SOLR can return ArrayIndexOutOfBounds when country code is unchecked</li>
<li>DS-513 - Connection leak in SWORD authentication process</li>
<li>DS-518 - Duplicate listing of dependencies in dspace-sword/pom.xml</li>
<li>DS-523 - Reordering of 1.5 &#45;&gt; 1.6 upgrade steps in DSpace manual</li>
<li>DS-526 - ItemUpdate - script and manual updates</li>
<li>DS-527 - Withdrawn items not shown as deleted in OAI</li>
<li>DS-534 - Documentation for 'schema' attribute in metadata xml files</li>
<li>DS-537 - Malformed Japanese option values in the authority lookup window</li>
<li>DS-538 - restricted items are being returned in OAI GetRecord method while using harvest.includerestricted.oai</li>
<li>DS-539 - Misspelled attribute in MODS/METS output</li>
<li>DS-542 - verbose output for stats-log-importer displays spurious city/country from previous committed entry</li>
<li>DS-543 - Harvest not internationalized</li>
<li>DS-544 - Removal of mapped items can lead to NPE</li>
<li>DS-547 - Value for Recent Submissions is not workin in the XMLUI</li>
<li>DS-548 - Removing repeatable values in DescribeStep does not properly test for authority control</li>
<li>DS-551 - Export directories <em>dspace.cfg</em> and <em>build.xml</em> out of sync</li>
<li>DS-556 - Add Xalan to SOLR <em>pom.xml</em> as dependency</li>
<li>DS-557 - LC Authority Names - Lookup Feature - names without dates</li>
<li>DS-558 - Error in update sequence script 1.5 to 1.6 Oracle</li>
<li>DS-565 - Fixed for Empty description column in Itemview Page - General-Handler.xsl</li>
<li>DS-566 - Fixed for side bar menu dropping when there is license text in collection - DIM-Handler.xsl</li>
<li>DS-571 - Upgrade DSpace Services to next release</li>
<li>DS-572 - Batch metadata editor fails to notice change of item's owning collection</li>
<li>DS-573 - NPE resuming submission for item with an empty bundle original</li>
<li>DS-574 - DSpaceMETSIngester creates empty original bundle</li>
<li>DS-577 - Use modified Cocoon Servlet Service Impl in place of existing to support proper Cocoon Block addition</li>
<li>DS-579 - Required fields in submissions display wrong error message</li>
<li>DS-580 - DIDL format include HTML element if the item has no files</li>
<li>DS-581 - DIDL doesn't respect the hidden fields and the oai_dc metadata section is different than the simple oai_dc implementation</li>
</ul>
<h2><a name="History-ChangesinDSpace1.6.0"></a>Changes in DSpace 1.6.0</h2>
<h3><a name="History-NewFeatures"></a>New Features</h3>
<ul>
<li>DS-161 - Bulk Metadata Editing (Batch Metadata Editing)</li>
<li>DS-194 - Give METS ingester configuration option to make use of collection templates</li>
<li>DS-195 - Allow the primary bitstream to be set in the item importer / exporter</li>
<li>DS-204 - New &#45;zip option for item exporter and importer</li>
<li>DS-205 - Creative Commons - option to set legal jurisdiction</li>
<li>DS-228 - Community Admin XMLUI: Delegated Admins Patch</li>
<li>DS-236 - Authority Control, and plug-in choice control for Metadata Fields</li>
<li>DS-288 - Hide metadata from full item view</li>
<li>DS-289 - OAI-PMH + OAI-ORE harvesting support</li>
<li>DS-317 - Embargo feature</li>
<li>DS-321 - DSpace command launcher</li>
<li>DS-323 - ItemUpdate - new feature to batch update metadata and bitstreams</li>
<li>DS-324 - Add support for OpenSearch syndicated search conventions</li>
<li>DS-330 - Create new session on login / invalidate sessions on logout</li>
<li>DS-359 - Add alternate file appender for log4j</li>
<li>DS-377 - Add META tags identifying DSpace source version to Web UIs</li>
<li>DS-388 - Item importer - new option to enable workflow notification emails</li>
<li>DS-430 - Embargo</li>
<li>DS-447 - Email test script</li>
</ul>
<h3><a name="History-GeneralImprovments"></a>General Improvments</h3>
<ul>
<li>DS-52 - Factor out common webapp installation - ID: 2042160</li>
<li>DS-196 - METS exposed via OAI-PMH includes descritpion.provenance information</li>
<li>DS-201&#45; handle.jar 6.2 needs adding to DSpace Maven repository</li>
<li>DS-213 - IPAuthentication extended to allow negative matching</li>
<li>DS-219 - Internal Server error - include login details of user</li>
<li>DS-221 - XMLUI 'current activity' recognises Google Chrome as Safari</li>
<li>DS-234 - Configurable passing of Javamail parameter settings</li>
<li>DS-238 - Move item function in xmlui</li>
<li>DS-241 - DSpace Assembly Improvement</li>
<li>DS-243 - UsageEvent adjustments to support Statistics and Reporting Addons</li>
<li>DS-252 - Interpolate variables in the Subject: line of email templates as well</li>
<li>DS-261 - Community Admin JSPUI: porting of the DS-228 patch</li>
<li>DS-270 - Make delegate admin permissions configurable</li>
<li>DS-271 - Make the OAI DC crosswalk configurable</li>
<li>DS-291 - README update for top level of dspace 1.6.0 package directory</li>
<li>DS-297 - Refactor SQL source and Ant script to avoid copying Oracle versions over PostgreSQL</li>
<li>DS-299 - Allow long values to be specified for the max upload request (for uploading files greater than 2Gb)</li>
<li>DS-306 - Option to disable mailserver</li>
<li>DS-307 - Offer access in AbstractSearch to QueryResults for subclasses</li>
<li>DS-315 - Enhance readability of embedded metadata in html head</li>
<li>DS-316 - Make SWORD app:accepts configurable</li>
<li>DS-319 - Replace <em>/dspace/bin/dsrun org.dspace.browse.ItemCounter</em> with <em>/dspace/bin/itemcounter</em></li>
<li>DS-333 - Adjust SWORD ingest crosswalk to store bibliographic citation</li>
<li>DS-339 - Cleanup Dependenceis and POM files prior to release Upgrade Servlet API to 2.4 across all projects</li>
<li>DS-347 - Add &#45;-quiet option to MediaFilterManager to disable debug/monitoring output</li>
<li>DS-356 - Antispam for suggest item feature</li>
<li>DS-361 - Merge + Improvie Generation of Syndication Feeds</li>
<li>DS-372 - New verbose option for [dspace]/bin/dspace cleanup script</li>
<li>DS-382 - Add '<em>dc.creator</em>' to Author browse index by default</li>
<li>DS-386 - Allow user to specify which &lt;dmdSec&gt; is used by the METS Ingester when importing METS from Packager script</li>
<li>DS-389 - Misleading label: "Submit to This Collection" is corrected</li>
<li>DS-405 - New 1.6 Statistics settings in dspace.cfg need documentation</li>
<li>DS-407 - Install or Upgrade on existing server throws error for 'mvn package'</li>
<li>DS-410 - Updates to upgrade instructions necessary</li>
<li>DS-412 - XPDF MediaFilter: generate UTF-8 text, and improve error reporting</li>
<li>DS-425 - JSP UI cosmetics: horizontal scroll bar</li>
<li>DS-445 - New bitstream.findAll() method</li>
<li>DS-446 - New ant step &#45;test_database</li>
<li>DS-460 - Change logging from RollingFileAppender to DailyFileAppender</li>
<li>DS-461 - Add information about setting web proxies to maven to install docs</li>
</ul>
<h3><a name="History-Bugfixes"></a>Bug fixes</h3>
<ul>
<li>DS-44 - Monthly statistics skip first and last of month - ID: 2541435</li>
<li>DS-114 - Links not working due to trailing white space in dspace.url</li>
<li>DS-118 - File preview link during submission leeds to page not found</li>
<li>DS-121 - XMLUI Feedback form breaks with multiple hostnames</li>
<li>DS-128 - Anchor in submission doesn't work</li>
<li>DS-156 - File description not available in XMLUI</li>
<li>DS-184 - NPE from Edit Collection, Item Template, Edit Authorizations</li>
<li>DS-191 - metadataschemaregistry_seq is not initialized correctly under Oracle</li>
<li>DS-193 - OAI RDF crosswalk fails when DC value is null</li>
<li>DS-197 - Deleting a primary bitstream does not clear the primary_bitstream_id on the bundle table</li>
<li>DS-198 - File descriptions can not be removed/cleared in XMLUI</li>
<li>DS-199 - SWORD module doesn't accept X-No-Op header (dry run)</li>
<li>DS-200 - SWORD module requires the X-Packaging header</li>
<li>DS-206 - Input form visibility restriction doesn't work properly</li>
<li>DS-209 - Context.java turnOffAuthorisationSystem() can throw a NPE</li>
<li>DS-212 - NPE thrown during Harvest of non-items when visibility restriction is enabled</li>
<li>DS-216 - Migrating items that use additional metadata schemas causes an NPE</li>
<li>DS-217 - Hardcoded String in the license bitstream</li>
<li>DS-218 - Cannot add/remove email subscriptions from Profile page in XMLUI</li>
<li>DS-222 - Email alerts due to internal errors are not sent, if context is missing</li>
<li>DS-223 - Submission process show previous button in JSPUI also if the step is the first "visible" step</li>
<li>DS-225 - <em>dc.description.provenance</em> &#45; public display</li>
<li>DS-226 - confirmation page of edit profile has an invalid link</li>
<li>DS-227 - Values with double apos doesn't work in dropdown and list input type</li>
<li>DS-229 - <em>dc.description.provenance</em> shown in default xmlui 'full item view'</li>
<li>DS-231 - Missig file for index-init</li>
<li>DS-232 - DCPersonName parses name incorrectly (fix included)</li>
<li>DS-240 - Item validityKey not complete</li>
<li>DS-242 - Special groups shown for logged in user rather than for user being examined</li>
<li>DS-246 - Fix configurable browse parameter encoding (XMLUI)</li>
<li>DS-248 - Missing admin column in community table in database-schema.sql - community admin patch</li>
<li>DS-249 - sub-daily utility script does not pass arguments to Java (fix included)</li>
<li>DS-250 - Invalid identifers are not escaped</li>
<li>DS-253 - NullPointerException in HttpServletResponseBufferingWrapper</li>
<li>DS-254 - Bitstream (and item-export) download service does not correctly sense authenticated user</li>
<li>DS-255 - CompleteStep in submission LOSES SUBMISSION if an exception is thrown</li>
<li>DS-256 - Item Export ignores metadata language qualifier</li>
<li>DS-258 - Item View Thumbnails not displaying in XMLUI</li>
<li>DS-260 - Template item some times has owningCollection filled and some times not</li>
<li>DS-262 - Bug in DS-118, new patch included</li>
<li>DS-264 - XMLUI misses logging UsageEvent on requests fulfilled from the cache</li>
<li>DS-265 - IndexBrowse dies fatally when confronting badly-formatted date</li>
<li>DS-269 - Oracle JDBC connection string wrong in dspace.cfg - ID: 2722093</li>
<li>DS-274 - Typo in XSL breaks rendering of dri:xref with class</li>
<li>DS-275 - License files not listed on Item Summary page; XSL bug with patch</li>
<li>DS-276 - Patch to fix spelling error in Exception page</li>
<li>DS-280 - build.xml fails for ant versions below 1.7 (patch included)</li>
<li>DS-281 - Invalid Link to "Go to DSpace Home" on Page Not Found</li>
<li>DS-282 - "Starts with" navigation block should not display when browsing by specific value</li>
<li>DS-284 - Some rows if presented in the item summary will be wrongly considered odd or even.</li>
<li>DS-285 - Item and Bitstream pages do not provide Last-Modified HTTP header, nor recognize If-Modified-Since</li>
<li>DS-290 - <em>[dspace]/exports</em> is not created during fresh install</li>
<li>DS-295 - CC License being assigned incorrect Mime Type during submission.</li>
<li>DS-303 - Export migrate option incorrectly removes non-handle identifier.uris</li>
<li>DS-309 - Shiboleth default roles are applied also to anonymous user and user logged-in with other methods</li>
<li>DS-310 - UTF-8 encoding in community and collection text</li>
<li>DS-318 - JSPUI: Left over text in edit item about format</li>
<li>DS-320 - java.util.NoSuchElementException: Timeout waiting for idle object</li>
<li>DS-327 - SWORD temp upload directory missing trailing slash</li>
<li>DS-328 - SWORD service documents do not include atom:generator element</li>
<li>DS-337 - A bug related with adding new &#45;EPersons</li>
<li>DS-338 - Bitstream download allows caching of content that requires authorization to read</li>
<li>DS-340 DSpace services log to the command line</li>
<li>DS-344 - Apostrophe in email address prevents EPerson from being selected</li>
<li>DS-349 - Edit Item in admin UI does not allow setting Bitstream to an Internal BitstreamFormat</li>
<li>DS-353 - Missing commits in XMLUI server-side javascript code.</li>
<li>DS-354 - Make-handle-server configuration fails. New command created using dspace launcher.</li>
<li>DS-365 New DSpace OAI-PMH Harvester doesn't support OAI gateways that do not use 'sets'</li>
<li>DS-370 - E Mail Sent On Item Export Error Message</li>
<li>DS-373 - "Letter" links have broken URLs in 2nd-stage Browse</li>
<li>DS-378 - XMLUI Submission Interface messes up in IE7 after an empty &lt;hint&gt; in input_forms.xml</li>
<li>DS-379 - open-search in jspui won't return description.xml</li>
<li>DS-381 - community and collection homepage</li>
<li>DS-385 - Packager script is unable to import the same METS + DIM package that was exported</li>
<li>DS-392 - Error messages in the submission do not disappear if e.g. one of the two errors are solved</li>
<li>DS-393 - The issue date in the submission lowers each time the describe page is being displayed</li>
<li>DS-395 - DSpace Objects (communities, collections, items, bitstreams) only accessible to logged in users</li>
<li>DS-398 - Submission license displayed on collection and item homepage</li>
<li>DS-399 - Special characters in collection license lead to parse error</li>
<li>DS-400 - Webui item browse (date, title or similar) reduces displayed issue date by one day</li>
<li>DS-406 - View Statistics button does not work in item page</li>
<li>DS-409 - JSPUI Statistics Display ignores "statistics.item.authorization.admin"</li>
<li>DS-414 - solr statistics file downloads listed in statistics display of communites and collections</li>
<li>DS-415 - Create groups via admin UI authorization denied</li>
<li>DS-416 - Solr Statistics not starting on Windows Fresh install</li>
<li>DS-417 - 1-day (or passed) embargo dates give error upon submission</li>
<li>DS-418 - i18n broken in jspui</li>
<li>DS-419 - Setting embargo.field.terms to an unqualified field throws uncaught exception on item submission</li>
<li>DS-421 - Setting solr.metadata.item.X property to an unqualified field generates exception in <em>SolrLogger.post</em> on item view and prevents Solr from logging the event</li>
<li>DS-422 - Directory "etc" missing from Ant target "init_installation".</li>
<li>DS-423 - Ant target "clean_database" doesn't drop all tables.</li>
<li>DS-424 - Export metadata button displayed in JSPUI Administration List of withdrawn items</li>
<li>DS-427 - Item license per default displayed in item display of the xmlui</li>
<li>DS-428 - Wrong link for bitstreams during submission unassigned</li>
<li>DS-432 - No mention of config/news-xmlui.xml in manual</li>
<li>DS-436 - SWORD Authenticator doesn"t support the special groups infrastructure</li>
<li>DS-437 - Oracle DB Schema has artifacts from past releases</li>
<li>DS-438 - JSPUI stats - filename incorrect on second and subsequent files</li>
<li>DS-459 - OAI PMH is not delivering continuation tokens</li>
<li>DS-468 - CLONE - Foreign characters broken in group names</li>
<li>DS-472 - "fresh_install" broken on a completely clean system</li>
<li>DS-474 - handle.canonical.prefix undocumented</li>
<li>DS-475 - create a new group</li>
<li>DS-477 - LDAPHierarchicalAuthentication fails when the LDAP returns mixed case email address</li>
<li>DS-480 - Exception is thrown when removing the last file after the item is rejected during review.</li>
</ul>
<h2><a name="History-ChangesinDSpace1.5.2"></a>Changes in DSpace 1.5.2</h2>
<h3><a name="History-GeneralImprovements"></a>General Improvements</h3>
<ul>
<li>The History System has been removed since DSpace 1.5. The <em>[dspace]/history</em> directory and it's contents can be completely removed if you so choose as it is non functional.</li>
</ul>
<h3><a name="History-Bugfixesandsmallerpatches"></a>Bug fixes and smaller patches</h3>
<ul>
<li>TBD</li>
</ul>
<h2><a name="History-ChangesinDSpace1.5.1"></a>Changes in DSpace 1.5.1</h2>
<h3><a name="History-GeneralImprovements"></a>General Improvements</h3>
<ul>
<li>TBD</li>
</ul>
<h3><a name="History-Bugfixesandsmallerpatches"></a>Bug fixes and smaller patches</h3>
<ul>
<li>TBD</li>
</ul>
<h2><a name="History-ChangesinDSpace1.5"></a>Changes in DSpace 1.5</h2>
<h3><a name="History-GeneralImprovements"></a>General Improvements</h3>
<ul>
<li>Highly configurable and theme-able new user interface (Manakin).</li>
<li>Apache Maven-based modular build system.</li>
<li>LNI (Lightweight Network Interface) service. Allows programmatic ingest of content via WebDAV or SOAP.</li>
<li>SWORD (Simple Web-service Offering Repository Deposit): repository-standard ingest service using Atom Publishing Protocol.</li>
<li>Highly configurable item web submission system. All submission steps are configurable not just metadata pages.</li>
<li>Browse functionality allowing customisation of the available indexes via dspace.cfg and pluggable normalisation of the sort strings. Integration with both JSP-UI and XML-UI included.</li>
<li>Extensible content event notification service.</li>
<li>Generation of Google and HTML sitemaps</li>
</ul>
<h3><a name="History-Bugfixesandsmallerpatches"></a>Bug fixes and smaller patches</h3>
<ul>
<li>New options for ItemImporter to support bitstream permissions and descriptions.</li>
<li>1824710 Fix - Change in Creative Commons RDF.</li>
<li>1794700 Fix - Stat-monthly and stat-report-monthly</li>
<li>1566820 Patch - Authentication code moved to new org.dspace.authenticate package, add IP AUth</li>
<li>1670093 Patch - More stable metadata and schema registry import Option to generate community and collection "strength" as a batch job</li>
<li>1659868 Patch - Improved database level debugging</li>
<li>1620700 Patch - Add Community and Sub-Community to OAI Sets</li>
<li>1679972 Fix - OAIDCCrosswalk NPE and invalid character fix, also invalid output prevented</li>
<li>1549290 Fix - Suggest Features uses hard coded strings</li>
<li>1727034 Fix - Method MetadataField.unique() is incorrect for null values</li>
<li>1614546 Fix - Get rid of unused mets_bitstream_id column</li>
<li>1450491 Patch - i18n configurable multilingualism support</li>
<li>1764069 Patch - Replace "String" with "Integer" in PreparedStatement where needed</li>
<li>1743188 Patch - for Request #1145499 - Move Items</li>
<li>179196 Patch - Oracle SQL in Bitstream Checker</li>
<li>1751638 Patch - Set http disposition header to force download of large bitstreams</li>
<li>1799575 Patch - New EPersonConsumer event consumer</li>
<li>1566572 Patch - Item metadata in XHTML head elements</li>
<li>1589429 Patch - "Self-Named" Media Filters (i.e. MediaFilter Plugins) (updated version of this patch)</li>
<li>1888652 Patch - Statistics Rewritten In Java</li>
<li>1444364 Request - Metadata registry exporter</li>
<li>1221957 Request - Admin browser for withdrawn items</li>
<li>1740454 Fix - Concurrency</li>
<li>1552760 Fix - Submit interface looks bad in Safari</li>
<li>1642563 Patch - bin/update-handle-prefix rewritten in Java</li>
<li>1724330 Fix - Removes "null" being displayed in community-home.jsp</li>
<li>1763535 Patch - Alert DSpace administrator of new user registration</li>
<li>1759438 Patch - Multilingualism Language Switch - DSpace Header</li>
</ul>
<h2><a name="History-ChangesinDSpace1.4.1"></a>Changes in DSpace 1.4.1</h2>
<h3><a name="History-GeneralImprovements"></a>General Improvements</h3>
<ul>
<li>Error pages now return appropriate HTTP status codes (e.g. 404 not found)</li>
<li>Bad filenames in /bitstream/ URLs now result in 404 error &#8211; prevents infinite URL spaces confusing crawlers and bad "persistent" bitstream IDs circulating</li>
<li>Prevent infinite URL spaces in HTMLServlet</li>
<li>InstallItem no longer sets dc.format.extent, dc.format.mimetype; no longer sets default value for dc.language.iso if one is not present</li>
<li>Empty values in drop-down submit fields are not added as empty metadata values</li>
<li>API methods for searching epeople and groups</li>
<li>Support stats from both 1.3 and 1.4</li>
<li>[dspace]/bin/update-handle-prefix now runs index-all</li>
<li>Remove cases of System.out from code executed in webapp</li>
<li>Change "View Licence" to "View License" in Messages.properties</li>
<li>dspace.cfg comments changed to indicate what default.language actually means</li>
<li>HandleServlet and BitstreamServlet support If-Modified-Since requests</li>
<li>Improved sanity-checking of XSL-based ingest crosswalks</li>
<li>Remove thumbnail filename from alt-text</li>
<li>Include item title in HTML title element</li>
<li>Improvements to help prevent spammers and sploggers</li>
<li>Make cleanup() commit outstanding work every 100 iterations</li>
<li>Better handling where email send failed due to wrong address for new user</li>
<li>Include robots.txt to limit bots navigating author, date and browse by subject pages</li>
<li>Add css styles for print media</li>
<li>RSS made more configurable and provide system-wide RSS feed, also moves text to Messages.properties</li>
<li>Jar file updates (includes required code changes for DSIndexer and DSQuery and new jars fontbox.jar and serializer.jar)</li>
<li>Various documentation additions and cleanups</li>
<li>XHTML compliance improvements</li>
<li>Move w3c valid xhtml boiler image into local repository</li>
<li>Remove uncessary Log4j Configuration in CheckerCommand</li>
<li>Include Windows CLASSPATH in dsrun.bat</li>
</ul>
<h3><a name="History-Bugfixes"></a>Bug fixes</h3>
<ul>
<li>1604037 - UIUtil.encodeBitstream() now correctly encodes URLs (no longer incorrectly substitutes '+' for spaces in non-query segment</li>
<li>1592984 - Date comparisons strip time in org.dspace.harvest.Harvest</li>
<li>1589902 - Duplicate [field] checking error [on input-forms.xml]</li>
<li>1596952 - Collection Wizard create Template missing schema</li>
<li>1596978 - View unfinished submissions - collection empty</li>
<li>1588625 - Incorrect text on item mapper screen</li>
<li>1597805 - DIDL Crosswalk: wrong resource management</li>
<li>1605635 - NPE in Utils.java</li>
<li>1597504 - Search result page shows shortened query string</li>
<li>1532389 - Item Templates do not work for non-dc fields</li>
<li>1066771 - Metadata edit form dropping DC qualifier</li>
<li>1548738 - Multiple Metadata Schema, schema not shown on edit item page</li>
<li>1589895 - Not possible to add unqualified Metadata Field</li>
<li>1543853 - Statistics do not work in 1.4</li>
<li>1541381 - Browse-by-date and browse-by-title not working</li>
<li>1556947 - NullPointerException when no user selected to del/edit</li>
<li>1554064 - Fix exception handling for ClassCastException in BitstreamServlet</li>
<li>1548865 - Browse errors on withdrawn item</li>
<li>1554056 - Community/collection handle URL with / redirects to homepage</li>
<li>1571490 - UTF-8 encoded characters in licence</li>
<li>1571519 - UTF-8 in statistics</li>
<li>1544807 - Browse-by-Subject/Author paging mechanism broken</li>
<li>1543966 - "Special" groups inside groups bug</li>
<li>1480496 - Cannot turn off "ignore authorization" flag&#33;</li>
<li>1515148 - Community policies not deleting correctly</li>
<li>1556829 - Docs mention old SiteAuthenticator class</li>
<li>1606435 - Workflow text out of context</li>
<li>Fix for bitstream authorization timeout</li>
<li>Fix to make sure cleanup() doesn't fail with NullPointerException</li>
<li>Fix for removeBitstream() failing to update primary bitstream</li>
<li>Fix for Advanced Search ignoring conjunctions for arbitrary number of queries</li>
<li>Fix minor bug in Harvest.java for Oracle users</li>
<li>Fix missing title for news editor page</li>
<li>Small Messages.properties modification (change of DSpace copyright text)</li>
<li>fix PDFBox tmp file issue</li>
<li>Fix HttpServletRequest encoding issues</li>
<li>Fix bug in TableRow toString() method where NPE is thrown if tablename not set</li>
<li>Update DIDL license and change coding style to DSpace standard</li>
</ul>
<h2><a name="History-ChangesinDSpace1.4"></a>Changes in DSpace 1.4</h2>
<h3><a name="History-GeneralImprovements"></a>General Improvements</h3>
<ul>
<li>Content verification through periodic checksum checking</li>
<li>Support for branded preview image</li>
<li>Add/replace Creative Commons in 'edit item' tool</li>
<li>Customisable item listing columns and browse indices</li>
<li>Script for updating handle prefixes (e.g. for moving from development to production)</li>
<li>Configurable boolean search operator</li>
<li>Controlled vocabulary patch to provide search on classification terms, and addition of terms during submission.</li>
<li>Add 'visibility' element to input-forms.xml</li>
<li>Browse by subject feature</li>
<li>Log4J enhancement to use XML configuration</li>
<li>QueryArgs class can support any number of fields in advanced search.</li>
<li>Community names no longer have to be unique</li>
<li>Enhanced Windows support</li>
<li>Support for multiple (flat) metadata schemas</li>
<li>Suggest an item page</li>
<li>RSS Feeds</li>
<li>Performance enhancements</li>
<li>Stackable authentication methods</li>
<li>Plug-in manager</li>
<li>Pluggable SIP/DIP support and metadata crosswalks</li>
<li>Nested groups of e-people</li>
<li>Expose METS and MPEG-21 DIDL DIPs via OAI-PMH</li>
<li>Configurable Lucene search analyzer (e.g. for Chinese metadata)</li>
<li>Support for SMTP servers requiring authentication</li>
</ul>
<h3><a name="History-Bugfixes"></a>Bug fixes</h3>
<ul>
<li>1358197 - Edit Item, empty DC fields not removable</li>
<li>1363633 - Submission step 1 fails when there are no collections</li>
<li>1255264 - Resource policy eperson value was set to wrong column</li>
<li>1380494 - Error deleting an item with multiple metadata schema support</li>
<li>1443649 - Cannot configure unqualified elements for advanced search index</li>
<li>1333687 - Browse-(title&#124;date) fails on withdrawn item</li>
<li>1066713 - Two (sub)communities cannot have one name</li>
<li>1284055 - Two Communities of same name throws error</li>
<li>1035366 - Bitstream size column should be bigint</li>
<li>1352257 - Selecting a Group for GroupToGroup while Creating Collection</li>
<li>1352226 - Navigation and Sorting in Group List (Select Groups) fails</li>
<li>1348276 - Null in collection name causes OAI ListSets to fail</li>
<li>1160898 - dspace_migrate removes Date.Issued from prev published items</li>
<li>1261191 - Malformed METS metadata exported</li>
</ul>
<h2><a name="History-ChangesinDSpace1.3.2"></a>Changes in DSpace 1.3.2</h2>
<h3><a name="History-GeneralImprovements"></a>General Improvements</h3>
<ul>
<li>DSpace UI XHTML/WAI compliant</li>
<li>Configure metadata fields shown on simple item display</li>
<li>Supervisor/workspace help documentation</li>
</ul>
<h3><a name="History-Bugfixes"></a>Bug fixes</h3>
<ul>
<li>Oracle compatibility fixes</li>
<li>Item exporter now correctly exports metadata in UTF-8</li>
<li>fixed to handle 'null' values passed in</li>
</ul>
<h2><a name="History-ChangesinDSpace1.3.1"></a>Changes in DSpace 1.3.1</h2>
<h3><a name="History-Bugfixes"></a>Bug fixes</h3>
<ul>
<li>1252153 - Error on fresh install</li>
</ul>
<h2><a name="History-ChangesinDSpace1.3"></a>Changes in DSpace 1.3</h2>
<h3><a name="History-GeneralImprovements"></a>General Improvements</h3>
<ul>
<li>Initial i18n Support for JSPs - Note: the implementation of this feature required changes to almost all JSP pages</li>
<li>LDAP authentication support</li>
<li>Log file analysis and report generation</li>
<li>Configurable item licence viewing</li>
<li>Supervision order/collaborative workspace administrative tools</li>
<li>Basic workspace for submissions in progress, with support for supervision</li>
<li>SRB storage system option</li>
<li>Updated handle server system</li>
<li>Database optimisations</li>
<li>Latest versions of Xerces, Xalan and OAICAT jars</li>
<li>Various documentation additions and cleanups</li>
</ul>
<h3><a name="History-Bugfixes"></a>Bug fixes</h3>
<ul>
<li>1161459 - ItemExporter fails with Too many open files</li>
<li>1167373 - Email date field not populated</li>
<li>1193948 - New item submit problem</li>
<li>1188132 - NullPointerException when Adding EPerson</li>
<li>1188016 - Cannot Edit an Eperson</li>
<li>1219701 - Unable to open unfinished submission</li>
<li>1206836 - community strengths not reflecting sub-community</li>
<li>1238262 - Submit UI nav/progress buttons no longer show progress</li>
<li>1238276 - Double quote problem in some fields in submit UI</li>
<li>1238277 - format support level not shown in "uploaded file" page</li>
<li>1242548 - Uploading non-existing files</li>
<li>1244743 - Bad lookup key for special case of DC Title in ItemTag.java</li>
<li>1245223 - Subscription Emailer fails</li>
<li>1247508 - Error when browsing item with no content/bitstream collections</li>
<li>Set the content type in the HTTP header</li>
<li>Fix issue where EPerson edit would not work due to form indexing (partial fix)</li>
<li>POST handling in HTMLServlet</li>
<li>Missing ContentType directives added to some JSPs</li>
<li>Name dependency on Collection Admin and Submitter groups fixed</li>
<li>Fixed OAI-PMH XML encoding</li>
</ul>
<h2><a name="History-ChangesinDSpace1.2.2"></a>Changes in DSpace 1.2.2</h2>
<h3><a name="History-GeneralImprovements"></a>General Improvements</h3>
<ul>
<li>Customisable submission forms added</li>
<li>Configurable number of index terms in Lucene for full-text indexing</li>
<li>Improved scalability in media filter</li>
<li>Submit button on collection pages only appears if user has authorisation</li>
<li>PostgreSQL 8.0 compatibility</li>
<li>Search scope retention to improve browsing</li>
<li>Community and collection strengths displayed</li>
<li>Upgraded OAICat software</li>
</ul>
<h3><a name="History-Bugfixes"></a>Bug fixes</h3>
<ul>
<li>Fix for Oracle too many cursors problem.</li>
<li>Fix for UTF-8 encoded searches in advanced search.</li>
<li>Fix for handling "\" in bitstream names.</li>
<li>Fix to prevent delete of "unknown" bitstream format</li>
<li>Fix for ItemImport creating new handles for replaced items</li>
</ul>
<h3><a name="History-ChangesinJSPs"></a>Changes in JSPs</h3>
<ul>
<li><em>collection-home.jsp</em><em>changed</em></li>
<li><em>community-home.jsp</em><em>changed</em></li>
<li><em>community-list.jsp</em><em>changed</em></li>
<li><em>home.jsp</em><em>changed</em></li>
<li><em>dspace-admin/list-formats.jsp</em><em>changed</em></li>
<li><em>dspace-admin/wizard-questions.jsp</em><em>changed</em></li>
<li><em>search/results.jsp</em><em>changed</em></li>
<li><em>submit/cancel.jsp</em><em>changed</em></li>
<li><em>submit/change-file-description.jsp</em><em>changed</em></li>
<li><em>submit/choose-file.jsp</em><em>changed</em></li>
<li><em>submit/complete.jsp</em><em>changed</em></li>
<li><em>submit/creative-commons.jsp</em><em>changed</em></li>
<li><em>submit/edit-metadata.jsp</em><em>new</em></li>
<li><em>submit/get-file-format.jsp</em><em>changed</em></li>
<li><em>submit/initial-questions.jsp</em><em>changed</em></li>
<li><em>submit/progressbar.jsp</em><em>changed</em></li>
<li><em>submit/review.jsp</em><em>changed</em></li>
<li><em>submit/select-collection.jsp</em><em>changed</em></li>
<li><em>submit/show-license.jsp</em><em>changed</em></li>
<li><em>submit/show-uploaded-file.jsp</em><em>changed</em></li>
<li><em>submit/upload-error.jsp</em><em>changed</em></li>
<li><em>submit/upload-file-list.jsp</em><em>changed</em></li>
</ul>
<h2><a name="History-ChangesinDSpace1.2.1"></a>Changes in DSpace 1.2.1</h2>
<h3><a name="History-GeneralImprovements"></a>General Improvements</h3>
<ul>
<li>Oracle support added</li>
<li>Thumbnails in item view can now be switched off/on</li>
<li>Browse and search thumbnail options</li>
<li>Improved item importer
<ul>
<li>can now import to multiple collections</li>
<li>added &#45;-test flag to simulate an import, without actually making any changes</li>
<li>added &#45;-resume flag to try to resume the import in case the import is aborted</li>
</ul>
</li>
<li>Configurable fields for the search index</li>
<li>Script for transferring items between DSpace instances</li>
<li>Sun library JARs (JavaMail, Java Activation Framework and Servlet) now included in DSpace source code bundle</li>
</ul>
<h3><a name="History-Bugfixes"></a>Bug fixes</h3>
<ul>
<li>A logo to existing collection can now be added. Fixes SF bug #1065933</li>
<li>The community logo can now be edited. Fixes SF bug #1035692</li>
<li>MediaFilterManager doesn't 'touch' every item every time. Fixes SF bug #1015296</li>
<li>Supported formats help page, set the format support level to "known" as default</li>
<li>Fixed various database connection pool leaks</li>
</ul>
<h3><a name="History-ChangedJSPs"></a>Changed JSPs</h3>
<ul>
<li><em>collection-home</em><em>changed</em></li>
<li><em>community-home</em><em>changed</em></li>
<li><em>display-item</em><em>changed</em></li>
<li><em>dspace-admin/confirm-delete-collection</em><em>moved to tools/ and changed</em></li>
<li><em>dspace-admin/confirm-delete-community</em><em>moved to tools/ and changed</em></li>
<li><em>dspace-admin/edit-collection</em><em>moved to tools/ and changed</em></li>
<li><em>dspace-admin/edit-community</em><em>moved to tools/ and changed</em></li>
<li><em>dspace-admin/index</em><em>changed</em></li>
<li><em>dspace-admin/upload-logo</em><em>changed</em></li>
<li><em>dspace-admin/wizard-basicinfo</em><em>changed</em></li>
<li><em>dspace-admin/wizard-default-item</em><em>changed</em></li>
<li><em>dspace-admin/wizard-permissions</em><em>changed</em></li>
<li><em>dspace-admin/wizard-questions</em><em>changed</em></li>
<li><em>help/formats.html</em><em>removed</em></li>
<li><em>help/formats</em><em>changed</em></li>
<li><em>index</em><em>changed</em></li>
<li><em>layout/navbar-admin</em><em>changed</em></li>
</ul>
<h2><a name="History-ChangesinDSpace1.2"></a>Changes in DSpace 1.2</h2>
<h3><a name="History-GeneralImprovments"></a>General Improvments</h3>
<ul>
<li>Communities can now contain sub-communities</li>
<li>Items may be included in more than one collection</li>
<li>Full text extraction and searching for MS Word, PDF, HTML, text documents</li>
<li>Thumbnails displayed in item view for items that contain images</li>
<li>Configurable MediaFilter tool creates both extracted text and thumbnails</li>
<li>Bitstream IDs are now persistent - generated from item's handle and a sequence number</li>
<li>Creative Commons licenses can optionally be added to items during web submission process</li>
</ul>
<h3><a name="History-Administration"></a>Administration</h3>
<ul>
<li>If you are logged in as administrator, you see admin buttons on item, collection, and community pages</li>
<li>New collection administration wizard</li>
<li>Can now administer collection's submitters from collection admin tool</li>
<li>Delegated administration - new 'collection editor' role - edits item metadata, manages submitters list, edits collection metadata, links to items from other collections, and can withdraw items</li>
<li>Admin UI moved from /admin to /dspace-admin to avoid conflict with Tomcat /admin JSPs</li>
<li>New EPerson selector popup makes Group editing much easier</li>
<li>'News' section is now editable using admin UI (no more mucking with JSPs)</li>
</ul>
<h3><a name="History-Import%2FExport%2FOAI"></a>Import/Export/OAI</h3>
<ul>
<li>New tool that exports DSpace content in AIPs that use METS XML for metadata (incomplete)</li>
<li>OAI - sets are now collections, identified by Handles ('safe' with /, : converted to &#95;)</li>
<li>OAI - contributor.author now mapped to oai_dc:creator</li>
</ul>
<h3><a name="History-Miscellaneous"></a>Miscellaneous</h3>
<ul>
<li>Build process streamlined with use of WAR files, symbolic links no longer used, friendlier to later versions of Tomcat</li>
<li>MIT-specific aspects of UI removed to avoid confusion</li>
<li>Item metadata now rendered to avoid interpreting as HTML (displays as entered)</li>
<li>Forms now have no-cache directive to avoid trouble with browser 'back' button</li>
<li>Bundles now have 'names' for more structure in item's content</li>
</ul>
<h3><a name="History-JSPfilechangesbetween1.1and1.2"></a>JSP file changes between 1.1 and 1.2</h3>
<p>This list generated with <em>cvs &#45;Q rdiff &#45;s &#45;r dspace-1_1 dspace</em> and a sprinkling of perl.</p>
<ul>
<li>Changed: dspace/jsp/collection-home.jsp</li>
<li>Changed: dspace/jsp/community-home.jsp</li>
<li>Changed: dspace/jsp/community-list.jsp</li>
<li>Changed: dspace/jsp/display-item.jsp</li>
<li>Changed: dspace/jsp/index.jsp</li>
<li>Changed: dspace/jsp/home.jsp</li>
<li>Changed: dspace/jsp/styles.css.jsp</li>
<li>Moved to dspace-admin and changed: dspace/jsp/admin/authorize-advanced.jsp</li>
<li>Moved to dspace-admin and changed: dspace/jsp/admin/authorize-collection-edit.jsp</li>
<li>Moved to dspace-admin and changed: dspace/jsp/admin/authorize-community-edit.jsp</li>
<li>Moved to dspace-admin and changed: dspace/jsp/admin/authorize-item-edit.jsp</li>
<li>Moved to dspace-admin and changed: dspace/jsp/admin/authorize-main.jsp</li>
<li>Moved to dspace-admin and changed: dspace/jsp/admin/authorize-policy-edit.jsp</li>
<li>Moved to dspace-admin: dspace/jsp/admin/collection-select.jsp</li>
<li>Moved to dspace-admin: dspace/jsp/admin/community-select.jsp</li>
<li>Moved to dspace-admin: dspace/jsp/admin/confirm-delete-collection.jsp</li>
<li>Moved to dspace-admin: dspace/jsp/admin/confirm-delete-community.jsp</li>
<li>Moved to dspace-admin: dspace/jsp/admin/confirm-delete-dctype.jsp</li>
<li>Moved to dspace-admin: dspace/jsp/admin/confirm-delete-eperson.jsp</li>
<li>Moved to dspace-admin: dspace/jsp/admin/confirm-delete-format.jsp</li>
<li>Moved to dspace/jsp/tools: dspace/jsp/admin/confirm-delete-item.jsp</li>
<li>Moved to dspace/jsp/tools: dspace/jsp/admin/confirm-withdraw-item.jsp</li>
<li>Moved to dspace-admin and changed: dspace/jsp/admin/edit-collection.jsp</li>
<li>Moved to dspace-admin and changed: dspace/jsp/admin/edit-community.jsp</li>
<li>Moved to dspace/jsp/tools and changed: dspace/jsp/admin/edit-item-form.jsp</li>
<li>Moved to dspace-admin and changed: dspace/jsp/admin/eperson-browse.jsp</li>
<li>Moved to dspace-admin: dspace/jsp/admin/eperson-confirm-delete.jsp</li>
<li>Moved to dspace-admin and changed: dspace/jsp/admin/eperson-edit.jsp</li>
<li>Moved to dspace-admin and changed: dspace/jsp/admin/eperson-main.jsp</li>
<li>Moved to dspace/jsp/tools and changed: dspace/jsp/admin/get-item-id.jsp</li>
<li>Moved to dspace/jsp/tools and changed: dspace/jsp/admin/group-edit.jsp</li>
<li>Moved to dspace-admin and changed: dspace/jsp/admin/group-eperson-select.jsp</li>
<li>Moved to dspace/jsp/tools and changed: dspace/jsp/admin/group-list.jsp</li>
<li>Moved to dspace-admin: dspace/jsp/admin/index.jsp</li>
<li>Moved to dspace-admin and changed: dspace/jsp/admin/item-select.jsp</li>
<li>Moved to dspace-admin and changed: dspace/jsp/admin/list-communities.jsp</li>
<li>Moved to dspace-admin and changed: dspace/jsp/admin/list-dc-types.jsp</li>
<li>Removed: dspace/jsp/admin/list-epeople.jsp</li>
<li>Moved to dspace-admin and changed: dspace/jsp/admin/list-formats.jsp</li>
<li>Moved to dspace/jsp/tools: dspace/jsp/admin/upload-bitstream.jsp</li>
<li>Moved to dspace-admin and changed: dspace/jsp/admin/upload-logo.jsp</li>
<li>Moved to dspace-admin: dspace/jsp/admin/workflow-abort-confirm.jsp</li>
<li>Moved to dspace-admin and changed: dspace/jsp/admin/workflow-list.jsp</li>
<li>Changed: dspace/jsp/browse/authors.jsp</li>
<li>Changed: dspace/jsp/browse/items-by-author.jsp</li>
<li>Changed: dspace/jsp/browse/items-by-date.jsp</li>
<li>Changed: dspace/jsp/browse/no-results.jsp</li>
<li>New: dspace-admin/eperson-deletion-error.jsp</li>
<li>New: dspace/jsp/dspace-admin/news-edit.jsp</li>
<li>New: dspace/jsp/dspace-admin/news-main.jsp</li>
<li>New: dspace/jsp/dspace-admin/wizard-basicinfo.jsp</li>
<li>New: dspace/jsp/dspace-admin/wizard-default-item.jsp</li>
<li>New: dspace/jsp/dspace-admin/wizard-permissions.jsp</li>
<li>New: dspace/jsp/dspace-admin/wizard-questions.jsp</li>
<li>Changed: dspace/jsp/components/contact-info.jsp</li>
<li>Changed: dspace/jsp/error/internal.jsp</li>
<li>New: dspace/jsp/help/formats.jsp</li>
<li>Changed: dspace/jsp/layout/footer-default.jsp</li>
<li>Changed: dspace/jsp/layout/header-default.jsp</li>
<li>Changed: dspace/jsp/layout/navbar-admin.jsp</li>
<li>Changed: dspace/jsp/layout/navbar-default.jsp</li>
<li>Changed: dspace/jsp/login/password.jsp</li>
<li>Changed: dspace/jsp/mydspace/main.jsp</li>
<li>Changed: dspace/jsp/mydspace/perform-task.jsp</li>
<li>Changed: dspace/jsp/mydspace/preview-task.jsp</li>
<li>Changed: dspace/jsp/mydspace/reject-reason.jsp</li>
<li>Changed: dspace/jsp/mydspace/remove-item.jsp</li>
<li>Changed: dspace/jsp/register/edit-profile.jsp</li>
<li>Changed: dspace/jsp/register/inactive-account.jsp</li>
<li>Changed: dspace/jsp/register/new-password.jsp</li>
<li>Changed: dspace/jsp/register/registration-form.jsp</li>
<li>Changed: dspace/jsp/search/advanced.jsp</li>
<li>Changed: dspace/jsp/search/results.jsp</li>
<li>Changed: dspace/jsp/submit/cancel.jsp</li>
<li>New: dspace/jsp/submit/cc-license.jsp</li>
<li>Changed: dspace/jsp/submit/choose-file.jsp</li>
<li>New: dspace/jsp/submit/creative-commons.css</li>
<li>New: dspace/jsp/submit/creative-commons.jsp</li>
<li>Changed: dspace/jsp/submit/edit-metadata-1.jsp</li>
<li>Changed: dspace/jsp/submit/edit-metadata-2.jsp</li>
<li>Changed: dspace/jsp/submit/get-file-format.jsp</li>
<li>Changed: dspace/jsp/submit/initial-questions.jsp</li>
<li>Changed: dspace/jsp/submit/progressbar.jsp</li>
<li>Changed: dspace/jsp/submit/review.jsp</li>
<li>Changed: dspace/jsp/submit/select-collection.jsp</li>
<li>Changed: dspace/jsp/submit/show-license.jsp</li>
<li>Changed: dspace/jsp/submit/show-uploaded-file.jsp</li>
<li>Changed: dspace/jsp/submit/upload-error.jsp</li>
<li>Changed: dspace/jsp/submit/upload-file-list.jsp</li>
<li>Changed: dspace/jsp/submit/verify-prune.jsp</li>
<li>New: dspace/jsp/tools/edit-item-form.jsp</li>
<li>New: dspace/jsp/tools/eperson-list.jsp</li>
<li>New: dspace/jsp/tools/itemmap-browse.jsp</li>
<li>New: dspace/jsp/tools/itemmap-info.jsp</li>
<li>New: dspace/jsp/tools/itemmap-main.jsp</li>
</ul>
<h2><a name="History-ChangesinDSpace1.1.1"></a>Changes in DSpace 1.1.1</h2>
<h3><a name="History-Bugfixes"></a>Bug fixes</h3>
<ul>
<li>non-administrators can now submit again</li>
<li>installations now preserve file creation dates, eliminating confusion with upgrades</li>
<li>authorization editing pages no longer create null entries in database, and no longer handles them poorly (no longer gives blank page instead of displaying policies.)</li>
<li>registration page Invalid token error page now displayed when an invalid token is received (as opposed to internal server error.) Fixes SF bug #739999</li>
<li>eperson admin 'recent submission' links fixed for DSpaces deployed somewhere other than at / (e.g. /dspace).</li>
<li>help pages Link to help pages now includes servlet context (e.g. '/dspace'). Fixes SF bug #738399.</li>
</ul>
<h3><a name="History-Improvements"></a>Improvements</h3>
<ul>
<li><em>bin/dspace-info.pl</em> now checks jsp and asset store files for zero-length files</li>
<li><em>make-release-package</em> now works with SourceForge CVS</li>
<li>eperson editor now doesn't display the spurious text 'null'</li>
<li>item exporter now uses Jakarta's cli command line arg parser (much cleaner)</li>
<li>item importer improvements:
<ul>
<li>now uses Jakarta's cli command line arg parser (much cleaner)</li>
<li>imported items can now be routed through a workflow</li>
<li>more validation and error messages before import</li>
<li>can now use email addresses and handles instead of just database IDs</li>
<li>can import an item to a collection with the workflow suppressed</li>
</ul>
</li>
</ul>
<h2><a name="History-ChangesinDSpace1.1"></a>Changes in DSpace 1.1</h2>
<ul>
<li>Fixed various OAI-related bugs; DSpace's OAI support should now be correct. Note that harvesting is now based on the new Item 'last modified' date (as opposed to the Dublin Core <em>date.available</em> date.)</li>
<li>Fixed Handle support--DSpace now responds to naming authority requests correctly.</li>
<li>Multiple bitstream stores can now be specified; this allows DSpace storage to span several disks, and so there is no longer a hard limit on storage.</li>
<li>Search improvements:
<ul>
<li>New fielded searching UI</li>
<li>Search results are now paged</li>
<li>Abstracts are indexed</li>
<li>Better use of Lucene API; should stop the number of open file handles getting large</li>
</ul>
</li>
<li>Submission UI improvements:
<ul>
<li>now insists on a title being specified</li>
<li>fixed navigation on file upload page</li>
<li>citation &amp; identifier fields for previously published submissions now fixed</li>
</ul>
</li>
<li>Many Unicode fixes to the database and Web user interface</li>
<li>Collections can now be deleted</li>
<li>Bitstream descriptions (if available) displayed on item display page</li>
<li>Modified a couple of servlets to handle invalid parameters better (i.e. to report a suitable error message instead of an internal server error)</li>
<li>Item templates now work</li>
<li>Fixed registration token expiration problem (they no longer expire.)</li>
</ul>
</td>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td height="12" background="https://wiki.duraspace.org/images/border/border_bottom.gif"><img src="images/border/spacer.gif" width="1" height="1" border="0"/></td>
</tr>
<tr>
<td align="center"><font color="grey">Document generated by Confluence on Nov 06, 2010 19:27</font></td>
</tr>
</table>
</body>
</html>

View File

@@ -0,0 +1,850 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>DSpace Documentation : Installation</title>
<link rel="stylesheet" href="styles/site.css" type="text/css" />
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
<table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
<tr>
<td valign="top" class="pagebody">
<div class="pageheader">
<span class="pagetitle">
DSpace Documentation : Installation
</span>
</div>
<div class="pagesubheading">
This page last changed on Nov 06, 2010 by <font color="#0050B2">jtrimble</font>.
</div>
<h1><a name="Installation-DSpaceSystemDocumentation%3AInstallation"></a>DSpace System Documentation: Installation</h1>
<h2><a name="Installation-FortheImpatient"></a>For the Impatient</h2>
<p>Since some users might want to get their test version up and running as fast as possible, offered below is an <em>unsupported</em> outline of getting DSpace to run quickly.</p>
<p>Only experienced unix admins should even attempt the following without going to Section 3.3 <span class="image-wrap" style=""><img src="attachments/22022840/22675570.png" style="border: 0px solid black"/></span></p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">useradd -m dspace
gunzip -c dspace-1.x-src-release.tar.gz | tar -xf -
createuser -U postgres -d -A -P dspace
createdb -U dspace -E UNICODE dspace
cd [dspace-source]/dspace/config
vi dspace.cfg
mkdir [dspace]
chown dspace [dspace]
su - dspace
cd [dspace-source]/dspace
mvn <span class="code-keyword">package</span>
cd [dspace-source]/dspace/target/dspace-&lt;version&gt;-build.dir
ant fresh_install
cp -r [dspace]/webapps/* [tomcat]/webapps
/etc/init.d/tomcat start
[dspace]/bin/dspace create-administrator</pre>
</div></div>
<p>Prerequisite Software</p>
<p>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.</p>
<p>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.</p>
<h3><a name="Installation-UNIXlikeOSorMicrosoftWindows"></a>UNIX-like OS or Microsoft Windows</h3>
<ul>
<li>UNIX-like OS (Linux, HP/UX 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 distributions documentation to determine what is already available. </li>
<li>Microsoft Windows: (see full Windows Instructions for full set of prerequisites)</li>
</ul>
<h3><a name="Installation-OracleJavaJDK6orlater%28standardSDKisfine%2Cyoudon%27tneedJ2EE%29"></a>Oracle Java JDK 6 or later (standard SDK is fine, you don't need J2EE)</h3>
<p>DSpace now requires <b>Oracle</b> Java 6 or greater because of usage of new language capabilities introduced in 5 and 6 that make coding easier and cleaner.</p>
<p>Java can be downloaded from the following location: <a href="http://java.sun.com/javase/downloads/index.jsp" title="http://java.sun.com/javase/downloads/index.jsp">http://java.sun.com/javase/downloads/index.jsp</a></p>
<p>Only Oracle's Java has been tested with each release and is known to work correctly. Other flavors of Java may pose problems.</p>
<h3><a name="Installation-ApacheMaven2.0.8orlater%28Javabuildtool%29"></a>Apache Maven 2.0.8 or later (Java build tool)</h3>
<p>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 exisitng Maven projects found in the <em>[dspace-source]/dspace/modules</em> directory or by adding in your own Maven project to build the installation package for DSpace, and apply any custom interface "overlay" changes.</p>
<p>Maven can be downloaded from the following location: <a href="http://maven.apache.org/download.html" title="http://maven.apache.org/download.html">http://maven.apache.org/download.html</a></p>
<h4><a name="Installation-ConfiguringaProxy"></a>Configuring a Proxy</h4>
<p>You can configure a proxy to use for some or all of your HTTP requests in Maven 2.0. 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 <em>settings.xml</em> file (usually <em>${user.home}/.m2/settings.xml</em>) is secured with permissions appropriate for your operating system).</p>
<p>Example:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">&lt;settings&gt;
.
.
&lt;proxies&gt;
&lt;proxy&gt;
&lt;active&gt;<span class="code-keyword">true</span>&lt;/active&gt;
&lt;protocol&gt;http&lt;/protocol&gt;
&lt;host&gt;proxy.somewhere.com&lt;/host&gt;
&lt;port&gt;8080&lt;/port&gt;
&lt;username&gt;proxyuser&lt;/username&gt;
&lt;password&gt;somepassword&lt;/password&gt;
&lt;nonProxyHosts&gt;www.google.com|*.somewhere.com&lt;/nonProxyHosts&gt;
&lt;/proxy&gt;
&lt;/proxies&gt;
.
.
&lt;/settings&gt; </pre>
</div></div>
<h3><a name="Installation-ApacheAnt1.7orlater%28Javabuildtool%29"></a>Apache Ant 1.7 or later (Java build tool)</h3>
<p>Apache Ant is still required for the second stage of the build process. It is used once the installation package has been constructed in <em>[dspace-source]/dspace/target/dspace-&lt;version&gt;-build.dir</em> and still uses some of the familiar ant build targets found in the 1.4.x build process.</p>
<p>Ant can be downloaded from the following location: <a href="http://ant.apache.org/" title="http://ant.apache.org">http://ant.apache.org</a></p>
<h3><a name="Installation-RelationalDatabase%3A%28PostgreSQLorOracle%29."></a>Relational Database: (PostgreSQL or Oracle).</h3>
<ul>
<li><b>PostgreSQL 8.1 to 8.4</b> PostgreSQL can be downloaded from the following location: <a href="http://www.postgresql.org/" title="http://www.postgresql.org/">http://www.postgresql.org/ </a>. It is highly recommended that you try to work with Postgres 8.4 or greater, however, 8.1 or greater should still work. Unicode (specifically UTF-8) support must be enabled. This is enabled by default in 8.0+. Once installed, you need to enable TCP/IP connections (DSpace uses JDBC). In <em>postgresql.conf</em>: uncomment the line starting: <em>listen_addresses = 'localhost'</em>. Then tighten up security a bit by editing <em>pg_hba.conf</em> and adding this line: <em>host dspace dspace 127.0.0.1 255.255.255.255 md5</em>. Then restart PostgreSQL.</li>
<li><b>Oracle 10g or greater</b> Details on acquiring Oracle can be downloaded from the following location: <a href="http://www.oracle.com/database/" title="http://www.oracle.com/database/">http://www.oracle.com/database/</a>. 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. <em>dspace</em>) and ensure that it has permissions to add and remove tables in the database. Refer to the Quick Installation for more details.
<ul>
<li><b>NOTE:</b> DSpace uses sequences to generate unique object IDs &#8212; beware Oracle sequences, which are said to lose their values when doing a database export/import, say restoring from a backup. Be sure to run the script <em>etc/update-sequences.sql</em>.</li>
<li>For people interested in switching from Postgres to Oracle, I know of no tools that would do this automatically. You will need to recreate the community, collection, and eperson structure in the Oracle system, and then use the item export and import tools to move your content over.</li>
</ul>
</li>
</ul>
<h3><a name="Installation-ServletEngine%3A%28ApacheTomcat5.5or6%2CJetty%2CCauchoResinorequivalent%29."></a>Servlet Engine: (Apache Tomcat 5.5 or 6, Jetty, Caucho Resin or equivalent).</h3>
<ul>
<li><b>Apache Tomcat 5.5 or later.</b> Tomcat can be downloaded from the following location: <a href="http://tomcat.apache.org/whichversion.html" title="http://tomcat.apache.org">http://tomcat.apache.org</a>.
<ul>
<li>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 '<em>dspace</em>'. Set the environment variable <em>TOMCAT_USER</em> appropriately.</li>
<li>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: <em>JAVA_OPTS="-Xmx512M &#45;Xms64M &#45;Dfile.encoding=UTF-8"</em></li>
<li><b>Modifications in</b> <b><em>[tomcat]/conf/server.xml</em></b>: 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 <em>&lt;Connector&gt;</em> element in <em>[tomcat]/config/server.xml</em>: <em>URIEncoding="UTF-8"</em> e.g. if you're using the default Tomcat config, it should read:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">&lt;!-- Define a non-SSL HTTP/1.1 Connector on port 8080 --&gt;
&lt;Connector port=<span class="code-quote">"8080"</span>
maxThreads=<span class="code-quote">"150"</span>
minSpareThreads=<span class="code-quote">"25"</span>
maxSpareThreads=<span class="code-quote">"75"</span>
enableLookups=<span class="code-quote">"<span class="code-keyword">false</span>"</span>
redirectPort=<span class="code-quote">"8443"</span>
acceptCount=<span class="code-quote">"100"</span>
connectionTimeout=<span class="code-quote">"20000"</span>
disableUploadTimeout=<span class="code-quote">"<span class="code-keyword">true</span>"</span>
URIEncoding=<span class="code-quote">"UTF-8"</span>/&gt;
</pre>
</div></div>
<p>You may change the port from 8080 by editing it in the file above, and by setting the variable <em>CONNECTOR_PORT</em> in <em>server.xml</em>.</p></li>
</ul>
</li>
<li><b>Jetty or Caucho Resin</b> DSpace will also run on an equivalent servlet Engine, such as Jetty (<a href="http://www.mortbay.org/jetty/index.html" title="http://www.mortbay.org/jetty/index.html">http://www.mortbay.org/jetty/index.html</a>) or Caucho Resin (<a href="http://www.caucho.com/" title="http://www.caucho.com/)">http://www.caucho.com/)</a>. Jetty and Resin are configured for correct handling of UTF-8 by default.</li>
</ul>
<h3><a name="Installation-Perl%28requiredfor%5Cdspace%5C%2Fbin%2Fdspaceinfo.pl%29"></a>Perl (required for [dspace]/bin/dspace-info.pl)</h3>
<h2><a name="Installation-InstallationOptions"></a>Installation Options</h2>
<h3><a name="Installation-OverviewofInstallOptions"></a>Overview of Install Options</h3>
<p>With the advent of a new Apache <a href="http://maven.apache.org/" title="Maven 2">Maven 2</a> based build architecture in DSpace 1.5.x, you now have two options in how you may wish to install and manage your local installation of DSpace. If you've used DSpace 1.4.x, please recognize that the initial build procedure has changed to allow for more customization. You will find the later 'Ant based' stages of the installation procedure familiar. Maven is used to resolve the dependencies of DSpace online from the 'Maven Central Repository' server.</p>
<p>It is important to note that the strategies are identical in terms of the list of procedures required to complete the build process, the only difference being that the Source Release includes "more modules" that will be built given their presence in the distribution package.</p>
<ul>
<li>Default Release (dspace-&lt;version&gt;-release.zip)
<ul>
<li>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.  </li>
<li>This method allows you to customize DSpace configurations (in dspace.cfg) or user interfaces, using basic pre-built interface "overlays". </li>
<li>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. </li>
<li>This approach exposes the parts of the application that the DSpace committers would prefer to see customized. All other modules are downloaded from the 'Maven Central Repository' The directory structure for this release is the following:
<ul>
<li><em>[dspace-source]</em>
<ul>
<li><em>dspace/</em> &#45; DSpace 'build' and configuration module</li>
<li><em>pom.xml</em> &#45; DSpace Parent Project definition</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li>Source Release (dspace-&lt;version&gt;-src-release.zip)
<ul>
<li>This method is recommended for those who wish to develop DSpace further or alter its underlying capabilities to a greater degree. </li>
<li>It contains <b>all</b> dspace code for the core dspace-api, supporting servlets, taglibraries, aspects and themes for Manakin (dspace-xmlui), and other webservice/applications.</li>
<li>Provides all the same capabilities as the normal release. The directory structure for this release is more detailed:
<ul>
<li><em>[dspace-source]</em>
<ul>
<li><em>dspace/</em> &#45; DSpace 'build' and configuration module</li>
<li><em>dspace-api/</em> &#45; Java API source module</li>
<li><em>dspace-jspui/</em> &#45; JSP-UI source module</li>
<li><em>dspace-oai</em> &#45; OAI-PMH source module</li>
<li><em>dspace-xmlui</em> &#45; XML-UI (Manakin) source module</li>
<li><em>dspace-lni</em> &#45; Lightweight Network Interface source module</li>
<li><em>dspace-sword</em> &#8211; SWORD (Simple Web-serve Offering Repository Deposit) deposit service source module</li>
<li><em>dspace-test</em> &#8211; DSpace Tests (Unit and Integration Tests)</li>
<li><em>pom.xml</em> &#45; DSpace Parent Project definition</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h3><a name="Installation-OverviewofDSpaceDirectories"></a>Overview of DSpace Directories</h3>
<p>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.)</p>
<p>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:</p>
<ol>
<li><b>The installation directory</b>, referred to as _<em>[dspace]</em>_ . This is the location where DSpace is installed and running off of it is the location that gets 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 to.</li>
<li><b>The source directory</b>, referred to as _<em>[dspace-source]</em>_ . This is the location where the DSpace release distribution has been unzipped into. It usually has the name of the archive that you expanded such as <em>dspace-&lt;version&gt;</em><em><del>release</del></em> or <em>dspace&lt;version&gt;-src-release</em>. It is the directory where all of your "build" commands will be run.</li>
<li><b>The web deployment directory</b>. This is the directory that contains your DSpace web application(s). In DSpace 1.5.x and above, this corresponds to _<em>[dspace]/webapps</em>_ by default. However, if you are using Tomcat, you may decide to copy your DSpace web applications from _<em>[dspace]/webapps/</em>_ to <em>[tomcat]/webapps/</em> (with <em>[tomcat]</em> being wherever you installed TomcatÄîalso known as <em>$CATALINA_HOME</em>).<br/>
For details on the contents of these separate directory trees, refer to directories.html. <em>Note that the &#95;[dspace-source]</em> and <em>[dspace]</em> directories are always separate&#33;&#95;</li>
</ol>
<h3><a name="Installation-Installation"></a>Installation</h3>
<p>This method gets you up and running with DSpace quickly and easily. It is identical in both the Default Release and Source Release distributions.</p>
<ol>
<li><b>Create the DSpace user</b>. This needs to be the same user that Tomcat (or Jetty etc.) will run as. e.g. as <b><em>root</em></b> run:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">useradd -m dspace</pre>
</div></div></li>
<li><b>Download</b> the <a href="http://sourceforge.net/projects/dspace/" title="latest DSpace release">latest DSpace release</a> There are two version available with each release of DSpace: (<em>dspace-1.x-release.</em> and <em>dspace-1.x-src-release.xxx</em>); you only need to choose one. If you want a copy of all underlying Java source code, you should download the <em>dspace-1.x-src-release.xxx</em> Within each version, you have a choice of compressed file format. Choose the one that best fits your environment.</li>
<li><b>Unpack the DSpace software</b>. After downloading the software, based on the compression file format, choose one of the following methods to unpack your software:
<ol>
<li><b>Zip file</b>. If you downloaded <em>dspace-1.6-release.zip</em> do the following:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">unzip dspace-1.7-release.zip</pre>
</div></div></li>
<li><b>.gz file</b>. If you downloaded <em>dspace-1.6-release.tar.gz</em> do the following:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">gunzip -c dspace-1.7-release.tar.gz | tar -xf -</pre>
</div></div></li>
<li><b>.bz2 file</b>. If you downloaded &#95;dspace-1.6-release.tar.bz2_do the following:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">bunzip2 dspace-1.7-release.tar.bz | tar -xf -</pre>
</div></div>
<p>For ease of reference, we will refer to the location of this unzipped version of the DSpace release as <em>[dspace-source]</em> in the remainder of these instructions.After unpacking the file, the user may which to change the ownership of the <em>dspace-1.6-release</em> to the 'dspace' user. (And you may need to change the group).</p></li>
</ol>
</li>
<li><b>Database Setup</b>
<br class="atl-forced-newline" />
<em>PostgreSQL:</em>
<ol>
<li>A PostgreSQL 8.1-404 jdbc3 driver is configured as part of the default DSpace build. You no longer need to copy any PostgreSQL jars to get PostgreSQL installed.</li>
<li>Create a <tt>dspace}}database, owned by the {{dspace</tt> PostgreSQL user <em>(you are still logged in at 'root')</em>:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">createuser -U postgres -d -A -P dspace ; createdb -U dspace -E UNICODE dspace</pre>
</div></div>
<p>You will be prompted for a password for the DSpace database. (This isn't the same as the <em>dspace</em> user's UNIX password.)
<br class="atl-forced-newline" />
<b><em>Oracle</em></b><em>:</em></p></li>
<li>Setting up 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: <a href="http://www.oracle.com/technology/software/tech/java/sqlj_jdbc/htdocs/jdbc_10201.html" title="http://www.oracle.com/technology/software/tech/java/sqlj_jdbc/htdocs/jdbc_10201.html">http://www.oracle.com/technology/software/tech/java/sqlj_jdbc/htdocs/jdbc_10201.html</a><em>$ mvn install:install-file &#45;Dfile=ojdbc14.jar &#45;DgroupId=com.oracle \ &#45;DartifactId=ojdbc14 &#45;Dversion=10.2.0.2.0 &#45;Dpackaging=jar &#45;DgeneratePom=true</em></li>
<li>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. Create a user account for DSpace (e.g. <em>dspace</em>,) and ensure that it has permissions to add and remove tables in the database.</li>
<li>Edit the <em>[dspace-source]/dspace/config/dspace.cfg</em> database settings:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">db.name = oracle
db.url = jdbc:oracle:thin:@<span class="code-comment">//host:port/dspace
</span>db.driver = oracle.jdbc.OracleDriver
</pre>
</div></div></li>
</ol>
</li>
<li><b>Initial Configuration*Edit_[dspace-source]/dspace/config/dspace.cfg_, in particular you'll need to set these properties:</b><b><em>dspace.dir</em></b> <b>&#45;&#45; must be set to the</b> <b><em>[dspace]</em></b> <b>(installation) directory.</b><b><em>dspace.url</em></b> <b>&#45;&#45; complete URL of this server's DSpace home page.</b><b><em>dspace.hostname</em></b> <b>&#45;&#45; fully-qualified domain name of web server.</b><b><em>dspace.name</em></b> <b>&#45;&#45; "Proper" name of your server, e.g. "My Digital Library".</b><b><em>db.password</em></b> <b>&#45;&#45; the database password you entered in the previous step.</b><b><em>mail.server</em></b> <b>&#45;&#45; fully-qualified domain name of your outgoing mail server.</b><b><em>mail.from.address</em></b> <b>&#45;&#45; the "From:" address to put on email sent by DSpace.</b><b><em>feedback.recipient</em></b> <b>&#45;&#45; mailbox for feedback mail.</b><b><em>mail.admin</em></b> <b>&#45;&#45; mailbox for DSpace site administrator.</b><b><em>alert.recipient</em></b> <b>&#45;&#45; mailbox for server errors/alerts (not essential but very useful&#33;)</b><b><em>registration.notify</em></b> <b>&#45;&#45; mailbox for emails when new users register (optional) &#42;NOTE:</b> You can interpolate the value of one configuration variable in the value of another one. For example, to set <em>feedback.recipient</em> to the same value as <em>mail.admin</em>, the line would look like:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"> feedback.recipient = ${mail.admin}</pre>
</div></div>
<p>Refer to <em>5.2. General Configuration</em> for details and examples of the above.</p></li>
<li><b>DSpace Directory</b><br/>
Create the directory for the DSpace installation (i.e. <tt>[dspace]</tt>). As <em>root</em> (or a user with appropriate permissions), run:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">mkdir [dspace]
chown dspace [dspace]</pre>
</div></div>
<p>(Assuming the <em>dspace</em> UNIX username.)</p></li>
<li><b>Installation Package</b><br/>
As the <em>dspace</em> UNIX user, generate the DSpace installation package in the <tt>[dspace-source]/dspace</tt> directory:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">cd [dspace-source]/dspace/
mvn <span class="code-keyword">package</span></pre>
</div></div>
<p>Note: without any extra arguments, the DSpace installation package is initialized for PostgreSQL. <em>If you want to use Oracle instead, you should build the DSpace installation package as follows:</em></p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">mvn -Ddb.name=oracle <span class="code-keyword">package</span></pre>
</div></div></li>
<li><b>Build DSpace and Initialize Database</b><br/>
As the <em>dspace</em> UNIX user, initialize the DSpace database and install DSpace to <tt>[dspace]&#95;</tt>:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">cd [dspace-source]/dspace/target/dspace-[version]-build.dir
ant fresh_install</pre>
</div></div>
<p>To see a complete list of build targets, run:&nbsp;<b>ant help</b> <em>The most likely thing to go wrong here is the database connection. See the &#95;3.7 Common Problems Section</em>.</p></li>
<li><b>Deploy Web Applications.</b><br/>
You have two choices or techniques for having Tomcat/Jetty/Resin serve up your web applications:
<ul>
<li>Technique A. 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:
<br class="atl-forced-newline" /> <tt>cp &#45;R [dspace]/webapps/&#42; [tomcat]/webapps&#42;</tt> (This will copy all the web applications to Tomcat).
<br class="atl-forced-newline" /> <tt>cp &#45;R [dspace]/webapps/jspui [tomcat]/webapps&#42;</tt> (This will copy only the jspui web application to Tomcat.)</li>
<li>Technique B. Tell your Tomcat/Jetty/Resin installation where to find your DSpace web application(s). As an example, in the <tt>\&lt;Host</tt>&gt; section of your <tt>[tomcat]/conf/server.xml</tt> you could add lines similar to the following (but replace <tt>[dspace]</tt> with your installation location:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">&lt;!-- Define the <span class="code-keyword">default</span> virtual host
Note: XML Schema validation will not work with Xerces 2.2.
--&gt;
&lt;Host name=<span class="code-quote">"localhost"</span> appBase=<span class="code-quote">"[dspace]/webapps"</span>
....</pre>
</div></div></li>
</ul>
</li>
<li><b>Administrator Account</b><br/>
Create an initial administrator account:
<br class="atl-forced-newline" />
<tt>[dspace]/bin/dspace create-administrator</tt></li>
<li><b>Initial Startup&#33;</b><br/>
Now the moment of truth&#33; 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&#33; Base URLs of DSpace Web Applications:
<ul>
<li><em>JSP User Interface</em> &#45; (e.g.) <tt><a href="http://dspace.myu.edu:8080/jspui">http://dspace.myu.edu:8080/jspui</a></tt></li>
<li><em>XML User Interface</em> (aka. Manakin) - (e.g.) <tt><a href="http://dspace.myu.edu:8080/xmlui">http://dspace.myu.edu:8080/xmlui</a></tt></li>
<li><em>OAI-PMH Interface</em> &#45; (e.g.) <tt><a href="http://dspace.myu.edu:8080/oai/request?verb=Identify">http://dspace.myu.edu:8080/oai/request?verb=Identify</a></tt> (Should return an XML-based response)</li>
</ul>
</li>
</ol>
<p>In order to set up some communities and collections, you'll need to login as your DSpace Administrator (which you created with <tt>create-administrator</tt> above) and access the administration UI in either the JSP or XML user interface.</p>
<h2><a name="Installation-AdvancedInstallation"></a>Advanced Installation</h2>
<p>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.</p>
<h3><a name="Installation-%27cron%27Jobs"></a>'cron' Jobs</h3>
<p>A couple of DSpace features require that a script is run regularly &#8211; the e-mail subscription feature that alerts users of new items being deposited, and the new 'media filter' tool, that generates thumbnails of images and extracts the full-text of documents for indexing.</p>
<p>To set these up, you just need to run the following command as the <em>dspace</em> UNIX user:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">crontab -e</pre>
</div></div>
<p>Then add the following lines:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"># Send out subscription e-mails at 01:00 every day
0 1 * * * [dspace]/bin/dspace sub-daily
# Run the media filter at 02:00 every day
0 2 * * * [dspace]/bin/dspace filter-media
# Run the checksum checker at 03:00
0 3 * * * [dspace]/bin/dspace checker -lp
# Mail the results to the sysadmin at 04:00
0 4 * * * [dspace]/bin/dspace checker-emailer -c
</pre>
</div></div>
<p>Naturally you should change the frequencies to suit your environment.</p>
<p>PostgreSQL also benefits from regular 'vacuuming', which optimizes the indexes and clears out any deleted data. Become the <em>postgres</em> UNIX user, run <em>crontab &#45;e</em> and add (for example):</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"># Clean up the database nightly at 4.20am
20 4 * * * vacuumdb --analyze dspace &gt; /dev/<span class="code-keyword">null</span> 2&gt;&amp;1</pre>
</div></div>
<p>In order that statistical reports are generated regularly and thus kept up to date you should set up the following cron jobs:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"># Run stat analysis
0 1 * * * [dspace]/bin/dspace stat-general
0 1 * * * [dspace]/bin/dspace stat-monthly
0 2 * * * [dspace]/bin/dspace stat-report-general
0 2 * * * [dspace]/bin/dspace stat-report-monthly</pre>
</div></div>
<p>Obviously, you should choose execution times which are most useful to you, and you should ensure that the <em><del>report</del></em> scripts run a short while after the analysis scripts to give them time to complete (a run of around 8 months worth of logs can take around 25 seconds to complete); the resulting reports will let you know how long analysis took and you can adjust your cron times accordingly.</p>
<h3><a name="Installation-MultilingualInstallation"></a>Multilingual Installation</h3>
<p>In order to deploy a multilingual version of DSpace you have to configure two parameters in <em>[dspace-source]/config/dspace.cfg:</em></p>
<p><em>default.locale</em>, e. g. default.locale = en</p>
<p><em>webui.supported locales</em>, e. g. webui.supported.locales = en, de</p>
<p>The Locales might have the form country, country_language, country_language_variant.</p>
<p>According to the languages you wish to support, you have to make sure, that all the i18n related files are available see the Multilingual User Interface Configuring MultiLingual Support section for the JSPUI or the Multilingual Support for XMLUI in the configuration documentation.</p>
<h3><a name="Installation-DSpaceoverHTTPS"></a>DSpace over HTTPS</h3>
<p>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. <em>dspace.myuni.edu/dspace/password-login</em>) 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.</p>
<p>The solution is to use <em>HTTPS</em> (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.</p>
<p>The following sections show how to set up the most commonly-used Java Servlet containers to support HTTP over SSL.</p>
<h4><a name="Installation-ToenabletheHTTPSsupportinTomcat5.0%3A"></a>To enable the HTTPS support in Tomcat 5.0:</h4>
<ol>
<li><b>For Production use:</b> 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, <em>$CATALINA_BASE</em> is the directory under which your Tomcat is installed.
<ol>
<li>Create a Java keystore for your server with the password <em>changeit</em>, and install your server certificate under the alias <em>"tomcat"</em>. This assumes the certificate was put in the file <em>server.pem</em>:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">$JAVA_HOME/bin/keytool -<span class="code-keyword">import</span> -noprompt -v -storepass changeit
-keystore $CATALINA_BASE/conf/keystore -alias tomcat -file
myserver.pem</pre>
</div></div></li>
<li>Install the CA (Certifying Authority) certificate for the CA that granted your server cert, if necessary. This assumes the server CA certificate is in <em>ca.pem</em>:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"> $JAVA_HOME/bin/keytool -<span class="code-keyword">import</span> -noprompt -storepass changeit
-trustcacerts -keystore $CATALINA_BASE/conf/keystore -alias ServerCA
-file ca.pem
</pre>
</div></div></li>
<li>Optional &#8211; 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 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 <em>client1.pem</em>:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">$JAVA_HOME/bin/keytool -<span class="code-keyword">import</span> -noprompt -storepass changeit
-trustcacerts -keystore $CATALINA_BASE/conf/keystore -alias client1
-file client1.pem
</pre>
</div></div></li>
<li>Now add another Connector tag to your <em>server.xml</em> 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)
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"> &lt;Connector port=<span class="code-quote">"8443"</span>
maxThreads=<span class="code-quote">"150"</span> minSpareThreads=<span class="code-quote">"25"</span>
maxSpareThreads=<span class="code-quote">"75"</span>
enableLookups=<span class="code-quote">"<span class="code-keyword">false</span>"</span>
disableUploadTimeout=<span class="code-quote">"<span class="code-keyword">true</span>"</span>
acceptCount=<span class="code-quote">"100"</span> debug=<span class="code-quote">"0"</span>
scheme=<span class="code-quote">"https"</span> secure=<span class="code-quote">"<span class="code-keyword">true</span>"</span> sslProtocol=<span class="code-quote">"TLS"</span>
keystoreFile=<span class="code-quote">"conf/keystore"</span> keystorePass=<span class="code-quote">"changeit"</span> clientAuth=<span class="code-quote">"<span class="code-keyword">true</span>"</span> - ONLY <span class="code-keyword">if</span> using client X.509 certs <span class="code-keyword">for</span> authentication!
truststoreFile=<span class="code-quote">"conf/keystore"</span> trustedstorePass=<span class="code-quote">"changeit"</span> /&gt;
</pre>
</div></div>
<p>Also, check that the default Connector is set up to redirect "secure" requests to the same port as your SSL connector, e.g.:  </p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">&lt;Connector port=<span class="code-quote">"8080"</span>
maxThreads=<span class="code-quote">"150"</span> minSpareThreads=<span class="code-quote">"25"</span>
maxSpareThreads=<span class="code-quote">"75"</span>
enableLookups=<span class="code-quote">"<span class="code-keyword">false</span>"</span>
redirectPort=<span class="code-quote">"8443"</span>
acceptCount=<span class="code-quote">"100"</span> debug=<span class="code-quote">"0"</span> /&gt;
</pre>
</div></div></li>
</ol>
</li>
<li><b>Quick-and-dirty Procedure for Testing:</b> If you are just setting up a DSpace server for testing, or to experiment with HTTPS, then you don't need to get a real server certificate. You can create a "self-signed" certificate for testing; web browsers will issue warnings before accepting it but they will function exactly the same after that as with a "real" certificate.  In the examples below, <em>$CATALINA_BASE</em> is the directory under which your Tomcat is installed.
<ol>
<li>Optional &#8211; ONLY if you don't already have a server certificate. Follow this sub-procedure to request a new, signed server certificate from your Certifying Authority (CA): 
<ul>
<li>Create a new key pair under the alias name <em>"tomcat"</em>. When generating your key, give the Distinguished Name fields the appropriate values for your server and institution. CN should be the fully-qualified domain name of your server host. Here is an example:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">$JAVA_HOME/bin/keytool -genkey -alias tomcat -keyalg RSA -keysize
1024 \
-keystore $CATALINA_BASE/conf/keystore -storepass changeit
-validity 365 \
-dname 'CN=dspace.myuni.edu, OU=MIT Libraries, O=Massachusetts
Institute of Technology, L=Cambridge, S=MA, C=US'
</pre>
</div></div></li>
<li>Then, create a <em>CSR</em> (Certificate Signing Request) and send it to your Certifying Authority. They will send you back a signed Server Certificate. This example command creates a CSR in the file <em>tomcat.csr</em>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"> $JAVA_HOME/bin/keytool -keystore $CATALINA_BASE/conf/keystore
-storepass changeit \
-certreq -alias tomcat -v -file tomcat.csr
</pre>
</div></div></li>
<li>Before importing the signed certificate, you must have the CA's certificate in your keystore as a <em>trusted certificate</em>. Get their certificate, and import it with a command like this (for the example <em>mitCA.pem</em>):
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"> $JAVA_HOME/bin/keytool -keystore $CATALINA_BASE/conf/keystore
-storepass changeit \
-<span class="code-keyword">import</span> -alias mitCA -trustcacerts -file mitCA.pem
</pre>
</div></div></li>
<li>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 <em>signed-cert.pem</em>)
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"> $JAVA_HOME/bin/keytool -keystore $CATALINA_BASE/conf/keystore
-storepass changeit \
-<span class="code-keyword">import</span> -alias tomcat -trustcacerts -file signed-cert.pem
</pre>
</div></div>
<p> Since you now have a signed server certificate in your keystore, you can, obviously, skip the next steps of installing a signed server certificate and the server CA's certificate. </p></li>
</ul>
</li>
<li>Create a Java keystore for your server with the password <em>changeit</em>, and install your server certificate under the alias <em>"tomcat"</em>. This assumes the certificate was put in the file <em>server.pem</em>:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"> $JAVA_HOME/bin/keytool -genkey -alias tomcat -keyalg RSA -keystore
$CATALINA_BASE/conf/keystore -storepass changeit
</pre>
</div></div>
<p>When answering the questions to identify the certificate, be sure to respond to "First and last name" with the fully-qualified domain name of your server (e.g. <em>test-dspace.myuni.edu</em>). The other questions are not important.</p></li>
<li>Optional &#8211; 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 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 <em>client1.pem</em>:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"> $JAVA_HOME/bin/keytool -<span class="code-keyword">import</span> -noprompt -storepass changeit
-trustcacerts -keystore $CATALINA_BASE/conf/keystore -alias client1
-file client1.pem
</pre>
</div></div></li>
<li>Follow the procedure in the section above to add another Connector tag, for the HTTPS port, to your <em>server.xml</em> file.</li>
</ol>
</li>
</ol>
<h4><a name="Installation-TouseSSLonApacheHTTPDwithmodjk%3A"></a>To use SSL on Apache HTTPD with mod_jk:</h4>
<p>If you choose <a href="http://httpd.apache.org/" title="Apache HTTPD">Apache HTTPD</a> as your primary HTTP server, you can have it forward requests to the <a href="http://tomcat.apache.org/" title="Tomcat servlet container">Tomcat servlet container</a> via <a href="http://tomcat.apache.org/connectors-doc/" title="Apache Jakarta Tomcat Connector">Apache Jakarta Tomcat Connector</a>. This can be configured to work over SSL as well. First, you must configure Apache for SSL; for Apache 2.0 see <a href="http://httpd.apache.org/docs/2.0/ssl/" title="Apache SSL/TLS Encryption">Apache SSL/TLS Encryption</a> for information about using <a href="http://httpd.apache.org/docs/2.0/mod/mod_ssl.html" title="mod_ssl">mod_ssl</a>.</p>
<p><b><em>If you are using X.509 Client Certificates for authentication:</em></b> add these configuration options to the appropriate <em>httpd</em> configuration file, e.g. <em>ssl.conf</em>, and be sure they are in force for the virtual host and namespace locations dedicated to DSpace:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"> ## SSLVerifyClient can be <span class="code-quote">"optional"</span> or
<span class="code-quote">"require"</span>
SSLVerifyClient optional
SSLVerifyDepth 10
SSLCACertificateFile
path-to-your-client-CA-certificate
SSLOptions StdEnvVars ExportCertData
</pre>
</div></div>
<p>Now consult the <a href="http://tomcat.apache.org/connectors-doc/" title="Apache Jakarta Tomcat Connector">Apache Jakarta Tomcat Connector</a> documentation to configure the <em>mod_jk</em> (note: <b>NOT</b><em>mod_jk2</em>) module. Select the AJP 1.3 connector protocol. Also follow the instructions there to configure your Tomcat server to respond to AJP.</p>
<p><b>To use SSL on Apache HTTPD with mod_webapp</b> consult the DSpace 1.3.2 documentation. Apache have deprecated the <em>mod_webapp</em> connector and recommend using <em>mod_jk</em>.</p>
<p><b>To use Jetty's HTTPS support</b> consult the documentation for the relevant tool.</p>
<h3><a name="Installation-TheHandleServer"></a>The Handle Server</h3>
<p>First a few facts to clear up some common misconceptions:</p>
<ul>
<li>You don't <b>have</b> 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.</li>
<li>You'll notice that while you've been playing around with a test server, DSpace has apparently been creating handles for you looking like <em>hdl:123456789/24</em> 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. <br/>
If you want to use the Handle system, you'll need to set up a Handle server. This 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 <a href="http://www.handle.net/" title="the central CNRI Handle site">the central CNRI Handle site</a>.</li>
</ul>
<p>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 broadcast and receive TCP on port 2641.</p>
<ol>
<li>To configure your DSpace installation to run the handle server, run the following command: <em>[dspace]/bin/dspace make-handle-config_Ensure that &#95;[dspace]/handle-server</em> matches whatever you have in <em>dspace.cfg</em> for the <em>handle.dir</em> property.</li>
<li>Edit the resulting <em>[dspace]/handle-server/config.dct</em> file to include the following lines in the <em>"server_config"</em> clause:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"><span class="code-quote">"storage_type"</span> = <span class="code-quote">"CUSTOM"</span>
<span class="code-quote">"storage_class"</span> = <span class="code-quote">"org.dspace.handle.HandlePlugin"</span>
</pre>
</div></div>
<p>This tells the Handle server to get information about individual Handles from the DSpace code. </p></li>
<li>Once the configuration file has been generated, you will need to go to <a href="http://hdl.handle.net/4263537/5014" title="http://hdl.handle.net/4263537/5014">http://hdl.handle.net/4263537/5014</a> 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.</li>
<li>When CNRI has sent you your naming authority prefix, you will need to edit the <em>config.dct</em> file. The file will be found in <em>/[dspace]/handle-server</em>. Look for <em>"300:0.NA/YOUR_NAMING_AUTHORITY"_Replace &#95;YOUR_NAMING_AUTHORITY</em> with the assigned naming authority prefix sent to you.</li>
<li>Now start your handle server (as the dspace user): 
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">[dspace]/bin/start-handle-server</pre>
</div></div>
<p>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.</p></li>
</ol>
<h4><a name="Installation-UpdatingExistingHandlePrefixes"></a>Updating Existing Handle Prefixes</h4>
<p>If you need to update the handle prefix on items created before the CNRI registration process you can run the <em>[dspace]/bin/dspace update-handle-prefix script</em>. 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:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">[dspace]/bin/dspace update-handle-prefix 123456789 1303
</pre>
</div></div>
<p>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.</p>
<h3><a name="Installation-GoogleandHTMLsitemaps"></a>Google and HTML sitemaps</h3>
<p>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.</p>
<p>Sitemaps allow DSpace to expose it's 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.</p>
<p>To generate the sitemaps, you need to run <em>[dspace]/bin/generate-sitemaps</em> This creates the sitemaps in <em>[dspace]/sitemaps/</em></p>
<p>The sitemaps can be accessed from the following URLs:</p>
<ul>
<li><a href="http://dspace.example.com/dspace/sitemap">http://dspace.example.com/dspace/sitemap</a> &#45; Index sitemap </li>
<li><a href="http://dspace.example.com/dspace/sitemap?map=0">http://dspace.example.com/dspace/sitemap?map=0</a> &#45; First list of items (up to 50,000) </li>
<li><a href="http://dspace.example.com/dspace/sitemap?map=n">http://dspace.example.com/dspace/sitemap?map=n</a> &#45; Subsequent lists of items (e.g. 50,0001 to 100,000) etc... <br/>
HTML sitemaps follow the same procedure:</li>
<li><a href="http://dspace.example.com/dspace/htmlmap">http://dspace.example.com/dspace/htmlmap</a> &#45; Index sitemap </li>
<li>etc... </li>
</ul>
<p>When running <em>[dspace]/bin/generate-sitemaps</em> 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 (<em>/dspace/sitemap</em>) with Google at <a href="http://www.google.com/webmasters/sitemaps/" title="http://www.google.com/webmasters/sitemaps/">http://www.google.com/webmasters/sitemaps/</a>. If your DSpace server requires the use of a HTTP proxy to connect to the Internet, ensure that you have set <em>http.proxy.host</em> and <em>http.proxy.port</em> in <em>[dspace]/config/dspace.cfg</em></p>
<p>The URL for pinging Google, and in future, other search engines, is configured in <em>[dspace-space]/config/dspace.cfg</em> using the <em>sitemap.engineurls</em> setting where you can provide a comma-separated list of URLs to 'ping'.</p>
<p>You can generate the sitemaps automatically every day using an additional cron job:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"># Generate sitemaps
0 6 * * * [dspace]/bin/generate-sitemaps
</pre>
</div></div>
<h3><a name="Installation-DSpaceStatistics"></a>DSpace Statistics</h3>
<p>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 5.2.35 DSpace Statistic Configuration for detailed information.</p>
<ol>
<li><b>DSpace Configuration for Accessing Solr.</b> In the <em>dspace.cfg</em> file review the following fields to make sure they are uncommented:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">solr.log.server = ${dspace.baseUrl}/solr/statistics
solr.dbfile = ${dspace.dir}/config/GeoLiteCity.dat
solr.spiderips.urls = http:<span class="code-comment">//iplists.com/google.txt, \
</span> http:<span class="code-comment">//iplists.com/inktomi.txt, \
</span> http:<span class="code-comment">//iplists.com/lycos.txt, \
</span> http:<span class="code-comment">//iplists.com/infoseek.txt, \
</span> http:<span class="code-comment">//iplists.com/altavista.txt, \
</span> http:<span class="code-comment">//iplists.com/excite.txt, \
</span> http:<span class="code-comment">//iplists.com/misc.txt, \
</span> http:<span class="code-comment">//iplists.com/non_engines.txt</span></pre>
</div></div></li>
<li><b>DSpace logging configuration for Solr.</b> If your DSpace instance is protected by a proxy server, in order for Solr to log the correct IP address of the user rather than of the proxy, it must be configured to look for the X-Forwarded-For header.&nbsp; This feature can be enabled by ensuring the following setting is uncommented in the logging section of <em>dspace.cfg</em>:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">useProxies = <span class="code-keyword">true</span></pre>
</div></div></li>
<li><b>DSpace configuration for fields indexed into Solr Event records for search.</b> In the <em>dspace.cfg</em> file, review the following property keys to make sure they are uncommented:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">statistics.items.dc.1=dc.identifier
statistics.items.dc.2=dc.date.accessioned
statistics.items.type.1=dcinput
statistics.items.type.2=date
statistics.<span class="code-keyword">default</span>.start.datepick = 01/01/1977</pre>
</div></div></li>
<li><b>Configuration Control.</b> In the <em>dspace.cfg</em> set the following property key:_statistics.item.authorization.admin=true_This will require the user to sign on to see that statistics. Setting the statistics to "false" will make them publicly available. </li>
<li>Final steps. 
<ul>
<li>Perform the following step: 
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">cd [dspace-source]/dspace
mvn <span class="code-keyword">package</span>
cd [dspace-source]/dspace/target/dspace-&lt;version&gt;-build.dir
ant -Dconfig=[dspace]/config/dspace.cfg update
cp -R [dspace]/webapps/* [TOMCAT]/webapps
</pre>
</div></div>
<p>If you only need to build the statistics, and don't make any changes to other web applications, you can replace the copy step above with: <em>cp &#45;R [dspace]/webapps/solr [TOMCAT]/webapps</em></p></li>
<li>Restart your webapps (Tomcat/Jetty/Resin) </li>
</ul>
</li>
</ol>
<h2><a name="Installation-WindowsInstallation"></a>Windows Installation</h2>
<h3><a name="Installation-PrerequisiteSoftware"></a>Pre-requisite Software</h3>
<p>You'll need to install this pre-requisite software:</p>
<ul>
<li><a href="http://java.sun.com/" title="Java SDK 1.5">Java SDK 1.5</a> or later (standard SDK is fine, you don't need J2EE)</li>
<li><a href="http://www.postgresql.org/ftp/" title="PostgreSQL 8.x for Windows">PostgreSQL 8.x for Windows</a> OR <a href="http://www.oracle.com/database/" title="Oracle 9 or later">Oracle 9 or later</a>.
<ul>
<li>If you install PostgreSQL, it's recommended to select to install the pgAdmin III tool</li>
</ul>
</li>
<li><a href="http://ant.apache.org/" title="Apache Ant 1.6.2 or later">Apache Ant 1.6.2 or later</a>. Unzip the package in <em>C: and add C:\apache-ant-1.6.2\bin</em> to the <em>PATH</em> environment variable. For Ant to work properly, you should ensure that <em>JAVA_HOME</em> is set.</li>
<li><a href="http://tomcat.apache.org/" title="Jakarta Tomcat 5.x or later">Jakarta Tomcat 5.x or later</a></li>
<li><a href="http://maven.apache.org/" title="Apache Maven 2.0.8 or later">Apache Maven 2.0.8 or later</a></li>
</ul>
<h3><a name="Installation-InstallationSteps"></a>Installation Steps</h3>
<ol>
<li>Download the DSpace source from <a href="http://sourceforge.net/projects/dspace" title="SourceForge">SourceForge</a> and untar it (<a href="http://www.winzip.com/" title="WinZip">WinZip</a> will do this)</li>
<li>Ensure the PostgreSQL service is running, and then run pgAdmin III (Start &#45;&gt; PostgreSQL 8.0 &#45;&gt; pgAdmin III). Connect to the local database as the postgres user and:
<ul>
<li>Create a 'Login Role' (user) called <em>dspace</em> with the password <em>dspace</em></li>
<li>Create a database called <em>dspace</em> owned by the user <em>dspace</em>, with UTF-8 encoding</li>
</ul>
</li>
<li>Update paths in <em>[dspace-source]\dspace\config\dspace.cfg</em>. <b>Note:</b> Use forward slashes / for path separators, though you can still use drive letters, e.g.:_dspace.dir = C:/DSpace_Make sure you change all of the parameters with file paths to suit, specifically: 
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"> dspace.dir
config.template.log4j.properties
config.template.log4j-handle-plugin.properties
config.template.oaicat.properties
assetstore.dir
log.dir
upload.temp.dir
report.dir
handle.dir
</pre>
</div></div></li>
<li>Create the directory for the DSpace installation (e.g. <em>C:\DSpace</em>)</li>
<li>Generate the DSpace installation package by running the following from command line (cmd) from your <em>[dspace-source]/dspace/</em> directory:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">mvn <span class="code-keyword">package</span>
</pre>
</div></div>
<p>Note #1: This will generate the DSpace installation package in your <em>[dspace-source]/dspace/target/dspace-[version]-build.dir/</em> directory.Note #2: 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: </p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">mvn -Ddb.name=oracle <span class="code-keyword">package</span>
</pre>
</div></div></li>
<li>Initialize the DSpace database and install DSpace to <em>[dspace]</em> (e.g. <em>C:\DSpace</em>) by running the following from command line from your <em>[dspace-source]/dspace/target/dspace-[version]-build.dir/</em> directory:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">ant fresh_install
</pre>
</div></div>
<p><b>Note:</b> to see a complete list of build targets, run</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">ant help
</pre>
</div></div></li>
<li>Create an administrator account, by running the following from your <em>[dspace]</em> (e.g. <em>C:\DSpace</em>) directory_[dspace]\bin\dspace create-administrator_and enter the required information </li>
<li>Copy the Web application directories from <em>[dspace]\webapps to Tomcat's webapps dir, which should be somewhere like C:\Program Files\Apache Software Foundation\Tomcat 5.5\webapps</em>
<ul>
<li>Alternatively, Tell your Tomcat installation where to find your DSpace web application(s). As an example, in the <em>&lt;Host&gt;</em> section of your <em>[tomcat]/conf/server.xml</em> you could add lines similar to the following (but replace <em>[dspace]</em> with your installation location):
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">&lt;!-- DEFINE A CONTEXT PATH FOR DSpace JSP User Interface --&gt;
&lt;Context path=<span class="code-quote">"/jspui"</span> docBase=<span class="code-quote">"[dspace]\webapps\jspui"</span> debug=<span class="code-quote">"0"</span>
reloadable=<span class="code-quote">"<span class="code-keyword">true</span>"</span> cachingAllowed=<span class="code-quote">"<span class="code-keyword">false</span>"</span>
allowLinking=<span class="code-quote">"<span class="code-keyword">true</span>"</span>/&gt;
&lt;!-- DEFINE A CONTEXT PATH FOR DSpace OAI User Interface --&gt;
&lt;Context path=<span class="code-quote">"/oai"</span> docBase=<span class="code-quote">"[dspace]\webapps\oai"</span> debug=<span class="code-quote">"0"</span>
reloadable=<span class="code-quote">"<span class="code-keyword">true</span>"</span> cachingAllowed=<span class="code-quote">"<span class="code-keyword">false</span>"</span>
allowLinking=<span class="code-quote">"<span class="code-keyword">true</span>"</span>/&gt;
</pre>
</div></div></li>
</ul>
</li>
<li>Start the Tomcat service</li>
<li>Browse to either <a href="http://localhost:8080/jspui_">http://localhost:8080/jspui</a> or <a href="http://localhost:8080/xmlui_">http://localhost:8080/xmlui</a>. You should see the DSpace home page for either the JSPUI or XMLUI, respectively.</li>
</ol>
<h2><a name="Installation-CheckingYourInstallation"></a>Checking Your Installation</h2>
<p>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.</p>
<ul>
<li>System is up and running. <em>User can see the DSpace home page. [Tomcat/Jetty, firewall, IP assignment, DNS]</em></li>
<li>Database is running and working correctly. <em>Attempt to create a user, community or collection [PostgreSQL, Oracle]</em><em>Run the test database command to see if other issues are being report:</em><em>[dspace]/bin/dspace test-database</em></li>
<li>Email subsystem is running. The user can issue the following command to test the email system. t 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, will refer you to the DSpace documentation. <em>[dspace]/bin/test-email</em></li>
</ul>
<h2><a name="Installation-KnownBugs"></a>Known Bugs</h2>
<p>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.</p>
<p>The known bugs in a release are documented in the <em>KNOWN_BUGS</em> file in the source package.</p>
<p>Please see the <a href="#Installation-%5C" title="DSpace bug tracker|">DSpace bug tracker\</a> 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.</p>
<h2><a name="Installation-CommonProblems"></a>Common Problems</h2>
<p>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.</p>
<ul>
<li><b>Database errors occur when you run</b> <b><em>ant fresh_install</em></b>: There are two common errors that occur. If your error looks like this-- 
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">[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)</pre>
</div></div>
<p>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 <em>db.username</em> and <em>db.password</em> properties are correctly set in <em>[dspace-source]/config/dspace.cfg</em>.An easy way to check that your DB is working OK over TCP/IP is to try this on the command line: </p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">psql -U dspace -W -h localhost</pre>
</div></div>
<p>Enter the <em>dspace</em><em>database</em> password, and you should be dropped into the psql tool with a <em>dspace=&gt;</em> prompt.Another common error looks like this: </p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">[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)</pre>
</div></div>
<p>This means that the PostgreSQL JDBC driver is not present in <em>[dspace-source]/lib</em>. See above.</p></li>
<li><b>Tomcat doesn't shut down</b>: 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:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">ps -ef | grep java</pre>
</div></div>
<p>and look for Tomcat's Java processes. If they stay around after running Tomcat's <em>shutdown.sh</em> script, trying <em>kill_ing them (with &#95;-9</em> if necessary), then starting Tomcat again.</p></li>
<li><b>Database connections don't work, or accessing DSpace takes forever</b>: 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:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">ps -ef | grep postgres</pre>
</div></div>
<p>You might see some processes like this:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">dspace 16325 1997 0 Feb 14 ? 0:00 postgres: dspace dspace
127.0.0.1 idle in transaction</pre>
</div></div>
<p>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.:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">dspace 16325 1997 0 Feb 14 ? 0:00 postgres: dspace dspace
127.0.0.1 SELECT</pre>
</div></div>
<p>This means the connection is in the middle of a <em>SELECT</em> operation, and if you're not using DSpace right that instant, it's probably a 'zombie' connection. If this is the case, try &#95;kill_ing the process, and stopping and restarting Tomcat.</p></li>
</ul>
<br/>
<div class="tabletitle">
<a name="attachments">Attachments:</a>
</div>
<div class="greybox" align="left">
<img src="images/icons/bullet_blue.gif" height="8" width="8" alt=""/>
<a href="attachments/22022840/22675570.png">warning.png</a> (image/png)
<br/>
</div>
</td>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td height="12" background="https://wiki.duraspace.org/images/border/border_bottom.gif"><img src="images/border/spacer.gif" width="1" height="1" border="0"/></td>
</tr>
<tr>
<td align="center"><font color="grey">Document generated by Confluence on Nov 06, 2010 19:27</font></td>
</tr>
</table>
</body>
</html>

View File

@@ -0,0 +1,71 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>DSpace Documentation : Introduction</title>
<link rel="stylesheet" href="styles/site.css" type="text/css" />
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
<table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
<tr>
<td valign="top" class="pagebody">
<div class="pageheader">
<span class="pagetitle">
DSpace Documentation : Introduction
</span>
</div>
<div class="pagesubheading">
This page last changed on Nov 06, 2010 by <font color="#0050B2">jtrimble</font>.
</div>
<h1><a name="Introduction-DSpaceSystemDocumentation%3AIntroduction"></a>DSpace System Documentation: Introduction</h1>
<p>DSpace is an open source software platform that enables organisations to:</p>
<ul>
<li>capture and describe digital material using a submission workflow module, or a variety of programmatic ingest options</li>
<li>distribute an organisation's digital assets over the web through a search and retrieval system</li>
<li>preserve digital assets over the long term<br/>
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.</li>
</ul>
<p>For people actually running a DSpace service, there is an installation guide, and sections on configuration and the directory structure. Note that as of DSpace 1.2, the administration user interface guide is now on-line help available from within the DSpace system.</p>
<p>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 and design section.</p>
<p>Other good sources of information are:</p>
<ul>
<li>The DSpace Public API Javadocs. Build these with the command <em>mvn javadoc:javadoc</em>.</li>
<li>The <a href="http://wiki.dspace.org/" title="DSpace Wiki">DSpace Wiki</a> 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:
<ul>
<li><a href="http://wiki.dspace.org/index.php/DSpaceResources" title="A list of DSpace resources">A list of DSpace resources</a> (Web sites, mailing lists etc.)</li>
<li><a href="http://wiki.dspace.org/index.php/TechnicalFaq" title="Technical FAQ">Technical FAQ</a></li>
<li><a href="http://www.dspace.org/whos-using-dspace/Repository-List.html" title="A list of projects using DSpace">A list of projects using DSpace</a></li>
<li><a href="http://wiki.dspace.org/index.php/ContributionGuidelines" title="Guidelines for contributing back to DSpace">Guidelines for contributing back to DSpace</a></li>
</ul>
</li>
<li><a href="http://www.dspace.org/" title="www.dspace.org">www.dspace.org</a> has announcements and contains useful information about bringing up an instance of DSpace at your organization.</li>
<li>The<a href="https://lists.sourceforge.net/lists/listinfo/dspace-general" title="DSpace General List">DSpace General List</a>. Join DSpace-General to ask questions or join discussions about non-technical 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-General for news of software releases, user conferences, and announcements from the DSpace Federation.</li>
<li>The <a href="https://lists.sourceforge.net/lists/listinfo/dspace-tech" title="DSpace Technical List">DSpace Technical List</a>. 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.</li>
<li>The <a href="https://lists.sourceforge.net/lists/listinfo/dspace-devel" title="DSpace Development List">DSpace Development List</a>. 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.</li>
</ul>
</td>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td height="12" background="https://wiki.duraspace.org/images/border/border_bottom.gif"><img src="images/border/spacer.gif" width="1" height="1" border="0"/></td>
</tr>
<tr>
<td align="center"><font color="grey">Document generated by Confluence on Nov 06, 2010 19:27</font></td>
</tr>
</table>
</body>
</html>

View File

@@ -0,0 +1,107 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>DSpace Documentation : JSPUI Configuration and Customization</title>
<link rel="stylesheet" href="styles/site.css" type="text/css" />
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
<table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
<tr>
<td valign="top" class="pagebody">
<div class="pageheader">
<span class="pagetitle">
DSpace Documentation : JSPUI Configuration and Customization
</span>
</div>
<div class="pagesubheading">
This page last changed on Nov 06, 2010 by <font color="#0050B2">jtrimble</font>.
</div>
<h1><a name="JSPUIConfigurationandCustomization-DSpaceSystemDocumentation%3AJPSUIConfigurationandCustomization"></a>DSpace System Documentation: JPSUI Configuration and Customization</h1>
<p>The DSpace digital repository supports two user interfaces: one based on JavaServer Pages (JSP) technologies and one based upon the Apache Cocoon framework. This chapter describes those parameters which are specific to the JPSUI interface.</p>
<h2><a name="JSPUIConfigurationandCustomization-Configuration"></a>Configuration</h2>
<p>The user will need to refer to the extensive WebUI/JSPUI configurations that are contained in 5.2.36 JSP Web Interface Settings.</p>
<h2><a name="JSPUIConfigurationandCustomization-CustomizingtheJSPpages"></a>Customizing the JSP pages</h2>
<p>The JSPUI interface is implemented using Java Servlets which handle the business logic, and JavaServer Pages (JSPs) which produce the HTML pages sent to an end-user. Since the JSPs are much closer to HTML than Java code, altering the look and feel of DSpace is relatively easy.</p>
<p>To make it even easier, DSpace allows you to 'override' the JSPs included in the source distribution with modified versions, that are stored in a separate place, so when it comes to updating your site with a new DSpace release, your modified versions will not be overwritten. It should be possible to dramatically change the look of DSpace to suit your organization by just changing the CSS style file and the site 'skin' or 'layout' JSPs in <em>jsp/layout</em>; if possible, it is recommended you limit local customizations to these files to make future upgrades easier.</p>
<p>You can also easily edit the text that appears on each JSP page by editing the <em>Messages.properties</em> file. However, note that unless you change the entry in all of the different language message files, users of other languages will still see the default text for their language. See Internationalization in Application Layer.</p>
<p>Note that the data (attributes) passed from an underlying Servlet to the JSP may change between versions, so you may have to modify your customized JSP to deal with the new data.</p>
<p>Thus, if possible, it is recommended you limit your changes to the 'layout' JSPs and the stylesheet.</p>
<p>The JSPs are available in one of two places:</p>
<ul>
<li><em>[dspace-source]/dspace-jspui/dspace-jspui-webapp/src/main/webapp/</em> &#45; Only exists if you downloaded the full Source Release of DSpace</li>
<li><em>[dspace-source]/dspace/target/dspace-[version].dir/webapps/dspace-jspui-webapp/</em> &#45; The location where they are copied after first building DSpace.<br/>
If you wish to modify a particular JSP, place your edited version in the <b><em>[dspace-source]/dspace/modules/jspui/src/main/webapp/</em></b> directory (<em>this is the replacement for the pre-1.5 &#95;/jsp/local</em> directory_), with the same path as the original. If they exist, these will be used in preference to the default JSPs. For example:
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'> <b>DSpace default</b> </td>
<td class='confluenceTd'> <b>Locally-modified version</b> </td>
</tr>
<tr>
<td class='confluenceTd'> <em>[jsp.dir]/community-list.jsp</em> </td>
<td class='confluenceTd'> <em>[jsp.custom-dir]/dspace/modules/jspui/src/main/webapp/community-list.jsp</em> </td>
</tr>
<tr>
<td class='confluenceTd'> <em>[jsp.dir]/mydspace/main.jsp</em> </td>
<td class='confluenceTd'> <em>[jsp.custom-dir]/dspace/modules/jspui/src/main/webapp/mydspace/main.jsp</em> </td>
</tr>
</tbody></table>
</div>
</li>
</ul>
<p>Heavy use is made of a style sheet, <em>styles.css</em>. If you make edits, copy the local version to <em>[jsp.custom-dir]/dspace/modules/jspui/src/main/webapp/styles.css</em>, and it will be used automatically in preference to the default, as described above.</p>
<p>Fonts and colors can be easily changed using the stylesheet. The stylesheet is a JSP so that the user's browser version can be detected and the stylesheet tweaked accordingly.</p>
<p>The 'layout' of each page, that is, the top and bottom banners and the navigation bar, are determined by the JSPs <em>/layout/header&#45;</em><b><em>.jsp</em></b> <b>and</b> <b><em>/layout/footer&#45;</em></b><em>.jsp</em>. You can provide modified versions of these (in <em>[jsp.custom-dir]/dspace/modules/jspui/src/main/webapp/layout</em>), or define more styles and apply them to pages by using the "style" attribute of the <em>dspace:layout</em> tag.</p>
<ol>
<li>Rebuild the DSpace installation package by running the following command from your <em>[dspace-source]/dspace/</em> directory:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">mvn <span class="code-keyword">package</span></pre>
</div></div></li>
<li>Update all DSpace webapps to <em>[dspace]/webapps</em> by running the following command from your <em>[dspace-source]/dspace/target/dspace-[version]-build.dir</em> directory:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">ant -Dconfig=[dspace]/config/dspace.cfg update </pre>
</div></div></li>
<li>Deploy the the new webapps:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">cp -R /[dspace]/webapps/* /[tomcat]/webapps</pre>
</div></div></li>
<li>Restart Tomcat <br/>
When you restart the web server you should see your customized JSPs.</li>
</ol>
</td>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td height="12" background="https://wiki.duraspace.org/images/border/border_bottom.gif"><img src="images/border/spacer.gif" width="1" height="1" border="0"/></td>
</tr>
<tr>
<td align="center"><font color="grey">Document generated by Confluence on Nov 06, 2010 19:27</font></td>
</tr>
</table>
</body>
</html>

52
dspace/docs/html/Preface.html Executable file
View File

@@ -0,0 +1,52 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>DSpace Documentation : Preface</title>
<link rel="stylesheet" href="styles/site.css" type="text/css" />
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
<table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
<tr>
<td valign="top" class="pagebody">
<div class="pageheader">
<span class="pagetitle">
DSpace Documentation : Preface
</span>
</div>
<div class="pagesubheading">
This page last changed on Nov 03, 2010 by <font color="#0050B2">jtrimble</font>.
</div>
<h1><a name="Preface-Preface"></a>Preface</h1>
<p>Welcome to Release 1.7.0. &nbsp;The committers have volunteered many hours to fix, re-write and contribute new software code for this release. Documentation has been updated. &nbsp;</p>
<p>This version of the documentation was produced with Confluence software. &nbsp;HTML and PDF versions were generated from the Confluence wiki software.</p>
<p>The following is a list of the new features included (not an exhaustive list) for release 1.7.0.</p>
<p>The following people have contributed to this release of DSpace: @mire, BioMed Central, Andrea Bollini, Ben Bosman, Flavio Botelho, Peter Dietz, Mark Diggory, Tim Donohue, Serhij Dubyk, Enovation Solutions, Sands Fish Javier Garrido, Keith Gilbertson, Ladd Hanson, Leonie Hayes, Paulo Jobim, Claudia Juergen, Keller, Fabio Kepler, Yin Yin Latt, Stuart Lewis, Bram Luyten, Van Ly, Ivan Masar, Alexey Maslov, Gabriela Mircea, Hardik Mishra, Caryn, Neiswender, Venessa Newton-Wade, OhioLINK, Ekaterina Pechekhonova, Dale Poulter, Toni Prieto, Richard Rodgers, Ricardo Saraiva, Andreas Schwander, Kim Shepherd, Elin Stangeland, Larry Stone, Keiji Suzuki, Robin Taylor, Graham Triggs, Jeffrey Trimble, Kevin Van de velde, Steve Williams and Mark Wood. Many of them could not do this work without the support (release time and financial) of their institutions that they are associated with. We offer thanks to those institutions for supporting their staff to take time to contribute to the DSpace project.</p>
<p>We apologize to any committer left off this list. &nbsp;DSpace has such a large, arctive development community that we sometimes loose track of all our contributors. &nbsp;Our ongoing list of all known people/institutions that contribute to DSpace can be found on our DSpace Contributors Wiki page (<a href="http://wiki.dspace.org/confluence/display/DSPACE/DSpaceContributors">http://wiki.dspace.org/confluence/display/DSPACE/DSpaceContributors</a>). &nbsp;Acknowledgements to those left off will be made in future releases.</p>
<p>The Documentation Gardener for this release was Jeffrey Trimble with input from everyone. &nbsp;All typos are his fault. &lt;para&gt;Kim Shepherd is the Release Co-ordinator of this release.&lt;/para&gt; &lt;para&gt;Additional thanks to Tim Donohue from DuraSpace on keeping all of us focused on the work at hand, and calming us when we got excited and for the general support for the DSpace project.&lt;/para&gt;<br/>
Peter Dietz is the Release Co-ordinator of this release.</p>
<p>Additional thanks to Tim Donohue from DuraSpace on keeping all of us focused on the work at hand, and calming us when we got excited and for the general support for the DSpace project.</p>
</td>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td height="12" background="https://wiki.duraspace.org/images/border/border_bottom.gif"><img src="images/border/spacer.gif" width="1" height="1" border="0"/></td>
</tr>
<tr>
<td align="center"><font color="grey">Document generated by Confluence on Nov 06, 2010 19:27</font></td>
</tr>
</table>
</body>
</html>

275
dspace/docs/html/Storage.html Executable file
View File

@@ -0,0 +1,275 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>DSpace Documentation : Storage</title>
<link rel="stylesheet" href="styles/site.css" type="text/css" />
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
<table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
<tr>
<td valign="top" class="pagebody">
<div class="pageheader">
<span class="pagetitle">
DSpace Documentation : Storage
</span>
</div>
<div class="pagesubheading">
This page last changed on Nov 06, 2010 by <font color="#0050B2">jtrimble</font>.
</div>
<h1><a name="Storage-DSpaceSystemDocumentation%3AStorageLayer"></a>DSpace System Documentation: Storage Layer</h1>
<p>In this section, we explain the storage layer: the database structure, maintenance, and the bistream store and configurations.</p>
<h2><a name="Storage-RDBMS%2FDatabaseStructure"></a>RDBMS / Database Structure</h2>
<p>DSpace uses a relational database to store all information about the organization of content, metadata about the content, information about e-people and authorization, and the state of currently-running workflows. The DSpace system also uses the relational database in order to maintain indices that users can browse.</p>
<p><span class="image-wrap" style=""><img src="attachments/22022822/21954891.png" style="border: 1px solid black"/></span></p>
<p>Most of the functionality that DSpace uses can be offered by any standard SQL database that supports transactions. Presently, the browse indices use some features specific to <a href="http://www.postgresql.org/" title="PostgreSQL">PostgreSQL</a> and <a href="http://www.oracle.com/database/" title="Oracle">Oracle</a>, so some modification to the code would be needed before DSpace would function fully with an alternative database back-end.</p>
<p>The <em>org.dspace.storage.rdbms</em> package provides access to an SQL database in a somewhat simpler form than using JDBC directly. The main class is <em>DatabaseManager</em>, which executes SQL queries and returns <em>TableRow</em> or <em>TableRowIterator</em> objects. The <em>InitializeDatabase</em> class is used to load SQL into the database via JDBC, for example to set up the schema.</p>
<p>All calls to the <em>Database Manager</em> require a DSpace <em>Context</em> object. Example use of the database manager API is given in the <em>org.dspace.storage.rdbms</em> package Javadoc.</p>
<p>The database schema used by DSpace is created by SQL statements stored in a directory specific to each supported RDBMS platform:</p>
<ul>
<li>PostgreSQL schemas are in <em>[dspace-source]/dspace/etc/postgres/</em></li>
<li>Oracle schemas are in <em>[dspace-source]/dspace/etc/oracle/</em><br/>
The SQL (DDL) statements to create the tables for the current release, starting with an empty database, aer in <em>database_schema.sql</em>. The schema SQL file also creates the two required e-person groups (<em>Anonymous</em> and <em>Administrator</em>) that are required for the system to function properly.</li>
</ul>
<p>Also in <em>[dspace-source]/dspace/etc/[database]</em> are various SQL files called <em>database_schema_1x_1y</em>. These contain the necessary SQL commands to update a live DSpace database from version 1.<em>x</em> to 1.<em>y</em>. Note that this might not be the only part of an upgrade process: see Updating a DSpace Installation for details.</p>
<p>The DSpace database code uses an SQL function <em>getnextid</em> to assign primary keys to newly created rows. This SQL function must be safe to use if several JVMs are accessing the database at once; for example, the Web UI might be creating new rows in the database at the same time as the batch item importer. The PostgreSQL-specific implementation of the method uses <em>SEQUENCES</em> for each table in order to create new IDs. If an alternative database backend were to be used, the implementation of <em>getnextid</em> could be updated to operate with that specific DBMS.</p>
<p>The <em>etc</em> directory in the source distribution contains two further SQL files. <em>clean-database.sql</em> contains the SQL necessary to completely clean out the database, so use with caution&#33; The Ant target <em>clean_database</em> can be used to execute this. <em>update-sequences.sql</em> contains SQL to reset the primary key generation sequences to appropriate values. You'd need to do this if, for example, you're restoring a backup database dump which creates rows with specific primary keys already defined. In such a case, the sequences would allocate primary keys that were already used.</p>
<p>Versions of the <b><em>.sql</em></b> files for Oracle are stored in <em>[dspace-source]/dspace/etc/oracle</em>. These need to be copied over their PostgreSQL counterparts in <em>[dspace-source]/dspace/etc</em> prior to installation.</p>
<h3><a name="Storage-MaintenanceandBackup"></a>Maintenance and Backup</h3>
<p>When using PostgreSQL, it's a good idea to perform regular 'vacuuming' of the database to optimize performance. This is performed by the <em>vacuumdb</em> command which can be executed via a 'cron' job, for example by putting this in the system <em>crontab</em>:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"># clean up the database nightly
40 2 * * * /usr/local/pgsql/bin/vacuumdb --analyze dspace &gt; /dev/<span class="code-keyword">null</span> 2&gt;&amp;1
</pre>
</div></div>
<p>The DSpace database can be backed up and restored using usual methods, for example with <em>pg_dump</em> and <em>psql</em>. However when restoring a database, you will need to perform these additional steps:</p>
<ul>
<li>The <em>fresh_install</em> target loads up the initial contents of the Dublin Core type and bitstream format registries, as well as two entries in the <em>epersongroup</em> table for the system anonymous and administrator groups. Before you restore a raw backup of your database you will need to remove these, since they will already exist in your backup, possibly having been modified. For example, use:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">DELETE FROM dctyperegistry;
DELETE FROM bitstreamformatregistry;
DELETE FROM epersongroup;
</pre>
</div></div></li>
<li>After restoring a backup, you will need to reset the primary key generation sequences so that they do not produce already-used primary keys. Do this by executing the SQL in <em>[dspace-source]/dspace/etc/update-sequences.sql</em>, for example with:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">psql -U dspace -f [dspace-source]/dspace/etc/update-sequences.sql
</pre>
</div></div>
<p>Future updates of DSpace may involve minor changes to the database schema. Specific instructions on how to update the schema whilst keeping live data will be included. The current schema also contains a few currently unused database columns, to be used for extra functionality in future releases. These unused columns have been added in advance to minimize the effort required to upgrade.</p></li>
</ul>
<h3><a name="Storage-ConfiguringtheRDBMSComponent"></a>Configuring the RDBMS Component</h3>
<p>The database manager is configured with the following properties in <em>dspace.cfg</em>:</p>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'> db.url </td>
<td class='confluenceTd'> The JDBC URL to use for accessing the database. This should not point to a connection pool, since DSpace already implements a connection pool. </td>
</tr>
<tr>
<td class='confluenceTd'> db.driver </td>
<td class='confluenceTd'> JDBC driver class name. Since presently, DSpace uses PostgreSQL-specific features, this should be <em>org.postgresql.Driver</em>. </td>
</tr>
<tr>
<td class='confluenceTd'> db.username </td>
<td class='confluenceTd'> Username to use when accessing the database. </td>
</tr>
<tr>
<td class='confluenceTd'> db.password </td>
<td class='confluenceTd'> Corresponding password ot use when accessing the database. </td>
</tr>
</tbody></table>
</div>
<h2><a name="Storage-BitstreamStore"></a>Bitstream Store</h2>
<p>DSpace offers two means for storing content. The first is in the file system on the server. The second is using <a href="http://www.sdsc.edu/srb" title="SRB (Storage Resource Broker)">SRB (Storage Resource Broker)</a>. Both are achieved using a simple, lightweight API.</p>
<p>SRB is purely an option but may be used in lieu of the server's file system or in addition to the file system. Without going into a full description, SRB is a very robust, sophisticated storage manager that offers essentially unlimited storage and straightforward means to replicate (in simple terms, backup) the content on other local or remote storage resources.</p>
<p>The terms "store", "retrieve", "in the system", "storage", and so forth, used below can refer to storage in the file system on the server ("traditional") or in SRB.</p>
<p>The <em>BitstreamStorageManager</em> provides low-level access to bitstreams stored in the system. In general, it should not be used directly; instead, use the <em>Bitstream</em> object in the content management API since that encapsulated authorization and other metadata to do with a bitstream that are not maintained by the <em>BitstreamStorageManager</em>.</p>
<p>The bitstream storage manager provides three methods that store, retrieve and delete bitstreams. Bitstreams are referred to by their 'ID'; that is the primary key <em>bitstream_id</em> column of the corresponding row in the database.</p>
<p>As of DSpace version 1.1, there can be multiple bitstream stores. Each of these bitstream stores can be traditional storage or SRB storage. This means that the potential storage of a DSpace system is not bound by the maximum size of a single disk or file system and also that traditional and SRB storage can be combined in one DSpace installation. Both traditional and SRB storage are specified by configuration parameters. Also see Configuring the Bitstream Store below.</p>
<p>Stores are numbered, starting with zero, then counting upwards. Each bitstream entry in the database has a store number, used to retrieve the bitstream when required.</p>
<p>At the moment, the store in which new bitstreams are placed is decided using a configuration parameter, and there is no provision for moving bitstreams between stores. Administrative tools for manipulating bitstreams and stores will be provided in future releases. Right now you can move a whole store (e.g. you could move store number 1 from <em>/localdisk/store</em> to <em>/fs/anotherdisk/store</em> but it would still have to be store number 1 and have the exact same contents.</p>
<p>Bitstreams also have an 38-digit internal ID, different from the primary key ID of the bitstream table row. This is not visible or used outside of the bitstream storage manager. It is used to determine the exact location (relative to the relevant store directory) that the bitstream is stored in traditional or SRB storage. The first three pairs of digits are the directory path that the bitstream is stored under. The bitstream is stored in a file with the internal ID as the filename.</p>
<p>For example, a bitstream with the internal ID <em>12345678901234567890123456789012345678</em> is stored in the directory:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">(assetstore dir)/12/34/56/12345678901234567890123456789012345678
</pre>
</div></div>
<p>The reasons for storing files this way are:</p>
<ul>
<li>Using a randomly-generated 38-digit number means that the 'number space' is less cluttered than simply using the primary keys, which are allocated sequentially and are thus close together. This means that the bitstreams in the store are distributed around the directory structure, improving access efficiency.</li>
<li>The internal ID is used as the filename partly to avoid requiring an extra lookup of the filename of the bitstream, and partly because bitstreams may be received from a variety of operating systems. The original name of a bitstream may be an illegal UNIX filename.<br/>
When storing a bitstream, the <em>BitstreamStorageManager</em> DOES set the following fields in the corresponding database table row:</li>
</ul>
<ul>
<li><em>bitstream_id</em></li>
<li><em>size</em></li>
<li><em>checksum</em></li>
<li><em>checksum_algorithm</em></li>
<li><em>internal_id</em></li>
<li><em>deleted</em></li>
<li><em>store_number</em><br/>
The remaining fields are the responsibility of the <em>Bitstream</em> content management API class.</li>
</ul>
<p>The bitstream storage manager is fully transaction-safe. In order to implement transaction-safety, the following algorithm is used to store bitstreams:</p>
<ol>
<li>A database connection is created, separately from the currently active connection in the current DSpace context.</li>
<li>An unique internal identifier (separate from the database primary key) is generated.</li>
<li>The bitstream DB table row is created using this new connection, with the <em>deleted</em> column set to <em>true</em>.</li>
<li>The new connection is &#95;commit_ted, so the 'deleted' bitstream row is written to the database</li>
<li>The bitstream itself is stored in a file in the configured 'asset store directory', with a directory path and filename derived from the internal ID</li>
<li>The <em>deleted</em> flag in the bitstream row is set to <em>false</em>. This will occur (or not) as part of the current DSpace <em>Context</em>.<br/>
This means that should anything go wrong before, during or after the bitstream storage, only one of the following can be true:</li>
</ol>
<ul>
<li>No bitstream table row was created, and no file was stored</li>
<li>A bitstream table row with <em>deleted=true</em> was created, no file was stored</li>
<li>A bitstream table row with <em>deleted=true</em> was created, and a file was stored<br/>
None of these affect the integrity of the data in the database or bitstream store.</li>
</ul>
<p>Similarly, when a bitstream is deleted for some reason, its <em>deleted</em> flag is set to true as part of the overall transaction, and the corresponding file in storage is <em>not</em> deleted.</p>
<p>The above techniques mean that the bitstream storage manager is transaction-safe. Over time, the bitstream database table and file store may contain a number of 'deleted' bitstreams. The <em>cleanup</em> method of <em>BitstreamStorageManager</em> goes through these deleted rows, and actually deletes them along with any corresponding files left in the storage. It only removes 'deleted' bitstreams that are more than one hour old, just in case cleanup is happening in the middle of a storage operation.</p>
<p>This cleanup can be invoked from the command line via the <em>Cleanup</em> class, which can in turn be easily executed from a shell on the server machine using <em>/dspace/bin/cleanup</em>. You might like to have this run regularly by <em>cron</em>, though since DSpace is read-lots, write-not-so-much it doesn't need to be run very often.</p>
<h3><a name="Storage-Backup"></a>Backup</h3>
<p>The bitstreams (files) in traditional storage may be backed up very easily by simply 'tarring' or 'zipping' the <em>assetstore</em> directory (or whichever directory is configured in <em>dspace.cfg</em>). Restoring is as simple as extracting the backed-up compressed file in the appropriate location.</p>
<p>Similar means could be used for SRB, but SRB offers many more options for managing backup.</p>
<p>It is important to note that since the bitstream storage manager holds the bitstreams in storage, and information about them in the database, that a database backup and a backup of the files in the bitstream store must be made at the same time; the bitstream data in the database must correspond to the stored files.</p>
<p>Of course, it isn't really ideal to 'freeze' the system while backing up to ensure that the database and files match up. Since DSpace uses the bitstream data in the database as the authoritative record, it's best to back up the database before the files. This is because it's better to have a bitstream in storage but not the database (effectively non-existent to DSpace) than a bitstream record in the database but not storage, since people would be able to find the bitstream but not actually get the contents.</p>
<h3><a name="Storage-ConfiguringtheBitstreamStore"></a>Configuring the Bitstream Store</h3>
<p>Both traditional and SRB bitstream stores are configured in <em>dspace.cfg</em>.</p>
<h4><a name="Storage-ConfiguringTraditonalStorage"></a>Configuring Traditonal Storage</h4>
<p>Bitstream stores in the file system on the server are configured like this:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">assetstore.dir = [dspace]/assetstore
</pre>
</div></div>
<p>(Remember that <em>[dspace]</em> is a placeholder for the actual name of your DSpace install directory).</p>
<p>The above example specifies a single asset store.</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">assetstore.dir = [dspace]/assetstore_0
assetstore.dir.1 = /mnt/other_filesystem/assetstore_1
</pre>
</div></div>
<p>The above example specifies two asset stores. assetstore.dir specifies the asset store number 0 (zero); after that use assetstore.dir.1, assetstore.dir.2 and so on. The particular asset store a bitstream is stored in is held in the database, so don't move bitstreams between asset stores, and don't renumber them.</p>
<p>By default, newly created bitstreams are put in asset store 0 (i.e. the one specified by the assetstore.dir property.) This allows backwards compatibility with pre-DSpace 1.1 configurations. To change this, for example when asset store 0 is getting full, add a line to <em>dspace.cfg</em> like:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">assetstore.incoming = 1
</pre>
</div></div>
<p>Then restart DSpace (Tomcat). New bitstreams will be written to the asset store specified by <em>assetstore.dir.1</em>, which is <em>/mnt/other_filesystem/assetstore_1</em> in the above example.</p>
<h4><a name="Storage-ConfiguringSRBStorage"></a>Configuring SRB Storage</h4>
<p>The same framework is used to configure SRB storage. That is, the asset store number (0..n) can reference a file system directory as above or it can reference a set of SRB account parameters. But any particular asset store number can reference one or the other but not both. This way traditional and SRB storage can both be used but with different asset store numbers. The same cautions mentioned above apply to SRB asset stores as well: The particular asset store a bitstream is stored in is held in the database, so don't move bitstreams between asset stores, and don't renumber them.</p>
<p>For example, let's say asset store number 1 will refer to SRB. The there will be a set of SRB account parameters like this:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">srb.host.1 = mysrbmcathost.myu.edu
srb.port.1 = 5544
srb.mcatzone.1 = mysrbzone
srb.mdasdomainname.1 = mysrbdomain
srb.defaultstorageresource.1 = mydefaultsrbresource
srb.username.1 = mysrbuser
srb.password.1 = mysrbpassword
srb.homedirectory.1 = /mysrbzone/home/mysrbuser.mysrbdomain
srb.parentdir.1 = mysrbdspaceassetstore
</pre>
</div></div>
<p>Several of the terms, such as <em>mcatzone</em>, have meaning only in the SRB context and will be familiar to SRB users. The last, <em>srb.parentdir.n</em>, can be used to used for addition (SRB) upper directory structure within an SRB account. This property value could be blank as well.</p>
<p>(If asset store 0 would refer to SRB it would be <em>srb.host =</em> ..., <em>srb.port =</em> ..., and so on (<em>.0</em> omitted) to be consistent with the traditional storage configuration above.)</p>
<p>The similar use of <em>assetstore.incoming</em> to reference asset store 0 (default) or 1..n (explicit property) means that new bitstreams will be written to traditional or SRB storage determined by whether a file system directory on the server is referenced or a set of SRB account parameters are referenced.</p>
<p>There are comments in dspace.cfg that further elaborate the configuration of traditional and SRB storage.</p>
<br/>
<div class="tabletitle">
<a name="attachments">Attachments:</a>
</div>
<div class="greybox" align="left">
<img src="images/icons/bullet_blue.gif" height="8" width="8" alt=""/>
<a href="attachments/22022822/21954862.gif">db-schema.gif</a> (image/gif)
<br/>
<img src="images/icons/bullet_blue.gif" height="8" width="8" alt=""/>
<a href="attachments/22022822/21954891.png">db-schema.png</a> (image/png)
<br/>
</div>
</td>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td height="12" background="https://wiki.duraspace.org/images/border/border_bottom.gif"><img src="images/border/spacer.gif" width="1" height="1" border="0"/></td>
</tr>
<tr>
<td align="center"><font color="grey">Document generated by Confluence on Nov 06, 2010 19:27</font></td>
</tr>
</table>
</body>
</html>

View File

@@ -0,0 +1,531 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>DSpace Documentation : Submission User Interface</title>
<link rel="stylesheet" href="styles/site.css" type="text/css" />
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
<table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
<tr>
<td valign="top" class="pagebody">
<div class="pageheader">
<span class="pagetitle">
DSpace Documentation : Submission User Interface
</span>
</div>
<div class="pagesubheading">
This page last changed on Nov 06, 2010 by <font color="#0050B2">jtrimble</font>.
</div>
<h1><a name="SubmissionUserInterface-DSpaceSystemDocumentation%3ACustomizingandConfiguringSubmissionUserInterface"></a>DSpace System Documentation: Customizing and Configuring Submission User Interface</h1>
<p>This page explains various customization and configuration options that are available within DSpace for the Item Submission user interface.</p>
<h2><a name="SubmissionUserInterface-UnderstandingtheSubmissionConfigurationFile"></a>Understanding the Submission Configuration File</h2>
<p>The <em>[dspace]/config/item-submission.xml</em> contains the submission configurations for <em>both</em> 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.</p>
<h3><a name="SubmissionUserInterface-TheStructureofitemsubmission.xml"></a>The Structure of <em>item-submission.xml</em></h3>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">&lt;item-submission&gt;
&lt;!-- Where submission processes are mapped to specific Collections --&gt;
&lt;submission-map&gt;
&lt;name-map collection-handle=<span class="code-quote">"<span class="code-keyword">default</span>"</span> submission-name=<span class="code-quote">"traditional"</span> /&gt; ...
&lt;/submission-map&gt;
&lt;!-- Where <span class="code-quote">"steps"</span> which are used across many submission processes can be defined in a
single place. They can then be referred to by ID later. --&gt;
&lt;step-definitions&gt;
&lt;step id=<span class="code-quote">"collection"</span>&gt;
&lt;processing-class&gt;org.dspace.submit.step.SelectCollectionStep&lt;/process;/processing-class&gt;
&lt;workflow-editable&gt;<span class="code-keyword">false</span>&lt;/workflow-editable&gt;
&lt;/step&gt;
...
&lt;/step-definitions&gt;
&lt;!-- Where actual submission processes are defined and given names. Each &lt;submission-process&gt; has
many &lt;step&gt; nodes which are in the order that the steps should be in.--&gt;
&lt;submission-definitions&gt; &lt;submission-process name=<span class="code-quote">"traditional"</span>&gt;
...
&lt;!-- Step definitions appear here! --&gt;
&lt;/submission-process&gt;
...
&lt;/submission-definitions&gt;
&lt;/item-submission&gt; </pre>
</div></div>
<p>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):</p>
<p><em>Select Collection &#45;&gt; Initial Questions &#45;&gt; Describe &#45;&gt; Upload &#45;&gt; Verify &#45;&gt; License &#45;&gt; Complete</em></p>
<p>If you would like to customize the steps used or the ordering of the steps, you can do so within the <em>&lt;submission-definition&gt;</em> section of the <em>item-submission.xml</em> .</p>
<p>In addition, you may also specify different Submission Processes for different DSpace Collections. This can be done in the <em>&lt;submission-map&gt;</em> section. The <em>item-submission.xml</em> file itself documents the syntax required to perform these configuration changes.</p>
<h3><a name="SubmissionUserInterface-DefiningSteps%28%3Cstep%3E%29withintheitemsubmission.xml"></a>Defining Steps (<em>&lt;step&gt;</em>) within the <em>item-submission.xml</em></h3>
<p>This section describes how Steps of the Submission Process are defined within the <em>item-submission.xml</em>.</p>
<h4><a name="SubmissionUserInterface-Wheretoplaceyour%3Cstep%3Edefinitions"></a>Where to place your <em>&lt;step&gt;</em> definitions</h4>
<p><em>&lt;step&gt;</em> definitions can appear in one of two places within the <em>item-submission.xml</em> configuration file.</p>
<ol>
<li>Within the <em>&lt;step-definitions&gt;</em> section
<ul>
<li>This is for globally defined <em>&lt;step&gt;</em> definitions (i.e. steps which are used in multiple <em>&lt;submission-process&gt;</em> definitions). Steps defined in this section <b>must</b> define a unique <em>id</em> which can be used to reference this step.</li>
<li>For example: 
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">&lt;step-definitions&gt;
&lt;step id=<span class="code-quote">"custom-step"</span>&gt;
...
&lt;/step&gt;
...
&lt;/step-definitions&gt;</pre>
</div></div></li>
<li>The above step definition could then be referenced from within a <em>&lt;submission-process&gt;</em> as simply <em>&lt;step id="custom-step"/&gt;</em></li>
</ul>
</li>
<li>Within a specific <em>&lt;submission-process&gt;</em> definition
<ul>
<li>This is for steps which are specific to a single <em>&lt;submission-process&gt;</em> definition.</li>
<li>For example:  
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">&lt;submission-process&gt;
&lt;step&gt;
...
&lt;/step&gt;
&lt;/submission-process&gt;</pre>
</div></div></li>
</ul>
</li>
</ol>
<h4><a name="SubmissionUserInterface-Theorderingof%3Cstep%3Edefinitionsmatters%5C%21"></a>The ordering of <em>&lt;step&gt;</em> definitions <b>matters</b>&#33;</h4>
<p>The ordering of the <em>&lt;step&gt;</em> tags within a <em>&lt;submission-process&gt;</em> definition directly corresponds to the order in which those steps will appear&#33;</p>
<p>For example, the following defines a Submission Process where the <em>License</em> step directly precedes the <em>Initial Questions</em> step (more information about the structure of the information under each &lt;step&gt; tag can be found in the section on Structure of the &lt;step&gt; Definition below):</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">&lt;submission-process&gt;
&lt;!--Step 1 will be to Sign off on the License--&gt;
&lt;step&gt;
&lt;heading&gt;submit.progressbar.license&lt;/heading&gt;
&lt;processing-class&gt;org.dspace.submit.step.LicenseStep&lt;/processing-classing-class&gt;
&lt;jspui-binding&gt;org.dspace.app.webui.submit.step.JSPLicenseStep&lt;/jspui-binding&gt;
&lt;xmlui-binding&gt;org.dspace.app.xmlui.aspect.submission.submit.LicenseStenseStep&lt;/xmlui-binding&gt;
&lt;workflow-editable&gt;<span class="code-keyword">false</span>&lt;/workflow-editable&gt;
&lt;/step&gt;
&lt;!--Step 2 will be to Ask Initial Questions--&gt;
&lt;step&gt;
&lt;heading&gt;submit.progressbar.initial-questions&lt;/heading&gt;
&lt;processing-class&gt;org.dspace.submit.step.InitialQuestionsStep&lt;/process;/processing-class&gt;
&lt;jspui-binding&gt;org.dspace.app.webui.submit.step.JSPInitialQuestionsSteonsStep&lt;/jspui-binding&gt;
&lt;xmlui-binding&gt;org.dspace.app.xmlui.aspect.submission.submit.InitialQutialQuestionsStep&lt;/xmlui-binding&gt;
&lt;workflow-editable&gt;<span class="code-keyword">true</span>&lt;/workflow-editable&gt;
&lt;/step&gt;
...[other steps]...
&lt;/submission-process&gt; </pre>
</div></div>
<h4><a name="SubmissionUserInterface-Structureofthe%3Cstep%3EDefinition"></a>Structure of the &lt;step&gt; Definition</h4>
<p>The same &lt;step&gt; 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 &lt;step&gt; definition contains information specific to each of these two interfaces.</p>
<p>The structure of the &lt;step&gt; Definition is as follows:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">&lt;step&gt;
&lt;heading&gt;submit.progressbar.describe&lt;/heading&gt;
&lt;processing-class&gt;org.dspace.submit.step.DescribeStep&lt;/processing-classing-class&gt;
&lt;jspui-binding&gt;org.dspace.app.webui.submit.step.JSPDescribeStep&lt;/jspuilt;/jspui-binding&gt;
&lt;xmlui-binding&gt;org.dspace.app.xmlui.aspect.submission.submit.DescribeScribeStep&lt;/xmlui-binding&gt;
&lt;workflow-editable&gt;<span class="code-keyword">true</span>&lt;/workflow-editable&gt;
&lt;/step&gt;</pre>
</div></div>
<p>Each <em>step</em> contains the following elements. The required elements are so marked:</p>
<ul>
<li>&#42;<b>heading</b>&#42;: Partial I18N key (defined in <em>Messages.properties</em> for JSPUI or <em>messages.xml</em> for 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:
<ul>
<li>XMLUI: prefix is <em>xmlui.Submission.</em> (e.g. "xmlui.Submission.submit.progressbar.describe" for 'Describe' step)</li>
<li>JSPUI: prefix is <em>jsp.</em> (e.g. "jsp.submit.progressbar.describe" for 'Describe' step)<em>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).</em></li>
</ul>
</li>
<li>&#42;<b>processing-class</b><em>(Required)</em><b>: Full Java path to the Processing Class for this Step. This Processing Class</b> <b><em>must</em></b> <b>perform the primary processing of any information gathered in this step,</b> <b><em>for both the XMLUI and JSPUI</em></b><b>. All valid step processing classes must extend the abstract `</b><b><em>org.dspace.submit.AbstractProcessingStep</em></b><b>` class (or alternatively, extend one of the pre-existing step processing classes in</b> <b><em>org.dspace.submit.step.</em></b>)</li>
<li>&#42;<b>jspui-binding</b>&#42;: 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 <em>must</em> extend the abstract `<em>org.dspace.app.webui.submit.JSPStep</em>` class. <em>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.</em></li>
<li>&#42;<b>xmlui-binding</b>&#42;: 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 <em>must</em> extend the abstract `<em>org.dspace.app.xmlui.submission.AbstractSubmissionStep</em>` class. <em>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.</em></li>
<li>&#42;<b>workflow-editable</b>&#42;: Defines whether or not this step can be edited during the <em>Edit Metadata</em> process with the DSpace approval/rejection workflow process. Possible values include <em>true</em> and <em>false</em>. If undefined, defaults to <em>true</em> (which means that workflow reviewers would be allowed to edit information gathered during that step).</li>
</ul>
<h2><a name="SubmissionUserInterface-Reordering%2FRemovingSubmissionSteps"></a>Reordering/Removing Submission Steps</h2>
<p>The removal of existing steps and reordering of existing steps is a relatively easy process&#33;</p>
<p><b>Reordering steps</b></p>
<ol>
<li>Locate the <em>&lt;submission-process&gt;</em> 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 <em>name="traditional"</em>, since this is the traditional DSpace submission process.</li>
<li>Reorder the <em>&lt;step&gt;</em> tags within that <em>&lt;submission-process&gt;</em> tag. Be sure to move the <em>entire</em><em>&lt;step&gt;</em> tag (i.e. everything between and including the opening <em>&lt;step&gt;</em> and closing <em>&lt;/step&gt;</em> tags).
<ul>
<li><em>Hint #1:</em> The <em>&lt;step&gt;</em> defining the <em>Review/Verify</em> step only allows the user to review information from steps which appear <b>before</b> it. So, it's likely you'd want this to appear as one of your last few steps</li>
<li><em>Hint #2:</em> If you are using it, the <em>&lt;step&gt;</em> defining the <em>Initial Questions</em> step should always appear <b>before</b> the <em>Upload</em> or <em>Describe</em> steps since it asks questions which help to set up those later steps.<br/>
<b>Removing one or more steps</b></li>
</ul>
</li>
</ol>
<ol>
<li>Locate the <em>&lt;submission-process&gt;</em> 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 <em>name="traditional"</em>, since this is the traditional DSpace submission process.</li>
<li>Comment out (i.e. surround with &lt;&#33;-&#45; and --&gt;) the <em>&lt;step&gt;</em> tags which you want to remove from that <em>&lt;submission-process&gt;</em> tag. Be sure to comment out the <em>entire</em><em>&lt;step&gt;</em> tag (i.e. everything between and including the opening <em>&lt;step&gt;</em> and closing <em>&lt;/step&gt;</em> tags).
<ul>
<li><em>Hint #1:</em> You cannot remove the <em>Select a Collection</em> step, as an DSpace Item cannot exist without belonging to a Collection.</li>
<li><em>Hint #2:</em> If you decide to remove the <em>&lt;step&gt;</em> defining the <em>Initial Questions</em> step, you should be aware that this may affect your <em>Describe</em> and <em>Upload</em> steps&#33; The <em>Initial Questions</em> step asks questions which help to initialize these later steps. If you decide to remove the <em>Initial Questions</em> step you may wish to create a custom, automated step which will provide default answers for the questions asked&#33;</li>
</ul>
</li>
</ol>
<h2><a name="SubmissionUserInterface-AssigningacustomSubmissionProcesstoaCollection"></a>Assigning a custom Submission Process to a Collection</h2>
<p>Assigning a custom submission process to a Collection in DSpace involves working with the <em>submission-map</em> section of the <em>item-submission.xml</em>. For a review of the structure of the <em>item-submission.xml</em> see the section above on Understanding the Submission Configuration File.</p>
<p>Each <em>name-map</em> element within <em>submission-map</em> associates a collection with the name of a submission definition. Its <em>collection-handle</em> attribute is the Handle of the collection. Its <em>submission-name</em> attribute is the submission definition name, which must match the <em>name</em> attribute of a <em>submission-process</em> element (in the <em>submission-definitions</em> section of <em>item-submission.xml</em>.</p>
<p>For example, the following fragment shows how the collection with handle "12345.6789/42" is assigned the "custom" submission process:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">&lt;submission-map&gt;
&lt;name-map collection-handle=<span class="code-quote">" 12345.6789/42"</span> submission-name="
custom" /&gt;
...
&lt;/submission-map&gt;
&lt;submission-definitions&gt;
&lt;submission-process name="
custom"&gt;
...
&lt;/submission-definitions&gt;
</pre>
</div></div>
<p>It's a good idea to keep the definition of the <em>default</em> name-map from the example <em>input-forms.xml</em> so there is always a default for collections which do not have a custom form set.</p>
<h3><a name="SubmissionUserInterface-GettingACollection%27sHandle"></a>Getting A Collection's Handle</h3>
<p>You will need the <em>handle</em> of a collection in order to assign it a custom form set. To discover the handle, go to the "Communities &amp; Collections" page under "<b>Browse</b>" in the left-hand menu on your DSpace home page. Then, find the link to your collection. It should look something like:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"> http:<span class="code-comment">//myhost.my.edu/dspace/handle/
</span> 12345.6789/42</pre>
</div></div>
<p>The underlined part of the URL is the handle. It should look familiar to any DSpace administrator. That is what goes in the <em>collection-handle</em> attribute of your <em>name-map</em> element.</p>
<h2><a name="SubmissionUserInterface-CustomMetadataentryPagesforSubmission"></a>Custom Metadata-entry Pages for Submission</h2>
<h3><a name="SubmissionUserInterface-Introduction"></a>Introduction</h3>
<p>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 <em>Describe</em> step within the Submission Process. However, they are also configurable via their own XML configuration file (<em>input-forms.xml</em>).</p>
<p>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:</p>
<ul>
<li>The number of metadata-entry pages. </li>
<li>Which fields appear on each page, and their sequence. </li>
<li>Labels, prompts, and other text associated with each field. </li>
<li>List of available choices for each menu-driven field. <br/>
&#42;N.B.*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.</li>
</ul>
<p>All of the custom metadata-entry forms for a DSpace instance are controlled by a single XML file, <em>input-forms.xml</em>, in the <em>config</em> subdirectory under the DSpace home. DSpace comes with a sample configuration that implements the traditional metadata-entry forms, which also serves as a well-documented example. The rest of this section explains how to create your own sets of custom forms.</p>
<h3><a name="SubmissionUserInterface-DescribingCustomMetadataForms"></a>Describing Custom Metadata Forms</h3>
<p>The description of a set of pages through which submitters enter their metadata is called a <em>form</em> (although it is actually a set of forms, in the HTML sense of the term). A form is identified by a unique symbolic <em>name</em>. In the XML structure, the <em>form</em> is broken down into a series of <em>pages</em>: each of these represents a separate Web page for collecting metadata elements.</p>
<p>To set up one of your DSpace collections with customized submission forms, first you make an entry in the <em>form-map</em>. This is effectively a table that relates a collection to a form set, by connecting the collection's <em>Handle</em> to the form name. Collections are identified by handle because their names are mutable and not necessarily unique, while handles are unique and persistent.</p>
<p>A special map entry, for the collection handle "default", defines the <em>default</em> form set. It applies to all collections which are not explicitly mentioned in the map. In the example XML this form set is named <em>traditional</em> (for the "traditional" DSpace user interface) but it could be named anything.</p>
<h3><a name="SubmissionUserInterface-TheStructureofinputforms.xml"></a>The Structure of <em>input-forms.xml</em></h3>
<p>The XML configuration file has a single top-level element, <em>input-forms</em>, which contains three elements in a specific order. The outline is as follows:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">&lt;input-forms&gt;
&lt;-- Map of Collections to Form Sets --&gt;
&lt;form-map&gt;
&lt;name-map collection-handle=<span class="code-quote">"<span class="code-keyword">default</span>"</span> form-name=<span class="code-quote">"traditional"</span>
/&gt;
...
&lt;/form-map&gt;
&lt;-- Form Set Definitions --&gt;
&lt;form-definitions&gt;
&lt;form name=<span class="code-quote">"traditional"</span>&gt;
...
&lt;/form-definitions&gt;
&lt;-- Name/Value Pairs used within Multiple Choice Widgets
--&gt;
&lt;form-value-pairs&gt;
&lt;value-pairs value-pairs-name=<span class="code-quote">"common_iso_languages"</span>
dc-term=<span class="code-quote">"language_iso"</span>&gt;
...
&lt;/form-value-pairs&gt;
&lt;/input-forms&gt;
</pre>
</div></div>
<h4><a name="SubmissionUserInterface-AddingaCollectionMap"></a>Adding a Collection Map</h4>
<p>Each <em>name-map</em> element within <em>form-map</em> associates a collection with the name of a form set. Its <em>collection-handle</em> attribute is the Handle of the collection, and its <em>form-name</em> attribute is the form set name, which must match the <em>name</em> attribute of a <em>form</em> element.</p>
<p>For example, the following fragment shows how the collection with handle "12345.6789/42" is attached to the "TechRpt" form set:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"> &lt;form-map&gt;
&lt;name-map collection-handle=<span class="code-quote">" 12345.6789/42"</span> form-name=<span class="code-quote">" TechRpt"</span>
/&gt;
...
&lt;/form-map&gt;
&lt;form-definitions&gt;
&lt;form name="
TechRept"&gt;
...
&lt;/form-definitions&gt;
</pre>
</div></div>
<p>It's a good idea to keep the definition of the <em>default</em> name-map from the example <em>input-forms.xml</em> so there is always a default for collections which do not have a custom form set.</p>
<h5><a name="SubmissionUserInterface-GettingACollection%27sHandle"></a>Getting A Collection's Handle</h5>
<p>You will need the <em>handle</em> of a collection in order to assign it a custom form set. To discover the handle, go to the "Communities &amp; Collections" page under "<b>Browse</b>" in the left-hand menu on your DSpace home page. Then, find the link to your collection. It should look something like:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"> http:<span class="code-comment">//myhost.my.edu/dspace/handle/
</span> 12345.6789/42</pre>
</div></div>
<p>The underlined part of the URL is the handle. It should look familiar to any DSpace administrator. That is what goes in the <em>collection-handle</em> attribute of your <em>name-map</em> element.</p>
<h4><a name="SubmissionUserInterface-AddingaFormSet"></a>Adding a Form Set</h4>
<p>You can add a new form set by creating a new <em>form</em> element within the <em>form-definitions</em> element. It has one attribute, <em>name</em>, which as seen above must match the value of the <em>name-map</em> for the collections it is to be used for.</p>
<h5><a name="SubmissionUserInterface-FormsandPages"></a>Forms and Pages</h5>
<p>The content of the <em>form</em> is a sequence of <em>page</em> 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).</p>
<p>A <em>form</em> must contain at least one and at most six pages. They are presented in the order they appear in the XML. Each <em>page</em> element must include a <em>number</em> attribute, that should be its sequence number, e.g.</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">&lt;page number=<span class="code-quote">"1"</span>&gt;
</pre>
</div></div>
<p>The <em>page</em> element, in turn, contains a sequence of <em>field</em> elements. Each field defines an interactive dialog where the submitter enters one of the Dublin Core metadata items.</p>
<h5><a name="SubmissionUserInterface-CompositionofaField"></a>Composition of a Field</h5>
<p>Each <em>field</em> contains the following elements, in the order indicated. The required sub-elements are so marked:</p>
<ul>
<li>&#42;<b>dc-schema</b><em>(Required)</em>&#42;: Name of metadata schema employed, e.g. <em>dc</em> for Dublin Core. This value must match the value of the <em>schema</em> element defined in <em>dublin-core-types.xml</em></li>
<li>&#42;<b>dc-element</b><em>(Required)</em>&#42;: Name of the Dublin Core element entered in this field, e.g. <em>contributor</em>.</li>
<li>&#42;<b>dc-qualifier</b>&#42;: Qualifier of the Dublin Core element entered in this field, e.g. when the field is <em>contributor.advisor</em> the value of this element would be <em>advisor</em>. Leaving this out means the input is for an unqualified DC element.</li>
<li>&#42;<b>repeatable</b>&#42;: Value is <em>true</em> when multiple values of this field are allowed, <em>false</em> 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.</li>
<li>&#42;<b>label</b><em>(Required)</em>&#42;: Text to display as the label of this field, describing what to enter, e.g. "<em>Your Advisor's Name</em>".</li>
<li>&#42;<b>input-type</b><em>(Required)</em>&#42;: 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:
<ul>
<li><b>onebox</b> &#8211; A single text-entry box.</li>
<li><b>twobox</b> &#8211; A pair of simple text-entry boxes, used for <em>repeatable</em> values such as the DC <em>subject</em> item. <em>Note:</em> The 'twobox' input type is rendered the same as a 'onebox' in the XML-UI, but both allow for ease of adding multiple values.</li>
<li><b>textarea</b> &#8211; Large block of text that can be entered on multiple lines, e.g. for an abstract.</li>
<li><b>name</b> &#8211; Personal name, with separate fields for family name and first name. When saved they are appended in the format 'LastName, FirstName'</li>
<li><b>date</b> &#8211; Calendar date. When required, demands that at least the year be entered.</li>
<li><b>series</b> &#8211; 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.</li>
<li><b>dropdown</b> &#8211; Choose value(s) from a "drop-down" menu list. <b>Note:</b> You must also include a value for the <em>value-pairs-name</em> 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 <em>language</em> item.</li>
<li><b>qualdrop_value</b> &#8211; Enter a "qualified value", which includes <em>both</em> 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 <em>identifier</em> field. <b>Note:</b> As for the <em>dropdown</em> type, you must include the <em>value-pairs-name</em> attribute to specify a menu choice list.</li>
<li><b>list</b> &#8211; Choose value(s) from a checkbox or radio button list. If the <em>repeatable</em> attribute is set to <em>true</em>, a list of checkboxes is displayed. If the <em>repeatable</em> attribute is set to <em>false</em>, a list of radio buttons is displayed. <b>Note:</b> You must also include a value for the <em>value-pairs-name</em> attribute to specify a list of values from which to choose.</li>
</ul>
</li>
<li>&#42;<b>hint</b><em>(Required)</em>&#42;: 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. </li>
<li>&#42;<b>required</b>&#42;: 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, <em>&lt;required&gt;You must enter a title.&lt;/required&gt; Note that leaving the</em> required element empty will <em>not</em> mark a field as required, e.g.:<em>&lt;required&gt;&lt;/required&gt;</em></li>
<li>&#42;<b>visibility</b>&#42;: When this optional element is included with a value, it restricts the visibility of the field to the scope defined by that value. If the element is missing or empty, the field is visible in all scopes. Currently supported scopes are:
<ul>
<li><b>workflow</b> : the field will only be visible in the workflow stages of submission. This is good for hiding difficult fields for users, such as subject classifications, thereby easing the use of the submission system.</li>
<li><b>submit</b> : the field will only be visible in the initial submission, and not in the workflow stages. In addition, you can decide which type of restriction apply: read-only or full hidden the field (default behaviour) using the <em>otherwise</em> attribute of the <em>visibility</em> XML element. For example:<em>&lt;visibility otherwise="readonly"&gt;workflow&lt;/visibility&gt;</em> 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. <br/>
Look at the example <em>input-forms.xml</em> 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.</li>
</ul>
</li>
</ul>
<p>For the use of controlled vocabularies see the Configuring Controlled Vocabularies section.</p>
<h5><a name="SubmissionUserInterface-AutomaticallyElidedFields"></a>Automatically Elided Fields</h5>
<p>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 <em>title.alternative</em> DC element is automatically elided, <em>even on custom submission pages.</em></p>
<p>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:</p>
<ol>
<li><b>The item has more than one title, e.g. a translated title</b> Controls <em>title.alternative</em> field.</li>
<li><b>The item has been published or publicly distributed before</b> Controls DC fields:  
<ul>
<li><em>date.issued</em></li>
<li><em>publisher</em></li>
<li><em>identifier.citation</em></li>
</ul>
</li>
<li><b>The item consists of more than one file</b><em>Does not affect any metadata input fields.</em> 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 elided from the initial page to avoid confusing or misleading the user.</li>
</ol>
<p>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.</p>
<h4><a name="SubmissionUserInterface-AddingValuePairs"></a>Adding <em>Value-Pairs</em></h4>
<p>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 <em>value-pairs</em> element to the contents of <em>form-value-pairs</em>. It has the following required attributes:</p>
<ul>
<li><b>value-pairs-name</b> &#8211; Name by which an <em>input-type</em> refers to this list.</li>
<li><b>dc-term</b> &#8211; Qualified Dublin Core field for which this choice list is selecting a value. Each <em>value-pairs</em> element contains a sequence of <em>pair</em> sub-elements, each of which in turn contains two elements:</li>
<li><b>displayed-value</b> &#8211; Name shown (on the web page) for the menu entry.</li>
<li><b>stored-value</b> &#8211; Value stored in the DC element when this entry is chosen. Unlike the HTML <em>select</em> tag, there is no way to indicate one of the entries should be the default, so the first entry is always the default choice.</li>
</ul>
<h5><a name="SubmissionUserInterface-Example"></a>Example</h5>
<p>Here is a menu of types of common identifiers:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"> &lt;value-pairs value-pairs-name=<span class="code-quote">"common_identifiers"</span>
dc-term=<span class="code-quote">"identifier"</span>&gt;
&lt;pair&gt;
&lt;displayed-value&gt;Gov't Doc
#&lt;/displayed-value&gt;
&lt;stored-value&gt;govdoc&lt;/stored-value&gt;
&lt;/pair&gt;
&lt;pair&gt;
&lt;displayed-value&gt;URI&lt;/displayed-value&gt;
&lt;stored-value&gt;uri&lt;/stored-value&gt;
&lt;/pair&gt;
&lt;pair&gt;
&lt;displayed-value&gt;ISBN&lt;/displayed-value&gt;
&lt;stored-value&gt;isbn&lt;/stored-value&gt;
&lt;/pair&gt;
&lt;/value-pairs&gt;
</pre>
</div></div>
<p>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 <em>SELECTED</em> attribute to mark one of the options as a pre-selected default.) </p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">&lt;select name=<span class="code-quote">"identifier_qualifier_0"</span>&gt;
&lt;option VALUE=<span class="code-quote">"govdoc"</span>&gt;Gov't Doc
#&lt;/option&gt;
&lt;option VALUE=<span class="code-quote">"uri"</span>&gt;URI&lt;/option&gt;
&lt;option VALUE=<span class="code-quote">"isbn"</span>&gt;ISBN&lt;/option&gt;
&lt;/select&gt;
</pre>
</div></div>
<p>&#42;Identifiers:*Gov't Doc #URIISBN</p>
<h3><a name="SubmissionUserInterface-DeployingYourCustomForms"></a>Deploying Your Custom Forms</h3>
<p>The DSpace web application only reads your custom form definitions when it starts up, so it is important to remember:<br/>
<b><em>You must always restart Tomcat</em></b> <em>(or whatever servlet container you are using) for changes made to the &#95;input-forms.xml</em> file take effect.&#95;<br/>
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 trace in the <em>dspace.log</em> 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.</p>
<h2><a name="SubmissionUserInterface-ConfiguringtheFileUploadstep"></a>Configuring the File Upload step</h2>
<p>The <em>Upload</em> step in the DSpace submission process has two configuration options which can be set with your <em>[dspace]/config/dspace.cfg</em> configuration file. They are as follows:</p>
<ul>
<li><em>upload.max</em> &#45; 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 &#45;1 to disable any file size limitation.
<ul>
<li><em>Note:</em> Increasing this value or setting to &#45;1 does <b>not</b> 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.</li>
</ul>
</li>
<li><em>webui.submit.upload.required</em> &#45; Whether or not all users are <em>required</em> 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.</li>
</ul>
<h2><a name="SubmissionUserInterface-CreatingnewSubmissionSteps"></a>Creating new Submission Steps</h2>
<p>First, a brief warning: <em>Creating a new Submission Step requires some Java knowledge, and is therefore recommended to be undertaken by a Java programmer whenever possible</em></p>
<p>That being said, at a higher level, creating a new Submission Step requires the following (in this relative order):</p>
<ol>
<li>(<b>Required</b>) Create a new Step Processing class
<ul>
<li>This class <b>must</b> extend the abstract <em>org.dspace.submit.AbstractProcessingStep</em> class and implement all methods defined by that abstract class.</li>
<li>This class should be built in such a way that it can process the input gathered from <em>either</em> the XMLUI or JSPUI interface.</li>
</ul>
</li>
<li>(<em>For steps using JSPUI</em>) Create the JSPs to display the user interface. Create a new JSPUI "binding" class to initialize and call these JSPs.</li>
<li>&#35;&#42; Your JSPUI "binding" class must extend the abstract class <em>org.dspace.app.webui.submit.JSPStep</em> and implement all methods defined there. It's recommended to use one of the classes in <em>org.dspace.app.webui.submit.step.&#42;</em> as a reference.
<ul>
<li>Any JSPs created should be loaded by calling the showJSP() method of the <em>org.dspace.app.webui.submit.JSPStepManager</em> class</li>
<li>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 <em>review-[step].jsp</em>) in the JSP <em>submit/</em> directory.</li>
</ul>
</li>
<li>(<em>For steps using XMLUI</em>) Create an XMLUI "binding" Step Transformer which will generate the DRI XML which Manakin requires.
<ul>
<li>The Step Transformer must extend and implement all necessary methods within the abstract class <em>org.dspace.app.xmlui.submission.AbstractSubmissionStep</em></li>
<li>It is useful to use the existing classes in <em>org.dspace.app.xmlui.submission.submit.&#42;</em> as references</li>
</ul>
</li>
<li>(<b>Required</b>) Add a valid Step Definition to the <em>item-submission.xml</em> configuration file.
<ul>
<li>This may also require that you add an I18N (Internationalization) key for this step's <em>heading</em>. See the sections on Configuring Multilingual Support for JSPUI or Configuring Multilingual Support for XMLUI for more details.</li>
<li>For more information on <em>&lt;step&gt;</em> definitions within the <em>item-submission.xml</em>, see the section above on Defining Steps (<em>&lt;step&gt;</em>) within the <em>item-submission.xml</em>.
<h3><a name="SubmissionUserInterface-CreatingaNonInteractiveStep"></a>Creating a Non-Interactive Step</h3></li>
</ul>
</li>
</ol>
<p>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.</p>
<p>To create a non-interactive step, do the following:</p>
<ol>
<li>Create the required Step Processing class, which extends the abstract <em>org.dspace.submit.AbstractProcessingStep</em> class. In this class add any processing which this step will perform.</li>
<li>Add your non-interactive step to your <em>item-submission.xml</em> at the place where you wish this step to be called during the submission process. For example, if you want it to be called <em>immediately after</em> 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:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"> &lt;step&gt;
&lt;processing-class&gt;org.dspace.submit.step.MyNonInteractveStep&lt;/processi
/processing-class&gt; &lt;workflow-editable&gt;<span class="code-keyword">false</span>&lt;/workflow-editable&gt;
&lt;/step&gt;</pre>
</div></div>
<p>Note: Non-interactive steps will not appear in the Progress Bar&#33; 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 non-interactive 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).</p></li>
</ol>
</td>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td height="12" background="https://wiki.duraspace.org/images/border/border_bottom.gif"><img src="images/border/spacer.gif" width="1" height="1" border="0"/></td>
</tr>
<tr>
<td align="center"><font color="grey">Document generated by Confluence on Nov 06, 2010 19:27</font></td>
</tr>
</table>
</body>
</html>

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,68 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>DSpace Documentation : Technical Resources</title>
<link rel="stylesheet" href="styles/site.css" type="text/css" />
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
<table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
<tr>
<td valign="top" class="pagebody">
<div class="pageheader">
<span class="pagetitle">
DSpace Documentation : Technical Resources
</span>
</div>
<div class="pagesubheading">
This page last changed on Dec 31, 2009 by <font color="#0050B2">mdiggory</font>.
</div>
<h1><a name="TechnicalResources-TechnicalResources"></a>Technical Resources</h1>
<h3><a name="TechnicalResources-dspace.osuosl.org"></a>dspace.osuosl.org</h3>
<p>is currently hosted at <a href="http://www.osuosl.org">OSL</a> and accessible by DSpace project administrators upon request.</p>
<h4><a name="TechnicalResources-scm.dspace.org"></a>scm.dspace.org</h4>
<p>vhost on dspace.osuosl.org</p>
<h4><a name="TechnicalResources-maven.dspace.org"></a>maven.dspace.org</h4>
<p>This vhost is used for managing both snapshot and release builds of DSpace artifacts. The release directory is rsynced with the maven central repository on a 3hr cycle.</p>
<p>maven.dspace.org is identical to scm.dspace.org</p>
<h4><a name="TechnicalResources-projects.dspace.org"></a>projects.dspace.org</h4>
<p>This vhost is used for managing the publication of maven project documentation.</p>
<p>projects.dspace.org is identical to scm.dspace.org</p>
<h3><a name="TechnicalResources-libaxis1.mit.edu"></a>libaxis1.mit.edu</h3>
<p>Is a webhosting service maintained by MIT. Access to this machine is managed by Alex Brennan at MIT.</p>
<p>Previously maven.dspace.org and projects.dspace.org were both hosted here. But, they have been migrated to OSUOSL as of Nov 2009.</p>
</td>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td height="12" background="https://wiki.duraspace.org/images/border/border_bottom.gif"><img src="images/border/spacer.gif" width="1" height="1" border="0"/></td>
</tr>
<tr>
<td align="center"><font color="grey">Document generated by Confluence on Nov 06, 2010 19:27</font></td>
</tr>
</table>
</body>
</html>

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,484 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>DSpace Documentation : XMLUI Configuration and Customization</title>
<link rel="stylesheet" href="styles/site.css" type="text/css" />
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
<table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
<tr>
<td valign="top" class="pagebody">
<div class="pageheader">
<span class="pagetitle">
DSpace Documentation : XMLUI Configuration and Customization
</span>
</div>
<div class="pagesubheading">
This page last changed on Apr 24, 2010 by <font color="#0050B2">mdiggory</font>.
</div>
<h1><a name="XMLUIConfigurationandCustomization-DSpaceSystemDocumentation%3AManakin%5CXMLUI%5CConfigurationandCustomization"></a>DSpace System Documentation: Manakin [XMLUI] Configuration and Customization</h1>
<p>The DSpace digital repository supports two user interfaces: one based on JavaServer Pages (JSP) technologies and one based upon the Apache Cocoon framework. This chapter describes those parameters which are specific to the Manakin (XMLUI) interface based upon the Cocoon framework.</p>
<h2><a name="XMLUIConfigurationandCustomization-ManakinConfigurationPropertyKeys"></a>Manakin Configuration Property Keys</h2>
<p>In an effort to save the programmer/administrator some time, the configuration table below is taken from 5.3.43. <em>XMLUI Specific Configuration</em>.</p>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.supportedLocales</em></td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.supportedLocales = en, de</em></td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>A list of supported locales for Manakin. Manakin will look at a user's browser configuration for the first language that appears in this list to make available to in the interface. This parameter is a comma separated list of Locales. All types of Locales country, country_language, country_language_variant. Note that if the appropriate files are not present (i.e. Messages_XX_XX.xml) then Manakin will fall back through to a more general language.</td>
</tr>
<tr>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.force.ssl</em></td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.force.ssl = true</em></td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>Force all authenticated connections to use SSL, only non-authenticated connections are allowed over plain http. If set to true, then you need to ensure that the '<em>dspace.hostname</em>' parameter is set to the correctly.</td>
</tr>
<tr>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.user.registration</em></td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.user.registration = true</em></td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>Determine if new users should be allowed to register. This parameter is useful in conjunction with Shibboleth where you want to disallow registration because Shibboleth will automatically register the user. Default value is true.</td>
</tr>
<tr>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.user.editmetadata</em></td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.user.editmetadata = true</em></td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>Determines if users should be able to edit their own metadata. This parameter is useful in conjunction with Shibboleth where you want to disable the user's ability to edit their metadata because it came from Shibboleth. Default value is true.</td>
</tr>
<tr>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.user.assumelogon</em></td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.user.assumelogon = true</em></td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>Determine if super administrators (those whom are in the Administrators group) can login as another user from the "edit eperson" page. This is useful for debugging problems in a running dspace instance, especially in the workflow process. The default value is false, i.e., no one may assume the login of another user.</td>
</tr>
<tr>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.user.loginredirect</em></td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.user.loginredirect = /profile</em></td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>After a user has logged into the system, which url should they be directed? Leave this parameter blank or undefined to direct users to the homepage, or <em>/profile</em> for the user's profile, or another reasonable choice is <em>/submissions</em> to see if the user has any tasks awaiting their attention. The default is the repository home page.</td>
</tr>
<tr>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.theme.allowoverrides</em></td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.theme.allowoverrides = false</em></td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>Allow the user to override which theme is used to display a particular page. When submitting a request add the HTTP parameter "themepath" which corresponds to a particular theme, that specified theme will be used instead of the any other configured theme. Note that this is a potential security hole allowing execution of unintended code on the server, this option is only for development and debugging it should be turned off for any production repository. The default value unless otherwise specified is "false".</td>
</tr>
<tr>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.bundle.upload</em></td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.bundle.upload = ORIGINAL, METADATA, THUMBNAIL, LICENSE, CC_LICENSE</em></td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>Determine which bundles administrators and collection administrators may upload into an existing item through the administrative interface. If the user does not have the appropriate privileges (add and write) on the bundle then that bundle will not be shown to the user as an option.</td>
</tr>
<tr>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.community-list.render.full</em></td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.community-list.render.full = true</em></td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>On the community-list page should all the metadata about a community/collection be available to the theme. This parameter defaults to true, but if you are experiencing performance problems on the community-list page you should experiment with turning this option off.</td>
</tr>
<tr>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.community-list.cache</em></td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.community-list.cache = 12 hours</em></td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>Normally, Manakin will fully verify any cache pages before using a cache copy. This means that when the community-list page is viewed the database is queried for each community/collection to see if their metadata has been modified. This can be expensive for repositories with a large community tree. To help solve this problem you can set the cache to be assumed valued for a specific set of time. The downside of this is that new or editing communities/collections may not show up the website for a period of time.</td>
</tr>
<tr>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.bistream.mods</em></td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.bistream.mods = true</em></td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>Optionally, you may configure Manakin to take advantage of metadata stored as a bitstream. The MODS metadata file must be inside the "METADATA" bundle and named MODS.xml. If this option is set to 'true' and the bitstream is present then it is made available to the theme for display.</td>
</tr>
<tr>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.bitstream.mets</em></td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.bitstream.mets = true</em></td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>Optionally, you may configure Manakin to take advantage of metadata stored as a bitstream. The METS metadata file must be inside the "METADATA" bundle and named METS.xml. If this optino is set to "true" and the bitstream is present then it is made available to the theme for display.</td>
</tr>
<tr>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.google.analytics.key</em></td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.google.analytics.key = UA-XXXXXX-X</em></td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>If you would like to use google analytics to track general website statistics then use the following parameter to provide your analytics key. First sign up for an account at <a href="http://analytics.google.com" title="http://analytics.google.com">http://analytics.google.com</a>, then create an entry for your repositories website. Google Analytics will give you a snipit of javascript code to place on your site, inside that snip it is your google analytics key usually found in the line: _uacct = "UA-XXXXXXX-X" Take this key (just the UA-XXXXXX-X part) and place it here in this parameter.</td>
</tr>
<tr>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.controlpanel.activity.max</em></td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.controlpanel.activity.max = 250</em></td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>Assign how many page views will be recorded and displayed in the control panel's activity viewer. The activity tab allows an administrator to debug problems in a running DSpace by understanding who and how their dspace is currently being used. The default value is 250.</td>
</tr>
<tr>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.controlpanel.activity.ipheader</em></td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.controlpanel.activity.ipheader = X-Forward-For</em></td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>Determine where the control panel's activity viewer recieves an events IP address from. If your DSpace is in a load balanced enviornment or otherwise behind a context-switch then you will need to set the paramater to the HTTP parameter that records the original IP address.</td>
</tr>
</tbody></table>
</div>
<h2><a name="XMLUIConfigurationandCustomization-ConfiguringThemesandAspects"></a>Configuring Themes and Aspects</h2>
<p>The Manakin user interface is composed of two distinct components: <em>aspects</em> and <em>themes</em>. Manakin aspects are like extensions or plugins for Manakin; they are interactive components that modify existing features or provide new features for the digital repository. Manakin themes stylize the look-and-feel of the repository, community, or collection.</p>
<p>The repository administrator is able to define which aspects and themes are installed for the particular repository by editing the <em>[dspace]/config/xmlui.xconf</em> configuration file. The <em>xmlui.xconf</em> file consists of two major sections: Aspects and Themes.</p>
<h3><a name="XMLUIConfigurationandCustomization-Aspects"></a>Aspects</h3>
<p>The <em>&lt;aspects&gt;</em> section defines the "Aspect Chain", or the linear set of aspects that are installed in the repository. For each aspect that is installed in the repository, the aspect makes available new features to the interface. For example, if the "submission" aspect were to be commented out or removed from the <em>xmlui.xconf</em>, then users would not be able to submit new items into the repository (even the links and language prompting users to submit items are removed). Each <em>&lt;aspect&gt;</em> element has two attributes, <em>name</em> and <em>path</em>. The name is used to identify the Aspect, while the path determines the directory where the aspect's code is located. Here is the default aspect configuration:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"> &lt;aspects&gt;
&lt;aspect name=<span class="code-quote">"Artifact Browser"</span> path=<span class="code-quote">"resource:<span class="code-comment">//aspects/ArtifactBrowser/"</span> /&gt;
</span> &lt;aspect name=<span class="code-quote">"Administration"</span> path=<span class="code-quote">"resource:<span class="code-comment">//aspects/Administrative/"</span> /&gt;
</span> &lt;aspect name=<span class="code-quote">"E-Person"</span> path=<span class="code-quote">"resource:<span class="code-comment">//aspects/EPerson/"</span> /&gt;
</span> &lt;aspect name=<span class="code-quote">"Submission and Workflow"</span> path=<span class="code-quote">"resource:<span class="code-comment">//aspects/Submission/"</span> /&gt;
</span> &lt;/aspects&gt;</pre>
</div></div>
<p>A standard distribution of Manakin/DSpace includes four "core" aspects: </p>
<ul>
<li>*Artifact Browser*The Artifact Browser Aspect is responsible for browsing communities, collections, items and bitstreams, viewing an individual item and searching the repository.</li>
<li>*E-Person*The E-Person Aspect is responsible for logging in, logging out, registering new users, dealing with forgotten passwords, editing profiles and changing passwords.</li>
<li>*Submission*The Submission Aspect is responsible for submitting new items to DSpace, determining the workflow process and ingesting the new items into the DSpace repository.</li>
<li>*Administrative*The Administrative Aspect is responsible for administrating DSpace, such as creating, modifying and removing all communities, collections, e-persons, groups, registries and authorizations.</li>
</ul>
<h3><a name="XMLUIConfigurationandCustomization-Themes"></a>Themes</h3>
<p>The <em>&lt;themes&gt;</em> section defines a set of "rules" that determine where themes are installed in the repository. Each rule is processed in the order that it appears, and the first rule that matches determines the theme that is applied (so order is important). Each rule consists of a <em>&lt;theme&gt;</em> element with several possible attributes:</p>
<ul>
<li><b>name</b> (<em>always required</em>)The name attribute is used to document the theme's name.</li>
<li><b>path</b> (<em>always required</em>)The path attribute determines where the theme is located relative to the <em>themes/</em> directory and must either contain a trailing slash or point directly to the theme's <em>sitemap.xmap</em> file.</li>
<li><b>regex</b> (<em>either regex and/or handle is required</em>)The regex attribute determines which URLs the theme should apply to.</li>
<li><b>handle</b> (<em>either regex and/or handle is required</em>)The handle attribute determines which community, collection, or item the theme should apply to.<br/>
If you use the "handle" attribute, the effect is cascading, meaning if a rule is established for a community then all collections and items within that community will also have this theme apply to them as well. Here is an example configuration:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"> &lt;themes&gt;
&lt;theme name=<span class="code-quote">"Theme 1"</span> handle=<span class="code-quote">"123456789/23"</span> path=<span class="code-quote">"theme1/"</span>/&gt;
&lt;theme name=<span class="code-quote">"Theme 2"</span> regex=<span class="code-quote">"community-list"</span> path=<span class="code-quote">"theme2/"</span>/&gt;
&lt;theme name=<span class="code-quote">"Reference Theme"</span> regex=<span class="code-quote">".*"</span> path=<span class="code-quote">"Reference/"</span>/&gt;
&lt;/themes&gt;</pre>
</div></div>
<p>In the example above three themes are configured: "Theme 1", "Theme 2", and the "Reference Theme". The first rule specifies that "Theme 1" will apply to all communities, collections, or items that are contained under the parent community "123456789/23". The next rule specifies any URL containing the string "community-list" will get "Theme 2". The final rule, using the regular expression ".<b>", will match *anything</b>, so all pages which have not matched one of the preceding rules will be matched to the Reference Theme.</p></li>
</ul>
<h2><a name="XMLUIConfigurationandCustomization-MultilingualSupport"></a>Multilingual Support</h2>
<p>The XMLUI user interface supports multiple languages through the use of internationalization catalogues as defined by the <a href="http://cocoon.apache.org/2.1/userdocs/i18nTransformer.html" title="Cocoon Internationalization Transformer">Cocoon Internationalization Transformer</a>. Each catalog contains the translation of all user-displayed strings into a particular language or variant. Each catalog is a single xml file whose name is based upon the language it is designated for, thus:</p>
<p>messages_<em>language</em>_<em>country</em>_<em>variant</em>.xml</p>
<p>messages_<em>language</em>_<em>country</em>.xml</p>
<p>messages_<em>language</em>.xml</p>
<p>messages.xml</p>
<p>The interface will automatically determine which file to select based upon the user's browser and system configuration. For example, if the user's browser is set to Australian English then first the system will check if <em>messages_en_au.xml</em> is available. If this translation is not available it will fall back to <em>messages_en.xml</em>, and finally if that is not available, <em>messages.xml</em>.</p>
<p>Manakin supplies an English only translation of the interface. In order to add other translations to the system, locate the <em>[dspace-source]/dspace/modules/xmlui/src/main/webapp/i18n/</em> directory. By default this directory will be empty; to add additional translations add alternative versions of the <em>messages.xml</em> file in specific language and country variants as needed for your installation.</p>
<p>To set a language other than English as the default language for the repository's interface, simply name the translation catalogue for the new default language "<em>messages.xml</em>"</p>
<h2><a name="XMLUIConfigurationandCustomization-CreatingaNewTheme"></a>Creating a New Theme</h2>
<p>Manakin themes stylize the look-and-feel of the repository, community, or collection and are distributed as self-contained packages. A Manakin/DSpace installation may have multiple themes installed and available to be used in different parts of the repository. The central component of a theme is the sitemap.xmap, which defines what resources are available to the theme such as XSL stylesheets, CSS stylesheets, images, or multimedia files.<br/>
<b>1) Create theme skeleton</b><br/>
Most theme developers do not create a new theme from scratch; instead they start from the standard theme template, which defines a skeleton structure for a theme. The template is located at: <em>[dspace-source]/dspace-xmlui/dspace-xmlui-webbapp/src/main/webbapp/themes/template</em>. To start your new theme simply copy the theme template into your locally defined modules directory, <em>[dspace-source]/dspace/modules/xmlui/src/main/webbapp/themes/[your theme's directory]/</em>.<br/>
<b>2) Modify theme variables</b><br/>
The next step is to modify the theme's parameters so that the theme knows where it is located. Open the <em>[your theme's directory]/sitemap.xmap</em> and look for <em>&lt;global-variables&gt;</em></p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"> &lt;global-variables&gt;
&lt;theme-path&gt;[your theme's directory]&lt;/theme-path&gt;
&lt;theme-name&gt;[your theme's name]&lt;/theme-name&gt;
&lt;/global-variables&gt;</pre>
</div></div>
<p>Update both the theme's path to the directory name you created in step one. The theme's name is used only for documentation.<br/>
<b>3) Add your CSS stylesheets</b><br/>
The base theme template will produce a repository interface without any style - just plain XHTML with no color or formatting. To make your theme useful you will need to supply a CSS Stylesheet that creates your desired look-and-feel. Add your new CSS stylesheets:</p>
<p><em>[your theme's directory]/lib/style.css</em> (The base style sheet used for all browsers)</p>
<p><em>[your theme's directory]/lib/style-ie.css</em> (Specific stylesheet used for internet explorer)<br/>
<b>4) Install theme and rebuild DSpace</b><br/>
Next rebuild and deploy Dspace (replace &lt;version&gt; with the your current release):</p>
<ol>
<li>Rebuild the DSpace installation package by running the following command from your <em>[dspace-source]/dspace/</em> directory:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">mvn <span class="code-keyword">package</span></pre>
</div></div></li>
<li>Update all DSpace webapps to <em>[dspace]/webapps</em> by running the following command from your <em>[dspace-source]/dspace/target/dspace-[version]-build.dir</em> directory:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">ant -Dconfig=[dspace]/config/dspace.cfg update </pre>
</div></div></li>
<li>Deploy the the new webapps:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">cp -R /[dspace]/webapps/* /[tomcat]/webapps</pre>
</div></div></li>
<li>Restart Tomcat<br/>
This will ensure the theme has been installed as described in the previous section "Configuring Themes and Aspects".</li>
</ol>
<h2><a name="XMLUIConfigurationandCustomization-CustomizingtheNewsDocument"></a>Customizing the News Document</h2>
<p>The XMLUI "news" document is only shown on the root page of your repository. It was intended to provide the title and introductory message, but you may use it for anything.</p>
<p>The news document is located at <em>[dspace]/dspace/config/news-xmlui.xml</em>. There is only one version; it is localized by inserting "i18n" callouts into the text areas. It must be a complete and valid XML DRI document (see Chapter 15).</p>
<p>Its (the News document) exact rendering in the XHTML UI depends, of course, on the theme. The default content is designed to operate with the reference themes, so when you modify it, be sure to preserve the tag structure and e.g. the exact attributes of the first DIV tag. Also note that the text is DRI, not HTML, so you must use only DRI tags, such as the XREF tag to construct a link.</p>
<p>Example 1: a single language:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">&lt;document&gt;
&lt;body&gt;
&lt;div id=<span class="code-quote">"file.news.div.news"</span> n=<span class="code-quote">"news"</span> rend=<span class="code-quote">"primary"</span>&gt;
&lt;head&gt; TITLE OF YOUR REPOSITORY HERE &lt;/head&gt;
&lt;p&gt;
INTRO MESSAGE HERE
Welcome to my wonderful repository etc etc ...
A service of &lt;xref target=<span class="code-quote">"http:<span class="code-comment">//myuni.edu/"</span>&gt;My University&lt;/xref&gt;
</span> &lt;/p&gt;
&lt;/div&gt;
&lt;/body&gt;
&lt;options/&gt;
&lt;meta&gt;
&lt;userMeta/&gt;
&lt;pageMeta/&gt;
&lt;repositoryMeta/&gt;
&lt;/meta&gt;
&lt;/document&gt;</pre>
</div></div>
<p>Example 2: all text replaced by references to localizable message keys:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">&lt;document&gt;
&lt;body&gt;
&lt;div id=<span class="code-quote">"file.news.div.news"</span> n=<span class="code-quote">"news"</span> rend=<span class="code-quote">"primary"</span>&gt;
&lt;head&gt;&lt;i18n:text&gt;myuni.repo.title&lt;/i18n:text&gt;&lt;/head&gt;
&lt;p&gt;
&lt;i18n:text&gt;myuni.repo.intro&lt;/i18n:text&gt;
&lt;i18n:text&gt;myuni.repo.a.service.of&lt;/i18n:text&gt;
&lt;xref target=<span class="code-quote">"http:<span class="code-comment">//myuni.edu/"</span>&gt;&lt;i18n:text&gt;myuni.name&lt;/i18n:text&gt;&lt;/xref&gt;
</span> &lt;/p&gt;
&lt;/div&gt;
&lt;/body&gt;
&lt;options/&gt;
&lt;meta&gt;
&lt;userMeta/&gt;
&lt;pageMeta/&gt;
&lt;repositoryMeta/&gt;
&lt;/meta&gt;
&lt;/document&gt;
</pre>
</div></div>
<h2><a name="XMLUIConfigurationandCustomization-AddingStaticContent"></a>Adding Static Content</h2>
<p>The XMLUI user interface supports the addition of globally static content (as well as static content within individual themes).</p>
<p>Globally static content can be placed in the <em>[dspace-source]/dspace/modules/xmlui/src/main/webapp/static/</em> directory. By default this directory only contains the default <em>robots.txt</em> file, which provides helpful site information to web spiders/crawlers. However, you may also add static HTML (<em>*.html</em>) content to this directory, as needed for your installation.</p>
<p>Any static HTML content you add to this directory may also reference static content (e.g. CSS, Javascript, Images, etc.) from the same <em>[dspace-source]/dspace/modules/xmlui/src/main/webapp/static/</em> directory. You may reference other static content from your static HTML files similar to the following:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"> &lt;link href=<span class="code-quote">"./<span class="code-keyword">static</span>/mystyle.css"</span> rel=<span class="code-quote">"stylesheet"</span> type=<span class="code-quote">"text/css"</span>/&gt;
&lt;img src=<span class="code-quote">"./<span class="code-keyword">static</span>/images/<span class="code-keyword">static</span>-image.gif"</span> alt=<span class="code-quote">"Static image in /<span class="code-keyword">static</span>/images/ directory"</span>/&gt;
&lt;img src=<span class="code-quote">"./<span class="code-keyword">static</span>/<span class="code-keyword">static</span>-image.jpg"</span> alt=<span class="code-quote">"Static image in /<span class="code-keyword">static</span>/ directory"</span>/&gt; </pre>
</div></div>
<h2><a name="XMLUIConfigurationandCustomization-EnablingOAIOREHarvesterusingXMLUI"></a>Enabling OAI-ORE Harvester using XMLUI</h2>
<p>This section will give the necessary steps to set up the OAI-ORE Harvester usig Manakin.</p>
<p>Setting up a collection (Collection Edit Screen):</p>
<ol>
<li>Login and create a new collection.</li>
<li>Go to the tab named "Content Source" that now appears next to "Edit Metadata" and "Assign Roles " in the collection edit screens.</li>
<li>The two counter source options are standards (selected by default) and harvested. Select "harvests from external source" and click Save.</li>
<li>A new set of menus appear to configure the harvesting settings:
<ul>
<li>"OAI Provide" is in the URL of the OAI-PMH provider that the content from this collection should be harvested from. The PMH provider deployed with DSpace typically has the form:"http://dspace.url/oai/reuqest". For this example use "http://web01.library.tamu.edu/oai-h151/request"</li>
<li>"OAI Set id" is the setSpec of the collection you wish to harvest from.Use "hdl_1969.1_5671" for this example.</li>
<li>"Metadata format" determines the format that the descriptive metdata will be harvested. Since DSpace stores metadata in its own internal format, not all metadata values might bet harvested if a specific format is specified. Select "DSpace Intermediate Metadata" if available and "Simple Dublin Core" otherwise.</li>
<li>Click the Test Settings button will verify the settings supplied in the previous steps and will usually let you know what, if anything is missing or does not match up.</li>
</ul>
</li>
<li>The list of radio buttons labeled "Content being harvested" allows you to select the harvest level. The first one requires no OAI-ORE support on the part of the provider and can be used to harvest metadata from any provider compliant with the OAI-PMH 2.0 specifications. The middle options will harvest the metadata and generate links to bitstreams stored remotely, while the last one will perform full local replication.Select the middle option and click Save<br/>
At this point the settings are saved and the menu changes to provide three options:</li>
</ol>
<ul>
<li>"Change Settings" takes you back to the edit screen.</li>
<li>"Import Now" performs a single harvest from the remote collection into the local one. Success, notes, and errors encountered in the process will be reflected in the "Last Harvest Result" entry. More detailed information is available in the dspace log. Note that the whole harvest cycle is execuited withtin a single HTTP request and will time out for large collections. For this reason, it is advisable to use the automatic harvest scheduler set up<br/>
either in XMLUI or from the command line. If the scheduler is running, "Import Now" will handle the harvest task as a separate thread.</li>
<li>"Reset and Reimport Collection" will perform the same function as "Import Now", but will clear the collection of all existing items before doing so.
<h3><a name="XMLUIConfigurationandCustomization-AutomaticHarvesting%28Scheduler%29"></a>Automatic Harvesting (Scheduler)</h3></li>
</ul>
<p>Setting up automatic harvesting in the Control Panel Screen.</p>
<ul>
<li>A new table, Harvesting, has been added under Administrative &gt; Control Panel.</li>
<li>The panel offers the following information:
<ul>
<li>Available actions:
<ul>
<li>Start Harvester: starts the scheduler. From this point on, all properly configured collections (listed on the next line) will be harvested at regular intervals. This interval can be changed in the <em>dspace.cfg</em> using the "<em>harvester.harvestFrequency</em>" parameter.</li>
<li>Pause: the "nice" stop; waits for the active harvests to finish, saves the state/progress and pauses execution. Can be either resumed or stopped.</li>
<li>Stop: the "full stop"; waits for the current item to finish harvesting, and aborts further execution.</li>
<li>Reset Harvest Status: since stopping in the middle of a harvest is likely to result in collections getting "stuck" in the queue, the button is available to clear all states.</li>
</ul>
</li>
</ul>
</li>
</ul>
</td>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td height="12" background="https://wiki.duraspace.org/images/border/border_bottom.gif"><img src="images/border/spacer.gif" width="1" height="1" border="0"/></td>
</tr>
<tr>
<td align="center"><font color="grey">Document generated by Confluence on Nov 06, 2010 19:27</font></td>
</tr>
</table>
</body>
</html>

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 165 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 192 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 191 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 138 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 227 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 60 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 613 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 1005 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 551 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 569 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 594 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 112 B

399
dspace/docs/html/styles/site.css Executable file
View File

@@ -0,0 +1,399 @@
/* Could not locate resource: /includes/css/master.css */
/* Could not locate resource: /includes/css/wiki-content.css */
/* Could not locate resource: /includes/css/tabs.css */
/* Could not locate resource: /includes/css/menu.css */
/* Could not locate resource: /includes/css/menu-ie.css */
/* Could not locate resource: /includes/css/tables.css */
/* Could not locate resource: /includes/css/panels.css */
/* Could not locate resource: /includes/css/master-ie.css */
/* Could not locate resource: /includes/css/renderer-macros.css */
/* Could not locate resource: /includes/css/content-types.css */
/* Could not locate resource: /includes/css/login.css */
/* Could not locate resource: /includes/css/information-macros.css */
/* Could not locate resource: /includes/css/layout-macros.css */
/*
Colors for Confluence (included for all themes by default).
*/
h1, h2, h3, h4, h5, h6,
.wiki-content h1,
.wiki-content h2,
.wiki-content h3,
.wiki-content h4,
.wiki-content h5,
.wiki-content h6,
.pagetitle,
.steptitle,
.substeptitle,
.formtitle,
a.blogHeading,
.more-comments a,
.label,
label,
th.confluenceTh,
table.confluenceTable th.confluenceTh,
table.admin th,
.form-element-large,
.form-element-small,
#com-atlassian-confluence .mce_h1 span.mceText,
#com-atlassian-confluence .mce_h2 span.mceText,
#com-atlassian-confluence .mce_h3 span.mceText,
#com-atlassian-confluence .mce_h4 span.mceText,
#com-atlassian-confluence .mce_h5 span.mceText,
#com-atlassian-confluence .mce_h6 span.mceText {
color: #2E6173;
}
.wiki-content h1,
.wiki-content h2 {
border-bottom-color: #669999;
}
.wiki-content-preview {
border-left-color: #669999;
border-right-color: #669999;
}
.pageSectionHeader {
border-bottom-color: #2E6173;
}
.panel {
border-color: #669999;
}
.panelHeader,
.menuheading,
.pageheader,
.sectionbottom {
border-bottom-color: #669999;
}
.topRow {
border-top-color: #669999;
}
.tabletitle, .pageSectionHeader, .section-header h2 {
color: #2E6173;
}
.tabletitle, .pageSectionHeader {
border-bottom-color: #669999;
}
a:link,
a:visited,
a:active,
a:hover,
#default-labels-header a.add {
color: #2E6173;
}
h1 a:hover {
border-bottom-color: #2E6173;
}
/* use logoSpaceLink instead.
.spacenametitle,
.spacenametitle a,
.spacenametitle a:visited {
color: #999999;
}
*/
.spacenametitle-printable,
.spacenametitle-printable a,
.spacenametitle-printable a:visited {
color: #999999;
}
.navItemOver,
.navItemOver a,
.navItemOver a:visited,
.navItemOver a:hover {
color: #ffffff;
background-color: #2E6173;
}
.navItem {
background-color: #2E6173;
}
.navItem a,
.navItem a:hover,
.navItem a:visited {
color: #ffffff;
}
.tableview th {
color: #2E6173;
border-bottom-color: #669999;
}
blockquote {
border-left-color: #669999;
}
.navBackgroundBox {
background: #2E6173;
}
.previewBoxTop,
.previewContent,
.previewBoxBottom,
.functionbox {
border-color: #669999;
}
.smalltext-blue {
color: #669999;
}
.tabnav,
.comment .tabnav,
ul.tabnav {
border-bottom-color: #2E6173;
}
.tabnav .tabs a {
border-color: #2E6173;
background: #2E6173;
}
.tabnav .tabs a:link, .tabnav .tabs a:visited {
color: #ffffff;
}
.tabnav .tabs a:hover {
color: #ffffff;
background: #2E6173;
border-color: #2E6173;
}
.tabnav .spaceActionLinks a:link,
.tabnav .spaceActionLinks a:visited {
color: #2E6173;
}
.foldertab-box {
border-left-color: #2E6173;
border-right-color: #2E6173;
border-bottom-color: #2E6173;
}
#squaretab a {
border-color: #2E6173;
}
#squaretab a:link, #squaretab a:visited {
background-color: #2E6173;
}
#squaretab a:hover {
color: #ffffff;
background-color: #2E6173;
border-color: #2E6173;
}
table.blogcalendar {
border-color: #669999;
}
.blogcalendar th.calendarhead,
a.calendarhead,
a.calendarhead:link,
a.calendarhead:visited,
a.calendarhead:hover {
background-color: #2E6173;
color: #ffffff;
}
.searchGroupHeading {
background-color: #2E6173;
color: #ffffff;
}
.permissionTab {
background: #2E6173;
color: #ffffff;
}
.permissionSuperTab {
background: #2E6173;
color: #ffffff;
}
/* styles for links in the top bar */
.topBarDiv a:link,
.topBarDiv a:visited,
.topBarDiv a:active,
.topBarDiv a:hover,
.topBarDiv {
color: #ffffff;
}
.topBar {
background-color: #2E6173;
}
.basicPanelContainer {
border-color: #2E6173;
}
.greynavbar {
border-top-color: #2E6173
}
div.license-personal {
background-color: #2E6173;
color: #ffffff;
}
div.license-personal a {
color: #ffffff;
}
.minitab {
border-bottom-color: #2E6173;
}
.minitab a {
border-top-color: #2E6173;
border-right-color: #2E6173;
border-left-color: #2E6173;
}
.minitab .unselected {
border-bottom-color: #2E6173;
background: #2E6173;
}
#header {
background-color: #2E6173;
}
#header a,
#breadcrumbs,
#header .ajs-menu-bar li.ajs-menu-item a.trigger {
color: #ffffff;
}
.breadcrumbs {
border-color: #669999;
}
#navigation, #tab-navigation {
border-bottom-color: #2E6173;
}
.ajs-menu-bar li.ajs-menu-item .ajs-drop-down a {
color: #535353;
}
#header .ajs-menu-bar li.ajs-menu-item .ajs-drop-down a {
color: #2E6173;
}
.menu-section-list li.active a,
.menu-section-list li.active a:hover,
#navigation .ajs-menu-bar .ajs-button a:hover,
/* .ajs-menu-bar .ajs-menu-item.opened, */
.ajs-menu-bar .ajs-menu-item li.active a,
.aui-dd-parent .aui-dropdown li.active,
.aui-dd-parent .aui-dropdown li:hover span,
.aui-dd-parent .aui-dropdown a:focus span,
.ajs-menu-bar .ajs-menu-item.opened .ajs-drop-down li.active a,
#navigation .ajs-menu-bar li.ajs-button a.active,
#header .ajs-menu-bar li.ajs-menu-item.opened .ajs-drop-down li.active a,
.ajs-content-hover .popup-follow a:hover {
color: #ffffff;
background-color: #669999;
}
#header .ajs-menu-bar li.ajs-menu-item.opened,
#header .ajs-menu-bar li.ajs-menu-item.opened a.trigger {
background-color: #669999;
border-color: #669999;
}
.ajs-menu-bar .ajs-menu-item.opened a.trigger {
background-color: #669999;
}
#header .ajs-menu-bar .ajs-drop-down {
border-color: #2E6173;
}
#header .ajs-menu-bar .ajs-drop-down li.separator {
border-top-color: #2E6173;
}
.tab-navigation .tab a {
background-color: #2E6173;
border: 1px solid #2E6173;
color: #ffffff;
}
.tab-navigation .tab a:hover {
color: #ffffff;
background-color: #2E6173;
border-bottom-color: #2E6173;
}
/***** Pre 2.8 markup styles for backwards compatability ******/
#foldertab {
border-bottom-color: #2E6173;
}
#foldertab li a {
border-color: #2E6173;
background: #2E6173;
}
#foldertab li a:link,
#foldertab li a:visited {
color: #ffffff;
}
#foldertab li a:hover {
color: #ffffff;
background: #2E6173;
border-color: #2E6173;
}
.logoSpaceLink,
.logoSpaceLink a:link,
.logoSpaceLink a:visited,
.logoSpaceLink a:active {
color: #999999;
}
.logoSpaceLink a:hover {
color: #2E6173;
}
.selectedminitab {
border-color: #2E6173
}
.unselectedminitab {
border-color: #2E6173;
background: #2E6173;
}
.tabletitle, .heading-text-color {
color: #2E6173;
}
a.unselectedminitab:hover {
color: #ffffff;
background: #2E6173;
border-color: #2E6173;
}
ol.autocompleter li.focused {
background: #669999;
color: #ffffff;
}
/* End colour styles for Confluence */
/* Could not locate resource: /includes/css/default-theme.css */