Email notification use case: When BCMS receives an error report for conversion errors (status=3)
Context
This email use case applies to:
- Submissions of source content to the XML workflow for conversion by NBCI Systems
- Submissions of source content to the Word workflow for conversion by NBCI Systems
- Kafka topics:
- convert_xml_book_chapter_receipt
- convert_xml_book_receipt
- convert_word_book_chapter_receipt
Proposal
- When BCMS receives an error report for the above topics with Status=3 and assignee=PMC, send email notification to the Sys Admin(s) assigned to the Organization. (note: this notification is already done, however the email text needs to be updated according to the template below)
- When BCMS receives an error report for the above topics with Status=3 and assignee=Publisher, send email notification to the user who uploaded the file (owner) in the BCMS and the Sys Admin(s) assigned to the Organization. (note: this notification is already done, however the email text needs to be updated according to the template below)
Email template for chapter
From: NCBI Bookshelf
Date: [Date email sent]
To: [User email]
Subject: Failed to process: Chapter [Title of component] in [Book Title] ([BCMS ID])
The chapter [Title of component] in [Book Title] from the organization [Organization name] failed to process.
Please find a list of errors or queries below:
[List All ERRORS or QUERIES that causes “CONVERSION ERRORS” STATUS]
To address issues with this submission, please navigate to the Files tab: [provide link of component to fix issues].
All errors in the Errors tab MUST be fixed to generate a preview.
If you have any questions about this email, please contact the NCBI Bookshelf at booksauthors@ncbi.nlm.nih.gov.
Thank you,
NCBI Bookshelf
[Main BCMS link]
[Bookshelf public site link]
Email template for book
From: NCBI Bookshelf
Date: [Date email sent]
To: [User email]
Subject: Failed to process: Book [Title of component] ([BCMS ID])
The book [Title of component] from the organization [Organization name] failed to process.
Please find a list of errors or queries below:
[List All ERRORS or QUERIES that causes “CONVERSION ERRORS” STATUS]
To address issues with this submission, please navigate to the Files tab: [provide link of component to fix issues].
All errors in the Errors tab MUST be fixed to generate a preview.
If you have any questions about this email, please contact the NCBI Bookshelf at booksauthors@ncbi.nlm.nih.gov.
Thank you,
NCBI Bookshelf
[Main BCMS link]
[Bookshelf public site link]
Example email for chapter
From: NCBI Bookshelf
Date: [Date email sent]
To: [User email]
Subject: Failed to process: Chapter Search in Bookshelf Help (bcms789123)
The chapter Search in Bookshelf Help from the organization National Institutes of Health failed to process.
Please find a list of errors or queries below:
sources file '/pmcdata/books/bcms967/novol-noyear/noiss/merge/final/sgml/bookbcms967Order.xml' not found
To address issues with this submission, please navigate to the Files tab: [provide link of component to fix issues].
All errors in the Errors tab MUST be fixed to generate a preview.
If you have any questions about this email, please contact the NCBI Bookshelf at booksauthors@ncbi.nlm.nih.gov.
Thank you,
NCBI Bookshelf [Main BCMS link] [Bookshelf public site link]
Notes for developers
- Link to file: https://gitlab.coko.foundation/ncbi/ncbi/-/blob/develop/server/services/handleNcbiMessage/bookComponentConversion.js
- See Example kafka notification below
{
"job_id": 9876543210, // XML conversion job reference ID
"status": 3, // Success = 0, Error = 3
"timestamp": "2020-11-07 15:14:59", // Completion time
"notices": [
{
"severity": "ERROR",
"assignee": "Publisher",
"message": "Mismatched end tag: expected </td>, got </list-item> in unnamed entity at line 79 char 155 of /pmc/work/article-24901.xml"
}
]
}