hazza/DSpace
1
0
Fork 0
mirror of https://github.com/DSpace/DSpace.git synced 2025-10-15 22:13:08 +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

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

@@ -16,12 +16,11 @@
</span>
</div>
<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>
<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>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>
<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>
@@ -80,56 +185,56 @@
<p>The administrator need to build the source xml document in the following format:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">&lt;import_structure&gt;
&lt;community&gt;
&lt;name&gt;Community Name&lt;/name&gt;
&lt;description&gt;Descriptive text&lt;/description&gt;
&lt;intro&gt;Introductory text&lt;/intro&gt;
&lt;copyright&gt;Special copyright notice&lt;/copyright&gt;
&lt;sidebar&gt;Sidebar text&lt;/sidebar&gt;
&lt;community&gt;
&lt;name&gt;Sub Community Name&lt;/name&gt;
&lt;community&gt; ...[ad infinitum]...
&lt;/community&gt;
&lt;/community&gt;
&lt;collection&gt;
&lt;name&gt;Collection Name&lt;/name&gt;
&lt;description&gt;Descriptive text&lt;/description&gt;
&lt;intro&gt;Introductory text&lt;/intro&gt;
&lt;copyright&gt;Special copyright notice&lt;/copyright&gt;
&lt;sidebar&gt;Sidebar text&lt;/sidebar&gt;
&lt;license&gt;Special licence&lt;/license&gt;
&lt;provenance&gt;Provenance information&lt;/provenance&gt;
&lt;/collection&gt;
&lt;/community&gt;
&lt;/import_structure&gt;
<pre class="code-java">&lt;import_structure&gt;
&lt;community&gt;
&lt;name&gt;Community Name&lt;/name&gt;
&lt;description&gt;Descriptive text&lt;/description&gt;
&lt;intro&gt;Introductory text&lt;/intro&gt;
&lt;copyright&gt;Special copyright notice&lt;/copyright&gt;
&lt;sidebar&gt;Sidebar text&lt;/sidebar&gt;
&lt;community&gt;
&lt;name&gt;Sub Community Name&lt;/name&gt;
&lt;community&gt; ...[ad infinitum]...
&lt;/community&gt;
&lt;/community&gt;
&lt;collection&gt;
&lt;name&gt;Collection Name&lt;/name&gt;
&lt;description&gt;Descriptive text&lt;/description&gt;
&lt;intro&gt;Introductory text&lt;/intro&gt;
&lt;copyright&gt;Special copyright notice&lt;/copyright&gt;
&lt;sidebar&gt;Sidebar text&lt;/sidebar&gt;
&lt;license&gt;Special licence&lt;/license&gt;
&lt;provenance&gt;Provenance information&lt;/provenance&gt;
&lt;/collection&gt;
&lt;/community&gt;
&lt;/import_structure&gt;
</pre>
</div></div>
<p>The resulting output document will be as follows:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">&lt;import_structure&gt;
&lt;community identifier=<span class="code-quote">"123456789/1"</span>&gt;
&lt;name&gt;Community Name&lt;/name&gt;
&lt;description&gt;Descriptive text&lt;/description&gt;
&lt;intro&gt;Introductory text&lt;/intro&gt;
&lt;copyright&gt;Special copyright notice&lt;/copyright&gt;
&lt;sidebar&gt;Sidebar text&lt;/sidebar&gt;
&lt;community identifier=<span class="code-quote">"123456789/2"</span>&gt;
&lt;name&gt;Sub Community Name&lt;/name&gt;
&lt;community identifier=<span class="code-quote">"123456789/3"</span>&gt; ...[ad infinitum]...
&lt;/community&gt;
&lt;/community&gt;
&lt;collection identifier=<span class="code-quote">"123456789/4"</span>&gt;
&lt;name&gt;Collection Name&lt;/name&gt;
&lt;description&gt;Descriptive text&lt;/description&gt;
&lt;intro&gt;Introductory text&lt;/intro&gt;
&lt;copyright&gt;Special copyright notice&lt;/copyright&gt;
&lt;sidebar&gt;Sidebar text&lt;/sidebar&gt;
&lt;license&gt;Special licence&lt;/license&gt;
&lt;provenance&gt;Provenance information&lt;/provenance&gt;
&lt;/collection&gt;
&lt;/community&gt;
&lt;/import_structure&gt;
<pre class="code-java">&lt;import_structure&gt;
&lt;community identifier=<span class="code-quote">"123456789/1"</span>&gt;
&lt;name&gt;Community Name&lt;/name&gt;
&lt;description&gt;Descriptive text&lt;/description&gt;
&lt;intro&gt;Introductory text&lt;/intro&gt;
&lt;copyright&gt;Special copyright notice&lt;/copyright&gt;
&lt;sidebar&gt;Sidebar text&lt;/sidebar&gt;
&lt;community identifier=<span class="code-quote">"123456789/2"</span>&gt;
&lt;name&gt;Sub Community Name&lt;/name&gt;
&lt;community identifier=<span class="code-quote">"123456789/3"</span>&gt; ...[ad infinitum]...
&lt;/community&gt;
&lt;/community&gt;
&lt;collection identifier=<span class="code-quote">"123456789/4"</span>&gt;
&lt;name&gt;Collection Name&lt;/name&gt;
&lt;description&gt;Descriptive text&lt;/description&gt;
&lt;intro&gt;Introductory text&lt;/intro&gt;
&lt;copyright&gt;Special copyright notice&lt;/copyright&gt;
&lt;sidebar&gt;Sidebar text&lt;/sidebar&gt;
&lt;license&gt;Special licence&lt;/license&gt;
&lt;provenance&gt;Provenance information&lt;/provenance&gt;
&lt;/collection&gt;
&lt;/community&gt;
&lt;/import_structure&gt;
</pre>
</div></div>
<p>This command-line tool gives you the ability to import a community and collection structure directly from a source XML file. It is executed as follows:</p>
@@ -211,13 +316,13 @@
<p>Here is a basic example of a bulk ingest 'packager' command template:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"> [dspace]/bin/dspace packager -s -a -t AIP -e &lt;eperson&gt; -p &lt;parent-handle&gt; &lt;file-path&gt;
<pre class="code-java"> [dspace]/bin/dspace packager -s -a -t AIP -e &lt;eperson&gt; -p &lt;parent-handle&gt; &lt;file-path&gt;
</pre>
</div></div>
<p>for example:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"> [dspace]/bin/dspace packager -s -a -t AIP -e admin@myu.edu -p 4321/12 collection-aip.zip
<pre class="code-java"> [dspace]/bin/dspace packager -s -a -t AIP -e admin@myu.edu -p 4321/12 collection-aip.zip
</pre>
</div></div>
<p>The above command will ingest the package named "collection-aip.zip" as a child of the specified Parent Object (handle="4321/12"). The resulting object is assigned a new Handle (since <tt>&#45;s</tt> is specified). In addition, any child packages directly referenced by "collection-aip.zip" are also recursively ingested (a new Handle is also assigned for each child AIP).</p>
@@ -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:
<ul>
<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>
</td></tr></table></div>
@@ -247,12 +352,12 @@
<p>Use this 'packager' command template:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"> [dspace]/bin/dspace packager -r -t AIP -e &lt;eperson&gt; &lt;file-path&gt;
<pre class="code-java"> [dspace]/bin/dspace packager -r -t AIP -e &lt;eperson&gt; &lt;file-path&gt;
</pre>
</div></div>
<p>For example:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"> [dspace]/bin/dspace packager -r -t AIP -e admin@myu.edu aip4567.zip
<pre class="code-java"> [dspace]/bin/dspace packager -r -t AIP -e admin@myu.edu aip4567.zip
</pre>
</div></div>
@@ -268,13 +373,13 @@
<p>Here's an example of how to use this 'packager' command:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"> [dspace]/bin/dspace packager -r -a -k -t AIP -e &lt;eperson&gt; &lt;file-path&gt;
<pre class="code-java"> [dspace]/bin/dspace packager -r -a -k -t AIP -e &lt;eperson&gt; &lt;file-path&gt;
</pre>
</div></div>
<p>For example:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"> [dspace]/bin/dspace packager -r -a -k -t AIP -e admin@myu.edu aip4567.zip
<pre class="code-java"> [dspace]/bin/dspace packager -r -a -k -t AIP -e admin@myu.edu aip4567.zip
</pre>
</div></div>
@@ -288,13 +393,13 @@
<p>Here's an example of how to use this 'packager' command:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"> [dspace]/bin/dspace packager -r -f -t AIP -e &lt;eperson&gt; &lt;file-path&gt;
<pre class="code-java"> [dspace]/bin/dspace packager -r -f -t AIP -e &lt;eperson&gt; &lt;file-path&gt;
</pre>
</div></div>
<p>For example:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"> [dspace]/bin/dspace packager -r -f -t AIP -e admin@myu.edu aip4567.zip
<pre class="code-java"> [dspace]/bin/dspace packager -r -f -t AIP -e admin@myu.edu aip4567.zip
</pre>
</div></div>
@@ -313,7 +418,7 @@
<p>Where <em>[user-email]</em> is the e-mail address of the E-Person under whose authority this runs; <em>[handle]</em> is the Handle of the Object to disseminate; <em>[packager-name]</em> is the plugin name of the package disseminator to use; and <em>[file-path]</em> is the path to the file to create (or <em>"-"</em> to write to the standard output). For example:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"> [dspace]/bin/dspace packager -d -t METS -e admin@myu.edu -i 4321/4567 4567.zip
<pre class="code-java"> [dspace]/bin/dspace packager -d -t METS -e admin@myu.edu -i 4321/4567 4567.zip
</pre>
</div></div>
<p>The above code will export the object of the given handle (4321/4567) into a METS file named "4567.zip".</p>
@@ -325,26 +430,26 @@
<p>For example, use this 'packager' command template:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"> [dspace]/bin/dspace packager -d -a -e [user-email] -i [handle] -t [packager-name][file-path]
<pre class="code-java"> [dspace]/bin/dspace packager -d -a -e [user-email] -i [handle] -t [packager-name][file-path]
</pre>
</div></div>
<p>for example:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"> [dspace]/bin/dspace packager -d -a -t METS -e admin@myu.edu -i 4321/4567 4567.zip
<pre class="code-java"> [dspace]/bin/dspace packager -d -a -t METS -e admin@myu.edu -i 4321/4567 4567.zip
</pre>
</div></div>
<p>The above code will export the object of the given handle (4321/4567) into a METS file named "4567.zip". In addition it would export all children objects to the same directory as the "4567.zip" file.</p>
<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>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>
@@ -354,6 +459,7 @@
<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>
@@ -362,18 +468,19 @@
<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">
<pre class="code-java">archive_directory/
item_000/
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
contents -- text file containing one line per filename
file_1.doc -- files to be added as bitstreams to the item
file_2.pdf
item_001/
dublin_core.xml
contents
file_1.png
...
<pre class="code-java">
archive_directory/
item_000/
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
contents -- text file containing one line per filename
file_1.doc -- files to be added as bitstreams to the item
file_2.pdf
item_001/
dublin_core.xml
contents
file_1.png
...
</pre>
</div></div>
<p>The <em>dublin_core.xml</em> or <em>metadata</em>[prefix].xml_file has the following format, where each metadata element has it's own entry within a <em>&lt;dcvalue&gt;</em> tagset. There are currently three tag attributes available in the <em>&lt;dcvalue&gt;</em> tagset:</p>
@@ -383,12 +490,13 @@
<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
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<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">"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;/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">"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;/dublin_core&gt;
</pre>
</div></div>
<p>(Note the optional language tag attribute which notifies the system that the optional title is in French.)</p></li>
@@ -399,9 +507,10 @@
<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">
<pre class="code-java"> file_1.doc
file_2.pdf
license
<pre class="code-java">
file_1.doc
file_2.pdf
license
</pre>
</div></div>
<p>Please notice that the <em>license</em> is optional, and if you wish to have one included, you can place the file in the .../item_001/ directory, for example.</p>
@@ -421,11 +530,11 @@
<li>Inside the xml file use the dame Dublin Core <em>syntax</em>, but on the <em>&lt;dublin_core&gt;</em> element include the attribute "<em>schema={prefix}</em>".</li>
<li>Here is an example for ETD metadata, which would be in the file "<em>metadata_etd.xml"</em>:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">&lt;xml version=<span class="code-quote">"1.0"</span> encoding=<span class="code-quote">"UTF-8"</span>?&gt;
&lt;dublin_core schema=<span class="code-quote">"etd"</span>&gt;
&lt;dcvalue element=<span class="code-quote">"degree"</span> qualifier=<span class="code-quote">"department"</span>&gt;Computer Science&lt;/dcvalue&gt;
&lt;dcvalue element=<span class="code-quote">"degree"</span> qualifier=<span class="code-quote">"level"</span>&gt;Masters&lt;/dcvalue&gt;
&lt;dcvalue element=<span class="code-quote">"degree"</span> qualifier=<span class="code-quote">"grantor"</span>&gt;Texas A &amp; M&lt;/dcvalue&gt;
<pre class="code-java">&lt;xml version=<span class="code-quote">"1.0"</span> encoding=<span class="code-quote">"UTF-8"</span>?&gt;
&lt;dublin_core schema=<span class="code-quote">"etd"</span>&gt;
&lt;dcvalue element=<span class="code-quote">"degree"</span> qualifier=<span class="code-quote">"department"</span>&gt;Computer Science&lt;/dcvalue&gt;
&lt;dcvalue element=<span class="code-quote">"degree"</span> qualifier=<span class="code-quote">"level"</span>&gt;Masters&lt;/dcvalue&gt;
&lt;dcvalue element=<span class="code-quote">"degree"</span> qualifier=<span class="code-quote">"grantor"</span>&gt;Texas A &amp; M&lt;/dcvalue&gt;
</pre>
</div></div></li>
</ol>
@@ -812,9 +921,9 @@ In order to avoid duplication of this metadata, run</li>
<p>The <em>contents</em> file, like that for regular item import, lists the item's content files, one content file per line, but each line has the one of the following formats:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">-r -s n -f filepath
-r -s n -f filepath\tbundle:bundlename
-r -s n -f filepath\tbundle:bundlename\tpermissions: -[r|w] 'group name'
<pre class="code-java">-r -s n -f filepath
-r -s n -f filepath\tbundle:bundlename
-r -s n -f filepath\tbundle:bundlename\tpermissions: -[r|w] 'group name'
-r -s n -f filepath\tbundle:bundlename\tpermissions: -[r|w] 'group name'\tdescription: some text</pre>
</div></div>
<p>where</p>
@@ -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>
</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>
@@ -1102,7 +1211,7 @@ Adding your own filters is done by creating a class which <em>implements</em> th
</tr>
<tr>
<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>
<td class='confluenceTd'> <tt>&#45;h</tt> or <tt>&#45;-help</tt> </td>
@@ -1367,7 +1476,7 @@ The user should refer to Chapter 5. Configuration for specific configuration bey
<li>Editing the retention policies in <tt>[dspace]/config/dspace.cfg</tt> See Chapter 5 Configuration for the property keys. OR</li>
<li>Pass in a properties file containting retention policies when using the &#45;p option.To do this, create a file with the following two property keys:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">checker.retention.<span class="code-keyword">default</span> = 10y
<pre class="code-java">checker.retention.<span class="code-keyword">default</span> = 10y
checker.retention.CHECKSUM_MATCH = 8w</pre>
</div></div>
<p>You can use the table above for your time units. At the command line: <tt>[dspace]/bin/dspace checker &#45;p retention_file_name &lt;ENTER&gt;</tt></p></li>
@@ -1538,47 +1647,47 @@ checker.retention.CHECKSUM_MATCH = 8w</pre>
<td class='confluenceTd'> Description </td>
</tr>
<tr>
<td class='confluenceTd'> <em><del>r</del></em> or <em>&#45;rebuild</em> </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'> <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 <tt>&#45;f</tt>. Mutually exclusive with <tt>&#45;d</tt> </td>
</tr>
<tr>
<td class='confluenceTd'> <em><del>s</del></em> or <em>&#45;start</em> </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>&#45;s</tt> or <tt>&#45;start</tt> </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>
<td class='confluenceTd'> <em><del>x</del></em> or <em>&#45;execute</em> </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'> <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 <tt>&#45;t</tt> and <tt>&#45;f</tt> </td>
</tr>
<tr>
<td class='confluenceTd'> <em><del>i</del></em> or <em>&#45;index</em> </td>
<td class='confluenceTd'> Actually do the indexing. Mutually exclusive with <em>&#45;t</em> and <em>&#45;f</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 <tt>&#45;t</tt> and <tt>&#45;f</tt>. </td>
</tr>
<tr>
<td class='confluenceTd'> <em><del>o</del></em> or <em>&#45;out</em> </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>&#45;o</tt> or <tt>&#45;out</tt> </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>
<td class='confluenceTd'> <em><del>p</del></em> or <em>&#45;print</em> </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'> <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 <tt>&#45;t</tt> and <tt>&#45;f</tt>. </td>
</tr>
<tr>
<td class='confluenceTd'> <em><del>t</del></em> or <em>&#45;tables</em> </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'> <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 <tt>&#45;f</tt> and <tt>&#45;i</tt> </td>
</tr>
<tr>
<td class='confluenceTd'> <em><del>f</del></em> or <em>&#45;full</em> </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'> <tt>&#45;f</tt> or <tt>&#45;full</tt> </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>
<td class='confluenceTd'> <em><del>v</del></em> or <em>&#45;verbose</em> </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'> <tt>&#45;v</tt> or <tt>&#45;verbose</tt> </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>
<td class='confluenceTd'> <em><del>d</del></em> or <em>&#45;delete</em> </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'> <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 <tt>&#45;f</tt>. This is mutually exclusive with <tt>&#45;r</tt>. </td>
</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>
</tr>
</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>
<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>
<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>
@@ -1647,7 +1755,7 @@ As one can see, the choices are limited only by your metadata schema, the metada
<table class='confluenceTable'><tbody>
<tr>
<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>
<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>
</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>
</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>
</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>
</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>
</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>
</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>
</tr>
</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>
<tr>
<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>
<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>
</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>
</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>
</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>
</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>
</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>
</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>
</tr>
</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>
<tr>
<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>
<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>
</tr>
<tr>
<td class='confluenceTd'> <em><del>u</del></em> or <em>&#45;update-spider-files</em> </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'> <tt>&#45;u</tt> or <tt>&#45;update-spider-files</tt> </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>
<td class='confluenceTd'> <em><del>f</del></em> or <em>&#45;delete-spiders-by-flag</em> </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'> <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 <tt>isBot:true</tt> </td>
</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>
</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>
</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>
</tr>
</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>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>
@@ -1787,7 +1895,7 @@ As one can see, the choices are limited only by your metadata schema, the metada
<table class='confluenceTable'><tbody>
<tr>
<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>
<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>
</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>
</tr>
</tbody></table>
</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>
</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>
</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>
</table>
</body>

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

File diff suppressed because it is too large Load Diff

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

@@ -16,12 +16,36 @@
</span>
</div>
<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>
<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>
@@ -29,212 +53,184 @@
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.supportedLocales</em></td>
<td class='confluenceTd'> Property: </td>
<td class='confluenceTd'> <em>xmlui.supportedLocales</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.supportedLocales = en, de</em></td>
<td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'> <em>xmlui.supportedLocales = en, de</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>A list of supported locales for Manakin. Manakin will look at a user's browser configuration for the first language that appears in this list to make available to in the interface. This parameter is a comma separated list of Locales. All types of Locales country, country_language, country_language_variant. Note that if the appropriate files are not present (i.e. Messages_XX_XX.xml) then Manakin will fall back through to a more general language.</td>
<td class='confluenceTd'> Informational Note: </td>
<td class='confluenceTd'> A list of supported locales for Manakin. Manakin will look at a user's browser configuration for the first language that appears in this list to make available to in the interface. This parameter is a comma separated list of Locales. All types of Locales country, country_language, country_language_variant. Note that if the appropriate files are not present (i.e. Messages_XX_XX.xml) then Manakin will fall back through to a more general language. </td>
</tr>
<tr>
<td class='confluenceTd'> Property: </td>
<td class='confluenceTd'> <em>xmlui.force.ssl</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.force.ssl</em></td>
<td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'> <em>xmlui.force.ssl = true</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.force.ssl = true</em></td>
<td class='confluenceTd'> Informational Note: </td>
<td class='confluenceTd'> Force all authenticated connections to use SSL, only non-authenticated connections are allowed over plain http. If set to true, then you need to ensure that the '<em>dspace.hostname</em>' parameter is set to the correctly. </td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>Force all authenticated connections to use SSL, only non-authenticated connections are allowed over plain http. If set to true, then you need to ensure that the '<em>dspace.hostname</em>' parameter is set to the correctly.</td>
<td class='confluenceTd'> Property: </td>
<td class='confluenceTd'> <em>xmlui.user.registration</em> </td>
</tr>
<tr>
<td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'> <em>xmlui.user.registration = true</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.user.registration</em></td>
<td class='confluenceTd'> Informational Note: </td>
<td class='confluenceTd'> Determine if new users should be allowed to register. This parameter is useful in conjunction with Shibboleth where you want to disallow registration because Shibboleth will automatically register the user. Default value is true. </td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.user.registration = true</em></td>
<td class='confluenceTd'> Property: </td>
<td class='confluenceTd'> <em>xmlui.user.editmetadata</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>Determine if new users should be allowed to register. This parameter is useful in conjunction with Shibboleth where you want to disallow registration because Shibboleth will automatically register the user. Default value is true.</td>
<td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'> <em>xmlui.user.editmetadata = true</em> </td>
</tr>
<tr>
<td class='confluenceTd'> Informational Note: </td>
<td class='confluenceTd'> Determines if users should be able to edit their own metadata. This parameter is useful in conjunction with Shibboleth where you want to disable the user's ability to edit their metadata because it came from Shibboleth. Default value is true. </td>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.user.editmetadata</em></td>
<td class='confluenceTd'> Property: </td>
<td class='confluenceTd'> <em>xmlui.user.assumelogon</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.user.editmetadata = true</em></td>
<td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'> <em>xmlui.user.assumelogon = true</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>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'> Informational Note: </td>
<td class='confluenceTd'> Determine if super administrators (those whom are in the Administrators group) can login as another user from the "edit eperson" page. This is useful for debugging problems in a running dspace instance, especially in the workflow process. The default value is false, i.e., no one may assume the login of another user. </td>
</tr>
<tr>
<td class='confluenceTd'> Property: </td>
<td class='confluenceTd'> <em>xmlui.user.loginredirect</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.user.assumelogon</em></td>
<td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'> <em>xmlui.user.loginredirect = /profile</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.user.assumelogon = true</em></td>
<td class='confluenceTd'> Informational Note: </td>
<td class='confluenceTd'> After a user has logged into the system, which url should they be directed? Leave this parameter blank or undefined to direct users to the homepage, or <em>/profile</em> for the user's profile, or another reasonable choice is <em>/submissions</em> to see if the user has any tasks awaiting their attention. The default is the repository home page. </td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>Determine if super administrators (those whom are in the Administrators group) can login as another user from the "edit eperson" page. This is useful for debugging problems in a running dspace instance, especially in the workflow process. The default value is false, i.e., no one may assume the login of another user.</td>
<td class='confluenceTd'> Property: </td>
<td class='confluenceTd'> <em>xmlui.theme.allowoverrides</em> </td>
</tr>
<tr>
<td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'> <em>xmlui.theme.allowoverrides = false</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.user.loginredirect</em></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>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.user.loginredirect = /profile</em></td>
<td class='confluenceTd'> Property: </td>
<td class='confluenceTd'> <em>xmlui.bundle.upload</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>After a user has logged into the system, which url should they be directed? Leave this parameter blank or undefined to direct users to the homepage, or <em>/profile</em> for the user's profile, or another reasonable choice is <em>/submissions</em> to see if the user has any tasks awaiting their attention. The default is the repository home page.</td>
<td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'> <em>xmlui.bundle.upload = ORIGINAL, METADATA, THUMBNAIL, LICENSE, CC_LICENSE</em> </td>
</tr>
<tr>
<td class='confluenceTd'> Informational Note: </td>
<td class='confluenceTd'> Determine which bundles administrators and collection administrators may upload into an existing item through the administrative interface. If the user does not have the appropriate privileges (add and write) on the bundle then that bundle will not be shown to the user as an option. </td>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.theme.allowoverrides</em></td>
<td class='confluenceTd'> Property: </td>
<td class='confluenceTd'> <em>xmlui.community-list.render.full</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.theme.allowoverrides = false</em></td>
<td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'> <em>xmlui.community-list.render.full = true</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>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'> Informational Note: </td>
<td class='confluenceTd'> On the community-list page should all the metadata about a community/collection be available to the theme. This parameter defaults to true, but if you are experiencing performance problems on the community-list page you should experiment with turning this option off. </td>
</tr>
<tr>
<td class='confluenceTd'> Property: </td>
<td class='confluenceTd'> <em>xmlui.community-list.cache</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.bundle.upload</em></td>
<td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'> <em>xmlui.community-list.cache = 12 hours</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.bundle.upload = ORIGINAL, METADATA, THUMBNAIL, LICENSE, CC_LICENSE</em></td>
<td class='confluenceTd'> Informational Note: </td>
<td class='confluenceTd'> Normally, Manakin will fully verify any cache pages before using a cache copy. This means that when the community-list page is viewed the database is queried for each community/collection to see if their metadata has been modified. This can be expensive for repositories with a large community tree. To help solve this problem you can set the cache to be assumed valued for a specific set of time. The downside of this is that new or editing communities/collections may not show up the website for a period of time. </td>
</tr>
<tr>
<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>
<td class='confluenceTd'> Property: </td>
<td class='confluenceTd'> <em>xmlui.bistream.mods</em> </td>
</tr>
<tr>
<td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'> <em>xmlui.bistream.mods = true</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.community-list.render.full</em></td>
<td class='confluenceTd'> Informational Note: </td>
<td class='confluenceTd'> Optionally, you may configure Manakin to take advantage of metadata stored as a bitstream. The MODS metadata file must be inside the "METADATA" bundle and named MODS.xml. If this option is set to 'true' and the bitstream is present then it is made available to the theme for display. </td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.community-list.render.full = true</em></td>
<td class='confluenceTd'> Property: </td>
<td class='confluenceTd'> <em>xmlui.bitstream.mets</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>On the community-list page should all the metadata about a community/collection be available to the theme. This parameter defaults to true, but if you are experiencing performance problems on the community-list page you should experiment with turning this option off.</td>
<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>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.community-list.cache</em></td>
<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.community-list.cache = 12 hours</em></td>
<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'>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'> 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: &#95;uacct = "UA-XXXXXXX-X" Take this key (just the UA-XXXXXX-X part) and place it here in this parameter. </td>
</tr>
<tr>
<td class='confluenceTd'> Property: </td>
<td class='confluenceTd'> <em>xmlui.controlpanel.activity.max</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.bistream.mods</em></td>
<td class='confluenceTd'> Example Value: </td>
<td class='confluenceTd'> <em>xmlui.controlpanel.activity.max = 250</em> </td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.bistream.mods = true</em></td>
<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>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>Optionally, you may configure Manakin to take advantage of metadata stored as a bitstream. The MODS metadata file must be inside the "METADATA" bundle and named MODS.xml. If this option is set to 'true' and the bitstream is present then it is made available to the theme for display.</td>
<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'>Property:</td>
<td class='confluenceTd'><em>xmlui.bitstream.mets</em></td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.bitstream.mets = true</em></td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>Optionally, you may configure Manakin to take advantage of metadata stored as a bitstream. The METS metadata file must be inside the "METADATA" bundle and named METS.xml. If this optino is set to "true" and the bitstream is present then it is made available to the theme for display.</td>
</tr>
<tr>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.google.analytics.key</em></td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.google.analytics.key = UA-XXXXXX-X</em></td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>If you would like to use google analytics to track general website statistics then use the following parameter to provide your analytics key. First sign up for an account at <a href="http://analytics.google.com" title="http://analytics.google.com">http://analytics.google.com</a>, then create an entry for your repositories website. Google Analytics will give you a snipit of javascript code to place on your site, inside that snip it is your google analytics key usually found in the line: _uacct = "UA-XXXXXXX-X" Take this key (just the UA-XXXXXX-X part) and place it here in this parameter.</td>
</tr>
<tr>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.controlpanel.activity.max</em></td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.controlpanel.activity.max = 250</em></td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>Assign how many page views will be recorded and displayed in the control panel's activity viewer. The activity tab allows an administrator to debug problems in a running DSpace by understanding who and how their dspace is currently being used. The default value is 250.</td>
</tr>
<tr>
</tr>
<tr>
<td class='confluenceTd'>Property:</td>
<td class='confluenceTd'><em>xmlui.controlpanel.activity.ipheader</em></td>
</tr>
<tr>
<td class='confluenceTd'>Example Value:</td>
<td class='confluenceTd'><em>xmlui.controlpanel.activity.ipheader = X-Forward-For</em></td>
</tr>
<tr>
<td class='confluenceTd'>Informational Note:</td>
<td class='confluenceTd'>Determine where the control panel's activity viewer recieves an events IP address from. If your DSpace is in a load balanced enviornment or otherwise behind a context-switch then you will need to set the paramater to the HTTP parameter that records the original IP address.</td>
<td class='confluenceTd'> Informational Note: </td>
<td class='confluenceTd'> Determine where the control panel's activity viewer recieves an events IP address from. If your DSpace is in a load balanced enviornment or otherwise behind a context-switch then you will need to set the paramater to the HTTP parameter that records the original IP address. </td>
</tr>
</tbody></table>
</div>
@@ -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;/aspects&gt;</pre>
</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>
<li>*Artifact Browser*The Artifact Browser Aspect is responsible for browsing communities, collections, items and bitstreams, viewing an individual item and searching the repository.</li>
<li>*E-Person*The E-Person Aspect is responsible for logging in, logging out, registering new users, dealing with forgotten passwords, editing profiles and changing passwords.</li>
<li>*Submission*The Submission Aspect is responsible for submitting new items to DSpace, determining the workflow process and ingesting the new items into the DSpace repository.</li>
<li>*Administrative*The Administrative Aspect is responsible for administrating DSpace, such as creating, modifying and removing all communities, collections, e-persons, groups, registries and authorizations.</li>
<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><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><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><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>
@@ -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;/themes&gt;</pre>
</div></div>
<p>In the example above three themes are configured: "Theme 1", "Theme 2", and the "Reference Theme". The first rule specifies that "Theme 1" will apply to all communities, collections, or items that are contained under the parent community "123456789/23". The next rule specifies any URL containing the string "community-list" will get "Theme 2". The final rule, using the regular expression ".<b>", will match *anything</b>, so all pages which have not matched one of the preceding rules will be matched to the Reference Theme.</p></li>
<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>
@@ -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>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>
@@ -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>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>
<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>
<li>"Change Settings" takes you back to the edit screen.</li>
<li>"Import Now" performs a single harvest from the remote collection into the local one. Success, notes, and errors encountered in the process will be reflected in the "Last Harvest Result" entry. More detailed information is available in the dspace log. Note that the whole harvest cycle is execuited withtin a single HTTP request and will time out for large collections. For this reason, it is advisable to use the automatic harvest scheduler set up<br/>
either in XMLUI or from the command line. If the scheduler is running, "Import Now" will handle the harvest task as a separate thread.</li>
<li>"Reset and Reimport Collection" will perform the same function as "Import Now", but will clear the collection of all existing items before doing so.
<h3><a name="XMLUIConfigurationandCustomization-AutomaticHarvesting%28Scheduler%29"></a>Automatic Harvesting (Scheduler)</h3></li>
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>
</ul>
<h3><a name="XMLUIConfigurationandCustomization-AutomaticHarvesting%28Scheduler%29"></a>Automatic Harvesting (Scheduler)</h3>
<p>Setting up automatic harvesting in the Control Panel Screen.</p>
<ul>
@@ -468,6 +465,17 @@ At this point the settings are saved and the menu changes to provide three optio
</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>
</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>
</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>
</table>
</body>