SUNScholar/Embargo Systems/1.8.X

Back to Embargo Systems

Introduction

There are two methods for setting an embargo with DSpace versions => 1.6.2 and <= 1.8.2, namely;

• By manually inputing a lift date upon submission of an item.
• By selecting an embargo term upon submission of an item, where term means "length of time".

We tried both methods but the terms method did not work with DSpace versions => 1.6.2 and <= 1.8.2.

Only one method may be setup.

Also see: http://wiki.lib.sun.ac.za/index.php/SUNScholar/Embargo

DSpace config settings

The following are our DSpace config settings.

#### Embargo Settings ####
# DC metadata field to hold the user-supplied embargo terms
embargo.field.terms = dc.embargo.terms
# DC metadata field to hold computed "lift date" of embargo
embargo.field.lift = dc.embargo.lift
# string in terms field to indicate indefinite embargo
embargo.terms.open = forever
# implementation of embargo setter plugin - replace with local implementation if applicable
plugin.single.org.dspace.embargo.EmbargoSetter = org.dspace.embargo.DefaultEmbargoSetter
# DC metadata field to hold computed "lift date" of embargo
#embargo.terms.days = None:0, 6 months:180, 1 year:365, 18 months:545, 2 years:730
# implementation of embargo lifter plugin - - replace with local implementation if applicable
plugin.single.org.dspace.embargo.EmbargoLifter = org.dspace.embargo.DefaultEmbargoLifter

Extra DSpace metadata fields

We added the following dc fields in the dublin core metadata schema:

dc.embargo.terms

dc.embargo.lift

Modified input form for inputing a lift date

We modified the input.xml file in the source DSpace config folder so that an embargo can be specified upon submission of an item:

<!-- The embargo terms input. Added by H Hgibson -->
	<field>
         <dc-schema>dc</dc-schema>
         <dc-element>embargo</dc-element>
         <dc-qualifier>terms</dc-qualifier>
         <repeatable>false</repeatable>
         <label>Embargo Terms</label>
         <input-type>onebox</input-type>
         <hint>If required, enter date in 'yyyy-mm-dd' format when the embargo expires or '2050/01/01' for indefinite.</hint>
         <required></required>
         </field>

Modified input form for terms method

If using the terms method, the lift date would be calculated by the embargo setter. Below is the input form modification required for the term method.

<!-- Embargo terms for dropdown input. Added by H Gibson -->
	<value-pairs value-pairs-name="embargo_terms" dc-term="embargo.terms">
     <pair>
       <displayed-value>None</displayed-value>
       <stored-value>None</stored-value>
     </pair>
     <pair>
       <displayed-value>6 months</displayed-value>
       <stored-value>6 months</stored-value>
     </pair>
     <pair>
       <displayed-value>1 year</displayed-value>
       <stored-value>1 year</stored-value>
     </pair>
     <pair>
       <displayed-value>18 months</displayed-value>
       <stored-value>18 months</stored-value>
     </pair>
     <pair>
       <displayed-value>2 years</displayed-value>
       <stored-value>2 years</stored-value>
     </pair>
   </value-pairs>

   <value-pairs value-pairs-name="absolute_valueUnit" dc-term="type">
     <pair>
       <displayed-value>Percentage</displayed-value>
       <stored-value>Percentage</stored-value>
     </pair>
   </value-pairs>

They match the terms in #embargo.terms.days = None:0, 6 months:180, 1 year:365, 18 months:545, 2 years:730 in the DSpace config file.

Retroactive embargo setting

We manually input the embargo lift and settings metadata per item. Then we manually remove the item read permissions.

Daily cron job

Click on the heading above. This will check for the lifting of embargoes daily.

References

• https://wiki.duraspace.org/display/DSDOC18/Embargo

Back to Embargo Systems