FTP integration: submitting PDF source files to collections
I'm creating a separate issue for PDF source submissions to collection specifically. See original issue #183 and #571 for discussion history.
Use cases
According to the submission specifications for PDF content: BOOK-PDFFileSubmissionSpecifications-080321-1545-138.pdf
-
Publisher posts new chapter PDF submission to an existing book in a collection -
Publisher posts new chapter PDF submission that creates a new book in a collection -
Publisher posts updated chapter PDF submission for use case 1 and 2 -
Publisher posts updated chapter PDF as a new publisher version to an existing book in a collection -
Publisher posts new book PDF submission that belongs to collection -
Publisher posts new book PDF submission that belongs to collection
Updated book-submit format:
ID names changed to: book-submit-id
and collection--submit-id
. If the book is created in the UI first, user should always use the ID provided in the email notification.
<book-submit>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book-submit SYSTEM "books-bulk-pdf.dtd">
<book-submit book-submit-id="cadthtest25"
doi="10.17226/25535" workflow="pdf"
submission-type="book">
</book-submit>
Integration spec
- NCBI will poll the FTP sites and pick up new submission packages posted by content providers.
- If a new submission is detected, a JSON notification message will be posted to Kafka
submit_package_receipt
topic. - CoKo will pick up the submission package from the specified path,
/ftp/submit/[package]
Updated JSON notification format:
{
"session_id": "10464956", // Reference ID for NCBI Task Manager session that picked up the submission
"status": 0,
"timestamp": "2021-04-26 08:09:06",
"package": "AHRQ/statstat.zip", // Path to the package data file in /ftp/submit/ directory, ex.
// /ftp/submit/AHRQ/hcup_sb261.zip. The package includes content files,
// manifest describing the files, and metadata XML.
"publisher": "AHRQ", // Publisher abbreviation (corresponds to 'publisher' in PMCBook)
"book": "ahrq_62d113_stacys_c", // Book-submit-ID as submitted by publisher.
"chapter": "article-8", // Chapter ID, as submitted by publisher, present for chapter submissions only.
"notices": []
}