hazza/DSpace
1
0
Fork 0
mirror of https://github.com/DSpace/DSpace.git synced 2025-10-15 14:03:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Final release for 1.7

Browse Source 
git-svn-id: http://scm.dspace.org/svn/repo/dspace/trunk@5983 9c30dcfa-912a-0410-8fc2-9e0234be79fd
This commit is contained in:
Jeffrey Trimble
2010-12-16 17:00:17 +00:00
parent 98ecece84d
commit 9e54e648d0
3 changed files with 1961 additions and 1747 deletions
Download Patch File Download Diff File Expand all files Collapse all files

245
dspace/docs/html/System Administration.html
View File

@@ -16,12 +16,11 @@
</span> </span>
</div> </div>
<div class="pagesubheading"> <div class="pagesubheading">
This page last changed on Nov 06, 2010 by <font color="#0050B2">jtrimble</font>. This page last changed on Dec 16, 2010 by <font color="#0050B2">jtrimble</font>.
</div> </div>
<h1><a name="SystemAdministration-DSpaceSystemDocumentation%3ASystemAdministration"></a>DSpace System Documentation: System Administration</h1> <h1><a name="SystemAdministration-DSpaceSystemDocumentation%3ASystemAdministration"></a>DSpace System Documentation: System Administration</h1>
<p>DSpace operates on several levels: as a Tomcat servlet, cron jobs, and on-demand operations. This section explains many of the on-demand operations. Some of the command operations may be also set up as cron jobs. Many of these operations are performed at the Command Line Interface (CLI) also known as the Unix prompt (<tt>$:</tt>). Future reference will use the term CLI when the use needs to be at the command line.</p> <p>DSpace operates on several levels: as a Tomcat servlet, cron jobs, and on-demand operations. This section explains many of the on-demand operations. Some of the command operations may be also set up as cron jobs. Many of these operations are performed at the Command Line Interface (CLI) also known as the Unix prompt (<tt>$:</tt>). Future reference will use the term CLI when the use needs to be at the command line.</p>
<p>Below is the "Command Help Table". This table explains what data is contained in the individual command/help tables in the sections that follow.</p> <p>Below is the "Command Help Table". This table explains what data is contained in the individual command/help tables in the sections that follow.</p>
@@ -43,7 +42,113 @@
</div> </div>
<p><b>DSpace Command Launcher</b>. With DSpace Release 1.6, the many commands and scripts have been replaced with a simple <tt>[dspace]/bin/dspace &lt;command&gt;</tt> command. See Application Layer chapter for the details of the <a href="Application.html#Application-DSpaceCommandLauncher">DSpace Command Launcher</a>.</p> <div class='panelMacro'><table class='infoMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="images/icons/emoticons/information.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><b>DSpace Command Launcher</b><br />With DSpace Release 1.6, the many commands and scripts have been replaced with a simple <tt>[dspace]/bin/dspace &lt;command&gt;</tt> command. See Application Layer chapter for the details of the <a href="Application Layer.html#ApplicationLayer-DSpaceCommandLauncher">DSpace Command Launcher</a>.</td></tr></table></div>
<p><b>Table of Contents:</b></p>
<style type='text/css'>/*<![CDATA[*/
div.rbtoc1292513589969 {margin-left: 0px;padding: 0px;}
div.rbtoc1292513589969 ul {list-style: none;margin-left: 0px;}
div.rbtoc1292513589969 li {margin-left: 0px;padding-left: 0px;}
/*]]>*/</style><div class='rbtoc1292513589969'>
<ul>
<li><span class='TOCOutline'>1</span> <a href='#SystemAdministration-CommunityandCollectionStructureImporter'>Community and Collection Structure Importer</a></li>
<ul>
<li><span class='TOCOutline'>1.1</span> <a href='#SystemAdministration-Limitation'>Limitation</a></li>
</ul>
<li><span class='TOCOutline'>2</span> <a href='#SystemAdministration-PackageImporterandExporter'>Package Importer and Exporter</a></li>
<ul>
<li><span class='TOCOutline'>2.1</span> <a href='#SystemAdministration-Ingesting'>Ingesting</a></li>
<ul>
<li><span class='TOCOutline'>2.1.1</span> <a href='#SystemAdministration-IngestionModes%26Options'>Ingestion Modes &amp; Options</a></li>
<ul>
<li><span class='TOCOutline'>2.1.1.1</span> <a href='#SystemAdministration-IngestingaSinglePackage'>Ingesting a Single Package</a></li>
<li><span class='TOCOutline'>2.1.1.2</span> <a href='#SystemAdministration-IngestingMultiplePackagesatOnce'>Ingesting Multiple Packages at Once</a></li>
</ul>
<li><span class='TOCOutline'>2.1.2</span> <a href='#SystemAdministration-Restoring%2FReplacingusingPackages'>Restoring/Replacing using Packages</a></li>
<ul>
<li><span class='TOCOutline'>2.1.2.1</span> <a href='#SystemAdministration-DefaultRestoreMode'>Default Restore Mode</a></li>
<li><span class='TOCOutline'>2.1.2.2</span> <a href='#SystemAdministration-Restore%2CKeepExistingMode'>Restore, Keep Existing Mode</a></li>
<li><span class='TOCOutline'>2.1.2.3</span> <a href='#SystemAdministration-ForceReplaceMode'>Force Replace Mode</a></li>
</ul>
</ul>
<li><span class='TOCOutline'>2.2</span> <a href='#SystemAdministration-Disseminating'>Disseminating</a></li>
<ul>
<li><span class='TOCOutline'>2.2.1</span> <a href='#SystemAdministration-DisseminatingaSingleObject'>Disseminating a Single Object</a></li>
<li><span class='TOCOutline'>2.2.2</span> <a href='#SystemAdministration-DisseminatingMultipleObjectsatOnce'>Disseminating Multiple Objects at Once</a></li>
</ul>
<li><span class='TOCOutline'>2.3</span> <a href='#SystemAdministration-ArchivalInformationPackages%28AIPs%29'>Archival Information Packages (AIPs)</a></li>
<li><span class='TOCOutline'>2.4</span> <a href='#SystemAdministration-METSpackages'>METS packages</a></li>
</ul>
<li><span class='TOCOutline'>3</span> <a href='#SystemAdministration-ItemImporterandExporter'>Item Importer and Exporter</a></li>
<ul>
<li><span class='TOCOutline'>3.1</span> <a href='#SystemAdministration-DSpaceSimpleArchiveFormat'>DSpace Simple Archive Format</a></li>
<li><span class='TOCOutline'>3.2</span> <a href='#SystemAdministration-Configuringmetadata%5Cprefix%5C.xmlforDifferentSchema'>Configuring <em>metadata-[prefix].xml</em> for Different Schema</a></li>
<li><span class='TOCOutline'>3.3</span> <a href='#SystemAdministration-ImportingItems'>Importing Items</a></li>
<ul>
<li><span class='TOCOutline'>3.3.1</span> <a href='#SystemAdministration-AddingItemstoaCollection'>Adding Items to a Collection</a></li>
<li><span class='TOCOutline'>3.3.2</span> <a href='#SystemAdministration-ReplacingItemsinCollection'>Replacing Items in Collection</a></li>
<li><span class='TOCOutline'>3.3.3</span> <a href='#SystemAdministration-DeletingorUnimportingItemsinaCollection'>Deleting or Unimporting Items in a Collection</a></li>
<li><span class='TOCOutline'>3.3.4</span> <a href='#SystemAdministration-OtherOptions'>Other Options</a></li>
</ul>
<li><span class='TOCOutline'>3.4</span> <a href='#SystemAdministration-ExportingItems'>Exporting Items</a></li>
</ul>
<li><span class='TOCOutline'>4</span> <a href='#SystemAdministration-TransferringItemsBetweenDSpaceInstances'>Transferring Items Between DSpace Instances</a></li>
<li><span class='TOCOutline'>5</span> <a href='#SystemAdministration-ItemUpdate'>Item Update</a></li>
<ul>
<li><span class='TOCOutline'>5.1</span> <a href='#SystemAdministration-DSpacesimpleArchiveFormat'>DSpace simple Archive Format</a></li>
<li><span class='TOCOutline'>5.2</span> <a href='#SystemAdministration-ItemUpdateCommands'>ItemUpdate Commands</a></li>
<ul>
<li><span class='TOCOutline'>5.2.1</span> <a href='#SystemAdministration-CLIExamples'>CLI Examples</a></li>
</ul>
</ul>
<li><span class='TOCOutline'>6</span> <a href='#SystemAdministration-Registering%28NotImporting%29Bitstreams'>Registering (Not Importing) Bitstreams</a></li>
<ul>
<li><span class='TOCOutline'>6.1</span> <a href='#SystemAdministration-AccessibleStorage'>Accessible Storage</a></li>
<li><span class='TOCOutline'>6.2</span> <a href='#SystemAdministration-RegisteringItemsUsingtheItemImporter'>Registering Items Using the Item Importer</a></li>
<li><span class='TOCOutline'>6.3</span> <a href='#SystemAdministration-InternalIdentificationandRetrievalofRegisteredItems'>Internal Identification and Retrieval of Registered Items</a></li>
<li><span class='TOCOutline'>6.4</span> <a href='#SystemAdministration-ExportingRegisteredItems'>Exporting Registered Items</a></li>
<li><span class='TOCOutline'>6.5</span> <a href='#SystemAdministration-METSExportofRegisteredItems'>METS Export of Registered Items</a></li>
<li><span class='TOCOutline'>6.6</span> <a href='#SystemAdministration-DeletingRegisteredItems'>Deleting Registered Items</a></li>
</ul>
<li><span class='TOCOutline'>7</span> <a href='#SystemAdministration-METSTools'>METS Tools</a></li>
<ul>
<li><span class='TOCOutline'>7.1</span> <a href='#SystemAdministration-TheExportTool'>The Export Tool</a></li>
<li><span class='TOCOutline'>7.2</span> <a href='#SystemAdministration-Limitations'>Limitations</a></li>
</ul>
<li><span class='TOCOutline'>8</span> <a href='#SystemAdministration-MediaFilters%3ATransformingDSpaceContent'>MediaFilters: Transforming DSpace Content</a></li>
<li><span class='TOCOutline'>9</span> <a href='#SystemAdministration-SubCommunityManagement'>Sub-Community Management</a></li>
<li><span class='TOCOutline'>10</span> <a href='#SystemAdministration-BatchMetadataEditing'>Batch Metadata Editing</a></li>
<ul>
<li><span class='TOCOutline'>10.1</span> <a href='#SystemAdministration-ExportFunction'>Export Function</a></li>
<ul>
<li><span class='TOCOutline'>10.1.1</span> <a href='#SystemAdministration-ExportingProcess'>Exporting Process</a></li>
</ul>
<li><span class='TOCOutline'>10.2</span> <a href='#SystemAdministration-ImportFunction'>Import Function</a></li>
<ul>
<li><span class='TOCOutline'>10.2.1</span> <a href='#SystemAdministration-ImportingProcess'>Importing Process</a></li>
</ul>
<li><span class='TOCOutline'>10.3</span> <a href='#SystemAdministration-TheCSVFiles'>The CSV Files</a></li>
</ul>
<li><span class='TOCOutline'>11</span> <a href='#SystemAdministration-ChecksumChecker'>Checksum Checker</a></li>
<ul>
<li><span class='TOCOutline'>11.1</span> <a href='#SystemAdministration-CheckerExecutionMode'>Checker Execution Mode</a></li>
<li><span class='TOCOutline'>11.2</span> <a href='#SystemAdministration-CheckerResultsPruning'>Checker Results Pruning</a></li>
<li><span class='TOCOutline'>11.3</span> <a href='#SystemAdministration-CheckerReporting'>Checker Reporting</a></li>
<li><span class='TOCOutline'>11.4</span> <a href='#SystemAdministration-CronorAutomaticExecutionofChecksumChecker'>Cron or Automatic Execution of Checksum Checker</a></li>
<li><span class='TOCOutline'>11.5</span> <a href='#SystemAdministration-AutomatedChecksumCheckers%27Results'>Automated Checksum Checkers' Results</a></li>
</ul>
<li><span class='TOCOutline'>12</span> <a href='#SystemAdministration-Embargo'>Embargo</a></li>
<li><span class='TOCOutline'>13</span> <a href='#SystemAdministration-BrowseIndexCreation'>Browse Index Creation</a></li>
<ul>
<li><span class='TOCOutline'>13.1</span> <a href='#SystemAdministration-RunningtheIndexingPrograms'>Running the Indexing Programs</a></li>
<li><span class='TOCOutline'>13.2</span> <a href='#SystemAdministration-IndexingCustomization'>Indexing Customization</a></li>
</ul>
<li><span class='TOCOutline'>14</span> <a href='#SystemAdministration-DSpaceLogConverter'>DSpace Log Converter</a></li>
<li><span class='TOCOutline'>15</span> <a href='#SystemAdministration-ClientStatistics'>Client Statistics</a></li>
<li><span class='TOCOutline'>16</span> <a href='#SystemAdministration-TestDatabase'>Test Database</a></li>
<li><span class='TOCOutline'>17</span> <a href='#SystemAdministration-Movingitems'>Moving items</a></li>
</ul></div>
<h2><a name="SystemAdministration-CommunityandCollectionStructureImporter"></a>Community and Collection Structure Importer</h2> <h2><a name="SystemAdministration-CommunityandCollectionStructureImporter"></a>Community and Collection Structure Importer</h2>
@@ -225,7 +330,7 @@
<div class='panelMacro'><table class='noteMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="images/icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><b>Not All Packagers Support Bulk Ingest</b><br />Because the packager plugin must know how to locate all child packages from an initial package file, not all plugins can support bulk ingest. Currently, in DSpace the following Packager Plugins support bulk ingest capabilities: <div class='panelMacro'><table class='noteMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="images/icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><b>Not All Packagers Support Bulk Ingest</b><br />Because the packager plugin must know how to locate all child packages from an initial package file, not all plugins can support bulk ingest. Currently, in DSpace the following Packager Plugins support bulk ingest capabilities:
<ul> <ul>
<li>METS Packager Plugin</li> <li>METS Packager Plugin</li>
<li><a href="AipBackupRestore.html" title="AipBackupRestore">AIP Packager Plugin</a></li> <li><a href="AIP Backup and Restore.html" title="AIP Backup and Restore">AIP Packager Plugin</a></li>
</ul> </ul>
</td></tr></table></div> </td></tr></table></div>
@@ -338,13 +443,13 @@
<h3><a name="SystemAdministration-ArchivalInformationPackages%28AIPs%29"></a>Archival Information Packages (AIPs)</h3> <h3><a name="SystemAdministration-ArchivalInformationPackages%28AIPs%29"></a>Archival Information Packages (AIPs)</h3>
<p>As of DSpace 1.7, DSpace now can backup and restore all of its contents as a set of <a href="DSpaceAIPFormat.html" title="DSpaceAIPFormat">AIP Files</a>. This includes all Communities, Collections, Items, Groups and People in the system.</p> <p>As of DSpace 1.7, DSpace now can backup and restore all of its contents as a set of <a href="DSpace AIP Format.html" title="DSpace AIP Format">AIP Files</a>. This includes all Communities, Collections, Items, Groups and People in the system.</p>
<p>This feature came out of a requirement for DSpace to better integrate with DuraCloud (<a href="http://www.duracloud.org">http://www.duracloud.org</a>), and other backup storage systems. One of these requirements is to be able to essentially "backup" local DSpace contents into the cloud (as a type of offsite backup), and "restore" those contents at a later time.</p> <p>This feature came out of a requirement for DSpace to better integrate with DuraCloud (<a href="http://www.duracloud.org">http://www.duracloud.org</a>), and other backup storage systems. One of these requirements is to be able to essentially "backup" local DSpace contents into the cloud (as a type of offsite backup), and "restore" those contents at a later time.</p>
<p>Essentially, this means DSpace can export the entire hierarchy (i.e. bitstreams, metadata and relationships between Communities/Collections/Items) into a relatively standard format (a METS-based, <a href="DSpaceAIPFormat.html" title="DSpaceAIPFormat">AIP format</a>). This entire hierarchy can also be re-imported into DSpace in the same format (essentially a restore of that content in the same or different DSpace installation).</p> <p>Essentially, this means DSpace can export the entire hierarchy (i.e. bitstreams, metadata and relationships between Communities/Collections/Items) into a relatively standard format (a METS-based, <a href="DSpace AIP Format.html" title="DSpace AIP Format">AIP format</a>). This entire hierarchy can also be re-imported into DSpace in the same format (essentially a restore of that content in the same or different DSpace installation).</p>
<p>For more information, see the section on <a href="AipBackupRestore.html" title="AipBackupRestore">AIP backup &amp; Restore for DSpace</a>.</p> <p>For more information, see the section on <a href="AIP Backup and Restore.html" title="AIP Backup and Restore">AIP backup &amp; Restore for DSpace</a>.</p>
<h3><a name="SystemAdministration-METSpackages"></a>METS packages</h3> <h3><a name="SystemAdministration-METSpackages"></a>METS packages</h3>
@@ -354,6 +459,7 @@
<h2><a name="SystemAdministration-ItemImporterandExporter"></a>Item Importer and Exporter</h2> <h2><a name="SystemAdministration-ItemImporterandExporter"></a>Item Importer and Exporter</h2>
<p>DSpace has a set of command line tools for importing and exporting items in batches, using the DSpace simple archive format. The tools are not terribly robust, but are useful and are easily modified. They also give a good demonstration of how to implement your own item importer if desired.</p> <p>DSpace has a set of command line tools for importing and exporting items in batches, using the DSpace simple archive format. The tools are not terribly robust, but are useful and are easily modified. They also give a good demonstration of how to implement your own item importer if desired.</p>
@@ -362,7 +468,8 @@
<p>The basic concept behind the DSpace's simple archive format is to create an archive, which is directory full of items, with a subdirectory per item. Each item directory contains a file for the item's descriptive metadata, and the files that make up the item.</p> <p>The basic concept behind the DSpace's simple archive format is to create an archive, which is directory full of items, with a subdirectory per item. Each item directory contains a file for the item's descriptive metadata, and the files that make up the item.</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">archive_directory/ <pre class="code-java">
archive_directory/
item_000/ item_000/
dublin_core.xml -- qualified Dublin Core metadata <span class="code-keyword">for</span> metadata fields belonging to the dc schema dublin_core.xml -- qualified Dublin Core metadata <span class="code-keyword">for</span> metadata fields belonging to the dc schema
metadata_[prefix].xml -- metadata in another schema, the prefix is the name of the schema as registered with the metadata registry metadata_[prefix].xml -- metadata in another schema, the prefix is the name of the schema as registered with the metadata registry
@@ -383,7 +490,8 @@
<li><em>&lt;qualifier&gt;</em> &#45; the element's qualifier</li> <li><em>&lt;qualifier&gt;</em> &#45; the element's qualifier</li>
<li><em>&lt;language&gt;</em> &#45; (optional)ISO language code for element <li><em>&lt;language&gt;</em> &#45; (optional)ISO language code for element
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">&lt;dublin_core&gt; <pre class="code-java">
&lt;dublin_core&gt;
&lt;dcvalue element=<span class="code-quote">"title"</span> qualifier=<span class="code-quote">"none"</span>&gt;A Tale of Two Cities&lt;/dcvalue&gt; &lt;dcvalue element=<span class="code-quote">"title"</span> qualifier=<span class="code-quote">"none"</span>&gt;A Tale of Two Cities&lt;/dcvalue&gt;
&lt;dcvalue element=<span class="code-quote">"date"</span> qualifier=<span class="code-quote">"issued"</span>&gt;1990&lt;/dcvalue&gt; &lt;dcvalue element=<span class="code-quote">"date"</span> qualifier=<span class="code-quote">"issued"</span>&gt;1990&lt;/dcvalue&gt;
&lt;dcvalue element=<span class="code-quote">"title"</span> qualifier=<span class="code-quote">"alternate"</span> language=<span class="code-quote">"fr"</span>&gt;J'aime les Printemps&lt;/dcvalue&gt; &lt;dcvalue element=<span class="code-quote">"title"</span> qualifier=<span class="code-quote">"alternate"</span> language=<span class="code-quote">"fr"</span>&gt;J'aime les Printemps&lt;/dcvalue&gt;
@@ -399,7 +507,8 @@
<p>The <em>contents</em> file simply enumerates, one file per line, the bitstream file names. See the following example:</p> <p>The <em>contents</em> file simply enumerates, one file per line, the bitstream file names. See the following example:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"> file_1.doc <pre class="code-java">
file_1.doc
file_2.pdf file_2.pdf
license license
</pre> </pre>
@@ -1053,7 +1162,7 @@ Adding your own filters is done by creating a class which <em>implements</em> th
<pre class="code-java">[dspace]/bin/dspace community-filiator -r -p parentID -c childID</pre> <pre class="code-java">[dspace]/bin/dspace community-filiator -r -p parentID -c childID</pre>
</div></div> </div></div>
<p>where '<del>r' or '</del>&#45;remove' means dis-establish the current relationship in which the community identified by 'parentID' is the parent of the community identified by 'childID'. The outcome will be that the 'childID' community will become an orphan, i.e. a top-level community.</p> <p>where '<del>r' or '</del>-remove' means dis-establish the current relationship in which the community identified by 'parentID' is the parent of the community identified by 'childID'. The outcome will be that the 'childID' community will become an orphan, i.e. a top-level community.</p>
<p>If the required constraints of operation are violated, an error message will appear explaining the problem, and no change will be made. An example in a removal operation, where the stated child community does not have the stated parent community as its parent: "Error, child community not a child of parent community".</p> <p>If the required constraints of operation are violated, an error message will appear explaining the problem, and no change will be made. An example in a removal operation, where the stated child community does not have the stated parent community as its parent: "Error, child community not a child of parent community".</p>
@@ -1102,7 +1211,7 @@ Adding your own filters is done by creating a class which <em>implements</em> th
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> <tt>&#45;a</tt> or <tt>&#45;-all</tt> </td> <td class='confluenceTd'> <tt>&#45;a</tt> or <tt>&#45;-all</tt> </td>
<td class='confluenceTd'> Include all the metadata fields that are not normally changed (e.g. provenance) or those fields you configured in the <em>dspace.cfg</em> to be ignored on export. </td> <td class='confluenceTd'> Include all the metadata fields that are not normally changed (e.g. provenance) or those fields you configured in the <tt>dspace.cfg</tt> to be ignored on export. </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> <tt>&#45;h</tt> or <tt>&#45;-help</tt> </td> <td class='confluenceTd'> <tt>&#45;h</tt> or <tt>&#45;-help</tt> </td>
@@ -1538,47 +1647,47 @@ checker.retention.CHECKSUM_MATCH = 8w</pre>
<td class='confluenceTd'> Description </td> <td class='confluenceTd'> Description </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> <em><del>r</del></em> or <em>&#45;rebuild</em> </td> <td class='confluenceTd'> <tt>&#45;r</tt> or <tt>&#45;rebuild</tt> </td>
<td class='confluenceTd'> Should we rebuild all the indexes, which removes old tables and creates new ones. For use with <em>&#45;f</em>. Mutually exclusive with <em>&#45;d</em> </td> <td class='confluenceTd'> Should we rebuild all the indexes, which removes old tables and creates new ones. For use with <tt>&#45;f</tt>. Mutually exclusive with <tt>&#45;d</tt> </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> <em><del>s</del></em> or <em>&#45;start</em> </td> <td class='confluenceTd'> <tt>&#45;s</tt> or <tt>&#45;start</tt> </td>
<td class='confluenceTd'> <em>[-s &lt;int&gt;] &#95;start from this index number and work upwards (mostly only useful for debugging). For use with &#95;-t</em> and <em>&#45;f</em> </td> <td class='confluenceTd'> <tt>[-s &lt;int&gt;] start from this index number and work upwards (mostly only useful for debugging). For use with {{-t</tt> and <tt>&#45;f</tt> </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> <em><del>x</del></em> or <em>&#45;execute</em> </td> <td class='confluenceTd'> <tt>&#45;x</tt> or <tt>&#45;execute</tt> </td>
<td class='confluenceTd'> Execute all the remove and create SQL against the database. For use with <em>&#45;t &#95;and &#95;-f</em> </td> <td class='confluenceTd'> Execute all the remove and create SQL against the database. For use with <tt>&#45;t</tt> and <tt>&#45;f</tt> </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> <em><del>i</del></em> or <em>&#45;index</em> </td> <td class='confluenceTd'> <tt>&#45;i</tt> or <tt>&#45;index</tt> </td>
<td class='confluenceTd'> Actually do the indexing. Mutually exclusive with <em>&#45;t</em> and <em>&#45;f</em>. </td> <td class='confluenceTd'> Actually do the indexing. Mutually exclusive with <tt>&#45;t</tt> and <tt>&#45;f</tt>. </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> <em><del>o</del></em> or <em>&#45;out</em> </td> <td class='confluenceTd'> <tt>&#45;o</tt> or <tt>&#45;out</tt> </td>
<td class='confluenceTd'> <em>[-o&lt;filename&gt;]</em> write the remove and create SQL to the given file. For use with <em>&#45;t</em> and <em>&#45;f</em> </td> <td class='confluenceTd'> <tt>[-o&lt;filename&gt;]</tt> write the remove and create SQL to the given file. For use with <tt>&#45;t</tt> and <tt>&#45;f</tt> </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> <em><del>p</del></em> or <em>&#45;print</em> </td> <td class='confluenceTd'> <tt>&#45;p</tt> or <tt>&#45;print</tt> </td>
<td class='confluenceTd'> Write the remove and create SQL to the stdout. For use with <em>&#45;t</em> and <em>&#45;f</em>. </td> <td class='confluenceTd'> Write the remove and create SQL to the stdout. For use with <tt>&#45;t</tt> and <tt>&#45;f</tt>. </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> <em><del>t</del></em> or <em>&#45;tables</em> </td> <td class='confluenceTd'> <tt>&#45;t</tt> or <tt>&#45;tables</tt> </td>
<td class='confluenceTd'> Create the tables only, do no attempt to index. Mutually exclusive with <em>&#45;f</em> and <em>&#45;i</em> </td> <td class='confluenceTd'> Create the tables only, do no attempt to index. Mutually exclusive with <tt>&#45;f</tt> and <tt>&#45;i</tt> </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> <em><del>f</del></em> or <em>&#45;full</em> </td> <td class='confluenceTd'> <tt>&#45;f</tt> or <tt>&#45;full</tt> </td>
<td class='confluenceTd'> Make the tables, and do the indexing. This forces <em>&#45;x</em>. Mutually exclusive with <em>&#45;f</em> and <em>&#45;i</em>. </td> <td class='confluenceTd'> Make the tables, and do the indexing. This forces <tt>&#45;x</tt>. Mutually exclusive with <tt>&#45;f</tt> and <tt>&#45;i</tt>. </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> <em><del>v</del></em> or <em>&#45;verbose</em> </td> <td class='confluenceTd'> <tt>&#45;v</tt> or <tt>&#45;verbose</tt> </td>
<td class='confluenceTd'> Print extra information to the stdout. If used in conjunction with <em>&#45;p</em>, you cannot use the stdout to generate your database structure. </td> <td class='confluenceTd'> Print extra information to the stdout. If used in conjunction with <tt>&#45;p</tt>, you cannot use the stdout to generate your database structure. </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> <em><del>d</del></em> or <em>&#45;delete</em> </td> <td class='confluenceTd'> <tt>&#45;d</tt> or <tt>&#45;delete</tt> </td>
<td class='confluenceTd'> Delete all the indexes, but do not create new ones. For use with <em>&#45;f</em>. This is mutually exclusive with <em>&#45;r</em>. </td> <td class='confluenceTd'> Delete all the indexes, but do not create new ones. For use with <tt>&#45;f</tt>. This is mutually exclusive with <tt>&#45;r</tt>. </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> <em><del>h</del></em> or <em>&#45;help</em> </td> <td class='confluenceTd'> <tt>&#45;h</tt> or <tt>&#45;help</tt> </td>
<td class='confluenceTd'> Show this help documentation. Overrides all other arguments. </td> <td class='confluenceTd'> Show this help documentation. Overrides all other arguments. </td>
</tr> </tr>
</tbody></table> </tbody></table>
@@ -1601,9 +1710,8 @@ checker.retention.CHECKSUM_MATCH = 8w</pre>
<p><b>Destroy and rebuild.</b> You can destroy and rebuild the database, but do not do the indexing. Output the SQL to do this to the screen and a file, as well as executing it against the database, while being verbose. At the CLI screen:</p> <p><b>Destroy and rebuild.</b> You can destroy and rebuild the database, but do not do the indexing. Output the SQL to do this to the screen and a file, as well as executing it against the database, while being verbose. At the CLI screen:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"></pre> <pre class="code-java">[dspace]/bin/dspace index \-r \-t \-p \-v \-x \-o myfile.sql</pre>
</div></div> </div></div>
<p>dspace/bin/dspace index &#45;r &#45;t &#45;p &#45;v &#45;x &#45;o myfile.sql&#95;</p>
<h3><a name="SystemAdministration-IndexingCustomization"></a>Indexing Customization</h3> <h3><a name="SystemAdministration-IndexingCustomization"></a>Indexing Customization</h3>
@@ -1647,7 +1755,7 @@ As one can see, the choices are limited only by your metadata schema, the metada
<table class='confluenceTable'><tbody> <table class='confluenceTable'><tbody>
<tr> <tr>
<td class='confluenceTd'> Command used: </td> <td class='confluenceTd'> Command used: </td>
<td class='confluenceTd'> _<em>[dspace]</em>_<em>/bin/dspace stats-log-converter</em> </td> <td class='confluenceTd'> <tt>[dspace]/bin/dspace stats-log-converter</tt> </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> Java class: </td> <td class='confluenceTd'> Java class: </td>
@@ -1658,27 +1766,27 @@ As one can see, the choices are limited only by your metadata schema, the metada
<td class='confluenceTd'> Description </td> <td class='confluenceTd'> Description </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> <em><del>i</del></em> or <em>&#45;in</em> </td> <td class='confluenceTd'> <tt>&#45;i</tt> or <tt>&#45;in</tt> </td>
<td class='confluenceTd'> Input file </td> <td class='confluenceTd'> Input file </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> <em><del>o</del></em> or <em>&#45;out</em> </td> <td class='confluenceTd'> <tt>&#45;o</tt> or <tt>&#45;out</tt> </td>
<td class='confluenceTd'> Output file </td> <td class='confluenceTd'> Output file </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> <em><del>m</del></em> or <em>&#45;multiple</em> </td> <td class='confluenceTd'> <tt>&#45;m</tt> or <tt>&#45;multiple</tt> </td>
<td class='confluenceTd'> Adds a wildcard at the end of input and output, so it would mean dspace.log&#42; would be converted. (For example, the following files would be included because of this argument: <em>dspace.log, dspace.log.1, dspace.log.2, dspace.log.3,</em> etc.) </td> <td class='confluenceTd'> Adds a wildcard at the end of input and output, so it would mean dspace.log&#42; would be converted. (For example, the following files would be included because of this argument: <em>dspace.log, dspace.log.1, dspace.log.2, dspace.log.3,</em> etc.) </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> <em><del>n</del></em> or <em>&#45;newformat</em> </td> <td class='confluenceTd'> <tt>&#45;n</tt> or <tt>&#45;newformat</tt> </td>
<td class='confluenceTd'> If the log files have been created with DSpace 1.6 </td> <td class='confluenceTd'> If the log files have been created with DSpace 1.6 </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> <em><del>v</del></em> or <em>&#45;verbose</em> </td> <td class='confluenceTd'> <tt>&#45;v</tt> or <tt>&#45;verbose</tt> </td>
<td class='confluenceTd'> Display verbose ouput (helpful for debugging) </td> <td class='confluenceTd'> Display verbose ouput (helpful for debugging) </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> <em><del>h</del></em> or <em>&#45;help</em> </td> <td class='confluenceTd'> <tt>&#45;h</tt> or <tt>&#45;help</tt> </td>
<td class='confluenceTd'> Help </td> <td class='confluenceTd'> Help </td>
</tr> </tr>
</tbody></table> </tbody></table>
@@ -1690,7 +1798,7 @@ As one can see, the choices are limited only by your metadata schema, the metada
<table class='confluenceTable'><tbody> <table class='confluenceTable'><tbody>
<tr> <tr>
<td class='confluenceTd'> Command used: </td> <td class='confluenceTd'> Command used: </td>
<td class='confluenceTd'> _<em>[dspace]</em>_<em>/bin/dspace stats-log-importer</em> </td> <td class='confluenceTd'> <tt>[dspace]/bin/dspace stats-log-importer</tt> </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> Java class: </td> <td class='confluenceTd'> Java class: </td>
@@ -1701,27 +1809,27 @@ As one can see, the choices are limited only by your metadata schema, the metada
<td class='confluenceTd'> Description </td> <td class='confluenceTd'> Description </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> <em><del>i</del></em> or <em>&#45;</em> </td> <td class='confluenceTd'> <tt>&#45;i</tt> or <tt>&#45;&#45;</tt> </td>
<td class='confluenceTd'> input file </td> <td class='confluenceTd'> input file </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> <em><del>m</del></em> or <em>&#45;</em> </td> <td class='confluenceTd'> <tt>&#45;m</tt> or <tt>&#45;&#45;</tt> </td>
<td class='confluenceTd'> Adds a wildcard at the end of the input, so it would mean dspace.log&#42; would be imported </td> <td class='confluenceTd'> Adds a wildcard at the end of the input, so it would mean dspace.log&#42; would be imported </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> <em><del>s</del></em> or <em>&#45;</em> </td> <td class='confluenceTd'> <tt>&#45;s</tt> or <tt>&#45;&#45;</tt> </td>
<td class='confluenceTd'> To skip the reverse DNS lookups that work out where a user is from. (The DNS lookup finds the inforamtion about the host from its IP addess, such as geographical location, etc. This can be slow, and wouldn't work on a server not connected to the internet.) </td> <td class='confluenceTd'> To skip the reverse DNS lookups that work out where a user is from. (The DNS lookup finds the inforamtion about the host from its IP addess, such as geographical location, etc. This can be slow, and wouldn't work on a server not connected to the internet.) </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> <em><del>v</del></em> or <em>&#45;</em> </td> <td class='confluenceTd'> <tt>&#45;v</tt> or <tt>&#45;&#45;</tt> </td>
<td class='confluenceTd'> Display verbose ouput (helpful for debugging) </td> <td class='confluenceTd'> Display verbose ouput (helpful for debugging) </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> <em><del>l</del></em> or <em>&#45;</em> </td> <td class='confluenceTd'> <tt>&#45;l</tt> or <tt>&#45;&#45;</tt> </td>
<td class='confluenceTd'> For developers: allows you to import a log file from another system, so because the handles won't exist, it looks up random items in your local system to add hits to instead. </td> <td class='confluenceTd'> For developers: allows you to import a log file from another system, so because the handles won't exist, it looks up random items in your local system to add hits to instead. </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> <em><del>h</del></em> or <em>&#45;</em> </td> <td class='confluenceTd'> <tt>&#45;h</tt> or <tt>&#45;&#45;</tt> </td>
<td class='confluenceTd'> Help </td> <td class='confluenceTd'> Help </td>
</tr> </tr>
</tbody></table> </tbody></table>
@@ -1737,7 +1845,7 @@ As one can see, the choices are limited only by your metadata schema, the metada
<table class='confluenceTable'><tbody> <table class='confluenceTable'><tbody>
<tr> <tr>
<td class='confluenceTd'> Command used: </td> <td class='confluenceTd'> Command used: </td>
<td class='confluenceTd'> _<em>[dspace]</em>_<em>/bin/dspace stats-util</em> </td> <td class='confluenceTd'> <tt>[dspace]/bin/dspace stats-util</tt> </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> Java class: </td> <td class='confluenceTd'> Java class: </td>
@@ -1748,23 +1856,23 @@ As one can see, the choices are limited only by your metadata schema, the metada
<td class='confluenceTd'> Description </td> <td class='confluenceTd'> Description </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> <em><del>u</del></em> or <em>&#45;update-spider-files</em> </td> <td class='confluenceTd'> <tt>&#45;u</tt> or <tt>&#45;update-spider-files</tt> </td>
<td class='confluenceTd'> Update Spider IP Files from internet into /dspace/config/spiders. Downloads Spider files identified in <em>dspace.cfg</em> under property </td> <td class='confluenceTd'> Update Spider IP Files from internet into <tt>/dspace/config/spiders</tt>. Downloads Spider files identified in <em>dspace.cfg</em> under property </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> <em><del>f</del></em> or <em>&#45;delete-spiders-by-flag</em> </td> <td class='confluenceTd'> <tt>&#45;f</tt> or <tt>&#45;delete-spiders-by-flag</tt> </td>
<td class='confluenceTd'> Delete Spiders in Solr By isBot Flag. Will prune out all records that have <em>isBot:true</em> </td> <td class='confluenceTd'> Delete Spiders in Solr By isBot Flag. Will prune out all records that have <tt>isBot:true</tt> </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> <em><del>i</del></em> or <em>&#45;delete-spiders-by-ip</em> </td> <td class='confluenceTd'> <tt>&#45;i</tt> or <tt>&#45;delete-spiders-by-ip</tt> </td>
<td class='confluenceTd'> Delete Spiders in Solr By IP Address. Will prune out all records that have IP's that match spider IPs. </td> <td class='confluenceTd'> Delete Spiders in Solr By IP Address. Will prune out all records that have IP's that match spider IPs. </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> <em><del>m</del></em> or <em>&#45;mark-spiders</em> </td> <td class='confluenceTd'> <tt>&#45;m</tt> or <tt>&#45;mark-spiders</tt> </td>
<td class='confluenceTd'> Update isBog Flag in Solr. Marks any records currently stored in statistics that have IP addresses matched in spiders files </td> <td class='confluenceTd'> Update isBog Flag in Solr. Marks any records currently stored in statistics that have IP addresses matched in spiders files </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> <em><del>h</del></em> or <em>&#45;help</em> </td> <td class='confluenceTd'> <tt>&#45;h</tt> or <tt>&#45;help</tt> </td>
<td class='confluenceTd'> Calls up this brief help table at CLI. </td> <td class='confluenceTd'> Calls up this brief help table at CLI. </td>
</tr> </tr>
</tbody></table> </tbody></table>
@@ -1773,11 +1881,11 @@ As one can see, the choices are limited only by your metadata schema, the metada
<p>Notes:</p> <p>Notes:</p>
<p>The usage of these options is open for the user to choose, If they want to keep spider entires in their repository, they can just mark them using "<em>&#45;m</em>" and they will be excluded from statistics queries when "<em>solr.statistics.query.filter.isBot = true</em>" in the <em>dspace.cfg</em>.</p> <p>The usage of these options is open for the user to choose, If they want to keep spider entires in their repository, they can just mark them using "<tt>&#45;m</tt>" and they will be excluded from statistics queries when "<tt>solr.statistics.query.filter.isBot = true</tt>" in the <tt>dspace.cfg</tt>.</p>
<p>If they want to keep the spiders out of the solr repository, they can run just use the "<em>&#45;i</em>" option and they will be removed immediately.</p> <p>If they want to keep the spiders out of the solr repository, they can run just use the "<tt>&#45;i</tt>" option and they will be removed immediately.</p>
<p>There are guards in place to control what can be defined as an IP range for a bot, in <em>[dspace]/config/spiders</em>, spider IP address ranges have to be at least 3 subnet sections in length 123.123.123 and IP Ranges can only be on the smallest subnet [123.123.123.0 - 123.123.123.255]. If not, loading that row will cause exceptions in the dspace logs and exclude that IP entry.</p> <p>There are guards in place to control what can be defined as an IP range for a bot, in <tt>[dspace]/config/spiders</tt>, spider IP address ranges have to be at least 3 subnet sections in length 123.123.123 and IP Ranges can only be on the smallest subnet [123.123.123.0 - 123.123.123.255]. If not, loading that row will cause exceptions in the dspace logs and exclude that IP entry.</p>
<h2><a name="SystemAdministration-TestDatabase"></a>Test Database</h2> <h2><a name="SystemAdministration-TestDatabase"></a>Test Database</h2>
@@ -1787,7 +1895,7 @@ As one can see, the choices are limited only by your metadata schema, the metada
<table class='confluenceTable'><tbody> <table class='confluenceTable'><tbody>
<tr> <tr>
<td class='confluenceTd'> Command used: </td> <td class='confluenceTd'> Command used: </td>
<td class='confluenceTd'> _<em>[dspace]</em>_<em>/bin/dspace test-database</em> </td> <td class='confluenceTd'> <tt>[dspace]/bin/dspace test-database</tt> </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> Java class: </td> <td class='confluenceTd'> Java class: </td>
@@ -1798,13 +1906,24 @@ As one can see, the choices are limited only by your metadata schema, the metada
<td class='confluenceTd'> Description </td> <td class='confluenceTd'> Description </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> or <em>&#45;</em> </td> <td class='confluenceTd'> <tt>&#45;</tt> or <tt>&#45;&#45;</tt> </td>
<td class='confluenceTd'> There are no arguments used at this time. </td> <td class='confluenceTd'> There are no arguments used at this time. </td>
</tr> </tr>
</tbody></table> </tbody></table>
</div> </div>
<h2><a name="SystemAdministration-Movingitems"></a>Moving items</h2>
<p>It is possible for administrators to move items one at a time using either the JSPUI or the XMLUI.&nbsp; When editing an item, on the 'Edit item' screen select the 'Move Item' option.&nbsp; To move the item, select the new collection for the item to appear in.&nbsp; When the item is moved, it will take its authorizations (who can READ / WRITE it) with it.</p>
<p>If you wish for the item to take on the default authorizations of the destination collection, tick the 'Inherit default policies of destination collection' checkbox.&nbsp; This is useful if you are moving an item from a private collection to a public collection, or from a public collection to a private collection.</p>
<ul>
<li>Note: When selecting the 'Inherit default policies of destination collection' option, ensure that this will not override system-managed authorizations such as those imposed by the embargo system.</li>
</ul>
</td> </td>
</tr> </tr>
@@ -1814,7 +1933,7 @@ As one can see, the choices are limited only by your metadata schema, the metada
<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> <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>
<tr> <tr>
<td align="center"><font color="grey">Document generated by Confluence on Nov 06, 2010 19:27</font></td> <td align="center"><font color="grey">Document generated by Confluence on Dec 16, 2010 16:47</font></td>
</tr> </tr>
</table> </table>
</body> </body>

331
dspace/docs/html/Upgrading a DSpace Installation.html
View File

@@ -16,11 +16,12 @@
</span> </span>
</div> </div>
<div class="pagesubheading"> <div class="pagesubheading">
This page last changed on Nov 06, 2010 by <font color="#0050B2">jtrimble</font>. This page last changed on Dec 16, 2010 by <font color="#0050B2">tdonohue</font>.
</div> </div>
<h1><a name="UpgradingaDSpaceInstallation-DSpaceSystemDocumentation%3AUpgradingaDSpaceInstallation"></a>DSpace System Documentation: Upgrading a DSpace Installation</h1> <h1><a name="UpgradingaDSpaceInstallation-DSpaceSystemDocumentation%3AUpgradingaDSpaceInstallation"></a>DSpace System Documentation: Upgrading a DSpace Installation</h1>
<p>This section describes how to upgrade a DSpace installation from one version to the next. Details of the differences between the functionality of each version are given in the Version History section.</p>
<p>This section describes how to upgrade a DSpace installation from one version to the next. Details of the differences between the functionality of each version are given in the <a href="History.html" title="History">Version History</a> section.</p>
<div class='panelMacro'><table class='warningMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="images/icons/emoticons/forbidden.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><b>Test Your Upgrade Process</b><br />It is always recommended that when performing an upgrade that the user should use a Development or Test instance or server in order to minimize downtime. You should note any problems you have encountered (and also how to resolve them) before attempting to upgrade your production instance or server. It also gives you a chance to "practice" at the upgrade. (And practice makes perfect.)</td></tr></table></div> <div class='panelMacro'><table class='warningMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="images/icons/emoticons/forbidden.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><b>Test Your Upgrade Process</b><br />It is always recommended that when performing an upgrade that the user should use a Development or Test instance or server in order to minimize downtime. You should note any problems you have encountered (and also how to resolve them) before attempting to upgrade your production instance or server. It also gives you a chance to "practice" at the upgrade. (And practice makes perfect.)</td></tr></table></div>
@@ -48,20 +49,27 @@
<h2><a name="UpgradingaDSpaceInstallation-Upgradingfrom1.6.xto1.7"></a>Upgrading from 1.6.x to 1.7</h2> <h2><a name="UpgradingaDSpaceInstallation-Upgradingfrom1.6.xto1.7"></a>Upgrading from 1.6.x to 1.7</h2>
<p>In the notes below <em>[dspace]</em> refers to the install directory for your existing DSpace installation, and <em>[dspace-source]</em> to the source directory for DSpace 1.7.0. Whenever you see these path references, be sure to replace them with the actual path names on your local system.</p> <p>In the notes below <tt>[dspace]</tt> refers to the install directory for your existing DSpace installation, and <em>[dspace-source]</em> to the source directory for DSpace 1.7.0. Whenever you see these path references, be sure to replace them with the actual path names on your local system.</p>
<div class='panelMacro'><table class='infoMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="images/icons/emoticons/information.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td>Before upgrading you need to check you are using the current recommended minimum versions of Java (1.6), Maven (2.0.8 or above) and ant (1.7 or above). For more details, see the current listing of <a href="Installation.html#Installation-PrerequisiteSoftware">Prerequisite Software</a></td></tr></table></div>
<ol> <ol>
<li><b>Backup Your DSpace.</b> First, and foremost, make a complete backup of your system, including: <li><b>Backup Your DSpace.</b> First, and foremost, make a complete backup of your system, including:
<ul> <ul>
<li>A snapshot of the database. &#95;To have a "snapshot" of the PostgreSQL database, you need to shut it down during the backup. You should also have your regular PostgreSQL Backup output (using pg_dump commands). _</li> <li>A snapshot of the database. <em>To have a "snapshot" of the PostgreSQL database, you need to shut it down during the backup. You should also have your regular PostgreSQL Backup output (using pg_dump commands).</em></li>
<li>The asset store (<em>[dspace]/assetstore</em> by default)</li> <li>The asset store (<em>[dspace]/assetstore</em> by default)</li>
<li>Your configuration files and customizations to DSpace (including any customized scripts).</li> <li>Your configuration files and customizations to DSpace (including any customized scripts).</li>
</ul> </ul>
</li> </li>
<li><b>Download DSpace 1.7.0</b> Retrieve the new DSpace 1.7.0 source code either as a download from <a href="http://www.dspace.org/latest-release/">SourceForge</a> or check it out directly from the <a href="http://scm.dspace.org/svn/repo/dspace/tags/dspace-1.7.0/">SVN code repository</a>. If you downloaded DSpace do not unpack it on top of your existing installation.Refer to Chapter 3.3.3 Installation, Step 3 for unpacking directives.</li> <li><b>Download DSpace 1.7.0</b> Retrieve the new DSpace 1.7.0 source code either as a download from <a href="http://www.dspace.org/latest-release/">DSpace.org</a> or check it out directly from the <a href="http://scm.dspace.org/svn/repo/dspace/tags/dspace-1.7.0/">SVN code repository</a>. If you downloaded DSpace do not unpack it on top of your existing installation. Refer to <a href="Installation.html#Installation-Installation">Installation Instructions, Step 3</a> for unpacking directives.</li>
<li><b>Stop Tomcat.</b> Take down your servlet container. For Tomcat, use the <em>$CATALINA/shutdown.sh</em> script. (Many installations will have a startup/shutdown script in the <em>/etc/init.d</em> or <em>/etc/rc.d</em> directories.</li> <li><b>Stop Tomcat.</b> Take down your servlet container. For Tomcat, use the <em>$CATALINA_HOME/bin/shutdown.sh</em> script. (Many Unix-based installations will have a startup/shutdown script in the <em>/etc/init.d</em> or <em>/etc/rc.d</em> directories).</li>
<li><b>Apply any customizations.</b> If you have made any local customizations to your DSpace installation they will need to be migrated over to the new DSpace. These are housed in one of the following places:JSPUI modifications: <em>[dspace-source]/dspace/modules/jspui/src/main/webapp/_XMLUI modifications: &#95;[dspace-source]/dspace/modules/xmlui/src/main/webbapp</em></li> <li><b>Apply any customizations.</b> If you have made any local customizations to your DSpace installation they will need to be migrated over to the new DSpace. These are normally housed in one of the following places:
<li><b>Update Configuration Files.</b>&nbsp;Some parameters have changed and some are new. &nbsp;Changes will be notes below: <ul>
<li>JSPUI modifications: <em>[dspace-source]/dspace/modules/jspui/src/main/webapp/</em></li>
<li>XMLUI modifications: <em>[dspace-source]/dspace/modules/xmlui/src/main/webapp/</em></li>
</ul>
</li>
<li><b>Update Configuration Files.</b> Some parameters have changed and some are new. You can either attempt to make these changes in your current 1.6.x <tt>dspace.cfg</tt> file, or you can start with a new 1.7.0 <tt>dspace.cfg</tt> and re-modify it as needed. Configuration changes are noted below:
<ul> <ul>
<li>&#42;<b>CORRECTION</b>&#42; &nbsp;There was a missing hyphen "-" in the property key for mail character set: <li>&#42;<b>CORRECTION</b>&#42; &nbsp;There was a missing hyphen "-" in the property key for mail character set:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
@@ -260,19 +268,19 @@ aip.disseminate.rightsMD = DSpaceDepositLicense:DSPACE_DEPLICENSE, \
# If unspecfied, defaults to <span class="code-quote">"MODS, DIM"</span> # If unspecfied, defaults to <span class="code-quote">"MODS, DIM"</span>
aip.disseminate.dmd = MODS, DIM</pre> aip.disseminate.dmd = MODS, DIM</pre>
</div></div></li> </div></div></li>
<li>&#42;&#42; NEW*&#42; A new property has been added to control the discovery index for the Event System Configuration: <li>&#42;<b>NEW</b>&#42; A new property has been added to control the discovery index for the Event System Configuration:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"> consumer to maintain the discovery index <pre class="code-java"> consumer to maintain the discovery index
event.consumer.discovery.class = org.dspace.discovery.IndexEventConsumer event.consumer.discovery.class = org.dspace.discovery.IndexEventConsumer
event.consumer.discovery.filters = Community|Collection|Item|Bundle+Add|Create|Modify|Modify_Metadata|Delete|Remove</pre> event.consumer.discovery.filters = Community|Collection|Item|Bundle+Add|Create|Modify|Modify_Metadata|Delete|Remove</pre>
</div></div></li> </div></div></li>
<li>&#42;&#42; NEW &#42;&#42; License bundle display is now configurable. You are able to either display or suppress. <li>&#42;<b>NEW</b>&#42; License bundle display is now configurable. You are able to either display or suppress.
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"># whether to display the contents of the licence bundle (often just the deposit <pre class="code-java"># whether to display the contents of the licence bundle (often just the deposit
# licence in standard DSpace installation # licence in standard DSpace installation
webui.licence_bundle.show = <span class="code-keyword">false</span></pre> webui.licence_bundle.show = <span class="code-keyword">false</span></pre>
</div></div></li> </div></div></li>
<li>&#42;&#42; CORRECTION*&#42; Thumbnail generation. The width and height of generated thumbnails had a missing equal sign. <li>&#42;<b>CORRECTION</b>&#42; Thumbnail generation. The width and height of generated thumbnails had a missing equal sign.
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"># maximum width and height of generated thumbnails <pre class="code-java"># maximum width and height of generated thumbnails
thumbnail.maxwidth = 80 thumbnail.maxwidth = 80
@@ -323,10 +331,19 @@ thumbnail.maxheight = 80</pre>
## Direction of sorting order. Values: DESC or ASC. Default: ASC ## Direction of sorting order. Values: DESC or ASC. Default: ASC
#webui.bitstream.order.direction = ASC #webui.bitstream.order.direction = ASC
</pre> </pre>
</div></div></li>
<li>&#42;<b>NEW</b>&#42; DSpace now includes a metadata mapping feature that makes repository content discoverable by Google Scholar:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
##### Google Scholar Metadata Configuration #####
google-metadata.config = ${dspace.dir}/config/crosswalks/google-metadata.properties
google-metadata.enable = <span class="code-keyword">true</span>
</pre>
</div></div></li> </div></div></li>
<li>&#42;<b>NEW</b>&#42; XMLUI is now able to concatenate CSS, JS and JSON files: <li>&#42;<b>NEW</b>&#42; XMLUI is now able to concatenate CSS, JS and JSON files:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"># Enabling <span class="code-keyword">this</span> property will concatenate CSS, JS and JSON files where possible. <pre class="code-java">
# Enabling <span class="code-keyword">this</span> property will concatenate CSS, JS and JSON files where possible.
# CSS files can be concatenated <span class="code-keyword">if</span> multiple CSS files with the same media attribute # CSS files can be concatenated <span class="code-keyword">if</span> multiple CSS files with the same media attribute
# are used in the same page. Links to the CSS files are automatically referring to the # are used in the same page. Links to the CSS files are automatically referring to the
# concatenated resulting CSS file. # concatenated resulting CSS file.
@@ -342,7 +359,8 @@ thumbnail.maxheight = 80</pre>
</div></div></li> </div></div></li>
<li>&#42;<b>NEW</b>&#42; XMLUI Mirage Theme. This is a new theme with it's own configuration: <li>&#42;<b>NEW</b>&#42; XMLUI Mirage Theme. This is a new theme with it's own configuration:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">### Setings <span class="code-keyword">for</span> Item lists in Mirage theme ### <pre class="code-java">
### Setings <span class="code-keyword">for</span> Item lists in Mirage theme ###
# What should the emphasis be in the display of item lists? # What should the emphasis be in the display of item lists?
# Possible values : 'file', 'metadata'. If your repository is # Possible values : 'file', 'metadata'. If your repository is
# used mainly <span class="code-keyword">for</span> scientific papers 'metadata' is probably the # used mainly <span class="code-keyword">for</span> scientific papers 'metadata' is probably the
@@ -368,7 +386,8 @@ mets.<span class="code-keyword">default</span>.ingest.crosswalk.EPDCX = SWORD
</div></div></li> </div></div></li>
<li>&#42;<b>NEW</b>&#42; New SOLR Statistic Property keys: <li>&#42;<b>NEW</b>&#42; New SOLR Statistic Property keys:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"># Timeout <span class="code-keyword">for</span> the resolver in the dns lookup <pre class="code-java">
# Timeout <span class="code-keyword">for</span> the resolver in the dns lookup
# Time in milliseconds, defaults to 200 <span class="code-keyword">for</span> backward compatibility # Time in milliseconds, defaults to 200 <span class="code-keyword">for</span> backward compatibility
# Your systems <span class="code-keyword">default</span> is usually set in /etc/resolv.conf and varies # Your systems <span class="code-keyword">default</span> is usually set in /etc/resolv.conf and varies
# between 2 to 5 seconds, to high a value might result in solr exhausting # between 2 to 5 seconds, to high a value might result in solr exhausting
@@ -388,10 +407,10 @@ solr.resolver.timeout = 200
</li> </li>
<li><b>Build DSpace.</b> Run the following commands to compile DSpace.: <li><b>Build DSpace.</b> Run the following commands to compile DSpace.:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">cd /[dspace-source]/dspace/ <pre class="code-java">cd [dspace-source]/dspace/
mvn -U clean <span class="code-keyword">package</span></pre> mvn -U clean <span class="code-keyword">package</span></pre>
</div></div> </div></div>
<p>You will find the result in <em>[dspace-source]/dspace/target/dspace-[version]-build.dir</em> . Inside this directory is the compiled binary distribution of DSpace.Before rebuilding DSpace, the above command will clean out any previously compiled code ('clean') and ensure that your local DSpace JAR files are updated from the remote maven repository.</p></li> <p> You will find the result in <em>[dspace-source]/dspace/target/dspace-[version]-build.dir</em> . Inside this directory is the compiled binary distribution of DSpace. Before rebuilding DSpace, the above command will clean out any previously compiled code ('clean') and ensure that your local DSpace JAR files are updated from the remote maven code repository.</p></li>
<li><b>Update DSpace.</b> Update the DSpace installed directory with the new code and libraries. Issue the following commands: <li><b>Update DSpace.</b> Update the DSpace installed directory with the new code and libraries. Issue the following commands:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <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 <pre class="code-java">cd [dspace-source]/dspace/target/dspace-[version]-build.dir
@@ -417,11 +436,11 @@ ant -Dconfig=[dspace]/config/dspace.cfg update</pre>
</li> </li>
</ul> </ul>
</li> </li>
<li><b>Generate Browse and Search Indexes</b>. It's always good policy to rebuild your search and browse indexes when upgrading to a new release. To do this, run the following command from your DSpace install directory (as the dspace user): <li><b>Generate Browse and Search Indexes</b>. It's always good policy to rebuild your search and browse indexes when upgrading to a new release. To do this, run the following command from your DSpace install directory (as the 'dspace' user):
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">[dspace]/bin/dspace index-init</pre> <pre class="code-java">[dspace]/bin/dspace index-init</pre>
</div></div></li> </div></div></li>
<li><b>Deploy Web Applications</b>. Copy the web applications files from your <tt>[dspace]/webapps</tt> directory to the subdirectory of your servlet container (e.g. tomcat): <li><b>Deploy Web Applications</b>. If your servlet container (e.g. Tomcat) is not configured to look for new web applications in your <tt>[dspace]/webapps</tt> directory, then you will need to copy the web applications files into the appropriate subdirectory of your servlet container. For example:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">cp -R [dspace]/webapps/* [tomcat]/webapps/</pre> <pre class="code-java">cp -R [dspace]/webapps/* [tomcat]/webapps/</pre>
</div></div></li> </div></div></li>
@@ -432,19 +451,19 @@ ant -Dconfig=[dspace]/config/dspace.cfg update</pre>
<h2><a name="UpgradingaDSpaceInstallation-Upgradingfrom1.6to1.6.x"></a>Upgrading from 1.6 to 1.6.x</h2> <h2><a name="UpgradingaDSpaceInstallation-Upgradingfrom1.6to1.6.x"></a>Upgrading from 1.6 to 1.6.x</h2>
<p>In the notes below <em>[dspace]</em> refers to the install directory for your existing DSpace installation, and <em>[dspace-source]</em> to the source directory for DSpace 1.6.1. Whenever you see these path references, be sure to replace them with the actual path names on your local system.</p> <p>In the notes below <tt>[dspace]</tt> refers to the install directory for your existing DSpace installation, and <tt>[dspace-source]</tt> to the source directory for DSpace 1.6.1. Whenever you see these path references, be sure to replace them with the actual path names on your local system.</p>
<ol> <ol>
<li><b>Backup Your DSpace.</b> First, and foremost, make a complete backup of your system, including: <li><b>Backup Your DSpace.</b> First, and foremost, make a complete backup of your system, including:
<ul> <ul>
<li>A snapshot of the database. &#95;To have a "snapshot" of the PostgreSQL database, you need to shut it down during the backup. You should also have your regular PostgreSQL Backup output (using pg_dump commands). _</li> <li>A snapshot of the database. <em>To have a "snapshot" of the PostgreSQL database, you need to shut it down during the backup. You should also have your regular PostgreSQL Backup output (using pg_dump commands).</em></li>
<li>The asset store (<em>[dspace]/assetstore</em> by default)</li> <li>The asset store (<em>[dspace]/assetstore</em> by default)</li>
<li>Your configuration files and customizations to DSpace (including any customized scripts).</li> <li>Your configuration files and customizations to DSpace (including any customized scripts).</li>
</ul> </ul>
</li> </li>
<li><b>Download DSpace 1.6.1</b> Retrieve the new DSpace 1.6.2 source code either as a download from <a href="http://www.dspace.org/latest-release/">SourceForge</a> or check it out directly from the <a href="http://scm.dspace.org/svn/repo/dspace/tags/dspace-1.6.2/">SVN code repository</a>. If you downloaded DSpace do not unpack it on top of your existing installation. Refer to Chapter 3.3.3 Installation, Step 3 for unpacking directives.</li> <li><b>Download DSpace 1.6.1</b> Retrieve the new DSpace 1.6.2 source code either as a download from <a href="http://www.dspace.org/latest-release/">DSpace.org</a> or check it out directly from the <a href="http://scm.dspace.org/svn/repo/dspace/tags/dspace-1.6.2/">SVN code repository</a>. If you downloaded DSpace do not unpack it on top of your existing installation. Refer to Chapter 3.3.3 Installation, Step 3 for unpacking directives.</li>
<li><b>Stop Tomcat.</b> Take down your servlet container. For Tomcat, use the <em>$CATALINA/shutdown.sh</em> script. (Many installations will have a startup/shutdown script in the <em>/etc/init.d</em> or <em>/etc/rc.d</em> directories.</li> <li><b>Stop Tomcat.</b> Take down your servlet container. For Tomcat, use the <em>$CATALINA/shutdown.sh</em> script. (Many installations will have a startup/shutdown script in the <em>/etc/init.d</em> or <em>/etc/rc.d</em> directories.</li>
<li><b>Apply any customizations.</b> If you have made any local customizations to your DSpace installation they will need to be migrated over to the new DSpace. These are housed in one of the following places:JSPUI modifications: <em>[dspace-source]/dspace/modules/jspui/src/main/webapp/_XMLUI modifications: &#95;[dspace-source]/dspace/modules/xmlui/src/main/webbapp</em></li> <li><b>Apply any customizations.</b> If you have made any local customizations to your DSpace installation they will need to be migrated over to the new DSpace. These are housed in one of the following places:JSPUI modifications: <em>[dspace-source]/dspace/modules/jspui/src/main/webapp/_XMLUI modifications: &#95;[dspace-source]/dspace/modules/xmlui/src/main/webapp</em></li>
<li><b>Update Configuration Files.</b> There are no additions to this release. So you do not have to update the configuration files.</li> <li><b>Update Configuration Files.</b> There are no additions to this release. So you do not have to update the configuration files.</li>
<li><b>Build DSpace.</b> Run the following commands to compile DSpace.: <li><b>Build DSpace.</b> Run the following commands to compile DSpace.:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
@@ -460,17 +479,17 @@ ant -Dconfig=[dspace]/config/dspace.cfg update</pre>
<li><b>Run Registry Format Update for CC License.</b> Creative Commons licenses have been assigned the wrong mime-type in past versions of DSpace. Even if you are not currently using CC Licenses, you should update your Bitstream Format Registry to include a new entry with the proper mime-type. To update your registry, run the following command: <em>dspace]/bin/dspace registry-loader &#45;bitstream [dspace]/etc/upgrades/15-16/new-bitstream-formats.xml</em></li> <li><b>Run Registry Format Update for CC License.</b> Creative Commons licenses have been assigned the wrong mime-type in past versions of DSpace. Even if you are not currently using CC Licenses, you should update your Bitstream Format Registry to include a new entry with the proper mime-type. To update your registry, run the following command: <em>dspace]/bin/dspace registry-loader &#45;bitstream [dspace]/etc/upgrades/15-16/new-bitstream-formats.xml</em></li>
<li><b>Update the Database.</b> If you are using Creative Commons Licenses in your DSpace submission process, you will need to run the 1.5.x to 1.6.x database upgrade script again. In 1.6.0 the improper mime-type was being assigned to all CC Licenses. This has now been resolved, and rerunning the upgrade script will now assign the proper mime-type to all existing CC Licenses in your DSpace installation. NOTE: You will receive messages that most of the script additions already exist. This is normal, and nothing to be worried about. <li><b>Update the Database.</b> If you are using Creative Commons Licenses in your DSpace submission process, you will need to run the 1.5.x to 1.6.x database upgrade script again. In 1.6.0 the improper mime-type was being assigned to all CC Licenses. This has now been resolved, and rerunning the upgrade script will now assign the proper mime-type to all existing CC Licenses in your DSpace installation. NOTE: You will receive messages that most of the script additions already exist. This is normal, and nothing to be worried about.
<ul> <ul>
<li>For PostgreSQL: <em>psql &#45;U [dspace-user] &#45;f [dspace-source]/dspace/etc/postgres/database_schema_15_16.sql [database name]</em> (Your database name is by default 'dspace'). Example: <li>For PostgreSQL: <em>psql &#45;U [dspace-user] &#45;f [dspace-source]/dspace/etc/postgres/database_schema_15-16.sql [database name]</em> (Your database name is by default 'dspace'). Example:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">psql -U dspace -f <pre class="code-java">psql -U dspace -f
/dspace-1.6-1-src-release/dspace/etc/postgres/database_schema_15_16.sql dspace</pre> /dspace-1.6-1-src-release/dspace/etc/postgres/database_schema_15-16.sql dspace</pre>
</div></div> </div></div>
<p><em>(The line break above is cosmetic. Please place your command in one line.</em></p></li> <p><em>(The line break above is cosmetic. Please place your command in one line.</em></p></li>
<li>For Oracle: Execute the upgrade script, e.g. with sqlplus, recording the output: <li>For Oracle: Execute the upgrade script, e.g. with sqlplus, recording the output:
<ol> <ol>
<li>Start SQL*Plus with "<em>sqlplus [connect args]</em>"</li> <li>Start SQL*Plus with "<em>sqlplus [connect args]</em>"</li>
<li>Record the output: <em>SQL&gt; spool 'upgrade.lst'</em></li> <li>Record the output: <em>SQL&gt; spool 'upgrade.lst'</em></li>
<li>Run the upgrade script <em>SQL&gt; @[dspace-source]/dspace/etc/oracle/database_schema_15_16.sql</em><em>SQL&gt; spool off</em></li> <li>Run the upgrade script <em>SQL&gt; @[dspace-source]/dspace/etc/oracle/database_schema_15-16.sql</em><em>SQL&gt; spool off</em></li>
<li>Please note: The final few statements WILL FAIL. That is because you have run some queries and use the results to construct the statements to remove the constraints, manually‚ Oracle doesn't have any easy way to automate this (unless you know PL/SQL). So, look for the comment line beginning: <li>Please note: The final few statements WILL FAIL. That is because you have run some queries and use the results to construct the statements to remove the constraints, manually‚ Oracle doesn't have any easy way to automate this (unless you know PL/SQL). So, look for the comment line beginning:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"><span class="code-quote">"--You need to remove the already in place constraints"</span> <pre class="code-java"><span class="code-quote">"--You need to remove the already in place constraints"</span>
@@ -490,7 +509,7 @@ the output of the queries you'll need.</pre>
<h2><a name="UpgradingaDSpaceInstallation-Upgradingfrom1.5.xto1.6.x"></a>Upgrading from 1.5.x to 1.6.x</h2> <h2><a name="UpgradingaDSpaceInstallation-Upgradingfrom1.5.xto1.6.x"></a>Upgrading from 1.5.x to 1.6.x</h2>
<p>In the notes below <em>[dspace]</em> refers to the install directory for your existing DSpace installation, and <em>[dspace-source]</em> to the source directory for DSpace 1.6. Whenever you see these path references, be sure to replace them with the actual path names on your local system.</p> <p>In the notes below <tt>[dspace]</tt> refers to the install directory for your existing DSpace installation, and <em>[dspace-source]</em> to the source directory for DSpace 1.6. Whenever you see these path references, be sure to replace them with the actual path names on your local system.</p>
<ol> <ol>
<li><b>Backup Your DSpace.</b> First, and foremost, make a complete backup of your system, including: <li><b>Backup Your DSpace.</b> First, and foremost, make a complete backup of your system, including:
@@ -500,9 +519,9 @@ the output of the queries you'll need.</pre>
<li>Your configuration files and customizations to DSpace (including any customized scripts).</li> <li>Your configuration files and customizations to DSpace (including any customized scripts).</li>
</ul> </ul>
</li> </li>
<li><b>Download DSpace 1.6.x</b> Retrieve the new DSpace 1.6.x source code either as a download from <a href="http://www.dspace.org/latest-release/">SourceForge</a> or check it out directly from the <a href="http://scm.dspace.org/svn/repo/dspace/tags/dspace-1.6.2/">SVN code repository</a>. If you downloaded DSpace do not unpack it on top of your existing installation.Refer to Chapter 3.3.3 Installation, Step 3 for unpacking directives.</li> <li><b>Download DSpace 1.6.x</b> Retrieve the new DSpace 1.6.x source code either as a download from <a href="http://www.dspace.org/latest-release/">DSpace.org</a> or check it out directly from the <a href="http://scm.dspace.org/svn/repo/dspace/tags/dspace-1.6.2/">SVN code repository</a>. If you downloaded DSpace do not unpack it on top of your existing installation.Refer to Chapter 3.3.3 Installation, Step 3 for unpacking directives.</li>
<li><b>Stop Tomcat</b>. Take down your servlet container. For Tomcat, use the <em>$CATALINA/shutdown.sh</em> script. (Many installations will have a startup/shutdown script in the <em>/etc/init.d</em> or <em>/etc/rc.d</em> directories.</li> <li><b>Stop Tomcat</b>. Take down your servlet container. For Tomcat, use the <em>$CATALINA/shutdown.sh</em> script. (Many installations will have a startup/shutdown script in the <em>/etc/init.d</em> or <em>/etc/rc.d</em> directories.</li>
<li><b>Apply any customizations</b>. If you have made any local customizations to your DSpace installation they will need to be migrated over to the new DSpace. These are housed in one of the following places:JSPUI modifications: <em>[dspace-source]/dspace/modules/jspui/src/main/webapp/_XMLUI modifications: &#95;[dspace-source]/dspace/modules/xmlui/src/main/webbapp</em></li> <li><b>Apply any customizations</b>. If you have made any local customizations to your DSpace installation they will need to be migrated over to the new DSpace. These are housed in one of the following places:JSPUI modifications: <em>[dspace-source]/dspace/modules/jspui/src/main/webapp/_XMLUI modifications: &#95;[dspace-source]/dspace/modules/xmlui/src/main/webapp</em></li>
<li><b>Update Configuration Files</b>. Some of the parameters have change and some are new. Changes will be noted below: <li><b>Update Configuration Files</b>. Some of the parameters have change and some are new. Changes will be noted below:
<ul> <ul>
<li>&#42;&#42;<b>CHANGE</b>&#42;&#42; The base url and oai urls property keys are set differently <li>&#42;&#42;<b>CHANGE</b>&#42;&#42; The base url and oai urls property keys are set differently
@@ -543,7 +562,7 @@ dspace.oai.url = ${dspace.baseUrl}/oai</pre>
#mail.server.disabled = <span class="code-keyword">false</span> #mail.server.disabled = <span class="code-keyword">false</span>
</pre> </pre>
</div></div></li> </div></div></li>
<li>&#42;&#42;<b>NEW</b>&#42;*New Authorization levels and parameters. See Section 5.2.10 in Configuration : Delegation Administration for further information. <li>&#42;&#42;<b>NEW</b>&#42;*New Authorization levels and parameters. See the <a href="Configuration.html" title="Configuration">Configuration</a> documentation, "Delegation Administration" section for further information.
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">##### Authorization system configuration - Delegate ADMIN ##### <pre class="code-java">##### Authorization system configuration - Delegate ADMIN #####
@@ -657,7 +676,7 @@ plugin.single.org.dspace.embargo.EmbargoSetter = \
plugin.single.org.dspace.embargo.EmbargoLifter = \ plugin.single.org.dspace.embargo.EmbargoLifter = \
org.dspace.embargo.DefaultEmbargoLifter</pre> org.dspace.embargo.DefaultEmbargoLifter</pre>
</div></div></li> </div></div></li>
<li>&#42;&#42;<b>NEW</b>&#42;&#42; New option for using the Batch Editing capabilities. See Section 5.2.21 in Configuration and also 8.10 in System Administration <li>&#42;&#42;<b>NEW</b>&#42;&#42; New option for using the Batch Editing capabilities. See <a href="Configuration.html#Configuration-BatchMetadataEditing">Batch Metadata Editing Configuration</a> and also <a href="System Administration.html#SystemAdministration-BatchMetadataEditing">System Administration : Batch Metadata Editing</a>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">### Bulk metadata editor settings ### <pre class="code-java">### Bulk metadata editor settings ###
# The delimiter used to separate values within a single field (defaults to a <span class="code-object">double</span> pipe ||) # The delimiter used to separate values within a single field (defaults to a <span class="code-object">double</span> pipe ||)
@@ -959,9 +978,10 @@ harvester.unknownSchema = fail
#harvester.rejectedHandlePrefix = 123456789, myTestHandle #harvester.rejectedHandlePrefix = 123456789, myTestHandle
</pre> </pre>
</div></div></li> </div></div></li>
<li>&#42;&#42;<b>NEW</b>&#42;&#42; SOLR Statistics Configurations.For a little more detailed information regarding the configuration, please refer to Section 5.2.49 DSpace SOLR Statistics Configuration ; or, for installation procedures, refer to Section 3.4.6 Dspace Statistics. <li>&#42;&#42;<b>NEW</b>&#42;&#42; SOLR Statistics Configurations. For a little more detailed information regarding the configuration, please refer to <a href="Configuration.html#Configuration-DSpaceSOLRStatisticsConfiguration">DSpace SOLR Statistics Configuration</a> ; or, for installation procedures, refer to <a href="Installation.html#Installation-DSpaceStatistics">Advanced Installation: Dspace Statistics</a>.
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">#---------------------------------------------------------------# <pre class="code-java">
#---------------------------------------------------------------#
#--------------SOLR STATISTICS CONFIGURATIONS-------------------# #--------------SOLR STATISTICS CONFIGURATIONS-------------------#
#---------------------------------------------------------------# #---------------------------------------------------------------#
# These configs are only used by the SOLR <span class="code-keyword">interface</span>/webapp to # # These configs are only used by the SOLR <span class="code-keyword">interface</span>/webapp to #
@@ -990,10 +1010,9 @@ statistics.item.authorization.admin=<span class="code-keyword">true</span></pre>
mvn -U clean <span class="code-keyword">package</span></pre> mvn -U clean <span class="code-keyword">package</span></pre>
</div></div> </div></div>
<p>You will find the result in <em>[dspace-source]/dspace/target/dspace-[version]-build.dir</em> . Inside this directory is the compiled binary distribution of DSpace.Before rebuilding DSpace, the above command will clean out any previously compiled code ('clean') and ensure that your local DSpace JAR files are updated from the remote maven repository.</p></li> <p>You will find the result in <em>[dspace-source]/dspace/target/dspace-[version]-build.dir</em> . Inside this directory is the compiled binary distribution of DSpace.Before rebuilding DSpace, the above command will clean out any previously compiled code ('clean') and ensure that your local DSpace JAR files are updated from the remote maven repository.</p></li>
<li>&#42;Update Registry for the CC License.*If you use the CC License, an incorrect mime-type type is being assigned. You will need to run the following step: &#95;dspace]/bin/dspace registry-loader &#45;bitstream [dspace]/etc/upgrades/15-16/new-bitstream-formats.xml _</li>
<li><b>Update the database</b>. The database schema needs to be updated to accommodate changes to the database. SQL files contain the relevant updates are provided. Please note that if you have made any local customizations to the database schema, you should consult these updates and make sure they will work for you. <li><b>Update the database</b>. The database schema needs to be updated to accommodate changes to the database. SQL files contain the relevant updates are provided. Please note that if you have made any local customizations to the database schema, you should consult these updates and make sure they will work for you.
<ul> <ul>
<li>For PostgreSQL: <em>psql &#45;U [dspace-user] &#45;f [dspace-source]/dspace/etc/postgres/database_schema_15_16.sql [database name]</em> (Your database name is by default 'dspace'). Example:&#95;<em>psql &#45;U dspace &#45;f /dspace-1.6-1-src-release/dspace/etc/postgres/database_schema_15_16.sql dspace</em>_</li> <li>For PostgreSQL: <tt>psql &#45;U [dspace-user] &#45;f [dspace-source]/dspace/etc/postgres/database_schema_15-16.sql [database name]</tt> (Your database name is by default 'dspace'). Example: <tt>psql &#45;U dspace &#45;f /dspace-1.6-1-src-release/dspace/etc/postgres/database_schema_15-16.sql dspace</tt></li>
<li>For Oracle: Execute the upgrade script, e.g. with sqlplus, recording the output: <li>For Oracle: Execute the upgrade script, e.g. with sqlplus, recording the output:
<ol> <ol>
<li>Start SQL*Plus with "<em>sqlplus [connect args]</em>"</li> <li>Start SQL*Plus with "<em>sqlplus [connect args]</em>"</li>
@@ -1015,6 +1034,7 @@ the output of the queries you'll need.</pre>
<pre class="code-java">cd [dspace-source]/dspace/target/dspace-[version]-build.dir <pre class="code-java">cd [dspace-source]/dspace/target/dspace-[version]-build.dir
ant -Dconfig=[dspace]/config/dspace.cfg update</pre> ant -Dconfig=[dspace]/config/dspace.cfg update</pre>
</div></div></li> </div></div></li>
<li><b>Update Registry for the CC License.</b> If you use the CC License, an incorrect mime-type type is being assigned. You will need to run the following step: &#95;dspace]/bin/dspace registry-loader &#45;bitstream [dspace]/etc/upgrades/15-16/new-bitstream-formats.xml _</li>
<li><b>Generate Browse and Search Indexes</b>. It makes good policy to rebuild your search and browse indexes when upgrading to a new release. Almost every release has database changes and indexes can be affected by this. In the DSpace 1.6 release there is Authority Control features and those will need the indexes to be regenerated. To do this, run the following command from your DSpace install directory (as the dspace user):<em>[dspace]/bin/dspace index-init</em></li> <li><b>Generate Browse and Search Indexes</b>. It makes good policy to rebuild your search and browse indexes when upgrading to a new release. Almost every release has database changes and indexes can be affected by this. In the DSpace 1.6 release there is Authority Control features and those will need the indexes to be regenerated. To do this, run the following command from your DSpace install directory (as the dspace user):<em>[dspace]/bin/dspace index-init</em></li>
<li><b>Deploy Web Applications</b>. Copy the web applications files from your <em>[dspace]/webapps</em> directory to the subdirectory of your servlet container (e.g. tomcat):<em>cp &#45;R [dspace]/webapps/&#42; [tomcat]/webapps/</em></li> <li><b>Deploy Web Applications</b>. Copy the web applications files from your <em>[dspace]/webapps</em> directory to the subdirectory of your servlet container (e.g. tomcat):<em>cp &#45;R [dspace]/webapps/&#42; [tomcat]/webapps/</em></li>
<li><b>Restart servlet.</b> Now restart your Tomcat/Jetty/Resin server program and test out the upgrade.</li> <li><b>Restart servlet.</b> Now restart your Tomcat/Jetty/Resin server program and test out the upgrade.</li>
@@ -1024,7 +1044,7 @@ ant -Dconfig=[dspace]/config/dspace.cfg update</pre>
[dspace]/bin/dspace stats-log-importer -i input file name (probably the output name from above) -m [dspace]/bin/dspace stats-log-importer -i input file name (probably the output name from above) -m
</pre> </pre>
</div></div> </div></div>
<p>The user is highly recommend to see Section 8.14 DSpace Log Converter.</p></li> <p>The user is highly recommend to see the <a href="System Administration.html#SystemAdministration-DSpaceLogConverter">System Administration : DSpace Log Converter</a> documentation.</p></li>
</ol> </ol>
@@ -1032,7 +1052,7 @@ ant -Dconfig=[dspace]/config/dspace.cfg update</pre>
<p>The changes in DSpace 1.5.2 do not include any database schema upgrades, and the upgrade should be straightforward.</p> <p>The changes in DSpace 1.5.2 do not include any database schema upgrades, and the upgrade should be straightforward.</p>
<p>In the notes below <em>[dspace]</em> refers to the install directory for your existing DSpace installation, and <em>[dspace-source]</em> to the source directory for DSpace 1.5. Whenever you see these path references, be sure to replace them with the actual path names on your local system.</p> <p>In the notes below <tt>[dspace]</tt> refers to the install directory for your existing DSpace installation, and <em>[dspace-source]</em> to the source directory for DSpace 1.5. Whenever you see these path references, be sure to replace them with the actual path names on your local system.</p>
<ol> <ol>
<li><b>Backup your DSpace</b> First and foremost, make a complete backup of your system, including: <li><b>Backup your DSpace</b> First and foremost, make a complete backup of your system, including:
@@ -1043,10 +1063,11 @@ ant -Dconfig=[dspace]/config/dspace.cfg update</pre>
<li>Your statistics scripts (<em>[dspace]/bin/stat&#42;</em>) which contain customizable dates</li> <li>Your statistics scripts (<em>[dspace]/bin/stat&#42;</em>) which contain customizable dates</li>
</ul> </ul>
</li> </li>
<li><b>Download DSpace 1.5.2</b> Get the new DSpace 1.5.2 source code either as a download from <a href="http://www.dspace.org/latest-release/">SourceForge</a> or check it out directly from the <a href="http://scm.dspace.org/svn/repo/dspace/tags/dspace-1.5.2/">SVN code repository</a>. If you downloaded DSpace do not unpack it on top of your existing installation.</li> <li><b>Download DSpace 1.5.2</b> Get the new DSpace 1.5.2 source code either as a download from <a href="http://www.dspace.org/latest-release/">DSpace.org</a> or check it out directly from the <a href="http://scm.dspace.org/svn/repo/dspace/tags/dspace-1.5.2/">SVN code repository</a>. If you downloaded DSpace do not unpack it on top of your existing installation.</li>
<li><b>Build DSpace</b> Run the following commands to compile DSpace. <li><b>Build DSpace</b> Run the following commands to compile DSpace.
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"> cd [dspace-source]/dspace/ <pre class="code-java">
cd [dspace-source]/dspace/
mvn <span class="code-keyword">package</span> mvn <span class="code-keyword">package</span>
</pre> </pre>
</div></div> </div></div>
@@ -1055,13 +1076,15 @@ ant -Dconfig=[dspace]/config/dspace.cfg update</pre>
<li><b>Apply any customizations</b> If you have made any local customizations to your DSpace installation they will need to be migrated over to the new DSpace. Commonly these modifications are made to "JSP" pages located inside the <em>[dspace 1.4.2]/jsp/local</em> directory. These should be moved <em>[dspace-source]/dspace/modules/jspui/src/main/webapp/</em> in the new build structure. See Customizing the JSP Pages for more information.</li> <li><b>Apply any customizations</b> If you have made any local customizations to your DSpace installation they will need to be migrated over to the new DSpace. Commonly these modifications are made to "JSP" pages located inside the <em>[dspace 1.4.2]/jsp/local</em> directory. These should be moved <em>[dspace-source]/dspace/modules/jspui/src/main/webapp/</em> in the new build structure. See Customizing the JSP Pages for more information.</li>
<li><b>Update DSpace</b> Update the DSpace installed directory with new code and libraries. Inside the <em>[dspace-source]/dspace/target/dspace-1.5-build.dir/</em> directory run: <li><b>Update DSpace</b> Update the DSpace installed directory with new code and libraries. Inside the <em>[dspace-source]/dspace/target/dspace-1.5-build.dir/</em> directory run:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">cd [dspace-source]/dspace/target/dspace-1.5-build.dir/ <pre class="code-java">
cd [dspace-source]/dspace/target/dspace-1.5-build.dir/
ant -Dconfig=[dspace]/config/dspace.cfg update ant -Dconfig=[dspace]/config/dspace.cfg update
</pre> </pre>
</div></div></li> </div></div></li>
<li><b>Update configuration files</b> This ant target preserves existing files in <em>[dspace]/config _ and will copy any new configuration files in place. If an existing file prevents copying the new file in place, the new file will have the suffix &#95;.new</em>, for example <em>[dspace]/local/dspace.cfg.new</em>. Note: there is also a configuration option <em>&#45;Doverwrite=true</em> which will instead copy the conflicting target files to &#42;.old suffixes and overwrite target file then with the new file (essentially the opposite) this is beneficial for developers and those who use the <em>[dspace-source]/dspace/config</em> to maintain their changes. <li><b>Update configuration files</b> This ant target preserves existing files in <em>[dspace]/config _ and will copy any new configuration files in place. If an existing file prevents copying the new file in place, the new file will have the suffix &#95;.new</em>, for example <em>[dspace]/local/dspace.cfg.new</em>. Note: there is also a configuration option <em>&#45;Doverwrite=true</em> which will instead copy the conflicting target files to &#42;.old suffixes and overwrite target file then with the new file (essentially the opposite) this is beneficial for developers and those who use the <em>[dspace-source]/dspace/config</em> to maintain their changes.
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">cd [dspace-source]/dspace/target/dspace-1.5-build.dir/ <pre class="code-java">
cd [dspace-source]/dspace/target/dspace-1.5-build.dir/
ant -Dconfig=[dspace]/config/dspace.cfg update_configs ant -Dconfig=[dspace]/config/dspace.cfg update_configs
</pre> </pre>
</div></div> </div></div>
@@ -1069,7 +1092,8 @@ ant -Dconfig=[dspace]/config/dspace.cfg update_configs
<ul> <ul>
<li>New option to restrict the expose of private items. The following needs to be added to dspace.cfg: <li>New option to restrict the expose of private items. The following needs to be added to dspace.cfg:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">#### Restricted item visibility settings ### <pre class="code-java">
#### Restricted item visibility settings ###
# By <span class="code-keyword">default</span> RSS feeds, OAI-PMH and subscription emails will include ALL items # By <span class="code-keyword">default</span> RSS feeds, OAI-PMH and subscription emails will include ALL items
# regardless of permissions set on them. # regardless of permissions set on them.
# #
@@ -1082,7 +1106,8 @@ ant -Dconfig=[dspace]/config/dspace.cfg update_configs
</div></div></li> </div></div></li>
<li>Special groups for LDAP and password authentication. <li>Special groups for LDAP and password authentication.
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">##### Password users group ##### <pre class="code-java">
##### Password users group #####
# If required, a group name can be given here, and all users who log in # If required, a group name can be given here, and all users who log in
# using the DSpace password system will automatically become members of # using the DSpace password system will automatically become members of
@@ -1100,7 +1125,8 @@ ant -Dconfig=[dspace]/config/dspace.cfg update_configs
</div></div></li> </div></div></li>
<li>new option for case insensitivity in browse tables. <li>new option for case insensitivity in browse tables.
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"># By <span class="code-keyword">default</span>, the display of metadata in the browse indexes is <span class="code-keyword">case</span> sensitive <pre class="code-java">
# By <span class="code-keyword">default</span>, the display of metadata in the browse indexes is <span class="code-keyword">case</span> sensitive
# So, you will get separate entries <span class="code-keyword">for</span> the terms # So, you will get separate entries <span class="code-keyword">for</span> the terms
# #
# Olive oil # Olive oil
@@ -1121,7 +1147,8 @@ ant -Dconfig=[dspace]/config/dspace.cfg update_configs
</div></div></li> </div></div></li>
<li>New usage event handler for collecting statistics: <li>New usage event handler for collecting statistics:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">### Usage event settings ### <pre class="code-java">
### Usage event settings ###
# The usage event handler to call. The <span class="code-keyword">default</span> is the <span class="code-quote">"passive"</span> handler, which ignores events. # The usage event handler to call. The <span class="code-keyword">default</span> is the <span class="code-quote">"passive"</span> handler, which ignores events.
# plugin.single.org.dspace.app.statistics.AbstractUsageEvent = \ # plugin.single.org.dspace.app.statistics.AbstractUsageEvent = \
# org.dspace.app.statistics.PassiveUsageEvent # org.dspace.app.statistics.PassiveUsageEvent
@@ -1129,19 +1156,22 @@ ant -Dconfig=[dspace]/config/dspace.cfg update_configs
</div></div></li> </div></div></li>
<li>The location where sitemaps are stored is now configurable. <li>The location where sitemaps are stored is now configurable.
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">#### Sitemap settings ##### <pre class="code-java">
#### Sitemap settings #####
# the directory where the generated sitemaps are stored # the directory where the generated sitemaps are stored
sitemap.dir = ${dspace.dir}/sitemaps sitemap.dir = ${dspace.dir}/sitemaps
</pre> </pre>
</div></div></li> </div></div></li>
<li>MARC 21 ordering should now be used as default. Unless you have it set already, or you have it set to a different value, the following should be set: <li>MARC 21 ordering should now be used as default. Unless you have it set already, or you have it set to a different value, the following should be set:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">plugin.named.org.dspace.sort.OrderFormatDelegate = org.dspace.sort.OrderFormatTitleMarc21=title <pre class="code-java">
plugin.named.org.dspace.sort.OrderFormatDelegate = org.dspace.sort.OrderFormatTitleMarc21=title
</pre> </pre>
</div></div></li> </div></div></li>
<li>Hierarchical LDAP support. <li>Hierarchical LDAP support.
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">##### Hierarchical LDAP Settings ##### <pre class="code-java">
##### Hierarchical LDAP Settings #####
# If your users are spread out across a hierarchical tree on your # If your users are spread out across a hierarchical tree on your
# LDAP server, you will need to use the following stackable authentication # LDAP server, you will need to use the following stackable authentication
# class: # class:
@@ -1178,7 +1208,8 @@ sitemap.dir = ${dspace.dir}/sitemaps
</div></div></li> </div></div></li>
<li>Shibboleth authentication support. <li>Shibboleth authentication support.
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">#### Shibboleth Authentication Configuration Settings #### <pre class="code-java">
#### Shibboleth Authentication Configuration Settings ####
# Check https:<span class="code-comment">//mams.melcoe.mq.edu.au/zope/mams/pubs/Installation/dspace15/view # Check https:<span class="code-comment">//mams.melcoe.mq.edu.au/zope/mams/pubs/Installation/dspace15/view
</span># <span class="code-keyword">for</span> installation detail. </span># <span class="code-keyword">for</span> installation detail.
# #
@@ -1246,7 +1277,8 @@ authentication.shib.role.Librarian = Administrator
</div></div></li> </div></div></li>
<li>DOI and handle identifiers can now be rendered in the JSPUI. <li>DOI and handle identifiers can now be rendered in the JSPUI.
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"># When using <span class="code-quote">"resolver"</span> in webui.itemdisplay to render identifiers as resolvable <pre class="code-java">
# When using <span class="code-quote">"resolver"</span> in webui.itemdisplay to render identifiers as resolvable
# links, the base URL is taken from &lt;code&gt;webui.resolver.&lt;n&gt;.baseurl&lt;/code&gt; # links, the base URL is taken from &lt;code&gt;webui.resolver.&lt;n&gt;.baseurl&lt;/code&gt;
# where &lt;code&gt;webui.resolver.&lt;n&gt;.baseurl&lt;/code&gt; matches the urn specified in the metadata value. # where &lt;code&gt;webui.resolver.&lt;n&gt;.baseurl&lt;/code&gt; matches the urn specified in the metadata value.
# The value is appended to the <span class="code-quote">"baseurl"</span> as is, so the baseurl need to end with slash almost in any <span class="code-keyword">case</span>. # The value is appended to the <span class="code-quote">"baseurl"</span> as is, so the baseurl need to end with slash almost in any <span class="code-keyword">case</span>.
@@ -1267,7 +1299,8 @@ authentication.shib.role.Librarian = Administrator
<p> In configuration sections such as webui.itemdisplay.default, values can be changed from (e.g.) metadata.dc.identifier.doi to metadata.doi.dc.identifier.doi</p></li> <p> In configuration sections such as webui.itemdisplay.default, values can be changed from (e.g.) metadata.dc.identifier.doi to metadata.doi.dc.identifier.doi</p></li>
<li>The whole of the SWORD configuration has changed. The SWORD section must be removed and replaced with <li>The whole of the SWORD configuration has changed. The SWORD section must be removed and replaced with
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">#---------------------------------------------------------------# <pre class="code-java">
#---------------------------------------------------------------#
#--------------SWORD SPECIFIC CONFIGURATIONS--------------------# #--------------SWORD SPECIFIC CONFIGURATIONS--------------------#
#---------------------------------------------------------------# #---------------------------------------------------------------#
# These configs are only used by the SWORD <span class="code-keyword">interface</span> # # These configs are only used by the SWORD <span class="code-keyword">interface</span> #
@@ -1477,7 +1510,7 @@ http:<span class="code-comment">//purl.org/net/sword-types/METSDSpaceSIP \
<p>The changes in DSpace 1.5 are significant and wide spread involving database schema upgrades, code restructuring, completely new user and programmatic interfaces, and new build system.</p> <p>The changes in DSpace 1.5 are significant and wide spread involving database schema upgrades, code restructuring, completely new user and programmatic interfaces, and new build system.</p>
<p>In the notes below <em>[dspace]</em> refers to the install directory for your existing DSpace installation, and <em>[dspace-source]</em> to the source directory for DSpace 1.5. Whenever you see these path references, be sure to replace them with the actual path names on your local system.</p> <p>In the notes below <tt>[dspace]</tt> refers to the install directory for your existing DSpace installation, and <em>[dspace-source]</em> to the source directory for DSpace 1.5. Whenever you see these path references, be sure to replace them with the actual path names on your local system.</p>
<ol> <ol>
<li><b>Backup your DSpace</b> First and foremost, make a complete backup of your system, including: <li><b>Backup your DSpace</b> First and foremost, make a complete backup of your system, including:
@@ -1488,10 +1521,11 @@ http:<span class="code-comment">//purl.org/net/sword-types/METSDSpaceSIP \
<li>Your statistics scripts (<em>[dspace]/bin/stat&#42;</em>) which contain customizable dates</li> <li>Your statistics scripts (<em>[dspace]/bin/stat&#42;</em>) which contain customizable dates</li>
</ul> </ul>
</li> </li>
<li><b>Download DSpace 1.5</b> Get the new DSpace 1.5 source code either as a download from <a href="#UpgradingaDSpaceInstallation-%5C" title="SourceForge|">SourceForge\</a> or check it out directly from the <a href="#UpgradingaDSpaceInstallation-%5C" title="SVN code repository|">SVN code repository\</a>. If you downloaded DSpace do not unpack it on top of your existing installation.</li> <li><b>Download DSpace 1.5</b> Get the new DSpace 1.5 source code either as a download from <a href="http://sourceforge.net/projects/dspace/">SourceForge</a> or check it out directly from the <a href="#UpgradingaDSpaceInstallation-%5C" title="SVN code repository|">SVN code repository\</a>. If you downloaded DSpace do not unpack it on top of your existing installation.</li>
<li><b>Build DSpace</b> The build process has radically changed for DSpace 1.5. With this new release the build system has moved to a maven-based system enabling the various projects (JSPUI, XMLUI, OAI, and Core API) into separate projects. See the Installation section for more information on building DSpace using the new maven-based build system. Run the following commands to compile DSpace. <li><b>Build DSpace</b> The build process has radically changed for DSpace 1.5. With this new release the build system has moved to a maven-based system enabling the various projects (JSPUI, XMLUI, OAI, and Core API) into separate projects. See the <a href="Installation.html" title="Installation">Installation</a> section for more information on building DSpace using the new maven-based build system. Run the following commands to compile DSpace.
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"> cd [dspace-source]/dspace/; <pre class="code-java">
cd [dspace-source]/dspace/;
mvn <span class="code-keyword">package</span> mvn <span class="code-keyword">package</span>
</pre> </pre>
</div></div> </div></div>
@@ -1499,7 +1533,8 @@ http:<span class="code-comment">//purl.org/net/sword-types/METSDSpaceSIP \
<li><b>Stop Tomcat</b> Take down your servlet container, for Tomcat use the <em>bin/shutdown.sh</em> script.</li> <li><b>Stop Tomcat</b> Take down your servlet container, for Tomcat use the <em>bin/shutdown.sh</em> script.</li>
<li><b>Update</b> <b><em>dspace.cfg</em></b> Several new parameters need to be added to your <em>[dspace]/config/dspace.cfg</em>. While it is advisable to start with a fresh <em>DSpace 1.5 &#95;dspace.cfg</em> configuration file&#95; here are the minimum set of parameters that need to be added to an old <em>DSpace 1.4.2 configuration</em>. <li><b>Update</b> <b><em>dspace.cfg</em></b> Several new parameters need to be added to your <em>[dspace]/config/dspace.cfg</em>. While it is advisable to start with a fresh <em>DSpace 1.5 &#95;dspace.cfg</em> configuration file&#95; here are the minimum set of parameters that need to be added to an old <em>DSpace 1.4.2 configuration</em>.
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">#### Stackable Authentication Methods ##### <pre class="code-java">
#### Stackable Authentication Methods #####
# #
# Stack of authentication methods # Stack of authentication methods
# (See org.dspace.authenticate.AuthenticationManager) # (See org.dspace.authenticate.AuthenticationManager)
@@ -1578,13 +1613,15 @@ event.consumer.eperson.filters = EPerson+Create
</div></div></li> </div></div></li>
<li><b>Add</b> <b><em>xmlui.xconf</em></b> <b>Manakin configuration</b> The new Manakin user interface available with DSpace 1.5 requires an extra configuration file that you will need to manually copy it over to your configuration directory. <li><b>Add</b> <b><em>xmlui.xconf</em></b> <b>Manakin configuration</b> The new Manakin user interface available with DSpace 1.5 requires an extra configuration file that you will need to manually copy it over to your configuration directory.
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">cp [dspace-source]/dspace/config/xmlui.xconf <pre class="code-java">
cp [dspace-source]/dspace/config/xmlui.xconf
[dspace]/config/xmlui.xconf [dspace]/config/xmlui.xconf
</pre> </pre>
</div></div></li> </div></div></li>
<li><b>Add</b> <b><em>item-submission.xml</em></b> <b>and</b> <b><em>item-submission.dtd</em></b> <b>configurable submission configuration</b> The new configurable submission system that enables an administrator to re-arrange, or add/remove item submission steps requires this configuration file. You need to manually copy it over to your configuration directory. <li><b>Add</b> <b><em>item-submission.xml</em></b> <b>and</b> <b><em>item-submission.dtd</em></b> <b>configurable submission configuration</b> The new configurable submission system that enables an administrator to re-arrange, or add/remove item submission steps requires this configuration file. You need to manually copy it over to your configuration directory.
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">cp [dspace-source]/dspace/config/item-submission.xml <pre class="code-java">
cp [dspace-source]/dspace/config/item-submission.xml
[dspace]/config/item-submission.xml [dspace]/config/item-submission.xml
cp [dspace-source]/dspace/config/item-submission.dtd cp [dspace-source]/dspace/config/item-submission.dtd
@@ -1593,7 +1630,8 @@ cp [dspace-source]/dspace/config/item-submission.dtd
</div></div></li> </div></div></li>
<li><b>Add new</b> <b><em>input-forms.xml</em></b> <b>and</b> <b><em>input-forms.dtd</em></b> <b>configurable submission configuration</b> The input-forms.xml now has an included dtd reference to support validation. You'll need to merge in your changes to both file/and or copy them into place. <li><b>Add new</b> <b><em>input-forms.xml</em></b> <b>and</b> <b><em>input-forms.dtd</em></b> <b>configurable submission configuration</b> The input-forms.xml now has an included dtd reference to support validation. You'll need to merge in your changes to both file/and or copy them into place.
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">cp [dspace-source]/dspace/config/input-forms.xml <pre class="code-java">
cp [dspace-source]/dspace/config/input-forms.xml
[dspace]/config/input-forms.xml [dspace]/config/input-forms.xml
cp [dspace-source]/dspace/config/input-forms.dtd cp [dspace-source]/dspace/config/input-forms.dtd
@@ -1602,7 +1640,8 @@ cp [dspace-source]/dspace/config/input-forms.dtd
</div></div></li> </div></div></li>
<li><b>Add</b> <b><em>sword-swap-ingest.xsl</em></b> <b>and</b> <b><em>xhtml-head-item.properties</em></b> <b>crosswalk files</b> New crosswalk files are required to support SWORD and the inclusion of metadata into the head of items. <li><b>Add</b> <b><em>sword-swap-ingest.xsl</em></b> <b>and</b> <b><em>xhtml-head-item.properties</em></b> <b>crosswalk files</b> New crosswalk files are required to support SWORD and the inclusion of metadata into the head of items.
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">cp [dspace-source]/dspace/config/crosswalks/sword-swap-ingest.xsl <pre class="code-java">
cp [dspace-source]/dspace/config/crosswalks/sword-swap-ingest.xsl
[dspace]/config/crosswalks/sword-swap-ingest.xsl [dspace]/config/crosswalks/sword-swap-ingest.xsl
@@ -1613,7 +1652,8 @@ cp
</div></div></li> </div></div></li>
<li><b>Add</b> <b><em>registration_notify</em></b> <b>email files</b> A new configuration option (<em>registration.notify = you@your-email.com</em>) can be set to send a notification email whenever a new user registers to use your DSpace. The email template for this email needs to be copied. <li><b>Add</b> <b><em>registration_notify</em></b> <b>email files</b> A new configuration option (<em>registration.notify = you@your-email.com</em>) can be set to send a notification email whenever a new user registers to use your DSpace. The email template for this email needs to be copied.
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">cp [dspace-source]/dspace/config/emails/registration_notify <pre class="code-java">
cp [dspace-source]/dspace/config/emails/registration_notify
[dspace]/config/emails/registration_notify [dspace]/config/emails/registration_notify
</pre> </pre>
@@ -1627,13 +1667,15 @@ cp
<li><b>Apply any customizations</b> If you have made any local customizations to your DSpace installation they will need to be migrated over to the new DSpace. Commonly these modifications are made to "JSP" pages located inside the <em>[dspace 1.4.2]/jsp/local</em> directory. These should be moved <em>[dspace-source]/dspace/modules/jspui/src/main/webapp/</em> in the new build structure. See Customizing the JSP Pages for more information.</li> <li><b>Apply any customizations</b> If you have made any local customizations to your DSpace installation they will need to be migrated over to the new DSpace. Commonly these modifications are made to "JSP" pages located inside the <em>[dspace 1.4.2]/jsp/local</em> directory. These should be moved <em>[dspace-source]/dspace/modules/jspui/src/main/webapp/</em> in the new build structure. See Customizing the JSP Pages for more information.</li>
<li><b>Update DSpace</b> Update the DSpace installed directory with new code and libraries. Inside the <em>[dspace-source]/dspace/target/dspace-1.5-build.dir/</em> directory run: <li><b>Update DSpace</b> Update the DSpace installed directory with new code and libraries. Inside the <em>[dspace-source]/dspace/target/dspace-1.5-build.dir/</em> directory run:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">cd [dspace-source]/dspace/target/dspace-1.5-build.dir/; <pre class="code-java">
cd [dspace-source]/dspace/target/dspace-1.5-build.dir/;
ant -Dconfig=[dspace]/config/dspace.cfg update ant -Dconfig=[dspace]/config/dspace.cfg update
</pre> </pre>
</div></div></li> </div></div></li>
<li><b>Update the Metadata Registry</b> New Metadata Registry updates are required to support SWORD. <li><b>Update the Metadata Registry</b> New Metadata Registry updates are required to support SWORD.
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">cp [dspace-source]/dspace/config/registries/sword-metadata.xml <pre class="code-java">
cp [dspace-source]/dspace/config/registries/sword-metadata.xml
[dspace]/config/registries/sword-metadata.xml; [dspace]/config/registries/sword-metadata.xml;
[dspace]/bin/dsrun org.dspace.administer.MetadataImporter -f [dspace]/bin/dsrun org.dspace.administer.MetadataImporter -f
@@ -1642,18 +1684,21 @@ ant -Dconfig=[dspace]/config/dspace.cfg update
</div></div></li> </div></div></li>
<li><b>Rebuild browse and search indexes</b> One of the major new features of DSpace 1.5 is the browse system which necessitates that the indexes be recreated. To do this run the following command from your DSpace installed directory: <li><b>Rebuild browse and search indexes</b> One of the major new features of DSpace 1.5 is the browse system which necessitates that the indexes be recreated. To do this run the following command from your DSpace installed directory:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">[dspace]/bin/index-init <pre class="code-java">
[dspace]/bin/index-init
</pre> </pre>
</div></div></li> </div></div></li>
<li><b>Update statistics scripts</b> The statistics scripts have been rewritten for DSpace 1.5. Prior to 1.5 they were written in Perl, but have been rewritten in Java to avoid having to install Perl. First, make a note of the dates you have specified in your statistics scripts for the statistics to run from. You will find these in <em>[dspace]/bin/stat-initial</em>, as <em>$start_year</em> and <em>$start_month</em>. Note down these values.Copy the new stats scripts: <li><b>Update statistics scripts</b> The statistics scripts have been rewritten for DSpace 1.5. Prior to 1.5 they were written in Perl, but have been rewritten in Java to avoid having to install Perl. First, make a note of the dates you have specified in your statistics scripts for the statistics to run from. You will find these in <em>[dspace]/bin/stat-initial</em>, as <em>$start_year</em> and <em>$start_month</em>. Note down these values.Copy the new stats scripts:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"> cp [dspace-source]/dspace/bin/stat* [dspace]/bin/ <pre class="code-java">
cp [dspace-source]/dspace/bin/stat* [dspace]/bin/
</pre> </pre>
</div></div> </div></div>
<p>Then edit your statistics configuration file with the start details. Add the following to <em>[dspace]/conf/dstat.cfg</em><em>&#35; the year and month to start creating reports from</em><em>&#35; - year as four digits (e.g. 2005)</em><em>&#35; - month as a number (e.g. January is 1, December is 12)</em><em>start.year = 2005</em><em>start.month = 1</em> Replace '2005' and '1' as with the values you noted down. <em>dstat.cfg</em> also used to contain the hostname and service name as displayed at the top of the statistics. These values are now taken from <em>dspace.cfg</em> so you can remove <em>host.name</em> and <em>host.url</em> from <em>dstat.cfg</em> if you wish. The values now used are <em>dspace.hostname</em> and <em>dspace.name</em> from <em>dspace.cfg</em></p></li> <p>Then edit your statistics configuration file with the start details. Add the following to <em>[dspace]/conf/dstat.cfg</em><em>&#35; the year and month to start creating reports from</em><em>&#35; - year as four digits (e.g. 2005)</em><em>&#35; - month as a number (e.g. January is 1, December is 12)</em><em>start.year = 2005</em><em>start.month = 1</em> Replace '2005' and '1' as with the values you noted down. <em>dstat.cfg</em> also used to contain the hostname and service name as displayed at the top of the statistics. These values are now taken from <em>dspace.cfg</em> so you can remove <em>host.name</em> and <em>host.url</em> from <em>dstat.cfg</em> if you wish. The values now used are <em>dspace.hostname</em> and <em>dspace.name</em> from <em>dspace.cfg</em></p></li>
<li><b>Deploy web applications</b> Copy the web applications files from your [dspace]/webapps directory to the subdirectory of your servlet container (e.g. Tomcat): <li><b>Deploy web applications</b> Copy the web applications files from your [dspace]/webapps directory to the subdirectory of your servlet container (e.g. Tomcat):
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">cp [dspace]/webapps/* [tomcat]/webapps/ <pre class="code-java">
cp [dspace]/webapps/* [tomcat]/webapps/
</pre> </pre>
</div></div></li> </div></div></li>
<li><b>Restart Tomcat</b> Restart your servlet container, for Tomcat use the <em>bin/startup.sh</em> script.</li> <li><b>Restart Tomcat</b> Restart your servlet container, for Tomcat use the <em>bin/startup.sh</em> script.</li>
@@ -1669,13 +1714,14 @@ ant -Dconfig=[dspace]/config/dspace.cfg update
<p>The changes in 1.4.x releases are only code and configuration changes so the update is simply a matter of rebuilding the wars and slight changes to your config file.</p> <p>The changes in 1.4.x releases are only code and configuration changes so the update is simply a matter of rebuilding the wars and slight changes to your config file.</p>
<p>In the notes below <em>[dspace]</em> refers to the install directory for your existing DSpace installation, and <em>[dspace-1.4.x-source]</em> to the source directory for DSpace 1.4.x. Whenever you see these path references, be sure to replace them with the actual path names on your local system.</p> <p>In the notes below <tt>[dspace]</tt> refers to the install directory for your existing DSpace installation, and <em>[dspace-1.4.x-source]</em> to the source directory for DSpace 1.4.x. Whenever you see these path references, be sure to replace them with the actual path names on your local system.</p>
<ol> <ol>
<li>Get the new DSpace 1.4.x source code from <a href="http://sourceforge.net/projects/dspace/" title="the DSpace page on SourceForge">the DSpace page on SourceForge</a> and unpack it somewhere. Do not unpack it on top of your existing installation&#33;&#33;</li> <li>Get the new DSpace 1.4.x source code from <a href="http://sourceforge.net/projects/dspace/">the DSpace page on SourceForge</a> and unpack it somewhere. Do not unpack it on top of your existing installation&#33;&#33;</li>
<li>Copy the PostgreSQL driver JAR to the source tree. For example: <li>Copy the PostgreSQL driver JAR to the source tree. For example:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">cd [dspace]/lib <pre class="code-java">
cd [dspace]/lib
cp postgresql.jar [dspace-1.4.x-source]/lib cp postgresql.jar [dspace-1.4.x-source]/lib
</pre> </pre>
</div></div></li> </div></div></li>
@@ -1683,7 +1729,8 @@ cp postgresql.jar [dspace-1.4.x-source]/lib
<li>Take down Tomcat (or whichever servlet container you're using).</li> <li>Take down Tomcat (or whichever servlet container you're using).</li>
<li>A new configuration item <em>webui.html.max-depth-guess</em> has been added to avoid infinite URL spaces. Add the following to the dspace.cfg file: <li>A new configuration item <em>webui.html.max-depth-guess</em> has been added to avoid infinite URL spaces. Add the following to the dspace.cfg file:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">#### Multi-file HTML document/site settings ##### <pre class="code-java">
#### Multi-file HTML document/site settings #####
# #
# When serving up composite HTML items, how deep can the request be # When serving up composite HTML items, how deep can the request be
<span class="code-keyword">for</span> us to <span class="code-keyword">for</span> us to
@@ -1705,15 +1752,17 @@ webui.html.max-depth-guess = 3
</pre> </pre>
</div></div> </div></div>
<p>If <em>webui.html.max-depth-guess</em> is not present in <em>dspace.cfg</em> the default value is used. If archiving entire web sites or deeply nested HTML documents it is advisable to change the default to a higher value more suitable for these types of materials.</p></li> <p>If <em>webui.html.max-depth-guess</em> is not present in <em>dspace.cfg</em> the default value is used. If archiving entire web sites or deeply nested HTML documents it is advisable to change the default to a higher value more suitable for these types of materials.</p></li>
<li>Your 'localized' JSPs (those in jsp/local) now need to be maintained in the <em>source</em> directory. If you have locally modified JSPs in your <em>[dspace]/jsp/local</em> directory, you will need to merge the changes in the new 1.4.x versions into your locally modified ones. You can use the <em>diff</em> command to compare your JSPs against the 1.4.x versions to do this. You can also check against the <a href="http://dspace.cvs.sourceforge.net/dspace/" title="DSpace CVS">DSpace CVS</a>.</li> <li>Your 'localized' JSPs (those in jsp/local) now need to be maintained in the <em>source</em> directory. If you have locally modified JSPs in your <em>[dspace]/jsp/local</em> directory, you will need to merge the changes in the new 1.4.x versions into your locally modified ones. You can use the <em>diff</em> command to compare your JSPs against the 1.4.x versions to do this. You can also check against the <a href="http://dspace.cvs.sourceforge.net/dspace/">DSpace CVS</a>.</li>
<li>In <em>[dspace-1.4.x-source]</em> run: <li>In <em>[dspace-1.4.x-source]</em> run:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">ant -Dconfig= [dspace]/config/dspace.cfg update <pre class="code-java">
ant -Dconfig= [dspace]/config/dspace.cfg update
</pre> </pre>
</div></div></li> </div></div></li>
<li>Copy the <em>.war</em> Web application files in <em>[dspace-1.4.x-source]/build</em> to the <em>webapps</em> sub-directory of your servlet container (e.g. Tomcat). e.g.: <li>Copy the <em>.war</em> Web application files in <em>[dspace-1.4.x-source]/build</em> to the <em>webapps</em> sub-directory of your servlet container (e.g. Tomcat). e.g.:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">cp [dspace-1.4.x-source]/build/*.war <pre class="code-java">
cp [dspace-1.4.x-source]/build/*.war
[tomcat]/webapps [tomcat]/webapps
</pre> </pre>
</div></div> </div></div>
@@ -1732,10 +1781,11 @@ webui.html.max-depth-guess = 3
<li>Your configuration files and localized JSPs</li> <li>Your configuration files and localized JSPs</li>
</ul> </ul>
</li> </li>
<li>Download the <a href="http://sourceforge.net/projects/dspace/" title="latest DSpace 1.4.x source bundle">latest DSpace 1.4.x source bundle</a> and unpack it in a suitable location (<em>not</em> over your existing DSpace installation or source tree&#33;)</li> <li>Download the <a href="http://sourceforge.net/projects/dspace/">latest DSpace 1.4.x source bundle</a> and unpack it in a suitable location (<em>not</em> over your existing DSpace installation or source tree&#33;)</li>
<li>Copy the PostgreSQL driver JAR to the source tree. For example: <li>Copy the PostgreSQL driver JAR to the source tree. For example:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">cd [dspace]/lib <pre class="code-java">
cd [dspace]/lib
cp postgresql.jar [dspace-1.4.x-source]/lib cp postgresql.jar [dspace-1.4.x-source]/lib
</pre> </pre>
</div></div></li> </div></div></li>
@@ -1745,7 +1795,8 @@ cp postgresql.jar [dspace-1.4.x-source]/lib
<ul> <ul>
<li>In <em>dspace.cfg</em>, paste in the following lines for the new stackable authentication feature, the new method for managing Media Filters, and the Checksum Checker. <li>In <em>dspace.cfg</em>, paste in the following lines for the new stackable authentication feature, the new method for managing Media Filters, and the Checksum Checker.
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">#### Stackable Authentication Methods ##### <pre class="code-java">
#### Stackable Authentication Methods #####
# Stack of authentication methods # Stack of authentication methods
# (See org.dspace.eperson.AuthenticationManager) # (See org.dspace.eperson.AuthenticationManager)
plugin.sequence.org.dspace.eperson.AuthenticationMethod = \ plugin.sequence.org.dspace.eperson.AuthenticationMethod = \
@@ -1823,12 +1874,14 @@ checker.retention.CHECKSUM_MATCH=8w
</div></div></li> </div></div></li>
<li>If you have customized advanced search fields (<em>search.index.n</em> fields, note that you now need to include the schema in the values. Dublin Core is specified as <em>dc</em>. So for example, if in 1.3.2 you had: <li>If you have customized advanced search fields (<em>search.index.n</em> fields, note that you now need to include the schema in the values. Dublin Core is specified as <em>dc</em>. So for example, if in 1.3.2 you had:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">search.index.1 = title:title.alternative <pre class="code-java">
search.index.1 = title:title.alternative
</pre> </pre>
</div></div> </div></div>
<p>That needs to be changed to: </p> <p>That needs to be changed to: </p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">search.index.1 = title:dc.title.alternative <pre class="code-java">
search.index.1 = title:dc.title.alternative
</pre> </pre>
</div></div></li> </div></div></li>
<li>If you use LDAP or X509 authentication, you'll need to add <em>org.dspace.eperson.LDAPAuthentication</em> or <em>org.dspace.eperson.X509Authentication</em> respectively. See also configuring custom authentication code.</li> <li>If you use LDAP or X509 authentication, you'll need to add <em>org.dspace.eperson.LDAPAuthentication</em> or <em>org.dspace.eperson.X509Authentication</em> respectively. See also configuring custom authentication code.</li>
@@ -1839,7 +1892,8 @@ checker.retention.CHECKSUM_MATCH=8w
<li>Your 'localized' JSPs (those in jsp/local) now need to be maintained in the <em>source</em> directory. If you have locally modified JSPs in your <em>[dspace]/jsp/local</em> directory, you will need to merge the changes in the new 1.4.x versions into your locally modified ones. You can use the <em>diff</em> command to compare your JSPs against the 1.4.x versions to do this. You can also check against the <a href="http://dspace.cvs.sourceforge.net/dspace/" title="DSpace CVS">DSpace CVS</a>.</li> <li>Your 'localized' JSPs (those in jsp/local) now need to be maintained in the <em>source</em> directory. If you have locally modified JSPs in your <em>[dspace]/jsp/local</em> directory, you will need to merge the changes in the new 1.4.x versions into your locally modified ones. You can use the <em>diff</em> command to compare your JSPs against the 1.4.x versions to do this. You can also check against the <a href="http://dspace.cvs.sourceforge.net/dspace/" title="DSpace CVS">DSpace CVS</a>.</li>
<li>In <em>[dspace-1.4.x-source]</em> run: <li>In <em>[dspace-1.4.x-source]</em> run:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">ant -Dconfig= [dspace]/config/dspace.cfg update <pre class="code-java">
ant -Dconfig= [dspace]/config/dspace.cfg update
</pre> </pre>
</div></div></li> </div></div></li>
<li>The database schema needs updating. SQL files containing the relevant file are provided. If you've modified the schema locally, you may need to check over this and make alterations. <li>The database schema needs updating. SQL files containing the relevant file are provided. If you've modified the schema locally, you may need to check over this and make alterations.
@@ -1851,7 +1905,8 @@ checker.retention.CHECKSUM_MATCH=8w
<li>Rebuild the search indexes: <em>[dspace]/bin/index-all</em></li> <li>Rebuild the search indexes: <em>[dspace]/bin/index-all</em></li>
<li>Copy the <em>.war</em> Web application files in <em>[dspace-1.4-source]/build</em> to the <em>webapps</em> sub-directory of your servlet container (e.g. Tomcat). e.g.: <li>Copy the <em>.war</em> Web application files in <em>[dspace-1.4-source]/build</em> to the <em>webapps</em> sub-directory of your servlet container (e.g. Tomcat). e.g.:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">cp [dspace-1.4-source]/build/*.war <pre class="code-java">
cp [dspace-1.4-source]/build/*.war
[tomcat]/webapps [tomcat]/webapps
</pre> </pre>
</div></div> </div></div>
@@ -1864,13 +1919,14 @@ checker.retention.CHECKSUM_MATCH=8w
<p>The changes in 1.3.2 are only code changes so the update is simply a matter of rebuilding the wars.</p> <p>The changes in 1.3.2 are only code changes so the update is simply a matter of rebuilding the wars.</p>
<p>In the notes below <em>[dspace]</em> refers to the install directory for your existing DSpace installation, and <em>[dspace-1.3.2-source]</em> to the source directory for DSpace 1.3.2. Whenever you see these path references, be sure to replace them with the actual path names on your local system.</p> <p>In the notes below <tt>[dspace]</tt> refers to the install directory for your existing DSpace installation, and <em>[dspace-1.3.2-source]</em> to the source directory for DSpace 1.3.2. Whenever you see these path references, be sure to replace them with the actual path names on your local system.</p>
<ol> <ol>
<li>Get the new DSpace 1.3.2 source code from <a href="http://sourceforge.net/projects/dspace/" title="the DSpace page on SourceForge">the DSpace page on SourceForge</a> and unpack it somewhere. Do not unpack it on top of your existing installation&#33;&#33;</li> <li>Get the new DSpace 1.3.2 source code from <a href="http://sourceforge.net/projects/dspace/" title="the DSpace page on SourceForge">the DSpace page on SourceForge</a> and unpack it somewhere. Do not unpack it on top of your existing installation&#33;&#33;</li>
<li>Copy the PostgreSQL driver JAR to the source tree. For example: <li>Copy the PostgreSQL driver JAR to the source tree. For example:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">cd [dspace]/lib <pre class="code-java">
cd [dspace]/lib
cp postgresql.jar [dspace-1.3.2-source]/lib cp postgresql.jar [dspace-1.3.2-source]/lib
</pre> </pre>
</div></div></li> </div></div></li>
@@ -1878,12 +1934,14 @@ cp postgresql.jar [dspace-1.3.2-source]/lib
<li>Your 'localized' JSPs (those in jsp/local) now need to be maintained in the <em>source</em> directory. If you have locally modified JSPs in your <em>[dspace]/jsp/local</em> directory, you will need to merge the changes in the new 1.3.2 versions into your locally modified ones. You can use the <em>diff</em> command to compare the 1.3.1 and 1.3.2 versions to do this.</li> <li>Your 'localized' JSPs (those in jsp/local) now need to be maintained in the <em>source</em> directory. If you have locally modified JSPs in your <em>[dspace]/jsp/local</em> directory, you will need to merge the changes in the new 1.3.2 versions into your locally modified ones. You can use the <em>diff</em> command to compare the 1.3.1 and 1.3.2 versions to do this.</li>
<li>In <em>[dspace-1.3.2-source]</em> run: <li>In <em>[dspace-1.3.2-source]</em> run:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">ant -Dconfig= [dspace]/config/dspace.cfg update <pre class="code-java">
ant -Dconfig= [dspace]/config/dspace.cfg update
</pre> </pre>
</div></div></li> </div></div></li>
<li>Copy the <em>.war</em> Web application files in <em>[dspace-1.3.2-source]/build</em> to the <em>webapps</em> sub-directory of your servlet container (e.g. Tomcat). e.g.: <li>Copy the <em>.war</em> Web application files in <em>[dspace-1.3.2-source]/build</em> to the <em>webapps</em> sub-directory of your servlet container (e.g. Tomcat). e.g.:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">cp [dspace-1.3.2-source]/build/*.war <pre class="code-java">
cp [dspace-1.3.2-source]/build/*.war
[tomcat]/webapps [tomcat]/webapps
</pre> </pre>
</div></div> </div></div>
@@ -1894,10 +1952,10 @@ cp postgresql.jar [dspace-1.3.2-source]/lib
<h2><a name="UpgradingaDSpaceInstallation-UpgradingFrom1.2.xto1.3.x"></a>Upgrading From 1.2.x to 1.3.x</h2> <h2><a name="UpgradingaDSpaceInstallation-UpgradingFrom1.2.xto1.3.x"></a>Upgrading From 1.2.x to 1.3.x</h2>
<p>In the notes below <em>[dspace]</em> refers to the install directory for your existing DSpace installation, and <em>[dspace-1.3.x-source]</em> to the source directory for DSpace 1.3.x. Whenever you see these path references, be sure to replace them with the actual path names on your local system.</p> <p>In the notes below <tt>[dspace]</tt> refers to the install directory for your existing DSpace installation, and <em>[dspace-1.3.x-source]</em> to the source directory for DSpace 1.3.x. Whenever you see these path references, be sure to replace them with the actual path names on your local system.</p>
<ol> <ol>
<li>Step one is, of course, to <b>back up all your data</b> before proceeding&#33;&#33; Include all of the contents of <em>[dspace]</em> and the PostgreSQL database in your backup.</li> <li>Step one is, of course, to <b>back up all your data</b> before proceeding&#33;&#33; Include all of the contents of <tt>[dspace]</tt> and the PostgreSQL database in your backup.</li>
<li>Get the new DSpace 1.3.x source code from <a href="http://sourceforge.net/projects/dspace/" title="the DSpace page on SourceForge">the DSpace page on SourceForge</a> and unpack it somewhere. Do not unpack it on top of your existing installation&#33;&#33;</li> <li>Get the new DSpace 1.3.x source code from <a href="http://sourceforge.net/projects/dspace/" title="the DSpace page on SourceForge">the DSpace page on SourceForge</a> and unpack it somewhere. Do not unpack it on top of your existing installation&#33;&#33;</li>
<li>Copy the PostgreSQL driver JAR to the source tree. For example: <em>cd [dspace]/lib</em><em>cp postgresql.jar [dspace-1.2.2-source]/lib</em></li> <li>Copy the PostgreSQL driver JAR to the source tree. For example: <em>cd [dspace]/lib</em><em>cp postgresql.jar [dspace-1.2.2-source]/lib</em></li>
<li>Take down Tomcat (or whichever servlet container you're using).</li> <li>Take down Tomcat (or whichever servlet container you're using).</li>
@@ -1905,7 +1963,8 @@ cp postgresql.jar [dspace-1.3.2-source]/lib
<li>Install the new config files by moving <em>dstat.cfg</em> and <em>dstat.map</em> from <em>[dspace-1.3.x-source]/config/</em> to <em>[dspace]/config</em></li> <li>Install the new config files by moving <em>dstat.cfg</em> and <em>dstat.map</em> from <em>[dspace-1.3.x-source]/config/</em> to <em>[dspace]/config</em></li>
<li>You need to add new parameters to your <em>[dspace]/dspace.cfg</em>: <li>You need to add new parameters to your <em>[dspace]/dspace.cfg</em>:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">###### Statistical Report Configuration Settings ###### <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> # should the stats be publicly available? should be set to <span class="code-keyword">false</span> <span class="code-keyword">if</span>
you only you only
@@ -1933,13 +1992,14 @@ report.dir = /dspace/reports/
<p>The changes in 1.2.2 are only code and config changes so the update should be fairly simple.</p> <p>The changes in 1.2.2 are only code and config changes so the update should be fairly simple.</p>
<p>In the notes below <em>[dspace]</em> refers to the install directory for your existing DSpace installation, and <em>[dspace-1.2.2-source]</em> to the source directory for DSpace 1.2.2. Whenever you see these path references, be sure to replace them with the actual path names on your local system.</p> <p>In the notes below <tt>[dspace]</tt> refers to the install directory for your existing DSpace installation, and <em>[dspace-1.2.2-source]</em> to the source directory for DSpace 1.2.2. Whenever you see these path references, be sure to replace them with the actual path names on your local system.</p>
<ol> <ol>
<li>Get the new DSpace 1.2.2 source code from <a href="http://sourceforge.net/projects/dspace/" title="the DSpace page on SourceForge">the DSpace page on SourceForge</a> and unpack it somewhere. Do not unpack it on top of your existing installation&#33;&#33;</li> <li>Get the new DSpace 1.2.2 source code from <a href="http://sourceforge.net/projects/dspace/" title="the DSpace page on SourceForge">the DSpace page on SourceForge</a> and unpack it somewhere. Do not unpack it on top of your existing installation&#33;&#33;</li>
<li>Copy the PostgreSQL driver JAR to the source tree. For example: <li>Copy the PostgreSQL driver JAR to the source tree. For example:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">cd [dspace]/lib <pre class="code-java">
cd [dspace]/lib
cp postgresql.jar [dspace-1.2.2-source]/lib cp postgresql.jar [dspace-1.2.2-source]/lib
</pre> </pre>
</div></div></li> </div></div></li>
@@ -1947,7 +2007,8 @@ cp postgresql.jar [dspace-1.2.2-source]/lib
<li>Your 'localized' JSPs (those in jsp/local) now need to be maintained in the <em>source</em> directory. If you have locally modified JSPs in your <em>[dspace]/jsp/local</em> directory, you might like to merge the changes in the new 1.2.2 versions into your locally modified ones. You can use the <em>diff</em> command to compare the 1.2.1 and 1.2.2 versions to do this. Also see the version history for a list of modified JSPs.</li> <li>Your 'localized' JSPs (those in jsp/local) now need to be maintained in the <em>source</em> directory. If you have locally modified JSPs in your <em>[dspace]/jsp/local</em> directory, you might like to merge the changes in the new 1.2.2 versions into your locally modified ones. You can use the <em>diff</em> command to compare the 1.2.1 and 1.2.2 versions to do this. Also see the version history for a list of modified JSPs.</li>
<li>You need to add a new parameter to your <em>[dspace]/dspace.cfg</em> for configurable fulltext indexing <li>You need to add a new parameter to your <em>[dspace]/dspace.cfg</em> for configurable fulltext indexing
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">##### Fulltext Indexing settings ##### <pre class="code-java">
##### Fulltext Indexing settings #####
# Maximum number of terms indexed <span class="code-keyword">for</span> a single field in Lucene. # Maximum number of terms indexed <span class="code-keyword">for</span> a single field in Lucene.
# Default is 10,000 words - often not enough <span class="code-keyword">for</span> full-text indexing. # Default is 10,000 words - often not enough <span class="code-keyword">for</span> full-text indexing.
# If you change <span class="code-keyword">this</span>, you'll need to re-index <span class="code-keyword">for</span> the change # If you change <span class="code-keyword">this</span>, you'll need to re-index <span class="code-keyword">for</span> the change
@@ -1958,12 +2019,14 @@ search.maxfieldlength = 10000
</div></div></li> </div></div></li>
<li>In <em>[dspace-1.2.2-source]</em> run: <li>In <em>[dspace-1.2.2-source]</em> run:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">ant -Dconfig= [dspace]/config/dspace.cfg update <pre class="code-java">
ant -Dconfig= [dspace]/config/dspace.cfg update
</pre> </pre>
</div></div></li> </div></div></li>
<li>Copy the <em>.war</em> Web application files in <em>[dspace-1.2.2-source]/build</em> to the <em>webapps</em> sub-directory of your servlet container (e.g. Tomcat). e.g.: <li>Copy the <em>.war</em> Web application files in <em>[dspace-1.2.2-source]/build</em> to the <em>webapps</em> sub-directory of your servlet container (e.g. Tomcat). e.g.:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">cp [dspace-1.2.2-source]/build/*.war <pre class="code-java">
cp [dspace-1.2.2-source]/build/*.war
[tomcat]/webapps [tomcat]/webapps
</pre> </pre>
</div></div> </div></div>
@@ -1977,13 +2040,14 @@ search.maxfieldlength = 10000
<p>The changes in 1.2.1 are only code changes so the update should be fairly simple.</p> <p>The changes in 1.2.1 are only code changes so the update should be fairly simple.</p>
<p>In the notes below <em>[dspace]</em> refers to the install directory for your existing DSpace installation, and <em>[dspace-1.2.1-source]</em> to the source directory for DSpace 1.2.1. Whenever you see these path references, be sure to replace them with the actual path names on your local system.</p> <p>In the notes below <tt>[dspace]</tt> refers to the install directory for your existing DSpace installation, and <em>[dspace-1.2.1-source]</em> to the source directory for DSpace 1.2.1. Whenever you see these path references, be sure to replace them with the actual path names on your local system.</p>
<ol> <ol>
<li>Get the new DSpace 1.2.1 source code from <a href="http://sourceforge.net/projects/dspace/" title="the DSpace page on SourceForge">the DSpace page on SourceForge</a> and unpack it somewhere. Do not unpack it on top of your existing installation&#33;&#33;</li> <li>Get the new DSpace 1.2.1 source code from <a href="http://sourceforge.net/projects/dspace/" title="the DSpace page on SourceForge">the DSpace page on SourceForge</a> and unpack it somewhere. Do not unpack it on top of your existing installation&#33;&#33;</li>
<li>Copy the PostgreSQL driver JAR to the source tree. For example: <li>Copy the PostgreSQL driver JAR to the source tree. For example:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">cd [dspace]/lib <pre class="code-java">
cd [dspace]/lib
cp postgresql.jar [dspace-1.2.1-source]/lib cp postgresql.jar [dspace-1.2.1-source]/lib
</pre> </pre>
</div></div></li> </div></div></li>
@@ -1991,7 +2055,8 @@ cp postgresql.jar [dspace-1.2.1-source]/lib
<li>Your 'localized' JSPs (those in jsp/local) now need to be maintained in the <em>source</em> directory. If you have locally modified JSPs in your <em>[dspace]/jsp/local</em> directory, you might like to merge the changes in the new 1.2.1 versions into your locally modified ones. You can use the <em>diff</em> command to compare the 1.2 and 1.2.1 versions to do this. Also see the version history for a list of modified JSPs.</li> <li>Your 'localized' JSPs (those in jsp/local) now need to be maintained in the <em>source</em> directory. If you have locally modified JSPs in your <em>[dspace]/jsp/local</em> directory, you might like to merge the changes in the new 1.2.1 versions into your locally modified ones. You can use the <em>diff</em> command to compare the 1.2 and 1.2.1 versions to do this. Also see the version history for a list of modified JSPs.</li>
<li>You need to add a few new parameters to your <em>[dspace]/dspace.cfg</em> for browse/search and item thumbnails display, and for configurable DC metadata fields to be indexed. <li>You need to add a few new parameters to your <em>[dspace]/dspace.cfg</em> for browse/search and item thumbnails display, and for configurable DC metadata fields to be indexed.
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"># whether to display thumbnails on browse and search results pages <pre class="code-java">
# whether to display thumbnails on browse and search results pages
(1.2+) (1.2+)
webui.browse.thumbnail.show = <span class="code-keyword">false</span> webui.browse.thumbnail.show = <span class="code-keyword">false</span>
@@ -2037,12 +2102,14 @@ search.index.11 = id:identifier.*
</div></div></li> </div></div></li>
<li>In <em>[dspace-1.2.1-source]</em> run: <li>In <em>[dspace-1.2.1-source]</em> run:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">ant -Dconfig= [dspace]/config/dspace.cfg update <pre class="code-java">
ant -Dconfig= [dspace]/config/dspace.cfg update
</pre> </pre>
</div></div></li> </div></div></li>
<li>Copy the <em>.war</em> Web application files in <em>[dspace-1.2.1-source]/build</em> to the <em>webapps</em> sub-directory of your servlet container (e.g. Tomcat). e.g.: <li>Copy the <em>.war</em> Web application files in <em>[dspace-1.2.1-source]/build</em> to the <em>webapps</em> sub-directory of your servlet container (e.g. Tomcat). e.g.:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">cp [dspace-1.2.1-source]/build/*.war <pre class="code-java">
cp [dspace-1.2.1-source]/build/*.war
[tomcat]/webapps [tomcat]/webapps
</pre> </pre>
</div></div> </div></div>
@@ -2057,14 +2124,15 @@ search.index.11 = id:identifier.*
<p>Note also that if you've substantially modified DSpace, these instructions apply to an unmodified 1.1.1 DSpace instance, and you'll need to adapt the process to any modifications you've made.</p> <p>Note also that if you've substantially modified DSpace, these instructions apply to an unmodified 1.1.1 DSpace instance, and you'll need to adapt the process to any modifications you've made.</p>
<p>This document refers to the install directory for your existing DSpace installation as <em>[dspace]</em>, and to the source directory for DSpace 1.2 as <em>[dspace-1.2-source]</em>. Whenever you see these path references below, be sure to replace them with the actual path names on your local system.</p> <p>This document refers to the install directory for your existing DSpace installation as <tt>[dspace]</tt>, and to the source directory for DSpace 1.2 as <em>[dspace-1.2-source]</em>. Whenever you see these path references below, be sure to replace them with the actual path names on your local system.</p>
<ol> <ol>
<li>Step one is, of course, to <b>back up all your data</b> before proceeding&#33;&#33; Include all of the contents of <em>[dspace]</em> and the PostgreSQL database in your backup.</li> <li>Step one is, of course, to <b>back up all your data</b> before proceeding&#33;&#33; Include all of the contents of <tt>[dspace]</tt> and the PostgreSQL database in your backup.</li>
<li>Get the new DSpace 1.2 source code from <a href="http://sourceforge.net/projects/dspace/" title="the DSpace page on SourceForge">the DSpace page on SourceForge</a> and unpack it somewhere. Do not unpack it on top of your existing installation&#33;&#33;</li> <li>Get the new DSpace 1.2 source code from <a href="http://sourceforge.net/projects/dspace/" title="the DSpace page on SourceForge">the DSpace page on SourceForge</a> and unpack it somewhere. Do not unpack it on top of your existing installation&#33;&#33;</li>
<li>Copy the required Java libraries that we couldn't include in the bundle to the source tree. For example: <li>Copy the required Java libraries that we couldn't include in the bundle to the source tree. For example:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">cd [dspace]/lib <pre class="code-java">
cd [dspace]/lib
cp activation.jar servlet.jar mail.jar cp activation.jar servlet.jar mail.jar
[dspace-1.2-source]/lib [dspace-1.2-source]/lib
</pre> </pre>
@@ -2080,7 +2148,8 @@ cp activation.jar servlet.jar mail.jar
</li> </li>
<li>You need to add the following new parameters to your <em>[dspace]/dspace.cfg</em>: <li>You need to add the following new parameters to your <em>[dspace]/dspace.cfg</em>:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">##### Media Filter settings ##### <pre class="code-java">
##### Media Filter settings #####
# maximum width and height of generated thumbnails # maximum width and height of generated thumbnails
thumbnail.maxwidth = 80 thumbnail.maxwidth = 80
thumbnail.maxheight = 80 thumbnail.maxheight = 80
@@ -2088,13 +2157,15 @@ thumbnail.maxheight = 80
</div></div> </div></div>
<p>There are one or two other, optional extra parameters (for controlling the pool of database connections). See the version history for details. If you leave them out, defaults will be used.Also, to avoid future confusion, you might like to <b>remove</b> the following property, which is no longer required:</p> <p>There are one or two other, optional extra parameters (for controlling the pool of database connections). See the version history for details. If you leave them out, defaults will be used.Also, to avoid future confusion, you might like to <b>remove</b> the following property, which is no longer required:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">config.template.oai-web.xml = <pre class="code-java">
config.template.oai-web.xml =
[dspace]/oai/WEB-INF/web.xml [dspace]/oai/WEB-INF/web.xml
</pre> </pre>
</div></div></li> </div></div></li>
<li>The layout of the installation directory (i.e. the structure of the contents of <em>[dspace]</em>) has changed somewhat since 1.1.1. First up, your 'localized' JSPs (those in jsp/local) now need to be maintained in the <em>source</em> directory. So make a copy of them now&#33;Once you've done that, you can remove <em>[dspace]/jsp</em> and <em>[dspace]/oai</em>, these are no longer used. (.war Web application archive files are used instead).Also, if you're using the same version of Tomcat as before, you need to <b>remove the lines from Tomcat's conf/server.xml file that enable symbolic links for DSpace.</b> These are the <em>&lt;Context&gt;</em> elements you added to get DSpace 1.1.1 working, looking something like this: <li>The layout of the installation directory (i.e. the structure of the contents of <tt>[dspace]</tt>) has changed somewhat since 1.1.1. First up, your 'localized' JSPs (those in jsp/local) now need to be maintained in the <em>source</em> directory. So make a copy of them now&#33;Once you've done that, you can remove <em>[dspace]/jsp</em> and <em>[dspace]/oai</em>, these are no longer used. (.war Web application archive files are used instead).Also, if you're using the same version of Tomcat as before, you need to <b>remove the lines from Tomcat's conf/server.xml file that enable symbolic links for DSpace.</b> These are the <em>&lt;Context&gt;</em> elements you added to get DSpace 1.1.1 working, looking something like this:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">&lt;Context path=<span class="code-quote">"/dspace"</span> docBase=<span class="code-quote">"dspace"</span> debug=<span class="code-quote">"0"</span> reloadable=<span class="code-quote">"<span class="code-keyword">true</span>"</span> <pre class="code-java">
&lt;Context path=<span class="code-quote">"/dspace"</span> docBase=<span class="code-quote">"dspace"</span> debug=<span class="code-quote">"0"</span> reloadable=<span class="code-quote">"<span class="code-keyword">true</span>"</span>
crossContext=<span class="code-quote">"<span class="code-keyword">true</span>"</span>&gt; crossContext=<span class="code-quote">"<span class="code-keyword">true</span>"</span>&gt;
&lt;Resources className=<span class="code-quote">"org.apache.naming.resources.FileDirContext"</span> &lt;Resources className=<span class="code-quote">"org.apache.naming.resources.FileDirContext"</span>
allowLinking=<span class="code-quote">"<span class="code-keyword">true</span>"</span> /&gt; allowLinking=<span class="code-quote">"<span class="code-keyword">true</span>"</span> /&gt;
@@ -2104,12 +2175,14 @@ thumbnail.maxheight = 80
<p>Be sure to remove the &lt;Context&gt; elements for both the Web UI and the OAI Web applications.</p></li> <p>Be sure to remove the &lt;Context&gt; elements for both the Web UI and the OAI Web applications.</p></li>
<li>Build and install the updated DSpace 1.2 code. Go to the DSpace 1.2 source directory, and run: <li>Build and install the updated DSpace 1.2 code. Go to the DSpace 1.2 source directory, and run:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">ant -Dconfig= [dspace]/config/dspace.cfg update <pre class="code-java">
ant -Dconfig= [dspace]/config/dspace.cfg update
</pre> </pre>
</div></div></li> </div></div></li>
<li>Copy the new config files in <em>config</em> to your installation, e.g.: <li>Copy the new config files in <em>config</em> to your installation, e.g.:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">cp [dspace-1.2-source]/config/news-* <pre class="code-java">
cp [dspace-1.2-source]/config/news-*
[dspace-1.2-source]/config/mediafilter.cfg [dspace-1.2-source]/config/mediafilter.cfg
[dspace-1.2-source]/config/dc2mods.cfg [dspace-1.2-source]/config/dc2mods.cfg
[dspace]/config [dspace]/config
@@ -2117,7 +2190,8 @@ thumbnail.maxheight = 80
</div></div></li> </div></div></li>
<li>You'll need to make some changes to the database schema in your PostgreSQL database. <em>[dspace-1.2-source]/etc/database_schema_11-12.sql</em> contains the SQL commands to achieve this. If you've modified the schema locally, you may need to check over this and make alterations.To apply the changes, go to the source directory, and run: <li>You'll need to make some changes to the database schema in your PostgreSQL database. <em>[dspace-1.2-source]/etc/database_schema_11-12.sql</em> contains the SQL commands to achieve this. If you've modified the schema locally, you may need to check over this and make alterations.To apply the changes, go to the source directory, and run:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">psql -f etc/database_schema_11-12.sql [DSpace database name] -h <pre class="code-java">
psql -f etc/database_schema_11-12.sql [DSpace database name] -h
localhost localhost
</pre> </pre>
</div></div></li> </div></div></li>
@@ -2134,14 +2208,16 @@ thumbnail.maxheight = 80
</div></div></li> </div></div></li>
<li>Delete the existing symlinks from your servlet container's (e.g. Tomcat's) <em>webapp</em> sub-directory.Copy the <em>.war</em> Web application files in <em>[dspace-1.2-source]/build</em> to the <em>webapps</em> sub-directory of your servlet container (e.g. Tomcat). e.g.: <li>Delete the existing symlinks from your servlet container's (e.g. Tomcat's) <em>webapp</em> sub-directory.Copy the <em>.war</em> Web application files in <em>[dspace-1.2-source]/build</em> to the <em>webapps</em> sub-directory of your servlet container (e.g. Tomcat). e.g.:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">cp [dspace-1.2-source]/build/*.war <pre class="code-java">
cp [dspace-1.2-source]/build/*.war
[tomcat]/webapps [tomcat]/webapps
</pre> </pre>
</div></div></li> </div></div></li>
<li>Restart Tomcat.</li> <li>Restart Tomcat.</li>
<li>To get image thumbnails generated and full-text extracted for indexing automatically, you need to set up a 'cron' job, for example one like this: <li>To get image thumbnails generated and full-text extracted for indexing automatically, you need to set up a 'cron' job, for example one like this:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"># Run the media filter at 02:00 every day <pre class="code-java">
# Run the media filter at 02:00 every day
0 2 * * * [dspace]/bin/filter-media 0 2 * * * [dspace]/bin/filter-media
</pre> </pre>
</div></div> </div></div>
@@ -2167,19 +2243,21 @@ Now, you should be finished&#33;</li>
<p>Fortunately the changes in 1.1.1 are only code changes so the update is fairly simple.</p> <p>Fortunately the changes in 1.1.1 are only code changes so the update is fairly simple.</p>
<p>In the notes below <em>[dspace]</em> refers to the install directory for your existing DSpace installation, and <em>[dspace-1.1.1-source]</em> to the source directory for DSpace 1.1.1. Whenever you see these path references, be sure to replace them with the actual path names on your local system.</p> <p>In the notes below <tt>[dspace]</tt> refers to the install directory for your existing DSpace installation, and <em>[dspace-1.1.1-source]</em> to the source directory for DSpace 1.1.1. Whenever you see these path references, be sure to replace them with the actual path names on your local system.</p>
<ol> <ol>
<li>Take down Tomcat.</li> <li>Take down Tomcat.</li>
<li>It would be a good idea to update any of the third-party tools used by DSpace at this point (e.g. PostgreSQL), following the instructions provided with the relevant tools.</li> <li>It would be a good idea to update any of the third-party tools used by DSpace at this point (e.g. PostgreSQL), following the instructions provided with the relevant tools.</li>
<li>In <em>[dspace-1.1.1-source]</em> run: <li>In <em>[dspace-1.1.1-source]</em> run:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">ant -Dconfig= [dspace]/config/dspace.cfg update <pre class="code-java">
ant -Dconfig= [dspace]/config/dspace.cfg update
</pre> </pre>
</div></div></li> </div></div></li>
<li>If you have locally modified JSPs of the following JSPs in your <em>[dspace]/jsp/local</em> directory, you might like to merge the changes in the new 1.1.1 versions into your locally modified ones. You can use the <em>diff</em> command to compare the 1.1 and 1.1.1 versions to do this. The changes are quite minor. <li>If you have locally modified JSPs of the following JSPs in your <em>[dspace]/jsp/local</em> directory, you might like to merge the changes in the new 1.1.1 versions into your locally modified ones. You can use the <em>diff</em> command to compare the 1.1 and 1.1.1 versions to do this. The changes are quite minor.
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">collection-home.jsp <pre class="code-java">
collection-home.jsp
admin/authorize-collection-edit.jsp admin/authorize-collection-edit.jsp
admin/authorize-community-edit.jsp admin/authorize-community-edit.jsp
admin/authorize-item-edit.jsp admin/authorize-item-edit.jsp
@@ -2192,14 +2270,15 @@ admin/eperson-edit.jsp
<h2><a name="UpgradingaDSpaceInstallation-UpgradingFrom1.0.1to1.1"></a>Upgrading From 1.0.1 to 1.1</h2> <h2><a name="UpgradingaDSpaceInstallation-UpgradingFrom1.0.1to1.1"></a>Upgrading From 1.0.1 to 1.1</h2>
<p>To upgrade from DSpace 1.0.1 to 1.1, follow the steps below. Your <em>dspace.cfg</em> does not need to be changed. In the notes below <em>[dspace]</em> refers to the install directory for your existing DSpace installation, and <em>[dspace-1.1-source]</em> to the source directory for DSpace 1.1. Whenever you see these path references, be sure to replace them with the actual path names on your local system.</p> <p>To upgrade from DSpace 1.0.1 to 1.1, follow the steps below. Your <em>dspace.cfg</em> does not need to be changed. In the notes below <tt>[dspace]</tt> refers to the install directory for your existing DSpace installation, and <em>[dspace-1.1-source]</em> to the source directory for DSpace 1.1. Whenever you see these path references, be sure to replace them with the actual path names on your local system.</p>
<ol> <ol>
<li>Take down Tomcat (or whichever servlet container you're using).</li> <li>Take down Tomcat (or whichever servlet container you're using).</li>
<li>We recommend that you upgrade to the latest version of PostgreSQL (7.3.2). Included are some notes to help you do this. Note you will also have to upgrade Ant to version 1.5 if you do this.</li> <li>We recommend that you upgrade to the latest version of PostgreSQL (7.3.2). Included are some notes to help you do this. Note you will also have to upgrade Ant to version 1.5 if you do this.</li>
<li>Make the necessary changes to the DSpace database. These include a couple of minor schema changes, and some new indexes which should improve performance. Also, the names of a couple of database views have been changed since the old names were so long they were causing problems. First run <em>psql</em> to access your database (e.g. <em>psql &#45;U dspace &#45;W</em> and then enter the password), and enter these SQL commands: <li>Make the necessary changes to the DSpace database. These include a couple of minor schema changes, and some new indexes which should improve performance. Also, the names of a couple of database views have been changed since the old names were so long they were causing problems. First run <em>psql</em> to access your database (e.g. <em>psql &#45;U dspace &#45;W</em> and then enter the password), and enter these SQL commands:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">ALTER TABLE bitstream ADD store_number INTEGER; <pre class="code-java">
ALTER TABLE bitstream ADD store_number INTEGER;
UPDATE bitstream SET store_number = 0; UPDATE bitstream SET store_number = 0;
ALTER TABLE item ADD last_modified TIMESTAMP; ALTER TABLE item ADD last_modified TIMESTAMP;
@@ -2239,26 +2318,30 @@ CREATE VIEW CollectionItemsByDateAccession AS SELECT
</div></div></li> </div></div></li>
<li>Fix your JSPs for Unicode. If you've modified the site 'skin' (<em>jsp/local/layout/header-default.jsp</em>) you'll need to add the Unicode header, i.e.: <li>Fix your JSPs for Unicode. If you've modified the site 'skin' (<em>jsp/local/layout/header-default.jsp</em>) you'll need to add the Unicode header, i.e.:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">&lt;meta http-equiv=<span class="code-quote">"Content-Type"</span> content="text/html; <pre class="code-java">
&lt;meta http-equiv=<span class="code-quote">"Content-Type"</span> content="text/html;
charset=UTF-8"&gt; charset=UTF-8"&gt;
</pre> </pre>
</div></div> </div></div>
<p>to the &lt;HEAD&gt; element. If you have any locally-edited JSPs, you need to add this page directive to the top of all of them: </p> <p>to the &lt;HEAD&gt; element. If you have any locally-edited JSPs, you need to add this page directive to the top of all of them: </p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">&lt;%@ page contentType=<span class="code-quote">"text/html;charset=UTF-8"</span> %&gt; <pre class="code-java">
&lt;%@ page contentType=<span class="code-quote">"text/html;charset=UTF-8"</span> %&gt;
</pre> </pre>
</div></div> </div></div>
<p>(If you haven't modified any JSPs, you don't have to do anything.)</p></li> <p>(If you haven't modified any JSPs, you don't have to do anything.)</p></li>
<li>Copy the required Java libraries that we couldn't include in the bundle to the source tree. For example: <li>Copy the required Java libraries that we couldn't include in the bundle to the source tree. For example:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">cd [dspace]/lib <pre class="code-java">
cd [dspace]/lib
cp *.policy activation.jar servlet.jar mail.jar cp *.policy activation.jar servlet.jar mail.jar
[dspace-1.1-source]/lib [dspace-1.1-source]/lib
</pre> </pre>
</div></div></li> </div></div></li>
<li>Compile up the new DSpace code, replacing <em>[dspace]/config/dspace.cfg</em> with the path to your current, LIVE configuration. (The second line, <em>touch `find .`</em>, is a precaution, which ensures that the new code has a current datestamp and will overwrite the old code. Note that those are back quotes.) <li>Compile up the new DSpace code, replacing <em>[dspace]/config/dspace.cfg</em> with the path to your current, LIVE configuration. (The second line, <em>touch `find .`</em>, is a precaution, which ensures that the new code has a current datestamp and will overwrite the old code. Note that those are back quotes.)
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">cd [dspace-1.1-source] <pre class="code-java">
cd [dspace-1.1-source]
touch `find .` touch `find .`
ant ant
ant -Dconfig= [dspace]/config/dspace.cfg update ant -Dconfig= [dspace]/config/dspace.cfg update
@@ -2266,7 +2349,8 @@ ant -Dconfig= [dspace]/config/dspace.cfg update
</div></div></li> </div></div></li>
<li>Update the database tables using the upgrader tool, which sets up the new &gt;<em>last_modified</em> date in the item table: <li>Update the database tables using the upgrader tool, which sets up the new &gt;<em>last_modified</em> date in the item table:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">Run [dspace]/bin/dsrun <pre class="code-java">
Run [dspace]/bin/dsrun
org.dspace.administer.Upgrade101To11 org.dspace.administer.Upgrade101To11
</pre> </pre>
</div></div></li> </div></div></li>
@@ -2278,12 +2362,14 @@ ant -Dconfig= [dspace]/config/dspace.cfg update
</div></div></li> </div></div></li>
<li>Fix the OAICat properties file. Edit <em>[dspace]/config/templates/oaicat.properties</em>. Change the line that says <li>Fix the OAICat properties file. Edit <em>[dspace]/config/templates/oaicat.properties</em>. Change the line that says
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">Identify.deletedRecord=yes <pre class="code-java">
Identify.deletedRecord=yes
</pre> </pre>
</div></div> </div></div>
<p>To: </p> <p>To: </p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">Identify.deletedRecord=persistent <pre class="code-java">
Identify.deletedRecord=persistent
</pre> </pre>
</div></div> </div></div>
<p>This is needed to fix the OAI-PMH 'Identity' verb response. Then run <em>[dspace]/bin/install-configs</em>.</p></li> <p>This is needed to fix the OAI-PMH 'Identity' verb response. Then run <em>[dspace]/bin/install-configs</em>.</p></li>
@@ -2294,7 +2380,8 @@ ant -Dconfig= [dspace]/config/dspace.cfg update
</div></div></li> </div></div></li>
<li>Restart Tomcat. Tomcat should be run with the following environment variable set, to ensure that Unicode is handled properly. Also, the default JVM memory heap sizes are rather small. Adjust <em>&#45;Xmx512M</em> (512Mb maximum heap size) and <em>&#45;Xms64M</em> (64Mb Java thread stack size) to suit your hardware. <li>Restart Tomcat. Tomcat should be run with the following environment variable set, to ensure that Unicode is handled properly. Also, the default JVM memory heap sizes are rather small. Adjust <em>&#45;Xmx512M</em> (512Mb maximum heap size) and <em>&#45;Xms64M</em> (64Mb Java thread stack size) to suit your hardware.
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">JAVA_OPTS=<span class="code-quote">"-Xmx512M -Xms64M -Dfile.encoding=UTF-8"</span> <pre class="code-java">
JAVA_OPTS=<span class="code-quote">"-Xmx512M -Xms64M -Dfile.encoding=UTF-8"</span>
</pre> </pre>
</div></div></li> </div></div></li>
</ol> </ol>
@@ -2309,7 +2396,7 @@ ant -Dconfig= [dspace]/config/dspace.cfg update
<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> <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>
<tr> <tr>
<td align="center"><font color="grey">Document generated by Confluence on Nov 06, 2010 19:27</font></td> <td align="center"><font color="grey">Document generated by Confluence on Dec 16, 2010 16:47</font></td>
</tr> </tr>
</table> </table>
</body> </body>

276
dspace/docs/html/XMLUI Configuration and Customization.html
View File

@@ -16,12 +16,36 @@
</span> </span>
</div> </div>
<div class="pagesubheading"> <div class="pagesubheading">
This page last changed on Apr 24, 2010 by <font color="#0050B2">mdiggory</font>. This page last changed on Dec 15, 2010 by <font color="#0050B2">bram</font>.
</div> </div>
<h1><a name="XMLUIConfigurationandCustomization-DSpaceSystemDocumentation%3AManakin%5CXMLUI%5CConfigurationandCustomization"></a>DSpace System Documentation: Manakin [XMLUI] Configuration and Customization</h1> <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> <p>The DSpace digital repository supports two user interfaces: one based on JavaServer Pages (JSP) technologies and one based upon the Apache Cocoon framework (XMLUI). This chapter describes those parameters which are specific to the Manakin (XMLUI) interface based upon the Cocoon framework.</p>
<style type='text/css'>/*<![CDATA[*/
div.rbtoc1292428718703 {margin-left: 0px;padding: 0px;}
div.rbtoc1292428718703 ul {list-style: none;margin-left: 0px;}
div.rbtoc1292428718703 li {margin-left: 0px;padding-left: 0px;}
/*]]>*/</style><div class='rbtoc1292428718703'>
<ul>
<li><span class='TOCOutline'>1</span> <a href='#XMLUIConfigurationandCustomization-ManakinConfigurationPropertyKeys'>Manakin Configuration Property Keys</a></li>
<li><span class='TOCOutline'>2</span> <a href='#XMLUIConfigurationandCustomization-ConfiguringThemesandAspects'>Configuring Themes and Aspects</a></li>
<ul>
<li><span class='TOCOutline'>2.1</span> <a href='#XMLUIConfigurationandCustomization-Aspects'>Aspects</a></li>
<li><span class='TOCOutline'>2.2</span> <a href='#XMLUIConfigurationandCustomization-Themes'>Themes</a></li>
</ul>
<li><span class='TOCOutline'>3</span> <a href='#XMLUIConfigurationandCustomization-MultilingualSupport'>Multilingual Support</a></li>
<li><span class='TOCOutline'>4</span> <a href='#XMLUIConfigurationandCustomization-CreatingaNewTheme'>Creating a New Theme</a></li>
<li><span class='TOCOutline'>5</span> <a href='#XMLUIConfigurationandCustomization-CustomizingtheNewsDocument'>Customizing the News Document</a></li>
<li><span class='TOCOutline'>6</span> <a href='#XMLUIConfigurationandCustomization-AddingStaticContent'>Adding Static Content</a></li>
<li><span class='TOCOutline'>7</span> <a href='#XMLUIConfigurationandCustomization-EnablingOAIOREHarvesterusingXMLUI'>Enabling OAI-ORE Harvester using XMLUI</a></li>
<ul>
<li><span class='TOCOutline'>7.1</span> <a href='#XMLUIConfigurationandCustomization-AutomaticHarvesting%28Scheduler%29'>Automatic Harvesting (Scheduler)</a></li>
</ul>
<li><span class='TOCOutline'>8</span> <a href='#XMLUIConfigurationandCustomization-AdditionalXMLUILearningResources'>Additional XMLUI Learning Resources</a></li>
</ul></div>
<h2><a name="XMLUIConfigurationandCustomization-ManakinConfigurationPropertyKeys"></a>Manakin Configuration Property Keys</h2> <h2><a name="XMLUIConfigurationandCustomization-ManakinConfigurationPropertyKeys"></a>Manakin Configuration Property Keys</h2>
@@ -29,212 +53,184 @@
<div class='table-wrap'> <div class='table-wrap'>
<table class='confluenceTable'><tbody> <table class='confluenceTable'><tbody>
<tr> <tr>
<td class='confluenceTd'>Property:</td> <td class='confluenceTd'> Property: </td>
<td class='confluenceTd'><em>xmlui.supportedLocales</em></td> <td class='confluenceTd'> <em>xmlui.supportedLocales</em> </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'>Example Value:</td> <td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'><em>xmlui.supportedLocales = en, de</em></td> <td class='confluenceTd'> <em>xmlui.supportedLocales = en, de</em> </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'>Informational Note:</td> <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> <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>
<tr> <tr>
<td class='confluenceTd'>Property:</td> <td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'><em>xmlui.force.ssl</em></td> <td class='confluenceTd'> <em>xmlui.force.ssl = true</em> </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'>Example Value:</td> <td class='confluenceTd'> Informational Note: </td>
<td class='confluenceTd'><em>xmlui.force.ssl = true</em></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'>Informational Note:</td> <td class='confluenceTd'> Property: </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> <td class='confluenceTd'> <em>xmlui.user.registration</em> </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'> <em>xmlui.user.registration = true</em> </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'>Property:</td> <td class='confluenceTd'> Informational Note: </td>
<td class='confluenceTd'><em>xmlui.user.registration</em></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'>Example Value:</td> <td class='confluenceTd'> Property: </td>
<td class='confluenceTd'><em>xmlui.user.registration = true</em></td> <td class='confluenceTd'> <em>xmlui.user.editmetadata</em> </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'>Informational Note:</td> <td class='confluenceTd'> Example Value: </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> <td class='confluenceTd'> <em>xmlui.user.editmetadata = true</em> </td>
</tr> </tr>
<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'> Property: </td>
<td class='confluenceTd'><em>xmlui.user.editmetadata</em></td> <td class='confluenceTd'> <em>xmlui.user.assumelogon</em> </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'>Example Value:</td> <td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'><em>xmlui.user.editmetadata = true</em></td> <td class='confluenceTd'> <em>xmlui.user.assumelogon = true</em> </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'>Informational Note:</td> <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> <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>
<tr> <tr>
<td class='confluenceTd'>Property:</td> <td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'><em>xmlui.user.assumelogon</em></td> <td class='confluenceTd'> <em>xmlui.user.loginredirect = /profile</em> </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'>Example Value:</td> <td class='confluenceTd'> Informational Note: </td>
<td class='confluenceTd'><em>xmlui.user.assumelogon = true</em></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'>Informational Note:</td> <td class='confluenceTd'> Property: </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> <td class='confluenceTd'> <em>xmlui.theme.allowoverrides</em> </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'> <em>xmlui.theme.allowoverrides = false</em> </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'>Property:</td> <td class='confluenceTd'> Informational Note: </td>
<td class='confluenceTd'><em>xmlui.user.loginredirect</em></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'>Example Value:</td> <td class='confluenceTd'> Property: </td>
<td class='confluenceTd'><em>xmlui.user.loginredirect = /profile</em></td> <td class='confluenceTd'> <em>xmlui.bundle.upload</em> </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'>Informational Note:</td> <td class='confluenceTd'> Example Value: </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> <td class='confluenceTd'> <em>xmlui.bundle.upload = ORIGINAL, METADATA, THUMBNAIL, LICENSE, CC_LICENSE</em> </td>
</tr> </tr>
<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'> Property: </td>
<td class='confluenceTd'><em>xmlui.theme.allowoverrides</em></td> <td class='confluenceTd'> <em>xmlui.community-list.render.full</em> </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'>Example Value:</td> <td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'><em>xmlui.theme.allowoverrides = false</em></td> <td class='confluenceTd'> <em>xmlui.community-list.render.full = true</em> </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'>Informational Note:</td> <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> <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>
<tr> <tr>
<td class='confluenceTd'>Property:</td> <td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'><em>xmlui.bundle.upload</em></td> <td class='confluenceTd'> <em>xmlui.community-list.cache = 12 hours</em> </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'>Example Value:</td> <td class='confluenceTd'> Informational Note: </td>
<td class='confluenceTd'><em>xmlui.bundle.upload = ORIGINAL, METADATA, THUMBNAIL, LICENSE, CC_LICENSE</em></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'>Informational Note:</td> <td class='confluenceTd'> Property: </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> <td class='confluenceTd'> <em>xmlui.bistream.mods</em> </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'> <em>xmlui.bistream.mods = true</em> </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'>Property:</td> <td class='confluenceTd'> Informational Note: </td>
<td class='confluenceTd'><em>xmlui.community-list.render.full</em></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'>Example Value:</td> <td class='confluenceTd'> Property: </td>
<td class='confluenceTd'><em>xmlui.community-list.render.full = true</em></td> <td class='confluenceTd'> <em>xmlui.bitstream.mets</em> </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'>Informational Note:</td> <td class='confluenceTd'> Example Value: </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> <td class='confluenceTd'> <em>xmlui.bitstream.mets = true</em> </td>
</tr> </tr>
<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'> Property: </td>
<td class='confluenceTd'><em>xmlui.community-list.cache</em></td> <td class='confluenceTd'> <em>xmlui.google.analytics.key</em> </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'>Example Value:</td> <td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'><em>xmlui.community-list.cache = 12 hours</em></td> <td class='confluenceTd'> <em>xmlui.google.analytics.key = UA-XXXXXX-X</em> </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'>Informational Note:</td> <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> <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: &#95;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>
<tr> <tr>
<td class='confluenceTd'>Property:</td> <td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'><em>xmlui.bistream.mods</em></td> <td class='confluenceTd'> <em>xmlui.controlpanel.activity.max = 250</em> </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'>Example Value:</td> <td class='confluenceTd'> Informational Note: </td>
<td class='confluenceTd'><em>xmlui.bistream.mods = true</em></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'>Informational Note:</td> <td class='confluenceTd'> Property: </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> <td class='confluenceTd'> <em>xmlui.controlpanel.activity.ipheader</em> </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'> <em>xmlui.controlpanel.activity.ipheader = X-Forward-For</em> </td>
</tr> </tr>
<tr> <tr>
<td class='confluenceTd'>Property:</td> <td class='confluenceTd'> Informational Note: </td>
<td class='confluenceTd'><em>xmlui.bitstream.mets</em></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>
<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> </tr>
</tbody></table> </tbody></table>
</div> </div>
@@ -258,12 +254,12 @@
</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;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> </span> &lt;/aspects&gt;</pre>
</div></div> </div></div>
<p>A standard distribution of Manakin/DSpace includes four "core" aspects: </p> <p>A standard distribution of Manakin/DSpace includes four "core" aspects:</p>
<ul> <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><b>Artifact Browser</b> 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><b>E-Person</b> 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><b>Submission</b> 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> <li><b>Administrative</b> 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> </ul>
@@ -285,7 +281,7 @@ If you use the "handle" attribute, the effect is cascading, meaning if a rule is
&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;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> &lt;/themes&gt;</pre>
</div></div> </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> <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 &#42;anything</b>, so all pages which have not matched one of the preceding rules will be matched to the Reference Theme.</p></li>
</ul> </ul>
@@ -295,11 +291,11 @@ If you use the "handle" attribute, the effect is cascading, meaning if a rule is
<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>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&#95;<em>language</em>_<em>country</em>_<em>variant</em>.xml</p>
<p>messages_<em>language</em>_<em>country</em>.xml</p> <p>messages&#95;<em>language</em>_<em>country</em>.xml</p>
<p>messages_<em>language</em>.xml</p> <p>messages&#95;<em>language</em>.xml</p>
<p>messages.xml</p> <p>messages.xml</p>
@@ -408,7 +404,7 @@ This will ensure the theme has been installed as described in the previous secti
<p>The XMLUI user interface supports the addition of globally static content (as well as static content within individual themes).</p> <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>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>&#42;.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> <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"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
@@ -443,12 +439,13 @@ At this point the settings are saved and the menu changes to provide three optio
<ul> <ul>
<li>"Change Settings" takes you back to the edit screen.</li> <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/> <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> 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. <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.</li>
<h3><a name="XMLUIConfigurationandCustomization-AutomaticHarvesting%28Scheduler%29"></a>Automatic Harvesting (Scheduler)</h3></li>
</ul> </ul>
<h3><a name="XMLUIConfigurationandCustomization-AutomaticHarvesting%28Scheduler%29"></a>Automatic Harvesting (Scheduler)</h3>
<p>Setting up automatic harvesting in the Control Panel Screen.</p> <p>Setting up automatic harvesting in the Control Panel Screen.</p>
<ul> <ul>
@@ -468,6 +465,17 @@ At this point the settings are saved and the menu changes to provide three optio
</ul> </ul>
<h2><a name="XMLUIConfigurationandCustomization-AdditionalXMLUILearningResources"></a>Additional XMLUI Learning Resources</h2>
<p>Useful links with further information into XMLUI Development</p>
<ul>
<li><a href="http://www.slideshare.net/tdonohue/making-dspace-xmlui-your-own">Making DSpace XMLUI Your Own</a> &#45; Concentrates on using Maven to build Overlays in the XMLUI (Manakin). Also has very basic examples for JSPUI. Based on DSpace 1.6.x.</li>
<li><a href="http://www.tdl.org/files/LearningToUseManakin.pdf">Learning to Use Manakin (XMLUI)</a> &#45; Overview of how to use Manakin and how it works. Based on DSpace 1.5, but also valid for 1.6.</li>
<li><a href="http://www.tdl.org/wp-content/uploads/2009/04/Introducing%20Manakin.pdf">Introducing Manakin (XMLUI)</a></li>
</ul>
</td> </td>
</tr> </tr>
@@ -477,7 +485,7 @@ At this point the settings are saved and the menu changes to provide three optio
<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> <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>
<tr> <tr>
<td align="center"><font color="grey">Document generated by Confluence on Nov 06, 2010 19:27</font></td> <td align="center"><font color="grey">Document generated by Confluence on Dec 16, 2010 16:47</font></td>
</tr> </tr>
</table> </table>
</body> </body>