Set Up - Use cases for Collection / Book Creation
Thanks @John.kopanas for creating this issue, but I'm editing it so it is completely accurate in the entire set up context. If you want to add technical notes below after reading this, that would be fine.
Bookshelf has two main ways of creating books:
- Manual
- Auto-Create
(1) The Manual Create Book may be done under these scenarios:
- It is a Word workflow chapter-processed book__
In this case the set-up is a one-time only thing for a long terms project with possibly many chapter submissions in the future. No publisher or collection clone is required for this set up.
NOTE: ALL Word books will be MANUALLY MIGRATED to the BCMS because of unclear mapping rules so there must be a way to link existing NCBI domains to the newly created BCMS books.
- In the XML or PDF workflow, Bookshelf Staff or a Submitter Role needs to create a book or collection within an organization__
In this case the new book should clone from a publisher domain clone AND metadata template. This may happen if it is the first book sample for a publisher, a publisher is unable to post to FTP, Bookshelf staff must MANUALLY MIGRATE content because it does not map one-to-one for scripted migration or must be migrated in a later phase because of lack of support at launch, or the domain is a collection within a publisher, etc.
Both chapter and book processed books needs to be supported here.
Book processed books may be updated or have missing parts added at any time.
Chapter processed books may be updated or have new published versions. At point of migration the published version MAY not be "1" and will need to be recorded accurately.
- In the XML or PDF workflow, Bookshelf Staff or a Submitter Roles needs to create a book within a collection__
In this case the new books should clone from a collection domain clone and metadata template. This may happen if a submitter (or Bookshelf staff on launch) needs to manually create a domain for their content because they cannot meet FTP file submission specifications. TBD, how to handle funded content that SHOULD best allow a user to upload files with grant all at once.
Both chapter and book processed books needs to be supported here.
Book processed books may be updated or have missing parts added at any time.
Chapter processed books may be updated or have new published versions.
(2) The Auto Create Book may be done under these scenarios:
- In the XML or PDF worflow, a submitter posts a book that does not belong to a collection to FTP.__
In this case the new auto-created book should clone from a publisher domain clone AND metadata template.
Both chapter and book processed books needs to be supported here.
Book processed books may be updated or have missing parts added at any time.
Chapter processed books may be updated or have new published versions.
- In the XML or PDF workflow, a submitter posts a book that belongs to a collection to FTP.__
In this case the new auto-craeted books should clone from a collection domain clone and metadata template.
Both chapter and book processed books needs to be supported here.
Book processed books may be updated or have missing parts added at any time.
Chapter processed books may be updated or have new published versions.
- In the XML or PDF workflow, NCBI Bookshelf staff migrates content not in its current CMS into BCMS after launch via FTP__
This is likely to happen given the phased-development approach to the BCMS
Both chapter and book processed books needs to be supported here.
Chapter processed books may be updated or have new published versions. At point of migration the published version MAY not be "1" and will need to be recorded accurately.