Difference between revisions of "Fusion-JSON"
(→Overview) |
|||
(24 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
[[Category:FMR Formats Reference]] | [[Category:FMR Formats Reference]] | ||
=Overview= | =Overview= | ||
− | Fusion-JSON is a format used for [[Structural_Metadata|Structural Metadata]], Data, and [[Reference Metadata]]. The Fusion-JSON format was created before the [[SDMX-JSON]] format became a standard as so has a slightly different syntax. In addition the Fusion-JSON format is used for [[Structural_Metadata|Structural Metadata]] that is supported by the Fusion Registry which is not a part of the official SDMX Specification. This includes: | + | Fusion-JSON is a format used for [[Structural_Metadata|Structural Metadata]], Data, and [[Reference Metadata]]. The Fusion-JSON format was created before the [[SDMX-JSON_Structure|SDMX-JSON]] format became a standard as so has a slightly different syntax. In addition the Fusion-JSON format is used for [[Structural_Metadata|Structural Metadata]] that is supported by the Fusion Metadata Registry which is not a part of the official SDMX Specification. This includes: |
− | * [[ | + | * [[Excel_Reporting_Template|Data Reporting Template]] |
− | * | + | * Data Structure Definitions that do not conform to the standard<sup>1</sup> |
* [[Valuelist]] | * [[Valuelist]] | ||
− | * [[Validation Scheme]] | + | * [[Validation_Scheme|Validation Scheme]] |
+ | Fusion-JSON can be used as an import and export format in Fusion Metadata Registry for both data and structures. | ||
− | + | It is the only format that supports all of the structures used in Fusion Metadata Registry. | |
+ | |||
+ | =Fusion-JSON Data= | ||
+ | [[File:FusionJson.PNG|Fusion-JSON Data|thumbnail]] | ||
+ | Fusion-JSON for data consists of three top-level nodes: | ||
+ | * "header" - header information | ||
+ | * "dataSets" - observation data consisting of a sequence of series keys together with observation values for each time period | ||
+ | * "structure" - metadata for each of the dimensions and attributes in the dataset | ||
+ | Fusion-JSON is therefore self-describing in that it contains both the observation data and structural metadata needed to interpreted making it better suited for driving visualisations and user interfaces than SDMX-ML where the metadata needs to be retrieved separately. | ||
+ | |||
+ | The series keys do not follow the SDMX [[Series Key|convention]], rather following the form: | ||
+ | 0:3:0:0:6 | ||
+ | 4:0:2:6:3:7:0 | ||
+ | 3:1:8:8:4:4 | ||
+ | The numbers are indexes to the information in the "structure" section. Thus the first digit "0" in the key 0:3:0:0:6 references the first dimension, and the first in the list of values given for that dimension. | ||
+ | |||
+ | Indexing is zero based. | ||
+ | |||
+ | For efficiency, the list of values only includes those actually used in the data. The list for a dimension using a Codelist with 1000 possible codes but with data for only two of those codes, will have two entries indexed "0" and "1". | ||
+ | |||
+ | =Fusion-JSON Structures= | ||
+ | [[File:FusionJsonStructure.PNG|Fusion-JSON Structures|thumbnail]] | ||
+ | FusionJSON for structures follows a schema unique to each structure. |
Latest revision as of 03:08, 30 March 2024
Overview
Fusion-JSON is a format used for Structural Metadata, Data, and Reference Metadata. The Fusion-JSON format was created before the SDMX-JSON format became a standard as so has a slightly different syntax. In addition the Fusion-JSON format is used for Structural Metadata that is supported by the Fusion Metadata Registry which is not a part of the official SDMX Specification. This includes:
- Data Reporting Template
- Data Structure Definitions that do not conform to the standard1
- Valuelist
- Validation Scheme
Fusion-JSON can be used as an import and export format in Fusion Metadata Registry for both data and structures.
It is the only format that supports all of the structures used in Fusion Metadata Registry.
Fusion-JSON Data
Fusion-JSON for data consists of three top-level nodes:
- "header" - header information
- "dataSets" - observation data consisting of a sequence of series keys together with observation values for each time period
- "structure" - metadata for each of the dimensions and attributes in the dataset
Fusion-JSON is therefore self-describing in that it contains both the observation data and structural metadata needed to interpreted making it better suited for driving visualisations and user interfaces than SDMX-ML where the metadata needs to be retrieved separately.
The series keys do not follow the SDMX convention, rather following the form:
0:3:0:0:6 4:0:2:6:3:7:0 3:1:8:8:4:4
The numbers are indexes to the information in the "structure" section. Thus the first digit "0" in the key 0:3:0:0:6 references the first dimension, and the first in the list of values given for that dimension.
Indexing is zero based.
For efficiency, the list of values only includes those actually used in the data. The list for a dimension using a Codelist with 1000 possible codes but with data for only two of those codes, will have two entries indexed "0" and "1".
Fusion-JSON Structures
FusionJSON for structures follows a schema unique to each structure.