2023-01-26 17:48:56 +01:00
#############################
Information System (IS) Model
#############################
2023-01-25 23:28:10 +01:00
2023-01-26 17:48:56 +01:00
This Model is part of research conducted in the context of a PhD. This wiki page represents just a partial view of the full rationale of the research. To have a complete overview of the rationale of the model, please refer to the PhD thesis which is publicly available at:
https://etd.adm.unipi.it/t/etd-05102019-114151/
https://openportal.isti.cnr.it/doc?id=people______::470484e51fcb9e307a418c800efc44c8
If you need to refer to such work you can cite the PhD Thesis.
.. code :: BibText
@phdthesis{frosini2019transactional,
title={Transactional REST Information System for Federated Research Infrastructures enabling Virtual Research Environments},
author={Frosini, Luca},
year={2019},
school={UNIVERSITÀ DI PISA}
}
An previous paper about this work is:
.. code :: BibText
@article{frosini2018facet,
title={A Facet-based Open and Extensible Resource Model for Research Data Infrastructures.},
author={Frosini, Luca and Pagano, Pasquale},
journal={Grey Journal (TGJ)},
volume={14},
number={2},
year={2018}
}
***** ***** **
The IS Model
***** ***** **
2023-01-26 18:28:54 +01:00
.. image :: ./is-model.png
.. image :: ./is-model-er.png
2023-01-26 17:48:56 +01:00
The Information System Model (henceforth IS Model) is a graph model with Entities as nodes and Relations as edges.
* Two typologies of entities are envisaged:
* Resources, i.e. entities representing a description of "thing" to be managed:
* Every Resource is described by a number of Facets.
2023-01-26 18:28:54 +01:00
2023-01-26 17:48:56 +01:00
* Facets, i.e. entities contributing to "build" a description of a Resource. Every facet, once attached to a Resource profile captures a certain aspect / characterization of the resource:
* Every facet is characterised by a number of properties.
* Two typologies of relations are envisaged:
* IsRelatedTo, i.e. a relation linking any two Resources.
* ConsistsOf, i.e. a relation connecting each Resource with one of the Facets characterizing it;
* Each entity and relation:
* has an header automatically generated for the sake of identification and provenance of the specific information;
* can be specialized
* A number of specializations are identified below. Such specializations are managed by the gCube Core services, i.e. Core services builds upon these specializations to realize its management tasks;
* Other specializations can be defined by clients, the system make it possible to store these additional typologies of relations and facets and to discover them.
* Facet and Relation instances can have additional properties which are not defined in the schema (henceforth schema-mixed mode).
* On relations:
* Any relation has a direction, i.e. a "source" (out bound of the relation) and a "target" (in bound of the relation). Anyway, the relation can be also navigated in the opposite direction;
* It is not permitted to define a Relation having a Facet as "source". In other words:
* It is not permitted to define a Relation connecting a Facet with another one;
* It is not permitted to define a Relation connecting a Facet with a Resource (as target);
* A Facet instance can be linked (by ConsistsOf or any specialization of it) from different Resources.
We derived the term Facet directly from the dictionary definition.
Merriam Webster Dictionary defines facet as “any of the definable aspects that make up a subject
(as of contemplation) or an object (as of consideration)” [#FacetMerriamWebsterDef]_ .
The Free Dictionary defines a facet as “One of numerous aspects, as of a subject” [#FacetFreeDictionaryDef]_ .
....
2023-01-26 18:28:54 +01:00
Type Attributes
===============
Any Property defined in the schema is characterised by:
Name:
Property Name
Type:
The Type of the Property (e.g. String, Integer, ...). It can be a Basic Type or a Derived Type or a Complex Type
Description:
The description of the Property. default=null.
Mandatory (M):
Indicate if the Property is mandatory. default=false.
ReadOnly (RO):
The Property cannot change its value. default=false.
NotNull (NN):
Whether the property must assume a value diverse from 'null' or not. default=false
Max (Max):
default=null
Min (Min):
default=null
Regex (Reg)):
A Regular Expression to validate the property value, default=null. A good online tool for regex is avalable at https://regex101.com/
Basic Types
-----------
Derived Types
-----------
The following are obtained using a String as real type and adding a validation regex.
2023-01-26 17:48:56 +01:00
2023-01-26 18:28:54 +01:00
Complex Types
-----------
2023-01-26 17:48:56 +01:00
2023-01-26 18:28:54 +01:00
Any property defined by composing basic types, complex types and other complex types. Any complex type can be defined by extending Property type.
2023-01-26 17:48:56 +01:00
Property
========
This is the base type for any Property
.. table :: **Property**
+------------------------------------------------------+------+------------+-------------+
| Name | Type | Attributes | Description |
+======================================================+======+============+=============+
| This type does not define any additional attributes. |
+------------------------------------------------------+------+------------+-------------+
The **Property** current version is 1.0.0.
Changelog:
* **1.0.0** : First Version.
Header
------
This type provides metadata per every IdentifiableElement
.. table :: **Header** `` extends `` **Property**
+----------------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Attributes | Description |
+================+========+====================================================================================================================================================+=========================================================================================================================================+
| createdBy | String | `` Mandatory:true `` `` ReadOnly:true `` `` NotNull:true `` | The user that created the Entity or the Relation. It is initialized at Creation Time. |
+----------------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| creationTime | Date | `` Mandatory:true `` `` ReadOnly:true `` `` NotNull:true `` | Creation time. It is represented in the format yyyy-MM-dd HH:mm:ss.SSS Z. |
+----------------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| lastUpdateBy | String | `` Mandatory:true `` `` ReadOnly:false `` `` NotNull:true `` | The user that made the last update to the Entity or the Relation. At Creation Time, it assumes the same value of createdBy. |
+----------------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| lastUpdateTime | Date | `` Mandatory:true `` `` ReadOnly:false `` `` NotNull:true `` | Last Update time. At creation time it assumes the same value of creationTime. It is represented in the format yyyy-MM-dd HH:mm:ss.SSS Z |
+----------------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| uuid | String | `` Mandatory:true `` `` ReadOnly:true `` `` NotNull:true `` `` Regex:^([a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}){1}$ `` | This UUID is be used to identify the Entity or the Relation univocally. |
+----------------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
The **Header** current version is 1.0.0.
Changelog:
* **1.0.0** : First Version.
Encrypted
---------
This type is used to properly manage encrypted values across contexts.
.. table :: **Encrypted** `` extends `` **Property**
+-------+--------+--------------------------------------------------------+----------------------------------------+
| Name | Type | Attributes | Description |
+=======+========+========================================================+========================================+
| value | String | `` Mandatory:true `` `` ReadOnly:false `` `` NotNull:true `` | The value to store encrypted in the IS |
+-------+--------+--------------------------------------------------------+----------------------------------------+
The **Encrypted** current version is 1.0.0.
Changelog:
* **1.0.0** : First Version.
PropagationConstraint
---------------------
This type provides propagation constraint for Relation
.. table :: **PropagationConstraint** `` extends `` **Property**
+--------+--------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Attributes | Description |
+========+========+=====================================================================================================+========================================================================================================================================================================================================================================================================================+
| add | String | `` Mandatory:true `` `` ReadOnly:false `` `` NotNull:true `` `` Regex:^(propagate|unpropagate)$ `` | It indicates the behaviour to implement for the target Entity when an 'add' action is performed on the source Resource. Add action is the operation of adding an instance to a context. |
+--------+--------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remove | String | `` Mandatory:true `` `` ReadOnly:false `` `` NotNull:true `` `` Regex:^(cascadeWhenOrphan|cascade|keep)$ `` | It indicates the behaviour to implement for the target Entity when a 'remove' action is performed on the source Resource. Remove actions are: (i) the operation of removing an instance from a context; (ii) the operation of deleting an instance (it has an impact on all contexts). |
+--------+--------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
The **PropagationConstraint** current version is 1.0.0.
Changelog:
* **1.0.0** : First Version.
Entity
======
This is the base type for any Entity
.. table :: **Entity**
+------------+----------+--------------------------------------------------------+--------------------------------------------------------------------------------------------+
| Properties |
+============+==========+========================================================+============================================================================================+
| **Name** | **Type** | **Attributes** | **Description** |
+------------+----------+--------------------------------------------------------+--------------------------------------------------------------------------------------------+
| header | Header | `` Mandatory:true `` `` ReadOnly:false `` `` NotNull:true `` | Metadata associated with the instance that is automatically created/updated by the system. |
+------------+----------+--------------------------------------------------------+--------------------------------------------------------------------------------------------+
The **Entity** current version is 1.0.0.
Changelog:
* **1.0.0** : First Version.
Resource
--------
This is the base type for any Resource
.. table :: **Resource** `` extends `` **Entity**
+-------------------------------------------------------+----------+--------------+--------+-------------+
| Source | Relation | Multiplicity | Target | Description |
+=======================================================+==========+==============+========+=============+
| **Facets** |
+-------------------------------------------------------+----------+--------------+--------+-------------+
| No specific facets usage defined for this type. |
+-------------------------------------------------------+----------+--------------+--------+-------------+
| **Resource Relations** |
+-------------------------------------------------------+----------+--------------+--------+-------------+
| No specific Resource relations defined for this type. |
+-------------------------------------------------------+----------+--------------+--------+-------------+
The **Resource** current version is 1.0.0.
Changelog:
* **1.0.0** : First Version.
Facet
-----
This is the base type for any Facet
.. table :: **Facet** `` extends `` **Entity**
+------------------------------------------------------+--------------+------------------+-----------------+-----------------+
| 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 **Facet** current version is 1.0.0.
Changelog:
* **1.0.0** : First Version.
Relation
========
This is the base type for any Relation
.. table :: **Relation**
+-----------------------+-----------------------+----------------------------------------------------------+-----------------+----------------------------------------+
| **Definition** |
+=======================+=======================+==========================================================+=================+========================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+-----------------------+-----------------------+----------------------------------------------------------+-----------------+----------------------------------------+
| Resource | Relation | 0..n | Entity | This is the base type for any Relation |
+-----------------------+-----------------------+----------------------------------------------------------+-----------------+----------------------------------------+
| **Properties** |
+-----------------------+-----------------------+----------------------------------------------------------+-----------------+----------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** |
+-----------------------+-----------------------+----------------------------------------------------------+-----------------+----------------------------------------+
| propagationConstraint | PropagationConstraint | `` Mandatory:false `` `` ReadOnly:false `` `` NotNull:false `` | |
+-----------------------+-----------------------+----------------------------------------------------------+-----------------+----------------------------------------+
The **Relation** current version is 1.0.0.
Changelog:
* **1.0.0** : First Version.
ConsistsOf
----------
This is the base type for any ConsistsOf relation
.. table :: **ConsistsOf** `` extends `` **Relation**
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------+
| **Definition** |
+======================================================+==============+==================+=================+===================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------+
| Resource | ConsistsOf | 0..n | Facet | This is the base type for any ConsistsOf relation |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------+
| **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 **ConsistsOf** current version is 1.0.0.
Changelog:
* **1.0.0** : First Version.
IsRelatedTo
-----------
This is the base type for any IsRelatedTo relation
.. table :: **IsRelatedTo** `` extends `` **Relation**
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------+
| **Definition** |
+======================================================+==============+==================+=================+====================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------+
| Resource | IsRelatedTo | 0..n | Resource | This is the base type for any IsRelatedTo relation |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------+
| **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 **IsRelatedTo** current version is 1.0.0.
Changelog:
* **1.0.0** : First Version.
.. rubric :: Footnotes
.. [#FacetMerriamWebsterDef] https://www.merriam-webster.com/dictionary/facet
.. [#FacetFreeDictionaryDef] https://www.thefreedictionary.com/facet
