This pages describes the key of OEMetadata version 2.1 .
You can have a look at an empty template and a filled out example of the metadata string.
The schema.json contains the complete metadata schema.
The cardinality defines the number of times an element can occur.
- [1] Mandatory
- [0..1] Optional
- [*] Multiple optional
- [1..*] Mandatory and multiple optional
Badges indicate the priority of metadata keys.
They are implemented as part of the Open Peer Review Process.
If a field is not applicable use: null.
If a value is not yet available, use: ToDo.
# |
Key |
Description |
Example |
Ontology Class |
Badge |
Card. |
|---|---|---|---|---|---|---|
| 1 | @context | Explanation of metadata keys in ontology terms. | context.json test | test | Platinum | [0..1] |
| 2 | @id | A unique identifier (UUID/DOI) for the dataset. This is the Databus Artifact. | databus.openenergyplatform.org/oeplatform/supply/wri_global_power_plant_database/ test | dct:identifier | Platinum | [0..1] |
| 3 | name | A filename or database conform dataset name. | oep_oemetadata | rdfs:label | Iron | [1] |
| 4 | title | A human readable dataset name. | OEP OEMetadata | dct:title | Bronze | [0..1] |
| 5 | description | A free text description of the dataset. | A collection of tables for the OEMetadata examples. | dct:description | Bronze | [0..1] |
| 6 | languages | An array of languages used within the described data structures (e.g. titles, descriptions). The language key can be repeated if more languages are used. Standard: IETF (BCP47) | en-GB, de-DE | dct:language | Gold | [*] |
| 7 | version | A version string identifying the version of the package. | 0.1.0 | dcat:version | Silver | [0..1] |
| 8 | image | An image to use for this data package. | https://openenergyplatform.org/static/img/about/OpenEnergyFamily_GroupPhoto2.png | schema.org:image | Gold | [0..1] |
| 9 | subject | An array of objects that references to the subjects of the resource in ontology terms. | - | [*] | ||
| 9.1 | name | A class label of the ontology term. | energy | rdfs:label | Platinum | [0..1] |
| 9.2 | @id | A unique identifier (URI/IRI) of the ontology class. | openenergyplatform.org/ontology/oeo/OEO_00000150 | dct:subject | Platinum | [0..1] |
| 10 | keywords | An array of freely selectable keywords that help with searching and structuring. | example, ODbL-1.0, NFDI4Energy | dcat:keyword | Silver | [*] |
# |
Key |
Description |
Example |
Ontology Class |
Badge |
Card. |
|---|---|---|---|---|---|---|
| 1 | projectContext | An object that describes the general setting, environment, or project leading to the creation or maintenance of this dataset. In science this is can be the research project. | [0..1] | |||
| 1.1 | title | A title of the associated project. | NFDI4Energy | dct:title | Gold | [0..1] |
| 1.2 | homepage | A URL of the project. | nfdi4energy.uol.de | foaf:homepage | Gold | [0..1] |
| 1.3 | documentation | A URL of the project documentation. | nfdi4energy.uol.de/sites/about_us | ncit:Project Description | Gold | [0..1] |
| 1.4 | sourceCode | A URL of the source code of the project. | github.com/NFDI4Energy | oeo:code source | Gold | [0..1] |
| 1.5 | publisher | The publishing agency of the data. This can be the OEP. | Open Energy Platform (OEP) | dct:publisher | Gold | [0..1] |
| 1.6 | publisherLogo | A URL to the logo of the publishing agency of data. | OpenEnergyFamily_Logo_OpenEnergyPlatform.svg | foaf:logo | Gold | [0..1] |
| 1.7 | contact | A reference to the creator or maintainer of the data set. It can be an email address or a GitHub handle. | info@nfdi4energy.org | oeo:contact person | Gold | [0..1] |
| 1.8 | fundingAgency | A name of the entity providing the funding. This can be a government agency or a company. | Deutsche Forschungsgemeinschaft (DFG) | sc:FundingAgency | Gold | [0..1] |
| 1.9 | fundingAgencyLogo | A URL to the logo or image of the funding agency. | DFG-logo-blau.svg | foaf:logo | Gold | [0..1] |
| 1.10 | grantNo | An identifying grant number. In case of a publicly funded project, this number is assigned by the funding agency. | 501865131 | sc:Grant | Gold | [0..1] |
# |
Key |
Description |
Example |
Ontology Class |
Badge |
Card. |
|---|---|---|---|---|---|---|
| 1 | contributors | An array of objects of the people or organizations who contributed to the data or metadata. Should have "Date of data creation" and "Date of metadata creation" | foaf:Agent | [*] | ||
| 1.1 | title | A name of the contributor. Note that the personal name format should be: family, given | Hülk, Ludwig | dct:title | Bronze | [0..1] |
| 1.2 | path | A qualified link or path pointing to a relevant location online for the contributor. This can be the GitHub page or ORCID. | https://github.com/Ludee | sc:url | Bronze | [0..1] |
| 1.3 | organization | A string describing the organization this contributor is affiliated to. This can be relevant for the copyright. | Reiner Lemoine Institut | oeo:organisation | Bronze | [0..1] |
| 1.4 | roles | An array describing the roles of the contributor. A role is recommended to follow the established vocabulary: DataCite Metadata Schema’s contributorRole. Useful roles to indicate are: DataCollector, ContactPerson, and DataCurator. | DataCollector, DataCurator | oeo:role | Bronze | [*] |
| 1.5 | date | The date of the contribution. Date Format is ISO 8601. | 2024-10-21 | dct:issued | Bronze | [0..1] |
| 1.6 | object | The target of the contribution. This can be the data, the metadata or both (data and metadata). | data and metadata | dct:type | Bronze | [0..1] |
| 1.7 | comment | A free-text commentary on what has been done. | Add general context. | rdfs:comment | Bronze | [0..1] |
# |
Key |
Description |
Example |
Ontology Class |
Badge |
Card. |
|---|---|---|---|---|---|---|
| 1 | datasetLicenses | An array of objects of licenses under which the described dataset is provided. | dct:license | [*] | ||
| 1.1 | name | The SPDX identifier. | ODbL-1.0 | rdfs:label | Bronze | [0..1] |
| 1.2 | title | The official (human-readable) title of the license. | Open Data Commons Open Database License 1.0 | dct:title | Bronze | [0..1] |
| 1.3 | path | A link or path to the license text. | opendatacommons.org/licenses/odbl/1-0/index.html | dcat:accessURL | Bronze | [0..1] |
| 1.4 | instruction | A short description of rights and obligations. The use of tl;drLegal is recommended. | You are free to share and change, but you must attribute, and share derivations under the same license. See tldrlegal.com for further information. | dc:rights | Bronze | [0..1] |
| 1.5 | attribution | A copyright owner of the data. Must be provided if attribution licenses are used. | © Reiner Lemoine Institut | spdx:attributionText | Bronze | [0..1] |
| 1.6 | copyrightStatement | A link or path that proves that the data has the appropriate license. This can be a page number or website imprint. | www.ipcc.ch/copyright/ | dct:rights | Bronze | [0..1] |
# |
Key |
Description |
Example |
Ontology Class |
Badge |
|---|---|---|---|---|---|
| 1. | review | The metadata on the OEP can go through an open peer review process. See the Academy course Open Peer Review for further information. | [0..1] | ||
| 1.1 | path | A link or path to the documented open peer review. | open_peer_review/9 | sc:url | [0..1] |
| 1.2 | badge | A badge of either Iron, Bronze, Silver, Gold or Platinum is used to label the quality of the metadata. | Platinum | oeo:quality control flag | [0..1] |
# |
Key |
Description |
Example |
Ontology Class |
Badge |
Card. |
|---|---|---|---|---|---|---|
| 1 | resources | An array of objects of the resources. The dataset can contain several (database) tables. | dcat:Dataset | [*] |
# |
Key |
Description |
Example |
Ontology Class |
Badge |
Card. |
|---|---|---|---|---|---|---|
| 1 | @id | A Uniform Resource Identifier (URI) that links the resource via the OpenEnergyDatabus (DBpedia Databus). | wri_global_power_plant_database | dct:identifier | Platinum | [0..1] |
| 2 | path | A unique identifier (URI/UUID/DOI) for the table or file. | oemetadata_table_template | dcat:accessURL | Bronze | [0..1] |
| 3 | name | A filename or database conform table name. | oemetadata_table_template | rdfs:label | Iron | [1] |
| 4 | title | A human readable resource or table name. | OEMetadata Table | dct:title | Silver | [0..1] |
| 5 | description | A description of the table. It should be usable as summary information for the table that is described by the metadata. | Example table used to illustrate the OEMetadata structure and features. | dct:description | Silver | [0..1] |
| 6 | publicationDate | A date of publication of the data or metadata. The date format is ISO 8601 (YYYY-MM-DD). | 2024-10-15 | dct:issued | Bronze | [0..1] |
| 7 | subject | An array of objects that references to the subjects of the resource in ontology terms. | [*] | |||
| 7.1 | name | A class label of the ontology term. | energy | rdfs:label | Platinum | [0..1] |
| 7.2 | @id | A unique identifier (URI/IRI) of the ontology class. | openenergyplatform.org/ontology/oeo/OEO_00000150 | dct:subject | Platinum | [0..1] |
| 8 | keywords | An array of freely selectable keywords that help with searching and structuring. The keyword are used and managed in the OEP as table tags. | example, ODbL-1.0, NFDI4Energy | dcat:keyword | Silver | [*] |
| 9 | embargoPeriod | An object that describes the embargo period during which public access to the data is not allowed. | [0..1] | |||
| 9.1 | start | The start date of the embargo period. The date of the data (metadata) upload. | 2024-10-11 | dbo:startDateTime | Bronze | [0..1] |
| 9.2 | end | The end date of the embargo period. This is the envisioned publication date. | 2025-01-01 | dbo:endDateTime | Bronze | [0..1] |
| 9.3 | isActive | A boolean key that indicates if the embargo period is currently active. Must be changed to False on the embargo period end date. | True | adms:status | Bronze | [0..1] |
# |
Key |
Description |
Example |
Ontology Class |
Badge |
Card. |
|---|---|---|---|---|---|---|
| 1 | spatial | An object that describes the spatial context of the data. | [0..1] | |||
| 1.1 | location | An object that describes a specific location. | dct:location | [0..1] | ||
| 1.1.1 | address | An address of the location of the data. May be specified with street name, house number, zip code, and city name. | Rudower Chaussee 12, 12489 Berlin | schema:address | Silver | [0..1] |
| 1.1.2 | @id | A path or URI to a specific location. It can use Wikidata or OpenStreetMap. | www.wikidata.org/wiki/Q77077223 | dct:identifier | Platinum | [0..1] |
| 1.1.3 | latitude | The latitude (lat) information of the location. | 52.432822 | schema:latitude | Gold | [0..1] |
| 1.1.4 | longitude | The longitude (lon) information of the location. | 13.5351004 | schema:longitude | Gold | [0..1] |
| 1.2 | extent | An object that describes a covered area or region. | oeo:spatial region | [0..1] | ||
| 1.2.1 | name | The name of the region. | Berlin | rdfs:label | Silver | [0..1] |
| 1.2.2 | @id | A URI reference for the region. | www.wikidata.org/wiki/Q64 | dct:identifier | Platinum | [0..1] |
| 1.2.3 | resolutionValue | The value of the spatial resolution. | 100 | dcat:spatialResolutionInMeters | Silver | [0..1] |
| 1.2.4 | resolutionUnit | The unit of the spatial resolution. | m | oeo:unit | Silver | [0..1] |
| 1.2.5 | boundingBox | The covered area specified by the coordinates of a bounding box. The format is [minLon, minLat, maxLon, maxLat] or [W,S,E,N]. | [13.08825, 52.33859, 13.76104, 52.6754] | dcat:bbox | Gold | [*] |
| 1.2.6 | crs | The Coordinate Reference System, specified as an EPSG code. | EPSG:4326 | cco:Geospatial Coordinate Reference System | Gold | [0..1] |
# |
Key |
Description |
Example |
Ontology Class |
Badge |
Card. |
|---|---|---|---|---|---|---|
| 1 | temporal | An object with the time period covered in the data. Temporal information should contain a "referenceDate" or the keys that describe a time series, or both. | schema:temporalCoverage | [0..1] | ||
| 1.1 | referenceDate | A base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601. | 2020-01-01 | dct:date | Silver | [0..1] |
| 1.2 | timeseries | An array that describes the timeseries. | dct:PeriodOfTime | [*] | ||
| 1.2.1 | start | The start time of a time series. | 2020-01-01T00:00:00+00:00 | dbo:startDateTime | Silver | [0..1] |
| 1.2.2 | end | The temporal end point of a time series. | 2020-01-01T23:59:30+00:00 | dbo:endDateTime | Silver | [0..1] |
| 1.2.3 | resolutionValue | The time span between individual information points in a time series. The value of the resolution. | 15 | dcat:spatialResolutionInMeters | Silver | [0..1] |
| 1.2.4 | resolutionUnit | The unit of the temporal resolution. | min | oeo:unit | Silver | [0..1] |
| 1.2.5 | alignment | An indicator of whether timestamps in a time series are to the left, right or in the centre. | left | oeo:time stamp alignment | Silver | [0..1] |
| 1.2.6 | aggregationType | An indicator of whether the values are a sum, an average or a current value. | current | oeo:aggregation type | Silver | [0..1] |
# |
Key |
Description |
Example |
Ontology Class |
Badge |
Card. |
|---|---|---|---|---|---|---|
| 1 | modules | An objects with domain specific metadata | [0..1] |
# |
Key |
Description |
Example |
Ontology Class |
Badge |
Card. |
|---|---|---|---|---|---|---|
| 1 | moduleName | The name of the module | Energy Systems | Platinum | [0..1] | |
| 3 | supplyTechnologies | A supply technology describes how specific technical components and processes are combined to generate or provide energy | (Solar, Wind, Biomass, Biogas, Geo, ST, other) | oeo:OEO_00020003 energy transformation | Platinum | [0..1] |
| 4 | storageTechnologies | An energy storage technology describes how energy storage components and energy carriers are combined to charge, store, and discharge energy for temporary use. | (Battery, Kinetic, CA, Pump, Chemical) | oeo:00020366 energy storage technology | Platinum | [0..1] |
| 6 | supplyGrid | A supply grid is a system of interconnected technical components that together enable the distribution and delivery of energy. | (electricity, gas, heating) | oeo:OEO_00000200 supply grid | Platinum | [0..1] |
| 2 | finalEnergyCarrier | A final energy carrier is an energy carrier that is delivered to and directly used by end users without further transformation. | (electricity, heating, gas, fuel, ...) | oeo:OEO_00140080 final energy carrier | Platinum | [0..1] |
| 5 | demandSectors | An energy demand sector is a sector of the energy system that groups together energy consumers with similar usage characteristics. | (building, commercial, households, transport) | oeo:OEO_00000128 energy demand sector | Platinum | [0..1] |
| 7 | moduleDescription | A description of the module. It should be usable as summary information for the module that is described by the metadata. | Example table used to illustrate the OEMetadata structure and features. | dct:description | Platinum | [0..1] |
# |
Key |
Description |
Example |
Ontology Class |
Badge |
Card. |
|---|---|---|---|---|---|---|
| 1 | moduleName | The name of the module WIP | Measurement Data | ? | Platinum | [0..1] |
| 2 | instrumentIdentifier | Unique string that identifies the instrument instance | http://hdl.handle.net/21.11157/a9250866-bbec-4542-86b3-a5f78c0c6922 | ? | Platinum | [0..1] |
| 3 | instrumentPath | A landing page that the identifier resolves to | https://sms.atmohub.kit.edu/devices/961 | ? | Platinum | [0..1] |
| 5 | instrumentName | Name by which the instrument instance is known | MFC_001000_02 - Merck KGaA - FC-2926V - DH9806004 | ? | Platinum | [0..1] |
| 4 | instrumentOwner | Institution(s) responsible for the management of the instrument. This may include the legal owner, the operator, or an institute providing access to the instrument. | Karlsruhe Institute of Technology (KIT) | ? | Platinum | [0..1] |
| 5 | manufacturerName | Full name of the manufacturer | Merck KGaA | ? | Platinum | [0..1] |
| 6 | moduleDescription | A description of the module. It should be usable as summary information for the module that is described by the metadata. | Example instrument of PIDInst. | dct:description | Platinum | [0..1] |
# |
Key |
Description |
Example |
Ontology Class |
Badge |
Card. |
|---|---|---|---|---|---|---|
| 1 | moduleName | The name of the module WIP | Data Transformations | [0..1] | ||
| 2 | softwareName | XA base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601. | 2020-01-01 | dct:date | Silver | [0..1] |
| 3 | softwarePath | XA base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601. | 2020-01-01 | dct:date | Silver | [0..1] |
| 4 | softwareVersion | XA base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601. | 2020-01-01 | dct:date | Silver | [0..1] |
| 5 | softwareType | XA base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601. | 2020-01-01 | dct:date | Silver | [0..1] |
| 6 | programmingLanguage | XA base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601. | 2020-01-01 | dct:date | Silver | [0..1] |
| 7 | moduleDescription | A description of the module. It should be usable as summary information for the module that is described by the metadata. | Example table used to illustrate the OEMetadata structure and features. | dct:description | Silver | [0..1] |
# |
Key |
Description |
Example |
Ontology Class |
Badge |
Card. |
|---|---|---|---|---|---|---|
| 1 | moduleName | The name of the module WIP | Transportation Systems | [0..1] | ||
| 2 | transportMode | XA base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601. | 2020-01-01 | dct:date | Silver | [0..1] |
| 3 | meansOfTransport | XA base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601. | 2020-01-01 | dct:date | Silver | [0..1] |
| 4 | transportInfrastructure | XA base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601. | 2020-01-01 | dct:date | Silver | [0..1] |
| 5 | dataGenerationMethod | XA base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601. | 2020-01-01 | dct:date | Silver | [0..1] |
| 6 | surveyPopulation | XA base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601. | 2020-01-01 | dct:date | Silver | [0..1] |
| 7 | elementaryUnit | XA base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601. | 2020-01-01 | dct:date | Silver | [0..1] |
| 8 | spatialUnit | XA base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601. | 2020-01-01 | dct:date | Silver | [0..1] |
| 9 | moduleDescription | A description of the module. It should be usable as summary information for the module that is described by the metadata. | Example table used to illustrate the OEMetadata structure and features. | dct:description | Silver | [0..1] |
# |
Key |
Description |
Example |
Ontology Class |
Badge |
Card. |
|---|---|---|---|---|---|---|
| 1 | moduleName | The name of the module WIP | Advanced Provenience | [0..1] | ||
| 2 | policy | XA base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601. | 2020-01-01 | dct:date | Silver | [0..1] |
| 3 | objectLifeCycleType | XA base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601. | 2020-01-01 | dct:date | Silver | [0..1] |
| 4 | objectTombstoneInformation | XA base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601. | 2020-01-01 | dct:date | Silver | [0..1] |
| 5 | provenanceGraph | XA base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601. | 2020-01-01 | dct:date | Silver | [0..1] |
| 6 | wasGeneratedBy | XA base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601. | 2020-01-01 | dct:date | Silver | [0..1] |
| 7 | moduleDescription | A description of the module. It should be usable as summary information for the module that is described by the metadata. | Example table used to illustrate the OEMetadata structure and features. | dct:description | Silver | [0..1] |
# |
Key |
Description |
Example |
Ontology Class |
Badge |
Card. |
|---|---|---|---|---|---|---|
| 1 | sources | An array of objects with the used and underlying sources of the data and metadata. | dct:source | [*] | ||
| 1.1 | title | A human readable title of the source, a document title or organisation name. | IPCC Sixth Assessment Report (AR6) - Climate Change 2023 - Synthesis Report | dct:title | Bronze | [0..1] |
| 1.2 | authors | An array of the full names of the authors of the source material. | Hoesung Lee,José Romero, The Core Writing Team | oeo:author | Bronze | [*] |
| 1.3 | description | A free text description of the source. | A Report of the Intergovernmental Panel on Climate Change | dct:description | Bronze | [0..1] |
| 1.4 | publicationYear | Indicates the year when the work was published. | 2023 | dct:issued | Bronze | [0..1] |
| 1.5 | path | A DOI or link to the original source. | IPCC_AR6_SYR_FullVolume.pdf | sc:url | Bronze | [0..1] |
| 1.6 | sourceLicenses | An array of objects of licenses under which the described source is provided. See academy/courses/08_licensing for further information. | dct:license | [*] | ||
| 1.6.1 | name | The SPDX identifier. | ODbL-1.0 | rdfs:label | Bronze | [0..1] |
| 1.6.2 | title | The official (human-readable) title of the license. | Open Data Commons Open Database License 1.0 | dct:title | Bronze | [0..1] |
| 1.6.3 | path | A link or path to the license text. | opendatacommons.org/licenses/odbl/1-0/index.html | sc:url | Bronze | [0..1] |
| 1.6.4 | instruction | A short description of rights and obligations. The use of tl;drLegal is recommended. | You are free to share and change, but you must attribute, and share derivations under the same license. See tldrlegal.com for further information. | rdfs:comment | Bronze | [0..1] |
| 1.6.5 | attribution | A copyright owner of the source. Must be provided if attribution licenses are used. | © Intergovernmental Panel on Climate Change 2023 | ms:copyright notice | Bronze | [0..1] |
| 1.6.6 | copyrightStatement | A link or path that proves that the source or data has the appropriate license. This can be a page number or website imprint. | www.ipcc.ch/copyright | dct:rights | Bronze | [0..1] |
# |
Key |
Description |
Example |
Ontology Class |
Badge |
Card. |
|---|---|---|---|---|---|---|
| 1 | resourceLicenses | An array of objects of licenses under which the described data is provided. | dct:license | [*] | ||
| 1.1 | name | The SPDX identifier. | ODbL-1.0 | rdfs:label | Bronze | [0..1] |
| 1.2 | title | The official (human-readable) title of the license. | Open Data Commons Open Database License 1.0 | dct:title | Bronze | [0..1] |
| 1.3 | path | A link or path to the license text. | opendatacommons.org/licenses/odbl/1-0/index.html | dcat:accessURL | Bronze | [0..1] |
| 1.4 | instruction | A short description of rights and obligations. The use of tl;drLegal is recommended. | You are free to share and change, but you must attribute, and share derivations under the same license. See tldrlegal.com for further information. | dc:rights | Bronze | [0..1] |
| 1.5 | attribution | A copyright owner of the data. Must be provided if attribution licenses are used. | © Reiner Lemoine Institut | spdx:attributionText | Bronze | [0..1] |
| 1.6 | copyrightStatement | A link or path that proves that the data has the appropriate license. This can be a page number or website imprint. | www.ipcc.ch/copyright/ | dct:rights | Bronze | [0..1] |
# |
Key |
Description |
Example |
Ontology Class |
Badge |
Card. |
|---|---|---|---|---|---|---|
| 1 | type | The 'table' type indicates that the resource is tabular as per 'Frictionless Tabular Data' definition. | table | csvw:datatype | Gold | [0..1] |
| 2 | format | A file extension format. Possible options are 'csv', 'xlsx', 'json', 'PostgreSQL', 'SQLite' and other standard file extensions. | PostgreSQL | dct:format | Gold | [0..1] |
| 3 | encoding | Specifies the character encoding of the resource's data file. The default is 'UTF-8'. The values should be one of the 'Preferred MIME Names'. | UTF-8 | csvw:encoding | Gold | [0..1] |
# |
Key |
Description |
Example |
Ontology Class |
Badge |
Card. |
|---|---|---|---|---|---|---|
| 1 | schema | An object that describes the structure of a table. It contains all fields (columns of the table), the primary key and optional foreign keys. | schema:table | [1] | ||
| 1.1 | fields | An array of objects that describes a field (column) and its detailed information. | csvw:column | [1] | ||
| 1.1.1 | name | The name of the field. The name may only consist of lowercase alphanumeric characters or underscores. It must not begin with a number or an underscore. | year | rdfs:label | Iron | [1] |
| 1.1.2 | description | A text describing the field. | Reference year for which the data were collected. | dct:description | Silver | [0..1] |
| 1.1.3 | type | The data type of the field. In case of a geom column in a database, also indicate the shape and CRS. | geometry(Point, 4326) | csvw:datatype | Iron | [1] |
| 1.1.4 | nullable | A boolean key to specify that a column can be nullable. True is the default value. | True | ncit:null | Iron | [1] |
| 1.1.5 | unit | The unit of a field. If it does not apply, use 'null'. If the unit is given in a separate field, reference this field (e.g. 'unit'). Use a space between numbers and units (100 m). | MW | oeo:has unit | Silver | [0..1] |
| 1.1.6 | isAbout | An array of objects that describes the field in ontology terms. | sc:about | [*] | ||
| 1.1.6.1 | name | The class label of the ontology term. | wind energy converting unit | rdfs:label | Platinum | [0..1] |
| 1.1.6.2 | @id | The path of the ontology term (IRI). | OEO_00000044 | dct:identifier | Platinum | [0..1] |
| 1.1.7 | valueReference | An array of objects for an extended description of the values in the column in ontology terms. | prov:value | [*] | ||
| 1.1.7.1 | value | The name of the value in the column. | onshore | rdf:value | Platinum | [0..1] |
| 1.1.7.2 | name | The class label of the ontology term in the column. | onshore wind farm | rdfs:label | Platinum | [0..1] |
| 1.1.7.3 | @id | The path of the ontology term (IRI) in the column. | OEO_00000311 | dct:identifier | Platinum | [0..1] |
# |
Key |
Description |
Example |
Ontology Class |
Badge |
Card. |
|---|---|---|---|---|---|---|
| 1.2 | primaryKey | An array of fields that uniquely identifies each row in the table. The default value is the “id” column. | id | csvw:primaryKey | Iron | [1..*] |
| 1.3 | foreignKeys | An array of objects with foreign keys that describe a field that relates to a field in another table. | csvw:foreignKey | [*] | ||
| 1.3.1 | fields | An array of fields in the table that is constrained by the foreign key. | id, version | ex:nestedFields | Iron | [*] |
| 1.3.2 | reference | The reference to the foreign table. | [0..1] | |||
| 1.3.2.1 | resource | The referenced foreign table. | oemetadata_table_template | dcat:Dataset | Iron | [0..1] |
| 1.3.2.2 | fields | The foreign resource column. | id, version | csvw:column | Iron | [*] |
| 1.4 | dialect | The Dialect defines a simple format for describing the various dialects of CSV files in a language-independent manner. In a database, the values in the fields are 'null'. | [1] | |||
| 1.4.1 | delimiter | The delimiter specifies the character sequence which should separate fields (columns). Common characters are ',' (comma), ';' (semicolon), '.' (point) and '\t' (tab). | , | csvw:delimiter | Iron | [1] |
| 1.4.2 | decimalSeparator | The symbol used to separate the integer part from the fractional part of a number written in decimal form. Depending on language and region this symbol can be '.' or ','. | . | csvw:decimalChar | Iron | [1] |
# |
Key |
Description |
Example |
Ontology Class |
Badge |
|---|---|---|---|---|---|
| 1. | review | The metadata on the OEP can go through an open peer review process. See the Academy course Open Peer Review for further information. | [0..1] | ||
| 1.1 | path | A link or path to the documented open peer review. | open_peer_review/9 | sc:url | [0..1] |
| 1.2 | badge | A badge of either Iron, Bronze, Silver, Gold or Platinum is used to label the quality of the metadata. | Platinum | oeo:quality control flag | [0..1] |
# |
Key |
Description |
Example |
Ontology Class |
Card. |
|---|---|---|---|---|---|
| 1 | metaMetadata | An object that describes the metadata themselves, their format, version and license. | [1] | ||
| 1.1 | metadataVersion | Type and version number of the metadata. | OEMetadata-2.0 | owl:versionInfo | [1] |
| 1.2 | metadataLicense | The license of the provided metadata. | dct:license | [1] | |
| 1.2.1 | name | The SPDX identifier. | CC0-1.0 | rdfs:label | [1] |
| 1.2.2 | title | The official (human-readable) title of the license. | Creative Commons Zero v1.0 Universal | dct:title | [1] |
| 1.2.3 | path | A link or path to the license text. | creativecommons.org/publicdomain/zero/1.0/ | sc:url | [1] |