Changes for page Guidelines on the Versioning of SDMX Artefacts

Last modified by Artur K. on 2026/05/29 14:28

From 1.6 to 1.7 From 1.16 to 1.17

From version 1.7

edited by Helena K.
on 2026/01/15 15:12

Change comment: There is no comment for this version

To version 1.16

edited by Helena K.
on 2026/01/15 15:20

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -88,8 +88,6 @@
  |**Removal of one or more codes in the HCL or removal of one or more codes in the referenced code lists**|(% style="width:150px" %)**Major**: **+.0**|(% style="width:1045px" %)Data represented using the old HCL can no longer be represented using the new HCL, thus resulting in a break in backward compatibility
  |**Addition, modification or removal of one or more hierarchical levels**|(% style="width:150px" %)**Major: +.0**|(% style="width:1045px" %)The reorganisation of codes within hierarchies has a significant impact on the code aggregations
--
--
  |(% colspan="3" %)**CONCEPT SCHEME (CS)**
  |(% style="width:874px" %)**Type of change**|(% style="width:154px" %)**Impact**|(% style="width:1044px" %)**Comments**
  |(% style="width:874px" %)**Addition of one or more new concepts in an existing CS**|(% style="width:154px" %)**Minor**: **N.+**|(% style="width:1044px" %)(((
@@ -97,18 +97,16 @@
  )))
  |(% style="width:874px" %)**Removal of one or more existing concepts**|(% style="width:154px" %)**Major: +.0**|(% style="width:1044px" %)Data exchanged/disseminated using the old version of the CS can no longer be exchanged/disseminated using the new version with less concepts
--
--
  |(% colspan="3" %)**DATA STRUCTURE DEFINITION (DSD)**
--|**Type of change**|**Impact**|**Comments**
--|**Addition of a dimension**|**Major**: **+.0**|Adding a new dimension has a strong impact because a dimension represents the identifier of a dataset, thus requiring a remodelling of the data as existing structural validation will fail
--|**Addition of a mandatory attribute**|**Major**: **+.0**|If the attribute is mandatory, the situation is the same as under point “Addition of a dimension”
--|**Addition of a conditional attribute**|**Minor**: **N.+**|If the attribute is conditional backward compatibility is maintained
--|**Removal of a dimension or attribute**|**Major**: **+.0**|Whatever the type of component, the change does not guarantee backward compatibility
++|(% style="width:868px" %)**Type of change**|(% style="width:159px" %)**Impact**|(% style="width:1045px" %)**Comments**
++|(% style="width:868px" %)**Addition of a dimension**|(% style="width:159px" %)**Major**: **+.0**|(% style="width:1045px" %)Adding a new dimension has a strong impact because a dimension represents the identifier of a dataset, thus requiring a remodelling of the data as existing structural validation will fail
++|(% style="width:868px" %)**Addition of a mandatory attribute**|(% style="width:159px" %)**Major**: **+.0**|(% style="width:1045px" %)If the attribute is mandatory, the situation is the same as under point “Addition of a dimension”
++|(% style="width:868px" %)**Addition of a conditional attribute**|(% style="width:159px" %)**Minor**: **N.+**|(% style="width:1045px" %)If the attribute is conditional backward compatibility is maintained
++|(% style="width:868px" %)**Removal of a dimension or attribute**|(% style="width:159px" %)**Major**: **+.0**|(% style="width:1045px" %)Whatever the type of component, the change does not guarantee backward compatibility
  For concrete examples, see the Appendix.
--=== 5. How versioning works for inter-dependent artefacts ===
++= 5. How versioning works for inter-dependent artefacts =
  This section describes how version changes to inter-dependent or parent/child artefacts affect each other. For example, how a Concept Scheme is affected when one of the Code Lists that it references changes version.
@@ -131,51 +131,40 @@
  The replacement of a reference with a different reference has the same impact for every artefact.
  |(% colspan="3" %)**ALL ARTEFACTS**
--|**Type of change**|**Impact**|**Comments**
--|(((
--**Replacement of a child artefact having a different version, but same id and**
--
--**Agency**
++|(% style="width:492px" %)**Type of change**|(% style="width:441px" %)**Impact**|**Comments**
++|(% style="width:492px" %)(((
++**Replacement of a child artefact having a different version, but same id and Agency**
++)))|(% style="width:441px" %)(((
++**The child artefact version change is replicated in the parent artefact**
  )))|(((
--**The child artefact version change is replicated in the**
--
--**parent artefact**
--)))|(((
  If a child artefact (e.g. a Code List) has a minor version change, then the parent artefact (e.g. a Concept Scheme) should also have a minor version change.
--
  If there are several child artefact version changes, the most severe impact is replicated in the parent artefact. For example, if two Code Lists have minor changes, and one Code List has a major change at the same time, the parent Concept Scheme has a major version change
  )))
--|(((
--**Replacement of a referenced child artefact having a**
++|(% style="width:492px" %)(((
++**Replacement of a referenced child artefact having a different id or Agency**
++)))|(% style="width:441px" %)**The parent artefact version impact depends on the backward/ forward compatibility as shown in the tables above**|Technically, the child artefact is not considered to be related to the previous child artefact. It needs to be checked whether exchange contracts can still be guaranteed (backward/forward compatibility principle)
--**different id or Agency**
--)))|**The parent artefact version impact depends on the backward/ forward compatibility as shown in the tables above**|Technically, the child artefact is not considered to be related to the previous child artefact. It needs to be checked whether exchange contracts can still be guaranteed (backward/forward compatibility principle)
--
  ==== b. Addition or removal of referenced artefacts ====
--| |(% colspan="2" %)**CONCEPT SCHEME (CS)**
--|**Type of change**|**Impact**|**Comments**
--|(((
--**Addition or removal of a child**
++|(% colspan="3" style="width:876px" %)**CONCEPT SCHEME (CS)**
++|(% style="width:845px" %)**Type of change**|(% style="width:156px" %)**Impact**|(% style="width:1071px" %)**Comments**
++|(% style="width:845px" %)(((
++**Addition or removal of a child Code List**
++)))|(% style="width:156px" %)**Minor: N.+**|(% style="width:1071px" %)The child Code Lists in a Data Structure Definition have priority over those referenced in a Concept Scheme. Child Code Lists added to or removed from a Concept Scheme do not have a direct impact on the data exchange. Backward/forward compatibility depends on the way Code Lists are referenced in Data Structure Definitions referencing the concept scheme. This needs to be taken into account when creating a new version of a DSD accordingly
--**Code List**
--)))|**Minor: N.+**|The child Code Lists in a Data Structure Definition have priority over those referenced in a Concept Scheme. Child Code Lists added to or removed from a Concept Scheme do not have a direct impact on the data exchange. Backward/forward compatibility depends on the way Code Lists are referenced in Data Structure Definitions referencing the concept scheme. This needs to be taken into account when creating a new version of a DSD accordingly
--
--| |(% colspan="2" %)**DATA STRUCTURE DEFINITION (DSD)**
++|(% colspan="3" %)**DATA STRUCTURE DEFINITION (DSD)**
  |**Type of change**|**Impact**|**Comments**
  |**Addition or removal of a child Code List**|(((
--**If same id and Agency, then the child artefact version change is replicated in the parent artefact.**
--
--**If different id or Agency, impact wil depend on the backward/forward compatibility as shown in the tables above**
++**If same id and Agency, then the child artefact version change is replicated in the parent artefact.
++If different id or Agency, impact wil depend on the backward/forward compatibility as shown in the tables above**
  )))|(((
  If a child Code List has a minor version change, then the DSD should also have a minor version change.
--
  If there are several Code List version changes, the most severe impact is replicated in the DSD. For example, if two Code Lists have minor changes, and one Code List has a major change at the same time, the parent DSD has a major version change
  )))
--=== 6. Appendix - Examples ===
++= 6. Appendix - Examples =
  **Example 1 – Change to a Code List name, for clarification purposes**. **Patch Impact: N.M.+**
@@ -196,36 +196,29 @@
  |(% colspan="2" %)**AGGREGATION OF EXISTING CODES**
  |**Old version**|**New version**
--|**2011** Heifers (female bovine that never calved), live **2012** Cows, live|**2010** Heifers and cows, live
--|(% colspan="2" %)Codes **2011** and **2012** are fully{{footnote}}i.e. without integration into or combination with another existing code.{{/footnote}} **removed** and replaced with one **brand new** code. In this case there is a many to 1 correspondence between the codes.
++|**2011** Heifers (female bovine that never calved), live
++**2012** Cows, live|**2010** Heifers and cows, live
++|(% colspan="2" %)Codes **2011** and **2012** are fully{{footnote}}i.e. without integration into or combination with another existing code.{{/footnote}} __**removed**__ and replaced with one __**brand new**__ code. In this case there is a many to 1 correspondence between the codes.
--
--
  |(% colspan="2" %)**DISAGGREGATION OF EXISTING CODES**
  |**Old version**|**New version**
  |**1010** Live horses|(((
--1. Pure bred breeding horses, live
--1. Other horses, live
++1011 Pure bred breeding horses, live
++1012 Other horses, live
  )))
--|(% colspan="2" %)Code **1010** is fully **removed** and replaced with two **brand new** codes. In this case there is a 1 to m correspondence between the codes.
++|(% colspan="2" %)Code **1010** is fully __**removed**__ and replaced with two __**brand new**__ codes. In this case there is a 1 to m correspondence between the codes.
--
--
  |(% colspan="2" %)**REORGANISATION OF EXISTING CODES**
  |**Old version**|**New version**
  |(((
  **3010** Fowls, weighing ≤ 185 g
--
  **3020** Ducks, , weighing ≤ 185 g
--
  **3030** Other poultry, weighing ≤ 185 g
--
  **3040** Fowls, weighing > 185 g
--
  **3050** Ducks, , weighing > 185 g
--
  **3060** Other poultry, weighing > 185 g
--)))|**3025** Poultry, weighing ≤ 175 g **3045** Poultry, weighing > 175 g
++)))|**3025** Poultry, weighing ≤ 175 g
++**3045** Poultry, weighing > 175 g
  |(% colspan="2" %)Codes **3010**, **3020**, **3030**, **3040**, **3050** and **3060** are fully removed and replaced with two brand new codes; furthermore the criterion for the classification used in the old version has been changed in the new version (185 g criterion versus 175 g criterion), so that it is not possible to exactly aggregate the codes from the old version to the codes of the new version (e.g. a part of **3010** goes to **3025**, another part to **3045**). In this case there is a m to n correspondence between the two sets of codes
  **Example 5 – Changes to hierarchies in a Code List. Major impact: +.0**
@@ -232,7 +232,16 @@
  |(% colspan="2" %)**ADDING A NEW CODE IN AN EXISTING HIERARCHY – CODE LIST**
  |**Old version**|**New version**
--|• 0213 - Beer o02131 - Lager beer o02132 - Other alcoholic beer|• 0213 - Beer o02131 - Lager beer o 02132 - Other alcoholic beer o **02133 - Low and non-alcoholic beer**
++|(((
++* 0213 - Beer
++** 02131 - Lager beer
++** 02132 - Other alcoholic beer
++)))|(((
++* 0213 - Beer
++** 02131 - Lager beer
++** 02132 - Other alcoholic beer
++* **02133 - Low and non-alcoholic beer**
++)))
  |(% colspan="2" %)Code 02133 has been added to hierarchy 0213
  **Example 6 – Changes to hierarchies in a Hierarchical Code List. Major impact: +.0**
@@ -240,23 +240,21 @@
  |(% colspan="2" %)**ADDING A NEW CODE IN AN EXISTING HIERARCHY – HIERARCHICAL CODE LIST**
  |**Old version**|**New version**
  |(((
--• A1 - World (codelist ref. ECB@CL_AREAS@1.0) o E1 - Europe (ECB@CL_COUNTRIES@1.0)
--
-- ES - Spain FR - France
--
--GR - Greece
--
--IT - Italy o E4 - Africaetc.
++*  A1 - World (codelist ref. ECB@CL_AREAS@1.0)
++** E1 - Europe (ECB@CL_COUNTRIES@1.0)
++*** ES - Spain FR - France
++*** GR - Greece
++*** IT - Italy
++** E4 - Africa
++*** etc.
  )))|(((
--• A1=World (codelist ref. ECB@CL_AREAS@1.0) o E1 =Europe (ECB@CL_COUNTRIES@1.0)
--
-- ES = Spain FR = FranceGR = Greece
--
--IT = Italy
--
--**DE= Germany**
--
--o E4 =Africaetc.
++* A1=World (codelist ref. ECB@CL_AREAS@1.0)
++** E1 =Europe (ECB@CL_COUNTRIES@1.0)
++** ES = Spain FR = FranceGR = Greece
++** IT = Italy
++** **DE= Germany**
++* E4 =Africa
++** etc.
  )))
  |(% colspan="2" %)The id of the hierarchical codes are assumed to be equal to those of the code lists referenced. The code DE has been added to hierarchy E1