Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Configuring and using Embargo in DSpace Submission User Interface

Info
titleAvailable in DSpace 7.2 and above

In DSpace 7.2 and above, both Item-level embargoes and bitstream (file) level embargoes are supported in the Submission user interface.
In DSpace 7.1 and 7.0, the Submission user interface only supported embargoes on specified bitstreams (files).  However, item-level embargoes could be added after submissions were accepted

Warning

Item-level embargo is not yet supported in DSpace 7.0 in the Submission user interface.  In the Submission UI, only embargoes on specific bitstreams (files) is supported. However, you can add an item-level embargo in DSpace 7.0 using the "Manage Embargoes on existing Items" approach described above.

Enabling Item

...

-level Embargo

While Bitstream-level embargoes are enabled by default, Item-level embargoes currently are not.  However, enabling them is easy.  Simply update your item-submission.xml to include this tag in your <submission-process>:

Code Block
<submission-process name="traditional">
   ...
   
   <!-- This step enables embargoes and other access restrictions at the Item level -->
   <step id="itemAccessConditions"/>
</submission-process>

After making this update, you will need to restart your backend (REST API) for the changes to take effect.

Configuring Embargo / Access Restriction options

Starting in DSpace 7, embargo (and lease) settings are configurable via a Spring Bean configuration file file [dspace]/config/spring/api/access-conditions.xmlFor detailed information on configuring your Embargo options (and other related options like lease or restrict to a particular group of users)-conditions.xml

For detailed information on configuring your Embargo options (and other related options like lease or restrict to a particular group of users), see the Submission User Interface documentation. Specifically these two sections:

  • For Bitstream embargo / access options, see the section on "Configuring the File Upload step" of the Submission User Interface
  • For Item embargo / access options, see the section on "Configuring the

...

...

Private/Public (or Non-Discoverable/Discoverable) Item

It is also possible to adjust the Private/Public Public (or Non-Discoverable/Discoverable) state of an item after it has been archived in the repository.  This can be achieved from either the "Admin Search" (/admin/search), or from the "Status" tab under "Edit Item".

Private (or non-Discoverable) items are not retrievable through the DSpace search, browse or Discovery indexes.  However, they are accessible via a direct link.  It is possible to create a publicly accessible, non-discoverable item...in which case it can only be shared via a direct link.  But, once anyone has that link, it is available anonymously.

Therefore, an "Admin Search" option is provided, which allows you to search across all items, including private or withdrawn items.  You can also filter your results to display only private items.

...

This ability to create/initialize embargoes via metadata is extremely powerful if you wish to submit embargoed content via electronic means (such as Importing Items via Simple Archive FormatSWORDv1SWORDv2, etc).

...