Changes for page Guidelines on Using SDMX Annotations
Last modified by Artur K. on 2026/05/29 14:28
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -30,6 +30,13 @@ 30 30 31 31 === SDMX 3.0 === 32 32 33 + 34 +|((( 35 +|((( 36 + 37 +))) 38 +))) 39 + 33 33 [[image:1768507168030-780.png]] 34 34 35 35 The URL can be localised which gives the advantage of linking to different resources depending on the language. It also removes the complexity of having to use AnnotationText in SDMX 2.1 to do this. ... ... @@ -38,23 +38,25 @@ 38 38 39 39 The properties of the Annotation construct are listed below. This information is taken from the [[SDMX official technical documentation>>url:https://sdmx.org/?page_id=5008]]. 40 40 41 -|**Property**| (% style="width:823px" %)**Description**|(% style="width:710px" %)**Controlled vocabulary context**42 -|**id**| (% style="width:823px" %)Identifier for the Annotation. It can be used to disambiguate one Annotation from another where there are several Annotations for the same annotated object.|(% style="width:710px" %)Id is set to @SDMX to identify it as part of the controlled vocabulary43 -|**title**| (% style="width:823px" %)A title used to identify an Annotation.|(% style="width:710px" %)A non-localised value for the annotation. Used when localisation is irrelevant.44 -|**type**|( % style="width:823px" %)(((48 +|**Property**|**Description**|**Controlled vocabulary context** 49 +|**id**|Identifier for the Annotation. It can be used to disambiguate one Annotation from another where there are several Annotations for the same annotated object.|Id is set to @SDMX to identify it as part of the controlled vocabulary 50 +|**title**|A title used to identify an Annotation.|A non-localised value for the annotation. Used when localisation is irrelevant. 51 +|**type**|((( 45 45 Specifies how the Annotation is to be processed. 46 -The **type** is often used as the usage context of the Annotation. The types are not enumerated{{footnote}}The technical standard does not enumerate the annotation types, however this guideline provides a recommended enumeration or controlled vocabulary{{/footnote}}, as these can be specified by the Annotation creator. The definitions and use of Annotation types should be documented by their creator. 47 -)))|(% style="width:710px" %)Identifies the usage (e.g. images are type IMAGE) of the annotation. The type values are enumerated in the controlled vocabulary table. 48 -|**url**|(% style="width:823px" %)((( 53 + 54 +The **type** is often used as the usage context of the Annotation. The types are not enumerated[[~[1~]>>path:#_ftn1]], as these can be specified by the Annotation creator. The definitions and use of Annotation types should be documented by their creator. 55 +)))|Identifies the usage (e.g. images are type IMAGE) of the annotation. The type values are enumerated in the controlled vocabulary table. 56 +|**url**|((( 49 49 A link to external descriptive text. 58 + 50 50 The **url** is a URI - typically a URL - which points to a resource. If a specific behaviour is desired, an Annotation type should be defined which specifies the use of this field more exactly. 51 -)))| (% style="width:710px" %)A non-localised URL reference to an external resource. Used when localisation is irrelevant.52 -|**+url**| (% style="width:823px" %)**SDMX 3.0 and later**. An annotation may have several localised URLs|(% style="width:710px" %)A localised URL reference to an external resource.53 -|**+text**|( % style="width:823px" %)(((60 +)))|A non-localised URL reference to an external resource. Used when localisation is irrelevant. 61 +|**+url**|**SDMX 3.0 and later**. An annotation may have several localised URLs|A localised URL reference to an external resource. 62 +|**+text**|((( 54 54 An International String that provides the multilingual text content of the Annotation. 55 55 56 56 **Text** holds a language-specific string containing the text of the Annotation. 57 -)))| (% style="width:710px" %)A localised value for the annotation.66 +)))|A localised value for the annotation. 58 58 59 59 = Introducing Standard Annotations = 60 60 ... ... @@ -74,15 +74,15 @@ 74 74 75 75 The green columns in the table below show example usages of standard Annotations. The orange “ORDER” column is not a standard Annotation because the usage context is not the same as the standard Annotation “ORDER”, therefore the **id** should not be “@SDMX”. 76 76 77 -|**id***|**@SDMX**| (% style="width:249px" %)**@SDMX**|(% style="width:209px" %)**@SDMX**|(% style="width:888px" %)(((86 +|**id***|**@SDMX**|**@SDMX**|**@SDMX**|((( 78 78 **Not @SDMX** 79 79 80 80 This is a “customer order no.” which is a different use case than the ORDER standard Annotation which is a list order 81 81 ))) 82 -|**title**| | (%style="width:249px" %)|(%style="width:209px" %)|(% style="width:888px" %)193424583 -|**type***|NOT_DISPLAYED| (% style="width:249px" %)EXCLUDES|(% style="width:209px" %)ORDER|(% style="width:888px" %)ORDER84 -|(% rowspan="2" %)**+text**|(% rowspan="2" %) |(% rowspan="2" style="width:249px"%) |(% style="width:209px" %)en :10|(% rowspan="2"style="width:888px"%)85 -| (% style="width:209px" %)fr :2091 +|**title**| | | |1934245 92 +|**type***|NOT_DISPLAYED|EXCLUDES|ORDER|ORDER 93 +|(% rowspan="2" %)**+text**|(% rowspan="2" %) |(% rowspan="2" %) |en :10|(% rowspan="2" %) 94 +|fr :20 86 86 87 87 ~* denotes a mandatory information for standard Annotations 88 88 ... ... @@ -102,13 +102,13 @@ 102 102 103 103 == Relationships between Annotation properties == 104 104 105 -=== Text value defaults and specific locale values === 114 +==== Text value defaults and specific locale values ==== 106 106 107 107 Some use cases may benefit from having a single, default value for all locales/languages but also to set the value for certain locales. An example is ORDER where there may be a default list order for all locales but two locales have a specific order which is different from the default. In order to avoid having to state an order for every locale, the Annotation Title property may be used to state the default value, whereas the text property is used for the localised values. 108 108 109 109 Consider this annotation //Example~:// An ORDER annotation type that is attached to a code item ACME. If both the Annotation Text and Annotation Title have values, then the Annotation Text value (e.g. en:10,es:20) is used for the localized values instead of the Annotation Title (e.g. 30) which would only be taken if the locale in the context is not found among the specified ones. 110 110 111 -=== URL value defaults and specific locale values === 120 +==== URL value defaults and specific locale values ==== 112 112 113 113 ===== SDMX 2.1 and earlier ===== 114 114 ... ... @@ -122,290 +122,348 @@ 122 122 123 123 Multiple URL localised properties were introduced in SDMX 3.0. Therefore, the URL work-around in the above paragraph is not recommended. The URL property should be used as shown in the table. 124 124 134 + 125 125 == General and Display-related Annotation types == 126 126 127 -(% style="width:1790.2px" %) 128 -|(% style="width:243px" %)**Annotation Type**|(% style="width:442px" %)**Use Case**|(% style="width:246px" %)**Where to attach**|(% style="width:289px" %)((( 129 -**+Text 130 -(% style="background-color:transparent" %)Blue is optional(%%)** 131 -)))|(% style="width:321px" %)((( 132 -**Title 133 -(% style="background-color:transparent" %)Blue is optional(%%)** 134 -)))|(% style="width:185px" %)((( 135 -**SDMX 2.1:URL 137 +|Annotation Type|Use Case|Where to attach|((( 138 ++Text 139 + 140 +Blue is optional 141 +)))|((( 142 +Title 143 + 144 +Blue is optional 145 +)))|((( 146 +SDMX 2.1:URL 147 + 136 136 SDMX >=3.0:+URL 137 -(% style="background-color:transparent" %)Blue is optional(%%)** 149 + 150 +Blue is optional 138 138 ))) 139 -|(% style="width:243px" %)FULL_NAME|(% style="width:442px" %)Alternative name to be displayed for items in Item Schemes (e.g. Codelists, Concept Schemes, Category Schemes) whenever the item is displayed without its parent. For example, if a code list that has a hierarchy is displayed as a flat list, then this annotation may be used to provide sufficient context for the code. Concatenation of code + heading in NACE Rev.2.1 140 -en: A0123 Growing of citrus fruits|(% style="width:246px" %)Item in an Item Scheme|(% style="width:289px" %)((( 141 -<language>:<content>,<language>:<content>,… 152 +|FULL_NAME|Alternative name to be displayed for items in Item Schemes (e.g. Codelists, Concept Schemes, Category Schemes) whenever the item is displayed without its parent. For example, if a code list that has a hierarchy is displayed as a flat list, then this annotation may be used to provide sufficient context for the code. Concatenation of code + heading in NACE Rev.2.1 153 +en: A0123 Growing of citrus fruits|Item in an Item Scheme|((( 154 +<language>:<content>, 155 + 156 +<language>:<content>,… 157 + 142 142 //Example~:// 143 -(% style="background-color:transparent" %)en:Labour force (Employment) 144 -)))|(% style="width:321px" %)<content>|(% style="width:185px" %) 145 -|(% style="width:243px" %)REPLACE_NAME|(% style="width:442px" %)Replace each code name in a component by the value of another component in an observation or series|(% style="width:246px" %)A Dataflow or DSD|(% style="width:289px" %) |(% style="width:321px" %)((( 146 -<component Id to replace name>: 147 -<component Id to use name> 159 + 160 +en:Labour force (Employment) 161 +)))|<content>| 162 +|REPLACE_NAME|Replace each code name in a component by the value of another component in an observation or series|A Dataflow or DSD| |((( 163 +<component Id to replace name>:<component Id to use name> 164 + 148 148 //Example~:// 149 - (% style="background-color:transparent" %)CUST_BREAKDOWN:CUST_150 -BREAKDOWN_LB 151 -)))| (%style="width:185px" %)152 -| (% style="width:243px" %)REPLACE_CONTENT|(% style="width:442px" %)Replace the content in a component by the value of another component in an observation or series|(% style="width:246px" %)A Dataflow or DSD|(%style="width:289px" %)|(% style="width:321px" %)(((153 -<component Id to replace content>: 154 - <component Id to use content>166 + 167 +CUST_BREAKDOWN:CUST_BREAKDOWN_LB 168 +)))| 169 +|REPLACE_CONTENT|Replace the content in a component by the value of another component in an observation or series|A Dataflow or DSD| |((( 170 +<component Id to replace content>:<component Id to use content> 171 + 155 155 //Example~:// 156 -(% style="background-color:transparent" %)REF_AREA:M49_CODE 157 -)))|(% style="width:185px" %) 158 -|(% style="width:243px" %)COMPLEMENT|(% style="width:442px" %)((( 173 + 174 +REF_AREA:M49_CODE 175 +)))| 176 +|COMPLEMENT|((( 159 159 Additional fixed text to be displayed in parenthesis after the code name. 160 -(% style="background-color:transparent" %)E.g. Representation of Non-hazardous (NHAZW), hazardous waste (HAZW) in the European List of Wastes(%%) 161 -(% style="background-color:transparent" %)en: 01 03 04* acid-generating tailings from processing of sulphide ore (HAZW)(%%) 162 -(% style="background-color:transparent" %)en: 01 03 99 wastes not otherwise specified (NHAZW) 163 -)))|(% style="width:246px" %)Item in an Item Scheme|(% style="width:289px" %)((( 164 -<language>:<content>,<language>:<content>,… 165 165 179 +E.g. Representation of Non-hazardous (NHAZW), hazardous waste (HAZW) in the European List of Wastes 180 +en: 01 03 04* acid-generating tailings from processing of sulphide ore (HAZW) 181 +en: 01 03 99 wastes not otherwise specified (NHAZW) 182 +)))|Item in an Item Scheme|((( 183 +<language>:<content>, 184 + 185 +<language>:<content>,… 186 + 166 166 //Example~:// 167 -(% style="background-color:transparent" %)en:See reference metadata 168 -)))|(% style="width:321px" %)<content>|(% style="width:185px" %) 169 -|(% style="width:243px" %)ORDER|(% style="width:442px" %)Explicit indication of a localised order of items in Items Schemes or artefacts (e.g. Codelist, Concept Scheme, Category Scheme, Dataflow, etc.)|(% style="width:246px" %)((( 188 + 189 +en:See reference metadata 190 +)))|<content>| 191 +|ORDER|Explicit indication of a localised order of items in Items Schemes or artefacts (e.g. Codelist, Concept Scheme, Category Scheme, Dataflow, etc.)|((( 170 170 Either: 171 171 172 172 * an artefact, or; 173 173 * an item in an Item Scheme 174 -)))|( % style="width:289px" %)(((196 +)))|((( 175 175 <language>:<content>, 198 + 176 176 <language>:<content>,… 177 177 178 178 //Example~:// 179 -(% style="background-color:transparent" %)en:10,es:20 180 -)))|(% style="width:321px" %)<content>|(% style="width:185px" %) 181 -|(% style="width:243px" %)TOTAL|(% style="width:442px" %)((( 202 + 203 +en:10,es:20 204 +)))|((( 205 +<content> 206 + 207 + 208 +)))| 209 +|TOTAL|((( 182 182 Code Item that represents a total value. If the attachment is: 183 183 184 184 * to a Code, the Annotation Text is optional and may contain an explanatory text; 185 -* to a Codelist, the Annotation Title is mandatory and includes the code(s) that represent a total 186 -)))|(% style="width:246px" %)((( 213 + 214 +to a Codelist, the Annotation Title is mandatory and includes the code(s) that represent a total 215 +)))|((( 187 187 Either: 188 188 189 189 * a Code Item that represents a total value, or; 190 190 * a Codelist to specify the code(s) with the total 191 -)))|(% style="width:289px" %)((( 192 -<language>:<explanatory text>, 193 -(% style="background-color:transparent" %)<language>:<explanatory text>,… 194 -)))|(% style="width:321px" %)((( 220 +)))|((( 221 +<language>:<explanatory text>, 222 + 223 +<language>:<explanatory text>,… 224 +)))|((( 195 195 Attached to Code Item: <blank> 196 -(% style="background-color:transparent" %)Attached to Codelist: <code>,<code>,… 197 -)))|(% style="width:185px" %) 198 -|(% style="width:243px" %)DRILLDOWN|(% style="width:442px" %)Denotes the concept that specifies whether observations are at the aggregate level or a drilldown.|(% style="width:246px" %)((( 226 + 227 +Attached to Codelist: <code>,<code>,… 228 +)))| 229 +|DRILLDOWN|Denotes the concept that specifies whether observations are at the aggregate level or a drilldown.|((( 199 199 Either: 200 200 201 201 * A Dataflow or DSD 202 -)))| (%style="width:289px" %)|(% style="width:321px" %)(((233 +)))| |((( 203 203 <concept Id> 235 + 204 204 //Example~:// 205 -(% style="background-color:transparent" %)DD_DIM (this concept should be hidden using the NOT_DISPLAYED Annotation below) 206 -)))|(% style="width:185px" %) 207 -|(% style="width:243px" %)DEPRECATED|(% style="width:442px" %)((( 237 + 238 +DD_DIM (this concept should be hidden using the NOT_DISPLAYED Annotation below) 239 +)))| 240 +|DEPRECATED|((( 208 208 Indication that an Item in an Item Scheme or an artefact is deprecated. 242 + 209 209 For an item scheme item, the annotation value provides a replacement name for the code name. 244 + 210 210 For an artefact, the URL points to the replacement artefact. May be used in conjunction with SUPERSEED where the replacement artefact references the replaced artefact. 246 + 211 211 Suggestion to use a controlled vocabulary 212 -url: 213 -<[[http:~~/~~/publications.europa.eu/resource/authority/concept-status/CURRENT>>url:http://publications.europa.eu/resource/authority/concept-status/CURRENT]]> 214 -url: 215 -<[[http:~~/~~/publications.europa.eu/resource/authority/concept-status/DEPRECATED>>url:http://publications.europa.eu/resource/authority/concept-status/DEPRECATED]]> 216 -or 217 -(% style="background-color:transparent" %)TITLE: true (false) 218 -)))|(% style="width:246px" %)((( 248 + 249 +url: <[[http:~~/~~/publications.europa.eu/resource/authority/concept-status/CURRENT>>url:http://publications.europa.eu/resource/authority/concept-status/CURRENT]]> 250 +url: <[[http:~~/~~/publications.europa.eu/resource/authority/concept-status/DEPRECATED>>url:http://publications.europa.eu/resource/authority/concept-status/DEPRECATED]]> 251 + 252 +or 253 + 254 +TITLE: true (false) 255 +)))|((( 219 219 Either: 220 220 221 221 * an artefact, or; 222 222 * an item in an Item Scheme 223 -)))|( % style="width:289px" %)(((260 +)))|((( 224 224 For item scheme item: 225 225 226 -<language>:<content>, <language>:<content>,…263 +<language>:<content>, 227 227 265 +<language>:<content>,… 266 + 228 228 //Example~:// 229 -(% style="background-color:transparent" %)en:deprecated,fr:obsolète 230 -)))|(% style="width:321px" %)<content>|(% style="width:185px" %)((( 268 + 269 +en:deprecated,fr:obsolète 270 +)))|<content>|((( 231 231 For artefact: 272 + 232 232 <see section URL value defaults and specific locale values> 274 + 275 + 233 233 ))) 234 -| (% style="width:243px" %)DEFAULT|(% style="width:442px" %)(((277 +|DEFAULT|((( 235 235 Indication that an item in an Item Scheme or artefacts is to be selected by default. 236 236 237 237 The Annotation defines a selection so that a pre-defined default subset of data can be processed (e.g. visualised, extracted) instead of the entire dataset 238 -)))|( % style="width:246px" %)(((281 +)))|((( 239 239 * Item in ItemScheme, or; 240 240 * DSD, or; 241 241 * a Dataflow 242 242 243 243 Note: A DEFAULT Annotation attached to a later level in this list supersedes that attached to an earlier level. E.g., a DEFAULT Annotation attached to individual Codes in Codelists is only to be used when there is no DEFAULT Annotation attached to the Dataflow nor to the DSD, and those of DSDs are only to be used when there is no DEFAULT Annotation attached to the Dataflow. 244 -)))| (%style="width:289px" %)|(% style="width:321px" %)(((287 +)))| |((( 245 245 Attached to: 246 246 247 247 - DSD or Dataflow: 248 -**<concept>=<code>+<code>+…, 249 -<concept>=<code>+<code>+…** 291 + **<concept>=<code>+<code>+…,<concept>=<code>+<code>+…** 250 250 251 -//Example~:// FREQ=A+Q,TIME_PERIOD_ 252 -START=2013-01,TIME_PERIOD_END 253 -~=2018-12 254 -)))|(% style="width:185px" %) 255 -|(% style="width:243px" %)IMAGE|(% style="width:442px" %)A visual identity to associate to Item Scheme Items or artefacts|(% style="width:246px" %)((( 293 +//Example~:// FREQ=A+Q,TIME_PERIOD_START=2013-01,TIME_PERIOD_END=2018-12 294 +)))| 295 +|IMAGE|A visual identity to associate to Item Scheme Items or artefacts|((( 256 256 Either: 257 257 258 258 * an artefact, or; 259 259 * an item in an item scheme 260 -)))|( % style="width:289px" %)(((300 +)))|((( 261 261 For localised content in SDMX 2.1 302 + 262 262 <language>:<HTML containing URL to the resource>, 304 + 263 263 <language>:<HTML containing URL to the resource>,… 264 264 265 265 //Example~:// 308 + 266 266 en:<a href=”https:~/~/sdmx.org/wp-content/uploads/SDMX_map_small-220x220.jpg”> 267 -)))| (%style="width:321px" %)|(% style="width:185px" %)(((310 +)))| |((( 268 268 See section URL value defaults and specific locale values. 269 269 270 270 //Example~:// 271 271 272 -https:~/~/sdmx.org/wp-content/uploads/SDMX_map_ 273 -small-220x220.jpg 315 +https:~/~/sdmx.org/wp-content/uploads/SDMX_map_small-220x220.jpg 316 + 317 + 274 274 ))) 275 -| (% style="width:243px" %)DRILLDOWN_CONCEPTS|(% style="width:442px" %)Concepts to be displayed in a drilldown operation|(% style="width:246px" %)Dataflow or DSD|(%style="width:289px" %)|(% style="width:321px" %)(((319 +|DRILLDOWN_CONCEPTS|Concepts to be displayed in a drilldown operation|Dataflow or DSD| |((( 276 276 <concept Id>,<concept Id>,… 277 277 278 278 Example : 279 -DONOR,RECIPIENT,YEAR,PROJECT_ID, OBS_VALUE,DESCRIPTION,OWNER 280 -)))|(% style="width:185px" %) 281 -|(% style="width:243px" %)NOT_DISPLAYED|(% style="width:442px" %)Used to hide components or their values in the presentation|(% style="width:246px" %)((( 323 + 324 +DONOR,RECIPIENT,YEAR,PROJECT_ID,OBS_VALUE,DESCRIPTION,OWNER 325 +)))| 326 +|NOT_DISPLAYED|Used to hide components or their values in the presentation|((( 282 282 Either: 283 283 284 284 * a Dataflow or DSD, or; 285 285 * an Item in an Item Scheme 286 -)))| (%style="width:289px" %)|(% style="width:321px" %)(((331 +)))| |((( 287 287 Attached to Item in Item Scheme: <blank> 288 288 289 289 Attached to Dataflow or DSD: 335 + 290 290 <concept Id>,<concept Id>,… 337 + 291 291 Example : 339 + 292 292 DD_DIM (to hide drilldown control concept) 293 -)))| (%style="width:185px" %)294 -| (% style="width:243px" %)LAYOUT_ROW|(% style="width:442px" %)Dimensions to be presented in rows (concepts on y-axis)|(% style="width:246px" %)(((341 +)))| 342 +|LAYOUT_ROW|Dimensions to be presented in rows (concepts on y-axis)|((( 295 295 Either: 296 296 297 297 * an artefact, or; 298 298 * a Dimension 299 -)))| (%style="width:289px" %)|(% style="width:321px" %)(((347 +)))| |((( 300 300 Attached to Dimension: <blank> 301 301 302 302 Attached to Dataflow or DSD: <dimension Id>,<dimension Id >,… 303 303 304 304 //Example~:// 353 + 305 305 REF_AREA,MEASURE 306 -)))| (%style="width:185px" %)307 -| (% style="width:243px" %)LAYOUT_COLUMN|(% style="width:442px" %)Dimensions to be presented in columns (concepts on x-axis)|(% style="width:246px" %)(((355 +)))| 356 +|LAYOUT_COLUMN|Dimensions to be presented in columns (concepts on x-axis)|((( 308 308 Either: 309 309 310 310 * an artefact, or; 311 - 312 -a Dimension 313 -)))|(% style="width:289px" %) |(% style="width:321px" %)((( 360 +* a Dimension 361 +)))| |((( 314 314 Attached to Dimension: <blank> 315 315 316 316 Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,… 317 317 318 318 //Example~:// 367 + 319 319 TIME_PERIOD 320 -)))| (%style="width:185px" %)321 -| (% style="width:243px" %)LAYOUT_FLAG|(% style="width:442px" %)Indication that an attribute and its attribute value should be presented as a flag|(% style="width:246px" %)Dataflow|(%style="width:289px" %)|(% style="width:321px" %)(((369 +)))| 370 +|LAYOUT_FLAG|Indication that an attribute and its attribute value should be presented as a flag|Dataflow| |((( 322 322 <concept Id>,<concept Id>,... 323 323 324 324 //Example~:// 374 + 325 325 OBS_STATUS,CONF_STATUS 326 -)))| (%style="width:185px" %)327 -| (% style="width:243px" %)LAYOUT_NOTE|(% style="width:442px" %)Indication that an attribute and its attribute value should be presented as a note|(% style="width:246px" %)Dataflow|(%style="width:289px" %)|(% style="width:321px" %)(((376 +)))| 377 +|LAYOUT_NOTE|Indication that an attribute and its attribute value should be presented as a note|Dataflow| |((( 328 328 <concept Id>,<concept Id>,... 329 329 330 330 //Example~:// 381 + 331 331 OBS_STATUS,CONF_STATUS 332 -)))| (%style="width:185px" %)333 -|( % style="width:243px" %)(((383 +)))| 384 +|((( 334 334 METADATA 335 -)))|(% style="width:442px" %)Links an MSD directly to a DSD. Can be used to overcome the complexities of reference metadata linkage|(% style="width:246px" %)DSD|(% style="width:289px" %) |(% style="width:321px" %)MSD URI, e.g. urn:sdmx:org.sdmx.infomodel. 336 -metadatastructure. MetadataStructure =OECD:MSD_REF_METADATA(1.0)|(% style="width:185px" %) 337 -|(% style="width:243px" %)LAYOUT_ROW_SECTION|(% style="width:442px" %)Dimension to be presented as a break-down concept at a third hierarchical level above columns and rows.|(% style="width:246px" %)((( 386 + 387 + 388 +)))|Links an MSD directly to a DSD. Can be used to overcome the complexities of reference metadata linkage|DSD| |MSD URI, e.g. urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataStructure=OECD:MSD_REF_METADATA(1.0)| 389 +|LAYOUT_ROW_SECTION|Dimension to be presented as a break-down concept at a third hierarchical level above columns and rows.|((( 338 338 Either: 339 339 340 340 * an artefact, or; 341 -* a Dimension 342 -)))|(% style="width:289px" %) |(% style="width:321px" %)((( 393 + 394 +a Dimension 395 +)))| |((( 343 343 Attached to Dimension: <blank> 344 -~|Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,… 397 + 398 +Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,… 399 + 345 345 //Example~:// 401 + 346 346 SEX 347 -)))| (%style="width:185px" %)348 -| (% style="width:243px" %)EXT_RESOURCE|(% style="width:442px" %)(((403 +)))| 404 +|EXT_RESOURCE|((( 349 349 A localised link to an external resource associated to the annotated artefact. For example, an ontology item 350 -//a methodology// en:<a href: "[[https:~~/~~/ec.europa.eu/eurostat/web/waste/methodology>>url:https://ec.europa.eu/eurostat/web/waste/methodology]]"> 351 -)))|(% style="width:246px" %)Any SDMX object|(% style="width:289px" %)((( 406 + 407 +//a methodology// en:<a href:"[[https:~~/~~/ec.europa.eu/eurostat/web/waste/methodology>>url:https://ec.europa.eu/eurostat/web/waste/methodology]]"> 408 +)))|Any SDMX object|((( 352 352 For localised content in SDMX 2.1 353 -<language>:<HTML containing URL to the resource>, 410 + 411 + <language>:<HTML containing URL to the resource>, 412 + 354 354 <language>:<HTML containing URL to the resource>,… 355 355 356 356 //Example~:// 416 + 357 357 en:<a href=”[[http:~~/~~/rdf-vocabulary.ddialliance.org/xkos#depth>>url:http://rdf-vocabulary.ddialliance.org/xkos#depth]]”> 358 -)))| (%style="width:321px" %)|(% style="width:185px" %)(((418 +)))| |((( 359 359 See section URL value defaults and specific locale values. 360 360 361 361 //Example~:// 362 362 363 -http:~/~/rdf-vocabulary.ddialliance.org/ 364 -xkos#depth 423 +http:~/~/rdf-vocabulary.ddialliance.org/xkos#depth 365 365 ))) 366 -| (% style="width:243px" %)COMBINED_CONCEPTS|(% style="width:442px" %)(((425 +|COMBINED_CONCEPTS|((( 367 367 Comma-separated list of concept IDs to show as a concatenated label. 427 + 368 368 The listed concepts’ item contents may be concatenated to generate the target concept. 429 + 369 369 Multiple target concept combinations can be defined by separating the target concepts by ; 370 -)))| (% style="width:246px" %)Dataflow or DSD|(% style="width:289px" %)(((431 +)))|Dataflow or DSD|((( 371 371 <language>:<display name>, 433 + 372 372 <language>:<display name> 373 - (% style="background-color:transparent" %)e.g. COMBINED_UNIT_MEASURE:374 -PRICE_BASE, UNIT_MEASURE;COMBINED_MEASURE:MEASURE,REF_SECTOR{(en):Combined unit of measure;Combined measure}{(fr):Unité de mesure combinée;Mesure combinée}375 -)))| (%style="width:321px" %)|(%style="width:185px" %)376 -|( % style="width:243px" %)(deprecated) UNIT_MEASURE_CONCEPTS|(% style="width:442px" %)(((435 + 436 +e.g. COMBINED_UNIT_MEASURE:PRICE_BASE,UNIT_MEASURE;COMBINED_MEASURE:MEASURE,REF_SECTOR{(en):Combined unit of measure;Combined measure}{(fr):Unité de mesure combinée;Mesure combinée} 437 +)))| | 438 +|(deprecated) UNIT_MEASURE_CONCEPTS|((( 377 377 Comma-separated list of concept IDs that is used to define the full unit of measure. The concepts must be in the DSD. 378 378 379 379 The listed concepts’ item contents may be concatenated to generate the unit of measure label (unless the UNIT_MEASURE_LABEL annotation is present). 380 -)))| (% style="width:246px" %)Dataflow or DSD|(%style="width:289px" %)|(% style="width:321px" %)(((442 +)))|Dataflow or DSD| |((( 381 381 <concept Id>,<concept Id>,… 382 382 383 -//Example~:// UNIT_MEASURE, UNIT_MULT,384 - TRANSFORMATION[could generate a value of Australian Dollar, Thousands, Non-transformed]385 - )))|(% style="width:185px" %)386 - |(% style="width:243px"%)(deprecated) UNIT_MEASURE_LABEL|(%style="width:442px"%)(((387 - Indicates the concept that enumerates the full unit of measure labels.445 +//Example~:// UNIT_MEASURE,UNIT_MULT,TRANSFORMATION [could generate a value of Australian Dollar, Thousands, Non-transformed] 446 +)))| 447 +|(deprecated) UNIT_MEASURE_LABEL|((( 448 +Indicates the concept that enumerates the full unit of measure labels. 449 + 388 388 The concept must be in the DSD. UNIT_MEASURE_LABEL overrides the UNIT_MEASURE_CONCEPTS if both are provided. 389 389 390 390 Also can be attached to items in item scheme, e.g. 391 391 392 -Text en:Gram 393 - fr: Gramme 454 +Text en:Gram 455 + fr: Gramme 394 394 url:** **[[**http:~~/~~/data.europa.eu/gzn/su/G**>>url:http://data.europa.eu/gzn/su/G]] 395 -)))| (% style="width:246px" %)Dataflow or DSD, Item in an Item Scheme|(% style="width:289px" %)(((457 +)))|Dataflow or DSD, Item in an Item Scheme|((( 396 396 This is optional, used if a freetext label is required. 397 397 398 398 <language>:<content>, 461 + 399 399 <language>:<content>,… 400 400 401 401 //Example~:// 402 402 403 403 en:USD, thousands 467 + 404 404 fr:USD, milliers 405 -)))|( % style="width:321px" %)(((469 +)))|((( 406 406 This is optional, used if an enumerated list is required. 471 + 407 407 <concept Id> 473 + 408 408 //Example~:// 475 + 409 409 UOM_ATTRIBUTE [This concept may contain the following items as units of measure: 410 410 411 411 * National Currency, thousands ... ... @@ -412,128 +412,155 @@ 412 412 * USD, thousands 413 413 414 414 Index, based on National Currency] 415 -)))| (%style="width:185px" %)416 -|( % style="width:243px" %)(((482 +)))| 483 +|((( 417 417 LAYOUT_TIME_PERIOD_DESC 418 -)))|(% style="width:442px" %)Indication that the display of the TIME_PERIOD dimension for a dataflow, or all dataflows of the same DSD, is to be done in descending sort order.|(% style="width:246px" %)Dataflow, DSD|(% style="width:289px" %) |(% style="width:321px" %)((( 485 + 486 + 487 +)))|Indication that the display of the TIME_PERIOD dimension for a dataflow, or all dataflows of the same DSD, is to be done in descending sort order.|Dataflow, DSD| |((( 419 419 //Example~:// 420 420 421 421 LAYOUT_TIME_PERIOD_DESC 422 -)))| (%style="width:185px" %)423 -|( % style="width:243px" %)(((491 +)))| 492 +|((( 424 424 LAYOUT_CELL_ALIGN 425 -)))|(% style="width:442px" %)Indication to force the data cell alignment to the left or to the right. This can be defined generically for all locales or per locale.|(% style="width:246px" %)Dataflow, DSD, Dimension|(% style="width:289px" %)((( 494 + 495 + 496 +)))|Indication to force the data cell alignment to the left or to the right. This can be defined generically for all locales or per locale.|Dataflow, DSD, Dimension|((( 426 426 <language>:<content>, 498 + 427 427 <language>:<content>,… 500 + 501 + 428 428 <content> values:RIGHT or LEFT 429 -)))| (% style="width:321px" %)Content values:RIGHT or LEFT|(%style="width:185px" %)430 -|( % style="width:243px" %)(((503 +)))|Content values:RIGHT or LEFT| 504 +|((( 431 431 MAX_TABLE_DATA 432 -)))|(% style="width:442px" %)Increase the maximum preview table size above default maximum limits for the number of observations retrieved from the SDMX web service and for the number of table cells|(% style="width:246px" %)Dataflow|(% style="width:289px" %) |(% style="width:321px" %)((( 506 + 507 + 508 +)))|Increase the maximum preview table size above default maximum limits for the number of observations retrieved from the SDMX web service and for the number of table cells|Dataflow| |((( 433 433 <integer> 510 + 434 434 //Example~:// 512 + 435 435 15000 436 -)))| (%style="width:185px" %)437 -|( % style="width:243px" %)(((514 +)))| 515 +|((( 438 438 MAXTEXTATTRIBUTELENGTH 439 -)))|(% style="width:442px" %)Increase the maximum length for textual attribute values|(% style="width:246px" %)DSD|(% style="width:289px" %) |(% style="width:321px" %)((( 517 + 518 + 519 +)))|Increase the maximum length for textual attribute values|DSD| |((( 440 440 <integer> 441 441 442 442 //Example~:// 443 443 444 444 500 445 -)))| (%style="width:185px" %)446 -| (% style="width:243px" %)SEARCH_WEIGHT|(% style="width:442px" %)Indication of localised boosted dataflows in the search results when ordered by relevance|(% style="width:246px" %)Dataflow|(% style="width:289px" %)(((525 +)))| 526 +|SEARCH_WEIGHT|Indication of localised boosted dataflows in the search results when ordered by relevance|Dataflow|((( 447 447 <language>:<integer>,... 528 + 448 448 //Example~:// 530 + 449 449 "en":"3","es":"4","fr":"5" 450 -)))|( % style="width:321px" %)(((532 +)))|((( 451 451 <integer> 452 452 453 453 //Example~:// 454 454 455 455 10 456 -)))| (%style="width:185px" %)538 +)))| 457 457 458 458 == Codelist and Statistical Classification-specific Annotations == 459 459 460 -The categories below are used widely, for example by the European Statistical System (ESS), and the United Nations Statistics Division for its central framework classifications ISIC4 {{footnote}}International Standard Industrial Classificationof All Economic Activities{{/footnote}}and CPC{{footnote}}Central ProductClassification{{/footnote}}.542 +The categories below are used widely, for example by the European Statistical System (ESS), and the United Nations Statistics Division for its central framework classifications ISIC4[[~[2~]>>path:#_ftn2]] and CPC[[~[3~]>>path:#_ftn3]]. 461 461 462 -(% style="width:1785.2px" %) 463 -|**Annotation Type**|(% style="width:463px" %)**Use Case**|(% style="width:247px" %)**Where to attach**|(% style="width:332px" %)((( 464 -**+Text 465 -Blue is optional** 466 -)))|(% style="width:224px" %)((( 467 -**Title 468 -Blue is optional** 469 -)))|(% style="width:229px" %)((( 470 -**SDMX 2.1:URL 544 +|Annotation Type|Use Case|Where to attach|((( 545 ++Text 546 + 547 +Blue is optional 548 +)))|((( 549 +Title 550 + 551 +Blue is optional 552 +)))|((( 553 +SDMX 2.1:URL 554 + 471 471 SDMX >=3.0:+URL 472 -Blue is optional** 556 + 557 +Blue is optional 473 473 ))) 474 -|ORIGINAL_CODE| (% style="width:463px" %)Code as displayed in other representations, such as official or original documentation (i.e. possibly containing dots, spaces, etc.). Reference to external standard: skos:notation|(% style="width:247px" %)Item in an Item Scheme|(%style="width:332px" %)|(% style="width:224px" %)(((559 +|ORIGINAL_CODE|Code as displayed in other representations, such as official or original documentation (i.e. possibly containing dots, spaces, etc.). Reference to external standard: skos:notation|Item in an Item Scheme| |((( 475 475 <original code> 561 + 476 476 //Examples~:// 477 477 478 478 * 0105.13 [Harmonized System] 479 479 * 11.2.0.9 [COICOP classification] 480 -)))| (%style="width:229px" %)481 -|HIER_CONTEXT|( % style="width:463px" %)(((566 +)))| 567 +|HIER_CONTEXT|((( 482 482 In SDMX 2.1, a reference between a usage context and a hierarchy (that may be contained in a Hierarchical Codelist (HCL)). 569 + 483 483 In SDMX 3.0, use the HierarchyAssociation artefact 484 -)))| (% style="width:247px" %)DSD or Dataflow|(%style="width:332px" %)|(% style="width:224px" %)(((571 +)))|DSD or Dataflow| |((( 485 485 <component Id>:<HCL Id>.<hierarchy Id> 573 + 486 486 //Example~:// 487 -REF_AREA: OECD.EDU:HCL_REF_AREA(1.0).REF_AREA provides the link to the reference area hierarchy for OECD education data 488 -)))|(% style="width:229px" %) 489 -|HIER_LEVEL|(% style="width:463px" %)((( 575 + 576 +REF_AREA:OECD.EDU:HCL_REF_AREA(1.0).REF_AREA provides the link to the reference area hierarchy for OECD education data 577 +)))| 578 +|HIER_LEVEL|((( 490 490 Explicit specification of the hierarchical level of a code item 491 491 492 492 Reference to external standard: xkos:ClassificationLevel - property: xkos:xdepth url: [[http:~~/~~/data.europa.eu/ux2/nace2.1/sections>>url:http://data.europa.eu/ux2/nace2.1/sections]] 582 + 493 493 text en:sections 494 -)))| (% style="width:247px" %)Code item|(%style="width:332px" %)|(% style="width:224px" %)(((584 +)))|Code item| |((( 495 495 <hierarchical level> 586 + 496 496 //Example~:// 588 + 497 497 1 498 -)))|(% style="width:229px" %) 499 -|SHORT_LABEL|(% style="width:463px" %)A short label, typically for dissemination purposes where long labels are sometimes not appropriate for presentation in tables where space is an important parameter (generally less than 40 or 50 characters)|(% style="width:247px" %)Artefact, or Concept, 500 -or Item in an Item Scheme|(% style="width:332px" %)((( 590 +)))| 591 +|SHORT_LABEL|A short label, typically for dissemination purposes where long labels are sometimes not appropriate for presentation in tables where space is an important parameter (generally less than 40 or 50 characters)|Artefact, or Concept, or Item in an Item Scheme|((( 501 501 <language>:<content>, 502 502 503 503 <language>:<content>,… 504 -)))|( % style="width:224px" %)(((595 +)))|((( 505 505 //Example~:// 506 506 507 507 [Official French label “Transformation et conservation de la viande de boucherie” is shortened to] fr:Transf. & conserv. viande de boucherie 508 508 600 + 509 509 In Codelist=IMF:CL_AREA(1.13) 510 510 Code 4J837 European Union Intellectual Property Office has a Short_Label 511 511 512 512 EN:EUIPO 513 -)))| (%style="width:229px" %)514 -|EXPLAN_LABEL| (% style="width:463px" %)An explanatory text that specifies “other” and similar categories. An example is the Combined Nomenclature classification where the many codes labelled “other” are complemented by a verbose text describing in detail the content of the code item|(% style="width:247px" %)Item in an Item Scheme, mapping to Representation Maps|(% style="width:332px" %)(((605 +)))| 606 +|EXPLAN_LABEL|An explanatory text that specifies “other” and similar categories. An example is the Combined Nomenclature classification where the many codes labelled “other” are complemented by a verbose text describing in detail the content of the code item|Item in an Item Scheme, mapping to Representation Maps|((( 515 515 <language>:<content>, 516 516 517 517 <language>:<content>,… 518 -)))|( % style="width:224px" %)(((610 +)))|((( 519 519 //Example~:// 520 520 521 521 [EU Combined Nomenclature official label for code 3824 99 57 reads “Other”, which is not very informative for the user; instead the EXPLAN_LABEL reads] en:Cartridges and refills, filled, for electronic cigarettes, and preparations for use in the cartridges and refills, not containing nicotine or its salts, ethers, esters or other derivatives thereof 522 -)))| (%style="width:229px" %)523 -|EXPLAN_CONSOL| (% style="width:463px" %)Explanatory notes. An explanatory text to be used when objects included in and excluded from a classification position are consolidated, i.e. are presented together. Reference to external standard: skos:scopeNote|(% style="width:247px" %)Item in an Item Scheme, mapping to Representation Maps|(% style="width:332px" %)(((614 +)))| 615 +|EXPLAN_CONSOL|Explanatory notes. An explanatory text to be used when objects included in and excluded from a classification position are consolidated, i.e. are presented together. Reference to external standard: skos:scopeNote|Item in an Item Scheme, mapping to Representation Maps|((( 524 524 <language>:<content>, 525 525 526 526 <language>:<content>,… 527 -)))|( % style="width:224px" %)(((619 +)))|((( 528 528 Example (from the US NAICS classification): 529 529 530 530 en:Industries in the Food Manufacturing subsector transform livestock and agricultural products into products for intermediate or final consumption. […] The food products manufactured in these establishments are typically sold to wholesalers or retailers for distribution to consumers, but establishments primarily engaged in retailing bakery and candy products made on the premises not for immediate consumption are included. Establishments primarily engaged in manufacturing beverages are classified in Subsector 312, Beverage and Tobacco Product Manufacturing. 531 -)))| (%style="width:229px" %)532 -|EXPLAN_INCLUDES| (% style="width:463px" %)Explanatory notes. Description of those things known specifically to be included in the concept. Synonyms Typical labels for such explanatory notes: "This class includes", "This category includes", "This position includes", "Includes", etc. Reference to external standard: xkos:inclusionNote or xkos:coreContentNote (if EXPLAN_INCLUDES_ALSO available)|(% style="width:247px" %)Item in an Item Scheme, mapping to Representation Maps|(% style="width:332px" %)(((623 +)))| 624 +|EXPLAN_INCLUDES|Explanatory notes. Description of those things known specifically to be included in the concept. Synonyms Typical labels for such explanatory notes: "This class includes", "This category includes", "This position includes", "Includes", etc. Reference to external standard: xkos:inclusionNote or xkos:coreContentNote (if EXPLAN_INCLUDES_ALSO available)|Item in an Item Scheme, mapping to Representation Maps|((( 533 533 <language>:<content>, 626 + 534 534 <language>:<content>,… 535 -)))|( % style="width:224px" %)(((628 +)))|((( 536 536 Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition): 630 + 537 537 en: This class includes: 538 538 539 539 * manufacture of heavy weapons (artillery, mobile guns, rocket launchers, torpedo tubes, heavy machine guns) ... ... @@ -540,20 +540,21 @@ 540 540 * manufacture of small arms (revolvers, shotguns, light machine guns) 541 541 * manufacture of air or gas guns and pistols 542 542 * manufacture of war ammunition 543 -)))| (%style="width:229px" %)544 -|EXPLAN_CASELAW| (% style="width:463px" %)Explanatory notes. Indication that a decision on the classification has been made by the ad hoc Committee (concept generally described as “ruling”, “classification opinion”, classification decision; caselaw). : Reference to external standardxkos:caseLaw. The difference between caselaws and traditional explanatory notes is that caselaws are adopted during the time period between two official versions of a specific classification and have thus a slightly different status (e.g. from a legal viewpoint)|(% style="width:247px" %)Item in an Item Scheme|(% style="width:332px" %)(((637 +)))| 638 +|EXPLAN_CASELAW|Explanatory notes. Indication that a decision on the classification has been made by the ad hoc Committee (concept generally described as “ruling”, “classification opinion”, classification decision; caselaw). : Reference to external standardxkos:caseLaw. The difference between caselaws and traditional explanatory notes is that caselaws are adopted during the time period between two official versions of a specific classification and have thus a slightly different status (e.g. from a legal viewpoint)|Item in an Item Scheme|((( 545 545 <language>:<content>, 640 + 546 546 <language>:<content>,… 547 547 548 548 Example (from NACE Rev. 2 caselaw to code 01.62): 549 549 550 550 en:Automated egg hatching for poultry - Operation of livestock management systems] 551 -)))| (%style="width:224px" %)|(%style="width:229px" %)552 -|EXPLAN_INCLUDES_ALSO| (% style="width:463px" %)Explanatory notes. Description of those things which can be considered as borderline cases and are generally based on consensus rather than strict methodological principles (e.g. classifying wooden shoes as handicraft rather than shoes). Typical labels for such explanatory notes: "This class includes also", "This category includes also", "This position includes also ", "Includes also", etc. Reference to external standard: xkos:additionalContentNote|(% style="width:247px" %)Item in an Item Scheme|(% style="width:332px" %)(((646 +)))| | 647 +|EXPLAN_INCLUDES_ALSO|Explanatory notes. Description of those things which can be considered as borderline cases and are generally based on consensus rather than strict methodological principles (e.g. classifying wooden shoes as handicraft rather than shoes). Typical labels for such explanatory notes: "This class includes also", "This category includes also", "This position includes also ", "Includes also", etc. Reference to external standard: xkos:additionalContentNote|Item in an Item Scheme|((( 553 553 <language>:<content>, 554 554 555 555 <language>:<content>,… 556 -)))|( % style="width:224px" %)(((651 +)))|((( 557 557 Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition): 558 558 559 559 en:This class also includes: ... ... @@ -560,15 +560,16 @@ 560 560 561 561 * manufacture of hunting, sporting or protective firearms and ammunition 562 562 * manufacture of explosive devices such as bombs, mines and torpedoes 563 -)))| (%style="width:229px" %)564 -|EXPLAN_EXCLUDES| (% style="width:463px" %)Explanatory notes. Description of those things which are explicitly excluded from a category. Typical labels for such explanatory notes: "This class excludes", "This category excludes", "This position excludes", "Excludes", etc. Reference to external standards: xkos:exclusionNote|(% style="width:247px" %)(((658 +)))| 659 +|EXPLAN_EXCLUDES|Explanatory notes. Description of those things which are explicitly excluded from a category. Typical labels for such explanatory notes: "This class excludes", "This category excludes", "This position excludes", "Excludes", etc. Reference to external standards: xkos:exclusionNote|((( 565 565 Item in an Item Scheme 566 566 567 567 568 -)))|( % style="width:332px" %)(((663 +)))|((( 569 569 <language>:<content>, 665 + 570 570 <language>:<content>,… 571 -)))|( % style="width:224px" %)(((667 +)))|((( 572 572 Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition): 573 573 574 574 en:This class excludes: ... ... @@ -575,75 +575,87 @@ 575 575 576 576 * manufacture of percussion caps, detonators or signalling flares, see 2029 577 577 * manufacture of cutlasses, swords, bayonets etc., see 2593 578 -)))| (%style="width:229px" %)579 -|MAP_REFER| (% style="width:463px" %)A reference to a classification mapping or transformation, e.g. an SDMX Structure Map. Reference to external standard: skos:mappingRelation (skos:broadMatch, skos:narrowMatch, skos:closeMatch, skos:exactMatch or skos:relatedMatch)|(% style="width:247px" %)Codelist, Concept Scheme, or another Item Scheme|(%style="width:332px" %)|(% style="width:224px" %)Id of an ItemSchemeMap returned by the Annotation URL|(% style="width:229px" %)(((674 +)))| 675 +|MAP_REFER|A reference to a classification mapping or transformation, e.g. an SDMX Structure Map. Reference to external standard: skos:mappingRelation (skos:broadMatch, skos:narrowMatch, skos:closeMatch, skos:exactMatch or skos:relatedMatch)|Codelist, Concept Scheme, or another Item Scheme| |Id of an ItemSchemeMap returned by the Annotation URL|((( 580 580 See section URL value defaults and specific locale values. 581 581 582 582 583 583 ))) 584 -|COMP_RULE| (% style="width:463px" %)Code item composition rule. For example, for code A the composition rule may be “A1+A2” where A1 and A2 are other codes in the same Codelist|(% style="width:247px" %)An Item in an Item Scheme|(%style="width:332px" %)|(% style="width:224px" %)(((680 +|COMP_RULE|Code item composition rule. For example, for code A the composition rule may be “A1+A2” where A1 and A2 are other codes in the same Codelist|An Item in an Item Scheme| |((( 585 585 <content> 586 586 587 587 //Example~:// 588 588 589 589 A1+A2 590 -)))| (%style="width:229px" %)591 -|FOLLOWS|( % style="width:463px" %)(((686 +)))| 687 +|FOLLOWS|((( 592 592 A reference used to express the succession in time of Item Schemes. 689 + 593 593 For example, NACE Rev. 2 is the successor of NACE Rev. 1.1 691 + 594 594 Reference to external standard: skos:ConceptScheme - property: xkos:follows 595 -)))| (% style="width:247px" %)Codelist or Item Scheme|(%style="width:332px" %)|(%style="width:224px" %)|(% style="width:229px" %)(((693 +)))|Codelist or Item Scheme| | |((( 596 596 See section URL value defaults and specific locale values. 695 + 597 597 //Example~:// 697 + 598 598 (CL_REGIONAL 3.1.1 follows CL_REGIONAL 3.1): 599 - [[https:~~/~~/registry.sdmx.org/ws/public/sdmxapi/600 -rest/codelist/ESTAT/CL_REGIONAL/3.1>>url:https://registry.sdmx.org/ws/public/sdmxapi/rest/codelist/ESTAT/CL_REGIONAL/3.1]] 699 + 700 +[[https:~~/~~/registry.sdmx.org/ws/public/sdmxapi/rest/codelist/ESTAT/CL_REGIONAL/3.1>>url:https://registry.sdmx.org/ws/public/sdmxapi/rest/codelist/ESTAT/CL_REGIONAL/3.1]] 601 601 ))) 602 -|HAS_VARIANT|( % style="width:463px" %)(((702 +|HAS_VARIANT|((( 603 603 A reference used to express the relation between an Item Scheme and its variant(s). 704 + 604 604 Reference to external standard: skos:ConceptScheme - property: xkos:variant 605 605 606 606 607 607 For //Example~:// CL_AREA has a variant CL_GEO 608 -)))| (% style="width:247px" %)Codelist or Item Scheme|(%style="width:332px" %)|(%style="width:224px" %)|(% style="width:229px" %)(((709 +)))|Codelist or Item Scheme| | |((( 609 609 See section URL value defaults and specific locale values. 610 610 611 611 612 612 ))) 613 -|SUPERSEED|( % style="width:463px" %)(((714 +|SUPERSEED|((( 614 614 A reference to a previous version, if the current version obsoleted the previous one. 716 + 615 615 May be used in conjunction with DEPRECATED. 718 + 616 616 Reference to external standard: skos:ConceptScheme - property: xkos:supersedes 617 -)))| (% style="width:247px" %)Codelist or Item Scheme, or an artefact|(%style="width:332px" %)|(%style="width:224px" %)|(% style="width:229px" %)(((720 +)))|Codelist or Item Scheme, or an artefact| | |((( 618 618 See section URL value defaults and specific locale values. 619 619 620 620 621 621 ))) 622 -|FAMILY_LABEL|( % style="width:463px" %)(((725 +|FAMILY_LABEL|((( 623 623 Label of the Classification Family (e.g. NACE, ISIC) 727 + 624 624 Reference to external standard: skos:ConceptScheme - property: xkos:belongsTo 729 + 625 625 label of the classification 626 -)))| (% style="width:247px" %)Codelist or Item Scheme|(% style="width:332px" %)(((731 +)))|Codelist or Item Scheme|((( 627 627 <language>:<content>, 733 + 628 628 <language>:<content>,… 629 629 630 630 //Example~:// 737 + 631 631 en:NACE 632 -)))| (%style="width:224px" %)|(% style="width:229px" %)(((739 +)))| |((( 633 633 See section URL value defaults and specific locale values. 634 634 635 635 636 636 ))) 637 -|COVERAGE_LABEL|( % style="width:463px" %)(((744 +|COVERAGE_LABEL|((( 638 638 Label(s) of the item scheme’s coverage (e.g. National Accounts, Products, Activities, Occupations) 746 + 639 639 Reference to external standard: skos:ConceptScheme - property: xkos:covers 640 640 641 641 //Examples~:// 750 + 642 642 URL <http:~/~/eurovoc.europa.eu/56> (National accounts) 643 643 644 -URL 645 -<http:~/~/publications.europa.eu/resource/authority/data-theme/REGI> (Regions and Cities) 646 -)))|(% style="width:247px" %)Codelist or Item Scheme|(% style="width:332px" %)((( 753 +URL <http:~/~/publications.europa.eu/resource/authority/data-theme/REGI> (Regions and Cities) 754 +)))|Codelist or Item Scheme|((( 647 647 <language>:<content>, 648 648 649 649 <language>:<content>,… ... ... @@ -651,35 +651,41 @@ 651 651 //Example~:// 652 652 653 653 En:national accounts 654 -)))| (%style="width:224px" %)|(% style="width:229px" %)(((762 +)))| |((( 655 655 See section URL value defaults and specific locale values. 656 656 657 657 658 658 ))) 659 -|GEO_FEATURE_SET|( % style="width:463px" %)(((660 -In Codelists, transmits GeoFeature values. Example for NUTS ID BE23661 - url:662 - [[http:~~/~~/data.europa.eu/nuts/geometry/2xr1qiv9>>url:http://data.europa.eu/nuts/geometry/2xr1qiv9]]663 - )))|(% style="width:247px" %)Code inaCodelist.TheCodelist musthavean annotation attachedwith AnnotationType664 - ~=GEO_TYPE_GEOGRAPHIC|(%style="width:332px" %)|(% style="width:224px" %)A set of points defining a feature following the 1363 ISO/IEC 13249-3:2016 standard to conform Well-known Text (WKT) for the 1364 representation of geometries. See SDMX STANDARDS: SECTION 6 for further information on the format.|(%style="width:229px" %)665 -|GEO_TYPE_GEOGRAPHIC| (% style="width:463px" %)Indicates that a codelist contains GeoFeature values via the GEO_FEATURE_SET annotation.|(% style="width:247px" %)Codelist|(%style="width:332px" %)|(%style="width:224px" %)|(%style="width:229px" %)666 -|LEGAL_BASIS|( % style="width:463px" %)(((767 +|GEO_FEATURE_SET|((( 768 +In Codelists, transmits GeoFeature values. 769 + 770 +Example for NUTS ID BE23 771 +url:[[http:~~/~~/data.europa.eu/nuts/geometry/2xr1qiv9>>url:http://data.europa.eu/nuts/geometry/2xr1qiv9]] 772 +)))|Code in a Codelist. The Codelist must have an annotation attached with AnnotationType=GEO_TYPE_GEOGRAPHIC| |A set of points defining a feature following the 1363 ISO/IEC 13249-3:2016 standard to conform Well-known Text (WKT) for the 1364 representation of geometries. See SDMX STANDARDS: SECTION 6 for further information on the format.| 773 +|GEO_TYPE_GEOGRAPHIC|Indicates that a codelist contains GeoFeature values via the GEO_FEATURE_SET annotation.|Codelist| | | 774 +|LEGAL_BASIS|((( 667 667 Indicates that the Legislation on which the codelist/nomenclature is based. 776 + 668 668 Example for NACE Rev.2.1 778 + 669 669 url: [[http:~~/~~/data.europa.eu/eli/reg_del/2023/137/oj>>url:http://data.europa.eu/eli/reg_del/2023/137/oj]] 670 -)))| (% style="width:247px" %)Codelist|(%style="width:332px" %)|(%style="width:224px" %)|(% style="width:229px" %)http:~/~/data.europa.eu/eli/reg_del/2023/137/oj780 +)))|Codelist| | |http:~/~/data.europa.eu/eli/reg_del/2023/137/oj 671 671 782 + 783 + 784 + 785 + 672 672 = Concept Scheme SDMX:CS_ANNOT = 673 673 674 674 The Concept Scheme for standard Annotations will have the Maintenance Agency SDMX and will describe the following properties for each Annotation. For the information represented by Annotations, the value is in AnnotationTitle apart from the URL property where it is in AnnotationURL. 675 675 676 -|**Property**| (% style="width:309px" %)**Representation in Concept**|(% style="width:1173px" %)**Description**677 -|**Code**| (% style="width:309px" %)Concept Id|(% style="width:1173px" %)The Annotation Type column, e.g. NOT_DISPLAYED, EXCLUDES678 -|**Name**| (% style="width:309px" %)Concept Name|(% style="width:1173px" %)Short description of the standard Annotation derived from the “Use case” column679 -|**Representation**| (% style="width:309px" %)Concept Core Representation|(% style="width:1173px" %)Allowable type or format for the Annotation680 -|**Description**| (% style="width:309px" %)Concept Description|(% style="width:1173px" %)The information in the “Use case” column. Possible to add more contextual information. Specific details can be described here, such as if the value should be in AnnotationText or AnnotationTitle681 -|**Artefact(s)**| (% style="width:309px" %)Annotation Type: Artefact(s)|(% style="width:1173px" %)The information in the “Where to attach” column682 -|**URL**| (% style="width:309px" %)Annotation Type: URL|(% style="width:1173px" %)The Annotation URL column. The value is in URL790 +|**Property**|**Representation in Concept**|**Description** 791 +|**Code**|Concept Id|The Annotation Type column, e.g. NOT_DISPLAYED, EXCLUDES 792 +|**Name**|Concept Name|Short description of the standard Annotation derived from the “Use case” column 793 +|**Representation**|Concept Core Representation|Allowable type or format for the Annotation 794 +|**Description**|Concept Description|The information in the “Use case” column. Possible to add more contextual information. Specific details can be described here, such as if the value should be in AnnotationText or AnnotationTitle 795 +|**Artefact(s)**|Annotation Type: Artefact(s)|The information in the “Where to attach” column 796 +|**URL**|Annotation Type: URL|The Annotation URL column. The value is in URL 683 683 684 684 == Example of a Concept == 685 685 ... ... @@ -689,6 +689,8 @@ 689 689 |**Concept Description**|To hide dimensions and attributes in a display (e.g. a table). For example, if they have only one allowed, available or selected value 690 690 |**Concept: Annotation: Type: Artefact(s)**|Either a Dataflow or DSD, or an item in an item scheme 691 691 806 +=== === 807 + 692 692 === SDMX-ML of the Example === 693 693 694 694 <str:Concept id="NOT_DISPLAYED"> ... ... @@ -716,4 +716,8 @@ 716 716 717 717 ---- 718 718 719 -{{putFootnotes/}} 835 +[[~[1~]>>path:#_ftnref1]] The technical standard does not enumerate the annotation types, however this guideline provides a recommended enumeration or controlled vocabulary 836 + 837 +[[~[2~]>>path:#_ftnref2]] International Standard Industrial Classification of All Economic Activities 838 + 839 +[[~[3~]>>path:#_ftnref3]] Central Product Classification