OpenProv

The following files are available:

This is required for specifications that contain normative material.

Introduction

Namespace

The following namespaces prefixes are used throughout this document.

Table 1: Prefix and Namespaces used in this specification
prefixnamespace IRI definition
provhttp://www.w3.org/ns/prov#The PROV namespace [[PROV-DM]]
openprovhttps://openprovenance.org/ns/openprov#The OpenProv namespace defined by this specification
provexthttps://openprovenance.org/ns/provext#Extension namespace for PROV used in the [[PROV-JSONLD]] specification
xsdhttp://www.w3.org/2000/10/XMLSchema#XML Schema Namespace [[XMLSCHEMA11-2]]]
rdfhttp://www.w3.org/1999/02/22-rdf-syntax-ns#The RDF namespace [[RDF-CONCEPTS]]
(others)(various)All other namespace prefixes are used in examples only.
In particular, IRIs starting with "http://example.com" represent some application-dependent IRI [[RFC3987]]

OpenProv Ontology

In this section, we provide details about OpenProv Ontology ... .

The ontology is identified by https://openprovenance.org/ns/openprov#; its terms are in the namespace https://openprovenance.org/ns/openprov#, prefix openprov. The vocabulary the OpenProvenance template library and ProvToolbox use in provenance documents beyond PROV-DM and provext: the statements a summarising relation was folded from, the roles of the parties to a change of collection, and the kinds of activity and derivation that change a collection. Distinct from provext, the minimal extension PROV-JSONLD needs for its regular JSON shape, whose classes this vocabulary builds on.

The ontology imports https://openprovenance.org/ns/provext#.

Object Properties

Each property is declared as owl:ObjectProperty; it is optional on the relation named by its domain and points at a statement that relation summarises.

On prov:Attribution and provext:Membership

rdfs:labelhad activity
rdfs:commentThe activity the relation arose from: for an attribution, the activity that generated, invalidated or derived the entity while the agent was associated with it; for a membership, the activity that placed the member in the collection. A sub-property of prov:hadActivity, whose domain PROV-O states as prov:Influence and, more precisely, as the union of Delegation, Derivation, End and Start; an attribution or membership carrying this property is therefore entailed to be an Influence, and, under the precise domain, a member of that union, which PROV-O declares nothing to contradict.
rdfs:subPropertyOfprov:hadActivity
rdfs:domainprov:Attribution ∪ provext:Membership
rdfs:rangeprov:Activity

On prov:Attribution

rdfs:labelhad agent derivation
rdfs:commentThe derivation of the agent, from its earlier version, by the activity the attribution arose from.
rdfs:domainprov:Attribution
rdfs:rangeprov:Derivation
rdfs:labelhad association
rdfs:commentThe association of the agent with the activity the attribution arose from.
rdfs:domainprov:Attribution
rdfs:rangeprov:Association
rdfs:labelhad entity derivation
rdfs:commentThe derivation of the attributed entity, from its earlier version, by the activity the attribution arose from.
rdfs:domainprov:Attribution
rdfs:rangeprov:Derivation
rdfs:labelhad invalidation
rdfs:commentThe invalidation of the attributed entity by the activity the attribution arose from.
rdfs:domainprov:Attribution
rdfs:rangeprov:Invalidation

On provext:Membership

rdfs:labelhad collection generation
rdfs:commentThe generation of the collection by the activity the membership arose from.
rdfs:domainprovext:Membership
rdfs:rangeprov:Generation
rdfs:labelhad item generation
rdfs:commentThe generation of the member by the activity the membership arose from.
rdfs:domainprovext:Membership
rdfs:rangeprov:Generation

On provext:Specialization

rdfs:labelhad derivation
rdfs:commentThe derivation of the specific entity from the entity the specialization arose from.
rdfs:domainprovext:Specialization
rdfs:rangeprov:Derivation
rdfs:labelhad previous entity
rdfs:commentThe previous entity, from which the specific entity was derived, itself a specialization of the same general entity. Named previous, not entity, beside the specific and general entities of the specialization.
rdfs:domainprovext:Specialization
rdfs:rangeprov:Entity
rdfs:labelhad specialization
rdfs:commentThe specialization, of the entity the specific entity was derived from, to the same general entity.
rdfs:domainprovext:Specialization
rdfs:rangeprovext:Specialization

On prov:Communication

rdfs:labelhad entity
rdfs:commentThe entity a communication arose from: generated by the informant activity and used by the informed one. The counterpart, for a communication, of the activity a derivation arose from, prov:hadActivity.
rdfs:domainprov:Communication
rdfs:rangeprov:Entity

On prov:Attribution and provext:Membership and prov:Communication and prov:Start and prov:End

rdfs:labelhad generation
rdfs:commentFor an attribution, the generation of the attributed entity by the activity it arose from; for a membership, the generation of the collection by that activity; for a communication, the generation, by the informant, of the entity the informed activity used; for a start or an end, the generation of the trigger entity by the starter or ender activity.
rdfs:domainprov:Attribution ∪ provext:Membership ∪ prov:Communication ∪ prov:Start ∪ prov:End
rdfs:rangeprov:Generation

On provext:Membership and prov:Communication

rdfs:labelhad usage
rdfs:commentFor a membership, the usage of the member by the activity the membership arose from; for a communication, the usage, by the informed activity, of the entity the informant generated.
rdfs:domainprovext:Membership ∪ prov:Communication
rdfs:rangeprov:Usage

Roles

Each role is an individual of type prov:Role, for use as the prov:role of a usage or generation.

rdfs:labelas collection
rdfs:commentThe role of a collection in the usage or generation by an activity that inserts into it or removes from it.
rdf:typeprov:Role
rdfs:labelas entity
rdfs:commentThe role of the entity an activity acts upon, when no more specific role applies.
rdf:typeprov:Role
rdfs:labelas item
rdfs:commentThe role of the item an activity takes in and hands on, as in an assignment or a handover.
rdf:typeprov:Role
rdfs:labelas member
rdfs:commentThe role of a member in the usage or generation by an activity that inserts it into, or removes it from, a collection.
rdf:typeprov:Role

Types

Each type is declared as owl:Class, for use as a prov:type.

rdfs:labelInserting element
rdfs:commentThe membership that an insertion establishes, alongside prov:Derivation; used by ProvToolbox's collection scenarios.
rdfs:labelInserting into: collection
rdfs:commentThe derivation of the new collection from the old one by an insertion.
rdfs:subClassOfprov:Derivation
rdfs:labelInserting into: item
rdfs:commentThe derivation of the inserted item, as it is in the collection, from the item that was inserted.
rdfs:subClassOfprov:Derivation
rdfs:labelInserting item into collection
rdfs:commentThe insertion of an item into a collection: the type of the activity that uses the collection and the item and generates the new collection, and of the derivations it accounts for.
rdfs:labelRemoving element
rdfs:commentThe derivation of the collection, as it is once the element is removed, from the element that was removed.
rdfs:subClassOfprov:Derivation
rdfs:labelRemoving element from collection
rdfs:commentThe removal of an element from a collection: the type of the activity that uses the collection and generates the new one, and of the derivations it accounts for.

OpenProv JSON-LD Context

In this section, we provide a description of the JSON-LD context [PROV-JSONLD]... .

The context builds on https://openprovenance.org/prov-jsonld/context.jsonld.

The context declares @version 1.1.

It declares the following prefixes.

prefixnamespace IRI
openprovhttps://openprovenance.org/ns/openprov#

Each of the following keys names a type of relation and carries a scoped context: the keys it lists are defined only inside an object of that type; a key mapped as a property gives the IRI as predicate, a reverse property as the predicate pointing back at the object.

Attributionstands for prov:Attribution
keyIRImapping@type
entityprov:qualifiedAttributionreverse property@id
activityopenprov:hadActivityproperty@id
associationopenprov:hadAssociationproperty@id
generationopenprov:hadGenerationproperty@id
invalidationopenprov:hadInvalidationproperty@id
entityDerivationopenprov:hadEntityDerivationproperty@id
agentDerivationopenprov:hadAgentDerivationproperty@id
Membershipstands for provext:Membership
keyIRImapping@type
collectionprovext:qualifiedMembershipreverse property@id
entityprovext:memberproperty@id
activityopenprov:hadActivityproperty@id
generationopenprov:hadGenerationproperty@id
usageopenprov:hadUsageproperty@id
collectionGenerationopenprov:hadCollectionGenerationproperty@id
itemGenerationopenprov:hadItemGenerationproperty@id
Specializationstands for provext:Specialization
keyIRImapping@type
specificEntityprovext:qualifiedSpecializationreverse property@id
generalEntityprovext:generalEntityproperty@id
previousEntityopenprov:hadPreviousEntityproperty@id
derivationopenprov:hadDerivationproperty@id
specializationopenprov:hadSpecializationproperty@id
Communicationstands for prov:Communication
keyIRImapping@type
informedprov:qualifiedCommunicationreverse property@id
informantprov:activityproperty@id
entityopenprov:hadEntityproperty@id
generationopenprov:hadGenerationproperty@id
usageopenprov:hadUsageproperty@id
Startstands for prov:Start
keyIRImapping@type
activityprov:qualifiedStartreverse property@id
triggerprov:entityproperty@id
starterprov:hadActivityproperty@id
timeprov:atTimepropertyxsd:dateTime
generationopenprov:hadGenerationproperty@id
Endstands for prov:End
keyIRImapping@type
activityprov:qualifiedEndreverse property@id
triggerprov:entityproperty@id
enderprov:hadActivityproperty@id
timeprov:atTimepropertyxsd:dateTime
generationopenprov:hadGenerationproperty@id
{
  "@context": [
    "https://openprovenance.org/prov-jsonld/context.jsonld",
    {
      "@version": 1.1,
      "openprov": "https://openprovenance.org/ns/openprov#",

      "Attribution": {
        "@id": "prov:Attribution",
        "@context": {
          "entity":           { "@reverse": "prov:qualifiedAttribution", "@type": "@id" },
          "activity":         { "@id": "openprov:hadActivity",         "@type": "@id" },
          "association":      { "@id": "openprov:hadAssociation",      "@type": "@id" },
          "generation":       { "@id": "openprov:hadGeneration",       "@type": "@id" },
          "invalidation":     { "@id": "openprov:hadInvalidation",     "@type": "@id" },
          "entityDerivation": { "@id": "openprov:hadEntityDerivation", "@type": "@id" },
          "agentDerivation":  { "@id": "openprov:hadAgentDerivation",  "@type": "@id" }
        }
      },

      "Membership": {
        "@id": "provext:Membership",
        "@context": {
          "collection":           { "@reverse": "provext:qualifiedMembership", "@type": "@id" },
          "entity":               { "@id": "provext:member",                   "@type": "@id" },
          "activity":             { "@id": "openprov:hadActivity",             "@type": "@id" },
          "generation":           { "@id": "openprov:hadGeneration",           "@type": "@id" },
          "usage":                { "@id": "openprov:hadUsage",                "@type": "@id" },
          "collectionGeneration": { "@id": "openprov:hadCollectionGeneration", "@type": "@id" },
          "itemGeneration":       { "@id": "openprov:hadItemGeneration",       "@type": "@id" }
        }
      },

      "Specialization": {
        "@id": "provext:Specialization",
        "@context": {
          "specificEntity": { "@reverse": "provext:qualifiedSpecialization", "@type": "@id" },
          "generalEntity":  { "@id": "provext:generalEntity",                "@type": "@id" },
          "previousEntity": { "@id": "openprov:hadPreviousEntity",           "@type": "@id" },
          "derivation":     { "@id": "openprov:hadDerivation",               "@type": "@id" },
          "specialization": { "@id": "openprov:hadSpecialization",           "@type": "@id" }
        }
      },

      "Communication": {
        "@id": "prov:Communication",
        "@context": {
          "informed":   { "@reverse": "prov:qualifiedCommunication", "@type": "@id" },
          "informant":  { "@id": "prov:activity",                    "@type": "@id" },
          "entity":     { "@id": "openprov:hadEntity",               "@type": "@id" },
          "generation": { "@id": "openprov:hadGeneration",           "@type": "@id" },
          "usage":      { "@id": "openprov:hadUsage",                "@type": "@id" }
        }
      },

      "Start": {
        "@id": "prov:Start",
        "@context": {
          "activity":   { "@reverse": "prov:qualifiedStart", "@type": "@id" },
          "trigger":    { "@id": "prov:entity",              "@type": "@id" },
          "starter":    { "@id": "prov:hadActivity",         "@type": "@id" },
          "time":       { "@id": "prov:atTime",              "@type": "xsd:dateTime" },
          "generation": { "@id": "openprov:hadGeneration",   "@type": "@id" }
        }
      },

      "End": {
        "@id": "prov:End",
        "@context": {
          "activity":   { "@reverse": "prov:qualifiedEnd", "@type": "@id" },
          "trigger":    { "@id": "prov:entity",            "@type": "@id" },
          "ender":      { "@id": "prov:hadActivity",       "@type": "@id" },
          "time":       { "@id": "prov:atTime",            "@type": "xsd:dateTime" },
          "generation": { "@id": "openprov:hadGeneration", "@type": "@id" }
        }
      }
    }
  ]
}

OpenProv JSON Schema

The PROV-JSONLD schema [PROV-JSONLD] closes every relation to the properties it names and to prefixed attributes, so a document using the terms above does not validate against it. The OpenProv schema, https://openprovenance.org/ns/openprov-schema.json, extends the PROV-JSONLD schema, https://openprovenance.org/prov-jsonld/schema.json, by reference: every definition that does not change is a $ref into the PROV-JSONLD schema, and only what changes is restated: the relations the context scopes terms to, each the PROV-JSONLD definition plus one property per term, a qualified name or an array of them (QualifiedName+) since the terms are @type: @id; and the chain from a document to its statements (Document, Bundle, StatementOrBundle, Statement), which otherwise would route a relation to the PROV-JSONLD definition of it.

A validator must therefore resolve the PROV-JSONLD schema, from its URL or a local copy: ajv validate -s openprov-schema.json -r schema.json -d document.jsonld. The schema is generated from the two files it extends, by script/schema-extend.py.

OpenProv support in PROV-N

In this section, we provide a description of how PROV-N supports the OpenProv Extension .

Interoperability Considerations

IC1:
...
IC2:
...
IC3:
...