Changes for page Technical details

Last modified by lzehl on 2021/07/05 18:57
From version 68.1
edited by lzehl
on 2021/06/24 19:11
Change comment: There is no comment for this version
To version 69.1
edited by lzehl
on 2021/06/27 12:46
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -57,55 +57,49 @@
57 57  === The openMINDS vocabulary ===
58 58  
59 59  (% style="text-align: justify;" %)
60 -Through the integration pipeline of the openMINDS generator, the openMINDS vocabulary is automatically gathered and stored in the main openMINDS GitHub in order to centrally maintain general definitions and references for **types** and **properties** used in schemas across all openMINDS repositories. How this works is explained in the following.
60 +Located under the folder **##vocab##** in the main openMINDS GitHub directory, the openMINDS vocabulary is semi-automatically gathered and stored in dedicated JSON files (**##types.json##** and **##properties.json##**). 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. For this reason, the files always contain an up-to-date list of all schemas and properties in use. This setup not only allows us to centrally maintain general definitions and references for schema **types** and **properties** across all openMINDS metadata models, but also to keep several technical aspects for the openMINDS schemas hidden from the naive user. How this works is explained in the following.
61 61  
62 62  (% style="text-align: justify;" %)
63 -Schema types and properties are stored in dedicated JSON files (**##types.json##** and **##properties.json##**) under the folder **##vocab##** located in the main openMINDS GitHub directory. Each schema type and property occurring in the openMINDS metadata models is automatically represented in those files as nested dictionaries. Here a cutout of the **##types.json##**:
63 +The **##types.json##** file is an associative array listing all existing openMINDS schemas. For each openMINDS schema a nested associative array is created providing the respective display label, the general description, and a list of references to corresponding schemas of other initiatives:
64 64  
65 65  {{code language="json"}}
66 66  {
67 - ...,
68 - "https://openminds.ebrains.eu/core/Person": {
69 - "description": "Structured information on a person (alive or dead).",
70 - "name": "Person",
67 + "OPENMINDS_SCHEMA_TYPE": {
68 + "description": "GENERAL_DESCRIPTION",
69 + "name": "DISPLAY_LABEL",
71 71   "translatableTo": [
72 - "https://schema.org/Person"
71 + "REFERENCE_TO_RELATED_SCHEMA_OF_OTHER_INITIATIVE"
73 73   ]
74 - },
75 - ...
73 + }
76 76  }
77 77  {{/code}}
78 78  
79 -... and a cutout of the **##properties.json##**:
77 +(% style="text-align: justify;" %)
78 +With each new schema committed to one of the openMINDS metadata models, a new entry is appended to the **##types.json##** file, with the display label automatically derived from the respective schema type and the remaining attributes provided with a null value. Once an entry for a schema is made in the **##types.json##** file, the values of all attributes (**##name##**, **##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; ##"deprecated": true##). It only can be permanently removed from the **##types.json##** file, if the entry is manually deleted.
80 80  
80 +(% style="text-align: justify;" %)
81 +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 nested associative array is created providing the respective display label, the general description, the label for displaying the reversed link of that property, the list of schemas in which the property is used, and a list of references to matching schema properties of other initiatives:
82 +
81 81  {{code language="json"}}
82 82  {
83 - ...,
84 - "givenName": {
85 - "description": "Name given to a person, including all potential middle names, but excluding the family name.",
86 - "name": "Given name",
87 - "nameForReverseLink": "Is given name of",
85 + "PROPERTY_NAME": {
86 + "description": "GENERAL_DESCRIPTION",
87 + "name": "DISPLAY_LABEL",
88 + "nameForReverseLink": "DISPLAY_LABEL_OF_REVERSED_LINK",
88 88   "sameAs": [
89 - "https://schema.org/givenName"
90 + "REFERENCE_TO_MATCHING_SCHEMA-PROPERTY_OF_OTHER_INITIATIVE"
90 90   ],
91 91   "schemas": [
92 - "core/v3/actors/person.schema.tpl.json"
93 + "RELATIVE_PATH_TO_SCHEMA_USING_THIS_PROPERTY"
93 93   ]
94 - },
95 - ...
95 + }
96 96  }
97 97  {{/code}}
98 98  
99 99  (% style="text-align: justify;" %)
100 -The keywords of those nested dictionaries are pre-defined to consistently capture for all schema types and properties their namespace, their occurrence (cf. **##"schemas"##** in **##properties.json##**), their general description (cf. **##"description"##** in **##types.json##** and **##properties.json##**), and possible references to related or matching schema types (cf. **##"translatableTo"##** in **##types.json##**) and properties (cf. **##""sameAs""##** in **##properties.json##**) of other metadata initiatives (e.g., schema.org).
100 +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##**. All manual editions of those attribute values 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; ##"deprecated": true##). It only can be permanently removed from the **##properties.json##** file, if the entry is manually deleted.
101 101  
102 102  (% style="text-align: justify;" %)
103 -This setup also allows us to define some values/entries to be automatically filled in by the openMINDS integration pipeline with each commit to one of the openMINDS repositories (**##"name"##**, **##"schemas"##**) and others to be manually editable later on (**##"description"##**, **##"translatableTo"##**, **##"sameAs"##**, **##"nameForReverseLink"##**).
104 -
105 -(% style="text-align: justify;" %)
106 -For security, outdated entries in those openMINDS vocabulary files (e.g., because the namespace of the schema type or property changed or the schema type or property was deleted) are not automatically deleted, but kept and marked as being deprecated. After evaluation, deprecated schema types or properties can be deleted manually from openMINDS vocabulary.
107 -
108 -(% style="text-align: justify;" %)
109 109  With that, the openMINDS vocab reflects always an up-to-date status of the schema types and properties in use across all openMINDS metadata models, while providing the opportunity to centrally review and maintain their consistency and references.
110 110  
111 111  === The openMINDS schema template syntax ===
... ... @@ -143,7 +143,7 @@
143 143  Under **##"required"##** a list of property names can be provided that are obligatory to be present in a correctly instantiated metadata instance of the respective schema. If none of the properties are required, this key-value pair does not have to be specified.
144 144  
145 145  (% style="text-align: justify;" %)
146 -Now, 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"##**.
140 +Now, 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"##**.
147 147  
148 148  === The openMINDS integration pipeline ===
149 149  
Public

openMINDS