Changes for page Guidelines on Using SDMX Annotations

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 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.
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" %)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,138 +122,669 @@
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		-== ==
	137	+|Annotation Type|Use Case|Where to attach|(((
	138	++Text
128	128
129		-|**Annotation Type**|(% style="width:524px" %)**Use Case**|(% style="width:198px" %)**Where to attach**|(% style="width:237px" %)(((
130		-**+Text
131		-(% style="background-color:transparent" %)Blue is optional(%%)**
132		-)))|(% style="width:320px" %)(((
133		-**Title
134		-(% style="background-color:transparent" %)Blue is optional(%%)**
135		-)))|(% style="width:203px" %)(((
136		-**SDMX 2.1:URL
	140	+Blue is optional
	141	+)))|(((
	142	+Title
	143	+
	144	+Blue is optional
	145	+)))|(((
	146	+SDMX 2.1:URL
	147	+
137	137	SDMX >=3.0:+URL
138		-(% style="background-color:transparent" %)Blue is optional(%%)**
	149	+
	150	+Blue is optional
139	139	)))
140		-|FULL_NAME|(% style="width:524px" %)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
141		-en: A0123 Growing of citrus fruits|(% style="width:198px" %)Item in an Item Scheme|(% style="width:237px" %)(((
142		-<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	+
143	143	//Example~://
144		-(% style="background-color:transparent" %)en:Labour force (Employment)
145		-)))|(% style="width:320px" %)<content>|(% style="width:203px" %)
146		-|REPLACE_NAME|(% style="width:524px" %)Replace each code name in a component by the value of another component in an observation or series|(% style="width:198px" %)A Dataflow or DSD|(% style="width:237px" %) |(% style="width:320px" %)(((
	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| |(((
147	147	<component Id to replace name>:<component Id to use name>
	164	+
148	148	//Example~://
149		-(% style="background-color:transparent" %)CUST_BREAKDOWN:CUST_BREAKDOWN_LB
150		-)))|(% style="width:203px" %)
151		-|REPLACE_CONTENT|(% style="width:524px" %)Replace the content in a component by the value of another component in an observation or series|(% style="width:198px" %)A Dataflow or DSD|(% style="width:237px" %) |(% style="width:320px" %)(((
	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| |(((
152	152	<component Id to replace content>:<component Id to use content>
	171	+
153	153	//Example~://
154		-(% style="background-color:transparent" %)REF_AREA:M49_CODE
155		-)))|(% style="width:203px" %)
156		-|COMPLEMENT|(% style="width:524px" %)(((
	173	+
	174	+REF_AREA:M49_CODE
	175	+)))|
	176	+|COMPLEMENT|(((
157	157	Additional fixed text to be displayed in parenthesis after the code name.
158		-(% style="background-color:transparent" %)E.g. Representation of Non-hazardous (NHAZW), hazardous waste (HAZW) in the European List of Wastes(%%)
159		-(% style="background-color:transparent" %)en: 01 03 04* acid-generating tailings from processing of sulphide ore (HAZW)(%%)
160		-(% style="background-color:transparent" %)en: 01 03 99 wastes not otherwise specified (NHAZW)
161		-)))|(% style="width:198px" %)Item in an Item Scheme|(% style="width:237px" %)(((
162		-<language>:<content>,<language>:<content>,…
163	163
	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	+
164	164	//Example~://
165		-(% style="background-color:transparent" %)en:See reference metadata
166		-)))|(% style="width:320px" %)<content>|(% style="width:203px" %)
167		-|ORDER|(% style="width:524px" %)Explicit indication of a localised order of items in Items Schemes or artefacts (e.g. Codelist, Concept Scheme, Category Scheme, Dataflow, etc.)|(% style="width:198px" %)(((
	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.)|(((
168	168	Either:
169	169
170	170	* an artefact, or;
171	171	* an item in an Item Scheme
172		-)))|(% style="width:237px" %)(((
173		-<language>:<content>,<language>:<content>,…
	196	+)))|(((
	197	+<language>:<content>,
174	174
	199	+<language>:<content>,…
	200	+
175	175	//Example~://
176		-(% style="background-color:transparent" %)en:10,es:20
177		-)))|(% style="width:320px" %)<content>|(% style="width:203px" %)
178		-|TOTAL|(% style="width:524px" %)(((
	202	+
	203	+en:10,es:20
	204	+)))|(((
	205	+<content>
	206	+
	207	+
	208	+)))|
	209	+|TOTAL|(((
179	179	Code Item that represents a total value. If the attachment is:
180	180
181	181	* to a Code, the Annotation Text is optional and may contain an explanatory text;
182		-* to a Codelist, the Annotation Title is mandatory and includes the code(s) that represent a total
183		-)))|(% style="width:198px" %)(((
	213	+
	214	+to a Codelist, the Annotation Title is mandatory and includes the code(s) that represent a total
	215	+)))|(((
184	184	Either:
185	185
186	186	* a Code Item that represents a total value, or;
187	187	* a Codelist to specify the code(s) with the total
188		-)))|(% style="width:237px" %)(((
189		-<language>:<explanatory text>,
190		-(% style="background-color:transparent" %)<language>:<explanatory text>,…
191		-)))|(% style="width:320px" %)(((
	220	+)))|(((
	221	+<language>:<explanatory text>,
	222	+
	223	+<language>:<explanatory text>,…
	224	+)))|(((
192	192	Attached to Code Item: <blank>
193		-(% style="background-color:transparent" %)Attached to Codelist: <code>,<code>,…
194		-)))|(% style="width:203px" %)
195		-|DRILLDOWN|(% style="width:524px" %)Denotes the concept that specifies whether observations are at the aggregate level or a drilldown.|(% style="width:198px" %)(((
	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	196	Either:
197	197
198	198	* A Dataflow or DSD
199		-)))|(% style="width:237px" %) |(% style="width:320px" %)(((
	233	+)))| |(((
200	200	<concept Id>
	235	+
201	201	//Example~://
202		-(% style="background-color:transparent" %)DD_DIM (this concept should be hidden using the NOT_DISPLAYED Annotation below)
203		-)))|(% style="width:203px" %)
204		-|DEPRECATED|(% style="width:524px" %)(((
	237	+
	238	+DD_DIM (this concept should be hidden using the NOT_DISPLAYED Annotation below)
	239	+)))|
	240	+|DEPRECATED|(((
205	205	Indication that an Item in an Item Scheme or an artefact is deprecated.
	242	+
206	206	For an item scheme item, the annotation value provides a replacement name for the code name.
	244	+
207	207	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	+
208	208	Suggestion to use a controlled vocabulary
	248	+
209	209	url: <[[http:~~/~~/publications.europa.eu/resource/authority/concept-status/CURRENT>>url:http://publications.europa.eu/resource/authority/concept-status/CURRENT]]>
210	210	url: <[[http:~~/~~/publications.europa.eu/resource/authority/concept-status/DEPRECATED>>url:http://publications.europa.eu/resource/authority/concept-status/DEPRECATED]]>
211		-or
212		-(% style="background-color:transparent" %)TITLE: true (false)
213		-)))|(% style="width:198px" %)(((
	251	+
	252	+or
	253	+
	254	+TITLE: true (false)
	255	+)))|(((
214	214	Either:
215	215
216	216	* an artefact, or;
217	217	* an item in an Item Scheme
218		-)))|(% style="width:237px" %)(((
	260	+)))|(((
219	219	For item scheme item:
220	220
221		-<language>:<content>,<language>:<content>,…
	263	+<language>:<content>,
222	222
	265	+<language>:<content>,…
	266	+
223	223	//Example~://
224		-(% style="background-color:transparent" %)en:deprecated,fr:obsolète
225		-)))|(% style="width:320px" %)<content>|(% style="width:203px" %)(((
	268	+
	269	+en:deprecated,fr:obsolète
	270	+)))|<content>|(((
226	226	For artefact:
	272	+
227	227	<see section URL value defaults and specific locale values>
	274	+
	275	+
228	228	)))
229		-| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
230		-| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
231		-| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
232		-| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
233		-| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
234		-| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
235		-| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
236		-| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
237		-| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
238		-| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
239		-| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
	277	+|DEFAULT|(((
	278	+Indication that an item in an Item Scheme or artefacts is to be selected by default.
240	240
	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	+)))|(((
	282	+* Item in ItemScheme, or;
	283	+* DSD, or;
	284	+* a Dataflow
	285	+
	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	+)))| |(((
	288	+Attached to:
	289	+
	290	+- DSD or Dataflow:
	291	+ **<concept>=<code>+<code>+…,<concept>=<code>+<code>+…**
	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|(((
	296	+Either:
	297	+
	298	+* an artefact, or;
	299	+* an item in an item scheme
	300	+)))|(((
	301	+For localised content in SDMX 2.1
	302	+
	303	+<language>:<HTML containing URL to the resource>,
	304	+
	305	+<language>:<HTML containing URL to the resource>,…
	306	+
	307	+//Example~://
	308	+
	309	+en:<a href=”https:~/~/sdmx.org/wp-content/uploads/SDMX_map_small-220x220.jpg”>
	310	+)))| |(((
	311	+See section URL value defaults and specific locale values.
	312	+
	313	+//Example~://
	314	+
	315	+https:~/~/sdmx.org/wp-content/uploads/SDMX_map_small-220x220.jpg
	316	+
	317	+
	318	+)))
	319	+|DRILLDOWN_CONCEPTS|Concepts to be displayed in a drilldown operation|Dataflow or DSD| |(((
	320	+<concept Id>,<concept Id>,…
	321	+
	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|(((
	327	+Either:
	328	+
	329	+* a Dataflow or DSD, or;
	330	+* an Item in an Item Scheme
	331	+)))| |(((
	332	+Attached to Item in Item Scheme: <blank>
	333	+
	334	+Attached to Dataflow or DSD:
	335	+
	336	+<concept Id>,<concept Id>,…
	337	+
	338	+Example :
	339	+
	340	+DD_DIM (to hide drilldown control concept)
	341	+)))|
	342	+|LAYOUT_ROW|Dimensions to be presented in rows (concepts on y-axis)|(((
	343	+Either:
	344	+
	345	+* an artefact, or;
	346	+* a Dimension
	347	+)))| |(((
	348	+Attached to Dimension: <blank>
	349	+
	350	+Attached to Dataflow or DSD: <dimension Id>,<dimension Id >,…
	351	+
	352	+//Example~://
	353	+
	354	+REF_AREA,MEASURE
	355	+)))|
	356	+|LAYOUT_COLUMN|Dimensions to be presented in columns (concepts on x-axis)|(((
	357	+Either:
	358	+
	359	+* an artefact, or;
	360	+* a Dimension
	361	+)))| |(((
	362	+Attached to Dimension: <blank>
	363	+
	364	+Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,…
	365	+
	366	+//Example~://
	367	+
	368	+TIME_PERIOD
	369	+)))|
	370	+|LAYOUT_FLAG|Indication that an attribute and its attribute value should be presented as a flag|Dataflow| |(((
	371	+<concept Id>,<concept Id>,...
	372	+
	373	+//Example~://
	374	+
	375	+OBS_STATUS,CONF_STATUS
	376	+)))|
	377	+|LAYOUT_NOTE|Indication that an attribute and its attribute value should be presented as a note|Dataflow| |(((
	378	+<concept Id>,<concept Id>,...
	379	+
	380	+//Example~://
	381	+
	382	+OBS_STATUS,CONF_STATUS
	383	+)))|
	384	+|(((
	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.|(((
	390	+Either:
	391	+
	392	+* an artefact, or;
	393	+
	394	+a Dimension
	395	+)))| |(((
	396	+Attached to Dimension: <blank>
	397	+
	398	+Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,…
	399	+
	400	+//Example~://
	401	+
	402	+SEX
	403	+)))|
	404	+|EXT_RESOURCE|(((
	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|(((
	409	+For localised content in SDMX 2.1
	410	+
	411	+ <language>:<HTML containing URL to the resource>,
	412	+
	413	+<language>:<HTML containing URL to the resource>,…
	414	+
	415	+//Example~://
	416	+
	417	+en:<a href=”[[http:~~/~~/rdf-vocabulary.ddialliance.org/xkos#depth>>url:http://rdf-vocabulary.ddialliance.org/xkos#depth]]”>
	418	+)))| |(((
	419	+See section URL value defaults and specific locale values.
	420	+
	421	+//Example~://
	422	+
	423	+http:~/~/rdf-vocabulary.ddialliance.org/xkos#depth
	424	+)))
	425	+|COMBINED_CONCEPTS|(((
	426	+Comma-separated list of concept IDs to show as a concatenated label.
	427	+
	428	+The listed concepts’ item contents may be concatenated to generate the target concept.
	429	+
	430	+Multiple target concept combinations can be defined by separating the target concepts by ;
	431	+)))|Dataflow or DSD|(((
	432	+<language>:<display name>,
	433	+
	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|(((
	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	+
	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| |(((
	443	+<concept Id>,<concept Id>,…
	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	+Indicates the concept that enumerates the full unit of measure labels.
	449	+
	450	+The concept must be in the DSD. UNIT_MEASURE_LABEL overrides the UNIT_MEASURE_CONCEPTS if both are provided.
	451	+
	452	+Also can be attached to items in item scheme, e.g.
	453	+
	454	+Text en:Gram
	455	+ fr: Gramme
	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|(((
	458	+This is optional, used if a freetext label is required.
	459	+
	460	+<language>:<content>,
	461	+
	462	+<language>:<content>,…
	463	+
	464	+//Example~://
	465	+
	466	+en:USD, thousands
	467	+
	468	+fr:USD, milliers
	469	+)))|(((
	470	+This is optional, used if an enumerated list is required.
	471	+
	472	+<concept Id>
	473	+
	474	+//Example~://
	475	+
	476	+UOM_ATTRIBUTE [This concept may contain the following items as units of measure:
	477	+
	478	+* National Currency, thousands
	479	+* USD, thousands
	480	+
	481	+Index, based on National Currency]
	482	+)))|
	483	+|(((
	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| |(((
	488	+//Example~://
	489	+
	490	+LAYOUT_TIME_PERIOD_DESC
	491	+)))|
	492	+|(((
	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|(((
	497	+<language>:<content>,
	498	+
	499	+<language>:<content>,…
	500	+
	501	+
	502	+<content> values:RIGHT or LEFT
	503	+)))|Content values:RIGHT or LEFT|
	504	+|(((
	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| |(((
	509	+<integer>
	510	+
	511	+//Example~://
	512	+
	513	+15000
	514	+)))|
	515	+|(((
	516	+MAXTEXTATTRIBUTELENGTH
	517	+
	518	+
	519	+)))|Increase the maximum length for textual attribute values|DSD| |(((
	520	+<integer>
	521	+
	522	+//Example~://
	523	+
	524	+500
	525	+)))|
	526	+|SEARCH_WEIGHT|Indication of localised boosted dataflows in the search results when ordered by relevance|Dataflow|(((
	527	+<language>:<integer>,...
	528	+
	529	+//Example~://
	530	+
	531	+"en":"3","es":"4","fr":"5"
	532	+)))|(((
	533	+<integer>
	534	+
	535	+//Example~://
	536	+
	537	+10
	538	+)))|
	539	+
241	241	== Codelist and Statistical Classification-specific Annotations ==
242	242
243		-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}}.
	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]].
244	244
	544	+|Annotation Type|Use Case|Where to attach|(((
	545	++Text
245	245
	547	+Blue is optional
	548	+)))|(((
	549	+Title
	550	+
	551	+Blue is optional
	552	+)))|(((
	553	+SDMX 2.1:URL
	554	+
	555	+SDMX >=3.0:+URL
	556	+
	557	+Blue is optional
	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| |(((
	560	+<original code>
	561	+
	562	+//Examples~://
	563	+
	564	+* 0105.13 [Harmonized System]
	565	+* 11.2.0.9 [COICOP classification]
	566	+)))|
	567	+|HIER_CONTEXT|(((
	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	+In SDMX 3.0, use the HierarchyAssociation artefact
	571	+)))|DSD or Dataflow| |(((
	572	+<component Id>:<HCL Id>.<hierarchy Id>
	573	+
	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|(((
	579	+Explicit specification of the hierarchical level of a code item
	580	+
	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	+text en:sections
	584	+)))|Code item| |(((
	585	+<hierarchical level>
	586	+
	587	+//Example~://
	588	+
	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|(((
	592	+<language>:<content>,
	593	+
	594	+<language>:<content>,…
	595	+)))|(((
	596	+//Example~://
	597	+
	598	+[Official French label “Transformation et conservation de la viande de boucherie” is shortened to] fr:Transf. & conserv. viande de boucherie
	599	+
	600	+
	601	+In Codelist=IMF:CL_AREA(1.13)
	602	+Code 4J837 European Union Intellectual Property Office has a Short_Label
	603	+
	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|(((
	607	+<language>:<content>,
	608	+
	609	+<language>:<content>,…
	610	+)))|(((
	611	+//Example~://
	612	+
	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|(((
	616	+<language>:<content>,
	617	+
	618	+<language>:<content>,…
	619	+)))|(((
	620	+Example (from the US NAICS classification):
	621	+
	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|(((
	625	+<language>:<content>,
	626	+
	627	+<language>:<content>,…
	628	+)))|(((
	629	+Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition):
	630	+
	631	+en: This class includes:
	632	+
	633	+* manufacture of heavy weapons (artillery, mobile guns, rocket launchers, torpedo tubes, heavy machine guns)
	634	+* manufacture of small arms (revolvers, shotguns, light machine guns)
	635	+* manufacture of air or gas guns and pistols
	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|(((
	639	+<language>:<content>,
	640	+
	641	+<language>:<content>,…
	642	+
	643	+Example (from NACE Rev. 2 caselaw to code 01.62):
	644	+
	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|(((
	648	+<language>:<content>,
	649	+
	650	+<language>:<content>,…
	651	+)))|(((
	652	+Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition):
	653	+
	654	+en:This class also includes:
	655	+
	656	+* manufacture of hunting, sporting or protective firearms and ammunition
	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|(((
	660	+Item in an Item Scheme
	661	+
	662	+
	663	+)))|(((
	664	+<language>:<content>,
	665	+
	666	+<language>:<content>,…
	667	+)))|(((
	668	+Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition):
	669	+
	670	+en:This class excludes:
	671	+
	672	+* manufacture of percussion caps, detonators or signalling flares, see 2029
	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|(((
	676	+See section URL value defaults and specific locale values.
	677	+
	678	+
	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| |(((
	681	+<content>
	682	+
	683	+//Example~://
	684	+
	685	+A1+A2
	686	+)))|
	687	+|FOLLOWS|(((
	688	+A reference used to express the succession in time of Item Schemes.
	689	+
	690	+For example, NACE Rev. 2 is the successor of NACE Rev. 1.1
	691	+
	692	+Reference to external standard: skos:ConceptScheme - property: xkos:follows
	693	+)))|Codelist or Item Scheme| | |(((
	694	+See section URL value defaults and specific locale values.
	695	+
	696	+//Example~://
	697	+
	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]]
	701	+)))
	702	+|HAS_VARIANT|(((
	703	+A reference used to express the relation between an Item Scheme and its variant(s).
	704	+
	705	+Reference to external standard: skos:ConceptScheme - property: xkos:variant
	706	+
	707	+
	708	+For //Example~:// CL_AREA has a variant CL_GEO
	709	+)))|Codelist or Item Scheme| | |(((
	710	+See section URL value defaults and specific locale values.
	711	+
	712	+
	713	+)))
	714	+|SUPERSEED|(((
	715	+A reference to a previous version, if the current version obsoleted the previous one.
	716	+
	717	+May be used in conjunction with DEPRECATED.
	718	+
	719	+Reference to external standard: skos:ConceptScheme - property: xkos:supersedes
	720	+)))|Codelist or Item Scheme, or an artefact| | |(((
	721	+See section URL value defaults and specific locale values.
	722	+
	723	+
	724	+)))
	725	+|FAMILY_LABEL|(((
	726	+Label of the Classification Family (e.g. NACE, ISIC)
	727	+
	728	+Reference to external standard: skos:ConceptScheme - property: xkos:belongsTo
	729	+
	730	+label of the classification
	731	+)))|Codelist or Item Scheme|(((
	732	+<language>:<content>,
	733	+
	734	+<language>:<content>,…
	735	+
	736	+//Example~://
	737	+
	738	+en:NACE
	739	+)))| |(((
	740	+See section URL value defaults and specific locale values.
	741	+
	742	+
	743	+)))
	744	+|COVERAGE_LABEL|(((
	745	+Label(s) of the item scheme’s coverage (e.g. National Accounts, Products, Activities, Occupations)
	746	+
	747	+Reference to external standard: skos:ConceptScheme - property: xkos:covers
	748	+
	749	+//Examples~://
	750	+
	751	+URL <http:~/~/eurovoc.europa.eu/56> (National accounts)
	752	+
	753	+URL <http:~/~/publications.europa.eu/resource/authority/data-theme/REGI> (Regions and Cities)
	754	+)))|Codelist or Item Scheme|(((
	755	+<language>:<content>,
	756	+
	757	+<language>:<content>,…
	758	+
	759	+//Example~://
	760	+
	761	+En:national accounts
	762	+)))| |(((
	763	+See section URL value defaults and specific locale values.
	764	+
	765	+
	766	+)))
	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|(((
	775	+Indicates that the Legislation on which the codelist/nomenclature is based.
	776	+
	777	+Example for NACE Rev.2.1
	778	+
	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
	781	+
	782	+
	783	+
	784	+
	785	+
246	246	= Concept Scheme SDMX:CS_ANNOT =
247	247
248	248	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.
249	249
250		-|**Property**|(% style="width:309px" %)**Representation in Concept**|(% style="width:1173px" %)**Description**
251		-|**Code**|(% style="width:309px" %)Concept Id|(% style="width:1173px" %)The Annotation Type column, e.g. NOT_DISPLAYED, EXCLUDES
252		-|**Name**|(% style="width:309px" %)Concept Name|(% style="width:1173px" %)Short description of the standard Annotation derived from the “Use case” column
253		-|**Representation**|(% style="width:309px" %)Concept Core Representation|(% style="width:1173px" %)Allowable type or format for the Annotation
254		-|**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
255		-|**Artefact(s)**|(% style="width:309px" %)Annotation Type: Artefact(s)|(% style="width:1173px" %)The information in the “Where to attach” column
256		-|**URL**|(% style="width:309px" %)Annotation Type: URL|(% style="width:1173px" %)The Annotation URL column. The value is in URL
	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
257	257
258	258	== Example of a Concept ==
259	259
...	...	@@ -263,6 +263,8 @@
263	263	|**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
264	264	|**Concept: Annotation: Type: Artefact(s)**|Either a Dataflow or DSD, or an item in an item scheme
265	265
	806	+=== ===
	807	+
266	266	=== SDMX-ML of the Example ===
267	267
268	268	<str:Concept id="NOT_DISPLAYED">
...	...	@@ -290,4 +290,8 @@
290	290
291	291	----
292	292
293		-{{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