Editing EP2DCOverview (section)

=EP2DC Plugin Installation=

Installation of EP2DC at an existing EPrints repository (version 3.1 or higher) has been designed to be a simple as possible.

==Prerequisites==

PERL modules, all of which are available from CPAN:
* LWP::UserAgent
* HTTP::Request::Common
* Authen::NTLM
* LWP::Authen::Ntlm
* HTML::Entities

==Install==

Assuming the EPrints install path is /opt/eprints3, and that the name of your archive is ARCHIVE_ID, the following actions are required to install the EP2DC plugin:

* <code>cd /opt/eprints3/archives/ARCHIVE_ID</code>

* <code>cp mdc-1.0.tar.gz .</code>

* <code>tar zxvf mdc-1.0.tar.gz</code>
This will copy most of the files at the right location.

* <code>cd /opt/eprints3/archives/ARCHIVE_ID/cfg/cfg.d</code>

* Edit '''document_fields_default.pl''', adding the following:
        $data->{ep2dc_is_validated} = 'TRUE';
Save the changes.

* Edit '''document_fields.pl''', adding the following field definitions:
        {
                name => "ep2dc_is_data",
                type => "boolean",
        },
        {
                name => "ep2dc_is_validated",
                type => "boolean",
        },
        {
                name => "ep2dc_data_centre",
                type => "set",
                options => [ "mdc", "ndc", "amcc" ],
        },
        {
                name => "ep2dc_test_type",
                type => "set",
                options => [ "tensile", "creep", "fatigue", "impact", "fcg", "ccg" ],
        },
        {
                name => "ep2dc_test_date",
                type => "date",
        },
        {
                name => "ep2dc_test_centre",
                type => "longtext",
        },
        {
                name => "ep2dc_object_id",
                type => "text",
        },
        {
                name => "ep2dc_security",
                type => "set",
                options => [ "openaccess", "restricted", "ondemand" ]
        }
Save the changes.

* Edit '''eprint_warnings.pl''', adding the following to the end of the file:
        push @problems, $session->make_text( "After clicking the deposit button, all EP2DC data files will automatically be transferred to the selected datacentre(s)." );
Save the changes.

* Edit '''eprint_render.pl''' as follows:
Look for the following piece of code:
        my @documents = $eprint->get_all_documents();
Replace with:
        my @documents = $eprint->get_all_documents(0);
Look for the following piece of code:
        if( defined $files{$doc->get_main} )
Replace with:
        if( defined $files{$doc->get_main} && !$doc->is_data() )
Where you want to display the EP2DC datasets, add the following:
        my $data_container = $session->make_element( "div", id => "ep_datadocs_container", style=>"width:80%;margin:auto;" );
        $page->appendChild( $data_container );
        my $wait_p = $session->make_element( "p", style=>"vertical-align: middle;width:100%;text-align:center;" );
        $data_container->appendChild( $wait_p );
        my $wait_img = $session->make_element( "img", border => "0", src => "/images/ajax_waiting.gif" );
        $wait_p->appendChild( $session->make_text( "Loading datasets...   " ) );
        $wait_p->appendChild( $wait_img );
        $page->appendChild( $session->make_javascript( "var datadocs = new Ajax.Updater( 'ep_datadocs_container', '/cgi/render_data_docs?eprintid=".$eprint->get_id."', { method:'get', onComplete: function(req) { \$('ep_datadocs_container').innerHTML = req.responseText;} } );" ) );
Save the changes.

* Update your workflow file in order to enable the upload of XML datasets to your EPrints repository:

Edit '''/opt/eprints3/archives/ARCHIVE_ID/cfg/worklows/eprint/default.xml''', add the following stage definition (between the <flow> tags): 

<code>
       <stage ref="data"/>
</code> 

and add the stage:

<code>
        <stage name="data">
                <component type="XHTML"><epc:phrase ref="Plugin/InputForm/Component/EP2DCUpload:help" /></component>
                <component type="EP2DCUpload">
                        <upload-methods>
                                <method>file</method>
                        </upload-methods>
                        <field ref="ep2dc_data_centre" required="yes" />
                        <field ref="ep2dc_test_type" required="yes" />
                        <field ref="ep2dc_test_date" required="yes" />
                        <field ref="ep2dc_test_centre" required="yes" />
                        <field ref="ep2dc_security" required="yes" />
                </component>
        </stage>
</code>



* Add the new fields to the database with <code>/opt/eprints3/bin/epadmin update_database_structure ARCHIVE_ID</code>

* Link the CGI scripts to EPrints with <code>ln -s /opt/eprints3/archives/ARCHIVE_ID/cgi/* /opt/eprints3/cgi/</code>

* Restart your web server, as root with <code>/etc/init.d/httpd restart</code>
 (note that this line might be different depending on which version of Linux you are running).