Create and update a collection domain
(Updated 17 Sept)
Create collection domain
- NCBI sys admin creates a new collection
example
in Org A in the BCMS (New collection modal, step 1) - BCMC send a create domain request
{
"domain": "examplecollect", // New domain name to create. Must match ^[a-z]+collect$ (start with a letter and only contains alphanumeric chars plus underscore)
"publisher": "OrgA", // Content publisher, must exist in PMCBook already.
"title": "New collection", // Collection title
"clone_from": "clonecollect" // Collections domain name to clone attributes from, must exist in PMC book already
}
- the create domain call adds
examplecollect
tobook_collection_list
if the domain name matches^\[a-z\]+collect$
here https://preview.ncbi.nlm.nih.gov/books/domain-service/domains/
Update collection domain
- Sys admin selects relevant settings
- On save, update domain request is sent
attributes__name | BCMS setting |
---|---|
toc-pub-info | Display book metadata on TOC: full book citations |
collection-auto-rebuild | NO if group by "custom group titles" is selected; YES for all other collection-group values |
collection-sort | Order book by |
collection-group | Group books by |
For collection-group
:
- Current--Archived --> update
status
- Current by year--Archived --> update
year-status
[original issue]
As confirmed in https://gitlab.coko.foundation/ncbi/ncbi/-/issues/226#note_62841:
A collection is just another domain with collect
name suffix and certain attributes.
- Create a collection: send 'create domain' request. Domain name should end in
collect
. I.e. to create collection 'example' domain name should beexamplecollect
. - Update domain to set certain domain attributes:
- collection-name: same rules as for domain name, i.e.
examplecollect
. This is required attribute - Collection: auto-rebuild (optional)
- Collection: sort by (optional)
- Collection: group by (optional)
- Show publication info on TOC (optional)
- collection-name: same rules as for domain name, i.e.