Changes for page Guidelines on Using SDMX Annotations
Last modified by Artur K. on 2026/05/29 14:28
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -527,119 +527,656 @@ 527 527 528 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 529 530 +|(% style="width:170px" %)Annotation Type|(% style="width:451px" %)Use Case|(% style="width:203px" %)Where to attach|(% style="width:254px" %)((( 531 ++Text 532 +Blue is optional 533 +)))|(% style="width:556.217px" %)((( 534 +Title 535 +Blue is optional 536 +)))|(% style="width:460px" %)((( 537 +SDMX 2.1:URL 530 530 531 -|**Annotation Type**|(% style="width:524px" %)**Use Case**|(% style="width:198px" %)**Where to attach**|(% style="width:237px" %)((( 539 +SDMX >=3.0:+URL 540 + 541 +Blue is optional 542 +))) 543 +|(% style="width:170px" %)ORIGINAL_CODE|(% style="width:451px" %)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:203px" %)Item in an Item Scheme|(% style="width:254px" %) |(% style="width:556.217px" %)((( 544 +<original code> 545 + 546 +//Examples~:// 547 + 548 +* 0105.13 [Harmonized System] 549 +* 11.2.0.9 [COICOP classification] 550 +)))|(% style="width:460px" %) 551 +|(% style="width:170px" %)HIER_CONTEXT|(% style="width:451px" %)((( 552 +In SDMX 2.1, a reference between a usage context and a hierarchy (that may be contained in a Hierarchical Codelist (HCL)). 553 +In SDMX 3.0, use the HierarchyAssociation artefact 554 +)))|(% style="width:203px" %)DSD or Dataflow|(% style="width:254px" %) |(% style="width:556.217px" %)((( 555 +<component Id>:<HCL Id>.<hierarchy Id> 556 + 557 +//Example~:// 558 + 559 +REF_AREA:OECD.EDU:HCL_REF_AREA(1.0).REF_AREA provides the link to the reference area hierarchy for OECD education data 560 +)))|(% style="width:460px" %) 561 +|(% style="width:170px" %)HIER_LEVEL|(% style="width:451px" %)((( 562 +Explicit specification of the hierarchical level of a code item 563 +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]] 564 + 565 +text en:sections 566 +)))|(% style="width:203px" %)Code item|(% style="width:254px" %) |(% style="width:556.217px" %)((( 567 +<hierarchical level> 568 + 569 +//Example~:// 570 + 571 +1 572 +)))|(% style="width:460px" %) 573 +|(% style="width:170px" %)SHORT_LABEL|(% style="width:451px" %)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:203px" %)Artefact, or Concept, or Item in an Item Scheme|(% style="width:254px" %)((( 574 +<language>:<content>, <language>:<content>,… 575 +)))|(% style="width:556.217px" %)((( 576 +//Example~:// 577 + 578 +[Official French label “Transformation et conservation de la viande de boucherie” is shortened to] fr:Transf. & conserv. viande de boucherie 579 + 580 +In Codelist=IMF:CL_AREA(1.13) 581 +Code 4J837 European Union Intellectual Property Office has a Short_Label 582 + 583 +EN:EUIPO 584 +)))|(% style="width:460px" %) 585 +|(% style="width:170px" %)EXPLAN_LABEL|(% style="width:451px" %)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:203px" %)Item in an Item Scheme, mapping to Representation Maps|(% style="width:254px" %)((( 586 +<language>:<content>, <language>:<content>,… 587 +)))|(% style="width:556.217px" %)((( 588 +//Example~:// 589 + 590 +[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 591 +)))|(% style="width:460px" %) 592 +|(% style="width:170px" %)EXPLAN_CONSOL|(% style="width:451px" %)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:203px" %)Item in an Item Scheme, mapping to Representation Maps|(% style="width:254px" %)((( 593 +<language>:<content>, 594 + 595 +<language>:<content>,… 596 +)))|(% style="width:556.217px" %)((( 597 +Example (from the US NAICS classification): 598 + 599 +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. 600 +)))|(% style="width:460px" %) 601 +|(% style="width:170px" %)EXPLAN_INCLUDES|(% style="width:451px" %)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:203px" %)Item in an Item Scheme, mapping to Representation Maps|(% style="width:254px" %)((( 602 +<language>:<content>, 603 + 604 +<language>:<content>,… 605 +)))|(% style="width:556.217px" %)((( 606 +Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition): 607 + 608 +en: This class includes: 609 + 610 +* manufacture of heavy weapons (artillery, mobile guns, rocket launchers, torpedo tubes, heavy machine guns) 611 +* manufacture of small arms (revolvers, shotguns, light machine guns) 612 +* manufacture of air or gas guns and pistols 613 +* manufacture of war ammunition 614 +)))|(% style="width:460px" %) 615 +|(% style="width:170px" %)EXPLAN_CASELAW|(% style="width:451px" %)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:203px" %)Item in an Item Scheme|(% style="width:254px" %)((( 616 +<language>:<content>, 617 + 618 +<language>:<content>,… 619 + 620 +Example (from NACE Rev. 2 caselaw to code 01.62): 621 + 622 +en:Automated egg hatching for poultry - Operation of livestock management systems] 623 +)))|(% style="width:556.217px" %) |(% style="width:460px" %) 624 +|(% style="width:170px" %)EXPLAN_INCLUDES_ALSO|(% style="width:451px" %)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:203px" %)Item in an Item Scheme|(% style="width:254px" %)((( 625 +<language>:<content>, 626 + 627 +<language>:<content>,… 628 +)))|(% style="width:556.217px" %)((( 629 +Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition): 630 + 631 +en:This class also includes: 632 + 633 +* manufacture of hunting, sporting or protective firearms and ammunition 634 +* manufacture of explosive devices such as bombs, mines and torpedoes 635 +)))|(% style="width:460px" %) 636 +|(% style="width:170px" %)EXPLAN_EXCLUDES|(% style="width:451px" %)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:203px" %)((( 637 +Item in an Item Scheme 638 + 639 + 640 +)))|(% style="width:254px" %)((( 641 +<language>:<content>, 642 + 643 +<language>:<content>,… 644 +)))|(% style="width:556.217px" %)((( 645 +Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition): 646 + 647 +en:This class excludes: 648 + 649 +* manufacture of percussion caps, detonators or signalling flares, see 2029 650 +* manufacture of cutlasses, swords, bayonets etc., see 2593 651 +)))|(% style="width:460px" %) 652 +|(% style="width:170px" %)MAP_REFER|(% style="width:451px" %)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:203px" %)Codelist, Concept Scheme, or another Item Scheme|(% style="width:254px" %) |(% style="width:556.217px" %)Id of an ItemSchemeMap returned by the Annotation URL|(% style="width:460px" %)((( 653 +See section URL value defaults and specific locale values. 654 + 655 + 656 +))) 657 +|(% style="width:170px" %)COMP_RULE|(% style="width:451px" %)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:203px" %)An Item in an Item Scheme|(% style="width:254px" %) |(% style="width:556.217px" %)((( 658 +<content> 659 + 660 +//Example~:// 661 + 662 +A1+A2 663 +)))|(% style="width:460px" %) 664 +|(% style="width:170px" %)FOLLOWS|(% style="width:451px" %)((( 665 +A reference used to express the succession in time of Item Schemes. 666 +For example, NACE Rev. 2 is the successor of NACE Rev. 1.1 667 +Reference to external standard: skos:ConceptScheme - property: xkos:follows 668 +)))|(% style="width:203px" %)Codelist or Item Scheme|(% style="width:254px" %) |(% style="width:556.217px" %) |(% style="width:460px" %)((( 669 +See section URL value defaults and specific locale values. 670 + 671 +//Example~:// 672 + 673 +(CL_REGIONAL 3.1.1 follows CL_REGIONAL 3.1): 674 + 675 +[[https:~~/~~/registry.sdmx.org/ws/public/sdmxapi/rest/codelist/ESTAT/CL_REGIONAL/3.1>>url:https://registry.sdmx.org/ws/public/sdmxapi/rest/codelist/ESTAT/CL_REGIONAL/3.1]] 676 +))) 677 +|(% style="width:170px" %)HAS_VARIANT|(% style="width:451px" %)((( 678 +A reference used to express the relation between an Item Scheme and its variant(s). 679 +Reference to external standard: skos:ConceptScheme - property: xkos:variant 680 +For //Example~:// CL_AREA has a variant CL_GEO 681 +)))|(% style="width:203px" %)Codelist or Item Scheme|(% style="width:254px" %) |(% style="width:556.217px" %) |(% style="width:460px" %)((( 682 +See section URL value defaults and specific locale values. 683 + 684 + 685 +))) 686 +|(% style="width:170px" %)SUPERSEED|(% style="width:451px" %)((( 687 +A reference to a previous version, if the current version obsoleted the previous one. 688 +May be used in conjunction with DEPRECATED. 689 +Reference to external standard: skos:ConceptScheme - property: xkos:supersedes 690 +)))|(% style="width:203px" %)Codelist or Item Scheme, or an artefact|(% style="width:254px" %) |(% style="width:556.217px" %) |(% style="width:460px" %)((( 691 +See section URL value defaults and specific locale values. 692 + 693 + 694 +))) 695 +|(% style="width:170px" %)FAMILY_LABEL|(% style="width:451px" %)((( 696 +Label of the Classification Family (e.g. NACE, ISIC) 697 + 698 +Reference to external standard: 699 +skos:ConceptScheme - property: xkos:belongsTo 700 +label of the classification 701 +)))|(% style="width:203px" %)Codelist or Item Scheme|(% style="width:254px" %)((( 702 +<language>:<content>, 703 + 704 +<language>:<content>,… 705 + 706 +//Example~:// 707 + 708 +en:NACE 709 +)))|(% style="width:556.217px" %) |(% style="width:460px" %)((( 710 +See section URL value defaults and specific locale values. 711 + 712 + 713 +))) 714 +|(% style="width:170px" %)COVERAGE_LABEL|(% style="width:451px" %)((( 715 +Label(s) of the item scheme’s coverage (e.g. National Accounts, Products, Activities, Occupations) 716 + 717 +Reference to external standard: skos:ConceptScheme - property: xkos:covers 718 + 719 +//Examples~:// 720 + 721 +URL <http:~/~/eurovoc.europa.eu/56> (National accounts) 722 + 723 +URL <http:~/~/publications.europa.eu/resource/authority/data-theme/REGI> (Regions and Cities) 724 +)))|(% style="width:203px" %)Codelist or Item Scheme|(% style="width:254px" %)((( 725 +<language>:<content>, 726 + 727 +<language>:<content>,… 728 + 729 +//Example~:// 730 + 731 +En:national accounts 732 +)))|(% style="width:556.217px" %) |(% style="width:460px" %)((( 733 +See section URL value defaults and specific locale values. 734 + 735 + 736 +))) 737 +|(% style="width:170px" %)GEO_FEATURE_SET|(% style="width:451px" %)((( 738 +In Codelists, transmits GeoFeature values. 739 + 740 +Example for NUTS ID BE23 741 +url:[[http:~~/~~/data.europa.eu/nuts/geometry/2xr1qiv9>>url:http://data.europa.eu/nuts/geometry/2xr1qiv9]] 742 +)))|(% style="width:203px" %)Code in a Codelist. The Codelist must have an annotation attached with AnnotationType=GEO_TYPE_GEOGRAPHIC|(% style="width:254px" %) |(% style="width:556.217px" %)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:460px" %) 743 +|(% style="width:170px" %)GEO_TYPE_GEOGRAPHIC|(% style="width:451px" %)Indicates that a codelist contains GeoFeature values via the GEO_FEATURE_SET annotation.|(% style="width:203px" %)Codelist|(% style="width:254px" %) |(% style="width:556.217px" %) |(% style="width:460px" %) 744 +|(% style="width:170px" %)LEGAL_BASIS|(% style="width:451px" %)((( 745 +Indicates that the Legislation on which the codelist/nomenclature is based. 746 + 747 +Example for NACE Rev.2.1 748 + 749 +url: [[http:~~/~~/data.europa.eu/eli/reg_del/2023/137/oj>>url:http://data.europa.eu/eli/reg_del/2023/137/oj]] 750 +)))|(% style="width:203px" %)Codelist|(% style="width:254px" %) |(% style="width:556.217px" %) |(% style="width:460px" %)http:~/~/data.europa.eu/eli/reg_del/2023/137/oj 751 + 752 + 753 + 754 +|**Annotation Type**|**Use Case**|**Where to attach**|((( 532 532 **+Text 533 533 (% style="background-color:transparent" %)Blue is optional(%%)** 534 -)))|( % style="width:320px" %)(((757 +)))|((( 535 535 **Title 536 536 (% style="background-color:transparent" %)Blue is optional(%%)** 537 -)))|( % style="width:203px" %)(((760 +)))|((( 538 538 **SDMX 2.1:URL 539 539 SDMX >=3.0:+URL 540 540 (% style="background-color:transparent" %)Blue is optional(%%)** 541 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>,… 765 +| | | | | | 766 +| | | | | | 767 +| | | | | | 768 +| | | | | | 769 +| | | | | | 770 +| | | | | | 771 +| | | | | | 772 +| | | | | | 773 +| | | | | | 774 +| | | | | | 775 +| | | | | | 776 +| | | | | | 777 +| | | | | | 778 +| | | | | | 779 +| | | | | | 780 +| | | | | | 781 +| | | | | | 782 +| | | | | | 783 +| | | | | | 784 + 785 + 786 + 787 + 788 +|Annotation Type|Use Case|Where to attach|(% style="width:288px" %)((( 789 ++TextBlue is optional 790 +)))|(% style="width:1427px" %)((( 791 +TitleBlue is optional 792 +)))|((( 793 +SDMX 2.1:URLSDMX >=3.0:+URLBlue is optional 794 +))) 795 +|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 796 +en: A0123 Growing of citrus fruits|Item in an Item Scheme|(% style="width:288px" %)((( 797 +<language>:<content>, 798 +<language>:<content>,… 545 545 //Example~:// 546 - (% style="background-color:transparent" %)en:Labour force (Employment)547 -)))|(% style="width: 320px" %)<content>|(%style="width:203px" %)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:320px" %)(((800 +en:Labour force (Employment) 801 +)))|(% style="width:1427px" %)<content>| 802 +|REPLACE_NAME|Replace each code name in a component by the value of another component in an observation or series|A Dataflow or DSD|(% style="width:288px" %) |(% style="width:1427px" %)((( 549 549 <component Id to replace name>:<component Id to use name> 804 + 550 550 //Example~:// 551 -(% style="background-color:transparent" %)CUST_BREAKDOWN:CUST_BREAKDOWN_LB 552 -)))|(% style="width:203px" %) 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:320px" %)((( 806 + 807 +CUST_BREAKDOWN:CUST_BREAKDOWN_LB 808 +)))| 809 +|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" %)((( 554 554 <component Id to replace content>:<component Id to use content> 811 + 555 555 //Example~:// 556 -(% style="background-color:transparent" %)REF_AREA:M49_CODE 557 -)))|(% style="width:203px" %) 558 -|COMPLEMENT|(% style="width:524px" %)((( 813 + 814 +REF_AREA:M49_CODE 815 +)))| 816 +|(% style="width:199px" %)COMPLEMENT|(% style="width:350px" %)((( 559 559 Additional fixed text to be displayed in parenthesis after the code name. 560 -(% style="background-color:transparent" %)E.g. Representation of Non-hazardous (NHAZW), hazardous waste (HAZW) in the European List of Wastes(%%) 561 -(% style="background-color:transparent" %)en: 01 03 04* acid-generating tailings from processing of sulphide ore (HAZW)(%%) 562 -(% style="background-color:transparent" %)en: 01 03 99 wastes not otherwise specified (NHAZW) 563 -)))|(% style="width:198px" %)Item in an Item Scheme|(% style="width:237px" %)((( 564 -<language>:<content>,<language>:<content>,… 565 565 819 +E.g. Representation of Non-hazardous (NHAZW), hazardous waste (HAZW) in the European List of Wastes 820 +en: 01 03 04* acid-generating tailings from processing of sulphide ore (HAZW) 821 +en: 01 03 99 wastes not otherwise specified (NHAZW) 822 +)))|(% style="width:250px" %)Item in an Item Scheme|(% style="width:288px" %)((( 823 +<language>:<content>, 824 + 825 +<language>:<content>,… 826 + 566 566 //Example~:// 567 -(% style="background-color:transparent" %)en:See reference metadata 568 -)))|(% style="width:320px" %)<content>|(% style="width:203px" %) 569 -|ORDER|(% style="width:524px" %)Explicit indication of a localised order of items in Items Schemes or artefacts (e.g. Codelist, Concept Scheme, Category Scheme, Dataflow, etc.)|(% style="width:198px" %)((( 828 + 829 +en:See reference metadata 830 +)))|(% style="width:1427px" %)<content>| 831 +|(% 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" %)((( 570 570 Either: 571 571 572 572 * an artefact, or; 573 573 * an item in an Item Scheme 574 -)))|(% style="width:2 37px" %)(((575 -<language>:<content>, <language>:<content>,…836 +)))|(% style="width:288px" %)((( 837 +<language>:<content>, 576 576 839 +<language>:<content>,… 840 + 577 577 //Example~:// 578 -(% style="background-color:transparent" %)en:10,es:20 579 -)))|(% style="width:320px" %)<content>|(% style="width:203px" %) 580 -|TOTAL|(% style="width:524px" %)((( 842 + 843 +en:10,es:20 844 +)))|(% style="width:1427px" %)((( 845 +<content> 846 + 847 + 848 +)))| 849 +|(% style="width:199px" %)TOTAL|(% style="width:350px" %)((( 581 581 Code Item that represents a total value. If the attachment is: 582 582 583 583 * to a Code, the Annotation Text is optional and may contain an explanatory text; 584 -* to a Codelist, the Annotation Title is mandatory and includes the code(s) that represent a total 585 -)))|(% style="width:198px" %)((( 853 + 854 +to a Codelist, the Annotation Title is mandatory and includes the code(s) that represent a total 855 +)))|(% style="width:250px" %)((( 586 586 Either: 587 587 588 588 * a Code Item that represents a total value, or; 589 589 * a Codelist to specify the code(s) with the total 590 -)))|(% style="width:237px" %)((( 591 -<language>:<explanatory text>, 592 -(% style="background-color:transparent" %)<language>:<explanatory text>,… 593 -)))|(% style="width:320px" %)((( 860 +)))|(% style="width:288px" %)((( 861 +<language>:<explanatory text>, 862 + 863 +<language>:<explanatory text>,… 864 +)))|(% style="width:1427px" %)((( 594 594 Attached to Code Item: <blank> 595 -(% style="background-color:transparent" %)Attached to Codelist: <code>,<code>,… 596 -)))|(% style="width:203px" %) 597 -|DRILLDOWN|(% style="width:524px" %)Denotes the concept that specifies whether observations are at the aggregate level or a drilldown.|(% style="width:198px" %)((( 866 + 867 +Attached to Codelist: <code>,<code>,… 868 +)))| 869 +|(% 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" %)((( 598 598 Either: 599 599 600 600 * A Dataflow or DSD 601 -)))|(% style="width:2 37px" %) |(% style="width:320px" %)(((873 +)))|(% style="width:288px" %) |(% style="width:1427px" %)((( 602 602 <concept Id> 875 + 603 603 //Example~:// 604 -(% style="background-color:transparent" %)DD_DIM (this concept should be hidden using the NOT_DISPLAYED Annotation below) 605 -)))|(% style="width:203px" %) 606 -|DEPRECATED|(% style="width:524px" %)((( 877 + 878 +DD_DIM (this concept should be hidden using the NOT_DISPLAYED Annotation below) 879 +)))| 880 +|(% style="width:199px" %)DEPRECATED|(% style="width:350px" %)((( 607 607 Indication that an Item in an Item Scheme or an artefact is deprecated. 882 + 608 608 For an item scheme item, the annotation value provides a replacement name for the code name. 884 + 609 609 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. 886 + 610 610 Suggestion to use a controlled vocabulary 888 + 611 611 url: <[[http:~~/~~/publications.europa.eu/resource/authority/concept-status/CURRENT>>url:http://publications.europa.eu/resource/authority/concept-status/CURRENT]]> 612 612 url: <[[http:~~/~~/publications.europa.eu/resource/authority/concept-status/DEPRECATED>>url:http://publications.europa.eu/resource/authority/concept-status/DEPRECATED]]> 613 -or 614 -(% style="background-color:transparent" %)TITLE: true (false) 615 -)))|(% style="width:198px" %)((( 891 + 892 +or 893 + 894 +TITLE: true (false) 895 +)))|(% style="width:250px" %)((( 616 616 Either: 617 617 618 618 * an artefact, or; 619 619 * an item in an Item Scheme 620 -)))|(% style="width:2 37px" %)(((900 +)))|(% style="width:288px" %)((( 621 621 For item scheme item: 622 622 623 -<language>:<content>, <language>:<content>,…903 +<language>:<content>, 624 624 905 +<language>:<content>,… 906 + 625 625 //Example~:// 626 -(% style="background-color:transparent" %)en:deprecated,fr:obsolète 627 -)))|(% style="width:320px" %)<content>|(% style="width:203px" %)((( 908 + 909 +en:deprecated,fr:obsolète 910 +)))|(% style="width:1427px" %)<content>|((( 628 628 For artefact: 912 + 629 629 <see section URL value defaults and specific locale values> 914 + 915 + 630 630 ))) 631 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 632 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 633 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 634 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 635 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 636 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 637 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 638 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 639 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 640 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 641 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 917 +|(% style="width:199px" %)DEFAULT|(% style="width:350px" %)((( 918 +Indication that an item in an Item Scheme or artefacts is to be selected by default. 642 642 920 +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 921 +)))|(% style="width:250px" %)((( 922 +* Item in ItemScheme, or; 923 +* DSD, or; 924 +* a Dataflow 925 + 926 +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. 927 +)))|(% style="width:288px" %) |(% style="width:1427px" %)((( 928 +Attached to: 929 + 930 +- DSD or Dataflow: 931 +**<concept>=<code>+<code>+…,<concept>=<code>+<code>+…** 932 + 933 +//Example~:// FREQ=A+Q,TIME_PERIOD_START=2013-01,TIME_PERIOD_END=2018-12 934 +)))| 935 +|(% style="width:199px" %)IMAGE|(% style="width:350px" %)A visual identity to associate to Item Scheme Items or artefacts|(% style="width:250px" %)((( 936 +Either: 937 + 938 +* an artefact, or; 939 +* an item in an item scheme 940 +)))|(% style="width:288px" %)((( 941 +For localised content in SDMX 2.1 942 + 943 +<language>:<HTML containing URL to the resource>, 944 + 945 +<language>:<HTML containing URL to the resource>,… 946 + 947 +//Example~:// 948 + 949 +en:<a href=”https:~/~/sdmx.org/wp-content/uploads/SDMX_map_small-220x220.jpg”> 950 +)))|(% style="width:1427px" %) |((( 951 +See section URL value defaults and specific locale values. 952 + 953 +//Example~:// 954 + 955 +https:~/~/sdmx.org/wp-content/uploads/SDMX_map_small-220x220.jpg 956 + 957 + 958 +))) 959 +|(% 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" %)((( 960 +<concept Id>,<concept Id>,… 961 + 962 +Example : 963 + 964 +DONOR,RECIPIENT,YEAR,PROJECT_ID,OBS_VALUE,DESCRIPTION,OWNER 965 +)))| 966 +|(% style="width:199px" %)NOT_DISPLAYED|(% style="width:350px" %)Used to hide components or their values in the presentation|(% style="width:250px" %)((( 967 +Either: 968 + 969 +* a Dataflow or DSD, or; 970 +* an Item in an Item Scheme 971 +)))|(% style="width:288px" %) |(% style="width:1427px" %)((( 972 +Attached to Item in Item Scheme: <blank> 973 + 974 +Attached to Dataflow or DSD: 975 + 976 +<concept Id>,<concept Id>,… 977 + 978 +Example : 979 + 980 +DD_DIM (to hide drilldown control concept) 981 +)))| 982 +|(% style="width:199px" %)LAYOUT_ROW|(% style="width:350px" %)Dimensions to be presented in rows (concepts on y-axis)|(% style="width:250px" %)((( 983 +Either: 984 + 985 +* an artefact, or; 986 +* a Dimension 987 +)))|(% style="width:288px" %) |(% style="width:1427px" %)((( 988 +Attached to Dimension: <blank> 989 + 990 +Attached to Dataflow or DSD: <dimension Id>,<dimension Id >,… 991 + 992 +//Example~:// 993 + 994 +REF_AREA,MEASURE 995 +)))| 996 +|(% style="width:199px" %)LAYOUT_COLUMN|(% style="width:350px" %)Dimensions to be presented in columns (concepts on x-axis)|(% style="width:250px" %)((( 997 +Either: 998 + 999 +* an artefact, or; 1000 +* a Dimension 1001 +)))|(% style="width:288px" %) |(% style="width:1427px" %)((( 1002 +Attached to Dimension: <blank> 1003 + 1004 +Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,… 1005 + 1006 +//Example~:// 1007 + 1008 +TIME_PERIOD 1009 +)))| 1010 +|(% 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" %)((( 1011 +<concept Id>,<concept Id>,... 1012 + 1013 +//Example~:// 1014 + 1015 +OBS_STATUS,CONF_STATUS 1016 +)))| 1017 +|(% 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" %)((( 1018 +<concept Id>,<concept Id>,... 1019 + 1020 +//Example~:// 1021 + 1022 +OBS_STATUS,CONF_STATUS 1023 +)))| 1024 +|(% style="width:199px" %)((( 1025 +METADATA 1026 + 1027 + 1028 +)))|(% 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)| 1029 +|(% 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" %)((( 1030 +Either: 1031 + 1032 +* an artefact, or; 1033 + 1034 +a Dimension 1035 +)))|(% style="width:288px" %) |(% style="width:1427px" %)((( 1036 +Attached to Dimension: <blank> 1037 + 1038 +Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,… 1039 + 1040 +//Example~:// 1041 + 1042 +SEX 1043 +)))| 1044 +|(% style="width:199px" %)EXT_RESOURCE|(% style="width:350px" %)((( 1045 +A localised link to an external resource associated to the annotated artefact. For example, an ontology item 1046 + 1047 +//a methodology// en:<a href:"[[https:~~/~~/ec.europa.eu/eurostat/web/waste/methodology>>url:https://ec.europa.eu/eurostat/web/waste/methodology]]"> 1048 +)))|(% style="width:250px" %)Any SDMX object|(% style="width:288px" %)((( 1049 +For localised content in SDMX 2.1 1050 + 1051 + <language>:<HTML containing URL to the resource>, 1052 + 1053 +<language>:<HTML containing URL to the resource>,… 1054 + 1055 +//Example~:// 1056 + 1057 +en:<a href=”[[http:~~/~~/rdf-vocabulary.ddialliance.org/xkos#depth>>url:http://rdf-vocabulary.ddialliance.org/xkos#depth]]”> 1058 +)))|(% style="width:1427px" %) |((( 1059 +See section URL value defaults and specific locale values. 1060 + 1061 +//Example~:// 1062 + 1063 +http:~/~/rdf-vocabulary.ddialliance.org/xkos#depth 1064 +))) 1065 +|(% style="width:199px" %)COMBINED_CONCEPTS|(% style="width:350px" %)((( 1066 +Comma-separated list of concept IDs to show as a concatenated label. 1067 + 1068 +The listed concepts’ item contents may be concatenated to generate the target concept. 1069 + 1070 +Multiple target concept combinations can be defined by separating the target concepts by ; 1071 +)))|(% style="width:250px" %)Dataflow or DSD|(% style="width:288px" %)((( 1072 +<language>:<display name>, 1073 + 1074 +<language>:<display name> 1075 + 1076 +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} 1077 +)))|(% style="width:1427px" %) | 1078 +|(% style="width:199px" %)(deprecated) UNIT_MEASURE_CONCEPTS|(% style="width:350px" %)((( 1079 +Comma-separated list of concept IDs that is used to define the full unit of measure. The concepts must be in the DSD. 1080 + 1081 +The listed concepts’ item contents may be concatenated to generate the unit of measure label (unless the UNIT_MEASURE_LABEL annotation is present). 1082 +)))|(% style="width:250px" %)Dataflow or DSD|(% style="width:288px" %) |(% style="width:1427px" %)((( 1083 +<concept Id>,<concept Id>,… 1084 + 1085 +//Example~:// UNIT_MEASURE,UNIT_MULT,TRANSFORMATION [could generate a value of Australian Dollar, Thousands, Non-transformed] 1086 +)))| 1087 +|(% style="width:199px" %)(deprecated) UNIT_MEASURE_LABEL|(% style="width:350px" %)((( 1088 +Indicates the concept that enumerates the full unit of measure labels. 1089 + 1090 +The concept must be in the DSD. UNIT_MEASURE_LABEL overrides the UNIT_MEASURE_CONCEPTS if both are provided. 1091 + 1092 +Also can be attached to items in item scheme, e.g. 1093 + 1094 +Text en:Gram 1095 + fr: Gramme 1096 +url:** **[[**http:~~/~~/data.europa.eu/gzn/su/G**>>url:http://data.europa.eu/gzn/su/G]] 1097 +)))|(% style="width:250px" %)Dataflow or DSD, Item in an Item Scheme|(% style="width:288px" %)((( 1098 +This is optional, used if a freetext label is required. 1099 + 1100 +<language>:<content>, 1101 + 1102 +<language>:<content>,… 1103 + 1104 +//Example~:// 1105 + 1106 +en:USD, thousands 1107 + 1108 +fr:USD, milliers 1109 +)))|(% style="width:1427px" %)((( 1110 +This is optional, used if an enumerated list is required. 1111 + 1112 +<concept Id> 1113 + 1114 +//Example~:// 1115 + 1116 +UOM_ATTRIBUTE [This concept may contain the following items as units of measure: 1117 + 1118 +* National Currency, thousands 1119 +* USD, thousands 1120 + 1121 +Index, based on National Currency] 1122 +)))| 1123 +|(% style="width:199px" %)((( 1124 +LAYOUT_TIME_PERIOD_DESC 1125 + 1126 + 1127 +)))|(% 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" %)((( 1128 +//Example~:// 1129 + 1130 +LAYOUT_TIME_PERIOD_DESC 1131 +)))| 1132 +|(% style="width:199px" %)((( 1133 +LAYOUT_CELL_ALIGN 1134 + 1135 + 1136 +)))|(% 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" %)((( 1137 +<language>:<content>, 1138 + 1139 +<language>:<content>,… 1140 + 1141 + 1142 +<content> values:RIGHT or LEFT 1143 +)))|(% style="width:1427px" %)Content values:RIGHT or LEFT| 1144 +|(% style="width:199px" %)((( 1145 +MAX_TABLE_DATA 1146 + 1147 + 1148 +)))|(% 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" %)((( 1149 +<integer> 1150 + 1151 +//Example~:// 1152 + 1153 +15000 1154 +)))| 1155 +|(% style="width:199px" %)((( 1156 +MAXTEXTATTRIBUTELENGTH 1157 + 1158 + 1159 +)))|(% style="width:350px" %)Increase the maximum length for textual attribute values|(% style="width:250px" %)DSD|(% style="width:288px" %) |(% style="width:1427px" %)((( 1160 +<integer> 1161 + 1162 +//Example~:// 1163 + 1164 +500 1165 +)))| 1166 +|(% 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" %)((( 1167 +<language>:<integer>,... 1168 + 1169 +//Example~:// 1170 + 1171 +"en":"3","es":"4","fr":"5" 1172 +)))|(% style="width:1427px" %)((( 1173 +<integer> 1174 + 1175 +//Example~:// 1176 + 1177 +10 1178 +)))| 1179 + 643 643 = Concept Scheme SDMX:CS_ANNOT = 644 644 645 645 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.