Skip to Content
Last modified by Artur on 2025/09/13 19:50
From version 2.1
edited by Helena
on 2025/07/01 17:55
Change comment: There is no comment for this version
To version 1.2
edited by Helena
on 2025/07/01 17:51
Change comment: There is no comment for this version

Summary

Details

Page properties
Tags
... ... @@ -1,1 +1,0 @@
1 -Artefact|Data source|Data structure definition|Dataflow|Dimension|Maintenance agency|Provision agreement|Reference metadata|Release policy - release calendar|Statistical data and metadata exchange
Content
... ... @@ -11,26 +11,26 @@
11 11  
12 12  = 1. Overview =
13 13  
14 -[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.1 is a minor revision to the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 Standard which introduces a limited set of changes, which cover the following:
14 +SDMX 3.1 is a minor revision to the SDMX 3.0 Standard which introduces a limited set of changes, which cover the following:
15 15  
16 -**Information Model**
16 +Information Model
17 17  
18 -* Support for [[Dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]] to reference a subset of [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] from a [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]
19 -* Simplification to Data (% style="color:#e74c3c" %)Constraints
20 -* Addition of Availability (% style="color:#e74c3c" %)Constraints
18 +* Support for Dataflows to reference a subset of Dimensions from a Data Structure Definition
19 +* Simplification to Data Constraints
20 +* Addition of Availability Constraints
21 21  
22 -**Documentation**
22 +1. Documentation
23 23  
24 -Registering [[Reference Metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] removed from documentation, to align with XML Registration object which is unable to reference a Metadata Provision, and REST API which is unable to query for registered [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] sources.
24 +Registering Reference Metadata removed from documentation, to align with XML Registration object which is unable to reference a Metadata Provision, and REST API which is unable to query for registered reference metadata sources.
25 25  
26 -**Breaking Changes**
26 +Breaking Changes
27 27  
28 -* Remove (% style="color:#e74c3c" %)version(%%) property on Categorisation
29 -* Removal of Advanced [[Release Calendar>>doc:sdmx:Glossary.Release policy - release calendar.WebHome]]
28 +* Remove version property on Categorisation
29 +* Removal of Advanced Release Calendar
30 30  
31 -**Content of the Document**
31 +Content of the Document
32 32  
33 -The remainder of this document contains a summary of the changes. More detailed information can be found in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.1 Technical Specifications, in particular:
33 +The remainder of this document contains a summary of the changes. More detailed information can be found in the SDMX 3.1 Technical Specifications, in particular:
34 34  
35 35  Section 2 – Information Model
36 36  
... ... @@ -38,63 +38,79 @@
38 38  
39 39  Section 6 – Technical Notes
40 40  
41 -[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] TWG GitHub for the REST API and the XML and JSON formats
41 +SDMX TWG GitHub for the REST API and the XML and JSON formats
42 42  
43 43  = 2. Summary of Breaking Changes in 3.1 =
44 44  
45 -(% style="color:#e74c3c" %)Version(%%) 3.1 introduces breaking changes, in the model in the following areas:
45 +Version 3.1 introduces breaking changes, in the model in the following areas:
46 46  
47 47  == 2.1 Removal of Advanced Release Calendar ==
48 48  
49 -The Data (% style="color:#e74c3c" %)Constraint(%%) was simplified to become a cohesive structural [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] focussed solely on the restriction of values that can be reported. As part of this remodelling the Advanced [[Release Calendar>>doc:sdmx:Glossary.Release policy - release calendar.WebHome]] was removed as it does not play a restrictive role.
49 +The Data Constraint was simplified to become a cohesive structural artefact focussed solely on the restriction of values that can be reported. As part of this remodelling the Advanced Release Calendar was removed as it does not play a restrictive role.
50 50  
51 51  //Guidance for Implementors//
52 -[[Reference Metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] reported against a [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] and / or [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] can be used as an alternative to the Advanced [[Release Calendar>>doc:sdmx:Glossary.Release policy - release calendar.WebHome]].
53 53  
54 -== 2.2 Removal of Version on Categorisation ==
53 +Reference Metadata reported against a Dataflow and / or Provision Agreement can be used as an alternative to the Advanced Release Calendar.
55 55  
56 -The Categorisation structural [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] has no use case for undergoing (% style="color:#e74c3c" %)version(%%) changes, the (% style="color:#e74c3c" %)version(%%) was therefore removed.
55 +1. //2.2 Removal of Version on Categorisation//
57 57  
57 +The Categorisation structural artefact has no use case for undergoing version changes, the version was therefore removed.
58 +
59 +
58 58  //Guidance for Implementors//
59 -If multiple (% style="color:#e74c3c" %)versions(%%) of a Categorisation exist where the source or target differs, these Categorisations should be given a unique ID.
60 60  
61 -= 3. Information Model =
62 +If multiple versions of a Categorisation exist where the source or target differs, these Categorisations should be given a unique ID.
62 62  
64 +1.
65 +11. Information Model
66 +
63 63  The changes to the information model support two distinct use cases:
64 64  
65 -1. Horizontally complex [[Data Structure Definitions>>doc:sdmx:Glossary.Data structure definition.WebHome]] (DSDs)
66 -1. Additional cohesion to the Data (% style="color:#e74c3c" %)Constraints(%%) model
69 +1. Horizontally complex Data Structure Definitions (DSDs)
70 +1. Additional cohesion to the Data Constraints model
67 67  
68 68  These changes are described in below.
69 69  
70 -== 3.1 Horizontally Complex Data Structure Definitions ==
74 +1. //3.1 Horizontally Complex Data Structure Definitions//
71 71  
72 -An explanation of this use case, with additional details can be found under Section 6 - Technical Notes, under heading ‘10.3 [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (% style="color:#e74c3c" %)Constraint(%%)’.
76 +An explanation of this use case, with additional details can be found under Section 6 - Technical Notes, under heading ‘10.3 Dimension Constraint’.
73 73  
74 74  The following changes to the model have been made to satisfy this use case.
75 75  
76 -**Data Structure Definition**
80 +1.
81 +11.
82 +111.
83 +1111. Data Structure Definition
77 77  
78 -The [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] has a new ‘evolving structure’ property, this is a Boolean property, when set to ‘true’ it indicates to the users of the [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] that new [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] may be added without the [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] undergoing a change to its major (% style="color:#e74c3c" %)version(%%) number.
85 +The Data Structure Definition has a new ‘evolving structure’ property, this is a Boolean property, when set to ‘true’ it indicates to the users of the DSD that new Dimensions may be added without the DSD undergoing a change to its major version number.
79 79  
80 -**Dataflow**
87 +1.
88 +11.
89 +111.
90 +1111. Dataflow
81 81  
82 -The [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] has a new [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (% style="color:#e74c3c" %)Constraint(%%) property, which is used to reference a subset of [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] which it uses from the referenced [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]].
92 +The Dataflow has a new Dimension Constraint property, which is used to reference a subset of Dimensions which it uses from the referenced DSD.
83 83  
84 -The [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (% style="color:#e74c3c" %)Constraint(%%) fixes the [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] of the [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] enabling the referenced [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] to have new [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] added without the need to change the major (% style="color:#e74c3c" %)version(%%) number.
94 +The Dimension Constraint fixes the Dimensions of the Dataflow enabling the referenced DSD to have new Dimensions added without the need to change the major version number.
85 85  
86 -The [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (% style="color:#e74c3c" %)Constraint(%%) property is only required if the [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] sets the evolving structure property to true.
96 +The Dimension Constraint property is only required if the DSD sets the evolving structure property to true.
87 87  
88 -== 3.2 Constraint Cohesion ==
98 +1. //3.2 Constraint Cohesion//
89 89  
90 -The (% style="color:#e74c3c" %)Constraint(%%) model in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.1 has been made more cohesive by separating the Data (% style="color:#e74c3c" %)Constraint(%%) into two distinct structures; the Data (% style="color:#e74c3c" %)Constraint(%%) which describes reporting restrictions, and the Availability (% style="color:#e74c3c" %)Constraint(%%), which describes data content from a [[data source>>doc:sdmx:Glossary.Data source.WebHome]]. In [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 these distinctions were made using the ‘type’ property on a Data (% style="color:#e74c3c" %)Constraint(%%).
100 +The Constraint model in SDMX 3.1 has been made more cohesive by separating the Data Constraint into two distinct structures; the Data Constraint which describes reporting restrictions, and the Availability Constraint, which describes data content from a data source. In SDMX 3.0 these distinctions were made using the ‘type’ property on a Data Constraint.
91 91  
92 -**Data Constraint**
102 +1.
103 +11.
104 +111.
105 +1111. Data Constraint
93 93  
94 -The Data (% style="color:#e74c3c" %)Constraint(%%) has had the ‘type’ property removed; the Data (% style="color:#e74c3c" %)Constraint(%%) in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.1 is always used to describe restrictions on content for data reporting purposes.
107 +The Data Constraint has had the ‘type’ property removed; the Data Constraint in SDMX 3.1 is always used to describe restrictions on content for data reporting purposes.
95 95  
96 -The attachment of the Data (% style="color:#e74c3c" %)Constraint(%%) in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 included [[Data Sources>>doc:sdmx:Glossary.Data source.WebHome]], in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.1 these attachments have been removed as these are not relevant for restricting reported data.
109 +The attachment of the Data Constraint in SDMX 3.0 included Data Sources, in SDMX 3.1 these attachments have been removed as these are not relevant for restricting reported data.
97 97  
98 -**Availability Constraint**
111 +1.
112 +11.
113 +111.
114 +1111. Availability Constraint
99 99  
100 -The Availability (% style="color:#e74c3c" %)Constraint(%%) is a new Structure introduced to describe data that exists, it is generated in the response to the Availability REST API. It is not a maintained structure, and as such has no [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]], identity or (% style="color:#e74c3c" %)version
116 +The Availability Constraint is a new Structure introduced to describe data that exists, it is generated in the response to the Availability REST API. It is not a maintained structure, and as such has no maintenance agency, identity or version