Difference between revisions of "Load example SDMX structures"

From FMR Knowledge Base
Jump to navigation Jump to search
(Download all of the structures for the ECB Exchange Rates dataflow (EXR))
(Overview)
 
(22 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
[[Category:How_To]]
 
[[Category:How_To]]
 +
[[Category:How_To V11]]
 
=Overview=
 
=Overview=
 
SDMX structural metadata (structures for short) describe the data and need to be created before you can start working with the data itself. Structures in SDMX are equivalent to the empty tables and relationships in a SQL database before any data is inserted.
 
SDMX structural metadata (structures for short) describe the data and need to be created before you can start working with the data itself. Structures in SDMX are equivalent to the empty tables and relationships in a SQL database before any data is inserted.
  
If you have access to structures in a suitable SDMX format like SDMX-ML (XML) or SDMX-JSON, you can start working immediately with those. Login using the admin account created at [[Install_Fusion_Metadata_Registry#2._Server_Settings|install]] and click the [[File:LoadStructuresOrReferenecMetadata.PNG]] button to load from file.
+
If you have access to structures in a suitable SDMX format like SDMX-ML (XML) or SDMX-JSON, you can start working immediately with those. Login using the admin (root user) account created during [[Root_User_Account|the install process]] and click the [[File:LoadStructuresOrReferenecMetadata.PNG]] button to load from file.
  
The rest of this guide explains how to download some example structures from Metadata Technology's cloud demonstration Fusion Registry service <code>https://demo.metadatatechnology.com/FusionRegistry</code> using the Environment Sync function.
+
The rest of this guide explains how to download some example structures from SDMX Global Registry site <code>https://registry.sdmx.org/overview.html</code> using the Environment Sync function.
 +
 
 +
Note
 +
Please refer to this article which explains how Environment Sync works across [[Synchronise_structural_metadata_between_FMR_environments|different vesions of FMR]].
  
 
=Adding a Sync Environment=
 
=Adding a Sync Environment=
 
A Sync Environment is a remote Fusion Registry with which structures can be exchanged. In this case we're going to retrieve from structures from it.
 
A Sync Environment is a remote Fusion Registry with which structures can be exchanged. In this case we're going to retrieve from structures from it.
[[File:SyncEnvironment.PNG|thumbnail]]
 
  
 
* Login using the admin account
 
* Login using the admin account
 
* From the left-hand menu choose > <code>Environments</code>
 
* From the left-hand menu choose > <code>Environments</code>
 
* Choose the <code>Add Environments</code> button and enter:
 
* Choose the <code>Add Environments</code> button and enter:
** ID: Demo
+
** ID: SDMX Global Registry
** URL: <nowiki>https://demo.metadatatechnology.com/FusionRegistry</nowiki>
+
** URL: <nowiki>https://registry.sdmx.org/</nowiki>
* Select the newly created 'Demo' environment in the list and choose the <code>Sync Environment</code> button
+
* Select the newly created 'Global Registry' environment in the list and choose the <code>Sync Environment</code> button
 
* When prompted for a username and password, click <code>Sync Anonymously</code>
 
* When prompted for a username and password, click <code>Sync Anonymously</code>
  
Your Fusion Registry should connect to the demonstration service and retrieve a list of all available structures.
+
Your Fusion Registry should connect to the Global Registry service and retrieve a list of all available structures.
 
 
Next, download the SDMX Agency Scheme.
 
 
 
=Download the Agency Scheme=
 
In SDMX, each structure is owned by a specific Agency so we first need to download the Agency Scheme.
 
  
* Click on Agency Schemes and check <code>SDMX:AGENCIES (1.0) - SDMX Agency Scheme</code>
+
=Download all structures for the ESTAT BPM6_BOP_M dataflow (BPM6_BOP_M)=
* Choose the <code>Pull Structure</code> button
+
For demonstration purposes we are going to download all of the structures needed for the ESTAT's BPM6_BOP_M dataflow, including Codelists, Concepts and the Data Structure Definition.
* When prompted for Sync Options, choose <code>Selected structures only</code>, and the <code>Pull</code> button
+
* Click on Dataflows and check <code>ESTAT:BPM6 BOP M (2.2) - BPM6_BOP_M dataflow</code>
* Acknowledge the report which should say that 1 structure has been created
+
[[File:Dataflow BPM6 BOP M.png| Select Dataflow|thumbnail]]
 
 
=Download all structures for the ECB Exchange Rates dataflow (EXR)=
 
For demonstration purposes we are going to download all of the structures needed for the ECB's Exchange Rates dataflow, including Codelists, Concepts and the Data Structure Definition.
 
[[File:SyncReportEXR.PNG|thumbnail]]
 
 
 
* Click on Dataflows and check <code>ECB:EXR (1.0) - ECB Exchange Rates</code>
 
 
* Choose the <code>Pull Structure</code> button
 
* Choose the <code>Pull Structure</code> button
 
* When prompted for Sync Options, choose <code>Selected structures and descendents</code>, and the <code>Pull</code> button
 
* When prompted for Sync Options, choose <code>Selected structures and descendents</code>, and the <code>Pull</code> button
 
* The report should tell us that a number of changes have been made to the Registry including 11 Codelists, plus a Concept Scheme, Data Structure Definition and a Dataflow
 
* The report should tell us that a number of changes have been made to the Registry including 11 Codelists, plus a Concept Scheme, Data Structure Definition and a Dataflow
 +
[[File:Sync report.png|Sync Report|thumbnail]]
  
 
=Check=
 
=Check=
 
To see what has been loaded, you can navigate back to the <code>Main menu</code> and select <code>Bulk Actions</code>.  
 
To see what has been loaded, you can navigate back to the <code>Main menu</code> and select <code>Bulk Actions</code>.  
  
The left hand panel will show the number of structures that have been created for each type, the right hand panel will show the details for a selected structure type.
+
The left-hand panel will show the number of structures that have been created for each type, the right hand panel will show the details for a selected structure type.
[[File:Loadstructure result.PNG|thumbnail]]
+
 
 +
[[File:Bulk actions BPM6 BOP M.png|Bulk Actions Page|1000px]]

Latest revision as of 08:49, 1 April 2024

Overview

SDMX structural metadata (structures for short) describe the data and need to be created before you can start working with the data itself. Structures in SDMX are equivalent to the empty tables and relationships in a SQL database before any data is inserted.

If you have access to structures in a suitable SDMX format like SDMX-ML (XML) or SDMX-JSON, you can start working immediately with those. Login using the admin (root user) account created during the install process and click the LoadStructuresOrReferenecMetadata.PNG button to load from file.

The rest of this guide explains how to download some example structures from SDMX Global Registry site https://registry.sdmx.org/overview.html using the Environment Sync function.

Note Please refer to this article which explains how Environment Sync works across different vesions of FMR.

Adding a Sync Environment

A Sync Environment is a remote Fusion Registry with which structures can be exchanged. In this case we're going to retrieve from structures from it.

  • Login using the admin account
  • From the left-hand menu choose > Environments
  • Choose the Add Environments button and enter:
    • ID: SDMX Global Registry
    • URL: https://registry.sdmx.org/
  • Select the newly created 'Global Registry' environment in the list and choose the Sync Environment button
  • When prompted for a username and password, click Sync Anonymously

Your Fusion Registry should connect to the Global Registry service and retrieve a list of all available structures.

Download all structures for the ESTAT BPM6_BOP_M dataflow (BPM6_BOP_M)

For demonstration purposes we are going to download all of the structures needed for the ESTAT's BPM6_BOP_M dataflow, including Codelists, Concepts and the Data Structure Definition.

  • Click on Dataflows and check ESTAT:BPM6 BOP M (2.2) - BPM6_BOP_M dataflow
Select Dataflow
  • Choose the Pull Structure button
  • When prompted for Sync Options, choose Selected structures and descendents, and the Pull button
  • The report should tell us that a number of changes have been made to the Registry including 11 Codelists, plus a Concept Scheme, Data Structure Definition and a Dataflow
Sync Report

Check

To see what has been loaded, you can navigate back to the Main menu and select Bulk Actions.

The left-hand panel will show the number of structures that have been created for each type, the right hand panel will show the details for a selected structure type.

Bulk Actions Page