Difference between revisions of "Main Page"

From FMR Knowledge Base
Jump to navigation Jump to search
(→‎FusionXL)
Line 1: Line 1:
 
{{DISPLAYTITLE:<span style="opacity:0;position:absolute;">{{FULLPAGENAME}}</span>}}
 
{{DISPLAYTITLE:<span style="opacity:0;position:absolute;">{{FULLPAGENAME}}</span>}}
 
__NOTOC__
 
__NOTOC__
−
<span style="font-size:2.0rem;">Fusion Metadata Registry (FMR) Knowledge Base</span>
+
<span style="font-size:2.0rem;">Fusion Metadata Registry (FMR) Knowledge Base</span><br>
 
::[[File:FMR11 screenshot.png|Fusion Metadata Registry|500px]]
 
::[[File:FMR11 screenshot.png|Fusion Metadata Registry|500px]]
−
==Change Log and Supported Features==
 
−
[[Change Log]] for details of the latest version, bug fixes and updates
 
  
−
[https://www.sdmx.io/fmr/#features FMR feature list]
+
Fusion Metadata Registry is a free to use structural metadata registry for SDMX supporting EDI, SDMX 1.0, 2.0, 2.1 and 3.0.
  
−
==Fusion Metadata Registry 11==
+
Read more about Fusion Metadata Registry on the [https://www.sdmx.io/tools/fmr/#sdmx-structural-metadata-registry sdmx.io web site]
−
Fusion Metadata Registry 11 implements the [https://sdmx.org/wp-content/uploads/SDMX_3-0-0_SECTION_5_FINAL-1_0.pdf SDMX 3.0 specification for a structural metadata registry].<br>
+
 
−
{|  
+
To download Fusion Metadata Registry [https://www.sdmx.io/resources/download/fmr/ please click here.]
 +
 
 +
= Tools =
 +
The [https://www.sdmx.io/tools/ecosystem/ sdmx.io ecosystem] includes a collection of open source SDMX software tools cooperating to solve official statistics use cases.
 +
 
 +
This knowledgebase provides further information on how to install, configure and use FMR and the tools:
 +
 
 +
* Click here to read more about [https://www.sdmx.io/tools/ecosystem/#fusionxl FusionXL on the sdmx.io site.] 
 +
* Click here to read more about [https://www.sdmx.io/tools/ecosystem/#fusion-transformer Fusion Transformer on the sdmx.io site.]
 +
* Click here to read more about [https://www.sdmx.io/tools/ecosystem/#fusion-workbench Workbench on the sdmx.io site.]
 +
* See below to read more about how to use [https://fmrwiki.sdmxcloud.org/Backup_and_Restore FMR-CL, a command line application] which performs functions against the web services of a running FMR instance.
 +
 
 +
==Fusion Metadata Registry Topics==
 +
SDMX statistical data engine and structural metadata registry. The main statistical engine for data collection, integration, processing, storage, query execution and time-series calculations. It provides an SDMX-compliant data and metadata REST API. The integrated SDMX structural metadata registry acts as the central repository, authoring and maintenance tool for all of the structures including Codelists, Concepts and Data Structure Definitions.
 +
 
 +
{| class="wikitable"
 +
|-
 +
| [[:Fusion_Metadata_Overview|'''Overview''']]|| What is Fusion Metadata Registry?
 +
|-
 +
| [[:Category:Installation_and_Configuration |'''Installation and Configuration''']]|| How to install and configure the Registry
 +
|-
 +
| [[:Category:Concepts_Reference_V11|'''Concepts Reference''']]|| Explanation of key concepts and terms used in SDMX
 +
|-
 +
| [[:Category:SDMX 3.0 Structures|'''SDMX V3.0 Structures''']]|| Detailed explanations of the main SDMX structural metadata artefacts
 +
|-
 +
| [[:Category:Structural Metadata V11|'''Structure Maintenance''']]|| How to maintain the SDMX Structures
 
|-
 
|-
−
| style="width:300px" | [[Upgrading_to_Version_11.4|Upgrading to Version 11.4]] || '''A key change occurs in V11.4, without taking action you may not be able to use FMR'''.
+
| [[:Category:Reference_Metadata|'''Reference Metadata''']] || Guidance on working with SDMX 3.0 reference metadata in Fusion Registry 11
 
|-
 
|-
−
| style="width:300px" | [[Upgrading_from_Version_10_to_Version_11|Upgrading From Version 10 to Version 11]] || Upgrading from FMR 10 to FMR 11.
+
| [[:Category:How_To V11|'''How to and other Features''']] || Guidance on specific tasks using Fusion Registry
 
|-
 
|-
−
| [[FMR 11.0 release notes]] || Key changes in version 11, backward compatibility, breaking changes.
+
| [[:Category:SDMX 3.0 Mapping Structures|'''Mapping''']] || Mapping using Structure Maps and Representation Maps
 
|-
 
|-
−
|}
+
| [[:Category:FMR Formats Reference|'''Data Formats''']] || A description of supported Data Formats
−
 
 
−
====Using Fusion Metadata Registry 11====
 
−
{|  
 
 
|-
 
|-
−
| [[Quick_Start_Guide|Quick Start Guide]] || Install and configure a basic FMR installation
+
| [[:Category:RegistrySecurity|'''Security''']] || Authentication and Authorisation Features
−
|-
 
−
| style="width:300px" | [[:Category:How_To V11|How to Guides]]|| Guidance on specific tasks using FMR
 
 
|-
 
|-
−
| [[:Category:FMR_Configuration_Reference|Configuration Reference]]|| Configuring FMR
+
| [[:Category:FMR REST API Reference|'''Web Services''']] || Registry Web Services
 
|-
 
|-
−
| [[:Category:Structural_Metadata_V11|Structural Metadata Management]] || Creating and maintaining SDMX structures using the FMR web user interface
+
| [[Change_Log|'''Change Log''']] || Change Logs for Fusion Metadata Registry
 
|-
 
|-
−
| [[:Category:Reference Metadata|Reference Metadata Management]] || Working with reference metadata using the FMR web user interface and web services API
+
| [[:Category:Version 10 |'''Functionality Retired after Version 10''']] || Functionality no longer available in V11
 
|}
 
|}
  
−
====Use cases====
+
== FusionXL Topics ==
−
{|  
+
FusionXL is an addin for Microsoft Excel which connects to a Fusion Registry server for both data and structure retrieval, and maintenance.
 +
{| class="wikitable"
 +
|-
 +
| [[FusionXL_install|'''Installation''']] || How to Install Fusion XL and connect to a Fusion Registry server
 +
|-
 +
| [[FusionXL_Create_Dataset|'''Creating Datasets''']] || Create datasets and load datasets for the purpose of data authoring, validation, and conversion
 +
|-
 +
| [[FusionXL_Author_Helper|'''Author Helper''']] || Provides assistance when creating datasets
 
|-
 
|-
−
| style="width:300px" | [[:Category:SDMX 3.0 Mapping Structures|Mapping]] || Mapping using Structure Maps and Representation Maps
+
| [[Structure_Explorer|'''Structure Explorer''']] || Create, Retrieve and Modify Structures using the Excel Ribbon
−
|}
 
−
 
 
−
====SDMX 3.0 Theory====
 
−
{|
 
 
|-
 
|-
−
| style="width:300px" | [[:Category:Concepts_Reference_V11|Concepts Reference]] || Explanation of key concepts and terms used in SDMX
+
| [[:Category:Fusion_XL|'''Other Features''']] || Other features available in FXL
 
|-
 
|-
−
| [[:Category:SDMX 3.0 Structures|SDMX 3.0 Structures Reference]] || Details on each of the key 'maintainable' and 'identifiable' SDMX structures
+
| [[FusionXL_Change_Log|'''Change Logs''']] || Change Logs for FusionXL
 
|-
 
|-
−
| [[:Category:FMR_Formats_Reference|Formats Reference]] || Details on each of the data and structure formats available in Fusion Metadata Registry including XML, JSON and CSV
+
| [[FusionXL_DataExplorer|'''Retired Functionality''']] || Functionality no longer available in V3
 
|-
 
|-
−
| [[:Category:FMR_REST_API_Reference|REST API Web Services Reference]] || Purpose, parameters, request content and response content for each of the published web services together with examples
 
 
|}
 
|}
 +
 +
== Fusion Transformer ==
 +
[https://fmrwiki.sdmxcloud.org/Fusion_Transformer '''Fusion Transformer'''] is a command line application providing transformations between supported data files.The Fusion Transformer is a command line application providing transformations between supported data files.
  
 
== Fusion Workbench ==
 
== Fusion Workbench ==
Line 70: Line 93:
 
|  style="width:300px" |  [[Backup and Restore|Structure Backup]] || Supporting backup of structures and transaction history for restore in new installations of FMR
 
|  style="width:300px" |  [[Backup and Restore|Structure Backup]] || Supporting backup of structures and transaction history for restore in new installations of FMR
 
|}
 
|}
−
 
−
== FusionXL ==
 
−
[https://fmrwiki.sdmxcloud.org/Category:Fusion_XL '''FusionXL''']
 
−
FusionXL is a plugin for Microsoft Excel® which can connect any Registry such as [https://registry.sdmx.org/overview.html Global Registry], in order to provide structure browsing, and maintenance.
 
−
 
−
== Fusion Transformer ==
 
−
[https://fmrwiki.sdmxcloud.org/Fusion_Transformer '''Fusion Transformer'''] is a command line application providing transformations between supported data files.The Fusion Transformer is a command line application providing transformations between supported data files.
 
−
 
−
==Fusion Metadata Registry 10==
 
−
Fusion Metadata Registry 10 implements the [https://sdmx.org/wp-content/uploads/SDMX_2-1_SECTION_5_RegistrySpecification_2020-07.pdf SDMX 2.1 specification for a structural metadata registry].
 
−
====Using Fusion Metadata Registry 10====
 
−
{|
 
−
|-
 
−
| [[Quick_Start_Guide|Quick Start Guide]] || Install and configure a basic FMR installation
 
−
|-
 
−
| style="width:300px" | [[:Category:How_To|How to Guides]]|| Guidance on specific tasks using FMR
 
−
|-
 
−
| [[:Category:FMR_Configuration_Reference|Configuration Reference]]|| Configuring FMR
 
−
|-
 
−
| [[:Category:Structural Metadata|Structural Metadata Management]] || Creating and maintaining SDMX structures using the FMR web user interface
 
−
|}
 
−
 
−
====SDMX 2.1 Theory====
 
−
{|
 
−
|-
 
−
| style="width:300px" | [[:Category:Concepts_Reference V10|Concepts Reference]] || Explanation of key concepts and terms used in SDMX
 
−
|-
 
−
| [[:Category:SDMX 2.1 Structures|SDMX 2.1 Structures Reference]] || Details on each of the key 'maintainable' and 'identifiable' SDMX structures
 
−
|-
 
−
| [[:Category:FMR_Formats_Reference|Formats Reference]] || Details on each of the data and structure formats available in Fusion Metadata Registry including XML, JSON and CSV
 
−
|-
 
−
| [[:Category:FMR_REST_API_Reference|REST API Web Services Reference]] || Purpose, parameters, request content and response content for each of the published web services together with examples
 
−
|}
 
−
 
−
==About Fusion Metadata Registry==
 
−
 
−
===Key Features===
 
−
* SDMX structural metadata registry
 
−
* Information model: FMR 10 = SDMX 2.1, FMR 11 = SDMX 3.0
 
−
* Formats: SDMX-EDI, SDMX-ML 1.0, 2.0, 2.1, 3.0, SDMX-JSON, SDMX-CSV (data)
 
−
* SDMX REST structure API
 
−
* Web user interface for browsing, authoring and maintaining structures
 
−
 
−
===Use Cases===
 
−
<strong>Structural metadata management</strong>
 
−
                            <ul>
 
−
                                <li>Centralise and control structural metadata</li>
 
−
                                <li>Author and maintain structural metadata</li>
 
−
                                <li>Drive statistics production using centrally-controlled metadata</li>
 
−
                                <li>Provide an SDMX-compliant a REST structure API</li>
 
−
                            </ul>
 
−
<strong>Data collection</strong>
 
−
                            <ul>
 
−
                                <li>Collect data using metadata-driven Excel forms</li>
 
−
                                <li>Map (transform) incoming data into standardised structures</li>
 
−
                            </ul>
 
−
<strong>Data reporting</strong>
 
−
                            <ul>
 
−
                                <li>Validate prepared data for compliance with the data collector's specifications prior to reporting</li>
 
−
                                <li>Map (transform) outgoing data into the collector's required structure</li>
 
−
                            </ul>
 
−
<strong>Statistics production</strong>
 
−
                            <ul>
 
−
                                <li>Data processing execution engine: data structural validation, mapping to different structures and conversion</li>
 
−
                            </ul>
 

Revision as of 07:37, 13 May 2024


Fusion Metadata Registry (FMR) Knowledge Base

Fusion Metadata Registry

Fusion Metadata Registry is a free to use structural metadata registry for SDMX supporting EDI, SDMX 1.0, 2.0, 2.1 and 3.0.

Read more about Fusion Metadata Registry on the sdmx.io web site

To download Fusion Metadata Registry please click here.

Tools

The sdmx.io ecosystem includes a collection of open source SDMX software tools cooperating to solve official statistics use cases.

This knowledgebase provides further information on how to install, configure and use FMR and the tools:

Fusion Metadata Registry Topics

SDMX statistical data engine and structural metadata registry. The main statistical engine for data collection, integration, processing, storage, query execution and time-series calculations. It provides an SDMX-compliant data and metadata REST API. The integrated SDMX structural metadata registry acts as the central repository, authoring and maintenance tool for all of the structures including Codelists, Concepts and Data Structure Definitions.

Overview What is Fusion Metadata Registry?
Installation and Configuration How to install and configure the Registry
Concepts Reference Explanation of key concepts and terms used in SDMX
SDMX V3.0 Structures Detailed explanations of the main SDMX structural metadata artefacts
Structure Maintenance How to maintain the SDMX Structures
Reference Metadata Guidance on working with SDMX 3.0 reference metadata in Fusion Registry 11
How to and other Features Guidance on specific tasks using Fusion Registry
Mapping Mapping using Structure Maps and Representation Maps
Data Formats A description of supported Data Formats
Security Authentication and Authorisation Features
Web Services Registry Web Services
Change Log Change Logs for Fusion Metadata Registry
Functionality Retired after Version 10 Functionality no longer available in V11

FusionXL Topics

FusionXL is an addin for Microsoft Excel which connects to a Fusion Registry server for both data and structure retrieval, and maintenance.

Installation How to Install Fusion XL and connect to a Fusion Registry server
Creating Datasets Create datasets and load datasets for the purpose of data authoring, validation, and conversion
Author Helper Provides assistance when creating datasets
Structure Explorer Create, Retrieve and Modify Structures using the Excel Ribbon
Other Features Other features available in FXL
Change Logs Change Logs for FusionXL
Retired Functionality Functionality no longer available in V3

Fusion Transformer

Fusion Transformer is a command line application providing transformations between supported data files.The Fusion Transformer is a command line application providing transformations between supported data files.

Fusion Workbench

The FMR Workbench (FWB) provides a web user interface (UI) for browsing and maintaining SDMX Structures obtained from external SDMX compliant Structure Web Services, including (and not limited to) - any FMR installation, OECD.STAT, public SDMX web services, such as the SDMX Global Registry,BIS,ECB,ILO,UNICEF.

FMR Workbench Getting Started Getting started guide for the FMR Workbench

FMR-CL

Fusion Metadata Registry-Command Line (FMR-CL) is a command line application which performs functions against the web services of a running FMR instance.

Overview

Using FMR-CL

Structure Backup Supporting backup of structures and transaction history for restore in new installations of FMR
Retrieved from "https://fmrwiki.sdmxcloud.org/index.php?title=Main_Page&oldid=7701"