Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Documenting DS-3123

...

If you enable versioning, is it possible that the name and email of the submitter are shown to all users in Version history. The way to circumvent this is to make Version history visible to admins only by setting

versioning.item.history.include.submitter=false

in [dspace]/config/modules/versioning.cfg.

Warning
titleAIP Backup & Restore functionality only works with the Latest Version of Items

If you are using the AIP Backup and Restore functionality to backup / restore / migrate DSpace Content, you must be aware that the "Item Level Versioning" feature is not yet compatible with AIP Backup & Restore. Using them together may result in accidental data loss.  Currently the AIPs that DSpace generates only store the latest version of an Item.  Therefore, past versions of Items will always be lost when you perform a restore / replace using AIP tools. See DS-1382.

Warning
titleVersioning history exposes data that may be considered personal

Enabling Item Level Versioning

By default, Item Level Versioning is disabled in DSpace 3, 4, 5 and 56.

Info
Starting from DSpace 4.0, Item Level Versioning is also supported in JSPUI.

...

If you wish to enable this feature, you just have to edit the versioning.enabled  settings in your [dspace]/config/modules/versioning.cfg cfg file. Alternatively, you may override it in your local.cfg config (see Configuration Reference).

...

An overview of the version history, including links to older versions of an item, is available at the bottom of an Item View page. The repository administrator can decide whether the version history should be available to all users or restricted to administratorsthe version history should be available to all users or restricted to administrators. Since DSpace 6 the repository administrator can decide whether all users should be able to see the version submitter/editor or if this information is restricted and can be seen by administrators only. As this may expose data that my be considered personal (name and email address of the submitter), we encourage everyone to leave the default setting and reveal those information to administrators only.

Architecture

Versioning model

...

Code Block
<!-- Default Item Versioning Provider, defines behavior for replicating
     Item, Metadata, Budles and Bitstreams. Autowired at this time. -->
<bean class="org.dspace.versioning.DefaultItemVersionProvider">
    <property name="ignoredMetadataFields">
         <set>
            <value>dc.date.accessioned</value>
            <value>dc.description.provenance</value>
         </set>
    </property>
</bean>

 

Identifier Service Override

...

The version history is added on the bottom of a versioned item page. A repository administrator can either decide to show this to all users, or restrict it to admins only. If it is shown to admins only, an end user will have no way to find the way to an older version. For JSPUI Since DSpace 6 you can also configure if the submitter's name and email address should be part of the version history or if they should be hidden (see below). For XMLUI you currently do not have this choice and the submitter's name and email address will be publicly exposed to everyone able to see the version history . This or if they should be hidden. To show the submitter might actually be useful if the editor account is always a generic institutional email address, but may conflict with local privacy laws if any personal details are included in this account. If you want to step in and enhance the XMLUI to respect the configuration option, please join the discussion here: JIRA DS-1349 - Item Level Versioning exposes personal data.

Hide Submitter details in

...

version table

In either the [dspace]/config/modules/versioning.cfg configuration file or your local.cfg, you can customize the configuration option versioning.item.history.include.submitter. By default this is set to false, which means that information about the submitter is only viewable by administrators. If you want to expose the submitters information to everyone (which be useful if all submitters uses generic institutional email addresses, but may conflict with local privacy laws if personal details are included) you can set this configuration property to true.

Code Block
# The property item.history.include.submitter controls whether the name of
# the submitter of a version should be included in the version history of
# an item. This property is currently used in JSPUI only.
versioning.item.history.include.submitter=false

...