.. _Facet: Facet ===== .. _AccessPointFacet: AccessPointFacet ---------------- AccessPointFacet captures information on an 'access point' of a resource, i.e., any web-based endpoint to programmatically interact with the resource via a known protocol. For example, it is used to define the network endpoint to contact the service. The endpoint can expose a well-known high-level protocol. .. table:: **AccessPointFacet** ``extends`` **Facet** +------------------------------------------+--------------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Properties | +==========================================+================================+==========================================================+=================================================================================================================================================================================================================+==================================================================================================================================================================+ | **Name** | **Type** | **Attributes** | **Description** | +------------------------------------------+--------------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | endpoint | String | ``Mandatory:true`` ``ReadOnly:true`` ``NotNull:true`` | The URI which characterises the specific endpoint instance. | +------------------------------------------+--------------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | authorization | :ref:`Property ` | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | Contains authorisation information. e.g., a token, the couple username:password, etc. | +------------------------------------------+--------------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | protocol | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | The high-level protocol used by the access point. The String could contain the version if needed. e.g., Web Map Service (WMS) and not HyperText Transfer Protocol (HTTP) which is already contained in the URI. | +------------------------------------------+--------------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | entryName | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | A distinguishing string to be used by clients to identify the access point of interest. | +------------------------------------------+--------------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | description | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | A human-oriented text accompanying the access point. | +------------------------------------------+--------------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Known Usage** | +------------------------------------------+--------------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | +------------------------------------------+--------------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`ConcreteDataset ` | :ref:`ConsistsOf ` | 1..n | :ref:`AccessPointFacet ` | The access point to use for having access to the concrete dataset. The embargoState can be modeled through the access policy defined in the consistsOf relation. | +------------------------------------------+--------------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dataset ` | :ref:`ConsistsOf ` | 0..n | :ref:`AccessPointFacet ` | The access point to use for having access to the dataset. The embargoState can be modeled through the access policy defined in the consistsOf relation. | +------------------------------------------+--------------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`EService ` | :ref:`ConsistsOf ` | 1..n | :ref:`AccessPointFacet ` | Identify the endpoints of the EService. | +------------------------------------------+--------------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ The **AccessPointFacet** current version is 1.0.0. Changelog: * **1.0.0**: First Version. .. _ActionFacet: ActionFacet ----------- This facet is expected to capture information on which action perform while a resource is added or removed from a context. .. table:: **ActionFacet** ``extends`` **Facet** +----------------------------------------+------------------------------------------------+----------------------------------------------------------+------------------------------------------------------+-----------------+ | Properties | +========================================+================================================+==========================================================+======================================================+=================+ | **Name** | **Type** | **Attributes** | **Description** | +----------------------------------------+------------------------------------------------+----------------------------------------------------------+------------------------------------------------------+-----------------+ | options | String | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | The options/params to use when executing the action. | +----------------------------------------+------------------------------------------------+----------------------------------------------------------+------------------------------------------------------+-----------------+ | type | :ref:`EnumStringProperty ` | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | Type of action | +----------------------------------------+------------------------------------------------+----------------------------------------------------------+------------------------------------------------------+-----------------+ | command | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | The command to execute. | +----------------------------------------+------------------------------------------------+----------------------------------------------------------+------------------------------------------------------+-----------------+ | source | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:true`` | From where to download the action. | +----------------------------------------+------------------------------------------------+----------------------------------------------------------+------------------------------------------------------+-----------------+ | **Known Usage** | +----------------------------------------+------------------------------------------------+----------------------------------------------------------+------------------------------------------------------+-----------------+ | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | +----------------------------------------+------------------------------------------------+----------------------------------------------------------+------------------------------------------------------+-----------------+ | No specific known usage for this type. | +----------------------------------------+------------------------------------------------+----------------------------------------------------------+------------------------------------------------------+-----------------+ The **ActionFacet** current version is 1.0.0. Changelog: * **1.0.0**: First Version. .. _CPUFacet: CPUFacet -------- CPUFacet captures information on the Central Processing Unit (CPU) of the resource it is associated with. A resource which needs to indicate a multi-processor/multi-core CPU will consist of more than one CPUFacet. Even if more than one CPUFacet is associated with a resource (i.e., an :ref:`HostingNode `), we did not find any reason to differentiate the CPUs. .. table:: **CPUFacet** ``extends`` **Facet** +----------------------------------------+--------------------------------+--------------------------------------------------------+---------------------------------------------------+----------------------------------------+ | Properties | +========================================+================================+========================================================+===================================================+========================================+ | **Name** | **Type** | **Attributes** | **Description** | +----------------------------------------+--------------------------------+--------------------------------------------------------+---------------------------------------------------+----------------------------------------+ | clockSpeed | String | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | Clock speed expressed with the unit, e.g., 1 GHz. | +----------------------------------------+--------------------------------+--------------------------------------------------------+---------------------------------------------------+----------------------------------------+ | model | String | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | CPU Model | +----------------------------------------+--------------------------------+--------------------------------------------------------+---------------------------------------------------+----------------------------------------+ | vendor | String | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | CPU Vendor | +----------------------------------------+--------------------------------+--------------------------------------------------------+---------------------------------------------------+----------------------------------------+ | **Known Usage** | +----------------------------------------+--------------------------------+--------------------------------------------------------+---------------------------------------------------+----------------------------------------+ | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | +----------------------------------------+--------------------------------+--------------------------------------------------------+---------------------------------------------------+----------------------------------------+ | :ref:`HostingNode ` | :ref:`ConsistsOf ` | 1..n | :ref:`CPUFacet ` | The CPU equipping the Hosting Node. | +----------------------------------------+--------------------------------+--------------------------------------------------------+---------------------------------------------------+----------------------------------------+ | :ref:`VirtualMachine ` | :ref:`ConsistsOf ` | 1..n | :ref:`CPUFacet ` | The CPU equipping the Virtual Machine. | +----------------------------------------+--------------------------------+--------------------------------------------------------+---------------------------------------------------+----------------------------------------+ The **CPUFacet** current version is 1.0.0. Changelog: * **1.0.0**: First Version. .. _CapabilityFacet: CapabilityFacet --------------- CapabilityFacet captures a defined facility for performing a specified task supported by a given Resource. It is mainly used to provide a human-readable description of the capabilities of a resource (e.g., the support for transactions of an electronic device or some non-functional properties of a service like its replicability to support High-Availability (HA)). .. table:: **CapabilityFacet** ``extends`` **Facet** +----------------------------+--------------------------------+----------------------------------------------------------+-------------------------------------------------+------------------------------------------------+ | Properties | +============================+================================+==========================================================+=================================================+================================================+ | **Name** | **Type** | **Attributes** | **Description** | +----------------------------+--------------------------------+----------------------------------------------------------+-------------------------------------------------+------------------------------------------------+ | name | String | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | The distinguishing name of the capability. | +----------------------------+--------------------------------+----------------------------------------------------------+-------------------------------------------------+------------------------------------------------+ | qualifier | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | A string used to specialise the capability. | +----------------------------+--------------------------------+----------------------------------------------------------+-------------------------------------------------+------------------------------------------------+ | description | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | A human oriented description of the capability. | +----------------------------+--------------------------------+----------------------------------------------------------+-------------------------------------------------+------------------------------------------------+ | **Known Usage** | +----------------------------+--------------------------------+----------------------------------------------------------+-------------------------------------------------+------------------------------------------------+ | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | +----------------------------+--------------------------------+----------------------------------------------------------+-------------------------------------------------+------------------------------------------------+ | :ref:`Service ` | :ref:`ConsistsOf ` | 0..n | :ref:`CapabilityFacet ` | Any facility supported/offered by the Service. | +----------------------------+--------------------------------+----------------------------------------------------------+-------------------------------------------------+------------------------------------------------+ | :ref:`Software ` | :ref:`ConsistsOf ` | 0..n | :ref:`CapabilityFacet ` | | +----------------------------+--------------------------------+----------------------------------------------------------+-------------------------------------------------+------------------------------------------------+ The **CapabilityFacet** current version is 1.0.0. Changelog: * **1.0.0**: First Version. .. _ContactFacet: ContactFacet ------------ ContactFacet captures information on a point of contact for the resource, i.e., a person or a department serving as the coordinator or focal point of information concerning the resource. .. table:: **ContactFacet** ``extends`` **Facet** +------------------------------------------+----------------------------------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | Properties | +==========================================+========================================+===========================================================================================================+================================================================================================+=================================================================================================+ | **Name** | **Type** | **Attributes** | **Description** | +------------------------------------------+----------------------------------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | eMail | String | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` ``Regex:^[a-z0-9._%+-]{1,128}@[a-z0-9.-]{1,128}$`` | Email address | +------------------------------------------+----------------------------------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | name | String | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | First Name | +------------------------------------------+----------------------------------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | surname | String | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | Surname | +------------------------------------------+----------------------------------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | middleName | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | Middle Name | +------------------------------------------+----------------------------------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | title | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | A name describing the profession or marital status of the point of contact. e.g., Dr, Mrs, Mr. | +------------------------------------------+----------------------------------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | **Known Usage** | +------------------------------------------+----------------------------------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | +------------------------------------------+----------------------------------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`Actor ` | :ref:`IsIdentifiedBy ` | 1..1 | :ref:`ContactFacet ` | An Actor has at least a Contact Facet which permit to identify the Actor per se. | +------------------------------------------+----------------------------------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`ConcreteDataset ` | :ref:`HasMaintainer ` | 1..n | :ref:`ContactFacet ` | The contact information of the entity responsible for the maintenance of the concrete dataset | +------------------------------------------+----------------------------------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`Dataset ` | :ref:`HasContact ` | 1..n | :ref:`ContactFacet ` | The contact information of the entity responsible for the dataset. | +------------------------------------------+----------------------------------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`Dataset ` | :ref:`HasContributor ` | 0..n | :ref:`ContactFacet ` | The contact information on contributors supporting the creation and development of the Dataset. | +------------------------------------------+----------------------------------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`Dataset ` | :ref:`HasCreator ` | 0..n | :ref:`ContactFacet ` | The contact information of the creator of the Dataset. | +------------------------------------------+----------------------------------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`Dataset ` | :ref:`HasCurator ` | 0..n | :ref:`ContactFacet ` | The contact information of the entity responsible for the curation of the dataset. | +------------------------------------------+----------------------------------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`Dataset ` | :ref:`HasMaintainer ` | 0..n | :ref:`ContactFacet ` | The contact information of the entity responsible for the maintenance of the dataset. | +------------------------------------------+----------------------------------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`Dataset ` | :ref:`HasOwner ` | 0..n | :ref:`ContactFacet ` | The contact information of the entity having the ownership of the dataset. | +------------------------------------------+----------------------------------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`Schema ` | :ref:`HasContact ` | 1..n | :ref:`ContactFacet ` | | +------------------------------------------+----------------------------------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`Site ` | :ref:`HasContact ` | 1..n | :ref:`ContactFacet ` | The main contact for the Site. | +------------------------------------------+----------------------------------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`Site ` | :ref:`HasMaintainer ` | 1..n | :ref:`ContactFacet ` | Contact information of the maintainer of the Site. | +------------------------------------------+----------------------------------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`Site ` | :ref:`HasManager ` | 1..n | :ref:`ContactFacet ` | Contact information of the Site Manager. | +------------------------------------------+----------------------------------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ The **ContactFacet** current version is 1.0.0. Changelog: * **1.0.0**: First Version. .. _ContactReferenceFacet: ContactReferenceFacet --------------------- ContactReferenceFacet captures information on the primary and authoritative contact for the resource it is associated with. .. table:: **ContactReferenceFacet** ``extends`` **Facet** +----------------------+--------------------------------+----------------------------------------------------------+------------------------------------------------------+-----------------+ | Properties | +======================+================================+==========================================================+======================================================+=================+ | **Name** | **Type** | **Attributes** | **Description** | +----------------------+--------------------------------+----------------------------------------------------------+------------------------------------------------------+-----------------+ | address | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | A physical address | +----------------------+--------------------------------+----------------------------------------------------------+------------------------------------------------------+-----------------+ | phoneNumber | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | A phone number | +----------------------+--------------------------------+----------------------------------------------------------+------------------------------------------------------+-----------------+ | website | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | The main website | +----------------------+--------------------------------+----------------------------------------------------------+------------------------------------------------------+-----------------+ | **Known Usage** | +----------------------+--------------------------------+----------------------------------------------------------+------------------------------------------------------+-----------------+ | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | +----------------------+--------------------------------+----------------------------------------------------------+------------------------------------------------------+-----------------+ | :ref:`Actor ` | :ref:`ConsistsOf ` | 0..n | :ref:`ContactReferenceFacet ` | | +----------------------+--------------------------------+----------------------------------------------------------+------------------------------------------------------+-----------------+ The **ContactReferenceFacet** current version is 1.0.0. Changelog: * **1.0.0**: First Version. .. _CoverageFacet: CoverageFacet ------------- CoverageFacet captures information on the extent of the resource, i.e., any aspect aiming at capturing an indicator of the amount/area the resource covers be it a geospatial area, a temporal area, or any other 'area'. Let consider a dataset containing information regarding the salinity of a specific ocean area in a certain amount of time. What is essential in the information system is not representing the data of the salinity. Instead, to specify the temporal period and theocean area the dataset is valid. This information is captured by the CoverageFacet. .. table:: **CoverageFacet** ``extends`` **Facet** +--------------------------+--------------------------------------------------+--------------------------------------------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ | Properties | +==========================+==================================================+========================================================+===============================================================================+=========================================================================================================================+ | **Name** | **Type** | **Attributes** | **Description** | +--------------------------+--------------------------------------------------+--------------------------------------------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ | coverage | :ref:`ValueSchema ` | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | The value indicates the 'area' covered by the dataset according to the schema | +--------------------------+--------------------------------------------------+--------------------------------------------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ | **Known Usage** | +--------------------------+--------------------------------------------------+--------------------------------------------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | +--------------------------+--------------------------------------------------+--------------------------------------------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dataset ` | :ref:`HasCoverage ` | 1..n | :ref:`CoverageFacet ` | Any coverage related information (e.g. topic, species) characterising the content of the dataset. | +--------------------------+--------------------------------------------------+--------------------------------------------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dataset ` | :ref:`HasSpatialCoverage ` | 0..n | :ref:`CoverageFacet ` | Any geo-spatial coverage information characterising the content of the dataset, e.g. the area covered by the dataset. | +--------------------------+--------------------------------------------------+--------------------------------------------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dataset ` | :ref:`HasTemporalCoverage ` | 0..n | :ref:`CoverageFacet ` | Any temporal coverage information characterising the content of the dataset, e.g. the time-span covered by the dataset. | +--------------------------+--------------------------------------------------+--------------------------------------------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ The **CoverageFacet** current version is 1.0.0. Changelog: * **1.0.0**: First Version. .. _DescriptiveMetadataFacet: DescriptiveMetadataFacet ------------------------ DescriptiveMetadataFacet captures information on descriptive metadata to be associated with the resource. This facet is mainly used to attach metadata to a Dataset. .. table:: **DescriptiveMetadataFacet** ``extends`` **Facet** +--------------------------+----------------------------------+--------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ | Properties | +==========================+==================================+========================================================+=================================================================================+=======================================================================================+ | **Name** | **Type** | **Attributes** | **Description** | +--------------------------+----------------------------------+--------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ | descriptiveMetadata | :ref:`ValueSchema ` | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | A metadata record representing the descriptive metadata according to the schema | +--------------------------+----------------------------------+--------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ | **Known Usage** | +--------------------------+----------------------------------+--------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | +--------------------------+----------------------------------+--------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ | :ref:`Dataset ` | :ref:`ConsistsOf ` | 0..n | :ref:`DescriptiveMetadataFacet ` | Any descriptive information associated with the dataset, e.g. for discovery purposes. | +--------------------------+----------------------------------+--------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ | :ref:`Schema ` | :ref:`ConsistsOf ` | 0..n | :ref:`DescriptiveMetadataFacet ` | | +--------------------------+----------------------------------+--------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ | :ref:`Service ` | :ref:`ConsistsOf ` | 0..n | :ref:`DescriptiveMetadataFacet ` | Any descriptive information associated with the service, e.g. for discovery purposes. | +--------------------------+----------------------------------+--------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ The **DescriptiveMetadataFacet** current version is 1.0.0. Changelog: * **1.0.0**: First Version. .. _EventFacet: EventFacet ---------- EventFacet captures information on a certain event/happening characterising the life cycle of the resource. Examples of an event are the start time of a virtual machine or the activation time of an electronic service. .. table:: **EventFacet** ``extends`` **Facet** +----------------------------------------+--------------------------------+--------------------------------------------------------+----------------------------------------+-------------------------------------------------------------------------------------------------------------+ | Properties | +========================================+================================+========================================================+========================================+=============================================================================================================+ | **Name** | **Type** | **Attributes** | **Description** | +----------------------------------------+--------------------------------+--------------------------------------------------------+----------------------------------------+-------------------------------------------------------------------------------------------------------------+ | date | Date | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | The time the event took place/occurred | +----------------------------------------+--------------------------------+--------------------------------------------------------+----------------------------------------+-------------------------------------------------------------------------------------------------------------+ | event | String | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | The typology of event | +----------------------------------------+--------------------------------+--------------------------------------------------------+----------------------------------------+-------------------------------------------------------------------------------------------------------------+ | **Known Usage** | +----------------------------------------+--------------------------------+--------------------------------------------------------+----------------------------------------+-------------------------------------------------------------------------------------------------------------+ | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | +----------------------------------------+--------------------------------+--------------------------------------------------------+----------------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`Dataset ` | :ref:`ConsistsOf ` | 0..n | :ref:`EventFacet ` | Any 'event' characterising the lifecycle of the dataset, e.g. collection date, last collection date. | +----------------------------------------+--------------------------------+--------------------------------------------------------+----------------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`EService ` | :ref:`ConsistsOf ` | 1..n | :ref:`EventFacet ` | Events characterising the current status and lifecycle of the service, e.g. ActivationTime, DeploymentTime. | +----------------------------------------+--------------------------------+--------------------------------------------------------+----------------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`HostingNode ` | :ref:`ConsistsOf ` | 1..n | :ref:`EventFacet ` | Every event characterizing the life cycle of the Hosting Node, e.g. the activation time. | +----------------------------------------+--------------------------------+--------------------------------------------------------+----------------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`VirtualMachine ` | :ref:`ConsistsOf ` | 1..n | :ref:`EventFacet ` | Every event characterizing the life cycle of the Virtual Machine, e.g. the activation time. | +----------------------------------------+--------------------------------+--------------------------------------------------------+----------------------------------------+-------------------------------------------------------------------------------------------------------------+ The **EventFacet** current version is 1.0.0. Changelog: * **1.0.0**: First Version. .. _IdentifierFacet: IdentifierFacet --------------- IdentifierFacet captures information on identifiers (other than the ones automatically generated by the system) that can be attached to a resource. .. table:: **IdentifierFacet** ``extends`` **Facet** +------------------------------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+---------------------------------------------------------+--------------------------------------------------------------+ | Properties | +======================================================+========================================+======================================================================================================+=========================================================+==============================================================+ | **Name** | **Type** | **Attributes** | **Description** | +------------------------------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+---------------------------------------------------------+--------------------------------------------------------------+ | identificationType | String | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` ``Regex:^(URI|DOI|IRI|URL|URN|UUID|STRING)$`` | The typology of identifier | +------------------------------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+---------------------------------------------------------+--------------------------------------------------------------+ | value | String | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | The identifier | +------------------------------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+---------------------------------------------------------+--------------------------------------------------------------+ | perstent | Boolean | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | To indicate whether the identifier is persistent or not | +------------------------------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+---------------------------------------------------------+--------------------------------------------------------------+ | **Known Usage** | +------------------------------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+---------------------------------------------------------+--------------------------------------------------------------+ | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | +------------------------------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+---------------------------------------------------------+--------------------------------------------------------------+ | :ref:`ConfigurationTemplate ` | :ref:`IsIdentifiedBy ` | 1..1 | :ref:`IdentifierFacet ` | | +------------------------------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+---------------------------------------------------------+--------------------------------------------------------------+ | :ref:`Dataset ` | :ref:`IsIdentifiedBy ` | 1..1 | :ref:`IdentifierFacet ` | The set of Identifiers associated with the Dataset instance. | +------------------------------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+---------------------------------------------------------+--------------------------------------------------------------+ | :ref:`Site ` | :ref:`IsIdentifiedBy ` | 1..1 | :ref:`IdentifierFacet ` | The Site Identifier. | +------------------------------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------------+---------------------------------------------------------+--------------------------------------------------------------+ The **IdentifierFacet** current version is 1.0.0. Changelog: * **1.0.0**: First Version. .. _LicenseFacet: LicenseFacet ------------ LicenseFacet captures information on any license associated with the resource to capture the policies governing its exploitation and use. Example of use is the licence of a dataset e.g., Creative Commons Attribution (CC-BY) or the licence of software such as GPL. This facet is used to provide for human knowledge, but it is not excluded the usage by infrastructure services which enforces the respect of the licence e.g., a service which denies the usage of a dataset with Creative Commons Attribution No-Derivatives (CC-BY-ND)licence to produce a new dataset. .. table:: **LicenseFacet** ``extends`` **Facet** +----------------------------+--------------------------------+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | Properties | +============================+================================+========================================================+=================================================================================================================================================================================+=================================================================================================================================================+ | **Name** | **Type** | **Attributes** | **Description** | +----------------------------+--------------------------------+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | name | String | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | The common name of the license. e.g., European Union Public Licence (EUPL) 1.1, GNU General Public License (GPL) 2, Berkeley Software Distribution (BSD), Common Creative (CC). | +----------------------------+--------------------------------+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | textURL | String | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | The URL to the actual text of the license. | +----------------------------+--------------------------------+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | **Known Usage** | +----------------------------+--------------------------------+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | +----------------------------+--------------------------------+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dataset ` | :ref:`ConsistsOf ` | 0..n | :ref:`LicenseFacet ` | The licence governing dataset exploitation. The duration of license (if any) is captured by the expiry date defined in the consistsOf relation. | +----------------------------+--------------------------------+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`EService ` | :ref:`ConsistsOf ` | 0..n | :ref:`LicenseFacet ` | The specific terms of use governing the exploitation of the EService. | +----------------------------+--------------------------------+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ The **LicenseFacet** current version is 1.0.0. Changelog: * **1.0.0**: First Version. .. _LocationFacet: LocationFacet ------------- LocationFacet captures information on a physical area characterising the resource it is associated with. This should not be confused with :ref:`CoverageFacet `. The LocationFacet provides information of a location (eventually using latitude and longitude), instead :ref:`CoverageFacet ` provide a way to to define the spatial or the temporal extent the resource represent. It is mainly used to locate a data centre or to the geographic references of a legal body playing the role of an actor in the infrastructure. .. table:: **LocationFacet** ``extends`` **Facet** +--------------------+--------------------------------+----------------------------------------------------------+--------------------------------------+-----------------+ | Properties | +====================+================================+==========================================================+======================================+=================+ | **Name** | **Type** | **Attributes** | **Description** | +--------------------+--------------------------------+----------------------------------------------------------+--------------------------------------+-----------------+ | longitude | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | Longitude | +--------------------+--------------------------------+----------------------------------------------------------+--------------------------------------+-----------------+ | latitude | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | Latitude | +--------------------+--------------------------------+----------------------------------------------------------+--------------------------------------+-----------------+ | location | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | The City name | +--------------------+--------------------------------+----------------------------------------------------------+--------------------------------------+-----------------+ | country | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | The English name of the country | +--------------------+--------------------------------+----------------------------------------------------------+--------------------------------------+-----------------+ | **Known Usage** | +--------------------+--------------------------------+----------------------------------------------------------+--------------------------------------+-----------------+ | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | +--------------------+--------------------------------+----------------------------------------------------------+--------------------------------------+-----------------+ | :ref:`Site ` | :ref:`ConsistsOf ` | 1..n | :ref:`LocationFacet ` | | +--------------------+--------------------------------+----------------------------------------------------------+--------------------------------------+-----------------+ The **LocationFacet** current version is 1.0.0. Changelog: * **1.0.0**: First Version. .. _MemoryFacet: MemoryFacet ----------- MemoryFacet captures information on computer memory equipping the resource and its usage. Any resource describing a computing machine must have at least two types of memories i.e., persistent and volatile. For such a reason, it has been identified the ConsistsOf relation called :ref:`HasMemory `. It is in charge of the specialisation :ref:`HasVolatileMemory ` and :ref:`HasPersistentMemory ` to clarify the semantics of the memory. .. table:: **MemoryFacet** ``extends`` **Facet** +----------------------------------------+--------------------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------+-------------------------------------------------+ | Properties | +========================================+==================================================+=====================================================================================================+==================================+=================================================+ | **Name** | **Type** | **Attributes** | **Description** | +----------------------------------------+--------------------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------+-------------------------------------------------+ | used | Long | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | | +----------------------------------------+--------------------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------+-------------------------------------------------+ | unit | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` ``Regex:^(Byte|kB|MB|GB|TB|PB|EB|ZB|YB)$`` | | +----------------------------------------+--------------------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------+-------------------------------------------------+ | size | Long | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | | +----------------------------------------+--------------------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------+-------------------------------------------------+ | **Known Usage** | +----------------------------------------+--------------------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------+-------------------------------------------------+ | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | +----------------------------------------+--------------------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------+-------------------------------------------------+ | :ref:`HostingNode ` | :ref:`HasPersistentMemory ` | 1..n | :ref:`MemoryFacet ` | The Disk Space Capacity of the Hosting Node. | +----------------------------------------+--------------------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------+-------------------------------------------------+ | :ref:`HostingNode ` | :ref:`HasVolatileMemory ` | 1..n | :ref:`MemoryFacet ` | The RAM Capacity of the Hosting Node. | +----------------------------------------+--------------------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------+-------------------------------------------------+ | :ref:`VirtualMachine ` | :ref:`HasPersistentMemory ` | 1..n | :ref:`MemoryFacet ` | The Disk Space Capacity of the Virtual Machine. | +----------------------------------------+--------------------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------+-------------------------------------------------+ | :ref:`VirtualMachine ` | :ref:`HasVolatileMemory ` | 1..n | :ref:`MemoryFacet ` | The RAM Capacity of the Virtual Machine. | +----------------------------------------+--------------------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------+-------------------------------------------------+ The **MemoryFacet** current version is 1.0.0. Changelog: * **1.0.0**: First Version. .. _NetworkingFacet: NetworkingFacet --------------- NetworkingFacet captures information on any (computer) network interface associated with the resource.It is mainly used to describe the network interface of a host. It should not be confused with the :ref:`AccessPointFacet ` which instead describes the protocol and the endpoint of a web-based service. .. table:: **NetworkingFacet** ``extends`` **Facet** +----------------------------------------+----------------------------------------+----------------------------------------------------------+------------------------------------------+----------------------------------------------------+ | Properties | +========================================+========================================+==========================================================+==========================================+====================================================+ | **Name** | **Type** | **Attributes** | **Description** | +----------------------------------------+----------------------------------------+----------------------------------------------------------+------------------------------------------+----------------------------------------------------+ | IPAddress | String | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | Internet Protocol (IP) Address | +----------------------------------------+----------------------------------------+----------------------------------------------------------+------------------------------------------+----------------------------------------------------+ | broadcastAddress | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | Broadcast Address | +----------------------------------------+----------------------------------------+----------------------------------------------------------+------------------------------------------+----------------------------------------------------+ | hostName | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | Host Name | +----------------------------------------+----------------------------------------+----------------------------------------------------------+------------------------------------------+----------------------------------------------------+ | domainName | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | Domain Name | +----------------------------------------+----------------------------------------+----------------------------------------------------------+------------------------------------------+----------------------------------------------------+ | mask | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | Network Mask | +----------------------------------------+----------------------------------------+----------------------------------------------------------+------------------------------------------+----------------------------------------------------+ | **Known Usage** | +----------------------------------------+----------------------------------------+----------------------------------------------------------+------------------------------------------+----------------------------------------------------+ | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | +----------------------------------------+----------------------------------------+----------------------------------------------------------+------------------------------------------+----------------------------------------------------+ | :ref:`HostingNode ` | :ref:`IsIdentifiedBy ` | 1..1 | :ref:`NetworkingFacet ` | The Network ID characterising the Hosting Node. | +----------------------------------------+----------------------------------------+----------------------------------------------------------+------------------------------------------+----------------------------------------------------+ | :ref:`Site ` | :ref:`ConsistsOf ` | 1..n | :ref:`NetworkingFacet ` | | +----------------------------------------+----------------------------------------+----------------------------------------------------------+------------------------------------------+----------------------------------------------------+ | :ref:`VirtualMachine ` | :ref:`IsIdentifiedBy ` | 1..1 | :ref:`NetworkingFacet ` | The Network ID characterising the Virtual Machine. | +----------------------------------------+----------------------------------------+----------------------------------------------------------+------------------------------------------+----------------------------------------------------+ The **NetworkingFacet** current version is 1.0.0. Changelog: * **1.0.0**: First Version. .. _ProvenanceFacet: ProvenanceFacet --------------- ProvenanceFacet captures information on provenance/lineage of the entire resource. It is mainly used to describe provenance information of a Dataset. .. table:: **ProvenanceFacet** ``extends`` **Facet** +--------------------------+----------------------------------+------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+ | Properties | +==========================+==================================+======================================================================================================+===========================================================================================================================================================================================================================================+====================================================+ | **Name** | **Type** | **Attributes** | **Description** | +--------------------------+----------------------------------+------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+ | document | :ref:`ValueSchema ` | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | Provenance Document, e.g., an XML according to the reference schema. | +--------------------------+----------------------------------+------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+ | reference | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | The ID of the referenced resource. | +--------------------------+----------------------------------+------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+ | relationship | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` ``Regex:^(wasDerivedFrom|wasGeneratedBy)$`` | Relationship with the resource indicated by ID. Please note that the provenance has not been modelled as IsRelatedTo specialization, because the source resource is not necessarly in the IS or could be deleted from the IS at any time. | +--------------------------+----------------------------------+------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+ | **Known Usage** | +--------------------------+----------------------------------+------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+ | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | +--------------------------+----------------------------------+------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+ | :ref:`Dataset ` | :ref:`ConsistsOf ` | 0..n | :ref:`ProvenanceFacet ` | Any provenance record associated with the dataset. | +--------------------------+----------------------------------+------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+ The **ProvenanceFacet** current version is 1.0.0. Changelog: * **1.0.0**: First Version. .. _SchemaFacet: SchemaFacet ----------- SchemaFacet captures information on any schema, i.e., a vocabulary used to validate a document associated with a resource. Examples of schema are JavaScript Object Notation (JSON) schema and XML schema. JSON schema "is a vocabulary that allows you to annotate and validate JSON documents". JSON schema is under standardisation by Internet Engineering Task force (IETF) (see references at https://json-schema.org/specification.html). XSD defines the legal building blocks of an XML document. DTD defines the structure and the legal elements and attributes of an XML document. .. table:: **SchemaFacet** ``extends`` **Facet** +------------------------+----------------------------------------+----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+ | Properties | +========================+========================================+==========================================================+===========================================================================================================================================================================================================================================================================================================================+=================+ | **Name** | **Type** | **Attributes** | **Description** | +------------------------+----------------------------------------+----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+ | description | String | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | Schema Description | +------------------------+----------------------------------------+----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+ | name | String | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | Schema Name | +------------------------+----------------------------------------+----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+ | schema | :ref:`ValueSchema ` | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | The 'value' property contains the defined 'schema' that in turn is validated by the schema available at the URL indicated in the ’schema’ property. An example could be an XSD schema instantiation as 'value' and the URL of the DTD defining the XSD as 'schema' i.e., https://www.w3.org/2009/XMLSchema/XMLSchema.dtd. | +------------------------+----------------------------------------+----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+ | **Known Usage** | +------------------------+----------------------------------------+----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+ | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | +------------------------+----------------------------------------+----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+ | :ref:`Schema ` | :ref:`IsIdentifiedBy ` | 1..1 | :ref:`SchemaFacet ` | | +------------------------+----------------------------------------+----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+ The **SchemaFacet** current version is 1.0.0. Changelog: * **1.0.0**: First Version. .. _SimpleFacet: SimpleFacet ----------- A sort of catch all. It does not define any property. It is mainly used to one or more arbitrary properties to the resource. Before using SimpleFacet a developer should evaluate if it is possible to identify a specific Facetto capture the particular aspect of the resource. The usage of SimpleFacet should be reduced to the maximum. .. table:: **SimpleFacet** ``extends`` **Facet** +------------------------------------------------------+--------------+------------------+-----------------+-----------------+ | Properties | +======================================================+==============+==================+=================+=================+ | **Name** | **Type** | **Attributes** | **Description** | +------------------------------------------------------+--------------+------------------+-----------------+-----------------+ | This type does not define any additional attributes. | +------------------------------------------------------+--------------+------------------+-----------------+-----------------+ | **Known Usage** | +------------------------------------------------------+--------------+------------------+-----------------+-----------------+ | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | +------------------------------------------------------+--------------+------------------+-----------------+-----------------+ | No specific known usage for this type. | +------------------------------------------------------+--------------+------------------+-----------------+-----------------+ The **SimpleFacet** current version is 1.0.0. Changelog: * **1.0.0**: First Version. .. _SimplePropertyFacet: SimplePropertyFacet ------------------- Collect name-value property .. table:: **SimplePropertyFacet** ``extends`` **Facet** +----------------------------------+--------------------------------+--------------------------------------------------------+--------------------------------------------------+---------------------------------------------------------------------------------------------------+ | Properties | +==================================+================================+========================================================+==================================================+===================================================================================================+ | **Name** | **Type** | **Attributes** | **Description** | +----------------------------------+--------------------------------+--------------------------------------------------------+--------------------------------------------------+---------------------------------------------------------------------------------------------------+ | name | String | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | | +----------------------------------+--------------------------------+--------------------------------------------------------+--------------------------------------------------+---------------------------------------------------------------------------------------------------+ | value | String | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | | +----------------------------------+--------------------------------+--------------------------------------------------------+--------------------------------------------------+---------------------------------------------------------------------------------------------------+ | **Known Usage** | +----------------------------------+--------------------------------+--------------------------------------------------------+--------------------------------------------------+---------------------------------------------------------------------------------------------------+ | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | +----------------------------------+--------------------------------+--------------------------------------------------------+--------------------------------------------------+---------------------------------------------------------------------------------------------------+ | :ref:`HostingNode ` | :ref:`ConsistsOf ` | 0..n | :ref:`SimplePropertyFacet ` | Any pair property worth associating with the Hosting Node, e.g. Environment Variables | +----------------------------------+--------------------------------+--------------------------------------------------------+--------------------------------------------------+---------------------------------------------------------------------------------------------------+ The **SimplePropertyFacet** current version is 1.0.0. Changelog: * **1.0.0**: First Version. .. _SoftwareFacet: SoftwareFacet ------------- SoftwareFacet captures information on any software associated with the resource. .. table:: **SoftwareFacet** ``extends`` **Facet** +----------------------------------------+----------------------------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Properties | +========================================+========================================+==========================================================+==========================================================================================================================================================================================+=====================================================================================================================================================================================+ | **Name** | **Type** | **Attributes** | **Description** | +----------------------------------------+----------------------------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | group | String | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | The name of 'group' the software artifact belongs to, e.g., groupId in maven coordinates, company name for retail software software such as 'Microsoft™' (in Microsoft™ Office 2013-SP2) | +----------------------------------------+----------------------------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | name | String | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | The name of the software artifact being described, e.g., artifactId in maven coordinates, the software name for retail software such as 'Office' (in Microsoft™ Office 2013-SP2) | +----------------------------------------+----------------------------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | version | String | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | The particular release of the software artifact, e.g., version in maven coordinates, the software version for retail software such as '2013-SP2' (in Microsoft™ Office 2013-SP2) | +----------------------------------------+----------------------------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | optional | Boolean | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | Used to indicate the software optionality, e.g., optional in maven coordinates | +----------------------------------------+----------------------------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | description | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | A human oriented description of the software artifact being described | +----------------------------------------+----------------------------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | qualifier | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | A qualifier for the software, e.g., packaging or scope in maven coordinates, target architecture for retail software such as x86 or amd64 | +----------------------------------------+----------------------------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Known Usage** | +----------------------------------------+----------------------------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | +----------------------------------------+----------------------------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`EService ` | :ref:`ConsistsOf ` | 0..n | :ref:`SoftwareFacet ` | Software available in the EService environment that characterizes the specific EService instance. | +----------------------------------------+----------------------------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`EService ` | :ref:`IsIdentifiedBy ` | 1..1 | :ref:`SoftwareFacet ` | The main software enabling the EService capabilities. | +----------------------------------------+----------------------------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`HostingNode ` | :ref:`ConsistsOf ` | 0..n | :ref:`SoftwareFacet ` | Any Software characterising the Hosting Node. Useful to report the hosted software that are not registered in the Resource Registry as Software Resource, e.g. Operating System | +----------------------------------------+----------------------------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Software ` | :ref:`ConsistsOf ` | 1..n | :ref:`SoftwareFacet ` | Apart the one connected by the IsIdentifiedBy relation (gCube coordinates) the others identify the software in other way e.g. (Maven coordinates). | +----------------------------------------+----------------------------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Software ` | :ref:`IsIdentifiedBy ` | 1..1 | :ref:`SoftwareFacet ` | Software coordinates which identify the Software per se. | +----------------------------------------+----------------------------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`VirtualMachine ` | :ref:`ConsistsOf ` | 0..n | :ref:`SoftwareFacet ` | Any Software characterising the Virtual Machine. Useful to report the hosted software that are not registered in the Resource Registry as Software Resource, e.g. Operating System | +----------------------------------------+----------------------------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`VirtualService ` | :ref:`IsIdentifiedBy ` | 1..n | :ref:`SoftwareFacet ` | | +----------------------------------------+----------------------------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ The **SoftwareFacet** current version is 1.0.0. Changelog: * **1.0.0**: First Version. .. _StateFacet: StateFacet ---------- StateFacet captures information on state to be associated with the resource. The state is captured by any controlled vocabulary which is an integral part of the facet. Examples of usage are the state of service e.g., running or down or the state of a virtual machine e.g., activated or unreachable. .. table:: **StateFacet** ``extends`` **Facet** +----------------------------------------+--------------------------------+--------------------------------------------------------+--------------------------------+--------------------------------------------------------------------------------------+ | Properties | +========================================+================================+========================================================+================================+======================================================================================+ | **Name** | **Type** | **Attributes** | **Description** | +----------------------------------------+--------------------------------+--------------------------------------------------------+--------------------------------+--------------------------------------------------------------------------------------+ | value | String | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | The value of the state | +----------------------------------------+--------------------------------+--------------------------------------------------------+--------------------------------+--------------------------------------------------------------------------------------+ | **Known Usage** | +----------------------------------------+--------------------------------+--------------------------------------------------------+--------------------------------+--------------------------------------------------------------------------------------+ | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | +----------------------------------------+--------------------------------+--------------------------------------------------------+--------------------------------+--------------------------------------------------------------------------------------+ | :ref:`EService ` | :ref:`ConsistsOf ` | 1..1 | :ref:`StateFacet ` | The current status of the EService, e.g. STARTED, ready, down, failed. | +----------------------------------------+--------------------------------+--------------------------------------------------------+--------------------------------+--------------------------------------------------------------------------------------+ | :ref:`HostingNode ` | :ref:`ConsistsOf ` | 1..1 | :ref:`StateFacet ` | The current state of the Hosting Node, e.g. started, ready, certified, down, failed. | +----------------------------------------+--------------------------------+--------------------------------------------------------+--------------------------------+--------------------------------------------------------------------------------------+ | :ref:`VirtualMachine ` | :ref:`ConsistsOf ` | 1..1 | :ref:`StateFacet ` | The current state of the Virtual Machine, e.g. started, ready, down, unreachable. | +----------------------------------------+--------------------------------+--------------------------------------------------------+--------------------------------+--------------------------------------------------------------------------------------+ The **StateFacet** current version is 1.0.0. Changelog: * **1.0.0**: First Version. .. _SubjectFacet: SubjectFacet ------------ SubjectFacet captures information on subjects associated with the resource for description, classification and discovery purposes. .. table:: **SubjectFacet** ``extends`` **Facet** +--------------------------+----------------------------------+--------------------------------------------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------+ | Properties | +==========================+==================================+========================================================+==================================================+==================================================================================================+ | **Name** | **Type** | **Attributes** | **Description** | +--------------------------+----------------------------------+--------------------------------------------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------+ | subject | :ref:`ValueSchema ` | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | The value of the subject according to the schema | +--------------------------+----------------------------------+--------------------------------------------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------+ | **Known Usage** | +--------------------------+----------------------------------+--------------------------------------------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------+ | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | +--------------------------+----------------------------------+--------------------------------------------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`Dataset ` | :ref:`ConsistsOf ` | 0..n | :ref:`SubjectFacet ` | Any subject/tag associated with the dataset for descriptive and discovery purposes. | +--------------------------+----------------------------------+--------------------------------------------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`Schema ` | :ref:`ConsistsOf ` | 0..n | :ref:`SubjectFacet ` | | +--------------------------+----------------------------------+--------------------------------------------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`Service ` | :ref:`ConsistsOf ` | 0..n | :ref:`SubjectFacet ` | Any subject/tag associated with the service for descriptive, cataloguing and discovery purposes. | +--------------------------+----------------------------------+--------------------------------------------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------+ The **SubjectFacet** current version is 1.0.0. Changelog: * **1.0.0**: First Version.