My Tech-Notes

DSpace 6.3 – Embargo Configuration Guide

This guide explains how to configure and manage embargo (temporary access restriction) on items in a DSpace 6.3 repository. Embargo allows bitstreams to remain inaccessible to the public until a specified future date.

Step 1: Enable Embargo in Configuration

Edit the main DSpace configuration file:

nano [dspace]/config/dspace.cfg

Add or confirm the following settings:

# Enable embargo feature
embargo.enabled = true

# Metadata fields
embargo.field.terms = dc.embargo.terms
embargo.field.lift = dc.date.available

# Default embargo plugins
plugin.named.org.dspace.embargo.EmbargoSetter = org.dspace.embargo.DefaultEmbargoSetter
plugin.named.org.dspace.embargo.EmbargoLifter = org.dspace.embargo.DefaultEmbargoLifter

Save and close the file.

Step 2: Update Submission Form

To allow users to enter embargo dates during submission, edit:

nano [dspace]/config/input-forms.xml

In the <form name="traditional"> section, add this field:

<field>
  <dc-schema>dc</dc-schema>
  <dc-element>date</dc-element>
  <dc-qualifier>available</dc-qualifier>
  <label>Embargo Lift Date</label>
  <input-type>date</input-type>
  <hint>Enter the date after which this item will become publicly accessible</hint>
  <required>no</required>
</field>

Restart Tomcat to apply changes:

sudo systemctl restart tomcat7

Step 3: Submit Items with Embargo Dates

During submission:

Use the Embargo Lift Date field to enter a future date.
This sets the dc.date.available metadata field.
Bitstreams will be restricted from anonymous access until that date.

Step 4: Embargo Setter Behavior

When an embargo date is set:

Anonymous users cannot access bitstreams.
DSpace sets a future READ policy that activates on the embargo lift date.
The embargo lifter script will update access policies when the date is reached.

Step 5: Schedule the Embargo Lifter Script

You can run the embargo-lifter manually or schedule it.

Run manually:

[dspace]/bin/dspace embargo-lifter

Automate with Cron: Edit crontab:

crontab -e

Add this line to run daily at 2 AM:

0 2 * * * /home/dspace/dspace/bin/dspace embargo-lifter >> /home/dspace/embargo.log 2>&1

Step 6: Test Embargo Functionality

Submit an item and set a future embargo date.
Ensure anonymous users cannot access the bitstreams.
After the embargo date passes, run:
```
[dspace]/bin/dspace embargo-lifter 
```
Confirm that public access is now available.

Additional Notes

Embargo affects bitstream access, not metadata visibility.
To embargo metadata, custom workflows or development is needed.
You can write a custom EmbargoSetter class for advanced logic.