Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info
titleLatest Releases of Replication Task Suite

Based on the version of DSpace you are running, here are the compatible latest releases of the Replication Task Suite:

  • RTS, version 7.06 - compatible only with DSpace 7.6.x releases (coming soon!)
    • Follow the
    • RTS version 7.0 is the only RTS release compatible with DSpace 7.x. If you are running DSpace 7.x, follow the directions below to install the Replication Task Suite (see Installation on DSpace 7.x).
      • After upgrading the RTS software, it is recommended to run a full backup to ensure all your AIP packages are also updated (if necessary).
    • Version 7.0 6 release notes
  • RTS, version 6.1 - compatible only with DSpace 6.x releases
    • Upgrading: To upgrade to RTS 6.1 from a previous version, simply change your pom.xml (see Installation on DSpace 6.x) to reference 'dspace-replicate' version 6.1.  Then rebuild DSpace & re-run 'ant update'. You should verify your configurations are still compatible with DSpace 6.x, as the DSpace Configuration System received an overhaul in DSpace 6
      • After upgrading the RTS software, it is recommended to run a full backup to ensure all your AIP packages are also updated (if necessary).
    • Version 6.1 release notes
  • RTS, version 5.0 - compatible only with DSpace 5.x releases
    • Upgrading: To upgrade to RTS 5.0 from a previous version, simply change your pom.xml (see Installation on DSpace 5.x) to reference 'dspace-replicate' version 5.0.  Then rebuild DSpace & re-run 'ant update'.
      • After upgrading the RTS software, it is recommended to run a full backup to ensure all your AIP packages are also updated (if necessary).
    • Version 5.0 release notes
  • RTS, version 3.5 - bug-fix release, compatible with all DSpace 3.x and 4.x releases
    • Upgrading: To upgrade to RTS 3.5 from a previous version, simply change your pom.xml (see Installation on DSpace 3.x or 4.x) to reference 'dspace-replicate' version 3.5.  Then rebuild DSpace & re-run 'ant update'. Your existing RTS 3.x configuration files will still work with RTS 3.5.
      • After upgrading the RTS software, it is recommended to run a full backup to ensure all your AIP packages are also updated (if necessary).
    • Version 3.5 release notes
  • RTS, version 1.3 - bug-fix release, compatible with all DSpace 1.8.x releases.
    • Upgrading: To upgrade to RTS version 1.3 from a previous release, simply change your pom.xml (see Installation on DSpace 1.8.x) to reference 'dspace-replicate' version 1.3. Then rebuild DSpace & re-run 'ant update'. Your existing RTS 1.x configuration files will still work with RTS 1.3.
      • After upgrading the RTS software, it is recommended to run a full backup to ensure all your AIP packages are also updated (if necessary).
    • 1.3 Bug Fixes: This fixes a DuraCloud v2.4.0 connection error with version 1.2.
    • 1.2 Bug Fixes: This fixes a Java 6 incompatibility bug in version 1.1.  Previously version 1.1 required Java 7 when using DuraCloud.
    • 1.1 Bug Fixes: Fixes for several small bugs in 1.0 (namely with the event consumer utilized during Automatic Replication).

...

Replication Task Suite VersionSupported DSpace Version(s)Supported Java VersionSupported InterfacesNotes
7.06DSpace version 7.6.xJava 11 or aboveDSpace 7.6.x UI or command lineThe 7.0 6 stable version of the Replication Task Suite offers no new functionality over the previous versions. It is simply a refactor of the code to ensure that Replication Task Suite works with DSpace 7.6.x.
6.1DSpace version 6.xJava 8 or aboveXMLUI and/or commandlineThe 6.1 stable version of the Replication Task Suite offers no new functionality over the previous versions. It is simply a refactor of the code to ensure that Replication Task Suite works with DSpace 6.x.
5.0DSpace version 5.xJava 8 or aboveXMLUI and/or commandlineThe 5.0 stable version of the Replication Task Suite offers no new functionality over the previous versions. It is simply a refactor of the code to ensure that Replication Task Suite works with DSpace 5.x.
3.5DSpace version 3.x or 4.xJava 8 or aboveXMLUI and/or commandlineThe 3.5 stable version of the Replication Task Suite is nearly identical to the 1.x stable version. It just includes minor bug fixes to ensure the Replication Task Suite is compatible with the newer DSpace APIs.
1.3DSpace version 1.8.xJava 6 or aboveXMLUI and/or commandlineHighly recommended to use either DSpace 1.8.1 or above. DSpace 1.8.0 has a known bug where running a Replication Task will always return a NullPointerException - see DS-1077

...

  1. In your DSpace Source directory ([dspace-src]), you will need to modify the following POM file:
    • [dspace-src]/dspace/modules/additions/pom.xml (This POM will ensure that the "dspace-replicate" dependency is made available to commandline and ALL DSpace interfaces)

  2. For this pom.xml file, add the following <dependency> section at the end of the existing <dependencies> section (just before the closing </dependencies> tag). NOTE: the exclusions are required to work around differences in DSpace and DuraCloud dependency versions.

    Code Block
    <dependencies>
        ...
        <!-- Adding this dependency will install the Replication Task Suite Addon -->
        <dependency>
           <groupId>org.dspace</groupId>
           <artifactId>dspace-replicate</artifactId>
           <version>7.1<6</version>
           <exclusions>
             <exclusion>
              <exclusion>
       <groupId>com.amazonaws</groupId>
               <artifactId>aws-java-sdk-core</artifactId>
             </exclusion>
          	 <exclusion>
               <groupId>com.amazonaws</groupId>
                 <artifactId>aws-java-sdk-core<sqs</artifactId>
             </exclusion>
             <exclusion>
               <groupId>org.apache.commons</groupId>
               <artifactId>commons-compress</artifactId>
             </exclusion>
             <exclusion>
               <exclusion>
      <groupId>org.hibernate.javax.persistence</groupId>
               <artifactId>hibernate-jpa-2.1-api</artifactId>
             </exclusion>
             <exclusion>
               <groupId>org.apache.httpcomponents</groupId>
                 <artifactId>httpmime</artifactId>
              </exclusion>
              <exclusion>
                 <groupId>org.springframework.security</groupId>
                 <artifactId>spring-security-core</artifactId>
              </exclusion>
           </exclusions>     
        </dependency>
     
    </dependencies> 


  3. Once you've finished modifying the pom.xml file, rebuild DSpace by running the following from your [dspace-src]/dspace/ folder:

    Code Block
    mvn clean package
    


  4. Update the default dspace.cfg to include the Replication Task Suite config files. This ensures these configs are loaded as part of your DSpace configuration. This also allows you to override the configurations in your own local.cfg file. Including the duracloud.cfg file is only required if you are planning to replicate/backup your content to DuraCloud.

    Code Block
    include = ${module_dir}/replicate.cfg
    include = ${module_dir}/replicate-mets.cfg
    include = ${module_dir}/replicate-bagit.cfg
    include = ${module_dir}/duracloud.cfg


  5. Follow the instructions in the Configuration section below in order to enable & configure the Replication Task Suite Add-On.
  6. Update your existing DSpace installation by running the following from your [dspace-src]/dspace/target/dspace-[version]-build/ directory

    Code Block
    ant update
    


    Note

    Alternatively, if you don't want to do a full DSpace update, you can just update your existing binaries & webapps by running the following two commands:

    • ant update_code (Updates the existing [dspace]/lib/ directory)
    • ant update_webapps (Updates the existing [dspace]/webapp/ directory)


...