Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: added some very initial (beta) install instructions

...

Note
titleMore Information

More information on the Replication Task Suite & some early screenshots/diagrams were presented as part of the DuraCloud Workshop at Open Repositories 2011: http://www.slideshare.net/tdonohue/dspace-duracloud-integrations
The Replication Taks Suite will be released as an optional "add-on" to DSpace 1.8 (this means it will be 1.8-compatible, and you can choose to install it on an existing DSpace 1.8.0 system)

Prerequisites

Must be installed on a DSpace 1.8.0 System

Because of enhancements to the Curation System in DSpace 1.8.0, the Replication Suite is only compatible with a DSpace 1.8.0 System.

Installation

Note
titleWORK IN PROGRESS

These instructions are still a work in progress. We'll enhance them for DSpace 1.8.0 release

Manual Installation

  1. Download the Replication Suite code
  2. Build/Compile the Replication Suite, by running the following from the root directory
    Code Block
    mvn package
  3. Copy the generated JAR files to your DSpace 1.8.0 installation.
    1. Wiki Markup
      There are a total of 5 JARs that will need to be copied to your {{\[dspace\]/lib/}}
      • Wiki Markup
        {{\[dspace-replicate\]/target/dspace-replicate-\[version\].jar}}  (The Replication Suite Plugin)
      • Wiki Markup
        {{\[dspace-replicate\]/target/lib/common-\[version\].jar}} (DuraCloud common libraries - required for DuraCloud integration)
      • Wiki Markup
        {{\[dspace-replicate\]/target/lib/commons-compress-\[version\].jar}} (Apache Commons Compress - prerequisite for Replication Suite plugin)
      • Wiki Markup
        {{\[dspace-replicate\]/target/lib/storageprovider-\[version\].jar}} (DuraCloud storage provider libraries - required for DuraCloud integration)
      • Wiki Markup
        {{\[dspace-replicate\]/target/lib/storeclient-\[version\].jar}} (DuraCloud store client libraries - required for DuraCloud integration)
    2. Wiki Markup
      Also, copy the above 5 JARs also to your XMLUI web application's WEB-INF/lib directory (e.g. {{\[dspace\]/webapps/xmlui/WEB-INF/lib/}})
  4. Copy the Replication Suite's configuration files to your DSpace configuration directory
    • Wiki Markup
      *Replication Suite Configuration File:* Copy {{\[dspace-replicate\]/config/modules/replicate.cfg}} to your {{\[dspace\]/config/modules/}} directory
    • Wiki Markup
      *DuraCloud Configuration File:* Copy {{\[dspace-replicate\]/config/modules/duracloud.cfg}} to your {{\[dspace\]/config/modules/}} directory
    1. Wiki Markup
      Finally, enable the Replication Suite Tasks in your {{\[dspace\]/config/modules/curate.cfg}} configuration file (the Replication Suite tasks all begin with "org.dspace.ctask.replicate"):
      Code Block
      
      plugin.named.org.dspace.curate.CurationTask = \
          org.dspace.ctask.general.NoOpCurationTask = noop, \
          org.dspace.ctask.general.ProfileFormats = profileformats, \
          org.dspace.ctask.general.RequiredMetadata = requiredmetadata, \
          org.dspace.ctask.general.ClamScan = vscan, \
          org.dspace.ctask.general.MicrosoftTranslator = translate, \
          org.dspace.ctask.general.MetadataValueLinkChecker = checklinks, \
          org.dspace.ctask.replicate.EstimateAIPSize = estaipsize, \
          org.dspace.ctask.replicate.ReadOdometer = readodometer, \
          org.dspace.ctask.replicate.TransmitAIP = transmitaip, \
          org.dspace.ctask.replicate.VerifyAIP = verifyaip, \
          org.dspace.ctask.replicate.FetchAIP = fetchaip, \
          org.dspace.ctask.replicate.CompareWithAIP = auditaip, \
          org.dspace.ctask.replicate.RemoveAIP = removeaip, \
          org.dspace.ctask.replicate.RecoverFromAIP = recoverfromaip, \
          org.dspace.ctask.replicate.ReplaceWithAIP = replacewithaip
      
      ui.tasknames = \
           profileformats = Profile Bitstream Formats, \
           requiredmetadata = Check for Required Metadata, \
           checklinks = Check Links in Metadata, \
           vscan = Scan for Viruses, \
           estaipsize = Estimate AIP Size, \
           readodometer = Read Odometer, \
           transmitaip = Transmit AIP, \
           verifyaip = Verify AIP, \
           fetchaip = Fetch AIP, \
           auditaip = Audit AIP, \
           removeaip = Remove AIP, \
           recoverfromaip = Recover from AIP, \
           replacewithaip = Replace with AIP
      

Maven-based Installation (Coming Soon)

Coming SoonTo use the code described here, you will need a build of DSpace that supports both curation and AIPs. See CurationSystem for a link to a code branch that fulfills these requirements. You will also need a 'jar' of the replication task code, which must be placed in /dspace/lib. There must also be the replication configuration file (replicate.cfg) in /dspace/config/modules. Leave all values defaulted for now.

Problem Statement

We can suppose our data curator has identified a collection of items in her DSpace repository consisting of high-value, born-digital, and unique/irreplaceable (not held elsewhere) content. She prudently wishes to insure against catastrophic local loss of this content by keeping a copy or replica of this collection elsewhere. She'd prefer to replicate all her DSpace content, but realizes that storage costs over long periods has made her administration wary, so decides to begin with this collection.

...