merge country and centre-id (#58) (#64)

* merge country and centre-id (#58) * update existing centre ids * Update topic-hierarchy.csv * update annex examples
wmo-im · Nov 12, 2023 · 86a7456 · 86a7456
1 parent 6cc0bee
commit 86a7456
Show file tree

Hide file tree

Showing 18 changed files with 123 additions and 279 deletions.
diff --git a/standard/abstract_tests/ATS_class_core.adoc b/standard/abstract_tests/ATS_class_core.adoc
@@ -5,3 +5,23 @@ label:: http://www.wmo.int/spec/wth/1/conf/core
 subject:: Requirements Class "core"
 classification:: Target Type:Topic Classification
 ====
+
+==== Management
+
+This requirement is not applicable to ATS testing.
+
+==== Versioning
+
+This requirement is not applicable to ATS testing.
+
+==== Conventions
+
+include::./core/ATS_test_conventions.adoc[]
+
+==== Centre identification
+
+include::./core/ATS_test_centre-id.adoc[]
+
+==== Publishing guidelines
+
+This requirement is not applicable to ATS testing.
diff --git a/standard/abstract_tests/core/ATS_test_centre-id.adoc b/standard/abstract_tests/core/ATS_test_centre-id.adoc
@@ -0,0 +1,16 @@
+[[ats_core_centre-id]]
+====
+[%metadata]
+label:: /conf/core/centre-id
+subject:: /req/core/centre-id
+test-purpose:: Validate that a centre identifier is valid.
+
+[.component,class=test method]
+=====
+[.component,class=step]
+--
+Check that the first component of the centre identifier is a valid TLD as defined by IANAfootnote:[https://data.iana.org/TLD].
+--
+
+=====
+====
diff --git a/standard/abstract_tests/core/ATS_test_conventions.adoc b/standard/abstract_tests/core/ATS_test_conventions.adoc
@@ -0,0 +1,24 @@
+[[ats_core_conventions]]
+====
+[%metadata]
+label:: /conf/core/conventions
+subject:: /req/core/conventions
+test-purpose:: Validate that a given topic meets the conventions of WTH.
+
+[.component,class=test method]
+=====
+[.component,class=step]
+--
+Check that all characters in the topic are lowercase.
+--
+
+--
+Check that all characters in the topic are based on ASCII T.50.
+--
+
+--
+Check that no characters in the topic contain dots (``.``).
+--
+
+=====
+====
diff --git a/standard/recommendations/core/PER_centre-id.adoc b/standard/recommendations/core/PER_centre-id.adoc
@@ -0,0 +1,8 @@
+[[per_core_centre-id]]
+[width="90%",cols="2,6a"]
+|===
+^|*Permission {counter:req-id}* |*/per/core/centre-id*
+^|A |A centre identifier's ``centre-name`` component MAY contain dashes.
+^|B |Larger organizations providing multiple centres MAY use dashes in the ``centre-name`` component to further delineate a centre function (e.g. ``int-org1-nwp``, ``int-org1-ozone``).
+^|C |A centre providing a WIS service MAY further qualify the function within the ``centre-name`` component (e.g. ``int-org1-global-cache``).
+|===
diff --git a/standard/recommendations/core/REC_centre-id.adoc b/standard/recommendations/core/REC_centre-id.adoc
@@ -0,0 +1,8 @@
+[[rec_core_centre-id]]
+[width="90%",cols="2,6a"]
+|===
+^|*Recommendation {counter:req-id}* |*/rec/core/centre-id*
+^|A |Organizations operating with a ``gov`` or similar TLD SHOULD use the TLD based on their country to define the TLD component of their centre identifier.
+^|B |International organizations operating with a ``int``, ``org`` or similar TLD SHOULD reuse these to define the TLD component of their centre identifier.
+^|C |Organizations wishing to test their WIS2 Node or Global Service MAY provide the ``-test`` suffix to their centre identifier (e.g. ``int-org1-test``).
+|===
diff --git a/standard/requirements/core/REQ_centre-id.adoc b/standard/requirements/core/REQ_centre-id.adoc
@@ -0,0 +1,12 @@
+[[req_core_centre-id]]
+[width="90%",cols="2,6a"]
+|===
+^|*Requirement {counter:req-id}* |*/req/core/centre-id*
+^|A
+a|A centre identifier SHALL be formatted as ``tld-centre-name``, where:
+
+- `tld` is based on a TLD as defined by IANAfootnote:[https://data.iana.org/TLD]
+- `centre-name` is based on a centre name as defined by the member
+^|B | The `test` TLD SHALL be used only for WIS internal system testing purposes.
+
+|===
diff --git a/standard/requirements/core/REQ_conventions.adoc b/standard/requirements/core/REQ_conventions.adoc
@@ -5,7 +5,7 @@
 ^|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 (``-``).
+^|D |All topic level definitions SHALL utilize dashes (``-``) to separate words (e.g. ``sea-ice``).
 ^|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
@@ -3,8 +3,8 @@
 |===
 ^|*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.
+^|B |Domain specific levels (level 8 and beyond) SHALL be determined by domain experts and user communities.
+^|C |Domain specific levels (level 8 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:
 

diff --git a/standard/requirements/core/REQ_versioning.adoc b/standard/requirements/core/REQ_versioning.adoc
@@ -8,5 +8,5 @@
 ^|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.
-^|G |A renaming or removal in the WMO Notification Message Format SHALL result in a major version update.
+^|G |A renaming or removal in the WMO Notification Message encoding SHALL result in a major version update.
 |===
diff --git a/standard/sections/annex_b_examples.adoc b/standard/sections/annex_b_examples.adoc
@@ -8,11 +8,11 @@
 .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
+origin/a/wis2/ca-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
+cache/a/wis2/de-dwd/metadata/core/wcmp2
 ----
diff --git a/standard/sections/clause_3_references.adoc b/standard/sections/clause_3_references.adoc
@@ -4,3 +4,4 @@
 * 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]
+* IANA: Root Zone Database (2023) footnote:[https://www.iana.org/domains/root/db]
diff --git a/standard/sections/clause_4_terms_and_definitions.adoc b/standard/sections/clause_4_terms_and_definitions.adoc
@@ -48,6 +48,12 @@ The following additional terms and definitions also apply.
 |PubSub
 |Publish / Subscribe
 
+|PR
+|Permanent Representative
+
+|TLD
+|Top-level domain
+
 |URI
 |Uniform Resource Identifier
 

diff --git a/standard/sections/clause_6_informative_text.adoc b/standard/sections/clause_6_informative_text.adoc
@@ -16,6 +16,6 @@ Users can discover datasets from the Global Discovery Catalogue (GDC). Once a us
 
 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]
+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 Policyfootnote:[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
@@ -18,8 +18,8 @@ The WTH is managed by the WMO Task Team on WIS Metadata. Updates to the WTH are
 
 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.
+1. Primary topic levels (levels 1-7): topic structure applies to all data and services in WIS
+2. Domain specific topic subcategory levels (level 8 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[]
 
@@ -35,6 +35,14 @@ All levels of the topic hierarchy are defined in a consistent manner to support
 
 include::../requirements/core/REQ_conventions.adoc[]
 
+==== Centre identification
+
+The centre identifier (``centre-id``) is an acronym as specified by the member and endorsed by the PR of the country and WMO.  It is a single identifier comprised of a TLD and centre name, and represents the data publisher, distributor or issuing centre of a given dataset or data product/granule.
+
+include::../requirements/core/REQ_centre-id.adoc[]
+include::../recommendations/core/REC_centre-id.adoc[]
+include::../recommendations/core/PER_centre-id.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.).

diff --git a/topic-hierarchy.csv b/topic-hierarchy.csv
@@ -2,9 +2,8 @@ Level,Name,Description
 1,channel,Location of where the data originates from (data providers [origin] or global services [cache])
 2,version,Alphabetical version of the topic hierarchy
 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 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
+4,centre-id,Acronym as specified by member and endorsed by the PR of the country and WMO
+5,notification-type,"WIS2 notification types (data, metadata, reports [from monitoring activities])"
+6,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
+7,earth-system-discipline,As per Annex 1 of resolution 1 Cg-Ext-2021
+8,earth-system-discipline-subcategory,As proposed by domain experts and further approved by INFCOM
diff --git a/topic-hierarchy/centre-id.csv b/topic-hierarchy/centre-id.csv
@@ -1,7 +1,6 @@
 Name,Description,Child
-eccc-msc,"Environment and Climate Change Canada, Meteorological Service of Canada",notification-type
-woudc,World Ozone and Ultraviolet Radiation Data Centre,notification-type
-meteo-france,Météo-France,notification-type
-dwd,Deutscher Wetterdienst,notification-type
-ecmwf,European Centre for Medium-Range Weather Forecasts,notification-type
-my-centre,my centre,notification-type
+can-eccc-msc,"Environment and Climate Change Canada, Meteorological Service of Canada",notification-type
+org-woudc,World Ozone and Ultraviolet Radiation Data Centre,notification-type
+fr-meteo-france,Météo-France,notification-type
+de-dwd,Deutscher Wetterdienst,notification-type
+int-ecmwf,European Centre for Medium-Range Weather Forecasts,notification-type