Report errors per job not per file version
Error are currently reported per file version, however this doesn't make sense for the wholebook scenario since there can be multiple source files in the wholebook case and it's possible that all files may not have the same version when they are submitted.
Instead, errors should be reported per job. We already have two design improvement issues to support this.
- Move previous errors to history (#310 (closed))
- Add job id and session link to error report (#292 (closed))
What we lose with this implementation is reporting the file version for each table of error. (at the moment we show filename + version as below).
This will be replaced by showing the job id and session link + date and time.
In addition to this, we can include a Filename
column in the errors table that would show the filename from json notification per error message.
Here an example from the Word conversion proposal in #73 (closed):
{
"job_id": 9876543210, // Word conversion job reference ID
"status": 3, // Success = 0, Waiting = 1, Loading = 2, Converting = 2, Error = 3, SevereError = 4, Timeout = 5, Killing = 9, Killed = 10
"timestamp": "2020-11-07 15:14:59", // Completion time
"converted_files": "assaygui.microplates.docx.9876543210.2020_05_15-09_30_19.output.zip", // domain.filename.ext.job_id.timestamp. Contains converted BXML and image files.
// May be returned even in case of an error, to assist with troubleshooting
"notices": [
{
"filename": "microplates.docx",
"severity": "ERROR",
"message": "Mismatched end tag: expected </td>, got </list-item> in unnamed entity at line 79 char 155 of file:///Users/msword/AppData/Local/Temp/EXTYLES/TMP/RXPin.xml"
},
{
"filename": "microplates.docx",
"severity": "ERROR",
"message": "eXtyles Error: Mismatched end tag: expected </p>, got </sec> in unnamed entity at line 1038 char 6 of file:///Program Files (x86)/eXtyles/TEMP/TMP/RXPin.xml"
},
{
"severity": "WARNING",
"message": "eXtyles Error: cannot resolve PubMed references"
}
]
}
This will be particularly useful for wholebooks that have more than one source file. It would be up to NCBI to make sure filename
is provided.
Please let me know if adding this column will be useful.