Add ability to archive books and collections via settings
Context
Users should be able to use settings to meet Bookshelf agreements requirements to accurately display status and updates, and we should also be able to migrate these settings for legacy content for same reasons.
We delayed "Archive" functionality as an Action / Button via the UI because we said we could still handle this through BCMS settings, but as we try to do Greenlight testing early, we find we cannot archive any domain (or any books and collections) via settings to support our agreements. We also need to migrate these settings for version control pre-deployment.
Proposal
In wholebooks and Word complete books we already have a section called 'Archiving and updating' with settings:
- 'Create version link'
- 'Version link text'
- 'Version link URI'
Extended feature:
- In wholebooks and Word complete books settings UI: add the new Domain Status dropdown to the exisiting 'Archiving and updating' section
- In Chapter-processed book settings UI: add only the 'Archiving and updating' section heading and the new Domain Status dropdown in the design below. 1.In Collection settings UI: add only the 'Archiving and updating' section heading and the new Domain Status dropdown in the design below.
Allow the user to choose the status of this domain, from three options:
- Current --> The default option. When selected, the domain settings are
'archive-version: no'
, and'validity: valid'
- Archived --> When is selected, the domain settings are:
'archive-version: yes'
, and'validity: expired'
. - Withdrawn --> editable by Sys admins only. When selected, the domain settings are
'archive-version: yes'
, and'validity: withdrawn'
.
Note for book template functionality: Even though this setting only shows in the UI after set up, it exists in book's template. Therefore the domain settings that correspond to the choice "Current" must be set in the chapter-processed and wholebook clone domains.
The options are mutually exclusive (you can't choose more than one at a time) so a dropdown is suitable in order to make the user choose one.
The tooltip text is: Indicates the status of the domain on the Bookshelf site. Note, Withdrawn is only selectable by System admins.
Design
Chapter processed books and collections domain status default
Chapter processed books and collections domain status non-System admin options
Chapter processed books and collections domain status System admin options
Wholebooks domain status default
Wholebooks domain status non-System admin options
Wholebooks domain status System admin options
Implementation (if applicable)
Alternative approaches (if applicable)
Acceptance Criteria
-
In settings, Editors, Org Admin, System Admin can "Archive" content no longer current by indicating it has Expired and it is an Archive version, AND if these are selected -
The book on NCBI websites will appear with an Archive banner and Indication at the top of the page that it is no longer current, like this: https://www.ncbi.nlm.nih.gov/books/NBK33514/
-
-
In settings, System Admin can "Withdraw" content that should have the full text no longer display by indicating it has been Withdrawn, AND if these are selected -
The book on NCBI websites will have a Withdrawn notice along with its metadata and no full text will appear
-
-
Tool tips will be provided for each of the settings above clearly indicating what that setting will do
Scheduling
Schedule this feature to be scoped and designed for Epic: