Interoperability Basis Platform

= DOCUMENT HISTORY =

6

7

|**Version**|**Date**|**Comment**

8

|1.0|01/03/2021|Initial version.

9

|2.0|24/04/2025|Adapted to SDMX 3.0. Extensions to controlled vocabulary. Clarified text.

= Introduction =

According to the SDMX documentation, the Annotation is a construct that contains user or organisation-specific metadata. The Annotation construct in SDMX is available to most of the SDMX structural metadata artefacts. This facility is essentially a flexible extension mechanism allowing metadata to be added to an SDMX structural artefact. Annotations are often used to store metadata in artefacts when there is no specific place for that information in the SDMX information model. Presentation metadata is a prime example, such as a default presentation for a dataflow.

14

15

Note that whilst the SDMX Annotation has a specific structure (Title, Type, URL, Text) individual organisations are free to use these in any way and any combination they wish. However, an Annotation can only be processed in a meaningful way (i.e. other than viewing it) by systems that understand its semantics.

16

17

The main advantage of the Annotation is its flexibility as all properties can be tailor-made and there is no limit to their number. This can prove very useful for specific applications, such as dissemination tools. The main drawback is poor interoperability as Annotations convey no semantics and are not standardised. This means that organisations that want to exchange Annotations and process them automatically must agree upon, at least, a common naming syntax.

18

19

The aim of this guideline is to improve machine interactions by proposing a controlled vocabulary for the Type property of the SDMX Annotation construct and a recommended usage for the other properties that will greatly improve the interoperability of Annotations between SDMX-compliant organisations.

20

21

The Controlled Vocabulary referred to above will be maintained as a SDMX Concept Scheme stored in the SDMX Global Repository.

22

23

= SDMX Information Model for the Annotation construct =

== SDMX 2.1 ==

[[image:1768507168026-558.png]]

28

29

All classes derived from the abstract class AnnotableArtefact may have Annotations. The Annotation is used to convey extra information to describe SDMX constructs. This information may be in the form of a URL reference, a non-localised text, and/or multiple localised texts (represented by the one-to-many relationship to LocalisedString).

== SDMX 3.0 ==

[[image:1768507168030-780.png]]

34

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.

36

37

= Properties of the Annotation construct =

38

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

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" %)(((

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" %)(((

49

A link to external descriptive text.

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" %)(((

54

An International String that provides the multilingual text content of the Annotation.

55

56

**Text** holds a language-specific string containing the text of the Annotation.

57

)))|(% style="width:710px" %)A localised value for the annotation.

58

59

= Introducing Standard Annotations =

60

61

As stated earlier, a major drawback of the Annotation construct is the fact that they are not standardised for reuse when exchanging structural metadata. Annotations are containers for additional information relating to the object to which they are attached. This means that for an Annotation to be interpreted in the same way by exchange partners, a reference is needed that defines some standard behaviour and implementation.

62

63

This guideline proposes an Annotation controlled vocabulary and guidelines on their (re)use for SDMX implementers.

64

65

A standard Annotation can be defined as an Annotation that has an agreed definition in the SDMX community. Some of them, especially the general and display-related annotations also have a described behaviour. They allow diverse systems to parse the information and perform a specific action in response.

66

67

= How to Identify Standard Annotations? =

68

69

In order to be able to configure their applications to implement actions based upon standard Annotations, systems must know how to identify such Annotations. This is done by setting the Annotation **id** property to “@SDMX” which indicates that the Annotation is part of the controlled vocabulary described in the section List of Standard Annotations, and avoids using “@SDMX” for other usage contexts. For example, ORDER could be the order of codes (as described in this controlled vocabulary) or some kind of order number (a different usage).

70

71

The additional mandatory information to be provided is the **type** property that specifies the type of action to be implemented. There may be other mandatory property values depending on the type of the standard Annotation.

== Examples ==

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”.

**Not @SDMX**

This is a “customer order no.” which is a different use case than the ORDER standard Annotation which is a list order

)))

|(% style="width:209px" %)fr :20

86

87

~* denotes a mandatory information for standard Annotations

88

89

= The Business value of Standard Annotations =

90

91

The following diagram explains the business value and decision process when deciding whether to use a standard Annotation. As can be seen, if they are used then a maximum reuse is made of the Annotation itself, tools and processes. If they are not used then bespoke Annotations, agreements, tools and processing are required to understand and make use of the information in the Annotation, and it (plus supporting tools, processes, etc.) is harder to reuse.

92

93

[[image:1768507168033-962.png]]

94

95

= List of Standard Annotations =

96

97

This section lists the standard Annotations with their typical usage contexts. This list will be expanded over time as new implementations and needs arise. When references to external standards are made (e.g. skos or xkos specifications), the reader is invited to consult the “References” section for more information.

98

99

The list of standard Annotations will be available from the SDMX Registry as artefact: SDMX:CS_ANNOT(*.*.*). Link: [[https:~~/~~/registry.sdmx.org/ws/public/sdmxapi/rest/conceptscheme/SDMX/CS_ANNOT/latest/?format=sdmx-2.1&detail=full&references=none>>url:https://registry.sdmx.org/ws/public/sdmxapi/rest/conceptscheme/SDMX/CS_ANNOT/latest/?format=sdmx-2.1&detail=full&references=none]]

100

101

**Note:** There are several Annotations that are types of name or label, e.g. FULL_NAME, SHORT_LABEL, ORIGINAL_LABEL. These Annotations have specific use cases that are described in the tables below and should not be used to replace an artefact’s or item scheme item’s Name and Description property.

102

103

== Relationships between Annotation properties ==

104

105

=== Text value defaults and specific locale values ===

106

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

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

111

=== URL value defaults and specific locale values ===

112

113

===== SDMX 2.1 and earlier =====

114

115

In SDMX 2.1, the Annotation’s URL property is a single, non-localised value. There may be cases where different URLs are required for certain locales. In this case, it is recommended to use the Annotation text property and state the language and URL in an HTML fragment, for example:

116

117

fr:<a href=”https:~/~/someLink”>

118

119

When both a URL and text property for the locale exists, the text property overrides (is used instead of) the URL property.

120

121

===== SDMX 3.0 and later =====

122

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

125

== General and Display-related Annotation types ==

126

127

(% style="width:1790.2px" %)

128

|(% style="width:243px" %)**Annotation Type**|(% style="width:442px" %)**Use Case**|(% style="width:246px" %)**Where to attach**|(% style="width:289px" %)(((

129

**+Text

130

(% style="background-color:transparent" %)Blue is optional(%%)**

131

)))|(% style="width:321px" %)(((

132

**Title

133

(% style="background-color:transparent" %)Blue is optional(%%)**

134

)))|(% style="width:185px" %)(((

135

**SDMX 2.1:URL

136

SDMX >=3.0:+URL

137

(% style="background-color:transparent" %)Blue is optional(%%)**

138

)))

139

|(% style="width:243px" %)FULL_NAME|(% style="width:442px" %)Alternative name to be displayed for items in Item Schemes (e.g. Codelists, Concept Schemes, Category Schemes) whenever the item is displayed without its parent. For example, if a code list that has a hierarchy is displayed as a flat list, then this annotation may be used to provide sufficient context for the code. Concatenation of code + heading in NACE Rev.2.1

140

en: A0123 Growing of citrus fruits|(% style="width:246px" %)Item in an Item Scheme|(% style="width:289px" %)(((

141

<language>:<content>,<language>:<content>,…

142

//Example~://

143

(% style="background-color:transparent" %)en:Labour force (Employment)

144

)))|(% style="width:321px" %)<content>|(% style="width:185px" %)

145

|(% style="width:243px" %)REPLACE_NAME|(% style="width:442px" %)Replace each code name in a component by the value of another component in an observation or series|(% style="width:246px" %)A Dataflow or DSD|(% style="width:289px" %) |(% style="width:321px" %)(((

146

<component Id to replace name>:

147

148

//Example~://

149

(% style="background-color:transparent" %)CUST_BREAKDOWN:CUST_

150

BREAKDOWN_LB

151

)))|(% style="width:185px" %)

152

|(% style="width:243px" %)REPLACE_CONTENT|(% style="width:442px" %)Replace the content in a component by the value of another component in an observation or series|(% style="width:246px" %)A Dataflow or DSD|(% style="width:289px" %) |(% style="width:321px" %)(((

153

<component Id to replace content>:

154

155

//Example~://

156

(% style="background-color:transparent" %)REF_AREA:M49_CODE

157

)))|(% style="width:185px" %)

158

|(% style="width:243px" %)COMPLEMENT|(% style="width:442px" %)(((

159

Additional fixed text to be displayed in parenthesis after the code name.

160

(% style="background-color:transparent" %)E.g. Representation of Non-hazardous (NHAZW), hazardous waste (HAZW) in the European List of Wastes(%%)

161

(% style="background-color:transparent" %)en: 01 03 04* acid-generating tailings from processing of sulphide ore (HAZW)(%%)

162

(% style="background-color:transparent" %)en: 01 03 99 wastes not otherwise specified (NHAZW)

163

)))|(% style="width:246px" %)Item in an Item Scheme|(% style="width:289px" %)(((

164

<language>:<content>,<language>:<content>,…

165

166

//Example~://

167

(% style="background-color:transparent" %)en:See reference metadata

168

)))|(% style="width:321px" %)<content>|(% style="width:185px" %)

169

|(% style="width:243px" %)ORDER|(% style="width:442px" %)Explicit indication of a localised order of items in Items Schemes or artefacts (e.g. Codelist, Concept Scheme, Category Scheme, Dataflow, etc.)|(% style="width:246px" %)(((

Either:

* an artefact, or;

* an item in an Item Scheme

174

)))|(% style="width:289px" %)(((

175

<language>:<content>,

176

<language>:<content>,…

177

178

//Example~://

179

(% style="background-color:transparent" %)en:10,es:20

180

)))|(% style="width:321px" %)<content>|(% style="width:185px" %)

181

|(% style="width:243px" %)TOTAL|(% style="width:442px" %)(((

182

Code Item that represents a total value. If the attachment is:

183

184

* to a Code, the Annotation Text is optional and may contain an explanatory text;

185

* to a Codelist, the Annotation Title is mandatory and includes the code(s) that represent a total

186

)))|(% style="width:246px" %)(((

187

Either:

188

189

* a Code Item that represents a total value, or;

190

* a Codelist to specify the code(s) with the total

191

)))|(% style="width:289px" %)(((

192

<language>:<explanatory text>,

193

(% style="background-color:transparent" %)<language>:<explanatory text>,…

194

)))|(% style="width:321px" %)(((

195

Attached to Code Item: <blank>

196

(% style="background-color:transparent" %)Attached to Codelist: <code>,<code>,…

197

)))|(% style="width:185px" %)

198

|(% style="width:243px" %)DRILLDOWN|(% style="width:442px" %)Denotes the concept that specifies whether observations are at the aggregate level or a drilldown.|(% style="width:246px" %)(((

Either:

* A Dataflow or DSD

)))|(% style="width:289px" %) |(% style="width:321px" %)(((

203

204

//Example~://

205

(% style="background-color:transparent" %)DD_DIM (this concept should be hidden using the NOT_DISPLAYED Annotation below)

206

)))|(% style="width:185px" %)

207

|(% style="width:243px" %)DEPRECATED|(% style="width:442px" %)(((

208

Indication that an Item in an Item Scheme or an artefact is deprecated.

209

For an item scheme item, the annotation value provides a replacement name for the code name.

210

For an artefact, the URL points to the replacement artefact. May be used in conjunction with SUPERSEED where the replacement artefact references the replaced artefact.

211

Suggestion to use a controlled vocabulary

212

url:

213

<[[http:~~/~~/publications.europa.eu/resource/authority/concept-status/CURRENT>>url:http://publications.europa.eu/resource/authority/concept-status/CURRENT]]>

214

url:

215

<[[http:~~/~~/publications.europa.eu/resource/authority/concept-status/DEPRECATED>>url:http://publications.europa.eu/resource/authority/concept-status/DEPRECATED]]>

216

or

217

(% style="background-color:transparent" %)TITLE: true (false)

218

)))|(% style="width:246px" %)(((

Either:

* an artefact, or;

* an item in an Item Scheme

223

)))|(% style="width:289px" %)(((

224

For item scheme item:

225

226

<language>:<content>,<language>:<content>,…

227

228

//Example~://

229

(% style="background-color:transparent" %)en:deprecated,fr:obsolète

230

)))|(% style="width:321px" %)<content>|(% style="width:185px" %)(((

For artefact:

)))

|(% style="width:243px" %)DEFAULT|(% style="width:442px" %)(((

235

Indication that an item in an Item Scheme or artefacts is to be selected by default.

236

237

The Annotation defines a selection so that a pre-defined default subset of data can be processed (e.g. visualised, extracted) instead of the entire dataset

238

)))|(% style="width:246px" %)(((

239

* Item in ItemScheme, or;

* DSD, or;

* a Dataflow

Note: A DEFAULT Annotation attached to a later level in this list supersedes that attached to an earlier level. E.g., a DEFAULT Annotation attached to individual Codes in Codelists is only to be used when there is no DEFAULT Annotation attached to the Dataflow nor to the DSD, and those of DSDs are only to be used when there is no DEFAULT Annotation attached to the Dataflow.

244

)))|(% style="width:289px" %) |(% style="width:321px" %)(((

Attached to:

- DSD or Dataflow:

**<concept>=<code>+<code>+…,

249

<concept>=<code>+<code>+…**

250

251

//Example~:// FREQ=A+Q,TIME_PERIOD_

252

START=2013-01,TIME_PERIOD_END

253

~=2018-12

254

)))|(% style="width:185px" %)

255

|(% style="width:243px" %)IMAGE|(% style="width:442px" %)A visual identity to associate to Item Scheme Items or artefacts|(% style="width:246px" %)(((

Either:

* an artefact, or;

* an item in an item scheme

260

)))|(% style="width:289px" %)(((

261

For localised content in SDMX 2.1

262

<language>:<HTML containing URL to the resource>,

263

<language>:<HTML containing URL to the resource>,…

264

265

//Example~://

266

en:<a href=”https:~/~/sdmx.org/wp-content/uploads/SDMX_map_small-220x220.jpg”>

267

)))|(% style="width:321px" %) |(% style="width:185px" %)(((

268

See section URL value defaults and specific locale values.

//Example~://

https:~/~/sdmx.org/wp-content/uploads/SDMX_map_

273

small-220x220.jpg

274

)))

275

|(% style="width:243px" %)DRILLDOWN_CONCEPTS|(% style="width:442px" %)Concepts to be displayed in a drilldown operation|(% style="width:246px" %)Dataflow or DSD|(% style="width:289px" %) |(% style="width:321px" %)(((

276

<concept Id>,<concept Id>,…

277

278

Example :

279

DONOR,RECIPIENT,YEAR,PROJECT_ID, OBS_VALUE,DESCRIPTION,OWNER

280

)))|(% style="width:185px" %)

281

|(% style="width:243px" %)NOT_DISPLAYED|(% style="width:442px" %)Used to hide components or their values in the presentation|(% style="width:246px" %)(((

282

Either:

283

284

* a Dataflow or DSD, or;

285

* an Item in an Item Scheme

286

)))|(% style="width:289px" %) |(% style="width:321px" %)(((

287

Attached to Item in Item Scheme: <blank>

288

289

Attached to Dataflow or DSD:

290

<concept Id>,<concept Id>,…

291

Example :

292

DD_DIM (to hide drilldown control concept)

293

)))|(% style="width:185px" %)

294

|(% style="width:243px" %)LAYOUT_ROW|(% style="width:442px" %)Dimensions to be presented in rows (concepts on y-axis)|(% style="width:246px" %)(((

Either:

* an artefact, or;

* a Dimension

)))|(% style="width:289px" %) |(% style="width:321px" %)(((

300

Attached to Dimension: <blank>

301

302

Attached to Dataflow or DSD: <dimension Id>,<dimension Id >,…

//Example~://

REF_AREA,MEASURE

)))|(% 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" %)(((

Either:

* an artefact, or;

a Dimension

)))|(% style="width:289px" %) |(% style="width:321px" %)(((

314

Attached to Dimension: <blank>

315

316

Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,…

//Example~://

TIME_PERIOD

)))|(% 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" %)(((

322

<concept Id>,<concept Id>,...

323

324

//Example~://

325

OBS_STATUS,CONF_STATUS

326

)))|(% style="width:185px" %)

327

|(% style="width:243px" %)LAYOUT_NOTE|(% style="width:442px" %)Indication that an attribute and its attribute value should be presented as a note|(% style="width:246px" %)Dataflow|(% style="width:289px" %) |(% style="width:321px" %)(((

328

<concept Id>,<concept Id>,...

329

330

//Example~://

331

OBS_STATUS,CONF_STATUS

332

)))|(% style="width:185px" %)

333

|(% style="width:243px" %)(((

334

METADATA

335

)))|(% style="width:442px" %)Links an MSD directly to a DSD. Can be used to overcome the complexities of reference metadata linkage|(% style="width:246px" %)DSD|(% style="width:289px" %) |(% style="width:321px" %)MSD URI, e.g. urn:sdmx:org.sdmx.infomodel.

336

metadatastructure. MetadataStructure =OECD:MSD_REF_METADATA(1.0)|(% style="width:185px" %)

337

|(% style="width:243px" %)LAYOUT_ROW_SECTION|(% style="width:442px" %)Dimension to be presented as a break-down concept at a third hierarchical level above columns and rows.|(% style="width:246px" %)(((

Either:

* an artefact, or;

* a Dimension

)))|(% style="width:289px" %) |(% style="width:321px" %)(((

343

Attached to Dimension: <blank>

344

~|Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,…

345

//Example~://

346

SEX

347

)))|(% style="width:185px" %)

348

|(% style="width:243px" %)EXT_RESOURCE|(% style="width:442px" %)(((

349

A localised link to an external resource associated to the annotated artefact. For example, an ontology item

350

//a methodology// en:<a href: "[[https:~~/~~/ec.europa.eu/eurostat/web/waste/methodology>>url:https://ec.europa.eu/eurostat/web/waste/methodology]]">

351

)))|(% style="width:246px" %)Any SDMX object|(% style="width:289px" %)(((

352

For localised content in SDMX 2.1

353

<language>:<HTML containing URL to the resource>,

354

<language>:<HTML containing URL to the resource>,…

355

356

//Example~://

357

en:<a href=”[[http:~~/~~/rdf-vocabulary.ddialliance.org/xkos#depth>>url:http://rdf-vocabulary.ddialliance.org/xkos#depth]]”>

358

)))|(% style="width:321px" %) |(% style="width:185px" %)(((

359

See section URL value defaults and specific locale values.

//Example~://

http:~/~/rdf-vocabulary.ddialliance.org/

364

xkos#depth

365

)))

366

|(% style="width:243px" %)COMBINED_CONCEPTS|(% style="width:442px" %)(((

367

Comma-separated list of concept IDs to show as a concatenated label.

368

The listed concepts’ item contents may be concatenated to generate the target concept.

369

Multiple target concept combinations can be defined by separating the target concepts by ;

370

)))|(% style="width:246px" %)Dataflow or DSD|(% style="width:289px" %)(((

371

<language>:<display name>,

372

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" %)(((

377

Comma-separated list of concept IDs that is used to define the full unit of measure. The concepts must be in the DSD.

378

379

The listed concepts’ item contents may be concatenated to generate the unit of measure label (unless the UNIT_MEASURE_LABEL annotation is present).

380

)))|(% style="width:246px" %)Dataflow or DSD|(% style="width:289px" %) |(% style="width:321px" %)(((

381

<concept Id>,<concept Id>,…

382

383

//Example~:// UNIT_MEASURE, UNIT_MULT,

384

TRANSFORMATION [could generate a value of Australian Dollar, Thousands, Non-transformed]

385

)))|(% style="width:185px" %)

386

|(% style="width:243px" %)(deprecated) UNIT_MEASURE_LABEL|(% style="width:442px" %)(((

387

Indicates the concept that enumerates the full unit of measure labels.

388

The concept must be in the DSD. UNIT_MEASURE_LABEL overrides the UNIT_MEASURE_CONCEPTS if both are provided.

389

390

Also can be attached to items in item scheme, e.g.

Text en:Gram

fr: Gramme

url:** **[[**http:~~/~~/data.europa.eu/gzn/su/G**>>url:http://data.europa.eu/gzn/su/G]]

395

)))|(% style="width:246px" %)Dataflow or DSD, Item in an Item Scheme|(% style="width:289px" %)(((

396

This is optional, used if a freetext label is required.

397

398

<language>:<content>,

399

<language>:<content>,…

//Example~://

en:USD, thousands

fr:USD, milliers

)))|(% style="width:321px" %)(((

406

This is optional, used if an enumerated list is required.

407

408

//Example~://

409

UOM_ATTRIBUTE [This concept may contain the following items as units of measure:

410

411

* National Currency, thousands

412

* USD, thousands

413

414

Index, based on National Currency]

415

)))|(% style="width:185px" %)

416

|(% style="width:243px" %)(((

417

LAYOUT_TIME_PERIOD_DESC

418

)))|(% style="width:442px" %)Indication that the display of the TIME_PERIOD dimension for a dataflow, or all dataflows of the same DSD, is to be done in descending sort order.|(% style="width:246px" %)Dataflow, DSD|(% style="width:289px" %) |(% style="width:321px" %)(((

419

//Example~://

420

421

LAYOUT_TIME_PERIOD_DESC

422

)))|(% style="width:185px" %)

423

|(% style="width:243px" %)(((

424

LAYOUT_CELL_ALIGN

425

)))|(% style="width:442px" %)Indication to force the data cell alignment to the left or to the right. This can be defined generically for all locales or per locale.|(% style="width:246px" %)Dataflow, DSD, Dimension|(% style="width:289px" %)(((

426

<language>:<content>,

427

<language>:<content>,…

428

<content> values:RIGHT or LEFT

429

)))|(% style="width:321px" %)Content values:RIGHT or LEFT|(% style="width:185px" %)

430

|(% style="width:243px" %)(((

431

MAX_TABLE_DATA

432

)))|(% style="width:442px" %)Increase the maximum preview table size above default maximum limits for the number of observations retrieved from the SDMX web service and for the number of table cells|(% style="width:246px" %)Dataflow|(% style="width:289px" %) |(% style="width:321px" %)(((

//Example~://

15000

)))|(% style="width:185px" %)

437

|(% style="width:243px" %)(((

438

MAXTEXTATTRIBUTELENGTH

439

)))|(% style="width:442px" %)Increase the maximum length for textual attribute values|(% style="width:246px" %)DSD|(% style="width:289px" %) |(% style="width:321px" %)(((

//Example~://

500

)))|(% 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" %)(((

447

<language>:<integer>,...

448

//Example~://

449

"en":"3","es":"4","fr":"5"

450

)))|(% style="width:321px" %)(((

//Example~://

10

)))|(% style="width:185px" %)

457

458

== Codelist and Statistical Classification-specific Annotations ==

459

460

The categories below are used widely, for example by the European Statistical System (ESS), and the United Nations Statistics Division for its central framework classifications ISIC4{{footnote}}International Standard Industrial Classification of All Economic Activities{{/footnote}} and CPC{{footnote}}Central Product Classification{{/footnote}}.

461

462

(% style="width:1785.2px" %)

463

|**Annotation Type**|(% style="width:463px" %)**Use Case**|(% style="width:247px" %)**Where to attach**|(% style="width:332px" %)(((

464

**+Text

465

Blue is optional**

466

)))|(% style="width:224px" %)(((

467

**Title

468

Blue is optional**

469

)))|(% style="width:229px" %)(((

**SDMX 2.1:URL

SDMX >=3.0:+URL

Blue is optional**

)))

|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" %)(((

//Examples~://

* 0105.13 [Harmonized System]

479

* 11.2.0.9 [COICOP classification]

480

)))|(% style="width:229px" %)

481

|HIER_CONTEXT|(% style="width:463px" %)(((

482

In SDMX 2.1, a reference between a usage context and a hierarchy (that may be contained in a Hierarchical Codelist (HCL)).

483

In SDMX 3.0, use the HierarchyAssociation artefact

484

)))|(% style="width:247px" %)DSD or Dataflow|(% style="width:332px" %) |(% style="width:224px" %)(((

485

486

//Example~://

487

REF_AREA: OECD.EDU:HCL_REF_AREA(1.0).REF_AREA provides the link to the reference area hierarchy for OECD education data

488

)))|(% style="width:229px" %)

489

|HIER_LEVEL|(% style="width:463px" %)(((

490

Explicit specification of the hierarchical level of a code item

491

492

Reference to external standard: xkos:ClassificationLevel - property: xkos:xdepth url: [[http:~~/~~/data.europa.eu/ux2/nace2.1/sections>>url:http://data.europa.eu/ux2/nace2.1/sections]]

493

text en:sections

494

)))|(% style="width:247px" %)Code item|(% style="width:332px" %) |(% style="width:224px" %)(((

//Example~://

1

)))|(% 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" %)(((

501

<language>:<content>,

502

503

<language>:<content>,…

504

)))|(% style="width:224px" %)(((

505

//Example~://

506

507

[Official French label “Transformation et conservation de la viande de boucherie” is shortened to] fr:Transf. & conserv. viande de boucherie

508

509

In Codelist=IMF:CL_AREA(1.13)

510

Code 4J837 European Union Intellectual Property Office has a Short_Label

511

512

EN:EUIPO

513

)))|(% style="width:229px" %)

514

|EXPLAN_LABEL|(% style="width:463px" %)An explanatory text that specifies “other” and similar categories. An example is the Combined Nomenclature classification where the many codes labelled “other” are complemented by a verbose text describing in detail the content of the code item|(% style="width:247px" %)Item in an Item Scheme, mapping to Representation Maps|(% style="width:332px" %)(((

515

<language>:<content>,

516

517

<language>:<content>,…

518

)))|(% style="width:224px" %)(((

519

//Example~://

520

521

[EU Combined Nomenclature official label for code 3824 99 57 reads “Other”, which is not very informative for the user; instead the EXPLAN_LABEL reads] en:Cartridges and refills, filled, for electronic cigarettes, and preparations for use in the cartridges and refills, not containing nicotine or its salts, ethers, esters or other derivatives thereof

522

)))|(% style="width:229px" %)

523

|EXPLAN_CONSOL|(% style="width:463px" %)Explanatory notes. An explanatory text to be used when objects included in and excluded from a classification position are consolidated, i.e. are presented together. Reference to external standard: skos:scopeNote|(% style="width:247px" %)Item in an Item Scheme, mapping to Representation Maps|(% style="width:332px" %)(((

524

<language>:<content>,

525

526

<language>:<content>,…

527

)))|(% style="width:224px" %)(((

528

Example (from the US NAICS classification):

529

530

en:Industries in the Food Manufacturing subsector transform livestock and agricultural products into products for intermediate or final consumption. […] The food products manufactured in these establishments are typically sold to wholesalers or retailers for distribution to consumers, but establishments primarily engaged in retailing bakery and candy products made on the premises not for immediate consumption are included. Establishments primarily engaged in manufacturing beverages are classified in Subsector 312, Beverage and Tobacco Product Manufacturing.

531

)))|(% style="width:229px" %)

532

|EXPLAN_INCLUDES|(% style="width:463px" %)Explanatory notes. Description of those things known specifically to be included in the concept. Synonyms Typical labels for such explanatory notes: "This class includes", "This category includes", "This position includes", "Includes", etc. Reference to external standard: xkos:inclusionNote or xkos:coreContentNote (if EXPLAN_INCLUDES_ALSO available)|(% style="width:247px" %)Item in an Item Scheme, mapping to Representation Maps|(% style="width:332px" %)(((

533

<language>:<content>,

534

<language>:<content>,…

535

)))|(% style="width:224px" %)(((

536

Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition):

537

en: This class includes:

538

539

* manufacture of heavy weapons (artillery, mobile guns, rocket launchers, torpedo tubes, heavy machine guns)

540

* manufacture of small arms (revolvers, shotguns, light machine guns)

541

* manufacture of air or gas guns and pistols

542

* manufacture of war ammunition

543

)))|(% style="width:229px" %)

544

|EXPLAN_CASELAW|(% style="width:463px" %)Explanatory notes. Indication that a decision on the classification has been made by the ad hoc Committee (concept generally described as “ruling”, “classification opinion”, classification decision; caselaw). : Reference to external standardxkos:caseLaw. The difference between caselaws and traditional explanatory notes is that caselaws are adopted during the time period between two official versions of a specific classification and have thus a slightly different status (e.g. from a legal viewpoint)|(% style="width:247px" %)Item in an Item Scheme|(% style="width:332px" %)(((

545

<language>:<content>,

546

<language>:<content>,…

547

548

Example (from NACE Rev. 2 caselaw to code 01.62):

549

550

en:Automated egg hatching for poultry - Operation of livestock management systems]

551

)))|(% style="width:224px" %) |(% style="width:229px" %)

552

|EXPLAN_INCLUDES_ALSO|(% style="width:463px" %)Explanatory notes. Description of those things which can be considered as borderline cases and are generally based on consensus rather than strict methodological principles (e.g. classifying wooden shoes as handicraft rather than shoes). Typical labels for such explanatory notes: "This class includes also", "This category includes also", "This position includes also ", "Includes also", etc. Reference to external standard: xkos:additionalContentNote|(% style="width:247px" %)Item in an Item Scheme|(% style="width:332px" %)(((

553

<language>:<content>,

554

555

<language>:<content>,…

556

)))|(% style="width:224px" %)(((

557

Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition):

558

559

en:This class also includes:

560

561

* manufacture of hunting, sporting or protective firearms and ammunition

562

* manufacture of explosive devices such as bombs, mines and torpedoes

563

)))|(% style="width:229px" %)

564

|EXPLAN_EXCLUDES|(% style="width:463px" %)Explanatory notes. Description of those things which are explicitly excluded from a category. Typical labels for such explanatory notes: "This class excludes", "This category excludes", "This position excludes", "Excludes", etc. Reference to external standards: xkos:exclusionNote|(% style="width:247px" %)(((

565

Item in an Item Scheme

566

567

568

)))|(% style="width:332px" %)(((

569

<language>:<content>,

570

<language>:<content>,…

571

)))|(% style="width:224px" %)(((

572

Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition):

573

574

en:This class excludes:

575

576

* manufacture of percussion caps, detonators or signalling flares, see 2029

577

* manufacture of cutlasses, swords, bayonets etc., see 2593

578

)))|(% style="width:229px" %)

579

|MAP_REFER|(% style="width:463px" %)A reference to a classification mapping or transformation, e.g. an SDMX Structure Map. Reference to external standard: skos:mappingRelation (skos:broadMatch, skos:narrowMatch, skos:closeMatch, skos:exactMatch or skos:relatedMatch)|(% style="width:247px" %)Codelist, Concept Scheme, or another Item Scheme|(% style="width:332px" %) |(% style="width:224px" %)Id of an ItemSchemeMap returned by the Annotation URL|(% style="width:229px" %)(((

580

See section URL value defaults and specific locale values.

)))

|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" %)(((

//Example~://

A1+A2

)))|(% style="width:229px" %)

591

|FOLLOWS|(% style="width:463px" %)(((

592

A reference used to express the succession in time of Item Schemes.

593

For example, NACE Rev. 2 is the successor of NACE Rev. 1.1

594

Reference to external standard: skos:ConceptScheme - property: xkos:follows

595

)))|(% style="width:247px" %)Codelist or Item Scheme|(% style="width:332px" %) |(% style="width:224px" %) |(% style="width:229px" %)(((

596

See section URL value defaults and specific locale values.

597

//Example~://

598

(CL_REGIONAL 3.1.1 follows CL_REGIONAL 3.1):

599

[[https:~~/~~/registry.sdmx.org/ws/public/sdmxapi/

600

rest/codelist/ESTAT/CL_REGIONAL/3.1>>url:https://registry.sdmx.org/ws/public/sdmxapi/rest/codelist/ESTAT/CL_REGIONAL/3.1]]

601

)))

602

|HAS_VARIANT|(% style="width:463px" %)(((

603

A reference used to express the relation between an Item Scheme and its variant(s).

604

Reference to external standard: skos:ConceptScheme - property: xkos:variant

605

606

607

For //Example~:// CL_AREA has a variant CL_GEO

608

)))|(% style="width:247px" %)Codelist or Item Scheme|(% style="width:332px" %) |(% style="width:224px" %) |(% style="width:229px" %)(((

609

See section URL value defaults and specific locale values.

)))

|SUPERSEED|(% style="width:463px" %)(((

614

A reference to a previous version, if the current version obsoleted the previous one.

615

May be used in conjunction with DEPRECATED.

616

Reference to external standard: skos:ConceptScheme - property: xkos:supersedes

617

)))|(% style="width:247px" %)Codelist or Item Scheme, or an artefact|(% style="width:332px" %) |(% style="width:224px" %) |(% style="width:229px" %)(((

618

See section URL value defaults and specific locale values.

)))

|FAMILY_LABEL|(% style="width:463px" %)(((

623

Label of the Classification Family (e.g. NACE, ISIC)

624

Reference to external standard: skos:ConceptScheme - property: xkos:belongsTo

625

label of the classification

626

)))|(% style="width:247px" %)Codelist or Item Scheme|(% style="width:332px" %)(((

627

<language>:<content>,

628

<language>:<content>,…

//Example~://

en:NACE

)))|(% style="width:224px" %) |(% style="width:229px" %)(((

633

See section URL value defaults and specific locale values.

)))

|COVERAGE_LABEL|(% style="width:463px" %)(((

638

Label(s) of the item scheme’s coverage (e.g. National Accounts, Products, Activities, Occupations)

639

Reference to external standard: skos:ConceptScheme - property: xkos:covers

640

641

//Examples~://

642

URL <http:~/~/eurovoc.europa.eu/56> (National accounts)

643

644

URL

645

<http:~/~/publications.europa.eu/resource/authority/data-theme/REGI> (Regions and Cities)

646

)))|(% style="width:247px" %)Codelist or Item Scheme|(% style="width:332px" %)(((

647

<language>:<content>,

648

649

<language>:<content>,…

//Example~://

En:national accounts

)))|(% style="width:224px" %) |(% style="width:229px" %)(((

655

See section URL value defaults and specific locale values.

)))

|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

666

|LEGAL_BASIS|(% style="width:463px" %)(((

667

Indicates that the Legislation on which the codelist/nomenclature is based.

668

Example for NACE Rev.2.1

669

url: [[http:~~/~~/data.europa.eu/eli/reg_del/2023/137/oj>>url:http://data.europa.eu/eli/reg_del/2023/137/oj]]

670

)))|(% style="width:247px" %)Codelist|(% style="width:332px" %) |(% style="width:224px" %) |(% style="width:229px" %)http:~/~/data.europa.eu/eli/reg_del/2023/137/oj

671

672

= Concept Scheme SDMX:CS_ANNOT =

673

674

The Concept Scheme for standard Annotations will have the Maintenance Agency SDMX and will describe the following properties for each Annotation. For the information represented by Annotations, the value is in AnnotationTitle apart from the URL property where it is in AnnotationURL.

675

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

683

684

== Example of a Concept ==

685

686

|**Concept Id**|NOT_DISPLAYED

687

|**Concept Name**|Used to hide components or their values in the presentation

688

|**Concept Core Representation**|/TextFormat@textType="String"

689

|**Concept Description**|To hide dimensions and attributes in a display (e.g. a table). For example, if they have only one allowed, available or selected value

690

|**Concept: Annotation: Type: Artefact(s)**|Either a Dataflow or DSD, or an item in an item scheme

691

692

=== SDMX-ML of the Example ===

693

694

<str:Concept id="NOT_DISPLAYED">

695

<com:Annotations>

696

<com:Annotation>

697

<com:AnnotationTitle>Either a Dataflow or DSD, or an item in an item scheme</com:AnnotationTitle>

698

<com:AnnotationType>Artefact(s)</com:AnnotationType>

699

</com:Annotation>

700

</com:Annotations>

701

<com:Name xml:lang="en">Used to hide components or their values in the presentation</com:Name>

702

<com:Description xml:lang="en">To hide dimensions and attributes in a display (e.g. a table). For example, if they have only one allowed, available or selected value</com:Description>

703

<str:CoreRepresentation>

704

<str:TextFormat textType="String"/>

705

</str:CoreRepresentation>

</str:Concept>

= References =

* [[Formalization of the Structure and Content of Statistical Classifications>>url:https://urldefense.com/v3/__https:/eur02.safelinks.protection.outlook.com/?url=https*3A*2F*2Furldefense.com*2Fv3*2F__https*3A*2Feur02.safelinks.protection.outlook.com*2F*3Furl*3Dhttps*3A*2F*2Fec.europa.eu*2Feurostat*2Framon*2Fmiscellaneous*2Fgen_intro_classif_files*2FStructure_and_content_of_classifications_version_1_0_October_2019.docx*26data*3D02*7C01*7CDavid.BARRACLOUGH*40oecd.org*7Cf9cb429291334e5170cb08d80c883aeb*7Cac41c7d41f61460db0f4fc925a2b471c*7C0*7C1*7C637273126543303645*26sdata*3Dl01*2BEX3SNWREH*2FElV3r9Ld*2BG49l7ouvFi7pqAGYg2Ss*3D*26reserved*3D0__*3BJSUlJSUlJSUlJSUlJSUlJSUlJSU!!DOxrgLBm!Q_cL04DGMBYhHfuPQVRMMCKao1C3QuaoJxBTxO4_mSKNMGfLjmV2UTCtAhTDvbMAZtNzrTZ3*24&data=02*7C01*7CDavid.BARRACLOUGH*40oecd.org*7Ca70a73c696814b06406408d80d1d9336*7Cac41c7d41f61460db0f4fc925a2b471c*7C0*7C1*7C637273768055440921&sdata=r4CVvCdYBIU39XMN0qNmt*2FC9FIS7AnXrzYcjuzDe0Dc*3D&reserved=0__;JSUlJSUlJSUlJSoqKioqKioqJSUqKioqKioqKiUlKioqKiUlJSUlJSUlJSUlJSUl!!DOxrgLBm!RCGOp-FMBfmiP7CvEwdSAhL4XCil-vey-z32n6uxoCDXVTN7rXWXG442IZgqwpmM4wKQq908$]]

711

* [[SDMX Global Registry>>url:https://registry.sdmx.org/overview.html]]

712

* [[SDMX Glossary 2.1>>url:https://sdmx.org/wp-content/uploads/SDMX_Glossary_version_2_1-Final-2.docx]]

713

* SDMX Standards, “[[Information Model: UML Conceptual Design>>url:https://sdmx.org/wp-content/uploads/SDMX_2_0_SECTION_02_InformationModel.pdf]]”, version 2.1

714

* [[SKOS Specification>>url:https://www.w3.org/TR/2009/REC-skos-reference-20090818/]]

715

* [[XKOS Specification>>url:https://ddialliance.org/Specification/XKOS/1.2/OWL/xkos.html]]

----

Wiki source code of Guidelines on Using SDMX Annotations