Create Update Tombstone Event List of Terms

Title : Create Update Tombstone Event List of Terms

Date version issued : 2024-10-15

Date created : 2024-10-15

This version : 0.4.0

Latest version : 0.4.0

Abstract : The Create Update Tombstone Event is an object that is used for provenance tracking in the DiSSCo infrastructure. It tracks, who, what and when a change to a Digital Object was made. The model has been based on the W3C PROV model. It consists of three interlinked objects:
- The Activity: This contains information about the action that was performed. It includes the time when the change was made (prov:endedAtTime) and in case of an Update it contains the full change (ods:changeValue) as a JSON Patch object.
- The Entity: The entity indicates the object that was changed. In case of an Create or Update it will hold the newly create object, in serialised as JSON in the field prov:value.
- The Agent: The agent is the person or system that made the change. It contains the identifier of the Agent en the agent name (schema:name).
Each object refers to the other objects through a set of properties, following the PROV model.

Main contributors : Sam Leeflang, Soulaine Theocharides, Tom Dijkema, Wouter Addink, Sharif Islam, Claus Weiland, Jonas Grieb

Creator : Distributed Infrastructure for Scientific Collections (DiSSCo)

Bibliographic citation : Distributed Infrastructure for Scientific Collections. 2024. Create Update Tombstone Event List of Terms.

1 Introduction

1.1 Status of the content of this document

The openDS data specification is in active development. This document is work in progres and might change until version 1.0.0 is released. Its main function at the moment is to inform the community about the current state of the data model and to gather feedback. We hope to include the feedback from the community and reach a first major version of the data model by the end of 2024.

1.2 RFC 2119 key words

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in BCP 14 RFC 2119 and RFC 8174 when, and only when, they appear in all capitals, as shown here.

1.3 Naming Convention

This document contains all the terms in use the DiSSCo Digital Objects. Most objects can be directly related to a openDS class, for example the Machine Annotation Service, or the Source System. However, the Digital Specimen and the Digital Media are more complex objects. They can contain classes as nested object in itself. In general, class names are capitalized, use the UpperCamelCase naming convention and are singular. For example, the class that represents a Digital Specimen is called DigitalSpecimen. The properties of a class start with a lowercase and use the lowerCamelCase naming convention. When a class contains a property which contains a list of another class we use the convention hasXXXs where XXX is the class name. The properties name ends with an s to indicate that it is plural and contains an array of objects. For example, the Digital Specimen can contain a list of Event objects, so it has a property called hasEvents. When a class is directly nested (not through a list) we use the same hasXXX construction. This name does not end with an s but is singular, indicating that it contains a single nested object. For example, the Location class contains the property hasGeoreference which contains the Geo Reference class.

When terms are borrowed from other vocabularies, such as Darwin Core, Annotation Vocabulary, Schema.org or others, we use the same naming convention as in the original vocabulary. This could conflict with the openDS vocabulary naming convention.

2 Borrowed Vocabulary

When terms are borrowed from other vocabularies, openDS uses the IRIs, common abbreviations, and namespace prefixes in use in those vocabularies. The IRIs are normative, but abbreviations and namespace prefixes have no impact except as an aid to reading the documentation.

Table 1. Vocabularies from which terms have been borrowed (non-normative)

3 Namespaces, Prefixes and Term Names

The namespace of terms borrowed from other vocabularies is that of the original. The namespace of de openDS terms is http://rs.dissco.eu/opends/terms/. In the table of terms, each term entry has a row with the term name. This term name is generally an “unqualified name” preceded by a widely accepted prefix designating an abbreviation for the namespace It is RECOMMENDED that implementers who need a namespace prefix for the openDS namespace use ods. In this web document, hovering over a term in the Index By Term Name list below will reveal a complete URL that can be used in other web documents to link to this document’s treatment of that term, even if it is from a borrowed vocabulary.