Changes for page Technical details

Last modified by lzehl on 2021/07/05 18:57

From 81.1 to 82.1 From 86.4 to 87.1

From version 82.1

edited by lzehl
on 2021/07/05 12:13

Change comment: There is no comment for this version

To version 86.4

edited by lzehl
on 2021/07/05 15:29

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -56,19 +56,22 @@
  === The openMINDS vocabulary ===
  (% style="text-align: justify;" %)
--Located under the folder **##vocab##** in the main branch of the central openMINDS GitHub directory, the openMINDS vocabulary is semi-automatically gathered and stored in dedicated JSON files ([[**##types.json##**>>https://raw.githubusercontent.com/HumanBrainProject/openMINDS/v2/vocab/types.json||rel="noopener noreferrer" target="_blank"]] and [[**##properties.json##**>>https://raw.githubusercontent.com/HumanBrainProject/openMINDS/v2/vocab/properties.json||rel="noopener noreferrer" target="_blank"]]). The openMINDS integration pipeline makes sure that both files are updated with each commit to any of the GitHub repositories for the openMINDS metadata models. With that, the openMINDS vocab reflects always an up-to-date status of the general attributes of existing **schemas** and **properties** across all openMINDS metadata models, while providing the opportunity to centrally review and maintain their consistency. In addition, this design allows us to centrally define and maintain multiple references to related schemas and matching schema properties of other metadata initiatives. How this works in detail is explained in the following.
++Located under the folder **##vocab##** in the main branch of the central openMINDS GitHub directory, the openMINDS vocabulary is semi-automatically gathered and stored in dedicated JSON files ([[**##types.json##**>>https://raw.githubusercontent.com/HumanBrainProject/openMINDS/v2/vocab/types.json||rel="noopener noreferrer" target="_blank"]] and [[**##properties.json##**>>https://raw.githubusercontent.com/HumanBrainProject/openMINDS/v2/vocab/properties.json||rel="noopener noreferrer" target="_blank"]]). The openMINDS integration pipeline makes sure that both files are updated with each commit to any of the GitHub repositories for the openMINDS metadata models. With that, the openMINDS vocab reflects always an up-to-date status of the general attributes of existing **schema types** and **properties** across all openMINDS metadata models, while providing the opportunity to centrally review and maintain their consistency. In addition, this design allows us to centrally define and maintain multiple references to related schemas and matching schema properties of other metadata initiatives. How this works in detail is explained in the following.
  (% style="text-align: justify;" %)
--The **##types.json##** file is an associative array listing all existing openMINDS schemas (via their type). For each openMINDS schema, a small list of general attributes are provided in a nested associative array. Currently, the following attributes are captured:
++The **##types.json##** file is an associative array listing all existing openMINDS schema types. For each openMINDS schema type, a small list of general attributes are provided in a nested associative array. Currently, the following attributes are captured:
  {{code language="json"}}
  {
--  "OPENMINDS_SCHEMA_TYPE": {
--    "description": "GENERAL_DESCRIPTION",
--    "label": "HUMAN-READABLE_LABEL",
--    "name": "SIMPLIFIED_SCHEMA_TYPE",
++  "https://openminds.ebrains.eu/«METADATA_MODEL_LABEL»/«SCHEMA_NAME»": {
++    "description": "«GENERAL_DESCRIPTION»",
++    "label": "«HUMAN-READABLE_LABEL»",
++    "name": "«SCHEMA_NAME»",
++    "schemas": [
++      "«RELATIVE_PATH_TO_SCHEMA_FILE_OF_THAT_TYPE»"
++    ],
      "translatableTo": [
--      "REFERENCE_TO_RELATED_SCHEMA_OF_OTHER_INITIATIVE"
++      "«REFERENCE_TO_RELATED_SCHEMA_OF_OTHER_INITIATIVE»"
      ]
    }
  }
@@ -75,28 +75,23 @@
  {{/code}}
  (% style="text-align: justify;" %)
--With each new schema committed to one of the openMINDS metadata models, a new entry is appended to the **##types.json##** file, with the "name" and "label" automatically derived from the respective schema type, because it has a consistent naming convention:
++With each new schema committed to one of the openMINDS metadata models, a new entry is appended to the **##types.json##** file, with the values for **##"name"##**, **##"label"##**, and **##"schemas"##** automatically derived. The remaining attributes are predefined with a null value and frequently, manually edited by a corresponding expert of the openMINDS development team. If necessary the auto-derived **##"label"##** value can be edited as well. All manual editions will be preserved and not overwritten when the file is updated again with a new commit. In case a schema is deleted from the openMINDS metadata models, the corresponding entry in the **##types.json##** file is marked as being deprecated (additional attribute-value pair; **##"deprecated": true##**). It only can be permanently removed from the **##types.json##** file, if the entry is manually deleted.
--(% style="text-align: center;" %)
--**##"https:~/~/openminds.ebrains.eu/METADATA_MODEL_LABEL/SIMPLIFIED_SCHEMA_NAME"##**
--
  (% style="text-align: justify;" %)
--The remaining attributes are predefined with a null value and frequently, manually edited by a corresponding expert of the openMINDS development team. Once an entry for a schema is made in the **##types.json##** file, the values of attributes (**##"label"##**, **##"description"##**, and **##"translatableTo"##**) can be manually edited. All manual editions will be preserved and not overwritten when the file is updated again with a new commit. In case a schema is deleted from the openMINDS metadata models, the corresponding entry in the **##types.json##** file is marked as being deprecated (additional attribute-value pair; **##"deprecated": true##**). It only can be permanently removed from the **##types.json##** file, if the entry is manually deleted.
++Similar to the **##types.json##** file, the **##properties.json##** file is an associative array listing all properties across all existing openMINDS schemas. For each openMINDS property, a small list of general attributes are provided in a nested associative array. Currently, the following attributes are captured:
--(% style="text-align: justify;" %)
--Similar to the **##types.json##** file, the **##properties.json##** file is an associative array listing all properties across all existing openMINDS schemas (via the property name). For each openMINDS property, a small list of general attributes are provided in a nested associative array. Currently, the following attributes are captured:
--
  {{code language="json"}}
  {
--  "PROPERTY_NAME": {
--    "description": "GENERAL_DESCRIPTION",
--    "name": "DISPLAY_LABEL",
--    "nameForReverseLink": "DISPLAY_LABEL_OF_REVERSED_LINK",
++  "https://openminds.ebrains.eu/vocab/«PROPERTY_NAME»": {
++    "description": "«GENERAL_DESCRIPTION",
++    "label": "«HUMAN-READABLE_LABEL",
++    "labelForReverseLink": "«HUMAN-READABLE_LABEL_OF_REVERSED_LINK",
++    "name": "«PROPERTY_NAME»",
      "sameAs": [
--      "REFERENCE_TO_MATCHING_SCHEMA-PROPERTY_OF_OTHER_INITIATIVE"
++      "«REFERENCE_TO_MATCHING_SCHEMA-PROPERTY_OF_OTHER_INITIATIVE"
      ],
      "schemas": [
--      "RELATIVE_PATH_TO_OPENMINDS-SCHEMA_USING_THIS_PROPERTY"
++      "«RELATIVE_PATH_TO_SCHEMA_FILE_CONTAINING_THIS_PROPERTY»"
      ]
    }
  }
@@ -103,7 +103,7 @@
  {{/code}}
  (% style="text-align: justify;" %)
--With each new property committed to a schema of one of the openMINDS metadata models, a new entry is appended to the **##properties.json##** file, with the display label and list of schemas in which this property occurs automatically derived. The remaining attributes are initially provided with a null value. Once an entry for a property is made in the **##properties.json##** file, the values of all attributes (**##"name"##**, **##"description"##**, **##"nameForReversedLink"##**, and **##"sameAs"##**) can be manually edited, except for **##"schemas"##** which will be always automatically updated. All those manual editions will be preserved and not overwritten when the file is updated again with a new commit. In case a property is not used anymore in any of the schemas from the openMINDS metadata models, the corresponding entry in the **##properties.json##** file is marked as being deprecated (additional attribute-value pair; **##"deprecated": true##**). It only can be permanently removed from the **##properties.json##** file, if the entry is manually deleted.
++With each new property committed to a schema of one of the openMINDS metadata models, a new entry is appended to the **##properties.json##** file, with the **##"name"##**, **##"label"##** and **##"labelForReversedLink"##** automatically derived. The remaining attributes are predefined with a null value and frequently, manually edited by a corresponding expert of the openMINDS development team. If necessary the auto-derived values for **##"label"##** and **##"labelForReversedLink"##** can be edited as well. All manual editions will be preserved and not overwritten when the file is updated again with a new commit. In case a property is not used anymore in any of the schemas from the openMINDS metadata models, the corresponding entry in the **##properties.json##** file is marked as being deprecated (additional attribute-value pair; **##"deprecated": true##**). It only can be permanently removed from the **##properties.json##** file, if the entry is manually deleted.
  === The openMINDS syntax ===
@@ -126,6 +126,7 @@
      "PROPERTY_NAME": {
        "type": "DATA_TYPE",
        "_instruction": "METADATA_ENTRY_INSTRUCTION"
++    }
    },
    "required": [
      "PROPERTY_NAME"
@@ -161,11 +161,80 @@
  ==== Data type depending constraints ====
  (% style="text-align: justify;" %)
--Depending on the expected data **##"type"##** additional constraints can be made for the metadata entry of a respective property. Currently, the openMINDS schema template syntax supports the following data types: **##"string"##**, ##**"integer"**##, **##"float"##**, **##"boolean"##**, **##"array"##** and **##"object"##**.
++Depending on the expected data **##"type"##** additional constraints can be made for the metadata entry of a respective property. Currently, the openMINDS schema template syntax supports the following data types: **##"string"##**, **##"number"##** (integer or float), ##**"integer"**##, **##"float"##**, **##"boolean"##**, **##"object"##** or **##"array"##**. Except for **##"boolean"##**, all these data types can have additional constraints which will be summarized in the following.
  (% style="text-align: justify;" %)
--If the expected data **##"type"##** is a **##"string"##** the expected number of characters, the format or a regular expression pattern of the string can be further defined.
++If the expected data **##"type"##** is a **##"string"##** the expected number of characters, the format or a regular expression pattern of the string can be further defined. Here abstract examples for all possible string constraints:
++{{code language="json"}}
++{
++  "properties": {
++    "stringProperty_noConstraints": {
++      "type": "string",
++      "_instruction": "Enter a free text."
++    },
++    "stringProperty_lengthConstraints": {
++      "maxLength": 6,
++      "minLength": 2,
++      "type": "string",
++      "_instruction": "Enter a free text (allowed numbers of characters: 2 - 6)."
++    },
++    "stringProperty_formatConstraints": {
++      "type": "string",
++      "_formats": [
++        "email",
++        "date",
++        "time",
++        "date-time",
++        "iri"
++      ]
++      "_instruction": "Enter a string matching one of the given formats."
++    },
++    "stringProperty_patternConstraints": {
++      "pattern": "«regular_expression»"
++      "type": "string",
++      "_instruction": "Enter a string matching the given regex pattern (ECMA 262 dialect)."
++    }
++  }
++}
++{{/code}}
++
++(% class="wikigeneratedid" %)
++If the expected data **##"type"##** is an **##"integer"##** or a **##"number"##** (float or integer) the expected range or multiples can be further defined. Here abstract examples for all possible  **##"integer"##** and **##"number"##** constraints (not that both constraints can be defined for both data types):
++
++{{code language="json"}}
++{
++  "properties": {
++    "integerProperty_noConstraints": {
++      "type": "integer",
++      "_instruction": "Enter an integer."
++    },
++    "integerProperty_rangeConstraints": {
++      "maximum": 50,
++      "minimum": 10,
++      "type": "integer",
++      "_instruction": "Enter an integer equal or between 10 and 50."
++    },
++    "numberProperty_noConstraints": {
++      "type": "number",
++      "_instruction": "Enter a number (float or integer)."
++    },
++    "numberProperty_multipleOfConstraints": {
++      "multipleOf": 10.5,
++      "type": "number",
++      "_instruction": "Enter any number which is a multiple of 10.5."
++    }
++  }
++}
++{{/code}}
++
++(% class="wikigeneratedid" %)
++If the expected data **##"type"##** is an **##"object"##** the expected schema type needs to be defined, as well as if the object is linked or embedded. Here abstract examples for all possible  **##"object"##** constraints:
++
++
++(% class="wikigeneratedid" %)
++If the expected data **##"type"##** is an **##"array"##** the expected data type of the items in the array, as well as the expected length of the array can be further defined. Valid data types for items are **##"string"##**, **##"number"##**, ##**"integer"**##, **##"float"##**, **##"boolean"##**, and/or **##"object"##**. In addition, items can also be defined as n-tuples with expected data types. Here abstract examples for all possible  **##"array"##** constraints:
++
  === The openMINDS integration pipeline ===
  (//**coming soon**//) If you'd like to learn more about the openMINDS integration pipeline, especially if you'd like to contribute to it, please get in touch with us (the openMINDS development team) via the issues on the openMINDS or openMINDS_generator GitHub or the support email: openminds@ebrains.eu