Editing User Agreement

DSpace 10 allows to edit the User Agreement displayed when the user logs into the system for the first time.

Access to the Functionality

User Agreement edit page can be accessed using the administrator sidebar:

This menu entry is configurable with an i18n label on the Angular side. The key is: menu.section.edit-user-agreement.

Functionality Overview

User Agreement page allows for editing User Agreement shown when the user logs in for the first time. You can edit the User Agreement for all languages specified under the languages section in your config.yml file.

markdown:
  enabled: true

Once you edit the metadata for a specific language and clicking the Save button at the bottom of the page, you have an option to either save the new User Agreement only for new users or force all users to accept the edited User Agreement again:

If you select the red button above, all users will be forced to accept the user license agreement upon website refresh or another login:

Metadata schema

In DSpace 10, in order to determine whether a user has accepted the End User Agreement a metadata field called dspace.agreement.end-user is used. When this metadata exists on a user, the system assumes they have agreed to the Agreement.
The content of the End User Agreement is stored in the dc.rights metadata on the Site object fetched using the SiteService.find() function. When entering the End User Agreement page, DSpace 10 will attempt to find the value of this metadata in the language of the user that is trying to log in. If the metadata field entry with the correct language is not specified, the End User Agreement content for the English language will be used.
If there are is no entry for the dc.rights metadata in both the target language and in English, the default DSpace End User Agreement is used.