Skip to content

Commit

Permalink
Add description of OEMetaDataBuilder #245
Browse files Browse the repository at this point in the history
  • Loading branch information
vismayajochem committed Sep 20, 2024
1 parent 1eb63bf commit b62c9b5
Showing 1 changed file with 41 additions and 3 deletions.
44 changes: 41 additions & 3 deletions docs/tutorials/99_other/oemetadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,50 @@ On the OEP there is a tool to create your OEMetaData directly on the platfrom. I

You can find the [OEMetaDataBuilder](https://openenergyplatform.org/dataedit/oemetabuilder/) on the OEP under [Database](https://openenergyplatform.org/dataedit/schemas) by clicking on `OEMetaBuilder` in the upper right corner.
![Database](images/Screenshots_OEMetaData/0_Database.png)
Then the OEMetaDataBuilder opens and you can see all the fields. Right next to the headline `Create new Metadata` there are two buttons; With the first one (the pen) you can edit and/or copy the code on which this page is based on in a popup window. With the second (the menu) you can choose which fields will be shown or hidden by clicking on them in the list in the popup window. Beneath all fields is a description of what values and information may be filled in the field above. For more detailed information please see the [key descriptions](https://github.com/OpenEnergyPlatform/oemetadata/blob/develop/metadata/v160/metadata_key_description.md).
In order for the OEMetaData dataset to exist on the OEP the ID field must be filled out. You can also give a name, title and description to your OEMetaData.
Then the OEMetaDataBuilder opens and you can see all the fields. Right next to the headline `Create new Metadata` there are two buttons; With the first one (the pen) you can edit and/or copy the code on which this page is based on in a popup window. With the second (the menu) you can choose which fields will be shown or hidden by clicking on them in the list in the popup window. Whenever there is a such a `menu` button next to a headline it enables you to choose which fields will be shown or hidden. Beneath all fields is a description of what values and information may be filled in the field above. For more detailed information please see the [key descriptions](https://github.com/OpenEnergyPlatform/oemetadata/blob/develop/metadata/v160/metadata_key_description.md).
In order for the OEMetaData dataset to exist on the OEP the ID field must be filled out. You can also give a name, title and description to your OEMetaData. If you create OEMetaData to an already existing table some fields will be filled automatically once you filled in the ID of the table. This makes it easier for you and minimizes the possibles errors.
![Anfang](images/Screenshots_OEMetaData/1_Anfang.png)
Under `Subject` you can provide subjects which describe your data. In the `Name`-field please provide the human readable name of the subject, e.g. energy. In the `Path`-field please provide the corresponding URL to the OEO, e.g. https://openenergy-platform.org/ontology/oeo/OEO_00000150. You can add subjects by clicking on the `+` right next to the headline `Subject`. Note: Subjects help other users to find you data and know what it is about.
![Subject](images/Screenshots_OEMetaData/2_Subject.png)
You can provide language tag(s) for all languages used in your data, inculding the table and the OEMetaData dataset. You can add multiple languages by the `+` right next to the headline `Language`. Note: Please use the required standard (IETF (BCP47)).
![Language](images/Screenshots_OEMetaData/3_Language.png)
Additionally to the Subjects you can also provide `Keywors`. These don't have to be defined in the OEO, but can help to describe the content of your data even more precisly.
![Language](images/Screenshots_OEMetaData/4_Keywords.png)
![Language](images/Screenshots_OEMetaData/4_Keywords.png)
You can give context to your data, e.g. a research project. This makes your data more comprehendable and traceable for others.
![Context](images/Screenshots_OEMetaData/5_Context_1.png)
![Context](images/Screenshots_OEMetaData/6_Context_2.png)
You can specify the spatial context of your data, e.g. the region in which a research was done.
![Spatial](images/Screenshots_OEMetaData/7_Spatial.png)
You can also define the time of your data. Either a reference date or a time span.
![Temporal](images/Screenshots_OEMetaData/8_Temporal.png)
You can add a `Timeseries` by clicking on the `+` next it. There you can specify start, end and resolution of the series and information about how the data is implemented in the table. You can add multiple timeseries if neccessarry.
![Timeseries-1](images/Screenshots_OEMetaData/9_Timeseries-1.png)
![Timeseries-2](images/Screenshots_OEMetaData/10_Timeseries-2.png)
You can provide information on your `Sources`, `Licenses`, `Contributers` and `Recourses`. You can add each of them by clicking on the `+` next to the headline.
![Sources-1](images/Screenshots_OEMetaData/11_Sources-1.png)
You can list your sources by providing a human readable title, a description of the source and the path to the source as URL. You can add multiple sources.
![Sources-2](images/Screenshots_OEMetaData/12_Sources-2.png)
You can also provide the license of each source by providing the SPDX identifire, a human readable name as well as a path to the license and further information.
![License-1](images/Screenshots_OEMetaData/13_License-1.png)
![License-2](images/Screenshots_OEMetaData/14_License-2.png)
You may provide information about the contributors of your data. You can add multiple contributors and add details about their contribution.
![Contributors-1](images/Screenshots_OEMetaData/15_Contributors-1.png)
![Contributors-2](images/Screenshots_OEMetaData/16_Contributors-2.png)
You can also annotate the data in your table. This helps to make the data in your table comparable to others because it makes a connection between coulumns and/or fields to classes in the OEO. In order to do so you must add resource(s) by clicking on the `+` next to the headline `Recourses`. For all resources you must add an unique name. Ich bin etwas verwirrt und weiß nicht, ob ich das folgende richtig beschreibe!
![Resources](images/Screenshots_OEMetaData/17_Resources.png)
You can specify the content of a field in your table by identifiying the field, giving its description and data type.
![Field](images/Screenshots_OEMetaData/18_Field-1.png)
The important step of making the connection between the entries in your table and the classes of the ontology happens now by providing the human readable term and the path to the OEO.
![isabout](images/Screenshots_OEMetaData/19_isabout.png)
You can also provide a class of the OEO for entries of a whole column. By giving the name of the column and the name and path of the OEO class as well as the unit. Of course you can do this for multiples rows by clicking on the `+` right next to the headline `ValueReferences`.
![ValueReferences](images/Screenshots_OEMetaData/20_ValueReferences.png)
![EndeField](images/Screenshots_OEMetaData/21_EndeField.png)
You can also give a `Primary Key` which uniquely identifies each row of your table.
![PrimaryKey](images/Screenshots_OEMetaData/22_PrimaryKey.png)
You can also refer to an other table by giving a `Foreign Key`.
![ForeignKey](images/Screenshots_OEMetaData/23_ForeignKeys.png)
If you want to reference another table you can provide the foreign table in the `Reyource`-field and then specifying which column should be referencced in the `Field` below.
![References](images/Screenshots_OEMetaData/24_References.png)
At the end you can provide an explantation of your data in terms defined by the OEO and a URI via the DBpedia Databus.
![Ende](images/Screenshots_OEMetaData/25_Ende.png)
You can submit your OEMetaData if there already exist a table for your dataset. You can always download the dataset as a JSON-file or cancel the process using the buttons at the very end of the page.

0 comments on commit b62c9b5

Please sign in to comment.