Provenance 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. 1.0 2019-07-19T16:15:43 ivoa http://www.ivoa.net/xml/VODML/20180519/IVOA-v1.0.vo-dml.xml https://volute.g-vo.org/svn/trunk/projects/dm/vo-dml/models/ivoa/vo-dml/IVOA-v1.0.html AgentType AgentType A literal for specifying the Agent type : Individal or Organisation or SoftwareAgent AgentType.Person Person Type label for agents considered as persons AgentType.Organization Organization Type label for agents considered as organizations AgentType.SoftwareAgent SoftwareAgent Type label for agents considered as software agents Agent Agent 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.id id Unique identifier for an Agent. Must be unique in the domain. ivoa:string 1 1 Agent.name name Agent name ivoa:string 1 1 Agent.type type Defines the Agent type : Person, Organization or SoftwareAgent Provenance:AgentType 0 1 Agent.comment comment A short text about some peculiar information on the instance. ivoa:string 0 1 Agent.email email Email address of the Agent ivoa:string 0 1 Agent.affiliation affiliation Agent's affiliation ivoa:string 0 1 Agent.phone phone Agent's phone number ivoa:string 0 1 Agent.address address Agent's postmail address ivoa:string 0 1 Agent.url url Reference URL to the agent ivoa:anyURI 0 1 WasAssociatedWith WasAssociatedWith Denotes the assignment of responsibility to an agent for an activity. WasAssociatedWith.role role Function of the agent with respect to the activity The role values belong to the AgentRole list defined in IVOA Provenance DataModel, Table 9. ivoa:string 0 1 WasAssociatedWith.agent agent Points to the agent Provenance:Agent 1 1 WasAttributedTo WasAttributedTo 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.role role 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. ivoa:string 0 1 WasAttributedTo.agent agent Points to the agent. Provenance:Agent 1 1 Activity Activity 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.id id Unique identifier for an Activity. Must be unique in the domain. ivoa:string 1 1 Activity.name name Activity name ivoa:string 0 1 Activity.startTime startTime 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. ivoa:datetime 0 1 Activity.endTime endTime Time when the Activity ends up. ivoa:datetime 0 1 Activity.comment comment A short text about some peculiar information on the instance. ivoa:string 0 1 Activity.wasAssociatedWith wasAssociatedWith Gathers Agents bound to this Activity instance Provenance:WasAssociatedWith 0 -1 Activity.used used Gathers Entities used by the Activity instance Provenance:Used 0 -1 Activity.wasConfiguredBy wasConfiguredBy Gathers Configuration elements for this Activity instance Provenance:ActivityConfiguration.WasConfiguredBy 0 -1 Activity.informant informant refers to an activity providing information Provenance:Activity 0 -1 Activity.activityDescription activityDescription Points to the corresponding description class Provenance:ActivityDescription 0 1 Used Used Binds an Activity to the Entities it consumes . Used.role role function of the entity with respect to the activity ivoa:string 0 1 Used.time time Time at which the usage of an entity started ivoa:datetime 0 1 Used.entity entity Points to the used entity Provenance:Entity 1 1 Used.usageDescription usageDescription This link points to some description of the Usage in the context of one specific ActivityDescription. Provenance:UsageDescription 0 1 Entity Entity 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.id id Unique identifier for an Entity. Must be unique in the domain. ivoa:string 1 1 Entity.name name 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 . ivoa:string 0 1 Entity.location location A path, a URL, coordinates or the name of a place. ivoa:string 0 1 Entity.generatedAtTime generatedAtTime The time of generation for the entity , in ISOTime ivoa:datetime 0 1 Entity.invalidatedAtTime invalidatedAtTime 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 . ivoa:datetime 0 1 Entity.comment comment A short text about some peculiar information on the instance. ivoa:string 0 1 Entity.wasGeneratedBy wasGeneratedBy Binds to the activity which generated this entity Provenance:WasGeneratedBy 0 1 Entity.wasAttributedTo wasAttributedTo Gathers Agents to which the entity was attributed Provenance:WasAttributedTo 0 -1 Entity.usedEntity usedEntity The link from the progenitor Entity to its descendant. Provenance:Entity 0 -1 Entity.entityDescription entityDescription Link to the corresponding EntityDescription instance. Many Entities may share the same EntityDescription instance. Provenance:EntityDescription 0 1 WasGeneratedBy WasGeneratedBy Binds an Entity to the Activity that produced it as a result. WasGeneratedBy.role role Function of the entity with respect to the activity. ivoa:string 0 1 WasGeneratedBy.activity activity points to the creating Activity instance. Provenance:Activity 1 1 WasGeneratedBy.generationDescription generationDescription Points to the instance of GenerationDescription describing this kind of generated output. Provenance:GenerationDescription 0 1 Collection Collection 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. Provenance:Entity Collection.entity entity Binds a collection entity to its members Provenance:Entity 0 -1 ValueEntity ValueEntity An entity that only contains a value. The way to interpret this value is described in the ValueDescription instance it linked to. Provenance:Entity Provenance:ValueEntity Provenance:ValueDescription ValueEntity.value value The value of the Entity. ivoa:string 1 1 DatasetEntity DatasetEntity An Entity which represents a data file in the Provenance system. It is not the data file itself Provenance:Entity Provenance:DatasetEntity Provenance:DatasetDescription ActivityDescription ActivityDescription Gives further information on how an activity works internally. ActivityDescription.name name Instance name ivoa:string 1 1 ActivityDescription.version version Version number, if applicable ivoa:string 0 1 ActivityDescription.description description A descriptive text for this kind of activity ivoa:string 0 1 ActivityDescription.docuLink docuLink Link to more documentation ivoa:anyURI 0 1 ActivityDescription.type type type of the activity ivoa:string 0 1 ActivityDescription.subtype subtype More specific subtype of the activity ivoa:string 0 1 ActivityDescription.parameterDescription parameterDescription Gathers the description classes explaining the Parameter object that can be applied when running an Activity that can follow this ActivityDescription template. Provenance:ActivityConfiguration.ParameterDescription 0 -1 ActivityDescription.configFileDescription configFileDescription Gathers the description of the config files Provenance:ActivityConfiguration.ConfigFileDescription 0 -1 ActivityDescription.usageDescription usageDescription This link points to some description of the Usage in the context of one specific ActivityDescription. Provenance:UsageDescription 0 -1 ActivityDescription.generationDescription generationDescription This link points to some description of the results produced in the context of one specific ActivityDescription. Provenance:GenerationDescription 0 -1 UsageDescription UsageDescription 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.role role Function of the entity with respect to its usage by the activity. ivoa:string 1 1 UsageDescription.description description A descriptive text for this kind of usage ivoa:string 0 1 UsageDescription.type type type of the usage. It is a free text attribute with some reserved words ivoa:string 0 1 UsageDescription.multiplicity multiplicity String representation of the number of expected input entities that are used with the given role (« unbounded «  if not set) ivoa:string 0 1 UsageDescription.entityDescription entityDescription Points to the description of the used entities Provenance:EntityDescription 0 -1 GenerationDescription GenerationDescription This class gathers description features about the products an ActivityDescription considers as output results. GenerationDescription.role role A label that describes the function of what was produced. It is defined in the context of an ActivityDescription instance. ivoa:string 1 1 GenerationDescription.description description A descriptive text for this kind of entity generation ivoa:string 0 1 GenerationDescription.type type Type of the entity generation. It is a free text attribute with some reserved words ivoa:string 0 1 GenerationDescription.multiplicity multiplicity String representation of the number of expected output entities that will be generated with the given role (« unbounded «  if not set) ivoa:string 0 1 GenerationDescription.entityDescription entityDescription Points to the description of the used entities Provenance:EntityDescription 0 -1 EntityDescription EntityDescription This class is meant to store descriptive information for different categories of entities. EntityDescription.name name Instance name ivoa:string 1 1 EntityDescription.description description A descriptive text for this kind of entity ivoa:string 1 1 EntityDescription.docuLink docuLink Link to more documentation ivoa:anyURI 0 1 EntityDescription.type type Type of the entity ivoa:string 0 1 ValueDescription ValueDescription Description of the properties of a ValueEntity. Provenance:EntityDescription ValueDescription.valueType valueType VODML-compliant data type of the value ivoa:string 1 1 ValueDescription.unit unit VO-compliant unit string ivoa:Unit 0 1 ValueDescription.ucd ucd VO-compliant UCD string ivoa:string 0 1 ValueDescription.utype utype Role of the value in the context of an external VO data mode ivoa:string 0 1 ValueDescription.min min Minimum value as a string whose content can be interpreted by the valueType attribute ivoa:string 0 1 ValueDescription.max max Maximum value as a string whose content can be interpreted by the valueType attribute ivoa:string 0 1 ValueDescription.default default Default value as a string whose content can be interpreted by the valueType attribute ivoa:string 0 1 ValueDescription.options options Comma separated list of possible values ivoa:string 0 1 DatasetDescription DatasetDescription The description of a DatasetEntity. Can be pointed to by multiple instances of DatasetEntity. Provenance:EntityDescription DatasetDescription.contentType contentType MIME-type or format of the dataset ivoa:string 1 1 ActivityConfiguration ActivityConfiguration 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.TypeOfConfigArtifact TypeOfConfigArtifact 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.Parameter Parameter Label for parameter config artifact ActivityConfiguration.TypeOfConfigArtifact.Configfile Configfile Label for config file config artifact ActivityConfiguration.ParameterDescription ParameterDescription How to both use and interpret the parameter ActivityConfiguration.ParameterDescription.name name Name of the parameter ivoa:string 1 1 ActivityConfiguration.ParameterDescription.valueType valueType VO-DML compliant data type of the parameter value ivoa:string 1 1 ActivityConfiguration.ParameterDescription.unit unit VO compliant unit string used for this parameter ivoa:Unit 0 1 ActivityConfiguration.ParameterDescription.ucd ucd Unified Content Descriptor, supplying a standardized classification of the physical quantity ivoa:string 0 1 ActivityConfiguration.ParameterDescription.utype utype Expresses the role of the parameter in the context of VO data mode text ivoa:string 0 1 ActivityConfiguration.ParameterDescription.min min Minimum parameter value as a string whose value can be interpreted by the valueType attribute ivoa:string 0 1 ActivityConfiguration.ParameterDescription.max max Maximum parameter value as a string whose value can be interpreted by the valueType attribute ivoa:string 0 1 ActivityConfiguration.ParameterDescription.default default Default parameter value as a string whose value can be interpreted by the valueType attribute. ivoa:string 0 1 ActivityConfiguration.ParameterDescription.options options Comma separated list of possible values ivoa:string 0 1 ActivityConfiguration.ParameterDescription.description description A short text that explains the content and purpose of this Parameter. ivoa:string 0 1 ActivityConfiguration.ConfigFileDescription ConfigFileDescription Properties of the configuration files ActivityConfiguration.ConfigFileDescription.name name Name of the instance ivoa:string 1 1 ActivityConfiguration.ConfigFileDescription.contentType contentType MIME-type or format of the configuration file ivoa:string 1 1 ActivityConfiguration.ConfigFileDescription.description description A short text that explains the content and purpose of the configuration file. ivoa:string 0 1 ActivityConfiguration.Parameter Parameter A simple value which is part of the configuration of an activity instance ActivityConfiguration.Parameter.value value The value of the parameter. The data type, meaning, units, etc., are stored in the ParameterDescription instance bound to it. ivoa:string 1 1 ActivityConfiguration.Parameter.name name Name of the parameter ivoa:string 1 1 ActivityConfiguration.Parameter.valueEntity valueEntity 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. Provenance:ValueEntity 0 1 ActivityConfiguration.Parameter.parameterDescription parameterDescription Gathers the properties and the description of the Parameter instance. Provenance:ActivityConfiguration.ParameterDescription 0 1 ActivityConfiguration.ConfigFile ConfigFile The values used to control the activity can be provided as a Configuration file document. ActivityConfiguration.ConfigFile.name name Name of the file ivoa:string 1 1 ActivityConfiguration.ConfigFile.location location Path or URL to the config file ivoa:string 0 1 ActivityConfiguration.ConfigFile.comment comment A descriptive text for this instance ivoa:string 0 1 ActivityConfiguration.ConfigFile.configFileDescription configFileDescription Points to the corresponding description class Provenance:ActivityConfiguration.ConfigFileDescription 0 1 ActivityConfiguration.WasConfiguredBy WasConfiguredBy 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 artefactType Object type pointed by the instance Provenance:ActivityConfiguration.TypeOfConfigArtifact 1 1 ActivityConfiguration.WasConfiguredBy.configFile configFile Points to the configuration file Provenance:ActivityConfiguration.ConfigFile 0 1 ActivityConfiguration.WasConfiguredBy.parameter parameter points to parameter Provenance:ActivityConfiguration.Parameter 0 1