Difference between revisions of "Main Page"

From FMR Knowledge Base
Jump to navigation Jump to search
(→‎Fusion Data Essentials Topics)
(→‎FusionXL)
(133 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:<span style="opacity:0;position:absolute;">{{FULLPAGENAME}}</span>}}
 
{{DISPLAYTITLE:<span style="opacity:0;position:absolute;">{{FULLPAGENAME}}</span>}}
 
__NOTOC__
 
__NOTOC__
−
=The Fusion Registry Knowledge Base=
+
<span style="font-size:2.0rem;">Fusion Metadata Registry (FMR) Knowledge Base</span>
−
<big><strong>Statistical data management software for official statistics using [https://metadatatechnology.com/about-sdmx.php SDMX]</strong></big>
+
::[[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
  
−
=Fusion Registry 10=
+
[https://www.sdmx.io/fmr/#features FMR feature list]
−
Fusion Registry 10 is for central banks, international organisations, national statistics offices, development banks and regional statistics authorities who need to collect, integrate, store, process and publish aggregated official statistics using the SDMX Standard.
 
  
−
Fusion Registry is a metadata-driven system providing closely governed, reliable and automated management of the statistical data supply chain, production process and dissemination service.
+
==Fusion Metadata Registry 11==
−
 
+
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>
−
Version 10.0 was released in January 2020 and comes in three [[Fusion Registry Editions|editions]]:
+
{|  
−
* Data Essentials - a free to use version with data handling capabilities suitable for personal use or simple use cases.
 
−
* Enterprise - a paid-for fully-featured SDMX data and metadata solution suitable for production deployment and sophisticated use cases.
 
−
* Cloud - the Enterprise Edition delivered as a fully-managed cloud service.
 
−
 
 
−
 
 
−
::[[File:FR10.png|500px]]
 
−
 
 
−
==Fusion Registry Components and Modules==
 
−
Fusion Registry 10 consists of a suite of components and modules centred on the <strong>Fusion Registry core</strong>.
 
−
 
 
−
====Fusion Registry Core====
 
−
SDMX statistical data engine and structural metadata registry.<br>
 
−
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.<br>
 
−
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.<br>
 
−
[[Fusion Registry Core|More]]
 
−
 
 
−
====Fusion Edge Server====
 
−
High-performance data dissemination server.<br>
 
−
A light-weight SDMX data and metadata REST API server designed to be deployed in clusters in the DMZ or at the network edge for scalable, fault-tolerant public data dissemination use cases.<br>
 
−
[[Fusion Edge Server|More]]
 
−
 
 
−
====Fusion Data Browser====
 
−
Interactive data explorer and analysis web tool for analysts and statisticians.<br>
 
−
Fusion Data Browser is a web application suitable for both internal and external data consumers to search and explore the catalogue of datasets, select series and cubes of interest, build visualisations using tables and charts, and retrieve selected data in a variety of formats including SDMX, Excel and CSV.<br>
 
−
It can connect to either a Fusion Registry Core engine, or a Fusion Edge Server cluster.<br>
 
−
[[Fusion Data Browser|More]]
 
−
 
 
−
====FusionXL====
 
−
Microsoft Excel addin for Fusion Registry.<br>
 
−
FusionXL is an Excel addin for browsing and modifying structural metadata, exploring the data catalogue, and downloading data directly into a spreadsheet.
 
−
 
 
−
====Fusion Data Mapper====
 
−
Web tool for creating and maintaining Fusion Registry FAME to SDMX series mappings.<br>
 
−
Web tool for Fusion Registry Core for mapping series with a single dimension to richer multi-dimensional structures using SDMX structure mapping rules.<br>
 
−
The main use case is mapping FAME series which typically have a single 'series code' dimension to SDMX multi-dimensional structures including dimensions and attributes like: FREQ, INDICATOR, REF_AREA and UNIT_MULT. However, it will work with source data with a single dimension like 'Indicator'.
 
−
 
 
−
====Fusion ETL Server====
 
−
Module for Extracting, Transforming and Loading data into Fusion Registry.<br>
 
−
Fusion ETL extracts observation data from one or more local SQL databases and loads them into a Fusion Registry Core data engine, transforming the data into the structure specified for the target SDMX Dataflows.
 
−
Any number of jobs can be created that can be executed interactively through the web user interface, executed automatically on a defined schedule, or triggered programmatically using the Fusion ETL REST API.
 
−
 
 
−
====Fusion Registry Command Line====
 
−
Windows and Linux command line interface.<br>
 
−
A command line interface to Fusion Registry's REST API providing utility scripts for loading structures, data and metadata, validating data, exporting content and deleting content.
 
−
 
 
−
=Fusion Registry Core Topics=
 
−
{| class="wikitable"
 
 
|-
 
|-
−
| [[:Category:SDMX Structures|'''Structural Metadata''']]|| Detailed explanations of the main SDMX structural metadata artefacts
+
| 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:How To|'''How To''']] || Guidance on specific tasks using Fusion Registry
+
| 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:Behaviour|'''Behaviours''']] || Answers to 'What happens when...?' questions
+
| [[FMR 11.0 release notes]] || Key changes in version 11, backward compatibility, breaking changes.
 
|-
 
|-
−
| [[:Category:Components and Modules|'''Components and Modules''']] || Components and modules reference
+
|}
 +
 
 +
====Using Fusion Metadata Registry 11====
 +
{|  
 
|-
 
|-
−
| [[:Category:Functions|'''Functions Reference''']] || Features and functions reference
+
| [[Quick_Start_Guide|Quick Start Guide]] || Install and configure a basic FMR installation
 +
|-
 +
| style="width:300px" | [[:Category:How_To V11|How to Guides]]|| Guidance on specific tasks using FMR
 
|-
 
|-
−
| [[:Category:SdmxDataFormat|'''Data Formats''']] || A description of supported Data Formats
+
| [[:Category:FMR_Configuration_Reference|Configuration Reference]]|| Configuring FMR
 
|-
 
|-
−
| [[:Category:RegistrySecurity|'''Security''']] || Authentication and Authorisation Features
+
| [[:Category:Structural_Metadata_V11|Structural Metadata Management]] || Creating and maintaining SDMX structures using the FMR web user interface
 
|-
 
|-
−
| [[:Category:WebService|'''Web Services''']] || Registry Web Services
+
| [[:Category:Reference Metadata|Reference Metadata Management]] || Working with reference metadata using the FMR web user interface and web services API
−
|-
+
|}
−
| [[Fusion_Registry_Command_Line|'''Command Line''']] || Structure, data, and metadata publishing from the command line
+
 
 +
====Use cases====
 +
{|  
 
|-
 
|-
−
| [[:Category:Glossary|'''Glossary of Terms''']] || Glossary of SDMX and Fusion Registry terminology
+
| style="width:300px" | [[:Category:SDMX 3.0 Mapping Structures|Mapping]] || Mapping using Structure Maps and Representation Maps
 
|}
 
|}
  
−
= Fusion Data Mapper =
+
====SDMX 3.0 Theory====
−
Fusion Data Mapper provides a web user Interface to administer Structure Maps in the Fusion Registry, where the maps support a specific use case – mapping from Single Dimension Data Structures to multidimensional Data Structures.  This use case is borne out of statistical applications which model time series datasets as a single unique identifier for the Series alongside a Time Dimension.  By modelling these dataset as a DSD with one Dimension (and a Time Dimension), it is very easy to overlay SDMX metadata to describe the Time Series as a multidimensional Cube with additional series Attributes to carry richer metadata.  
+
{|  
−
 
 
−
{| class="wikitable"
 
 
|-
 
|-
−
| [[DataMapperServerInstall|'''Installation''']] || How to Install Fusion Data Mapper
+
| style="width:300px" | [[:Category:Concepts_Reference_V11|Concepts Reference]] || Explanation of key concepts and terms used in SDMX
 
|-
 
|-
−
| [[Fusion_Data_Mapper_-_Add_Dataset|'''Add Dataset''']] || Creating new Mapped Dataflows
+
| [[:Category:SDMX 3.0 Structures|SDMX 3.0 Structures Reference]] || Details on each of the key 'maintainable' and 'identifiable' SDMX structures
 
|-
 
|-
−
| [[Fusion_Data_Mapper_-_Maintaining_Mapping_Rules|'''Maintaining Rules''']] || How to create and maintain mapping rules
+
| [[: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
 
|-
 
|-
−
| [[Fusion_Data_Mapper_-_Query_Forwarding|'''Query Forwarding''']] || How data queries are forwarded from the Target to Source Dataflow using mappings
+
| [[: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
−
|-
 
−
| '''[https://www.youtube.com/channel/UC0zlrpIaiIivnWWIIRkqXYA Videos]''' || [https://www.youtube.com/watch?v=5dZJi9OysC8 Data Mapper in Action]
 
−
 
 
 
|}
 
|}
  
−
= Fusion ETL Server =
+
== Fusion Workbench ==
−
Fusion ETL is a web application which connects to one or more local databases in order to extract data for publication to a remote Fusion Registry instance via the standard Fusion Registry web services.
+
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.
  
−
Fusion ETL provides the ability to map Dataflows to Database tables and Dimensions to specific database columns.  Schedules can be configured for automated extraction, views can be defined allowing for extraction of full updates, sub-cubes and deltas. 
+
{|  
−
 
 
−
Fusion ETL provides a sophisticated auditing, logging and error notification framework to ensure full visibility of data publication history.
 
−
 
 
−
{| class="wikitable"
 
 
|-
 
|-
−
| [[ETLServerInstall|'''Installation''']] || How to Install Fusion ETL Server
+
| style="width:300px" | [[FMR_Workbench|FMR Workbench Getting Started]] || Getting started guide for the FMR Workbench
−
|-
 
−
| [[:Category:ETLServerConfigure|'''Configuration Reference''']] || Configuration of the Fusion ETL Server
 
−
|-
 
−
| '''[https://www.youtube.com/channel/UC0zlrpIaiIivnWWIIRkqXYA Videos]''' || [https://www.youtube.com/watch?v=h3V6kKU1Reg Set up and Configuration]
 
−
 
 
 
|}
 
|}
  
−
= Fusion Edge Server =
+
== FMR-CL ==
−
Fusion Edge Server is a solution for supporting high performance data and metadata dissemination, with high throughput. The Fusion Edge Server serves all data, related metadata, including reference metadata, from its highly optimised in memory store and as such has no reliance on a database. The Fusion Edge Server has been designed to support the use case of high availability of data through load balancing.
+
'''F'''usion '''M'''etadata '''R'''egistry-'''C'''ommand '''L'''ine (FMR-CL) is a command line application which performs functions against the web services of a running FMR instance.
−
Fusion Edge Server provides access to its stored data and metadata through SDMX compliant web services, and includes support for non-SDMX data formats such as CSV and Excel. The Fusion Edge Server extends the SDMX web services by providing additional information such as data metrics, and data search.
 
−
 
 
−
Fusion Edge Server is compatible with Fusion Data Browser and Fusion XL, providing an off-the-shelf solution for both web based data exploration, and from within Microsoft Excel. Connectivity to statistical software such as R and Matlab can be achieved using third party SDMX Connector libraries such as the [https://github.com/amattioc/SDMX SDMX Connectors project].
 
−
 
 
  
 +
[https://fmrwiki.sdmxcloud.org/FMR-CL Overview]
  
−
{| class="wikitable"
+
==== Using FMR-CL ====
−
|-
+
{|  
−
| [[EdgeServerInstall|'''Installation''']] || How to Install Fusion Edge Server
 
 
|-
 
|-
−
| [[:Category:EdgeServerConfigure|'''Configuration Reference''']] || Configuration of the Fusion Edge Server
+
| style="width:300px" |  [[Backup and Restore|Structure Backup]] || Supporting backup of structures and transaction history for restore in new installations of FMR
 
|}
 
|}
  
−
=Fusion Data Browser Topics=
+
== FusionXL ==
−
Fusion Data Browser is a HTML and JavaScript client side web application which provides a user interface for querying, graphing, and exporting data from a Fusion Registry or Fusion Edge Server.
+
[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.
  
−
[https://demo.metadatatechnology.com/DataBrowser Live Demo] running against data from the [https://demo.metadatatechnology.com/FusionRegistry Registry Demo Server].
+
== 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.
  
−
{| class="wikitable"
+
==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====
 +
{|  
 
|-
 
|-
−
| [[Data_Browser_Install|'''Installation''']] || How to Install/Deploy the Data Browser
+
| [[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:DataBrowserConfigure|'''Configuration Reference''']] || Configuration of the Browser, Charts, and Series
+
| [[:Category:FMR_Configuration_Reference|Configuration Reference]]|| Configuring FMR
 
|-
 
|-
−
| [[:Category:DataBrowserFunctions|'''Functions Reference''']] || Features and functions reference
+
| [[:Category:Structural Metadata|Structural Metadata Management]] || Creating and maintaining SDMX structures using the FMR web user interface
 
|}
 
|}
  
−
=Fusion Metadata Registry Topics=
+
====SDMX 2.1 Theory====
−
 
+
{|  
−
What is Fusion Metadata Registry?
 
−
 
 
−
{| class="wikitable"
 
 
|-
 
|-
−
| [[:Category:FMR_How_To_Guides|'''How to Guides''']]|| Guidance on specific tasks using Fusion Metadata Registry
+
| style="width:300px" | [[:Category:Concepts_Reference V10|Concepts Reference]] || Explanation of key concepts and terms used in SDMX
 
|-
 
|-
−
| [[:Category:FMR_Configuration_Reference|'''Configuration Reference''']]|| Guidance on how to configure Fusion Metadata Registry
+
| [[:Category:SDMX 2.1 Structures|SDMX 2.1 Structures Reference]] || Details on each of the key 'maintainable' and 'identifiable' SDMX structures
 
|-
 
|-
−
| [[:Category:FMR_Concepts_Reference|'''Concepts Reference''']] || Explanation of useful basic SDMX structural metadata concepts
+
| [[: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_Structures_Reference|'''Structures Reference''']] || Guidance of each of the structure types available in Fusion Metadata Registry
 
−
|-
 
−
| [[:Category:FMR_Formats_Reference|'''Formats Reference''']] || Guidance of each of the format types available in Fusion Metadata Registry
 
−
|-
 
−
| [[:Category:FMR_REST_API_Reference|'''REST API Reference''']] || Purpose, parameters, request content and response content for each of the published web services together with examples
 
 
|-
 
|-
 +
| [[: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 05:38, 23 October 2023


Fusion Metadata Registry (FMR) Knowledge Base

Fusion Metadata Registry

Change Log and Supported Features

Change Log for details of the latest version, bug fixes and updates

FMR feature list

Fusion Metadata Registry 11

Fusion Metadata Registry 11 implements the SDMX 3.0 specification for a structural metadata registry.

Upgrading to Version 11.4 A key change occurs in V11.4, without taking action you may not be able to use FMR.
Upgrading From Version 10 to Version 11 Upgrading from FMR 10 to FMR 11.
FMR 11.0 release notes Key changes in version 11, backward compatibility, breaking changes.

Using Fusion Metadata Registry 11

Quick Start Guide Install and configure a basic FMR installation
How to Guides Guidance on specific tasks using FMR
Configuration Reference Configuring FMR
Structural Metadata Management Creating and maintaining SDMX structures using the FMR web user interface
Reference Metadata Management Working with reference metadata using the FMR web user interface and web services API

Use cases

Mapping Mapping using Structure Maps and Representation Maps

SDMX 3.0 Theory

Concepts Reference Explanation of key concepts and terms used in SDMX
SDMX 3.0 Structures Reference Details on each of the key 'maintainable' and 'identifiable' SDMX structures
Formats Reference Details on each of the data and structure formats available in Fusion Metadata Registry including XML, JSON and CSV
REST API Web Services Reference Purpose, parameters, request content and response content for each of the published web services together with examples

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

FusionXL

FusionXL FusionXL is a plugin for Microsoft Excel® which can connect any Registry such as Global Registry, in order to provide structure browsing, and maintenance.

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 SDMX 2.1 specification for a structural metadata registry.

Using Fusion Metadata Registry 10

Quick Start Guide Install and configure a basic FMR installation
How to Guides Guidance on specific tasks using FMR
Configuration Reference Configuring FMR
Structural Metadata Management Creating and maintaining SDMX structures using the FMR web user interface

SDMX 2.1 Theory

Concepts Reference Explanation of key concepts and terms used in SDMX
SDMX 2.1 Structures Reference Details on each of the key 'maintainable' and 'identifiable' SDMX structures
Formats Reference Details on each of the data and structure formats available in Fusion Metadata Registry including XML, JSON and CSV
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

Structural metadata management

  • Centralise and control structural metadata
  • Author and maintain structural metadata
  • Drive statistics production using centrally-controlled metadata
  • Provide an SDMX-compliant a REST structure API

Data collection

  • Collect data using metadata-driven Excel forms
  • Map (transform) incoming data into standardised structures

Data reporting

  • Validate prepared data for compliance with the data collector's specifications prior to reporting
  • Map (transform) outgoing data into the collector's required structure

Statistics production

  • Data processing execution engine: data structural validation, mapping to different structures and conversion
Retrieved from "https://fmrwiki.sdmxcloud.org/index.php?title=Main_Page&oldid=7208"