Difference between revisions of "Valuelist"

From FMR Knowledge Base
Jump to navigation Jump to search
(Conventions)
(Conventions)
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:SDMX Structures]]
+
[[Category:SDMX 2.1 Structures]]
 
=Overview=
 
=Overview=
A Valuelist is a managed list of values, similar to an [[Codelist|SDMX Codelist]] but unlike a Code the Value Id does not need to conform to the [[Identifiable|SDMX ID]] Type.
+
A Valuelist is a managed list of values, similar to an [[Codelist_V10|SDMX Codelist]] but unlike a Code the Value Id does not need to conform to the [[Identifiable_V10|SDMX ID]] Type.
  
'''Note:''' A Valuelist is not an official part of the SDMX Specification.  It may be supported in version 3.0 of the standard, it is supported in version 10.2.0 of the Fusion Registry.
+
'''Note:''' Value List became an official part of the SDMX standard in version 3.0
 +
 
 +
==Structure Properties==
 +
{| class="wikitable"
 +
! scope=row style="text-align: left;" | Structure Type
 +
| Standard SDMX Structural Metadata Artefact
 +
|-
 +
! scope=row style="text-align: left;"  | Maintainable
 +
| [[Maintainable V10|Yes]]
 +
|-
 +
! scope=row style="text-align: left;"  | Identifiable
 +
| [[Identifiable V10|Yes]]
 +
|-
 +
! scope=row style="text-align: left;"  | Item Scheme
 +
| No
 +
|-
 +
! scope=row style="text-align: left;"  | SDMX Information Model Versions
 +
| 3.0
 +
|-
 +
! scope=row style="text-align: left;"  | Concept ID
 +
| ValueList
 +
|}
  
 
=Example=
 
=Example=
Line 35: Line 56:
 
|}
 
|}
  
==Structure Properties==
+
==Context within the 2.1 Information Model==
{| class="wikitable"
 
! scope=row style="text-align: left;" | Structure Type
 
| Standard SDMX Structural Metadata Artefact
 
|-
 
! scope=row style="text-align: left;"  | Maintainable
 
| [[Maintainable|Yes]]
 
|-
 
! scope=row style="text-align: left;"  | Identifiable
 
| [[Identifiable|Yes]]
 
|-
 
! scope=row style="text-align: left;"  | Item Scheme
 
| [[Item_Scheme|No]]
 
|-
 
! scope=row style="text-align: left;"  | SDMX Information Model Versions
 
| 3.0
 
|-
 
! scope=row style="text-align: left;"  | URN
 
| <nowiki>urn:sdmx:org.sdmx.infomodel.valuelist.Valuelist</nowiki>
 
|}
 
 
 
==Context within the Information Model==
 
 
::[[File:Valuelist Model.png|600px]]
 
::[[File:Valuelist Model.png|600px]]
 
<p>The schematic illustrates the how the Valuelist is used by Data Structure Definitions (DSD).</p>
 
<p>The schematic illustrates the how the Valuelist is used by Data Structure Definitions (DSD).</p>
<p>'''Note''' A valuelist is not an official part of the SDMX Information model at version 2.1, which is currently the latest model.</p>
+
<p>'''Note''' A Valuelist is not an official part of the SDMX Information model at version 2.1, which is currently the latest model.</p>
  
 
==Usage==
 
==Usage==
<p>Valuelists provide an enumerated list of allowable values, for which there is also a mandatory Name and optional description.  This list can be referenced for defining the set of allowed values for enumerated [[Data_Structure_Definition#Data_Structure_Components|Components]] in [[Data Structure Definition|Data Structure Definitions (DSDs)]] or [[Metadata Structure Definition|Metadata Structure Definitions]] which describe [[Reference Metadata]].</p>
+
<p>Valuelists provide an enumerated list of allowable values, for which there is also a mandatory Name and optional description.  This list can be referenced for defining the set of allowed values for enumerated Components [[Data_Structure_Definitions|Data Structure Definitions (DSDs)]] or [[Metadata Structure Definition|Metadata Structure Definitions]] which describe [[Reference Metadata]].</p>
  
 
=Conventions=
 
=Conventions=
Line 69: Line 69:
 
Valielist IDs are given a 'VL_' prefix to distinguish them from other structures. For instance: VL_CURRENCY.
 
Valielist IDs are given a 'VL_' prefix to distinguish them from other structures. For instance: VL_CURRENCY.
 
</p>
 
</p>
[[URN|You can seem more examples and information on Identities in this article]].
+
[[URN V10|You can seem more examples and information on Identities in this article]].

Latest revision as of 06:07, 13 May 2024

Overview

A Valuelist is a managed list of values, similar to an SDMX Codelist but unlike a Code the Value Id does not need to conform to the SDMX ID Type.

Note: Value List became an official part of the SDMX standard in version 3.0

Structure Properties

Structure Type Standard SDMX Structural Metadata Artefact
Maintainable Yes
Identifiable Yes
Item Scheme No
SDMX Information Model Versions 3.0
Concept ID ValueList

Example

The following table is used to demonstrate the types of values that a Valuelist could hold

Id Name Description
$ Dollar -
£ Pound -
% Percent A number or ratio that represents a fraction of 100.

Formats

Format supported Example
SDXM-EDI No -
SDMX-1.0 No -
SDMX-2.0 No -
SDMX-2.1 No -
Fusion-JSON Yes Click Here to View Sample

Context within the 2.1 Information Model

Valuelist Model.png

The schematic illustrates the how the Valuelist is used by Data Structure Definitions (DSD).

Note A Valuelist is not an official part of the SDMX Information model at version 2.1, which is currently the latest model.

Usage

Valuelists provide an enumerated list of allowable values, for which there is also a mandatory Name and optional description. This list can be referenced for defining the set of allowed values for enumerated Components Data Structure Definitions (DSDs) or Metadata Structure Definitions which describe Reference Metadata.

Conventions

'VL_' Valuelist ID Prefix

Valielist IDs are given a 'VL_' prefix to distinguish them from other structures. For instance: VL_CURRENCY.

You can seem more examples and information on Identities in this article.