The SubmissionEvent model captures significant events that are performed by an agent and occur against a Submission. In the current implementation, the agent will be a PASS User. The definition of “significant” will evolve depending on which events are useful to capture in order to e.g. trigger notifications, or form an audit trail. The events that are currently deemed significant for capture are documented under eventType.
| Field | Type | Description |
|---|---|---|
| id* | URI | Unique SubmissionEvent URI (autogenerated) |
| eventType* | Enum (see list below) | The type of event. |
| performedDate* | DateTime | Date the event was performed by the User |
| performedBy* | URI | URI of the User responsible for performing the event |
| performerRole | Enum (see list below) | Role of the person performing the event. |
| submission* | URI | URI of the Submission that the event relates to |
| comment | String | A comment relevant to the SubmissionEvent. For example, when a changes-requested event occurs, this might be added by the User through the UI to communicate what changes should be made. |
| link | URI | A resource relevant to the SubmissionEvent. For example, when a changes-requested event occurs, this may contain an Ember application URL to the affected Submission. |
*required
Properties automatically generated by the system are documented in System Properties. These are not available to client tools by default.
The following describes the types of events that might be recorded as SubmissionEvents.
| Value | Description |
|---|---|
| approval-requested-newuser | A Submission was prepared by a preparer on behalf of a person who does not yet have a User record in PASS. The preparer is requesting that the submitter join PASS and then approve and submit it or provide feedback. |
| approval-requested | A Submission was prepared by a preparer who is now requesting that the submitter approve and submit it or provide feedback. |
| changes-requested | A Submission was prepared by a preparer, but on review by the submitter, a change was requested. The Submission has been handed back to the preparer for editing. |
| cancelled | A Submission was prepared and then cancelled by the submitter or preparer without being submitted. No further edits can be made to the Submission. |
| submitted | The submit button has been pressed through the UI. |
The following describe the roles of people who might perform a SubmissionEvent.
| Value | Description |
|---|---|
| preparer | An individual who can prepare a Submission on behalf of another User - select the Publication, Repositories, Files, and Grants - but cannot approve the Repository agreements or submit the record for Deposit. |
| submitter | An individual responsible for a Submission. A person with this role can do all of the tasks that a preparer can do, but also approve any Repository agreements and submit the record for Deposit. |