diff --git a/standard/abstract_tests/ATS_class_core.adoc b/standard/abstract_tests/ATS_class_core.adoc new file mode 100644 index 0000000..97dc4e1 --- /dev/null +++ b/standard/abstract_tests/ATS_class_core.adoc @@ -0,0 +1,7 @@ +[[ats_core]] +==== +[%metadata] +label:: http://www.wmo.int/spec/wth/1/conf/core +subject:: Requirements Class "core" +classification:: Target Type:Topic Classification +==== diff --git a/standard/clause_main.adoc b/standard/clause_main.adoc deleted file mode 100644 index 62b321a..0000000 --- a/standard/clause_main.adoc +++ /dev/null @@ -1,185 +0,0 @@ -== Overview - -=== Purpose - -This document is intended to define the topic structure in support of WIS data notifications exchange, -discovery, and access. - -The core driver of WTH is data discovery and filtering as part of the WMO Information System (WIS).footnote:[https://community.wmo.int/activity-areas/wmo-information-system-wis] - -=== Scope - -This document defines the topic-hierarchy used by WIS message brokers to manage message delivery to the respective group of recipients. -All other topic structure specifications are not in scope. - -=== Audience - -The target stakeholder audiences for this document include (but are not limited to): - -* Metadata providers (NCs, DCPCs) -* WIS Global Services (Global Discovery Catalogues (GDCs), Global Brokers (GB), Global Caches (GC), Global Monitoring (GM)) -* WIS Nodes -* GAW World Data Centres (WDCs) -* Metadata implementors (generation, ingest) - -== Terms and definitions - -The following terms and definitions also apply. - -=== Abbreviated terms - -.Symbols and abbreviated terms -|=== -|Abbreviation |Term - -|API -|Application Programming Interface - -|DCPC -|Data Collection and Production Centres - -|GDC -|Global Discovery Catalogue - -|GIS -|Geographic Information System - -|GISC -|Global Information System Centre - -|HTML -|Hypertext Markup Language - -|HTTP -|Hypertext Transfer Protocol - -|HTTPS -|Hypertext Transfer Protocol Secure - -|IANA -|Internet Assigned Numbers Authority - -|IETF -|Internet Engineering Task Force - -|ISO -|International Organization for Standardization - -|JSON -|JavaScript Object Notation - -|MQP -|Message queuing protocol - -|MQTT -|Message Queuing Telemetry Transport - -|NC -|National Centre - -|NWP -|Numerical Weather Prediction - -|OGC -|Open Geospatial Consortium - -|REST -|Representational State Transfer - -|TT-WISMD -|Task Team on WIS Metadata - -|URI -|Uniform Resource Identifier - -|URL -|Uniform Resource Locator - -|W3C -|World Wide Web Consortium - -|WCMP -|WMO Core Metadata Profile - -|WIS -|WMO Information System - -|WMO -|World Meteorological Organization - -|WTH -|WIS Topic Hierarchy -|=== - -== Conventions - -=== Publication - -The WTH can be found at TODO (URL to deployment) - -== The WIS Topic Hierarchy - -The WIS Topic Hierarchy (WTH) provides a structure used by data providers and WIS Global Services in support of core WIS workflows: publish, discover, subscribe and download. - -=== Real-time data sharing - -WIS real-time data sharing is based on a message queuing protocol (MQP) supporting a publication/subscription mechanism. A user can subscribe to an MQP broker to receive real-time notifications. The notifications can be sent for new or updated data, metadata, or reports. The notification message received from the MQP broker contains a URL to download the data. The MQP broker offers a range of topics organised in a hierarchy. The users can select their topics of interest and subscribe to them to receive notifications and download data relevant to their work. - -=== Data discovery - -Users can discover datasets from the Global Discovery Catalogue (GDC). Once a user has identified a dataset of interest, they may subscribe to data notifications and updates using the topic and MQP broker found from the GDC dataset discovery metadata. Datasets in the GDC are made available via the WMO Core Metadata Profile 2 (WCMP2) standard for discovery metadata, which supports a categorisation scheme consistent with the topic hierarchy to provide a seamless search experience compatible with the access modality provided by the MQP broker. In other words, the MQP topic and WIS discovery metadata have the same vocabulary so that discovery, subscription, and download are consistent. - -=== Structure - -The structure of the topic hierarchy underpins the discovery and sharing of data in WIS, and it has to be standardized across all the WIS services to provide consistent search and access to the user. - -Recalling that WIS is designed to support the WMO Unified Data Policy, the topic hierarchy must be aligned with WMO Res. 1 Cg-EXT-21 - Unified Data Policy.:footnote:[https://ane4bf-datap1.s3-eu-west-1.amazonaws.com/wmocms/s3fs-public/ckeditor/files/Cg-Ext2021-d04-1-WMO-UNIFIED-POLICY-FOR-THE-INTERNATIONAL-approved_en_0.pdf?4pv38FtU6R4fDNtwqOxjBCndLIfntWeR] - -The WIS Topic Hierarchy has been developed according to the classification of the Earth System domains in Annex 1 of Resolution 1 Cg-Ext(2021), and it is managed in two parts: - -1. Primary topic levels (levels 1-8): topic structure applies to all data and services in WIS and is managed by the WMO Secretariat -2. Domain-specific topic subcategory levels (level 9 and beyond): topic structure proposed by domain experts and user communities. Note that the number of levels in this part may vary according to the requirements of various domains. - -== Management - -The WTH is managed by the WMO Task Team on WIS Metadata. Updates to the WTH are made as part of two workflows: core levels, and domain specific levels. - -=== Responsibility - -==== Core levels - -WTH core levels (1-8) are managed by the WMO Task Team on WIS Metadata. - -==== Domain specific levels - -WTH domain specific levels (level 9 and beyond) are determined by various teams familiar with the given domain. - -=== Managing updates - -==== Domain specific levels - -WTH domain specific levels are updated using the following steps: - -- domain specific teams submit proposals to TT-WISMD -- TT-WISMD performs a review of the proposal and curates the content for consistency. Discussion and clarifications on the proposal are performed as required -- once consensus is reached, TT-WISMD approves the proposal for inclusion into the next release of WTH -- Final approval of the WTH updates will go through the WMO fast-track amendment process.footnote:[https://community.wmo.int/en/activity-areas/wis/amendment-processes-wis-manuals-and-guides] - -=== Versioning - -TODO - -== Reference implementation - -The TT-WISMD maintains pywcmpfootnote:[https://github.com/wmo-im/pywcmp], as the -reference WTH validation utility which includes: - -* validation of topics against this specification -* browsing topics at a given level - -Documentation on installation, configuration and usage can be found on the -pywcmp website. - -pywcmp is provided as a resource to the community, under continuous -improvement. Contributions are welcome and can be facilited by the -WMO Task Team on WIS Metadata. diff --git a/standard/index.adoc b/standard/index.adoc index 8580467..b7beaf2 100644 --- a/standard/index.adoc +++ b/standard/index.adoc @@ -34,4 +34,26 @@ toc::[] <<< -include::clause_main.adoc[] +include::sections/clause_0_front_material.adoc[] + +include::sections/clause_1_scope.adoc[] + +include::sections/clause_2_conformance.adoc[] + +include::sections/clause_3_references.adoc[] + +include::sections/clause_4_terms_and_definitions.adoc[] + +include::sections/clause_5_conventions.adoc[] + +include::sections/clause_6_informative_text.adoc[] + +include::sections/clause_7_normative_text.adoc[] + +include::sections/annex_a_ats.adoc[] + +include::sections/annex_b_examples.adoc[] + +include::sections/annex_c_bibliography.adoc[] + +include::sections/annex_d_revision_history.adoc[] diff --git a/standard/requirements/core/REQ_conventions.adoc b/standard/requirements/core/REQ_conventions.adoc new file mode 100644 index 0000000..fd58629 --- /dev/null +++ b/standard/requirements/core/REQ_conventions.adoc @@ -0,0 +1,11 @@ +[[req_core_conventions]] +[width="90%",cols="2,6a"] +|=== +^|*Requirement {counter:req-id}* |*/req/core/conventions* +^|A |All topic level definitions SHALL be lowercase. +^|B |All topic level definitions SHALL following ASCII T.50. +^|C |All topic level definitions SHALL NOT utilize dots (``.``). +^|D |All topic level definitions SHALL utilize dashes (``-``). +^|E |All topic level definitions at a given level SHALL be unique. +^|F |The topic structure levels imply a fixed sequence and SHALL NOT be re-ordered. +|=== diff --git a/standard/requirements/core/REQ_management.adoc b/standard/requirements/core/REQ_management.adoc new file mode 100644 index 0000000..c1cbb37 --- /dev/null +++ b/standard/requirements/core/REQ_management.adoc @@ -0,0 +1,18 @@ +[[req_core_management]] +[width="90%",cols="2,6a"] +|=== +^|*Requirement {counter:req-id}* |*/req/core/management* +^|A |Primary levels 1-8 SHALL be determined by the WMO Task Team on WIS Metadata. +^|B |Domain specific levels (level 9 and beyond) SHALL be determined by domain experts and user communities. +^|C |Domain specific levels (level 9 and beyond) SHALL be coordinated and integrated by the WMO Task Team on WIS Metadata. +^|D +a|Domain specific level updates SHALL be implemented using the following steps: + +- domain specific teams submit proposals to TT-WISMD + +- TT-WISMD performs a review of the proposal and curates the content for consistency. Discussion and clarifications on the proposal are performed as required + +- once consensus is reached, TT-WISMD approves the proposal for inclusion into the next release of WTH + +- Final approval of the WTH updates will go through the WMO fast-track amendment process.footnote:[https://community.wmo.int/en/activity-areas/wis/amendment-processes-wis-manuals-and-guides] +|=== diff --git a/standard/requirements/core/REQ_publishing.adoc b/standard/requirements/core/REQ_publishing.adoc new file mode 100644 index 0000000..53e2440 --- /dev/null +++ b/standard/requirements/core/REQ_publishing.adoc @@ -0,0 +1,8 @@ +[[req_core_publishing]] +[width="90%",cols="2,6a"] +|=== +^|*Requirement {counter:req-id}* |*/req/core/publishing* +^|A |Data SHALL be published to at least the level of the Earth system discipline subcategory. +^|B |Metadata SHALL be published to at least the level of the notification type (``metadata``). +^|C |Reports SHALL be published to at least the level of the notification type (``reports``). +|=== diff --git a/standard/requirements/core/REQ_versioning.adoc b/standard/requirements/core/REQ_versioning.adoc new file mode 100644 index 0000000..3948b46 --- /dev/null +++ b/standard/requirements/core/REQ_versioning.adoc @@ -0,0 +1,11 @@ +[[req_core_versioning]] +[width="90%",cols="2,6a"] +|=== +^|*Requirement {counter:req-id}* |*/req/core/versioning* +^|A |A removal of a topic at any level SHALL result in a major version update. +^|B |A renaming of a topic at any level SHALL result in a major version update. +^|C |A change in structure of the topic hierarchy SHALL result in a major version update. +^|D |A new topic SHALL NOT result in any version update. +^|E |A major version SHALL result in a change / bump to the version level (i.e. ``a`` -> ``b``). +^|F |A minor version SHALL NOT result in any changes to the version level. +|=== diff --git a/standard/requirements/requirements_class_core.adoc b/standard/requirements/requirements_class_core.adoc new file mode 100644 index 0000000..fcd8f62 --- /dev/null +++ b/standard/requirements/requirements_class_core.adoc @@ -0,0 +1,11 @@ +[[rc_core]] +[cols="1,4",width="90%"] +|=== +2+|*Requirements Class* +2+|http://www.wmo.int/spec/wth/1/req/core +|Target type |Topic Classification +|Dependency |<> +|Dependency |<> +|Pre-conditions | +Topics conform to Topic Name requirements of MQTT +|=== diff --git a/standard/sections/annex_a_ats.adoc b/standard/sections/annex_a_ats.adoc new file mode 100644 index 0000000..6a28fda --- /dev/null +++ b/standard/sections/annex_a_ats.adoc @@ -0,0 +1,8 @@ +[appendix] +:appendix-caption: Annex +== Conformance Class Abstract Test Suite (Normative) + +=== Conformance Class: Core + +include::../abstract_tests/ATS_class_core.adoc[] + diff --git a/standard/sections/annex_b_examples.adoc b/standard/sections/annex_b_examples.adoc new file mode 100644 index 0000000..d5ce049 --- /dev/null +++ b/standard/sections/annex_b_examples.adoc @@ -0,0 +1,18 @@ +[[examples]] +[appendix] +:appendix-caption: Annex +== Examples (Informative) + +=== WIS2 Topic Hierarchy + +.Example: WIS Node data publishing (surface weather observations) from Environment and Climate Change Canada, Meteorological Service of Canada +[source,text] +---- +origin/a/wis2/can/eccc-msc/data/core/weather/surface-based-observations/synop +---- + +.Example: WIS Node metadata publishing from Deutscher Wetterdienst +[source,text] +---- +cache/a/wis2/deu/dwd/metadata/core/wcmp2 +---- diff --git a/standard/sections/annex_c_bibliography.adoc b/standard/sections/annex_c_bibliography.adoc new file mode 100644 index 0000000..22324c4 --- /dev/null +++ b/standard/sections/annex_c_bibliography.adoc @@ -0,0 +1,9 @@ +[appendix] +:appendix-caption: Annex +[[Bibliography]] += Bibliography + +* [[OASIS-mqtt5]] OASIS: MQTT Version 5.0 (2019) footnote:[https://docs.oasis-open.org/mqtt/mqtt/v5.0/mqtt-v5.0.html] +* [[OASIS-mqtt311]] OASIS: MQTT Version 3.1.1 (2014) footnote:[http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html] +* [[Wikipedia-PubSub]] Wikipedia: Publish-subscribe pattern (2023) footnote:[https://en.wikipedia.org/wiki/Publish%E2%80%93subscribe_pattern] +* [[ITU-T50]] International Telecommunications Union (ITU): T.50 : International Reference Alphabet (IRA) (Formerly International Alphabet No. 5 or IA5) - Information technology - 7-bit coded character set for information interchange footnote:[https://www.itu.int/rec/T-REC-T.50] diff --git a/standard/sections/annex_d_revision_history.adoc b/standard/sections/annex_d_revision_history.adoc new file mode 100644 index 0000000..530bdaf --- /dev/null +++ b/standard/sections/annex_d_revision_history.adoc @@ -0,0 +1,9 @@ +[appendix] +:appendix-caption: Annex +== Revision History + +[cols="12,18,12,12,46",options="header"] +|=== +|Date |Release |Editor | Primary clauses modified |Description +|2023-09-25 | Template | Tom Kralidis |all | initial revision +|=== diff --git a/standard/sections/clause_0_front_material.adoc b/standard/sections/clause_0_front_material.adoc new file mode 100644 index 0000000..13934a8 --- /dev/null +++ b/standard/sections/clause_0_front_material.adoc @@ -0,0 +1,25 @@ +[big]*i. Abstract* + +WIS2 real-time data sharing is based on a message queuing protocol (MQP) supporting a +publication/subscription (PubSub) mechanism. A user can subscribe to an MQP broker to receive +real-time notifications of the existence of new data. + +WIS2 brokers offer a range of topics organised in a hierarchy. Users can select their topics of interest and +subscribe to them to receive notifications and download data relevant to their work. + +The standard notification message format ensures that the WIS2 ecosystem (data publisher, data +user, and global services) is a robust, effective, and unified exchange platform for weather, +climate, and water data. + +This document defines the structure of the WIS Topic Hierarchy. Topics are utilized by WIS Nodes, Global +Broker services, and data/metadata subscribers. + +The following are keywords to be used by search engines and document catalogues. + +wmo, wis 2.0, weather, climate, water, topic hierarchy, metadata, pubsub, mqp, message queuing protocol + +[big]*iii. Security Considerations* + +Based on the WMO Unified Data Policy for the International Exchange of Earth System Data (Resolution 1 (Cg-Ext(2021) footnote:[https://library.wmo.int/doc_num.php?explnum_id=11113#page=9], exchanged data are classified as `+core+` or `+recommended+`. Core data is considered fully open and unrestricted with no security considerations. Recommended data may have access control defined. + +No security considerations have been made for this standard. diff --git a/standard/sections/clause_1_scope.adoc b/standard/sections/clause_1_scope.adoc new file mode 100644 index 0000000..575c0f1 --- /dev/null +++ b/standard/sections/clause_1_scope.adoc @@ -0,0 +1,7 @@ +== Scope + +This document defines the topic hierarchy used by WIS message brokers to manage message delivery to subscribers and / or recipients. + +This specification defines the conformance requirements for the WIS2 Topic Hierarchy. Annex A defines the abstract test suite. + +All other topic structure specifications are not in scope. diff --git a/standard/sections/clause_2_conformance.adoc b/standard/sections/clause_2_conformance.adoc new file mode 100644 index 0000000..fc4c004 --- /dev/null +++ b/standard/sections/clause_2_conformance.adoc @@ -0,0 +1,14 @@ +== Conformance + +Conformance with this standard shall be checked using the tests specified in Annex A (normative) of this document. + +WIS Global Brokers and Nodes are required to comply with all conformance classes of this specification in support +of providing MQP services in alignment with the defined topic structure. + +WMO shall publish guidance material to assist WIS Global Brokers and Nodes in constructing valid topic structures. + +This standard identifies one Conformance Class which defines the functional requirements. + +The mandatory Conformance Class for this specification is: + +* "WIS2 Topic Hierarchy Core" diff --git a/standard/sections/clause_3_references.adoc b/standard/sections/clause_3_references.adoc new file mode 100644 index 0000000..a97802b --- /dev/null +++ b/standard/sections/clause_3_references.adoc @@ -0,0 +1,6 @@ +== References + +* OASIS: MQTT Version 5.0 (2019) footnote:[https://docs.oasis-open.org/mqtt/mqtt/v5.0/mqtt-v5.0.html] +* OASIS: MQTT Version 3.1.1 (2014) footnote:[http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html] +* Wikipedia: Publish-subscribe pattern (2023) footnote:[https://en.wikipedia.org/wiki/Publish%E2%80%93subscribe_pattern] +* International Telecommunications Union (ITU): T.50 : International Reference Alphabet (IRA) (Formerly International Alphabet No. 5 or IA5) - Information technology - 7-bit coded character set for information interchange footnote:[https://www.itu.int/rec/T-REC-T.50] diff --git a/standard/sections/clause_4_terms_and_definitions.adoc b/standard/sections/clause_4_terms_and_definitions.adoc new file mode 100644 index 0000000..0d7c15a --- /dev/null +++ b/standard/sections/clause_4_terms_and_definitions.adoc @@ -0,0 +1,71 @@ +== Terms and definitions + +This document uses the terms defined in https://portal.ogc.org/public_ogc/directives/directives.php[OGC Policy Directive 49], which is based on the ISO/IEC Directives, Part 2, Rules for the structure and drafting of International Standards. In particular, the word “shall” (not “must”) is the verb form used to indicate a requirement to be strictly followed to conform to this Standard and OGC documents do not use the equivalent phrases in the ISO/IEC Directives, Part 2. + +This document also uses terms defined in the OGC Standard for Modular specifications (https://portal.opengeospatial.org/files/?artifact_id=34762[OGC 08-131r3]), also known as the 'ModSpec'. The definitions of terms such as standard, specification, requirement, and conformance test are provided in the ModSpec. + +The following additional terms and definitions also apply. + +=== Abbreviated terms + +.Symbols and abbreviated terms +|=== +|Abbreviation |Term + +|DCPC +|Data Collection and Production Centres + +|GISC +|Global Information System Centre + +|HTTP +|Hypertext Transfer Protocol + +|HTTPS +|Hypertext Transfer Protocol Secure + +|IANA +|Internet Assigned Numbers Authority + +|IETF +|Internet Engineering Task Force + +|ISO +|International Organization for Standardization + +|MQP +|Message Queuing Protocol + +|MQTT +|Message Queuing Telemetry Transport + +|NC +|National Centre + +|OGC +|Open Geospatial Consortium + +|PubSub +|Publish / Subscribe + +|URI +|Uniform Resource Identifier + +|URL +|Uniform Resource Locator + +|W3C +|World Wide Web Consortium + +|WCMP +|WMO Core Metadata Profile + +|WIS +|WMO Information System + +|WMO +|World Meteorological Organization + +|WNM +|WIS2 notification message +|=== diff --git a/standard/sections/clause_5_conventions.adoc b/standard/sections/clause_5_conventions.adoc new file mode 100644 index 0000000..2a4a7aa --- /dev/null +++ b/standard/sections/clause_5_conventions.adoc @@ -0,0 +1,19 @@ +== Conventions +This section provides details and examples for any conventions used in the document. Examples of conventions are symbols, abbreviations, or special notes regarding how to read the document. + +=== Identifiers +The normative provisions in this Standard are denoted by the URI: + +http://wis.wmo.int/spec/wth/1 + +All requirements and conformance tests that appear in this document are denoted by partial URIs which are relative to this base. + +=== Examples + +Examples provided in this specification are encoded as ``plain text strings``. + +=== Codelists bundle + +The WIS2 Topic Hierarchy Notification codelist bundle can be found at https://schemas.wmo.int/wth/1.0/wth.zip. This bundle can be used by tools and applications wishing to browse or validate topic structures. + +A browseable codelist can be found at https://codes.wmo.int/wth diff --git a/standard/sections/clause_6_informative_text.adoc b/standard/sections/clause_6_informative_text.adoc new file mode 100644 index 0000000..dec5adc --- /dev/null +++ b/standard/sections/clause_6_informative_text.adoc @@ -0,0 +1,21 @@ +== Introduction + +=== The WIS Topic Hierarchy + +The WIS Topic Hierarchy (WTH) provides a structure used by data providers and WIS Global Services in support of core WIS workflows: publish, discover, subscribe and download. + +=== Real-time data sharing + +WIS real-time data sharing is based on a message queuing protocol (MQP) supporting a publication/subscription mechanism. A user can subscribe to an MQP broker to receive real-time notifications. The notifications can be sent for new or updated data, metadata, or reports. The notification message received from the MQP broker contains a URL to download the data. The MQP broker offers a range of topics organised in a hierarchy. The users can select their topics of interest and subscribe to them to receive notifications and download data relevant to their work. + +=== Data discovery + +Users can discover datasets from the Global Discovery Catalogue (GDC). Once a user has identified a dataset of interest, they may subscribe to data notifications and updates using the topic and MQP broker found from the GDC dataset discovery metadata. Datasets in the GDC are made available via the WMO Core Metadata Profile 2 (WCMP2) standard for discovery metadata, which supports a categorisation scheme consistent with the topic hierarchy to provide a seamless search experience compatible with the access modality provided by the MQP broker. In other words, the MQP topic and WIS discovery metadata have the same vocabulary so that discovery, subscription, and download are consistent. + +=== Structure + +The structure of the topic hierarchy underpins the discovery and sharing of data in WIS, and requires standardization across all WIS services to provide consistent filter and access to the user. + +Recalling that WIS is designed to support the WMO Unified Data Policy, the topic hierarchy must be aligned with WMO Res. 1 Cg-EXT-21 - Unified Data Policy.:footnote:[https://ane4bf-datap1.s3-eu-west-1.amazonaws.com/wmocms/s3fs-public/ckeditor/files/Cg-Ext2021-d04-1-WMO-UNIFIED-POLICY-FOR-THE-INTERNATIONAL-approved_en_0.pdf?4pv38FtU6R4fDNtwqOxjBCndLIfntWeR] + +Final approval of the WTH updates will go through the WMO fast-track amendment process.footnote:[https://community.wmo.int/en/activity-areas/wis/amendment-processes-wis-manuals-and-guides] diff --git a/standard/sections/clause_7_normative_text.adoc b/standard/sections/clause_7_normative_text.adoc new file mode 100644 index 0000000..5f6df09 --- /dev/null +++ b/standard/sections/clause_7_normative_text.adoc @@ -0,0 +1,42 @@ +== The WIS2 Topic Hierarchy + +The WIS Topic Hierarchy (WTH) provides a structure used by data providers and WIS Global Services in support of core WIS workflows: publish, discover, subscribe and download. + +=== Conformance Class Core + +==== Overview + +This Core Conformance Class provides requirements to articulate the required elements of the definition and management of the WIS2 Topic Hierarchy. + +include::../requirements/requirements_class_core.adoc[] + +The standard topic structure ensures that the WIS2 ecosystem (data publisher, data user, and global services) is a robust, effective, and unified data exchange platform for weather, climate, and water. + +==== Management + +The WTH is managed by the WMO Task Team on WIS Metadata. Updates to the WTH are made as part of two workflows: core levels, and domain specific levels. + +The WIS Topic Hierarchy has been developed according to the classification of the Earth System domains in Annex 1 of Resolution 1 Cg-Ext(2021), and it is managed in two parts: + +1. Primary topic levels (levels 1-8): topic structure applies to all data and services in WIS +2. Domain specific topic subcategory levels (level 9 and beyond): topic structure proposed by domain experts and user communities. Note that the number of levels in this part may vary according to the requirements of various domains. + +include::../requirements/core/REQ_management.adoc[] + +==== Versioning + +The topic hierarchy version helps data providers and data consumers with change management and transition in relation to updates. + +include::../requirements/core/REQ_versioning.adoc[] + +==== Conventions + +All levels of the topic hierarchy are defined in a consistent manner to support a normalized and predictable structure. + +include::../requirements/core/REQ_conventions.adoc[] + +==== Publishing guidelines + +For maximum utility and efficient management of topics, data, metadata, and reports need to be published to a minimum level. This helps with avoiding "pollution" of messages in higher level topics which are used to delineate core concepts (centre identification, notification types, data policy, etc.). + +include::../requirements/core/REQ_publishing.adoc[] diff --git a/topic-hierarchy.csv b/topic-hierarchy.csv index 3b75d8a..02a6519 100644 --- a/topic-hierarchy.csv +++ b/topic-hierarchy.csv @@ -4,7 +4,7 @@ Level,Name,Description 3,system,Fixed value of wis2 for WIS2 4,country,Lower case representation of ISO3166 3-letter code. Includes extensions for partner organizations 5,centre-id,Acronym as specified by member and endorsed by the PR of the country and by WMO -6,notification-type,"WIS2 resources types (data, metadata, reports [from monitoring activities])" +6,notification-type,"WIS2 notification types (data, metadata, reports [from monitoring activities])" 7,data-policy,Data policy as defined by the WMO Unified Data Policy. core data are available from the Global Caches with open access on a free and unrestricted basis. Notifications for core and recommended data are available by subscription to Global Brokers. recommended data are downloaded from the original NC/DCPC and may require authentication/authorisation 8,earth-system-discipline,As per Annex 1 of resolution 1 Cg-Ext-2021 9,earth-system-discipline-subcategory,As proposed by domain experts and further approved by INFCOM