Provenance

Table of Contents

1.     model: Provenance
2.     Packages and Types
2.1     [root package]
2.1.1     objectType:Activity
2.1.2     objectType:ActivityDescription
2.1.3     objectType:Agent
2.1.4     enumeration:AgentType
2.1.5     objectType:Collection
2.1.6     objectType:DatasetDescription
2.1.7     objectType:DatasetEntity
2.1.8     objectType:Entity
2.1.9     objectType:EntityDescription
2.1.10     objectType:GenerationDescription
2.1.11     objectType:UsageDescription
2.1.12     objectType:Used
2.1.13     objectType:ValueDescription
2.1.14     objectType:ValueEntity
2.1.15     objectType:WasAssociatedWith
2.1.16     objectType:WasAttributedTo
2.1.17     objectType:WasGeneratedBy
2.2     package: ActivityConfiguration
2.2.1     objectType: ConfigFile
2.2.2     objectType: ConfigFileDescription
2.2.3     objectType: Parameter
2.2.4     objectType: ParameterDescription
2.2.5     enumeration: TypeOfConfigArtifact
2.2.6     objectType: WasConfiguredBy
3.     vodml-id-s
4.     Imported Models
4.1     ivoa

1. Model: Provenance (Provenance)

Authors :
Date : 2019-07-19T16:15:43
Version : 1.0
Abstract : Data model describing the structure and content of the IVOA Provenance Data Model. This re-uses the concepts from the W3C Provenance DM, but extends it with a description layer for Activities and Entities.
Diagram : The following diagram has been generated from the model using the GraphViz tool.
The classes and packages in the diagram can be clicked and are mapped to the descriptions of the corresponding element elsewhere in the document.

2.Model contents: Packages and Types

The following sub-sections present all packages in the model with their types. The packages are listed here in alphabetical order. Each sub-section contains a description of the package and a table containing its various features.

2.1 [root package]

Model Provenance
child package(s) ActivityConfiguration
Object types Activity ActivityDescription Agent Collection DatasetDescription DatasetEntity Entity EntityDescription GenerationDescription UsageDescription Used ValueDescription ValueEntity WasAssociatedWith WasAttributedTo WasGeneratedBy
Enumerations AgentType

2.1.1 objectType: Activity

vodml-id Activity
description A task executed at some time. It consumes products via relations of type Used and produces results via relations of type WasGeneratedBy. The method applied for this task is described in the ActivityDescription class and its subtree.
referrers Activity WasGeneratedBy
attributes
name feature value
id type ivoa:string
vodml-id Activity.id
multiplicity 1
description Unique identifier for an Activity. Must be unique in the domain.
name type ivoa:string
vodml-id Activity.name
multiplicity 0..1
description Activity name
startTime type ivoa:datetime
vodml-id Activity.startTime
multiplicity 0..1
description This allows to know when the activity was launched . This is recommended to fill in as it helps to check dependencies and errors into the database.
endTime type ivoa:datetime
vodml-id Activity.endTime
multiplicity 0..1
description Time when the Activity ends up.
comment type ivoa:string
vodml-id Activity.comment
multiplicity 0..1
description A short text about some peculiar information on the instance.
references
name feature value
activityDescription type ActivityDescription [Provenance:ActivityDescription]
vodml-id Activity.activityDescription
multiplicity 0..1
description Points to the corresponding description class
informant type Activity [Provenance:Activity]
vodml-id Activity.informant
multiplicity 0..*
description refers to an activity providing information
compositions
name feature value
used type Used [Provenance:Used]
vodml-id Activity.used
multiplicity 0..*
isOrdered false
description Gathers Entities used by the Activity instance
wasAssociatedWith type WasAssociatedWith [Provenance:WasAssociatedWith]
vodml-id Activity.wasAssociatedWith
multiplicity 0..*
isOrdered false
description Gathers Agents bound to this Activity instance
wasConfiguredBy type WasConfiguredBy [Provenance:ActivityConfiguration.WasConfiguredBy]
vodml-id Activity.wasConfiguredBy
multiplicity 0..*
isOrdered false
description Gathers Configuration elements for this Activity instance

2.1.2 objectType: ActivityDescription

vodml-id ActivityDescription
description Gives further information on how an activity works internally.
referrers Activity
attributes
name feature value
name type ivoa:string
vodml-id ActivityDescription.name
multiplicity 1
description Instance name
version type ivoa:string
vodml-id ActivityDescription.version
multiplicity 0..1
description Version number, if applicable
description type ivoa:string
vodml-id ActivityDescription.description
multiplicity 0..1
description A descriptive text for this kind of activity
docuLink type ivoa:anyURI
vodml-id ActivityDescription.docuLink
multiplicity 0..1
description Link to more documentation
type type ivoa:string
vodml-id ActivityDescription.type
multiplicity 0..1
description type of the activity
subtype type ivoa:string
vodml-id ActivityDescription.subtype
multiplicity 0..1
description More specific subtype of the activity
compositions
name feature value
configFileDescription type ConfigFileDescription [Provenance:ActivityConfiguration.ConfigFileDescription]
vodml-id ActivityDescription.configFileDescription
multiplicity 0..*
isOrdered false
description Gathers the description of the config files
generationDescription type GenerationDescription [Provenance:GenerationDescription]
vodml-id ActivityDescription.generationDescription
multiplicity 0..*
isOrdered false
description This link points to some description of the results produced in the context of one specific ActivityDescription.
parameterDescription type ParameterDescription [Provenance:ActivityConfiguration.ParameterDescription]
vodml-id ActivityDescription.parameterDescription
multiplicity 0..*
isOrdered false
description Gathers the description classes explaining the Parameter object that can be applied when running an Activity that can follow this ActivityDescription template.
usageDescription type UsageDescription [Provenance:UsageDescription]
vodml-id ActivityDescription.usageDescription
multiplicity 0..*
isOrdered false
description This link points to some description of the Usage in the context of one specific ActivityDescription.

2.1.3 objectType: Agent

vodml-id Agent
description A person or an organisation that was involved in the follow-up of an Activity, or can be credited for the production of an Entity.
referrers WasAssociatedWith WasAttributedTo
attributes
name feature value
id type ivoa:string
vodml-id Agent.id
multiplicity 1
description Unique identifier for an Agent. Must be unique in the domain.
name type ivoa:string
vodml-id Agent.name
multiplicity 1
description Agent name
type type AgentType [Provenance:AgentType]
vodml-id Agent.type
multiplicity 0..1
description Defines the Agent type : Person, Organization or SoftwareAgent
comment type ivoa:string
vodml-id Agent.comment
multiplicity 0..1
description A short text about some peculiar information on the instance.
email type ivoa:string
vodml-id Agent.email
multiplicity 0..1
description Email address of the Agent
affiliation type ivoa:string
vodml-id Agent.affiliation
multiplicity 0..1
description Agent's affiliation
phone type ivoa:string
vodml-id Agent.phone
multiplicity 0..1
description Agent's phone number
address type ivoa:string
vodml-id Agent.address
multiplicity 0..1
description Agent's postmail address
url type ivoa:anyURI
vodml-id Agent.url
multiplicity 0..1
description Reference URL to the agent

2.1.4 enumeration: AgentType

vodml-id AgentType
description A literal for specifying the Agent type : Individal or Organisation or SoftwareAgent
literals
name feature value
Person vodml-id AgentType.Person
description Type label for agents considered as persons
Organization vodml-id AgentType.Organization
description Type label for agents considered as organizations
SoftwareAgent vodml-id AgentType.SoftwareAgent
description Type label for agents considered as software agents

2.1.5 objectType: Collection

vodml-id Collection
description A collection of Entities. It is a way to consider a set of entities when produced and consumed with respect to an Activity. Allows coarse description of the provenance.
extends Entity [Provenance:Entity]
references
name feature value
entity type Entity [Provenance:Entity]
vodml-id Collection.entity
multiplicity 0..*
description Binds a collection entity to its members

2.1.6 objectType: DatasetDescription

vodml-id DatasetDescription
description The description of a DatasetEntity. Can be pointed to by multiple instances of DatasetEntity.
extends EntityDescription [Provenance:EntityDescription]
attributes
name feature value
contentType type ivoa:string
vodml-id DatasetDescription.contentType
multiplicity 1
description MIME-type or format of the dataset

2.1.7 objectType: DatasetEntity

vodml-id DatasetEntity
description An Entity which represents a data file in the Provenance system. It is not the data file itself
extends Entity [Provenance:Entity]
role constraints
Constrained Role Constraint Feature Constraint Value
DatasetEntity [Provenance:DatasetEntity]
datatype DatasetDescription [Provenance:DatasetDescription]

2.1.8 objectType: Entity

vodml-id Entity
description A thing which is consumed or produced in a task , namely here in the astronomical domain. It represents some data as single element or file or an instrument.
Subclasses in this model Collection DatasetEntity ValueEntity
referrers Collection Entity Used
attributes
name feature value
id type ivoa:string
vodml-id Entity.id
multiplicity 1
description Unique identifier for an Entity. Must be unique in the domain.
name type ivoa:string
vodml-id Entity.name
multiplicity 0..1
description This is a text string which designate the Entity for display in application or diagrams . It can follow various syntax and naming conventions depending on the Entity subclass : dataset, quality flag, device name convention, etc .
location type ivoa:string
vodml-id Entity.location
multiplicity 0..1
description A path, a URL, coordinates or the name of a place.
generatedAtTime type ivoa:datetime
vodml-id Entity.generatedAtTime
multiplicity 0..1
description The time of generation for the entity , in ISOTime
invalidatedAtTime type ivoa:datetime
vodml-id Entity.invalidatedAtTime
multiplicity 0..1
description Time stamp after which the entity is considered no longer valid for further usage in an Activity. It may still be available in the system but not used for operations .
comment type ivoa:string
vodml-id Entity.comment
multiplicity 0..1
description A short text about some peculiar information on the instance.
references
name feature value
entityDescription type EntityDescription [Provenance:EntityDescription]
vodml-id Entity.entityDescription
multiplicity 0..1
description Link to the corresponding EntityDescription instance. Many Entities may share the same EntityDescription instance.
usedEntity type Entity [Provenance:Entity]
vodml-id Entity.usedEntity
multiplicity 0..*
description The link from the progenitor Entity to its descendant.
compositions
name feature value
wasAttributedTo type WasAttributedTo [Provenance:WasAttributedTo]
vodml-id Entity.wasAttributedTo
multiplicity 0..*
isOrdered false
description Gathers Agents to which the entity was attributed
wasGeneratedBy type WasGeneratedBy [Provenance:WasGeneratedBy]
vodml-id Entity.wasGeneratedBy
multiplicity 0..1
isOrdered false
description Binds to the activity which generated this entity

2.1.9 objectType: EntityDescription

vodml-id EntityDescription
description This class is meant to store descriptive information for different categories of entities.
Subclasses in this model DatasetDescription ValueDescription
referrers Entity GenerationDescription UsageDescription
attributes
name feature value
name type ivoa:string
vodml-id EntityDescription.name
multiplicity 1
description Instance name
description type ivoa:string
vodml-id EntityDescription.description
multiplicity 1
description A descriptive text for this kind of entity
docuLink type ivoa:anyURI
vodml-id EntityDescription.docuLink
multiplicity 0..1
description Link to more documentation
type type ivoa:string
vodml-id EntityDescription.type
multiplicity 0..1
description Type of the entity

2.1.10 objectType: GenerationDescription

vodml-id GenerationDescription
description This class gathers description features about the products an ActivityDescription considers as output results.
referrers WasGeneratedBy
attributes
name feature value
role type ivoa:string
vodml-id GenerationDescription.role
multiplicity 1
description A label that describes the function of what was produced. It is defined in the context of an ActivityDescription instance.
description type ivoa:string
vodml-id GenerationDescription.description
multiplicity 0..1
description A descriptive text for this kind of entity generation
type type ivoa:string
vodml-id GenerationDescription.type
multiplicity 0..1
description Type of the entity generation. It is a free text attribute with some reserved words
multiplicity type ivoa:string
vodml-id GenerationDescription.multiplicity
multiplicity 0..1
description String representation of the number of expected output entities that will be generated with the given role (« unbounded «  if not set)
references
name feature value
entityDescription type EntityDescription [Provenance:EntityDescription]
vodml-id GenerationDescription.entityDescription
multiplicity 0..*
description Points to the description of the used entities

2.1.11 objectType: UsageDescription

vodml-id UsageDescription
description This class gathers description features about the products an ActivityDescription considers as input resources. It can differentiate various roles and types of Entities consumed by the task described by the corresponding ActivityDescription instance.
referrers Used
attributes
name feature value
role type ivoa:string
vodml-id UsageDescription.role
multiplicity 1
description Function of the entity with respect to its usage by the activity.
description type ivoa:string
vodml-id UsageDescription.description
multiplicity 0..1
description A descriptive text for this kind of usage
type type ivoa:string
vodml-id UsageDescription.type
multiplicity 0..1
description type of the usage. It is a free text attribute with some reserved words
multiplicity type ivoa:string
vodml-id UsageDescription.multiplicity
multiplicity 0..1
description String representation of the number of expected input entities that are used with the given role (« unbounded «  if not set)
references
name feature value
entityDescription type EntityDescription [Provenance:EntityDescription]
vodml-id UsageDescription.entityDescription
multiplicity 0..*
description Points to the description of the used entities

2.1.12 objectType: Used

vodml-id Used
description Binds an Activity to the Entities it consumes .
attributes
name feature value
role type ivoa:string
vodml-id Used.role
multiplicity 0..1
description function of the entity with respect to the activity
time type ivoa:datetime
vodml-id Used.time
multiplicity 0..1
description Time at which the usage of an entity started
references
name feature value
entity type Entity [Provenance:Entity]
vodml-id Used.entity
multiplicity 1
description Points to the used entity
usageDescription type UsageDescription [Provenance:UsageDescription]
vodml-id Used.usageDescription
multiplicity 0..1
description This link points to some description of the Usage in the context of one specific ActivityDescription.

2.1.13 objectType: ValueDescription

vodml-id ValueDescription
description Description of the properties of a ValueEntity.
extends EntityDescription [Provenance:EntityDescription]
attributes
name feature value
valueType type ivoa:string
vodml-id ValueDescription.valueType
multiplicity 1
description VODML-compliant data type of the value
unit type ivoa:Unit
vodml-id ValueDescription.unit
multiplicity 0..1
description VO-compliant unit string
ucd type ivoa:string
vodml-id ValueDescription.ucd
multiplicity 0..1
description VO-compliant UCD string
utype type ivoa:string
vodml-id ValueDescription.utype
multiplicity 0..1
description Role of the value in the context of an external VO data mode
min type ivoa:string
vodml-id ValueDescription.min
multiplicity 0..1
description Minimum value as a string whose content can be interpreted by the valueType attribute
max type ivoa:string
vodml-id ValueDescription.max
multiplicity 0..1
description Maximum value as a string whose content can be interpreted by the valueType attribute
default type ivoa:string
vodml-id ValueDescription.default
multiplicity 0..1
description Default value as a string whose content can be interpreted by the valueType attribute
options type ivoa:string
vodml-id ValueDescription.options
multiplicity 0..1
description Comma separated list of possible values

2.1.14 objectType: ValueEntity

vodml-id ValueEntity
description An entity that only contains a value. The way to interpret this value is described in the ValueDescription instance it linked to.
extends Entity [Provenance:Entity]
referrers Parameter
attributes
name feature value
value type ivoa:string
vodml-id ValueEntity.value
multiplicity 1
description The value of the Entity.
role constraints
Constrained Role Constraint Feature Constraint Value
ValueEntity [Provenance:ValueEntity]
datatype ValueDescription [Provenance:ValueDescription]

2.1.15 objectType: WasAssociatedWith

vodml-id WasAssociatedWith
description Denotes the assignment of responsibility to an agent for an activity.
attributes
name feature value
role type ivoa:string
vodml-id WasAssociatedWith.role
multiplicity 0..1
description Function of the agent with respect to the activity The role values belong to the AgentRole list defined in IVOA Provenance DataModel, Table 9.
references
name feature value
agent type Agent [Provenance:Agent]
vodml-id WasAssociatedWith.agent
multiplicity 1
description Points to the agent

2.1.16 objectType: WasAttributedTo

vodml-id WasAttributedTo
description Links an Agent to the Entity it is responsible for. Various roles for this relation are allowed and defined in the Provenance vocabulary under TypeOfAgentRole
attributes
name feature value
role type ivoa:string
vodml-id WasAttributedTo.role
multiplicity 0..1
description Function of the agent with respect to the entity. Values for role are listed in the AgentRole type, as listed in Table 9 of the PROV-DM specification.
references
name feature value
agent type Agent [Provenance:Agent]
vodml-id WasAttributedTo.agent
multiplicity 1
description Points to the agent.

2.1.17 objectType: WasGeneratedBy

vodml-id WasGeneratedBy
description Binds an Entity to the Activity that produced it as a result.
attributes
name feature value
role type ivoa:string
vodml-id WasGeneratedBy.role
multiplicity 0..1
description Function of the entity with respect to the activity.
references
name feature value
activity type Activity [Provenance:Activity]
vodml-id WasGeneratedBy.activity
multiplicity 1
description points to the creating Activity instance.
generationDescription type GenerationDescription [Provenance:GenerationDescription]
vodml-id WasGeneratedBy.generationDescription
multiplicity 0..1
description Points to the instance of GenerationDescription describing this kind of generated output.

2.2 package: ActivityConfiguration

vodml-id ActivityConfiguration
description This package gathers the necessary classes for expressing the configuration of a task before, during and after execution. We consider only the executed version will be stored in a provenance information system.
parent Provenance
Object types ConfigFile ConfigFileDescription Parameter ParameterDescription WasConfiguredBy
Enumerations TypeOfConfigArtifact

2.2.1 objectType: ConfigFile

vodml-id ActivityConfiguration.ConfigFile
description The values used to control the activity can be provided as a Configuration file document.
package ActivityConfiguration
referrers WasConfiguredBy
attributes
name feature value
name type ivoa:string
vodml-id ActivityConfiguration.ConfigFile.name
multiplicity 1
description Name of the file
location type ivoa:string
vodml-id ActivityConfiguration.ConfigFile.location
multiplicity 0..1
description Path or URL to the config file
comment type ivoa:string
vodml-id ActivityConfiguration.ConfigFile.comment
multiplicity 0..1
description A descriptive text for this instance
references
name feature value
configFileDescription type ConfigFileDescription [Provenance:ActivityConfiguration.ConfigFileDescription]
vodml-id ActivityConfiguration.ConfigFile.configFileDescription
multiplicity 0..1
description Points to the corresponding description class

2.2.2 objectType: ConfigFileDescription

vodml-id ActivityConfiguration.ConfigFileDescription
description Properties of the configuration files
package ActivityConfiguration
referrers ConfigFile
attributes
name feature value
name type ivoa:string
vodml-id ActivityConfiguration.ConfigFileDescription.name
multiplicity 1
description Name of the instance
contentType type ivoa:string
vodml-id ActivityConfiguration.ConfigFileDescription.contentType
multiplicity 1
description MIME-type or format of the configuration file
description type ivoa:string
vodml-id ActivityConfiguration.ConfigFileDescription.description
multiplicity 0..1
description A short text that explains the content and purpose of the configuration file.

2.2.3 objectType: Parameter

vodml-id ActivityConfiguration.Parameter
description A simple value which is part of the configuration of an activity instance
package ActivityConfiguration
referrers WasConfiguredBy
attributes
name feature value
value type ivoa:string
vodml-id ActivityConfiguration.Parameter.value
multiplicity 1
description The value of the parameter. The data type, meaning, units, etc., are stored in the ParameterDescription instance bound to it.
name type ivoa:string
vodml-id ActivityConfiguration.Parameter.name
multiplicity 1
description Name of the parameter
references
name feature value
parameterDescription type ParameterDescription [Provenance:ActivityConfiguration.ParameterDescription]
vodml-id ActivityConfiguration.Parameter.parameterDescription
multiplicity 0..1
description Gathers the properties and the description of the Parameter instance.
valueEntity type ValueEntity [Provenance:ValueEntity]
vodml-id ActivityConfiguration.Parameter.valueEntity
multiplicity 0..1
description A Parameter instance can have a value derived from a ValueEntity value element computed previously by some former Activity instance. Therefore, the ValueEntity it refers to is generated with another instance of the Activity class, in a different generation scenario executed previously. This references such a ValueEntity from the Parameter instance.

2.2.4 objectType: ParameterDescription

vodml-id ActivityConfiguration.ParameterDescription
description How to both use and interpret the parameter
package ActivityConfiguration
referrers Parameter
attributes
name feature value
name type ivoa:string
vodml-id ActivityConfiguration.ParameterDescription.name
multiplicity 1
description Name of the parameter
valueType type ivoa:string
vodml-id ActivityConfiguration.ParameterDescription.valueType
multiplicity 1
description VO-DML compliant data type of the parameter value
unit type ivoa:Unit
vodml-id ActivityConfiguration.ParameterDescription.unit
multiplicity 0..1
description VO compliant unit string used for this parameter
ucd type ivoa:string
vodml-id ActivityConfiguration.ParameterDescription.ucd
multiplicity 0..1
description Unified Content Descriptor, supplying a standardized classification of the physical quantity
utype type ivoa:string
vodml-id ActivityConfiguration.ParameterDescription.utype
multiplicity 0..1
description Expresses the role of the parameter in the context of VO data mode text
min type ivoa:string
vodml-id ActivityConfiguration.ParameterDescription.min
multiplicity 0..1
description Minimum parameter value as a string whose value can be interpreted by the valueType attribute
max type ivoa:string
vodml-id ActivityConfiguration.ParameterDescription.max
multiplicity 0..1
description Maximum parameter value as a string whose value can be interpreted by the valueType attribute
default type ivoa:string
vodml-id ActivityConfiguration.ParameterDescription.default
multiplicity 0..1
description Default parameter value as a string whose value can be interpreted by the valueType attribute.
options type ivoa:string
vodml-id ActivityConfiguration.ParameterDescription.options
multiplicity 0..1
description Comma separated list of possible values
description type ivoa:string
vodml-id ActivityConfiguration.ParameterDescription.description
multiplicity 0..1
description A short text that explains the content and purpose of this Parameter.

2.2.5 enumeration: TypeOfConfigArtifact

vodml-id ActivityConfiguration.TypeOfConfigArtifact
description The configuration for an Activity ( job) can be fully explicit , with a list of searchable parameters , or expressed into a document file storing the configuration . This attribute contains the type of config information at the end of the wasConfiguredby association instance .
package ActivityConfiguration
literals
name feature value
Parameter vodml-id ActivityConfiguration.TypeOfConfigArtifact.Parameter
description Label for parameter config artifact
Configfile vodml-id ActivityConfiguration.TypeOfConfigArtifact.Configfile
description Label for config file config artifact

2.2.6 objectType: WasConfiguredBy

vodml-id ActivityConfiguration.WasConfiguredBy
description This is an association class binding an Activity Instance to one configuration artefact which can be a Parameter instance or a ConfigFile instance . Attribute "artefactType" holds the type of its target .
package ActivityConfiguration
attributes
name feature value
artefactType type TypeOfConfigArtifact [Provenance:ActivityConfiguration.TypeOfConfigArtifact]
vodml-id ActivityConfiguration.WasConfiguredBy.artefactType
multiplicity 1
description Object type pointed by the instance
references
name feature value
configFile type ConfigFile [Provenance:ActivityConfiguration.ConfigFile]
vodml-id ActivityConfiguration.WasConfiguredBy.configFile
multiplicity 0..1
description Points to the configuration file
parameter type Parameter [Provenance:ActivityConfiguration.Parameter]
vodml-id ActivityConfiguration.WasConfiguredBy.parameter
multiplicity 0..1
description points to parameter

3.Element Identifiers/VO-DMLrefs

The following table shows all fully qualified vodml-ids for this data model. It is ordered alphabetically and the identifiers are hyper-linked to the location in the document where the actual element is fully defined.
vodml-id feature type description
vo-dml:model Data model describing the structure and content of the IVOA Provenance Data Model. This re-uses the concepts from the W3C Provenance DM, but extends it with a description layer for Activities and Entities.
Activity objectType A task executed at some time. It consumes products via relations of type Used and produces results via relations of type WasGeneratedBy. The method applied for this task is described in the ActivityDescription class and its subtree.
Activity.activityDescription reference Points to the corresponding description class
Activity.comment attribute A short text about some peculiar information on the instance.
Activity.endTime attribute Time when the Activity ends up.
Activity.id attribute Unique identifier for an Activity. Must be unique in the domain.
Activity.informant reference refers to an activity providing information
Activity.name attribute Activity name
Activity.startTime attribute This allows to know when the activity was launched . This is recommended to fill in as it helps to check dependencies and errors into the database.
Activity.used composition Gathers Entities used by the Activity instance
Activity.wasAssociatedWith composition Gathers Agents bound to this Activity instance
Activity.wasConfiguredBy composition Gathers Configuration elements for this Activity instance
ActivityDescription objectType Gives further information on how an activity works internally.
ActivityDescription.configFileDescription composition Gathers the description of the config files
ActivityDescription.description attribute A descriptive text for this kind of activity
ActivityDescription.docuLink attribute Link to more documentation
ActivityDescription.generationDescription composition This link points to some description of the results produced in the context of one specific ActivityDescription.
ActivityDescription.name attribute Instance name
ActivityDescription.parameterDescription composition Gathers the description classes explaining the Parameter object that can be applied when running an Activity that can follow this ActivityDescription template.
ActivityDescription.subtype attribute More specific subtype of the activity
ActivityDescription.type attribute type of the activity
ActivityDescription.usageDescription composition This link points to some description of the Usage in the context of one specific ActivityDescription.
ActivityDescription.version attribute Version number, if applicable
Agent objectType A person or an organisation that was involved in the follow-up of an Activity, or can be credited for the production of an Entity.
Agent.address attribute Agent's postmail address
Agent.affiliation attribute Agent's affiliation
Agent.comment attribute A short text about some peculiar information on the instance.
Agent.email attribute Email address of the Agent
Agent.id attribute Unique identifier for an Agent. Must be unique in the domain.
Agent.name attribute Agent name
Agent.phone attribute Agent's phone number
Agent.type attribute Defines the Agent type : Person, Organization or SoftwareAgent
Agent.url attribute Reference URL to the agent
AgentType enumeration A literal for specifying the Agent type : Individal or Organisation or SoftwareAgent
AgentType.Organization literal Type label for agents considered as organizations
AgentType.Person literal Type label for agents considered as persons
AgentType.SoftwareAgent literal Type label for agents considered as software agents
Collection objectType A collection of Entities. It is a way to consider a set of entities when produced and consumed with respect to an Activity. Allows coarse description of the provenance.
Collection.entity reference Binds a collection entity to its members
DatasetDescription objectType The description of a DatasetEntity. Can be pointed to by multiple instances of DatasetEntity.
DatasetDescription.contentType attribute MIME-type or format of the dataset
DatasetEntity objectType An Entity which represents a data file in the Provenance system. It is not the data file itself
Entity objectType A thing which is consumed or produced in a task , namely here in the astronomical domain. It represents some data as single element or file or an instrument.
Entity.comment attribute A short text about some peculiar information on the instance.
Entity.entityDescription reference Link to the corresponding EntityDescription instance. Many Entities may share the same EntityDescription instance.
Entity.generatedAtTime attribute The time of generation for the entity , in ISOTime
Entity.id attribute Unique identifier for an Entity. Must be unique in the domain.
Entity.invalidatedAtTime attribute Time stamp after which the entity is considered no longer valid for further usage in an Activity. It may still be available in the system but not used for operations .
Entity.location attribute A path, a URL, coordinates or the name of a place.
Entity.name attribute This is a text string which designate the Entity for display in application or diagrams . It can follow various syntax and naming conventions depending on the Entity subclass : dataset, quality flag, device name convention, etc .
Entity.usedEntity reference The link from the progenitor Entity to its descendant.
Entity.wasAttributedTo composition Gathers Agents to which the entity was attributed
Entity.wasGeneratedBy composition Binds to the activity which generated this entity
EntityDescription objectType This class is meant to store descriptive information for different categories of entities.
EntityDescription.description attribute A descriptive text for this kind of entity
EntityDescription.docuLink attribute Link to more documentation
EntityDescription.name attribute Instance name
EntityDescription.type attribute Type of the entity
GenerationDescription objectType This class gathers description features about the products an ActivityDescription considers as output results.
GenerationDescription.description attribute A descriptive text for this kind of entity generation
GenerationDescription.entityDescription reference Points to the description of the used entities
GenerationDescription.multiplicity attribute String representation of the number of expected output entities that will be generated with the given role (« unbounded «  if not set)
GenerationDescription.role attribute A label that describes the function of what was produced. It is defined in the context of an ActivityDescription instance.
GenerationDescription.type attribute Type of the entity generation. It is a free text attribute with some reserved words
UsageDescription objectType This class gathers description features about the products an ActivityDescription considers as input resources. It can differentiate various roles and types of Entities consumed by the task described by the corresponding ActivityDescription instance.
UsageDescription.description attribute A descriptive text for this kind of usage
UsageDescription.entityDescription reference Points to the description of the used entities
UsageDescription.multiplicity attribute String representation of the number of expected input entities that are used with the given role (« unbounded «  if not set)
UsageDescription.role attribute Function of the entity with respect to its usage by the activity.
UsageDescription.type attribute type of the usage. It is a free text attribute with some reserved words
Used objectType Binds an Activity to the Entities it consumes .
Used.entity reference Points to the used entity
Used.role attribute function of the entity with respect to the activity
Used.time attribute Time at which the usage of an entity started
Used.usageDescription reference This link points to some description of the Usage in the context of one specific ActivityDescription.
ValueDescription objectType Description of the properties of a ValueEntity.
ValueDescription.default attribute Default value as a string whose content can be interpreted by the valueType attribute
ValueDescription.max attribute Maximum value as a string whose content can be interpreted by the valueType attribute
ValueDescription.min attribute Minimum value as a string whose content can be interpreted by the valueType attribute
ValueDescription.options attribute Comma separated list of possible values
ValueDescription.ucd attribute VO-compliant UCD string
ValueDescription.unit attribute VO-compliant unit string
ValueDescription.utype attribute Role of the value in the context of an external VO data mode
ValueDescription.valueType attribute VODML-compliant data type of the value
ValueEntity objectType An entity that only contains a value. The way to interpret this value is described in the ValueDescription instance it linked to.
ValueEntity.value attribute The value of the Entity.
WasAssociatedWith objectType Denotes the assignment of responsibility to an agent for an activity.
WasAssociatedWith.agent reference Points to the agent
WasAssociatedWith.role attribute Function of the agent with respect to the activity The role values belong to the AgentRole list defined in IVOA Provenance DataModel, Table 9.
WasAttributedTo objectType Links an Agent to the Entity it is responsible for. Various roles for this relation are allowed and defined in the Provenance vocabulary under TypeOfAgentRole
WasAttributedTo.agent reference Points to the agent.
WasAttributedTo.role attribute Function of the agent with respect to the entity. Values for role are listed in the AgentRole type, as listed in Table 9 of the PROV-DM specification.
WasGeneratedBy objectType Binds an Entity to the Activity that produced it as a result.
WasGeneratedBy.activity reference points to the creating Activity instance.
WasGeneratedBy.generationDescription reference Points to the instance of GenerationDescription describing this kind of generated output.
WasGeneratedBy.role attribute Function of the entity with respect to the activity.
ActivityConfiguration package This package gathers the necessary classes for expressing the configuration of a task before, during and after execution. We consider only the executed version will be stored in a provenance information system.
ActivityConfiguration.ConfigFile objectType The values used to control the activity can be provided as a Configuration file document.
ActivityConfiguration.ConfigFile.comment attribute A descriptive text for this instance
ActivityConfiguration.ConfigFile.configFileDescription reference Points to the corresponding description class
ActivityConfiguration.ConfigFile.location attribute Path or URL to the config file
ActivityConfiguration.ConfigFile.name attribute Name of the file
ActivityConfiguration.ConfigFileDescription objectType Properties of the configuration files
ActivityConfiguration.ConfigFileDescription.contentType attribute MIME-type or format of the configuration file
ActivityConfiguration.ConfigFileDescription.description attribute A short text that explains the content and purpose of the configuration file.
ActivityConfiguration.ConfigFileDescription.name attribute Name of the instance
ActivityConfiguration.Parameter objectType A simple value which is part of the configuration of an activity instance
ActivityConfiguration.Parameter.name attribute Name of the parameter
ActivityConfiguration.Parameter.parameterDescription reference Gathers the properties and the description of the Parameter instance.
ActivityConfiguration.Parameter.value attribute The value of the parameter. The data type, meaning, units, etc., are stored in the ParameterDescription instance bound to it.
ActivityConfiguration.Parameter.valueEntity reference A Parameter instance can have a value derived from a ValueEntity value element computed previously by some former Activity instance. Therefore, the ValueEntity it refers to is generated with another instance of the Activity class, in a different generation scenario executed previously. This references such a ValueEntity from the Parameter instance.
ActivityConfiguration.ParameterDescription objectType How to both use and interpret the parameter
ActivityConfiguration.ParameterDescription.default attribute Default parameter value as a string whose value can be interpreted by the valueType attribute.
ActivityConfiguration.ParameterDescription.description attribute A short text that explains the content and purpose of this Parameter.
ActivityConfiguration.ParameterDescription.max attribute Maximum parameter value as a string whose value can be interpreted by the valueType attribute
ActivityConfiguration.ParameterDescription.min attribute Minimum parameter value as a string whose value can be interpreted by the valueType attribute
ActivityConfiguration.ParameterDescription.name attribute Name of the parameter
ActivityConfiguration.ParameterDescription.options attribute Comma separated list of possible values
ActivityConfiguration.ParameterDescription.ucd attribute Unified Content Descriptor, supplying a standardized classification of the physical quantity
ActivityConfiguration.ParameterDescription.unit attribute VO compliant unit string used for this parameter
ActivityConfiguration.ParameterDescription.utype attribute Expresses the role of the parameter in the context of VO data mode text
ActivityConfiguration.ParameterDescription.valueType attribute VO-DML compliant data type of the parameter value
ActivityConfiguration.TypeOfConfigArtifact enumeration The configuration for an Activity ( job) can be fully explicit , with a list of searchable parameters , or expressed into a document file storing the configuration . This attribute contains the type of config information at the end of the wasConfiguredby association instance .
ActivityConfiguration.TypeOfConfigArtifact.Configfile literal Label for config file config artifact
ActivityConfiguration.TypeOfConfigArtifact.Parameter literal Label for parameter config artifact
ActivityConfiguration.WasConfiguredBy objectType This is an association class binding an Activity Instance to one configuration artefact which can be a Parameter instance or a ConfigFile instance . Attribute "artefactType" holds the type of its target .
ActivityConfiguration.WasConfiguredBy.artefactType attribute Object type pointed by the instance
ActivityConfiguration.WasConfiguredBy.configFile reference Points to the configuration file
ActivityConfiguration.WasConfiguredBy.parameter reference points to parameter

4.Imported Models

This section lists the external models imported by the current data model. For each imported model we list URLs to the VO-DML and HTML representations and the prefix used for vodml-ids from inside the model.

4.1 ivoa

Model vodml-id ivoa
url http://www.ivoa.net/xml/VODML/20180519/IVOA-v1.0.vo-dml.xml
documentation url https://volute.g-vo.org/svn/trunk/projects/dm/vo-dml/models/ivoa/vo-dml/IVOA-v1.0.html