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,13 +30,6 @@ 30 30 31 31 === SDMX 3.0 === 32 32 33 - 34 -|((( 35 -|((( 36 - 37 -))) 38 -))) 39 - 40 40 [[image:1768507168030-780.png]] 41 41 42 42 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. ... ... @@ -45,25 +45,23 @@ 45 45 46 46 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]]. 47 47 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**|((( 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 vocabulary 43 +|**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" %)((( 52 52 Specifies how the Annotation is to be processed. 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**|((( 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" %)((( 57 57 A link to external descriptive text. 58 - 59 59 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. 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**|((( 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" %)((( 63 63 An International String that provides the multilingual text content of the Annotation. 64 64 65 65 **Text** holds a language-specific string containing the text of the Annotation. 66 -)))|A localised value for the annotation. 57 +)))|(% style="width:710px" %)A localised value for the annotation. 67 67 68 68 = Introducing Standard Annotations = 69 69 ... ... @@ -83,15 +83,15 @@ 83 83 84 84 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”. 85 85 86 -|**id***|**@SDMX**|**@SDMX**|**@SDMX**|((( 77 +|**id***|**@SDMX**|(% style="width:249px" %)**@SDMX**|(% style="width:209px" %)**@SDMX**|(% style="width:888px" %)((( 87 87 **Not @SDMX** 88 88 89 89 This is a “customer order no.” which is a different use case than the ORDER standard Annotation which is a list order 90 90 ))) 91 -|**title**| | | |1934245 92 -|**type***|NOT_DISPLAYED|EXCLUDES|ORDER|ORDER 93 -|(% rowspan="2" %)**+text**|(% rowspan="2" %) |(% rowspan="2" %) |en :10|(% rowspan="2" %) 94 -|fr :20 82 +|**title**| |(% style="width:249px" %) |(% style="width:209px" %) |(% style="width:888px" %)1934245 83 +|**type***|NOT_DISPLAYED|(% style="width:249px" %)EXCLUDES|(% style="width:209px" %)ORDER|(% style="width:888px" %)ORDER 84 +|(% 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 :20 95 95 96 96 ~* denotes a mandatory information for standard Annotations 97 97 ... ... @@ -111,13 +111,13 @@ 111 111 112 112 == Relationships between Annotation properties == 113 113 114 -=== =Text value defaults and specific locale values ====105 +=== Text value defaults and specific locale values === 115 115 116 116 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. 117 117 118 118 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. 119 119 120 -=== =URL value defaults and specific locale values ====111 +=== URL value defaults and specific locale values === 121 121 122 122 ===== SDMX 2.1 and earlier ===== 123 123 ... ... @@ -131,348 +131,290 @@ 131 131 132 132 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. 133 133 134 - 135 135 == General and Display-related Annotation types == 136 136 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 - 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 148 148 SDMX >=3.0:+URL 149 - 150 -Blue is optional 137 +(% style="background-color:transparent" %)Blue is optional(%%)** 151 151 ))) 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 - 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>,… 158 158 //Example~:// 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 - 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> 165 165 //Example~:// 166 - 167 - CUST_BREAKDOWN:CUST_BREAKDOWN_LB168 -)))| 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 - 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> 172 172 //Example~:// 173 - 174 -REF_AREA:M49_CODE 175 -)))| 176 -|COMPLEMENT|((( 156 +(% style="background-color:transparent" %)REF_AREA:M49_CODE 157 +)))|(% style="width:185px" %) 158 +|(% style="width:243px" %)COMPLEMENT|(% style="width:442px" %)((( 177 177 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>,… 178 178 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 - 187 187 //Example~:// 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.)|((( 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" %)((( 192 192 Either: 193 193 194 194 * an artefact, or; 195 195 * an item in an Item Scheme 196 -)))|((( 174 +)))|(% style="width:289px" %)((( 197 197 <language>:<content>, 198 - 199 199 <language>:<content>,… 200 200 201 201 //Example~:// 202 - 203 -en:10,es:20 204 -)))|((( 205 -<content> 206 - 207 - 208 -)))| 209 -|TOTAL|((( 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" %)((( 210 210 Code Item that represents a total value. If the attachment is: 211 211 212 212 * to a Code, the Annotation Text is optional and may contain an explanatory text; 213 - 214 -to a Codelist, the Annotation Title is mandatory and includes the code(s) that represent a total 215 -)))|((( 185 +* to a Codelist, the Annotation Title is mandatory and includes the code(s) that represent a total 186 +)))|(% style="width:246px" %)((( 216 216 Either: 217 217 218 218 * a Code Item that represents a total value, or; 219 219 * a Codelist to specify the code(s) with the total 220 -)))|((( 221 -<language>:<explanatory text>, 222 - 223 -<language>:<explanatory text>,… 224 -)))|((( 191 +)))|(% style="width:289px" %)((( 192 +<language>:<explanatory text>, 193 +(% style="background-color:transparent" %)<language>:<explanatory text>,… 194 +)))|(% style="width:321px" %)((( 225 225 Attached to Code Item: <blank> 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.|((( 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" %)((( 230 230 Either: 231 231 232 232 * A Dataflow or DSD 233 -)))| |((( 202 +)))|(% style="width:289px" %) |(% style="width:321px" %)((( 234 234 <concept Id> 235 - 236 236 //Example~:// 237 - 238 -DD_DIM (this concept should be hidden using the NOT_DISPLAYED Annotation below) 239 -)))| 240 -|DEPRECATED|((( 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" %)((( 241 241 Indication that an Item in an Item Scheme or an artefact is deprecated. 242 - 243 243 For an item scheme item, the annotation value provides a replacement name for the code name. 244 - 245 245 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 - 247 247 Suggestion to use a controlled vocabulary 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 -)))|((( 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" %)((( 256 256 Either: 257 257 258 258 * an artefact, or; 259 259 * an item in an Item Scheme 260 -)))|((( 223 +)))|(% style="width:289px" %)((( 261 261 For item scheme item: 262 262 263 -<language>:<content>, 226 +<language>:<content>,<language>:<content>,… 264 264 265 -<language>:<content>,… 266 - 267 267 //Example~:// 268 - 269 -en:deprecated,fr:obsolète 270 -)))|<content>|((( 229 +(% style="background-color:transparent" %)en:deprecated,fr:obsolète 230 +)))|(% style="width:321px" %)<content>|(% style="width:185px" %)((( 271 271 For artefact: 272 - 273 273 <see section URL value defaults and specific locale values> 274 - 275 - 276 276 ))) 277 -|DEFAULT|((( 234 +|(% style="width:243px" %)DEFAULT|(% style="width:442px" %)((( 278 278 Indication that an item in an Item Scheme or artefacts is to be selected by default. 279 279 280 280 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 281 -)))|((( 238 +)))|(% style="width:246px" %)((( 282 282 * Item in ItemScheme, or; 283 283 * DSD, or; 284 284 * a Dataflow 285 285 286 286 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. 287 -)))| |((( 244 +)))|(% style="width:289px" %) |(% style="width:321px" %)((( 288 288 Attached to: 289 289 290 290 - DSD or Dataflow: 291 - **<concept>=<code>+<code>+…,<concept>=<code>+<code>+…** 248 +**<concept>=<code>+<code>+…, 249 +<concept>=<code>+<code>+…** 292 292 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|((( 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" %)((( 296 296 Either: 297 297 298 298 * an artefact, or; 299 299 * an item in an item scheme 300 -)))|((( 260 +)))|(% style="width:289px" %)((( 301 301 For localised content in SDMX 2.1 302 - 303 303 <language>:<HTML containing URL to the resource>, 304 - 305 305 <language>:<HTML containing URL to the resource>,… 306 306 307 307 //Example~:// 308 - 309 309 en:<a href=”https:~/~/sdmx.org/wp-content/uploads/SDMX_map_small-220x220.jpg”> 310 -)))| |((( 267 +)))|(% style="width:321px" %) |(% style="width:185px" %)((( 311 311 See section URL value defaults and specific locale values. 312 312 313 313 //Example~:// 314 314 315 -https:~/~/sdmx.org/wp-content/uploads/SDMX_map_small-220x220.jpg 316 - 317 - 272 +https:~/~/sdmx.org/wp-content/uploads/SDMX_map_ 273 +small-220x220.jpg 318 318 ))) 319 -|DRILLDOWN_CONCEPTS|Concepts to be displayed in a drilldown operation|Dataflow or DSD| |((( 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" %)((( 320 320 <concept Id>,<concept Id>,… 321 321 322 322 Example : 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|((( 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" %)((( 327 327 Either: 328 328 329 329 * a Dataflow or DSD, or; 330 330 * an Item in an Item Scheme 331 -)))| |((( 286 +)))|(% style="width:289px" %) |(% style="width:321px" %)((( 332 332 Attached to Item in Item Scheme: <blank> 333 333 334 334 Attached to Dataflow or DSD: 335 - 336 336 <concept Id>,<concept Id>,… 337 - 338 338 Example : 339 - 340 340 DD_DIM (to hide drilldown control concept) 341 -)))| 342 -|LAYOUT_ROW|Dimensions to be presented in rows (concepts on y-axis)|((( 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" %)((( 343 343 Either: 344 344 345 345 * an artefact, or; 346 346 * a Dimension 347 -)))| |((( 299 +)))|(% style="width:289px" %) |(% style="width:321px" %)((( 348 348 Attached to Dimension: <blank> 349 349 350 350 Attached to Dataflow or DSD: <dimension Id>,<dimension Id >,… 351 351 352 352 //Example~:// 353 - 354 354 REF_AREA,MEASURE 355 -)))| 356 -|LAYOUT_COLUMN|Dimensions to be presented in columns (concepts on x-axis)|((( 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" %)((( 357 357 Either: 358 358 359 359 * an artefact, or; 360 -* a Dimension 361 -)))| |((( 311 + 312 +a Dimension 313 +)))|(% style="width:289px" %) |(% style="width:321px" %)((( 362 362 Attached to Dimension: <blank> 363 363 364 364 Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,… 365 365 366 366 //Example~:// 367 - 368 368 TIME_PERIOD 369 -)))| 370 -|LAYOUT_FLAG|Indication that an attribute and its attribute value should be presented as a flag|Dataflow| |((( 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" %)((( 371 371 <concept Id>,<concept Id>,... 372 372 373 373 //Example~:// 374 - 375 375 OBS_STATUS,CONF_STATUS 376 -)))| 377 -|LAYOUT_NOTE|Indication that an attribute and its attribute value should be presented as a note|Dataflow| |(((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" %)((( 378 378 <concept Id>,<concept Id>,... 379 379 380 380 //Example~:// 381 - 382 382 OBS_STATUS,CONF_STATUS 383 -)))| 384 -|((( 332 +)))|(% style="width:185px" %) 333 +|(% style="width:243px" %)((( 385 385 METADATA 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.|((( 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" %)((( 390 390 Either: 391 391 392 392 * an artefact, or; 393 - 394 -a Dimension 395 -)))| |((( 341 +* a Dimension 342 +)))|(% style="width:289px" %) |(% style="width:321px" %)((( 396 396 Attached to Dimension: <blank> 397 - 398 -Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,… 399 - 344 +~|Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,… 400 400 //Example~:// 401 - 402 402 SEX 403 -)))| 404 -|EXT_RESOURCE|((( 347 +)))|(% style="width:185px" %) 348 +|(% style="width:243px" %)EXT_RESOURCE|(% style="width:442px" %)((( 405 405 A localised link to an external resource associated to the annotated artefact. For example, an ontology item 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|((( 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" %)((( 409 409 For localised content in SDMX 2.1 410 - 411 - <language>:<HTML containing URL to the resource>, 412 - 353 +<language>:<HTML containing URL to the resource>, 413 413 <language>:<HTML containing URL to the resource>,… 414 414 415 415 //Example~:// 416 - 417 417 en:<a href=”[[http:~~/~~/rdf-vocabulary.ddialliance.org/xkos#depth>>url:http://rdf-vocabulary.ddialliance.org/xkos#depth]]”> 418 -)))| |((( 358 +)))|(% style="width:321px" %) |(% style="width:185px" %)((( 419 419 See section URL value defaults and specific locale values. 420 420 421 421 //Example~:// 422 422 423 -http:~/~/rdf-vocabulary.ddialliance.org/xkos#depth 363 +http:~/~/rdf-vocabulary.ddialliance.org/ 364 +xkos#depth 424 424 ))) 425 -|COMBINED_CONCEPTS|((( 366 +|(% style="width:243px" %)COMBINED_CONCEPTS|(% style="width:442px" %)((( 426 426 Comma-separated list of concept IDs to show as a concatenated label. 427 - 428 428 The listed concepts’ item contents may be concatenated to generate the target concept. 429 - 430 430 Multiple target concept combinations can be defined by separating the target concepts by ; 431 -)))|Dataflow or DSD|((( 370 +)))|(% style="width:246px" %)Dataflow or DSD|(% style="width:289px" %)((( 432 432 <language>:<display name>, 433 - 434 434 <language>:<display name> 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|((( 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" %)((( 439 439 Comma-separated list of concept IDs that is used to define the full unit of measure. The concepts must be in the DSD. 440 440 441 441 The listed concepts’ item contents may be concatenated to generate the unit of measure label (unless the UNIT_MEASURE_LABEL annotation is present). 442 -)))|Dataflow or DSD| |((( 380 +)))|(% style="width:246px" %)Dataflow or DSD|(% style="width:289px" %) |(% style="width:321px" %)((( 443 443 <concept Id>,<concept Id>,… 444 444 445 -//Example~:// UNIT_MEASURE,UNIT_MULT, TRANSFORMATION [could generate a value of Australian Dollar, Thousands, Non-transformed]446 - )))|447 -|( deprecated)UNIT_MEASURE_LABEL|(((448 - Indicatesthe conceptthatenumeratesthefull unitof measure labels.449 - 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. 450 450 The concept must be in the DSD. UNIT_MEASURE_LABEL overrides the UNIT_MEASURE_CONCEPTS if both are provided. 451 451 452 452 Also can be attached to items in item scheme, e.g. 453 453 454 -Text en:Gram455 - fr: Gramme392 +Text en:Gram 393 + fr: Gramme 456 456 url:** **[[**http:~~/~~/data.europa.eu/gzn/su/G**>>url:http://data.europa.eu/gzn/su/G]] 457 -)))|Dataflow or DSD, Item in an Item Scheme|((( 395 +)))|(% style="width:246px" %)Dataflow or DSD, Item in an Item Scheme|(% style="width:289px" %)((( 458 458 This is optional, used if a freetext label is required. 459 459 460 460 <language>:<content>, 461 - 462 462 <language>:<content>,… 463 463 464 464 //Example~:// 465 465 466 466 en:USD, thousands 467 - 468 468 fr:USD, milliers 469 -)))|((( 405 +)))|(% style="width:321px" %)((( 470 470 This is optional, used if an enumerated list is required. 471 - 472 472 <concept Id> 473 - 474 474 //Example~:// 475 - 476 476 UOM_ATTRIBUTE [This concept may contain the following items as units of measure: 477 477 478 478 * National Currency, thousands ... ... @@ -479,155 +479,128 @@ 479 479 * USD, thousands 480 480 481 481 Index, based on National Currency] 482 -)))| 483 -|((( 415 +)))|(% style="width:185px" %) 416 +|(% style="width:243px" %)((( 484 484 LAYOUT_TIME_PERIOD_DESC 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| |((( 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" %)((( 488 488 //Example~:// 489 489 490 490 LAYOUT_TIME_PERIOD_DESC 491 -)))| 492 -|((( 422 +)))|(% style="width:185px" %) 423 +|(% style="width:243px" %)((( 493 493 LAYOUT_CELL_ALIGN 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|((( 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" %)((( 497 497 <language>:<content>, 498 - 499 499 <language>:<content>,… 500 - 501 - 502 502 <content> values:RIGHT or LEFT 503 -)))|Content values:RIGHT or LEFT| 504 -|((( 429 +)))|(% style="width:321px" %)Content values:RIGHT or LEFT|(% style="width:185px" %) 430 +|(% style="width:243px" %)((( 505 505 MAX_TABLE_DATA 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| |((( 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" %)((( 509 509 <integer> 510 - 511 511 //Example~:// 512 - 513 513 15000 514 -)))| 515 -|((( 436 +)))|(% style="width:185px" %) 437 +|(% style="width:243px" %)((( 516 516 MAXTEXTATTRIBUTELENGTH 517 - 518 - 519 -)))|Increase the maximum length for textual attribute values|DSD| |((( 439 +)))|(% style="width:442px" %)Increase the maximum length for textual attribute values|(% style="width:246px" %)DSD|(% style="width:289px" %) |(% style="width:321px" %)((( 520 520 <integer> 521 521 522 522 //Example~:// 523 523 524 524 500 525 -)))| 526 -|SEARCH_WEIGHT|Indication of localised boosted dataflows in the search results when ordered by relevance|Dataflow|((( 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" %)((( 527 527 <language>:<integer>,... 528 - 529 529 //Example~:// 530 - 531 531 "en":"3","es":"4","fr":"5" 532 -)))|((( 450 +)))|(% style="width:321px" %)((( 533 533 <integer> 534 534 535 535 //Example~:// 536 536 537 537 10 538 -)))| 456 +)))|(% style="width:185px" %) 539 539 540 540 == Codelist and Statistical Classification-specific Annotations == 541 541 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]].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 Classification of All Economic Activities{{/footnote}} and CPC{{footnote}}Central Product Classification{{/footnote}}. 543 543 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 - 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 555 555 SDMX >=3.0:+URL 556 - 557 -Blue is optional 472 +Blue is optional** 558 558 ))) 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| |((( 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" %)((( 560 560 <original code> 561 - 562 562 //Examples~:// 563 563 564 564 * 0105.13 [Harmonized System] 565 565 * 11.2.0.9 [COICOP classification] 566 -)))| 567 -|HIER_CONTEXT|((( 480 +)))|(% style="width:229px" %) 481 +|HIER_CONTEXT|(% style="width:463px" %)((( 568 568 In SDMX 2.1, a reference between a usage context and a hierarchy (that may be contained in a Hierarchical Codelist (HCL)). 569 - 570 570 In SDMX 3.0, use the HierarchyAssociation artefact 571 -)))|DSD or Dataflow| |((( 484 +)))|(% style="width:247px" %)DSD or Dataflow|(% style="width:332px" %) |(% style="width:224px" %)((( 572 572 <component Id>:<HCL Id>.<hierarchy Id> 573 - 574 574 //Example~:// 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|((( 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" %)((( 579 579 Explicit specification of the hierarchical level of a code item 580 580 581 581 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 - 583 583 text en:sections 584 -)))|Code item| |((( 494 +)))|(% style="width:247px" %)Code item|(% style="width:332px" %) |(% style="width:224px" %)((( 585 585 <hierarchical level> 586 - 587 587 //Example~:// 588 - 589 589 1 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|((( 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" %)((( 592 592 <language>:<content>, 593 593 594 594 <language>:<content>,… 595 -)))|((( 504 +)))|(% style="width:224px" %)((( 596 596 //Example~:// 597 597 598 598 [Official French label “Transformation et conservation de la viande de boucherie” is shortened to] fr:Transf. & conserv. viande de boucherie 599 599 600 - 601 601 In Codelist=IMF:CL_AREA(1.13) 602 602 Code 4J837 European Union Intellectual Property Office has a Short_Label 603 603 604 604 EN:EUIPO 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|((( 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" %)((( 607 607 <language>:<content>, 608 608 609 609 <language>:<content>,… 610 -)))|((( 518 +)))|(% style="width:224px" %)((( 611 611 //Example~:// 612 612 613 613 [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 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|((( 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" %)((( 616 616 <language>:<content>, 617 617 618 618 <language>:<content>,… 619 -)))|((( 527 +)))|(% style="width:224px" %)((( 620 620 Example (from the US NAICS classification): 621 621 622 622 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. 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|(((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" %)((( 625 625 <language>:<content>, 626 - 627 627 <language>:<content>,… 628 -)))|((( 535 +)))|(% style="width:224px" %)((( 629 629 Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition): 630 - 631 631 en: This class includes: 632 632 633 633 * manufacture of heavy weapons (artillery, mobile guns, rocket launchers, torpedo tubes, heavy machine guns) ... ... @@ -634,21 +634,20 @@ 634 634 * manufacture of small arms (revolvers, shotguns, light machine guns) 635 635 * manufacture of air or gas guns and pistols 636 636 * manufacture of war ammunition 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|((( 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" %)((( 639 639 <language>:<content>, 640 - 641 641 <language>:<content>,… 642 642 643 643 Example (from NACE Rev. 2 caselaw to code 01.62): 644 644 645 645 en:Automated egg hatching for poultry - Operation of livestock management systems] 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|((( 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" %)((( 648 648 <language>:<content>, 649 649 650 650 <language>:<content>,… 651 -)))|((( 556 +)))|(% style="width:224px" %)((( 652 652 Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition): 653 653 654 654 en:This class also includes: ... ... @@ -655,16 +655,15 @@ 655 655 656 656 * manufacture of hunting, sporting or protective firearms and ammunition 657 657 * manufacture of explosive devices such as bombs, mines and torpedoes 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|((( 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" %)((( 660 660 Item in an Item Scheme 661 661 662 662 663 -)))|((( 568 +)))|(% style="width:332px" %)((( 664 664 <language>:<content>, 665 - 666 666 <language>:<content>,… 667 -)))|((( 571 +)))|(% style="width:224px" %)((( 668 668 Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition): 669 669 670 670 en:This class excludes: ... ... @@ -671,87 +671,75 @@ 671 671 672 672 * manufacture of percussion caps, detonators or signalling flares, see 2029 673 673 * manufacture of cutlasses, swords, bayonets etc., see 2593 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|((( 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" %)((( 676 676 See section URL value defaults and specific locale values. 677 677 678 678 679 679 ))) 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| |((( 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" %)((( 681 681 <content> 682 682 683 683 //Example~:// 684 684 685 685 A1+A2 686 -)))| 687 -|FOLLOWS|((( 590 +)))|(% style="width:229px" %) 591 +|FOLLOWS|(% style="width:463px" %)((( 688 688 A reference used to express the succession in time of Item Schemes. 689 - 690 690 For example, NACE Rev. 2 is the successor of NACE Rev. 1.1 691 - 692 692 Reference to external standard: skos:ConceptScheme - property: xkos:follows 693 -)))|Codelist or Item Scheme| | |((( 595 +)))|(% style="width:247px" %)Codelist or Item Scheme|(% style="width:332px" %) |(% style="width:224px" %) |(% style="width:229px" %)((( 694 694 See section URL value defaults and specific locale values. 695 - 696 696 //Example~:// 697 - 698 698 (CL_REGIONAL 3.1.1 follows 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]]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]] 701 701 ))) 702 -|HAS_VARIANT|((( 602 +|HAS_VARIANT|(% style="width:463px" %)((( 703 703 A reference used to express the relation between an Item Scheme and its variant(s). 704 - 705 705 Reference to external standard: skos:ConceptScheme - property: xkos:variant 706 706 707 707 708 708 For //Example~:// CL_AREA has a variant CL_GEO 709 -)))|Codelist or Item Scheme| | |((( 608 +)))|(% style="width:247px" %)Codelist or Item Scheme|(% style="width:332px" %) |(% style="width:224px" %) |(% style="width:229px" %)((( 710 710 See section URL value defaults and specific locale values. 711 711 712 712 713 713 ))) 714 -|SUPERSEED|((( 613 +|SUPERSEED|(% style="width:463px" %)((( 715 715 A reference to a previous version, if the current version obsoleted the previous one. 716 - 717 717 May be used in conjunction with DEPRECATED. 718 - 719 719 Reference to external standard: skos:ConceptScheme - property: xkos:supersedes 720 -)))|Codelist or Item Scheme, or an artefact| | |((( 617 +)))|(% style="width:247px" %)Codelist or Item Scheme, or an artefact|(% style="width:332px" %) |(% style="width:224px" %) |(% style="width:229px" %)((( 721 721 See section URL value defaults and specific locale values. 722 722 723 723 724 724 ))) 725 -|FAMILY_LABEL|((( 622 +|FAMILY_LABEL|(% style="width:463px" %)((( 726 726 Label of the Classification Family (e.g. NACE, ISIC) 727 - 728 728 Reference to external standard: skos:ConceptScheme - property: xkos:belongsTo 729 - 730 730 label of the classification 731 -)))|Codelist or Item Scheme|((( 626 +)))|(% style="width:247px" %)Codelist or Item Scheme|(% style="width:332px" %)((( 732 732 <language>:<content>, 733 - 734 734 <language>:<content>,… 735 735 736 736 //Example~:// 737 - 738 738 en:NACE 739 -)))| |((( 632 +)))|(% style="width:224px" %) |(% style="width:229px" %)((( 740 740 See section URL value defaults and specific locale values. 741 741 742 742 743 743 ))) 744 -|COVERAGE_LABEL|((( 637 +|COVERAGE_LABEL|(% style="width:463px" %)((( 745 745 Label(s) of the item scheme’s coverage (e.g. National Accounts, Products, Activities, Occupations) 746 - 747 747 Reference to external standard: skos:ConceptScheme - property: xkos:covers 748 748 749 749 //Examples~:// 750 - 751 751 URL <http:~/~/eurovoc.europa.eu/56> (National accounts) 752 752 753 -URL <http:~/~/publications.europa.eu/resource/authority/data-theme/REGI> (Regions and Cities) 754 -)))|Codelist or Item Scheme|((( 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" %)((( 755 755 <language>:<content>, 756 756 757 757 <language>:<content>,… ... ... @@ -759,41 +759,35 @@ 759 759 //Example~:// 760 760 761 761 En:national accounts 762 -)))| |((( 654 +)))|(% style="width:224px" %) |(% style="width:229px" %)((( 763 763 See section URL value defaults and specific locale values. 764 764 765 765 766 766 ))) 767 -|GEO_FEATURE_SET|((( 768 -In Codelists, transmits GeoFeature values. 769 - 770 - ExampleforNUTS ID BE23771 - 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|((( 659 +|GEO_FEATURE_SET|(% style="width:463px" %)((( 660 +In Codelists, transmits GeoFeature values.Example for NUTS ID BE23 661 +url: 662 +[[http:~~/~~/data.europa.eu/nuts/geometry/2xr1qiv9>>url:http://data.europa.eu/nuts/geometry/2xr1qiv9]] 663 +)))|(% style="width:247px" %)Code in a Codelist. The Codelist must have an annotation attached with AnnotationType 664 +~=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" %)((( 775 775 Indicates that the Legislation on which the codelist/nomenclature is based. 776 - 777 777 Example for NACE Rev.2.1 778 - 779 779 url: [[http:~~/~~/data.europa.eu/eli/reg_del/2023/137/oj>>url:http://data.europa.eu/eli/reg_del/2023/137/oj]] 780 -)))|Codelist| | |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/oj 781 781 782 - 783 - 784 - 785 - 786 786 = Concept Scheme SDMX:CS_ANNOT = 787 787 788 788 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. 789 789 790 -|**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 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, EXCLUDES 678 +|**Name**|(% style="width:309px" %)Concept Name|(% style="width:1173px" %)Short description of the standard Annotation derived from the “Use case” column 679 +|**Representation**|(% style="width:309px" %)Concept Core Representation|(% style="width:1173px" %)Allowable type or format for the Annotation 680 +|**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 AnnotationTitle 681 +|**Artefact(s)**|(% style="width:309px" %)Annotation Type: Artefact(s)|(% style="width:1173px" %)The information in the “Where to attach” column 682 +|**URL**|(% style="width:309px" %)Annotation Type: URL|(% style="width:1173px" %)The Annotation URL column. The value is in URL 797 797 798 798 == Example of a Concept == 799 799 ... ... @@ -803,8 +803,6 @@ 803 803 |**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 804 804 |**Concept: Annotation: Type: Artefact(s)**|Either a Dataflow or DSD, or an item in an item scheme 805 805 806 -=== === 807 - 808 808 === SDMX-ML of the Example === 809 809 810 810 <str:Concept id="NOT_DISPLAYED"> ... ... @@ -832,8 +832,4 @@ 832 832 833 833 ---- 834 834 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 719 +{{putFootnotes/}}