Skip to Content

Wiki source code of 1 Introduction

Version 2.1 by Helena on 2025/05/15 09:59
Hide last authors
Helena 2.1 1 = 1 Introduction =
2
3 This document is not normative but provides a detailed view of the information model on which the normative SDMX specifications are based. Those new to the UML notation or to the concept of Data Structure Definitions may wish to read the appendixes in this document as an introductory exercise.
4
5 == 1.1 Related Documents ==
6
7 This document is one of two documents concerned with the SDMX Information Model. The complete set of documents is:
8
9 * SDMX SECTION 02 INFORMATION MODEL: UML CONCEPTUAL DESIGN (this document): This document comprises the complete definition of the information model, with the exception of the registry interfaces. It is intended for technicians wishing to understand the complete scope of the SDMX technical standards in a syntax neutral form.
10 * SDMX SECTION 05 REGISTRY SPECIFICATION: LOGICAL INTERFACES: This document provides the logical specification for the registry interfaces, including subscription/notification, registration/submission of data and metadata, and querying.
11
12 == 1.2 Modelling Technique and Diagrammatic Notes ==
13
14 The modelling technique used for the SDMX Information Model (SDMX-IM) is the Unified Modelling Language (UML). An overview of the constructs of UML that are used in the SDMXIM can be found in the Appendix “A Short Guide to UML in the SDMX Information Model”
15
16 UML diagramming allows a class to be shown with or without the compartments for one or both of attributes and operations (sometimes called methods). In this document the operations compartment is not shown as there are no operations.
17
18 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_1ce09669.png||height="111" width="324"]]
19
20 **Figure 1 Class with operations suppressed**
21
22 In some diagrams for some classes the attribute compartment is suppressed even though there may be some attributes. This is deliberate and is done to aid clarity of the diagram. The method used is:
23
24 * The attributes will always be present on the class diagram where the class is defined and its attributes and associations are defined.// //
25 * On other diagrams, such as inheritance diagrams, the attributes may be suppressed from the class for clarity.//  //
26
27 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_bbb8fac9.png||height="54" width="158"]]
28
29 **Figure 2 Class with attributes also suppressed**
30
31 Note that, in any case, attributes inherited from a super class are not shown in the sub class.
32
33 The following table structure is used in the definition of the classes, attributes, and associations.
34
35 |**Class**|**Feature**|**Description**
36 |ClassName||
37 ||attributeName|
38 ||associationName|
39 ||+roleName|
40
41 The content in the “Feature” column comprises or explains one of the following structural features of the class:
42
43 * Whether it is an abstract class. Abstract classes are shown in //italic Courier// font.//  //
44 * The superclass this class inherits from, if any.//  //
45 * The sub classes of this class, if any.//  //
46 * Attribute – the attributeName is shown in Courier font.// //
47 * Association – the associationName is shown in Courier font. If the association is derived from the association between super classes, then the format is
48
49 /associationName.// //
50
51 * Role – the +roleName is shown in Courier font.// //
52
53 The Description column provides a short definition or explanation of the Class or Feature. UML class names may be used in the description and if so, they are presented in normal font with spaces between words. For example, the class ConceptScheme will be written as Concept Scheme.
54
55 == 1.3 Overall Functionality ==
56
57 === 1.3.1 Information Model Packages ===
58
59 The SDMX Information Model (SDMX-IM) is a conceptual metamodel from which syntax specific implementations are developed. The model is constructed as a set of functional packages which assist in the understanding, re-use and maintenance of the model.
60
61 In addition to this, in order to aid understanding each package can be considered to be in one of three conceptual layers:
62
63 the SDMX Base layer comprises fundamental building blocks which are used by the Structural Definitions layer and the Reporting and Dissemination layer
64
65 the Structural Definitions layer comprises the definition of the structural artefacts needed to support data and metadata reporting and dissemination
66
67 the Reporting and Dissemination layer comprises the definition of the data and metadata containers used for reporting and dissemination
68
69 In reality the layers have no implicit or explicit structural function as any package can make use of any construct in another package.
70
71 === 1.3.2 Version 1.0 ===
72
73 In version 1.0 the metamodel supported the requirements for:
74
75 Data Structure Definition including (domain) category scheme, (metadata) concept scheme, and code list
76
77 Data and related metadata reporting and dissemination// //
78
79 The SDMX-IM comprises a number of packages. These packages act as convenient compartments for the various sub models in the SDMX-IM. The diagram below shows the sub models of the SDMX-IM that were included in the version 1.0 specification.
80
81 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_c2c05d9c.jpg||height="203" width="612"]]
82
83 **Figure 3: SDMX Information Model Version 1.0 package structure**
84
85 === 1.3.3 Version 2.0/2.1 ===
86
87 The version 2.0/2.1 model extends the functionality of version 1.0. principally in the area of metadata, but also in various ways to define structures to support data analysis by systems with knowledge of cube type structures such as OLAP^^[[^^1^^>>path:#sdfootnote1sym||name="sdfootnote1anc"]]^^ systems. The following major constructs have been added at version 2.0/2.1
88
89 Metadata structure definition
90
91 Metadata set
92
93 Hierarchical Codelist
94
95 Data and Metadata Provisioning
96
97 Process
98
99 Mapping
100
101 Constraints
102
103 Constructs supporting the Registry
104
105 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_59eee18f.gif||alt="Shape1" height="1" width="192"]]
106
107 Furthermore, the term Data Structure Definition replaces the term Key Family: as both of these terms are used in various communities, they are synonymous. The term Data Structure Definition is used in the model and this document.
108
109 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_d8008692.jpg||height="201" width="597"]]
110
111 **Figure 4 SDMX Information Model Version 2.0/2.1 package structure**
112
113 Additional constructs that are specific to a registry-based scenario can be found in the Specification of Registry Interfaces. For information these are shown on the diagram below and comprise:
114
115 * Subscription and Notification
116 * Registration
117 * Discovery
118
119 Note that the data and metadata required for registry functions are not confined to the registry, and the registry also makes use of the other packages in the Information Model.
120
121 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_758d5bb1.jpg||height="201" width="604"]]
122
123 **Figure 5: SDMX Information Model Version 2.0/2.1 package structure including the registry**
124
125 === 1.3.4 Version 3.0 ===
126
127 The version 3.0 model introduces changes in the way reference metadata are handled. In addition, it includes a few more artefacts. Finally, a few abstractions have been added, as shown in section “Basic Inheritance” in “Figure 11: Basic Inheritance from the Base Structures”.
128
129 The IM packages are largely the same.
130
131 1. [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_26bb40b.jpg||height="202" width="613"]]
132 1. **Figure 6: SDMX Information Model version 3.0 package structure**