SUNScholar/Embargo Systems/4.X

From Libopedia
Jump to navigation Jump to search
Back to Embargo Systems

Introduction

There is a MAJOR change in the embargo functionality with DSpace versions =>3.2 when using the XMLUI.

There is a basic and an advanced policy method for setting embargoes.

Embargoes can be set during submission of an item or retroactively set after submission.

Read carefully and prepare yourself during an upgrade.

Also see:

https://jira.duraspace.org/browse/DS-3218

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.

See example below:

# Special Group for UI: all the groups nested inside this group
# will be loaded in the multiple select list of the RestrictStep
xmlui.submission.restrictstep.groups=Anonymous      
xmlui.submission.restrictstep.enableAdvancedForm=false

Step 2 - Enable Embargoes During Submission

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/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 3 - Rebuild webapps

Click on the heading above.

References