Skip to content

OEMetadata - Key Description#

This pages describes the key of OEMetadata version 2.0 .
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.

Introduction#

JSON Format#

The JSON format offers different formats:

  • key-value pair: JSON {"key":"value"}
  • array: JSON {"key": ["value","value"]}
  • object {nested key}: JSON {"key": { "key_a":"value", "key_b":"value"}}
  • array of objects {nested array}: JSON {"key": [ {"key_a":"value"}, {"key_a":"value"}]}

Cardinality#

The cardinality defines the number of times an element can occur.

  • [1] Mandatory
  • [0..1] Optional
  • [*] Multiple optional
  • [1..*] Mandatory and multiple optional

Badges#

Badges indicate the priority of metadata keys.
They are implemented as part of the Open Peer Review Process.

Additional information:
#

If a field is not applicable use: null.
If a value is not yet available, use: ToDo.

Overview#

Collection Keys#

#
Key
Description
Example
Ontology Class
Badge
Card.
1 @context Explanation of metadata keys in ontology terms. context.json Platinum [0..1]
2 name A filename or database conform dataset name. oep_oemetadata rdfs:label Iron [1]
3 title A human readable dataset name. OEP OEMetadata dct:title Bronze [0..1]
4 description A free text description of the dataset. A collection of tables for the OEMetadata examples. dct:description Bronze [0..1]
5 @id A unique identifier (UUID/DOI) for the dataset. This is the Databus Artifact. databus.openenergyplatform.org/oeplatform/supply/wri_global_power_plant_database/ dct:identifier Platinum [0..1]
6 resources An array of objects of the resources. The dataset can contain several (database) tables. dcat:Dataset [*]

Resource - General Keys#

#
Key
Description
Example</ div>
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 name A filename or database conform table name. oemetadata_table_template rdfs:label Iron [1]
3 topics An array of predefined topics that correspond to the database schemas of the OEP. model_draft foaf:topic Bronze [*]
4 title A human readable resource or table name. OEMetadata Table dct:title Silver [0..1]
5 path A unique identifier (URI/UUID/DOI) for the table or file. model_draft/oemetadata_table_template dcat:accessURL Bronze [0..1]
6 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]
7 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 [*]
8 subject An array of objects that references to the subjects of the resource in ontology terms. [*]
8.1 name A class label of the ontology term. energy rdfs:label Platinum [0..1]
8.2 @id A unique identifier (URI/IRI) of the ontology class. openenergyplatform.org/ontology/oeo/OEO_00000150 dct:subject Platinum [0..1]
9 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 [*]
10 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]
11 embargoPeriod An object that describes the embargo period during which public access to the data is not allowed. [0..1]
11.1 start The start date of the embargo period. The date of the data (metadata) upload. 2024-10-11 dbo:startDateTime Bronze [0..1]
11.2 end The end date of the embargo period. This is the envisioned publication date. 2025-01-01 dbo:endDateTime Bronze [0..1]
11.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]

Resource - Context Keys#

#
Key
Description
Example
Ontology Class
Badge
Card.
1 context 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]

Resource - Spatial Keys#

#
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]

Resource - Temporal Keys#

#
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. 30 s dcat:spatialResolutionInMeters Silver [0..1]
1.2.4 resolutionUnit The unit of the temporal resolution. 30 s 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]

Resource - Sources Keys#

#
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]

Resource - Licenses Keys#

#
Key
Description
Example
Ontology Class
Badge
Card.
1 licenses 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]

Resource - Provenance Keys#

#
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 full name of the contributor. Ludwig Hülk 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]

Resource - Type Keys#

#
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]

Resource - Fields Keys#

#
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]

Resource - Properties Keys#

#
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. model_draft.oep_oemetadata_table_example_version 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]

Resource - Review Keys#

#
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]

MetaMetadata Keys#

#
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]

Metadata Keys#

Dataset - @context#
Key @context
Description Explanation of metadata keys in ontology terms.
Example context.json
Ontology Class
Badge Platinum
Card. [0..1]

Dataset - name#
Key name
Description A filename or database conform dataset name.
Example oep_oemetadata
Ontology Class rdfs:label
Badge Iron
Card. [1]

Dataset - title#
Key title
Description A human readable dataset name.
Example OEP OEMetadata
Ontology Class dct:title
Badge Bronze
Card. [0..1]

Dataset - description#
Key description
Description A free text description of the dataset.
Example A collection of tables for the OEMetadata examples.
Ontology Class dct:description
Badge Bronze
Card. [0..1]

Dataset - @id#
Key @id
Description A unique identifier (UUID/DOI) for the dataset. This is the Databus Artifact.
Example databus.openenergyplatform.org/oeplatform/supply/wri_global_power_plant_database/
Ontology Class dct:identifier
Badge Platinum
Card. [0..1]

Dataset - resources#
Key resources
Description An array of objects of the resources. The dataset can contain several (database) tables.
Example
Ontology Class dcat:Dataset
Badge
Card. [*]

Resource - @id#
Key @id
Description A Uniform Resource Identifier (URI) that links the resource via the OpenEnergyDatabus (DBpedia Databus).
Example wri_global_power_plant_database
Ontology Class dct:identifier
Badge Platinum
Card. [0..1]

Resource - name#
Key name
Description A filename or database conform table name.
Example oemetadata_table_template
Ontology Class rdfs:label
Badge Iron
Card. [1]

Resource - topics#
Key topics
Description An array of predefined topics that correspond to the database schemas of the OEP.
Example model_draft
Ontology Class foaf:topic
Badge Bronze
Card. [*]

Resource - title#
Key title
Description A human readable resource or table name.
Example OEMetadata Table
Ontology Class dct:title
Badge Silver
Card. [0..1]

Resource - path#
Key path
Description A unique identifier (URI/UUID/DOI) for the table or file.
Example model_draft/oemetadata_table_template
Ontology Class dcat:accessURL
Badge Bronze
Card. [0..1]

Resource - description#
Key description
Description A description of the table. It should be usable as summary information for the table that is described by the metadata.
Example Example table used to illustrate the OEMetadata structure and features.
Ontology Class dct:description
Badge Silver
Card. [0..1]

Resource - languages#
Key languages
Description 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).
Example en-GB, de-DE
Ontology Class dct:language
Badge Gold
Card. [*]

Resource - subject#
Key subject
Description An array of objects that references the subjects of the resource in ontology terms.
Example
Ontology Class
Badge
Card. [*]

Resource - subject (name)#
Key name
Description A class label of the ontology term.
Example energy
Ontology Class rdfs:label
Badge Platinum
Card. [0..1]

Resource - subject (@id)#
Key @id
Description A unique identifier (URI/IRI) of the ontology class.
Example openenergyplatform.org/ontology/oeo/OEO_00000150
Ontology Class dct:subject
Badge Platinum
Card. [0..1]

Resource - keywords#
Key keywords
Description An array of freely selectable keywords that help with searching and structuring.
Example example, ODbL-1.0, NFDI4Energy
Ontology Class dcat:keyword
Badge Silver
Card. [*]

Resource - publicationDate#
Key publicationDate
Description A date of publication of the data or metadata. The date format is ISO 8601 (YYYY-MM-DD).
Example 2024-10-15
Ontology Class dct:issued
Badge Bronze
Card. [0..1]

Resource - embargoPeriod#
Key embargoPeriod
Description An object that describes the embargo period during which public access to the data is not allowed.
Example
Ontology Class
Badge
Card. [0..1]

Resource - embargoPeriod (start)#
Key start
Description The start date of the embargo period. The date of the data (metadata) upload.
Example 2024-10-11
Ontology Class dbo:startDateTime
Badge Bronze
Card. [0..1]

Resource - embargoPeriod (end)#
Key end
Description The end date of the embargo period. This is the envisioned publication date.
Example 2025-01-01
Ontology Class dbo:endDateTime
Badge Bronze
Card. [0..1]

Resource - embargoPeriod (isActive)#
Key isActive
Description A boolean key that indicates if the embargo period is currently active. Must be changed to False on the embargo period end date.
Example True
Ontology Class adms:status
Badge Bronze
Card. [0..1]

Resource - context#
Key context
Description An object that describes the general setting, environment, or project leading to the creation or maintenance of this dataset. In science, this can be the research project.
Example
Ontology Class
Badge
Card. [0..1]

Resource - context (title)#
Key title
Description A title of the associated project.
Example NFDI4Energy
Ontology Class dct:title
Badge Gold
Card. [0..1]

Resource - context (homepage)#
Key homepage
Description A URL of the project.
Example nfdi4energy.uol.de
Ontology Class foaf:homepage
Badge Gold
Card. [0..1]

Resource - context (documentation)#
Key documentation
Description A URL of the project documentation.
Example nfdi4energy.uol.de/sites/about_us
Ontology Class ncit:Project Description
Badge Gold
Card. [0..1]

Resource - context (sourceCode)#
Key sourceCode
Description A URL of the source code of the project.
Example github.com/NFDI4Energy
Ontology Class oeo:code source
Badge Gold
Card. [0..1]

Resource - context (publisher)#
Key publisher
Description The publishing agency of the data. This can be the OEP.
Example Open Energy Platform (OEP)
Ontology Class dct:publisher
Badge Gold
Card. [0..1]
Key publisherLogo
Description A URL to the logo of the publishing agency of data.
Example OpenEnergyFamily_Logo_OpenEnergyPlatform.svg
Ontology Class foaf:logo
Badge Gold
Card. [0..1]

Resource - context (contact)#
Key contact
Description A reference to the creator or maintainer of the data set. It can be an email address or a GitHub handle.
Example info@nfdi4energy.org
Ontology Class oeo:contact person
Badge Gold
Card. [0..1]

Resource - context (fundingAgency)#
Key fundingAgency
Description A name of the entity providing the funding. This can be a government agency or a company.
Example Deutsche Forschungsgemeinschaft (DFG)
Ontology Class sc:FundingAgency
Badge Gold
Card. [0..1]
Key fundingAgencyLogo
Description A URL to the logo or image of the funding agency.
Example DFG-logo-blau.svg
Ontology Class foaf:logo
Badge Gold
Card. [0..1]

Resource - context (grantNo)#
Key grantNo
Description An identifying grant number. In case of a publicly funded project, this number is assigned by the funding agency.
Example 501865131
Ontology Class sc:Grant
Badge Gold
Card. [0..1]

Resource - spatial#
Key spatial
Description An object that describes the spatial context of the data.
Example
Ontology Class
Badge
Card. [0..1]

Resource - spatial (location)#
Key location
Description An object that describes a specific location.
Example
Ontology Class dct:location
Badge
Card. [0..1]

Resource - spatial (location - address)#
Key address
Description An address of the location of the data. May be specified with street name, house number, zip code, and city name.
Example Rudower Chaussee 12, 12489 Berlin
Ontology Class schema:address
Badge Silver
Card. [0..1]

Resource - spatial (location - @id)#
Key @id
Description A path or URI to a specific location. It can use Wikidata or OpenStreetMap.
Example www.wikidata.org/wiki/Q77077223
Ontology Class dct:identifier
Badge Platinum
Card. [0..1]

Resource - spatial (location - latitude)#
Key latitude
Description The latitude (lat) information of the location.
Example 52.432822
Ontology Class schema:latitude
Badge Gold
Card. [0..1]

Resource - spatial (location - longitude)#
Key longitude
Description The longitude (lon) information of the location.
Example 13.5351004
Ontology Class schema:longitude
Badge Gold
Card. [0..1]

Resource - spatial (extent)#
Key extent
Description An object that describes a covered area or region.
Example
Ontology Class oeo:spatial region
Badge
Card. [0..1]

Resource - spatial (extent - name)#
Key name
Description The name of the region.
Example Berlin
Ontology Class rdfs:label
Badge Silver
Card. [0..1]

Resource - spatial (extent - @id)#
Key @id
Description A URI reference for the region.
Example www.wikidata.org/wiki/Q64
Ontology Class dct:identifier
Badge Platinum
Card. [0..1]

Resource - spatial (extent - resolutionValue)#
Key resolutionValue
Description The value of the spatial resolution.
Example 100
Ontology Class dcat:spatialResolutionInMeters
Badge Silver
Card. [0..1]

Resource - spatial (extent - resolutionUnit)#
Key resolutionUnit
Description The unit of the spatial resolution.
Example m
Ontology Class oeo:unit
Badge Silver
Card. [0..1]

Resource - spatial (extent - boundingBox)#
Key boundingBox
Description The covered area specified by the coordinates of a bounding box. The format is [minLon, minLat, maxLon, maxLat] or [W,S,E,N].
Example [13.08825, 52.33859, 13.76104, 52.6754]
Ontology Class dcat:bbox
Badge Gold
Card. [*]

Resource - spatial (extent - crs)#
Key crs
Description The Coordinate Reference System, specified as an EPSG code.
Example EPSG:4326
Ontology Class cco:Geospatial Coordinate Reference System
Badge Gold
Card. [0..1]

Resource - temporal#
Key temporal
Description 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.
Example
Ontology Class schema:temporalCoverage
Badge
Card. [0..1]

Resource - temporal (referenceDate)#
Key referenceDate
Description A base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601.
Example 2020-01-01
Ontology Class dct:date
Badge Silver
Card. [0..1]

Resource - temporal (timeseries)#
Key timeseries
Description An array that describes the timeseries.
Example
Ontology Class dct:PeriodOfTime
Badge
Card. [*]

Resource - temporal (timeseries - start)#
Key start
Description The start time of a time series.
Example 2020-01-01T00:00:00+00:00
Ontology Class dbo:startDateTime
Badge Silver
Card. [0..1]

Resource - temporal (timeseries - end)#
Key end
Description The temporal end point of a time series.
Example 2020-01-01T23:59:30+00:00
Ontology Class dbo:endDateTime
Badge Silver
Card. [0..1]

Resource - temporal (timeseries - resolutionValue)#
Key resolutionValue
Description The time span between individual information points in a time series. The value of the resolution.
Example 30 s
Ontology Class dcat:spatialResolutionInMeters
Badge Silver
Card. [0..1]

Resource - temporal (timeseries - resolutionUnit)#
Key resolutionUnit
Description The unit of the temporal resolution.
Example 30 s
Ontology Class oeo:unit
Badge Silver
Card. [0..1]

Resource - temporal (timeseries - alignment)#
Key alignment
Description An indicator of whether timestamps in a time series are to the left, right or in the centre.
Example left
Ontology Class oeo:time stamp alignment
Badge Silver
Card. [0..1]

Resource - temporal (timeseries - aggregationType)#
Key aggregationType
Description An indicator of whether the values are a sum, an average or a current value.
Example current
Ontology Class oeo:aggregation type
Badge Silver
Card. [0..1]

Resource - sources#
Key sources
Description An array of objects with the used and underlying sources of the data and metadata.
Example
Ontology Class dct:source
Badge
Card. [*]

Resource - sources (title)#
Key title
Description A human readable title of the source, a document title or organisation name.
Example IPCC Sixth Assessment Report (AR6) - Climate Change 2023 - Synthesis Report
Ontology Class dct:title
Badge Bronze
Card. [0..1]

Resource - sources (authors)#
Key authors
Description An array of the full names of the authors of the source material.
Example Hoesung Lee, José Romero, The Core Writing Team
Ontology Class oeo:author
Badge Bronze
Card. [*]

Resource - sources (description)#
Key description
Description A free text description of the source.
Example A Report of the Intergovernmental Panel on Climate Change
Ontology Class dct:description
Badge Bronze
Card. [0..1]

Resource - sources (publicationYear)#
Key publicationYear
Description Indicates the year when the work was published.
Example 2023
Ontology Class dct:issued
Badge Bronze
Card. [0..1]

Resource - sources (path)#
Key path
Description A DOI or link to the original source.
Example IPCC_AR6_SYR_FullVolume.pdf
Ontology Class sc:url
Badge Bronze
Card. [0..1]

Resource - sourceLicenses#
Key sourceLicenses
Description An array of objects of licenses under which the described source is provided. See academy/courses/08_licensing for further information.
Example
Ontology Class dct:license
Badge
Card. [*]

Resource - sourceLicenses (name)#
Key name
Description The SPDX identifier.
Example ODbL-1.0
Ontology Class rdfs:label
Badge Bronze
Card. [0..1]

Resource - sourceLicenses (title)#
Key title
Description The official (human-readable) title of the license.
Example Open Data Commons Open Database License 1.0
Ontology Class dct:title
Badge Bronze
Card. [0..1]

Resource - sourceLicenses (path)#
Key path
Description A link or path to the license text.
Example opendatacommons.org/licenses/odbl/1-0/index.html
Ontology Class sc:url
Badge Bronze
Card. [0..1]

Resource - sourceLicenses (instruction)#
Key instruction
Description A short description of rights and obligations. The use of tl;drLegal is recommended.
Example You are free to share and change, but you must attribute, and share derivations under the same license. See tldrlegal.com for further information.
Ontology Class rdfs:comment
Badge Bronze
Card. [0..1]

Resource - sourceLicenses (attribution)#
Key attribution
Description A copyright owner of the source. Must be provided if attribution licenses are used.
Example © Intergovernmental Panel on Climate Change 2023
Ontology Class ms:copyright notice
Badge Bronze
Card. [0..1]

Resource - sourceLicenses (copyrightStatement)#
Key copyrightStatement
Description A link or path that proves that the source or data has the appropriate license. This can be a page number or website imprint.
Example www.ipcc.ch/copyright
Ontology Class dct:rights
Badge Bronze
Card. [0..1]

Resource - licenses#
Key licenses
Description An array of objects of licenses under which the described data is provided.
Example
Ontology Class dct:license
Badge
Card. [*]

Resource - licenses (name)#
Key name
Description The SPDX identifier.
Example ODbL-1.0
Ontology Class rdfs:label
Badge Bronze
Card. [0..1]

Resource - licenses (title)#
Key title
Description The official (human-readable) title of the license.
Example Open Data Commons Open Database License 1.0
Ontology Class dct:title
Badge Bronze
Card. [0..1]

Resource - licenses (path)#
Key path
Description A link or path to the license text.
Example opendatacommons.org/licenses/odbl/1-0/index.html
Ontology Class dcat:accessURL
Badge Bronze
Card. [0..1]

Resource - licenses (instruction)#
Key instruction
Description A short description of rights and obligations. The use of tl;drLegal is recommended.
Example You are free to share and change, but you must attribute, and share derivations under the same license. See tldrlegal.com for further information.
Ontology Class dc:rights
Badge Bronze
Card. [0..1]

Resource - licenses (attribution)#
Key attribution
Description A copyright owner of the data. Must be provided if attribution licenses are used.
Example © Reiner Lemoine Institut
Ontology Class spdx:attributionText
Badge Bronze
Card. [0..1]

Resource - licenses (copyrightStatement)#
Key copyrightStatement
Description A link or path that proves that the data has the appropriate license. This can be a page number or website imprint.
Example www.ipcc.ch/copyright/
Ontology Class dct:rights
Badge Bronze
Card. [0..1]

Resource - Provenance Keys#
Key contributors
Description 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"
Example
Ontology Class foaf:Agent
Badge
Card. [*]

Resource - Provenance Keys (title)#
Key title
Description A full name of the contributor.
Example Ludwig Hülk
Ontology Class dct:title
Badge Bronze
Card. [0..1]

Resource - Provenance Keys (path)#
Key path
Description A qualified link or path pointing to a relevant location online for the contributor. This can be the GitHub page or ORCID.
Example https://github.com/Ludee
Ontology Class sc:url
Badge Bronze
Card. [0..1]

Resource - Provenance Keys (organization)#
Key organization
Description A string describing the organization this contributor is affiliated to. This can be relevant for the copyright.
Example Reiner Lemoine Institut
Ontology Class oeo:organisation
Badge Bronze
Card. [0..1]

Resource - Provenance Keys (roles)#
Key roles
Description An array describing the roles of the contributor. A role is recommended to follow the established vocabulary: DataCite Metadata Schema’s contributorRole.
Example DataCollector, DataCurator
Ontology Class oeo:role
Badge Bronze
Card. [*]

Resource - Provenance Keys (date)#
Key date
Description The date of the contribution. Date Format is ISO 8601.
Example 2024-10-21
Ontology Class dct:issued
Badge Bronze
Card. [0..1]

Resource - Provenance Keys (object)#
Key object
Description The target of the contribution. This can be the data, the metadata or both (data and metadata).
Example data and metadata
Ontology Class dct:type
Badge Bronze
Card. [0..1]

Resource - Provenance Keys (comment)#
Key comment
Description A free-text commentary on what has been done.
Example Add general context.
Ontology Class rdfs:comment
Badge Bronze
Card. [0..1]

Resource - Type Keys#

Key type
Description The 'table' type indicates that the resource is tabular as per 'Frictionless Tabular Data' definition.
Example table
Ontology Class csvw:datatype
Badge Gold
Card. [0..1]
Key format
Description A file extension format. Possible options are 'csv', 'xlsx', 'json', 'PostgreSQL', 'SQLite' and other standard file extensions.
Example PostgreSQL
Ontology Class dct:format
Badge Gold
Card. [0..1]
Key encoding
Description 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'.
Example UTF-8
Ontology Class csvw:encoding
Badge Gold
Card. [0..1]

Resource - Fields Keys#
Key schema
Description An object that describes the structure of a table. It contains all fields (columns of the table), the primary key and optional foreign keys.
Example
Ontology Class schema:table
Badge
Card. [1]

Resource - Fields Keys - fields#
Key fields
Description An array of objects that describes a field (column) and its detailed information.
Example
Ontology Class csvw:column
Badge
Card. [1]

Resource - Fields Keys - name#
Key name
Description 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.
Example year
Ontology Class rdfs:label
Badge Iron
Card. [1]

Resource - Fields Keys - description#
Key description
Description A text describing the field.
Example Reference year for which the data were collected.
Ontology Class dct:description
Badge Silver
Card. [0..1]

Resource - Fields Keys - type#
Key type
Description The data type of the field. In case of a geom column in a database, also indicate the shape and CRS.
Example geometry(Point, 4326)
Ontology Class csvw:datatype
Badge Iron
Card. [1]

Resource - Fields Keys - nullable#
Key nullable
Description A boolean key to specify that a column can be nullable. True is the default value.
Example True
Ontology Class ncit:null
Badge Iron
Card. [1]

Resource - Fields Keys - unit#
Key unit
Description 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).
Example MW
Ontology Class oeo:has unit
Badge Silver
Card. [0..1]

Resource - Fields Keys - isAbout#
Key isAbout
Description An array of objects that describes the field in ontology terms.
Example
Ontology Class sc:about
Badge
Card. [*]

Resource - Fields Keys - name (isAbout)#
Key name
Description The class label of the ontology term.
Example wind energy converting unit
Ontology Class rdfs:label
Badge Platinum
Card. [0..1]

Resource - Fields Keys - @id (isAbout)#
Key @id
Description The path of the ontology term (IRI).
Example OEO_00000044
Ontology Class dct:identifier
Badge Platinum
Card. [0..1]

Resource - Fields Keys - valueReference#
Key valueReference
Description An array of objects for an extended description of the values in the column in ontology terms.
Example
Ontology Class prov:value
Badge
Card. [*]

Resource - Fields Keys - value#
Key value
Description The name of the value in the column.
Example onshore
Ontology Class rdf:value
Badge Platinum
Card. [0..1]

Resource - Fields Keys - name (valueReference)#
Key name
Description The class label of the ontology term in the column.
Example onshore wind farm
Ontology Class rdfs:label
Badge Platinum
Card. [0..1]

Resource - Fields Keys - @id (valueReference)#
Key @id
Description The path of the ontology term (IRI) in the column.
Example OEO_00000311
Ontology Class dct:identifier
Badge Platinum
Card. [0..1]

Resource - Properties Keys#
Key primaryKey
Description An array of fields that uniquely identifies each row in the table. The default value is the “id” column.
Example id
Ontology Class csvw:primaryKey
Badge Iron
Card. [1..*]

Resource - Properties Keys - foreignKeys#
Key foreignKeys
Description An array of objects with foreign keys that describe a field that relates to a field in another table.
Example
Ontology Class csvw:foreignKey
Badge
Card. [*]

Resource - Properties Keys - fields (foreignKeys)#
Key fields
Description An array of fields in the table that is constrained by the foreign key.
Example id, version
Ontology Class ex:nestedFields
Badge Iron
Card. [*]

Resource - Properties Keys - reference#
Key reference
Description The reference to the foreign table.
Example
Ontology Class
Badge
Card. [0..1]

Resource - Properties Keys - resource (reference)#
Key resource
Description The referenced foreign table.
Example model_draft.oep_oemetadata_table_example_version
Ontology Class dcat:Dataset
Badge Iron
Card. [0..1]

Resource - Properties Keys - fields (reference)#
Key fields
Description The foreign resource column.
Example id, version
Ontology Class csvw:column
Badge Iron
Card. [*]

Resource - Properties Keys - dialect#
Key dialect
Description 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'.
Example
Ontology Class
Badge
Card. [1]

Resource - Properties Keys - delimiter#
Key delimiter
Description The delimiter specifies the character sequence which should separate fields (columns). Common characters are ',' (comma), ';' (semicolon), '.' (point) and '\t' (tab).
Example ,
Ontology Class csvw:delimiter
Badge Iron
Card. [1]

Resource - Properties Keys - decimalSeparator#
Key decimalSeparator
Description 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 ','.
Example .
Ontology Class csvw:decimalChar
Badge Iron
Card. [1]

Resource - Review Keys#
Key review
Description The metadata on the OEP can go through an open peer review process. See the Academy course Open Peer Review for further information.
Example
Ontology Class
Badge [0..1]

Resource - Review Keys - path#
Key path
Description A link or path to the documented open peer review.
Example open_peer_review/9
Ontology Class sc:url
Badge [0..1]

Resource - Review Keys - badge#
Key badge
Description A badge of either Iron, Bronze, Silver, Gold or Platinum is used to label the quality of the metadata.
Example Platinum
Ontology Class oeo:quality control flag
Badge [0..1]

MetaMetadata Keys#
Key metaMetadata
Description An object that describes the metadata themselves, their format, version and license.
Example
Ontology Class
Card. [1]

MetaMetadata Keys - metadataVersion#
Key metadataVersion
Description Type and version number of the metadata.
Example OEMetadata-2.0
Ontology Class owl:versionInfo
Card. [1]

MetaMetadata Keys - metadataLicense#
Key metadataLicense
Description The license of the provided metadata.
Example
Ontology Class dct:license
Card. [1]

MetaMetadata Keys - metadataLicense - name#
Key name
Description The SPDX identifier.
Example CC0-1.0
Ontology Class rdfs:label
Card. [1]

MetaMetadata Keys - metadataLicense - title#
Key title
Description The official (human-readable) title of the license.
Example Creative Commons Zero v1.0 Universal
Ontology Class dct:title
Card. [1]

MetaMetadata Keys - metadataLicense - path#
Key path
Description A link or path to the license text.
Example creativecommons.org/publicdomain/zero/1.0/
Ontology Class sc:url
Card. [1]