Reporting and resolving FTP submission errors
Context
Miro ref: Session 2
User story 9: As a user I need to know about any errors in the content that I submit by FTP so that I can resolve them. (Time estimate : 13 developer days)
User story 10: BCMS system admins and users of the relevant organisation need to know about all content submissions from FTP that fail so that the packaged can be fixed and resubmitted. (Time estimate : 5 developer days)
NCBI accepts source submissions for the XML and PDF workflow via FTP. When an organization wants to submit content via FTP, NCBI sets up this organization with an FTP account and provides a specific folder for them to submit content. The BCMS currently supports submissions by FTP for the XML workflow. This was developed according to the specifications outlined in #183.
Proposal
Summary
This feature proposal describes the workflow for users to deal with any errors as a result of a source submission by FTP for the XML workflow only, since FTP submission for the PDF workflow is not supported yet.
In summary, user story 9:
- Validate FTP packages against the submission rules and report any errors with the package in the BCMS as "FTP submission errors".
- Make users aware of the errors by email notification.
- Allow users to resolve the errors from within the BCMS or by resubmitting by FTP.
In summary, user story 10:
- Report all packages that fail submission in the BCMS, within the relevant organisation, as "FTP submission failures".
- Make users aware of the errors by email notification.
- Allow users to resolve the errors from within the BCMS or by resubmitting by FTP.
- An alternative is to report an activity log of all FTP submissions
- A temporary workaround is to add BCMS System admins to "notification_recipients" in existing notifications sent by NCBI systems for failed packages. BCMS System admins communicate problems with packages to the organisations that submitted the files outside of the BCMS. Note that this is an NCBI task
Workflow diagram
The following digram describes the workflow steps for reporting and resolving FTP submission errors. View it online here or download as PDF:FTP-submission-errors-walkthrough-20220307_Part1.pdf
Workflow summary based on the diagram
The steps below refer to the numbers in red on the diagram.
At Step 2 NCBI does the following checks:
- the
submission-type
is valid in the meta.xml:book
orchapter
- the
workflow
is valid in the meta.xml:xml
(pdf is not support in first deployment therefore it's considered invalid) - a value is provided for
book-submit-id
- a value is provided for
publisher
As a starting point, we've provided error messages for these on the Errors tracking sheet. Please see all error with "2a" in Column D.
From Step 3 onwards all checks and error writing is done by the BCMS. From Step 4 onwards the BCMS has the required information to create the submission in the correct Organisation, workflow, and submission type so that user can resolve the remaining errors in the UI.
Design
I've attached high res PDF for each step shown in the online walkthrough
FTP-submission-errors-walkthrough-20220307.pdf
FTP-submission-errors-walkthrough-20220307_Part1.pdf
FTP-submission-errors-walkthrough-20220307_Part2.pdf
FTP-submission-errors-walkthrough-20220307_Part3.pdf
FTP-submission-errors-walkthrough-20220307_Part4.pdf
FTP-submission-errors-walkthrough-20220307_Part5.pdf
FTP-submission-errors-walkthrough-20220307_Part6.pdf
FTP-submission-errors-walkthrough-20220307_Part7.pdf
FTP-submission-errors-walkthrough-20220307_Part8.pdf
Implementation (if applicable)
[A description of the steps to implement the feature.]
Alternative approaches (if applicable)
[Include any alternatives to meet this use case.]
Open issues (if applicable)
[Links to and a discussion of related issues, if applicable.]