Difference between revisions of "Data Structure Definitions"

From FMR Knowledge Base
Jump to navigation Jump to search
(Group Attachment)
 
(19 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:FMR_Structures_Reference]]
+
[[Category:Structural Metadata]]
 
+
=Overview=
==Overview==
 
  
 
A Data Structure Definition (DSD) defines a dataset in terms of its Dimensionality and allowable content.  All reported datasets must conform to the definition defined by the DSD.
 
A Data Structure Definition (DSD) defines a dataset in terms of its Dimensionality and allowable content.  All reported datasets must conform to the definition defined by the DSD.
Line 7: Line 6:
 
A DSD Consists of Dimensions, Attributes, and Measures, collectively these are termed Components.  Each Component of a DSD references a Concept to provide a semantic meaning, and optionally a Codelist to provide an enumerated list of allowable content for reported data.
 
A DSD Consists of Dimensions, Attributes, and Measures, collectively these are termed Components.  Each Component of a DSD references a Concept to provide a semantic meaning, and optionally a Codelist to provide an enumerated list of allowable content for reported data.
  
A DSD can include a special type of Dimension known as a Measure Dimension. he Measure Dimension supports the use case of multiple measures.  Unlike a ‘normal’ Dimension, the Measure Dimension cannot reference a Codelist, however it must reference a Concept Scheme which is used to list the allowable measures. Each Concept in the Concept Scheme may provide its own representation which can be enumerated (Codelist) or non-enumerated. When data is reported for the Measure Dimension, the allowable values will depend on the Concept that is being reported in the linked Concept Scheme.
+
=Wizard=
 
+
From the Data menu, select the Data Structure Page and use the maintenance button to create a Data Structure. [[File :cogs.PNG|40px]]<br>
 
 
[[File:DS.PNG|1000px]]<br>
 
 
 
 
 
When Viewing a DSD the Components of the DSD are displayed by showing the Name of the Concept as the Component label, and the allowable content, which may be the referenced Codelist, as shown below.
 
 
 
  
[[File:DSD1.PNG|1000px]]<br>
+
==Step 1 - High Level Details==
  
==Wizard==
+
The steps in a DSD Wizard includes step 1 which provides the generic, high level details about the Data Structure Definition. See this article [https://fmrwiki.sdmxcloud.org/All_Structures for more information on authoring and maintaining structures.]
  
The steps in a DSD Wizard includes step 1 which provides the generic, high level details about the Category Scheme. See [[https://wiki.sdmxcloud.org/Category:FMR_Structures_Reference Structure creating in the Structures Reference options.]]<br>
+
==Step 2 - Concepts==
  
 
The second step of the Wizard allows the user to define all the other Concepts which will be used by the DSD. Each Concept can be assigned a role of Dimension, Measure Dimension, or Attribute.
 
The second step of the Wizard allows the user to define all the other Concepts which will be used by the DSD. Each Concept can be assigned a role of Dimension, Measure Dimension, or Attribute.
  
  
[[File:DSD2.PNG|1000px]]<br>
+
[[File:DSD2.PNG|DSD - Choose Concepts|500px]]<br>
  
 +
==Step 3 - Dimension Position and Content==
 
The third step of the wizard allows the user to define the allowable content for each Component. If the Concept has a default Representation this will be selected by default, however this Representation can be changed if required.
 
The third step of the wizard allows the user to define the allowable content for each Component. If the Concept has a default Representation this will be selected by default, however this Representation can be changed if required.
  
  
[[File:DSD3.PNG|1000px]]<br>
+
[[File:DSD3.PNG|DSD - Position and Content|500px]]<br>
  
 
The allowable content can be enumerated (which is a reference to a Codelist) or non-enumerated (for example Text, Integer, Double, Boolean etc). The allowable content defines what data a user can report when they are supplying a dataset.
 
The allowable content can be enumerated (which is a reference to a Codelist) or non-enumerated (for example Text, Integer, Double, Boolean etc). The allowable content defines what data a user can report when they are supplying a dataset.
  
 +
==Step 4 - Attributes==
 
The final step of the Wizard is to define the assignment status (required or optional) and attachment level (dataset, series, dimension group, observation, group) of Attributes as shown in the screenshot below.
 
The final step of the Wizard is to define the assignment status (required or optional) and attachment level (dataset, series, dimension group, observation, group) of Attributes as shown in the screenshot below.
  
  
[[File:DSD4.PNG|1000px]]<br>
+
[[File:DSD4.PNG|DSD - Attributes|500px]]<br>
  
The purpose of each attachment levels is described below.  
+
The purpose of each attachment levels is described below.
  
==Dataset Attachment==
+
===Dataset Attachment===
An Attribute attaching to a dataset will mean that when data is reported for the dataset, there will be a single value which is provided for the dataset. For example, the '''Unit of Measure''' Attribute could be attached to the dataset if it is expected that all of the observations will always be measured using the same unit.  
+
An Attribute attaching to a dataset will mean that when data is reported for the dataset, there will be a single value which is provided for the dataset. For example, the '''Unit of Measure''' Attribute could be attached to the dataset if it is expected that all the observations will always be measured using the same unit.  
  
==Series Attachment==
+
===Series Attachment===
 
If the Attribute attaches to a Series, then the Attribute will attach itself to every Dimension in the Data Structure Definition, except the Time Dimension. This attachment is used to define that the value for the Attribute can vary for each Series in the dataset. For example, the '''Series Title''' Attribute could attach to a Series, as each series will have a different title.  
 
If the Attribute attaches to a Series, then the Attribute will attach itself to every Dimension in the Data Structure Definition, except the Time Dimension. This attachment is used to define that the value for the Attribute can vary for each Series in the dataset. For example, the '''Series Title''' Attribute could attach to a Series, as each series will have a different title.  
  
 
It is possible to modify this attachment to specify a subset of the Dimensions, if the value for the attribute only relates to a subset.  
 
It is possible to modify this attachment to specify a subset of the Dimensions, if the value for the attribute only relates to a subset.  
  
==Observation Attachment==
+
===Observation Attachment===
 
If a value for an Attribute can change from Observation to Observation, then the attachment level should be set to Observation. An example of an Observation attachment is '''Observation Confidentiality'''.
 
If a value for an Attribute can change from Observation to Observation, then the attachment level should be set to Observation. An example of an Observation attachment is '''Observation Confidentiality'''.
  
==Group Attachment==
+
===Group Attachment===
 
The final attachment is to a pre-defined Group of Dimensions. This is similar to Series Attachment, in that the Attribute will attach to a subset of Dimensions, however the subset is defined by the referenced Group.
 
The final attachment is to a pre-defined Group of Dimensions. This is similar to Series Attachment, in that the Attribute will attach to a subset of Dimensions, however the subset is defined by the referenced Group.
  
Line 58: Line 53:
  
  
[[File:DSD4.PNG|1000px]]<br>
+
[[File:DSD4.PNG|DSD Group Attachment|500px]]<br>
 
 
 
 
 
 
 
 
Back to [[https://wiki.sdmxcloud.org/Category:FMR_Structures_Reference Structures Reference options]]
 

Latest revision as of 00:29, 5 May 2021

Overview

A Data Structure Definition (DSD) defines a dataset in terms of its Dimensionality and allowable content. All reported datasets must conform to the definition defined by the DSD.

A DSD Consists of Dimensions, Attributes, and Measures, collectively these are termed Components. Each Component of a DSD references a Concept to provide a semantic meaning, and optionally a Codelist to provide an enumerated list of allowable content for reported data.

Wizard

From the Data menu, select the Data Structure Page and use the maintenance button to create a Data Structure. Cogs.PNG

Step 1 - High Level Details

The steps in a DSD Wizard includes step 1 which provides the generic, high level details about the Data Structure Definition. See this article for more information on authoring and maintaining structures.

Step 2 - Concepts

The second step of the Wizard allows the user to define all the other Concepts which will be used by the DSD. Each Concept can be assigned a role of Dimension, Measure Dimension, or Attribute.


DSD - Choose Concepts

Step 3 - Dimension Position and Content

The third step of the wizard allows the user to define the allowable content for each Component. If the Concept has a default Representation this will be selected by default, however this Representation can be changed if required.


DSD - Position and Content

The allowable content can be enumerated (which is a reference to a Codelist) or non-enumerated (for example Text, Integer, Double, Boolean etc). The allowable content defines what data a user can report when they are supplying a dataset.

Step 4 - Attributes

The final step of the Wizard is to define the assignment status (required or optional) and attachment level (dataset, series, dimension group, observation, group) of Attributes as shown in the screenshot below.


DSD - Attributes

The purpose of each attachment levels is described below.

Dataset Attachment

An Attribute attaching to a dataset will mean that when data is reported for the dataset, there will be a single value which is provided for the dataset. For example, the Unit of Measure Attribute could be attached to the dataset if it is expected that all the observations will always be measured using the same unit.

Series Attachment

If the Attribute attaches to a Series, then the Attribute will attach itself to every Dimension in the Data Structure Definition, except the Time Dimension. This attachment is used to define that the value for the Attribute can vary for each Series in the dataset. For example, the Series Title Attribute could attach to a Series, as each series will have a different title.

It is possible to modify this attachment to specify a subset of the Dimensions, if the value for the attribute only relates to a subset.

Observation Attachment

If a value for an Attribute can change from Observation to Observation, then the attachment level should be set to Observation. An example of an Observation attachment is Observation Confidentiality.

Group Attachment

The final attachment is to a pre-defined Group of Dimensions. This is similar to Series Attachment, in that the Attribute will attach to a subset of Dimensions, however the subset is defined by the referenced Group.

This option is only available in the list if a Group has been defined. To define, modify, or delete a Group, click on the ‘Manage Groups’ button, which will open a window, as shown below.


DSD Group Attachment