submit cover images separately
In #739 (closed), we decided to decouple ingest and cover image submissions. This applies to both wholebook and chapter-processed domains. This also applies to collection covers (there is no difference between a collection and a wholebook in terms of NCBI's processing).
NCBI needs two things:
- the physical image (ex.
- the domain name
- User adds or updates a cover image in the book or collection metadata UI
- BCMS creates package: Zip the image together with a JSON file detailing the domain: ex
foobar.json. JSON contains
- submit to FTP dir:
- Processing errors NCBI-side should be very rare, but are no impossible. In these cases NCBI sends a receipt via Kafka to a dedicated topic
- BCMS sends email notification for the errors reported (to be defined in #511
Some refinements of the spec:
- json/zip file names are expected to match
- zip package must contain exactly one image
- JSON must include the fields
Receipts are sent to the Kafka topic
cover_receipt. Notifications contain:
package_id: the BCMS reference ID for the package
status: 0=success, 3=failure
thumb: the name of the converted cover (not really useful, but included anyways)
notices: a list of error and/or warning notices
In production, the FTP is polled once a day, at 6.30 pm.= In development, I'll keep it at every minute - to facilitate dev work.
The complete process for cover thumbs looks like this:
- Cover thumbs get submitted to a dedicated location on the PMC file system - on a rolling basis
- Images get picked up from #1 and submitted to a VCS - twice a day, at 10am and 7pm
- Images get synced from the VCS to NCBI web fronts - once a day, at 3am
This process here only covers step #1!
In development, steps #2 and #3 are not executed - so @lathrops1 , @DioneMentis: do not expect any thumbs for all those test domains to show up. You cannot verify that the process works by looking at the preview site. @John.kopanas can verify it based on what he gets from Kafka.
- Covers submitted to BCMS display on NCBI Bookshelf web pages per NCBI rendering rules after covers are passed to NCBI from BCMS and committed and distributed by NCBI