Difference between revisions of "SUNScholar/Embargo Systems/3.X"

From Libopedia
Jump to navigation Jump to search
 
(72 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
<center>
 +
'''[[SUNScholar/Embargo Systems|Back to Embargo Systems]]'''
 +
</center>
 +
 
==Introduction==
 
==Introduction==
−
See: https://wiki.duraspace.org/display/DSDOC3x/Embargo
+
'''<font color="red">There was a MAJOR change in the embargo functionality with the release of DSpace versions 3.2 when using the XMLUI.</font>'''
  
−
As a DSpace administrator, you can choose to integrate either Simple or Advanced dialog screens as part of the item submission process.
+
There is a basic and an advanced policy method for setting embargoes.
  
−
This preference is stored in the dspace.cfg value '''xmlui.submission.restrictstep.enableAdvancedForm'''.
+
''Embargoes can be set during submission of an item or retroactively set after submission.''
  
−
==Simple Embargo Settings==
+
''Read carefully and prepare yourself during an upgrade.'
−
https://wiki.duraspace.org/display/DSDOC3x/Embargo#Embargo-SimpleEmbargoSettings
 
  
−
==Advanced Embargo Settings==
+
Also see:
−
  https://wiki.duraspace.org/display/DSDOC3x/Embargo#Embargo-AdvancedEmbargoSettings
+
  https://jira.duraspace.org/browse/DS-3218
  
−
==Daily task==
+
==<font color="red">'''Urgent Notice'''</font>==
−
The "embargo-lifter" task must be run daily. See below for details.
+
The wording for the simple embargo form was confusing users, so the following were submitted to change the wording:
 +
*https://jira.duraspace.org/browse/DS-1709
 +
*https://jira.duraspace.org/browse/DS-1764
 +
With our repository we updated the '''messages.xml''' file with the changes incorporated for DSpace 4.0.
 +
 
 +
See example below:
 
<pre>
 
<pre>
−
dspace@dspace:~$ sudo /home/dspace/bin/dspace embargo-lifter -h
+
    <!-- org.dspace.app.xmlui.Submission.submit.AccessStep -->
−
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
+
    <message key="xmlui.Submission.submit.AccessStep.head">Access Settings</message>
−
INFO [main] (ConfigurationManager.java:1224) - Loading from classloader: file:/home/dspace/config/dspace.cfg
+
    <message key="xmlui.Submission.submit.AccessStep.access_settings">Visible to a group of selected users (no selection needed for Anonymous)</message>
−
INFO [main] (ConfigurationManager.java:1224) - Using dspace provided log configuration (log.init.config)
+
    <message key="xmlui.Submission.submit.AccessStep.open_access">Item will be visible once accepted into archive</message>
−
INFO [main] (ConfigurationManager.java:1224) - Loading: /home/dspace/config/log4j.properties
+
    <message key="xmlui.Submission.submit.AccessStep.embargo">Embargo Access until Specific Date</message>
−
usage: org.dspace.embargo.EmbargoManager
+
    <message key="xmlui.Submission.submit.AccessStep.embargo_visible">Visible/Embargoed</message>
−
-a,--adjust        Function: Adjust bitstreams policies
+
    <message key="xmlui.Submission.submit.AccessStep.name">Name</message>
−
-c,--check        Function: ONLY check the state of embargoed Items, do
+
    <message key="xmlui.Submission.submit.AccessStep.description">Description</message>
−
                    NOT lift any embargoes.
+
    <message key="xmlui.Submission.submit.AccessStep.reason">Reason</message>
−
-h,--help          help
+
    <message key="xmlui.Submission.submit.AccessStep.submit_add_policy">Confirm Policy &amp; add another</message>
−
-i,--identifier    Process ONLY this Handle identifier(s), which must be
+
    <message key="xmlui.Submission.submit.AccessStep.list_assigned_groups">Groups</message>
−
                    an Item. Can be repeated.
+
    <message key="xmlui.Submission.submit.AccessStep.error_format_date">Error format date</message>
−
-l,--lift          Function: ONLY lift embargoes, do NOT check the state
+
    <message key="xmlui.Submission.submit.AccessStep.error_missing_date">When Embargo selected, date is required</message>
−
                    of any embargoed Items.
+
    <message key="xmlui.Submission.submit.AccessStep.error_duplicated_policy">An identical policy for this group and this action is already in place.</message>
−
-n,--dryrun        Do not change anything in the data model, print
+
    <message key="xmlui.Submission.submit.AccessStep.table_policies">Policies List</message>
−
                    message instead.
+
    <message key="xmlui.Submission.submit.AccessStep.private_settings">Private Item</message>
−
-q,--quiet        Do not print anything except for errors.
+
    <message key="xmlui.Submission.submit.AccessStep.private_settings_help">If selected, the item won't be searchable</message>
−
-v,--verbose      Print a line describing action taken for each
+
    <message key="xmlui.Submission.submit.AccessStep.column0">Name</message>
−
                    embargoed Item found.
+
    <message key="xmlui.Submission.submit.AccessStep.column1">Action</message>
 +
    <message key="xmlui.Submission.submit.AccessStep.column2">Group</message>
 +
    <message key="xmlui.Submission.submit.AccessStep.column3">Start Date</message>
 +
    <message key="xmlui.Submission.submit.AccessStep.column4">End Date</message>
 +
    <message key="xmlui.Submission.submit.AccessStep.table_edit_button">Edit</message>
 +
    <message key="xmlui.Submission.submit.AccessStep.table_delete_button">Remove</message>
 +
    <message key="xmlui.administrative.authorization.AccessStep.label_date_help">Accepted format: yyyy, yyyy-mm, yyyy-mm-dd</message>
 
</pre>
 
</pre>
 +
 +
==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.
 +
 +
See example below:
 +
<pre>
 +
# 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
 +
</pre>
 +
 +
==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/<u>[[SUNScholar/Install_DSpace/S03#Step_3.2|source]]</u>/dspace/config/item-submission.xml
 +
 +
See example below.
 +
<pre>
 +
      <!--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>
 +
</pre>
 +
 +
==[[SUNScholar/Rebuild_DSpace|Step 3 - Rebuild webapps]]==
 +
Click on the heading above.
 +
 +
==References==
 +
*https://wiki.duraspace.org/display/DSDOC3x/Embargo
 +
*https://wiki.duraspace.org/display/DSDOC3x/Managing+Embargoed+Content
 +
[[Category:Operations]]

Latest revision as of 00:30, 31 May 2016

Back to Embargo Systems

Introduction

There was a MAJOR change in the embargo functionality with the release of 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

Urgent Notice

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.

See example below: 

    <!-- org.dspace.app.xmlui.Submission.submit.AccessStep -->
    <message key="xmlui.Submission.submit.AccessStep.head">Access Settings</message>
    <message key="xmlui.Submission.submit.AccessStep.access_settings">Visible to a group of selected users (no selection needed for Anonymous)</message>
    <message key="xmlui.Submission.submit.AccessStep.open_access">Item will be visible once accepted into archive</message>
    <message key="xmlui.Submission.submit.AccessStep.embargo">Embargo Access until Specific Date</message>
    <message key="xmlui.Submission.submit.AccessStep.embargo_visible">Visible/Embargoed</message>
    <message key="xmlui.Submission.submit.AccessStep.name">Name</message>
    <message key="xmlui.Submission.submit.AccessStep.description">Description</message>
    <message key="xmlui.Submission.submit.AccessStep.reason">Reason</message>
    <message key="xmlui.Submission.submit.AccessStep.submit_add_policy">Confirm Policy & add another</message>
    <message key="xmlui.Submission.submit.AccessStep.list_assigned_groups">Groups</message>
    <message key="xmlui.Submission.submit.AccessStep.error_format_date">Error format date</message>
    <message key="xmlui.Submission.submit.AccessStep.error_missing_date">When Embargo selected, date is required</message>
    <message key="xmlui.Submission.submit.AccessStep.error_duplicated_policy">An identical policy for this group and this action is already in place.</message>
    <message key="xmlui.Submission.submit.AccessStep.table_policies">Policies List</message>
    <message key="xmlui.Submission.submit.AccessStep.private_settings">Private Item</message>
    <message key="xmlui.Submission.submit.AccessStep.private_settings_help">If selected, the item won't be searchable</message>
    <message key="xmlui.Submission.submit.AccessStep.column0">Name</message>
    <message key="xmlui.Submission.submit.AccessStep.column1">Action</message>
    <message key="xmlui.Submission.submit.AccessStep.column2">Group</message>
    <message key="xmlui.Submission.submit.AccessStep.column3">Start Date</message>
    <message key="xmlui.Submission.submit.AccessStep.column4">End Date</message>
    <message key="xmlui.Submission.submit.AccessStep.table_edit_button">Edit</message>
    <message key="xmlui.Submission.submit.AccessStep.table_delete_button">Remove</message>
    <message key="xmlui.administrative.authorization.AccessStep.label_date_help">Accepted format: yyyy, yyyy-mm, yyyy-mm-dd</message>

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.

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

Retrieved from "http://wiki.lib.sun.ac.za/index.php?title=SUNScholar/Embargo_Systems/3.X&oldid=42925"