This document is licensed under a Creative Commons Attribution 4.0 License .
This document defines a set of events that can be used and extended to communicate status about content that has been deposited into a DDP through the OTM Bridge. Each event describes an action which has occurred within the DDP and is associated with content that has been deposited through the OTM Bridge. The set of all events associated with one deposited entity (filegroup or file) is considered to be that entity's audit log. This audit log is available for each deposit via the OTM Bridge Get Audit Log endpoint.
This document is an appendix to a specification, created as part of the One to Many grant, funded by the Andrew W. Mellon Foundation.
The audit log events listed in this document are based on initial discussions between representatives from Chronopolis and APTrust and should be considered in draft form as additional discussions with other DDPs may uncover differences in auditing practices.
The Ingest event represents the ingestion of content from an OTM Gateway by a DDP. This event can represent either a filegroup being ingested or a file being ingested.
| Field Name | Note |
|---|---|
| Identifier | Identifier associated with the filegroup or file |
| Version | The version identifier of the filegroup or file which was ingested |
| Timestamp | The timestamp of when the Ingest event completed |
| Checksum | The checksum recorded by the DDP at Ingest |
| Checksum Algorithm | The algorithm used to generate the checksum |
| Bytes Ingested | The number of bytes ingested for the filegroup or the file |
| Files Ingested | The number of files ingested |
The Replication event represents the distribution of a filegroup or a file to a single location within a DDP. This should occur for each copy of the filegroup regardless of whether or not it is the primary copy.
| Field | Note |
|---|---|
| Identifier | Identifier associated with the filegroup or file |
| Version | The version identifier of the filegroup or file which was replicated |
| Timestamp | The timestamp of when the Replication event completed |
| Replicated To | The location where filegroup or file was replicated |
The Fixity event represents an action taken by a DDP to validate that a deposited file received as part of a filegroup has not been changed. This can occur at any point in the lifecycle of the file.
| Field | Note |
|---|---|
| Identifier | Identifier associated with the file |
| Version | The version identifier of the filegroup or file which was checked |
| Timestamp | The timestamp of when the Fixity event occurred |
| Checksum | The checksum calculated according to the algorithm used |
| Checksum Algorithm | The algorithm used to validate the file |
| Fixity Result | Boolean value indicating success or failure of the event |
A Deletion event represents the removal of one or more files from DDP storage.
| Field | Note |
|---|---|
| Identifier | Identifier associated with the filegroup or file |
| Version | The version identifier of the filegroup or file which was deleted |
| Timestamp | The timestamp of when the Delete event occurred |
| Checksum | The checksum value of the file which was deleted |
| Checksum Algorithm | The algorithm used to generate the checksum |
A Repair event occurs when a DDP resolves any file corruption. Although this is internal to the DDP, it is considered to be an event that may be auditable.
| Field | Note |
|---|---|
| Identifier | Identifier associated with the filegroup or file |
| Version | The version identifier of the filegroup or file which was repaired |
| Timestamp | The timestamp of when the Repair event occurred |
| Repair Outcome | The result of the Repair |
Restoration is an event which occurs when the Repository requests a filegroup be retrieved from a DDP.
| Field | Note |
|---|---|
| Identifier | Identifier associated with the filegroup or file |
| Version | The version identifier of the filegroup or file which was restored |
| Timestamp | The timestamp of when the Restore event occurred |
| Expiration | The expiration timestamp for the Restore |
| Success | The result of the Restoration: true or false |
| From | The location in the DDP where the filegroup or file came from |