EdShareCollectionsInstallation

Introduction

The collections module is part of OneShare. It is based on code developed in EdShare and OneBox. The goal of this project is to produce a package that allows the easy installation of the collections functionality on a vanilla EPrints installation.

Installation

As with all package installations it is important to remember to backup your installation of EPrints before continuing.

Extract Package

The package should be extracted in the root directory of your EPrints installation. Assuming the package is located in your root EPrints directory;

cd /opt/eprints3
tar -xzf meprints-VERSION.tar.gz

This will extract the package but the modifications to the archive will be extracted to archives/ARCHIVEID. You need to move this to your usual directory. You can do this by using the mv command, if we have a repository called foo then run;

cp -r archives/ARCHIVEID/* archives/foo

Then to clean up run;

rm -rf archives/ARCHIVEID

Install CGI Scripts

Link the collections CGI scripts to the EPrints CGI directory:

ln -s /opt/eprints3/archives/ARCHIVEID/cgi/collectionselect/ /opt/eprints3/cgi/

Edit Core Files

perl_lib/EPrints/Plugin/Screen/EPrint.pm

Look for the workflow subroutine in this file and comment out the following line:

$self->{processor}->{$cache_id} = EPrints::Workflow->new( $self->{session}, "default", %opts );

Then add in the following two lines:

my $workflow_id = $self->workflow_id;
$self->{processor}->{$cache_id} = EPrints::Workflow->new( $self->{session}, $workflow_id, %opts );

Finally after the workflow subroutine add the following subroutine;

sub workflow_id
{
        return 'default';
}

Update Database Tables

The OneShare collections package requires an additional database field. To get this setup all you need to do is run;

bin/epadmin update_database_structure test1

Restart Web Server

Once you have completed all of these previous steps, you will need to restart your web server in the usual fashion.

Testing

1. Login as a user to your EPrints install and go to the Manage Deposits page. There should be a new button labelled Create Collection.
2. First ensure that you can still create an EPrint in the usual manner using New Item.
3. Head back to the Manage Deposits page and choose Create Collection.
4. Give your collection a name.
5. Search for an EPrint and add it to the collection, it should appear in a list in the Items In The Collection section.
6. Remove that EPrint from the collection by clearing the tick next to it, the list should now be empty.
7. Add an EPrint from My Deposits.
8. Submit the Collection and deposit it in the standard way.
9. Go to the appropriate resource page for the published collection and ensure that there is the correct number of items in the collection.

Bugs

Please report all bugs to the OneShare Bugtracker. There is a project setup for OneShare collections called OneShare Packages >> Collections.