Create Update Tombstone Event Terms (In Progress)
Open Digital Specimen List of Terms
Create Update Tombstone Event List of Terms (In Progress)
Title : Create Update Tombstone Event List of Terms
Date version issued : 2024-06-17
Date created : 2024-06-17
This version : 0.3.0
Latest version : 0.3.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 (foaf: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 DigitalSpecimen and the Digital Entity 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 hasXXX
where XXX is the class name.
For example, the DigitalSpecimen can contain a list of Event objects, so it has a property called hasEvent
.
When a class is directly nested (not through a list) we use the class name as property name.
For example, the Location class contains the property ods:GeoReference
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)
Vocabulary | Abbreviation | Namespaces and abbreviations |
---|---|---|
Schema.org | Schema | schema: = https://schema.org/version/latest/schemaorg-current-https.rdf |
Friend of a Friend | FOAF | foaf: = http://xmlns.com/foaf/0.1/ |
PROV | PROV | prov: = http://www.w3.org/ns/prov# |
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.
4 Term index
4.1 Index By Term Name
Agent
CreateUpdateTombstoneEvent
5 Vocabulary
Term Name wasAssociatedWith | |
---|---|
Qualified Term | prov:wasAssociatedWith |
Term IRI | wasAssociatedWith |
Label | Was Associated With |
Definition | The unique identifier of the prov:Agent that was associated with the Activity (as indicated at @id in the Activity Class), http://www.w3.org/ns/prov#wasAssociatedWith |
Examples |
|
Datatype | string |
Belongs to Class | Activity |
Required | True |
Repeatable | False |
RDF Type | rdf:Property |
Term Name endedAtTime | |
---|---|
Qualified Term | prov:endedAtTime |
Term IRI | endedAtTime |
Label | Ended At Time |
Definition | The date and time when the activity ended, in ISO 8601 format, http://www.w3.org/ns/prov#endedAtTime |
Examples |
|
Datatype | string |
Belongs to Class | Activity |
Required | True |
Repeatable | False |
RDF Type | rdf:Property |
Term Name used | |
---|---|
Qualified Term | prov:used |
Term IRI | used |
Label | Used |
Definition | The unique identifier of the prov:Entity that was used in the Activity (as indicated at @id in the Activity Class), http://www.w3.org/ns/prov#used |
Examples |
|
Datatype | string |
Belongs to Class | Activity |
Required | True |
Repeatable | False |
RDF Type | rdf:Property |
Term Name comment | |
---|---|
Qualified Term | rdfs:comment |
Term IRI | http://www.w3.org/2000/01/rdf-schema#comment |
Label | Comment |
Definition | A comment about the activity, https://www.w3.org/2000/01/rdf-schema#comment |
Examples |
|
Datatype | string |
Belongs to Class | Activity |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name changeValue | |
---|---|
Qualified Term | ods:changeValue |
Term IRI | http://rs.dissco.eu/opends/terms/changeValue |
Label | Change Value |
Definition | The json patch object that describes the changes made to the object as opposed to the previous version, empty if this is a ods:Create or ods:Tombstone activity |
Examples |
|
Datatype | array |
Belongs to Class | Activity |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name name | |
---|---|
Qualified Term | foaf:name |
Term IRI | http://xmlns.com/foaf/0.1/name |
Label | Name |
Definition | The name of the agent |
Examples |
|
Datatype | string |
Belongs to Class | Agent |
Required | True |
Repeatable | False |
RDF Type | rdf:Property |
Term Name CreateUpdateTombstoneEvent | |
---|---|
Qualified Term | ods:CreateUpdateTombstoneEvent |
Term IRI | http://rs.dissco.eu/opends/terms/CreateUpdateTombstoneEvent |
Label | Create Update Tombstone Event |
Definition | Create Update Tombstone Event, based on W3C PROV Data Model (https://www.w3.org/TR/prov-o/) |
Required | True |
Repeatable | True |
RDF Type | rdfs:Class |
Term Name ID | |
---|---|
Qualified Term | ods:ID |
Term IRI | http://rs.dissco.eu/opends/terms/ID |
Label | Id |
Definition | The unique identifier of the Create Update Tombstone Event, this includes the version of the object |
Examples |
|
Datatype | string |
Belongs to Class | CreateUpdateTombstoneEvent |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name type | |
---|---|
Qualified Term | ods:type |
Term IRI | http://rs.dissco.eu/opends/terms/type |
Label | Type |
Definition | The DOI to the FDO type of the object |
Examples |
|
Datatype | string |
Belongs to Class | CreateUpdateTombstoneEvent |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name Activity | |
---|---|
Qualified Term | prov:Activity |
Term IRI | Activity |
Label | Activity |
Definition | Based on the prov-ontology Activity Class, https://www.w3.org/ns/prov#Activity |
Datatype | object |
Required | False |
Repeatable | False |
RDF Type | rdfs:Class |
Term Name Entity | |
---|---|
Qualified Term | prov:Entity |
Term IRI | Entity |
Label | Entity |
Definition | Based on the prov-ontology Entity Class, https://www.w3.org/ns/prov#Entity |
Datatype | object |
Required | False |
Repeatable | False |
RDF Type | rdfs:Class |
Term Name Agent | |
---|---|
Qualified Term | prov:Agent |
Term IRI | Agent |
Label | Agent |
Definition | Based on the prov-ontology Agent Class, https://www.w3.org/ns/prov#Agent |
Datatype | object |
Required | False |
Repeatable | False |
RDF Type | rdfs:Class |
Term Name value | |
---|---|
Qualified Term | prov:value |
Term IRI | value |
Label | Value |
Definition | The full object that is the result of the prov:Activity, the structure of this object is defined by the `@type` field. When the `prov:Activity` is of type `ods:Tombstone`, this field is empty |
Examples |
|
Datatype | object |
Belongs to Class | Entity |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name wasRevisionOf | |
---|---|
Qualified Term | prov:wasRevisionOf |
Term IRI | wasRevisionOf |
Label | Was Revision Of |
Definition | The unique identifier (handle) of the previous version of the object, only present when prov:Activity is of type ods:Update and ods:Tombstone |
Examples |
|
Datatype | string |
Belongs to Class | Entity |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name wasGeneratedBy | |
---|---|
Qualified Term | prov:wasGeneratedBy |
Term IRI | wasGeneratedBy |
Label | Was Generated By |
Definition | The unique identifier of the prov:Activity that generated the Entity (as indicated at @id in the Activity Class), http://www.w3.org/ns/prov#wasGeneratedBy |
Examples |
|
Datatype | string |
Belongs to Class | Entity |
Required | True |
Repeatable | False |
RDF Type | rdf:Property |
Term Name wasAttributedTo | |
---|---|
Qualified Term | prov:wasAttributedTo |
Term IRI | wasAttributedTo |
Label | Was Attributed To |
Definition | The unique identifier of the prov:Agent that was attributed to the Entity (as indicated at @id in the Agent Class), http://www.w3.org/ns/prov#wasAttributedTo |
Examples |
|
Datatype | string |
Belongs to Class | Entity |
Required | True |
Repeatable | False |
RDF Type | rdf:Property |