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:152px" %)Annotation Type|(% style="width:559px" %)Use Case|Where to attach|(((

+Text

Blue is optional

)))|(((

Title

Blue is optional

)))|(((

SDMX 2.1:URL

SDMX >=3.0:+URL

Blue is optional

)))

|(% style="width:152px" %)FULL_NAME|(% style="width:559px" %)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:20px" %)Item in an Item Scheme|(% style="width:506px" %)(((

141

<language>:<content>,

142

143

<language>:<content>,…

//Example~://

en:Labour force (Employment)

148

)))|(% style="width:178px" %)<content>|(% style="width:866px" %)

149

|(% style="width:152px" %)REPLACE_NAME|(% style="width:559px" %)Replace each code name in a component by the value of another component in an observation or series|(% style="width:20px" %)A Dataflow or DSD|(% style="width:506px" %) |(% style="width:178px" %)(((

//Example~://

CUST_BREAKDOWN:CUST_BREAKDOWN_LB

155

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

156

|(% style="width:152px" %)REPLACE_CONTENT|(% style="width:559px" %)Replace the content in a component by the value of another component in an observation or series|(% style="width:20px" %)A Dataflow or DSD|(% style="width:506px" %) |(% style="width:178px" %)(((

//Example~://

REF_AREA:M49_CODE

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

163

|(% style="width:152px" %)COMPLEMENT|(% style="width:559px" %)(((

164

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

165

166

E.g. Representation of Non-hazardous (NHAZW), hazardous waste (HAZW) in the European List of Wastes

167

en: 01 03 04* acid-generating tailings from processing of sulphide ore (HAZW)

168

en: 01 03 99 wastes not otherwise specified (NHAZW)

169

)))|(% style="width:20px" %)Item in an Item Scheme|(% style="width:506px" %)(((

170

<language>:<content>,

171

172

<language>:<content>,…

//Example~://

en:See reference metadata

177

)))|(% style="width:178px" %)<content>|(% style="width:866px" %)

178

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

Either:

* an artefact, or;

* an item in an Item Scheme

183

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

184

<language>:<content>,

185

186

<language>:<content>,…

//Example~://

en:10,es:20

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

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

196

|(% style="width:152px" %)TOTAL|(% style="width:559px" %)(((

197

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

198

199

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

200

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

201

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

202

Either:

203

204

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

205

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

206

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

207

<language>:<explanatory text>,

208

209

<language>:<explanatory text>,…

210

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

211

Attached to Code Item: <blank>

212

213

Attached to Codelist: <code>,<code>,…

214

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

215

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

Either:

* A Dataflow or DSD

)))|(% style="width:506px" %) |(% style="width:178px" %)(((

//Example~://

DD_DIM (this concept should be hidden using the NOT_DISPLAYED Annotation below)

225

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

226

|(% style="width:152px" %)DEPRECATED|(% style="width:559px" %)(((

227

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

228

229

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

230

231

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.

232

233

Suggestion to use a controlled vocabulary

234

235

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

236

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

or

TITLE: true (false)

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

Either:

* an artefact, or;

* an item in an Item Scheme

246

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

247

For item scheme item:

248

249

<language>:<content>,

250

251

<language>:<content>,…

//Example~://

en:deprecated,fr:obsolète

256

)))|(% style="width:178px" %)<content>|(% style="width:866px" %)(((

For artefact:

)))

|(% style="width:152px" %)DEFAULT|(% style="width:559px" %)(((

264

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

265

266

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

267

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

268

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

273

)))|(% style="width:506px" %) |(% style="width:178px" %)(((

Attached to:

- DSD or Dataflow:

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

278

279

//Example~:// FREQ=A+Q,TIME_PERIOD_START=2013-01,TIME_PERIOD_END=2018-12

280

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

281

|(% style="width:152px" %)IMAGE|(% style="width:559px" %)A visual identity to associate to Item Scheme Items or artefacts|(% style="width:20px" %)(((

Either:

* an artefact, or;

* an item in an item scheme

286

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

287

For localised content in SDMX 2.1

288

289

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

290

291

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

//Example~://

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

296

)))|(% style="width:178px" %) |(% style="width:866px" %)(((

297

See section URL value defaults and specific locale values.

//Example~://

https:~/~/sdmx.org/wp-content/uploads/SDMX_map_small-220x220.jpg

)))

|(% style="width:152px" %)DRILLDOWN_CONCEPTS|(% style="width:559px" %)Concepts to be displayed in a drilldown operation|(% style="width:20px" %)Dataflow or DSD|(% style="width:506px" %) |(% style="width:178px" %)(((

306

<concept Id>,<concept Id>,…

Example :

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

311

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

312

|(% style="width:152px" %)NOT_DISPLAYED|(% style="width:559px" %)Used to hide components or their values in the presentation|(% style="width:20px" %)(((

313

Either:

314

315

* a Dataflow or DSD, or;

316

* an Item in an Item Scheme

317

)))|(% style="width:506px" %) |(% style="width:178px" %)(((

318

Attached to Item in Item Scheme: <blank>

319

320

Attached to Dataflow or DSD:

321

322

<concept Id>,<concept Id>,…

Example :

DD_DIM (to hide drilldown control concept)

327

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

328

|(% style="width:152px" %)LAYOUT_ROW|(% style="width:559px" %)Dimensions to be presented in rows (concepts on y-axis)|(% style="width:20px" %)(((

Either:

* an artefact, or;

* a Dimension

)))|(% style="width:506px" %) |(% style="width:178px" %)(((

334

Attached to Dimension: <blank>

335

336

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

//Example~://

REF_AREA,MEASURE

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

342

|(% style="width:152px" %)LAYOUT_COLUMN|(% style="width:559px" %)Dimensions to be presented in columns (concepts on x-axis)|(% style="width:20px" %)(((

Either:

* an artefact, or;

* a Dimension

)))|(% style="width:506px" %) |(% style="width:178px" %)(((

348

Attached to Dimension: <blank>

349

350

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

//Example~://

TIME_PERIOD

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

356

|(% style="width:152px" %)LAYOUT_FLAG|(% style="width:559px" %)Indication that an attribute and its attribute value should be presented as a flag|(% style="width:20px" %)Dataflow|(% style="width:506px" %) |(% style="width:178px" %)(((

357

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

//Example~://

OBS_STATUS,CONF_STATUS

362

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

363

|(% style="width:152px" %)LAYOUT_NOTE|(% style="width:559px" %)Indication that an attribute and its attribute value should be presented as a note|(% style="width:20px" %)Dataflow|(% style="width:506px" %) |(% style="width:178px" %)(((

364

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

//Example~://

OBS_STATUS,CONF_STATUS

369

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

370

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

METADATA

)))|(% style="width:559px" %)Links an MSD directly to a DSD. Can be used to overcome the complexities of reference metadata linkage|(% style="width:20px" %)DSD|(% style="width:506px" %) |(% style="width:178px" %)MSD URI, e.g. urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataStructure=OECD:MSD_REF_METADATA(1.0)|(% style="width:866px" %)

375

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

Either:

* an artefact, or;

a Dimension

)))|(% style="width:506px" %) |(% style="width:178px" %)(((

382

Attached to Dimension: <blank>

383

384

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

//Example~://

SEX

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

390

|(% style="width:152px" %)EXT_RESOURCE|(% style="width:559px" %)(((

391

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

392

393

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

394

)))|(% style="width:20px" %)Any SDMX object|(% style="width:506px" %)(((

395

For localised content in SDMX 2.1

396

397

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

398

399

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

//Example~://

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

404

)))|(% style="width:178px" %) |(% style="width:866px" %)(((

405

See section URL value defaults and specific locale values.

//Example~://

http:~/~/rdf-vocabulary.ddialliance.org/xkos#depth

410

)))

411

|(% style="width:152px" %)COMBINED_CONCEPTS|(% style="width:559px" %)(((

412

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

413

414

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

415

416

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

417

)))|(% style="width:20px" %)Dataflow or DSD|(% style="width:506px" %)(((

418

<language>:<display name>,

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}

423

)))|(% style="width:178px" %) |(% style="width:866px" %)

424

|(% style="width:152px" %)(deprecated) UNIT_MEASURE_CONCEPTS|(% style="width:559px" %)(((

425

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

426

427

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

428

)))|(% style="width:20px" %)Dataflow or DSD|(% style="width:506px" %) |(% style="width:178px" %)(((

429

<concept Id>,<concept Id>,…

430

431

//Example~:// UNIT_MEASURE,UNIT_MULT,TRANSFORMATION [could generate a value of Australian Dollar, Thousands, Non-transformed]

432

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

433

|(% style="width:152px" %)(deprecated) UNIT_MEASURE_LABEL|(% style="width:559px" %)(((

434

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

435

436

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

437

438

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]]

443

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

444

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

445

446

<language>:<content>,

447

448

<language>:<content>,…

//Example~://

en:USD, thousands

fr:USD, milliers

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

456

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

//Example~://

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

463

464

* National Currency, thousands

465

* USD, thousands

466

467

Index, based on National Currency]

468

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

469

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

470

LAYOUT_TIME_PERIOD_DESC

471

472

473

)))|(% style="width:559px" %)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:20px" %)Dataflow, DSD|(% style="width:506px" %) |(% style="width:178px" %)(((

474

//Example~://

475

476

LAYOUT_TIME_PERIOD_DESC

477

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

478

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

LAYOUT_CELL_ALIGN

)))|(% style="width:559px" %)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:20px" %)Dataflow, DSD, Dimension|(% style="width:506px" %)(((

483

<language>:<content>,

484

485

<language>:<content>,…

486

487

488

<content> values:RIGHT or LEFT

489

)))|(% style="width:178px" %)Content values:RIGHT or LEFT|(% style="width:866px" %)

490

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

MAX_TABLE_DATA

)))|(% style="width:559px" %)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:20px" %)Dataflow|(% style="width:506px" %) |(% style="width:178px" %)(((

//Example~://

15000

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

501

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

502

MAXTEXTATTRIBUTELENGTH

503

504

505

)))|(% style="width:559px" %)Increase the maximum length for textual attribute values|(% style="width:20px" %)DSD|(% style="width:506px" %) |(% style="width:178px" %)(((

//Example~://

500

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

512

|(% style="width:152px" %)SEARCH_WEIGHT|(% style="width:559px" %)Indication of localised boosted dataflows in the search results when ordered by relevance|(% style="width:20px" %)Dataflow|(% style="width:506px" %)(((

513

<language>:<integer>,...

//Example~://

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

518

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

//Example~://

10

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

525

526

== Codelist and Statistical Classification-specific Annotations ==

527

528

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

529

530

531

|**Annotation Type**|(% style="width:524px" %)**Use Case**|(% style="width:198px" %)**Where to attach**|(% style="width:237px" %)(((

532

**+Text

533

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

534

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

535

**Title

536

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

)))|(((

**SDMX 2.1:URL

SDMX >=3.0:+URL

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

541

)))

542

|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

543

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

544

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

545

//Example~://

546

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

547

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

548

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

549

550

//Example~://

551

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

552

)))|

553

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

554

555

//Example~://

556

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

)))|

|FULL_NAME|(% style="width:350px" %)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

578

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

579

<language>:<content>,

580

<language>:<content>,…

581

//Example~://

582

en:Labour force (Employment)

583

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

//Example~://

CUST_BREAKDOWN:CUST_BREAKDOWN_LB

590

)))|

591

|REPLACE_CONTENT|(% style="width:350px" %)Replace the content in a component by the value of another component in an observation or series|(% style="width:250px" %)A Dataflow or DSD|(% style="width:288px" %) |(% style="width:1427px" %)(((

//Example~://

REF_AREA:M49_CODE

)))|

|(% style="width:199px" %)COMPLEMENT|(% style="width:350px" %)(((

599

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

600

601

E.g. Representation of Non-hazardous (NHAZW), hazardous waste (HAZW) in the European List of Wastes

602

en: 01 03 04* acid-generating tailings from processing of sulphide ore (HAZW)

603

en: 01 03 99 wastes not otherwise specified (NHAZW)

604

)))|(% style="width:250px" %)Item in an Item Scheme|(% style="width:288px" %)(((

605

<language>:<content>,

606

607

<language>:<content>,…

//Example~://

en:See reference metadata

612

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

613

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

Either:

* an artefact, or;

* an item in an Item Scheme

618

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

619

<language>:<content>,

620

621

<language>:<content>,…

//Example~://

en:10,es:20

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

)))|

|(% style="width:199px" %)TOTAL|(% style="width:350px" %)(((

632

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

633

634

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

635

636

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

637

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

638

Either:

639

640

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

641

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

642

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

643

<language>:<explanatory text>,

644

645

<language>:<explanatory text>,…

646

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

647

Attached to Code Item: <blank>

648

649

Attached to Codelist: <code>,<code>,…

650

)))|

651

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

Either:

* A Dataflow or DSD

)))|(% style="width:288px" %) |(% style="width:1427px" %)(((

//Example~://

DD_DIM (this concept should be hidden using the NOT_DISPLAYED Annotation below)

661

)))|

662

|(% style="width:199px" %)DEPRECATED|(% style="width:350px" %)(((

663

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

664

665

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

666

667

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.

668

669

Suggestion to use a controlled vocabulary

670

671

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

672

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

or

TITLE: true (false)

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

Either:

* an artefact, or;

* an item in an Item Scheme

682

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

683

For item scheme item:

684

685

<language>:<content>,

686

687

<language>:<content>,…

//Example~://

en:deprecated,fr:obsolète

692

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

For artefact:

)))

|(% style="width:199px" %)DEFAULT|(% style="width:350px" %)(((

700

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

701

702

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

703

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

704

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

709

)))|(% style="width:288px" %) |(% style="width:1427px" %)(((

Attached to:

- DSD or Dataflow:

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

714

715

//Example~:// FREQ=A+Q,TIME_PERIOD_START=2013-01,TIME_PERIOD_END=2018-12

716

)))|

717

|(% style="width:199px" %)IMAGE|(% style="width:350px" %)A visual identity to associate to Item Scheme Items or artefacts|(% style="width:250px" %)(((

Either:

* an artefact, or;

* an item in an item scheme

722

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

723

For localised content in SDMX 2.1

724

725

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

726

727

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

//Example~://

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

732

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

733

See section URL value defaults and specific locale values.

//Example~://

https:~/~/sdmx.org/wp-content/uploads/SDMX_map_small-220x220.jpg

)))

|(% style="width:199px" %)DRILLDOWN_CONCEPTS|(% style="width:350px" %)Concepts to be displayed in a drilldown operation|(% style="width:250px" %)Dataflow or DSD|(% style="width:288px" %) |(% style="width:1427px" %)(((

742

<concept Id>,<concept Id>,…

Example :

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

747

)))|

748

|(% style="width:199px" %)NOT_DISPLAYED|(% style="width:350px" %)Used to hide components or their values in the presentation|(% style="width:250px" %)(((

749

Either:

750

751

* a Dataflow or DSD, or;

752

* an Item in an Item Scheme

753

)))|(% style="width:288px" %) |(% style="width:1427px" %)(((

754

Attached to Item in Item Scheme: <blank>

755

756

Attached to Dataflow or DSD:

757

758

<concept Id>,<concept Id>,…

Example :

DD_DIM (to hide drilldown control concept)

763

)))|

764

|(% style="width:199px" %)LAYOUT_ROW|(% style="width:350px" %)Dimensions to be presented in rows (concepts on y-axis)|(% style="width:250px" %)(((

Either:

* an artefact, or;

* a Dimension

)))|(% style="width:288px" %) |(% style="width:1427px" %)(((

770

Attached to Dimension: <blank>

771

772

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

//Example~://

REF_AREA,MEASURE

)))|

|(% style="width:199px" %)LAYOUT_COLUMN|(% style="width:350px" %)Dimensions to be presented in columns (concepts on x-axis)|(% style="width:250px" %)(((

Either:

* an artefact, or;

* a Dimension

)))|(% style="width:288px" %) |(% style="width:1427px" %)(((

784

Attached to Dimension: <blank>

785

786

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

//Example~://

TIME_PERIOD

)))|

|(% style="width:199px" %)LAYOUT_FLAG|(% style="width:350px" %)Indication that an attribute and its attribute value should be presented as a flag|(% style="width:250px" %)Dataflow|(% style="width:288px" %) |(% style="width:1427px" %)(((

793

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

//Example~://

OBS_STATUS,CONF_STATUS

798

)))|

799

|(% style="width:199px" %)LAYOUT_NOTE|(% style="width:350px" %)Indication that an attribute and its attribute value should be presented as a note|(% style="width:250px" %)Dataflow|(% style="width:288px" %) |(% style="width:1427px" %)(((

800

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

//Example~://

OBS_STATUS,CONF_STATUS

805

)))|

806

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

METADATA

)))|(% style="width:350px" %)Links an MSD directly to a DSD. Can be used to overcome the complexities of reference metadata linkage|(% style="width:250px" %)DSD|(% style="width:288px" %) |(% style="width:1427px" %)MSD URI, e.g. urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataStructure=OECD:MSD_REF_METADATA(1.0)|

811

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

Either:

* an artefact, or;

a Dimension

)))|(% style="width:288px" %) |(% style="width:1427px" %)(((

818

Attached to Dimension: <blank>

819

820

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

//Example~://

SEX

)))|

|(% style="width:199px" %)EXT_RESOURCE|(% style="width:350px" %)(((

827

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

828

829

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

830

)))|(% style="width:250px" %)Any SDMX object|(% style="width:288px" %)(((

831

For localised content in SDMX 2.1

832

833

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

834

835

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

//Example~://

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

840

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

841

See section URL value defaults and specific locale values.

//Example~://

http:~/~/rdf-vocabulary.ddialliance.org/xkos#depth

846

)))

847

|(% style="width:199px" %)COMBINED_CONCEPTS|(% style="width:350px" %)(((

848

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

849

850

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

851

852

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

853

)))|(% style="width:250px" %)Dataflow or DSD|(% style="width:288px" %)(((

854

<language>:<display name>,

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}

859

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

860

|(% style="width:199px" %)(deprecated) UNIT_MEASURE_CONCEPTS|(% style="width:350px" %)(((

861

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

862

863

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

864

)))|(% style="width:250px" %)Dataflow or DSD|(% style="width:288px" %) |(% style="width:1427px" %)(((

865

<concept Id>,<concept Id>,…

866

867

//Example~:// UNIT_MEASURE,UNIT_MULT,TRANSFORMATION [could generate a value of Australian Dollar, Thousands, Non-transformed]

868

)))|

869

|(% style="width:199px" %)(deprecated) UNIT_MEASURE_LABEL|(% style="width:350px" %)(((

870

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

871

872

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

873

874

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]]

879

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

880

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

881

882

<language>:<content>,

883

884

<language>:<content>,…

//Example~://

en:USD, thousands

fr:USD, milliers

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

892

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

//Example~://

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

899

900

* National Currency, thousands

901

* USD, thousands

902

903

Index, based on National Currency]

904

)))|

905

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

906

LAYOUT_TIME_PERIOD_DESC

907

908

909

)))|(% style="width:350px" %)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:250px" %)Dataflow, DSD|(% style="width:288px" %) |(% style="width:1427px" %)(((

910

//Example~://

911

912

LAYOUT_TIME_PERIOD_DESC

913

)))|

914

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

LAYOUT_CELL_ALIGN

)))|(% style="width:350px" %)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:250px" %)Dataflow, DSD, Dimension|(% style="width:288px" %)(((

919

<language>:<content>,

920

921

<language>:<content>,…

922

923

924

<content> values:RIGHT or LEFT

925

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

926

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

MAX_TABLE_DATA

)))|(% style="width:350px" %)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:250px" %)Dataflow|(% style="width:288px" %) |(% style="width:1427px" %)(((

//Example~://

15000

)))|

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

938

MAXTEXTATTRIBUTELENGTH

939

940

941

)))|(% style="width:350px" %)Increase the maximum length for textual attribute values|(% style="width:250px" %)DSD|(% style="width:288px" %) |(% style="width:1427px" %)(((

//Example~://

500

)))|

|(% style="width:199px" %)SEARCH_WEIGHT|(% style="width:350px" %)Indication of localised boosted dataflows in the search results when ordered by relevance|(% style="width:250px" %)Dataflow|(% style="width:288px" %)(((

949

<language>:<integer>,...

//Example~://

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

954

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

//Example~://

10

)))|

= Concept Scheme SDMX:CS_ANNOT =

963

964

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.

965

966

|**Property**|(% style="width:309px" %)**Representation in Concept**|(% style="width:1173px" %)**Description**

967

|**Code**|(% style="width:309px" %)Concept Id|(% style="width:1173px" %)The Annotation Type column, e.g. NOT_DISPLAYED, EXCLUDES

968

|**Name**|(% style="width:309px" %)Concept Name|(% style="width:1173px" %)Short description of the standard Annotation derived from the “Use case” column

969

|**Representation**|(% style="width:309px" %)Concept Core Representation|(% style="width:1173px" %)Allowable type or format for the Annotation

970

|**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

971

|**Artefact(s)**|(% style="width:309px" %)Annotation Type: Artefact(s)|(% style="width:1173px" %)The information in the “Where to attach” column

972

|**URL**|(% style="width:309px" %)Annotation Type: URL|(% style="width:1173px" %)The Annotation URL column. The value is in URL

973

974

== Example of a Concept ==

975

976

|**Concept Id**|NOT_DISPLAYED

977

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

978

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

979

|**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

980

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

981

982

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

983

984

<str:Concept id="NOT_DISPLAYED">

985

<com:Annotations>

986

<com:Annotation>

987

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

988

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

989

</com:Annotation>

990

</com:Annotations>

991

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

992

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

993

<str:CoreRepresentation>

994

<str:TextFormat textType="String"/>

995

</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$]]

1001

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

1002

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

1003

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

1004

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

1005

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

----

Wiki source code of Guidelines on Using SDMX Annotations