Skip to Content
Last modified by Artur K. on 2026/05/29 14:28
From version 1.2
edited by Helena K.
on 2026/01/15 23:02
Change comment: There is no comment for this version
To version 1.1
edited by Helena K.
on 2026/01/15 23:00
Change comment: There is no comment for this version

Summary

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 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" %)(((
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.
53 +
46 46  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.
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" %)(((
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" %)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
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
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,6 +122,7 @@
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 127  |Annotation Type|Use Case|Where to attach|(((
... ... @@ -278,7 +278,7 @@
278 278  Attached to:
279 279  
280 280  - DSD or Dataflow:
281 -**<concept>=<code>+<code>+…,<concept>=<code>+<code>+…**
291 + **<concept>=<code>+<code>+…,<concept>=<code>+<code>+…**
282 282  
283 283  //Example~:// FREQ=A+Q,TIME_PERIOD_START=2013-01,TIME_PERIOD_END=2018-12
284 284  )))|
© Semantic R&D Group, 2026