Difference between revisions of "Main Page"

From FMR Knowledge Base
Jump to navigation Jump to search
(→‎Fusion Registry 10)
(→‎FusionXL Topics)
 
(139 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><br>
−
<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]]
  
−
=Fusion Registry 10=
+
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 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.
+
Read more about Fusion Metadata Registry on the [https://www.sdmx.io/tools/fmr/#sdmx-structural-metadata-registry sdmx.io web site]
  
−
Version 10.0 was released in January 2020 and comes in three [[Fusion Registry Editions|editions]]:
+
To download Fusion Metadata Registry [https://www.sdmx.io/resources/download/fmr/ please click here.]
−
* Community - free to use structural metadata registry without any capability to load, store, process or disseminate data.
 
−
* 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.
 
  
 +
= 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.
  
−
::[[File:FR10.png|500px]]
+
This knowledgebase provides further information on how to install, configure and use FMR and the tools:
  
−
==Fusion Registry Components and Modules==
+
* Click here to read more about [https://www.sdmx.io/tools/ecosystem/#fusionxl FusionXL on the sdmx.io site.] 
−
Fusion Registry 10 consists of a suite of components and modules centred on the <strong>Fusion Registry core</strong>.
+
* 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 Registry Core====
+
==Fusion Metadata Registry Topics==
−
SDMX statistical data engine and structural metadata registry.<br>
+
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.
−
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]]
 
−
 
−
====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 Topics=
 
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
| [[:Category:SDMX Structures|'''Structural Metadata''']]|| Detailed explanations of the main SDMX structural metadata artefacts
+
| [[:Fusion_Metadata_Overview|'''Overview''']]|| What is Fusion Metadata Registry?
−
|-
 
−
| [[:Category:How To|'''How To''']] || Guidance on specific tasks using Fusion Registry
 
 
|-
 
|-
−
| [[:Category:Behaviour|'''Behaviours''']] || Answers to 'What happens when...?' questions
+
| [[:Category:Installation_and_Configuration |'''Installation and Configuration''']]|| How to install and configure the Registry
 
|-
 
|-
−
| [[:Category:Components and Modules|'''Components and Modules''']] || Components and modules reference
+
| [[:Category:Concepts_Reference_V11|'''Concepts Reference''']]|| Explanation of key concepts and terms used in SDMX
 
|-
 
|-
−
| [[:Category:Functions|'''Functions Reference''']] || Features and functions reference
+
| [[:Category:SDMX 3.0 Structures|'''SDMX V3.0 Structures''']]|| Detailed explanations of the main SDMX structural metadata artefacts
 
|-
 
|-
−
| [[:Category:SdmxDataFormat|'''Data Formats''']] || A description of supported Data Formats
+
| [[:Category:Structural Metadata V11|'''Structure Maintenance''']]|| How to maintain the SDMX Structures
 
|-
 
|-
−
| [[:Category:RegistrySecurity|'''Security''']] || Authentication and Authorisation Features
+
| [[:Category:Reference_Metadata|'''Reference Metadata''']] || Guidance on working with SDMX 3.0 reference metadata in Fusion Registry 11
 
|-
 
|-
−
| [[:Category:WebService|'''Web Services''']] || Registry Web Services
+
| [[:Category:How_To V11|'''How to and other Features''']] || Guidance on specific tasks using Fusion Registry
 
|-
 
|-
−
| [[Fusion_Registry_Command_Line|'''Command Line''']] || Structure, data, and metadata publishing from the command line
+
| [[:Category:SDMX 3.0 Mapping Structures|'''Mapping''']] || Mapping using Structure Maps and Representation Maps
 
|-
 
|-
−
| [[:Category:Glossary|'''Glossary of Terms''']] || Glossary of SDMX and Fusion Registry terminology
+
| [[:Category:FMR Formats Reference|'''Data Formats''']] || A description of supported Data Formats
−
|}
 
−
 
 
−
= Fusion Data Mapper =
 
−
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
+
| [[:Category:RegistrySecurity|'''Security''']] || Authentication and Authorisation Features
−
|-
 
−
| [[Fusion_Data_Mapper_-_Add_Dataset|'''Add Dataset''']] || Creating new Mapped Dataflows
 
 
|-
 
|-
−
| [[Fusion_Data_Mapper_-_Maintaining_Mapping_Rules|'''Maintaining Rules''']] || How to create and maintain mapping rules
+
| [[:Category:FMR REST API Reference|'''Web Services''']] || Registry Web Services
 
|-
 
|-
−
| [[Fusion_Data_Mapper_-_Query_Forwarding|'''Query Forwarding''']] || How data queries are forwarded from the Target to Source Dataflow using mappings
+
| [[Change_Log|'''Change Log''']] || Change Logs for Fusion Metadata Registry
 
|-
 
|-
−
| '''[https://www.youtube.com/channel/UC0zlrpIaiIivnWWIIRkqXYA Videos]''' || [https://www.youtube.com/watch?v=5dZJi9OysC8 Data Mapper in Action]
+
| [[:Category:Version 10 |'''Functionality Retired after Version 10''']] || Functionality no longer available in V11
−
 
 
 
|}
 
|}
  
−
= Fusion ETL Server =
+
== FusionXL Topics ==
−
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.
+
FusionXL is an addin for Microsoft Excel which connects to a Fusion Registry server for both data and structure retrieval, and maintenance.
−
 
 
−
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"
 
{| class="wikitable"
 
|-
 
|-
−
| [[ETLServerInstall|'''Installation''']] || How to Install Fusion ETL Server
+
| [[FusionXL_install|'''Installation''']] || How to Install Fusion XL and connect to a Fusion Registry server
−
|-
 
−
| [[: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]
+
| [[FusionXL_Create_Dataset|'''Creating Datasets''']] || Create datasets and load datasets for the purpose of data authoring, validation, and conversion
−
 
 
−
|}
 
−
 
 
−
= Fusion Edge Server =
 
−
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.
 
−
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].
 
−
 
 
−
 
 
−
 
 
−
{| class="wikitable"
 
 
|-
 
|-
−
| [[EdgeServerInstall|'''Installation''']] || How to Install Fusion Edge Server
+
| [[FusionXL_Author_Helper|'''Author Helper''']] || Provides assistance when creating datasets
 
|-
 
|-
−
| [[:Category:EdgeServerConfigure|'''Configuration Reference''']] || Configuration of the Fusion Edge Server
+
| [[Structure_Explorer|'''Structure Explorer''']] || Create, Retrieve and Modify Structures using the Excel Ribbon
−
|}
 
−
 
 
−
=Fusion Data Browser Topics=
 
−
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://demo.metadatatechnology.com/DataBrowser Live Demo] running against data from the [https://demo.metadatatechnology.com/FusionRegistry Registry Demo Server].
 
−
 
 
−
{| class="wikitable"
 
 
|-
 
|-
−
| [[Data_Browser_Install|'''Installation''']] || How to Install/Deploy the Data Browser
+
| [[:Category:Fusion_XL|'''Other Features''']] || Other features available in FXL
 
|-
 
|-
−
| [[:Category:DataBrowserConfigure|'''Configuration Reference''']] || Configuration of the Browser, Charts, and Series
+
| [[FusionXL_Change_Log|'''Change Logs''']] || Change Logs for FusionXL
 
|-
 
|-
−
| [[:Category:DataBrowserFunctions|'''Functions Reference''']] || Features and functions reference
 
 
|}
 
|}
  
−
=Fusion Data Essentials Topics=
+
== 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.
  
−
Data Essentials is free for qualifying organisations and, as well as an SDMX metadata registry, it has all the essential Functions needed to load, store, process and publish aggregated statistical data using the SDMX standard. It contains a subset of the functionality of Fusion Registry and many of the articles you will find on this wiki will apply to Data Essentials as well as Fusion Registry.  
+
== 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.
  
−
Version 10.4.4 is available on request NOW! To learn more and request a copy, please go to [https://metadatatechnology.com/software/startforfree.php#dataessentials our Website]
+
{|  
−
 
 
−
Watch our '''videos''' on the [https://www.youtube.com/channel/UCk5RLv9d7qcKZFFNCZOCCGQ Data Essentials You Tube Channel]
 
−
{| class="wikitable"
 
−
|-
 
−
| [[Data_Essentials_-_What is Data Essentials|'''What is Data Essentials? ''']] || Overview of Data Essentials
 
−
|-
 
−
| [[Data_Essentials_-_Differences|'''How does Data Essentials Differ from Fusion Registry? ''']] || Features available in Fusion Registry
 
−
|-
 
−
| [[Quick_start_-_install_Fusion_Registry|'''Installation Guide ''']] || Quick Start Guide to installing your Registry
 
−
|-
 
−
| '''[[PDF Version of Installation Guide]]''' || [https://sdmx-public.s3.eu-west-2.amazonaws.com/Data_Essentials_Installation_Guide_V1.1.pdfQuick PDF Version]
 
 
|-
 
|-
−
| [[Data_Essentials_-_Connect_to_the_data_schema|'''Set up your Data Connection ''']] || How to create a database connection to store your data
+
| style="width:300px" |  [[FMR_Workbench|FMR Workbench Getting Started]] || Getting started guide for the FMR Workbench
−
|-
 
−
 
 
−
 
 
 
|}
 
|}
  
−
=Fusion Metadata Registry Topics=
+
== FMR-CL ==
 +
'''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.
  
−
What is Fusion Metadata Registry?
+
[https://fmrwiki.sdmxcloud.org/FMR-CL Overview]
  
−
{| class="wikitable"
+
==== Using FMR-CL ====
−
|-
+
{|  
−
| [[:Category:FMR_How_To_Guides|'''How to Guides''']]|| Guidance on specific tasks using Fusion Metadata Registry
 
−
|-
 
−
| [[:Category:FMR_Configuration_Reference|'''Configuration Reference''']]|| Guidance on how to configure Fusion Metadata Registry
 
−
|-
 
−
| [[:Category:FMR_Concepts_Reference|'''Concepts Reference''']] || Explanation of useful basic SDMX structural metadata concepts
 
−
|-
 
−
| [[: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
 
 
|-
 
|-
 +
|  style="width:300px" |  [[Backup and Restore|Structure Backup]] || Supporting backup of structures and transaction history for restore in new installations of FMR
 +
|}

Latest revision as of 07:40, 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

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=7702"