SUNScholar/Embargo Systems/3.X

From Libopedia
Jump to navigation Jump to search

Please note: This feature was released with DSpace version 3.2 and therefore not fully tried and tested.

You apply this feature at your own risk.

Introduction

There is a MAJOR change in the embargo function with DSpace 3.2 when using the XMLUI.

Read carefully and prepare yourself during an upgrade.

Note for DSpace 3.2

The wording for the simple embargo form was confusing users, so the following were submitted to change the wording:

With our repository we updated the messages.xml file with the changes incorporated for DSpace 4.0.

Note for upgrade from 1.8.2 to 3.2

If you enabled embargoes in 1.8.2 then make sure to remove the embargo date option in your customsied input-forms.xml file.

See: http://wiki.lib.sun.ac.za/index.php/SUNScholar/Embargo_Systems/1.8.2#Modified_input_form_for_inputing_a_lift_date

Step 1 - Select simple or advanced embargo

The user has an opportunity to choose between, simple or advanced embargo settings.

To switch between the two, you need to set following variable in the dspace.cfg file. 

xmlui.submission.restrictstep.enableAdvancedForm=false

At Stellenbosch University with SUNScholar we have chosen to stay with the "simple" embargo method.

Step 2 - Pre-3.0 Embargo Migration Routine

A migration routine has been developed to migrate the current embargo to the new one.

To execute it, run the following command: 

/home/dspace/bin/dspace migrate-embargo -a

And then: 

/home/dspace/bin/dspace embargo-lifter -a -v

And then: 

/home/dspace/bin/dspace embargo-lifter -c -v

Step 3- Enable Embargoes

To enable the new embargo changes are required to the item-submission.xml file, located in your config directory. This file determines which steps are executed in the submission of a new item.

Two new submission steps have been introduced in the file. By default, they are not activated yet:

  • AccessStep: the step in which the user can set the embargo at item level, effectively restricting access to the item metadata.
  • UploadWithEmbargoStep: the step in which the user can set the embargo at bitstream level. If this step is enabled, the old UploadStep must be disabled, leaving both steps enabled will result in a system failure.

To enable the new embargo, ensure that the new steps are uncommented, while the old UploadStep needs to be commented out.

Type the following to edit the submission file: 

nano /home/dspace/source/dspace/config/item-submission.xml

See example below. 

       <!--Step 3 will be to Manage Item access.-->
       <step>
           <heading>submit.progressbar.access</heading>
           <processing-class>org.dspace.submit.step.AccessStep</processing-class>
           <xmlui-binding>org.dspace.app.xmlui.aspect.submission.submit.AccessStep</xmlui-binding>
           <workflow-editable>true</workflow-editable>
       </step>

       <!--Step 4 will be to Upload the item   
       <step>
          <heading>submit.progressbar.upload</heading>
          <processing-class>org.dspace.submit.step.UploadStep</processing-class>
          <jspui-binding>org.dspace.app.webui.submit.step.JSPUploadStep</jspui-binding>
          <xmlui-binding>org.dspace.app.xmlui.aspect.submission.submit.UploadStep</xmlui-binding>
          <workflow-editable>true</workflow-editable>
       </step>
      -->

       <!-- Step 4 Upload Item with Embargo Features (not supported in JSPUI)
            to enable this step, please make sure to comment-out the previous step "UploadStep" -->
       <step>
          <heading>submit.progressbar.upload</heading>
          <processing-class>org.dspace.submit.step.UploadWithEmbargoStep</processing-class>
          <xmlui-binding>org.dspace.app.xmlui.aspect.submission.submit.UploadWithEmbargoStep</xmlui-binding>
          <workflow-editable>true</workflow-editable>
       </step>

Step 4 - Rebuild webapps

Go to: http://wiki.lib.sun.ac.za/index.php/SUNScholar/Rebuild_DSpace and rebuild the webapps.

Step 5 - Update daily task

Go to: http://wiki.lib.sun.ac.za/index.php/SUNScholar/Daily_Admin and update daily admin tasks.

See below for daily options. 

usage: /home/dspace/bin/dspace embargo-lifter

 -a,--adjust        Function: Adjust bitstreams policies
 -l,--lift          Function: ONLY lift embargoes, do NOT check the state
                    of any embargoed Items.
 -c,--check         Function: ONLY check the state of embargoed Items, do
                    NOT lift any embargoes.
 -v,--verbose       Print a line describing action taken for each
                    embargoed Item found.
 -i,--identifier    Process ONLY this Handle identifier(s), which must be
                    an Item.  Can be repeated.
 -n,--dryrun        Do not change anything in the data model, print
                    message instead.
 -q,--quiet         Do not print anything except for errors.
 -h,--help          help

References

Back to Embargo Systems
Retrieved from "http://wiki.lib.sun.ac.za/index.php?title=SUNScholar/Embargo_Systems/3.X&oldid=23210"