Lifecycle of a Submission
A Submission in Oversight mirrors submissions to a manuscript tracking system.
When you send a submission it will go through the following states in order:
graph LR
accepted --> processing --> report-available
processing --> failed
failed --> failed
report-available --> report-available
failed --> report-available
report-available --> failed
accepted: We have received the Submission and it is queued for processing.processing: It is now being processed.report-available: There is a report. Users can access the report via the Oversight app.failed: There was an error processing the input. Data was missing, or there was an internal error.
Users can manually re-run a report, or it may be re-run automatically.
Note
We use other states internally and may add more in the future. If your system sees an unexpected state, it should not throw an error.
Checks
A Check is a snapshot of metadata that we analyze. When you create a submission, a new Check is created, and the report is associated with this Check.
You will see the Check and its ID in API results. If you re-send a Submission (e.g. because of a resubmission, see Submission IDs) a new Check will be created. Users will see this new Check and its results in Oversight.