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.

Selection

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

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

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.

Here is an extract from the new file: 

<!--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 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>
        -->

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

Advanced Embargo Settings

https://wiki.duraspace.org/display/DSDOC3x/Embargo#Embargo-AdvancedEmbargoSettings

Daily task

The "embargo-lifter" task must be run daily. See below for details. 

dspace@dspace:~$ sudo /home/dspace/bin/dspace embargo-lifter -h
 INFO [main] (DSpaceKernelInit.java:52) - Created new kernel: DSpaceKernel:org.dspace:name=e1d37331-cd5c-48f4-a4b0-b78a50102807,type=DSpaceKernel:lastLoad=null:loadTime=0:running=false:kernel=null
 INFO [main] (ConfigurationManager.java:1224) - Loading from classloader: file:/home/dspace/config/dspace.cfg
 INFO [main] (ConfigurationManager.java:1224) - Using dspace provided log configuration (log.init.config)
 INFO [main] (ConfigurationManager.java:1224) - Loading: /home/dspace/config/log4j.properties
usage: org.dspace.embargo.EmbargoManager
 -a,--adjust        Function: Adjust bitstreams policies
 -c,--check         Function: ONLY check the state of embargoed Items, do
                    NOT lift any embargoes.
 -h,--help          help
 -i,--identifier    Process ONLY this Handle identifier(s), which must be
                    an Item.  Can be repeated.
 -l,--lift          Function: ONLY lift embargoes, do NOT check the state
                    of any embargoed Items.
 -n,--dryrun        Do not change anything in the data model, print
                    message instead.
 -q,--quiet         Do not print anything except for errors.
 -v,--verbose       Print a line describing action taken for each
                    embargoed Item found.

References

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