Collection Documentation
Updated 20211102 by @lathrops1
USER STORY
Bookshelf can review and accept collections of books and documents according to legal participant agreements. The BCMS needs to support this content type, including by setting it up as a domain component with its own contents, metadata, settings consistent with wholebook book ingest processing / integration / errors / preview specifications AS WELL as a container that editorial teams with supported users with clearly defined permissions may submit, track, and manage their books as book collection members. The collection as a container of these submitted book members must permit users to arrange the book members as they wish to display on Bookshelf according to rules for displaying those contents. The collection must also permit shared settings, metadata, grant templates and rules to be applied to it and all its members to support Bookshelf's current collection clone practices.
TECHNICAL TASKS
@DioneMentis to link approved development | technical tasks after scoping, design, and NCBI-Coko developement team review for each aspect of collections
ACCEPTANCE CRITERA
Create Collection
-
System admin are able to create a new collection via their Book | Collection dashboard -
A collection domain is created from an agreed PMCBook domain clone with necessary properties applied during creation in both the BCMS and NCBI PMCBook database via the PMCDomain service -
Any relevant metadata templates are applied to the collection domain when it is created in the BCMS and NCBI PMCBook database via the PMCDoamin service -
User can create a collection member settings and metadata templates to be applied to every book / chapter processed book added to the collection -
User can add a grant for the collection to be applied to every book added to the collection -
User can add a cover for the collection -
User can indicate via setting if the cover for the collection should be submitted for every book added to the collection -
User can add and update metadata and settings specific to JUST the collection domain
Collection Member Templates
-
System Admin can set up AND modify settings and metadata templates for minimal, common information that should be applied (cloned) to all new book | chapter processed books in any workflow added as a member of the collection to avoid processing | data accuracy errors. -
Templates in Phase 1 will ONLY apply to NEW collection members unless an exception is defined, such as preview approvals.
Collection Settings
-
Collection domains inherit settings from an agreed PMCBook clone domain managed by System Admin in PMCBook. -
Collection domains automatically receive particular settings based on its content type (e.g., collection member domain attribute) necessary for processing and display on Bookshelf -
Users can modify settings for the collection domain itself via a Settings page per agreed specifications - https://docs.google.com/spreadsheets/d/1Xd0vKDbaYrajfnUmYqCnXUY5Ir0znqc7o0KGVp_okg0/edit#gid=725030307 -
Collection domains will process and display accurately on the Bookshelf site(s) according to communicated settings via BCMS
Collection Meta
-
Collection inherits any common metadata from any Org templates for the Org(s) it belong -
Collection automatically receives particular metadta based on its content type (e.g., collection source type) necessary for processing and display on Bookshelf -
Users can modify minimally supported metadata for the collectin domain itself via Collection metadata UI fields; minimal criteria for supported fields is NCBI-only metadata, metadata that does not display on Bookshelf, AND current collection metadata communicated in the PDF workflow to taggers via templates -
Anytime collection metadata is added OR updated it is written into chapter-processed components (CHAPTER.XML, TOC.XML, COLLECTION.XML, PART.XML) AND loaded to PMC -
Any collection metadata written into XML is valid and meets Bookshelf tagging guidelines -
Collection metadata is passed to NCBI for wholebook XML conversion -
Collection metadata is passed to PDF2XML taggers for wholebook PDF tagging -
Collection metadata displays accurately on Bookshelf site pages
Collection Funding and Cover
-
System Admin | Org Admin | Editor can upload cover for the collection -
System Admin | Org Admin | Editor can indicate a cover for the collection should be applied to all new book members in the collection -
Covers display accurately on the Bookshelf site(s) -
System Admin | Org Admin | Editor can select a grant and funder via GrantHub API integration for the collection -
System Admin | Org Admin | Editor can indicate a grant and funder for the collection should be applied to all new book members in the collection -
In Phase 1, books in the collection can be retrieved accurately in a search by grant number and funder on the Bookshelf / PubMed site after indexing in those resources
Collection TOC Management
-
System Admin | Org Admin | Editor can set a setting whether they want their collection automatically grouped and ordered by NCBI OR if they want to manually order it -
IF System Admin | Org Admin | Editor select automatic collection build, then the BCMS will group and order the contents on the Collection Manager page per those group and sorting rules -
IF the BCMS cannot place a book member per the automatic grouping | sorting rules, it will palce the book member on the top of the collection page with a notification it cannot be placed -
IF BCMS provides a notification it cannot be placed automatically according to automatic group | sorting rules, user must resolve that notification by downloading book files, editing them, uploading them, and reprocessing them -
IF System Admin | Org Admin | Editor select manual groups, then the user can create a group and provide a title for that group -
IF System Admin | Org Admin | Editor select manual groups, then any new book member added to the collection will be added to the top of the collection page with a notification it cannot be grouped -
IF System Admin | Org Admin | Editor select manual sorting, then any new book member added to the collection will be added to the top of the collection page with a notificaiton it cannot be sorted -
IF BCMS provides a notification about a new book member that must be manually place, user must resolve that notification by moving to to the correct place or saying the placement is OK as is -
No COLLECTION.XML build will be generated if there is a notification about an inability to place a member -
Collection.XML will display accurately on the Bookshelf site(s)
Collection User Management
-
System Admin | Org Admin | Editors can be provided access to see, submit to, and manage a collection based on clear roles and permissions rules
Collection Processing, Tracking, and Management
-
Collection domains and domain attribute settings are created and updated per integration specifications -
Collection components are processed as wholebook ingests according to agreed integratin specifications -
The status of the collection domain and its landing page are clearly communicated in the BCMS Collection Manager page -
The collection landing page is available for view via the BCMS -
Any processing | failed state errors for creating the collection page will be provided clearly in the BCMS along with an ability to reprocess it
Collection Notifications
-
System Admin | Org Admin | Editors receive email notification when collection is created -
System Admin | Org Admin | Editors receive email notification when there is any change to collection settings or metadata -
System Admin | Org Admin | Editors receive email notification when any book is added to the collection, including a note in the message if the book cannot be placed in the TOC per any provided automatic rules -
System Admin | Org Admin | Editors receive email notification about all status changes about the collection domain, including failures in adding it to Bookshelf and when it is successfully published
Collection Search
-
System Admin | Org Admin | Editors can search the collection by book title and BCMSID - how find chapters if only chapter BCMSID provided in notifications? -
System Admin | Org Admin | Editors can filter the collection by source, type, status.