Difference between revisions of "Main Page"

From FMR Knowledge Base
Jump to navigation Jump to search
(FusionXL)
 
(74 intermediate revisions by 4 users not shown)
Line 2: Line 2:
 
__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>
==Topics==
+
::[[File:FMR11 screenshot.png|Fusion Metadata Registry|500px]]
====Using Fusion Metadata Registry====
+
==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 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>
 +
{|
 +
|-
 +
| 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'''.
 +
|-
 +
| style="width:300px" | [[Upgrading_from_Version_10_to_Version_11|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|Quick Start Guide]] || Install and configure a basic FMR installation
+
| [[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:FMR_Configuration_Reference|Configuration Reference]]|| Configuring FMR
 +
|-
 +
| [[:Category:Structural_Metadata_V11|Structural Metadata Management]] || Creating and maintaining SDMX structures using the FMR web user interface
 +
|-
 +
| [[:Category:Reference Metadata|Reference Metadata Management]] || Working with reference metadata using the FMR web user interface and web services API
 +
|}
 +
 
 +
====Use cases====
 +
{|
 +
|-
 +
| style="width:300px" | [[:Category:SDMX 3.0 Mapping Structures|Mapping]] || Mapping using Structure Maps and Representation Maps
 +
|}
 +
 
 +
====SDMX 3.0 Theory====
 +
{|
 +
|-
 +
| style="width:300px" | [[:Category:Concepts_Reference_V11|Concepts Reference]] || Explanation of key concepts and terms used in SDMX
 +
|-
 +
| [[:Category:SDMX 3.0 Structures|SDMX 3.0 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
 +
|}
 +
 
 +
== 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.
 +
 
 +
{|
 +
|-
 +
| style="width:300px" |  [[FMR_Workbench|FMR Workbench Getting Started]] || Getting started guide for the FMR Workbench
 +
|}
 +
 
 +
== 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.
 +
 
 +
[https://fmrwiki.sdmxcloud.org/FMR-CL Overview]
 +
 
 +
==== Using FMR-CL ====
 +
{|
 +
|-
 +
|  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
 
| style="width:300px" | [[:Category:How_To|How to Guides]]|| Guidance on specific tasks using FMR
Line 18: Line 95:
 
{|  
 
{|  
 
|-
 
|-
| style="width:300px" | [[:Category:Concepts_Reference|Concepts Reference]] || Explanation of key concepts and terms used in SDMX
+
| style="width:300px" | [[:Category:Concepts_Reference V10|Concepts Reference]] || Explanation of key concepts and terms used in SDMX
 
|-
 
|-
| [[:Category:SDMX Structures|Structures Reference]] || Details on each of the key [[maintainable]] SDMX structures
+
| [[: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_Formats_Reference|Formats Reference]] || Details on each of the data and structure formats available in Fusion Metadata Registry including XML, JSON and CSV
Line 28: Line 105:
  
 
==About Fusion Metadata Registry==
 
==About Fusion Metadata Registry==
Fusion Metadata Registry 10 implements the SDMX 2.1 [https://sdmx.org/wp-content/uploads/SDMX_2-1_SECTION_5_RegistrySpecification_2020-07.pdf specification] for a structural metadata registry.
 
 
  
::[[File:FMR1.png|400px]]
 
 
===Key Features===
 
===Key Features===
* SDMX structural metadata registry compliant with the SDMX 2.1 specification
+
* SDMX structural metadata registry
* Formats: SDMX-EDI, SDMX-ML 1.0, 2.0, 2.1, SDMX-JSON
+
* 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
 
* SDMX REST structure API
 
* Web user interface for browsing, authoring and maintaining structures
 
* Web user interface for browsing, authoring and maintaining structures
* Validator for checking that SDMX data complies with the structural metadata
 
* Transformer for executing SDMX Structure Maps
 
  
 
===Use Cases===
 
===Use Cases===
* Repository for SDMX structural metadata
+
<strong>Structural metadata management</strong>
* Interactively authoring and maintaining SDMX structures using the web user interface
+
                            <ul>
* SDMX structural metadata REST API service
+
                                <li>Centralise and control structural metadata</li>
* Data validation - validate that data complies with SDMX structures
+
                                <li>Author and maintain structural metadata</li>
* Data transformation - transform data into different structures and coding schemes using SDMX Structure Mapping
+
                                <li>Drive statistics production using centrally-controlled metadata</li>
* Data conversion - convert data between SDMX versions and formats
+
                                <li>Provide an SDMX-compliant a REST structure API</li>
* Data collection - use the metadata to generate Excel data reporting templates which data providers need only to complete and return
+
                            </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>

Latest 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