Unit 3: Using FMR Workbench to Manage .Stat Suite Structural Metadata

This unit covers installing, configuring, and integrating FMR Workbench with .Stat Suite. You'll learn how to set up Environments, configure connections, and integrate with the .Stat DLM. The unit also explores the impact of seamless integration on managing SDMX structural metadata and provides step-by-step guidance for implementation.

Installing FMR Workbench

To use FMR Workbench, you first need to install and set it up. This process involves downloading Docker Desktop, pulling the latest FMR Workbench image, creating a container, and accessing the user interface through a web browser.

1. Download and install Docker Desktop (if not already installed)

2. Download the latest fwb image (at the windows shell or command prompt)

docker pull sdmxio/fwb:latest

3. Create a container called "fwb" and start the fwb app.

docker run -p8080:8080 --name fwb sdmxio/fwb:latest

4. Access the FMR UI by opening https://localhost:8080/ in your web browser.

Configuring FMR Workbench

The FMR Workbench UI browses and displays SDMX structures from the connected Environment. An Environment is a single SDMX service offering. The list of available Environments is defined in the configuration file.

To edit the configuration file, use the following command:

docker exec -it fwb /usr/bin/vi /root/MetadataTechnology/FusionRegistry/fwb_config.json

(Note: This command uses the "vim editor" and standard vim commands.)

Once finished, restart the Docker container to apply the revised settings:

docker restart fwb

Configuring FMR Workbench Environments

The FMR Workbench UI allows users to select from and switch between a list of Environments. An Environment is a single SDMX service offering.

Each SDMX service offering includes a set of related SDMX web services, such as the following:

• Web service entry point to retrieve the structures
• Entry point to save structures
• Entry point to delete structures

The list of available Environments is defined in the configuration file for FMR Workbench. The connected Environment is associated with the current user, enabling multiple users to connect to different Environments simultaneously.

More on FMR Workbench configuration

This section provides an overview of how FMR Workbench is configured to work with .Stat Suite. It includes:

1. An example of a .Stat Suite configuration in FMR Workbench
2. Key notes on .Stat Suite configuration settings
3. A description of the FMR Workbench configuration file

Select the image to enlarge.

The .Stat Suite configuration in FMR Workbench includes specific settings that must be correctly defined:

• "id" – Specifies the .Stat data space to connect to.
• "api.version" – Should be set to "1.5.0".
• "agencies" – Must align with the agencies used in .Stat metadata.
• "locale" – Should match the desired locales in the .Stat data space.
• "api.timeout" – Should be increased to 600.
• "format" – Should be set to "mlv2.1".

Select the image to enlarge.

Seamless integration of FMR Workbench and .Stat Suite

So far, you have seen how to configure FMR Workbench to connect to a .Stat Suite data space and manage SDMX structural metadata.

As of the "JS arc" release, the FMR Workbench web application can be seamlessly integrated with the .Stat DLM. This integration enables structure creation and editing directly within the .Stat DLM UI.

Version Compatibility: Supported as of the June 13, 2024, release of .Stat Suite JS arc.

Impact of seamless integration

The integration of FMR Workbench with .Stat DLM enhances metadata management by adding new features. This includes improved structure creation and editing options directly within the .Stat DLM UI

Select each option below to reveal the details.

Create Structure Option

A new "create structure" option is added to the .Stat DLM header.

Select the image to enlarge.

Enhanced Artefact Menu

The contextual menu of any artefact offers new options to view or edit structure or edit annotations.

Select the flow chart to enlarge.

How to seamlessly integrate FMR Workbench and .Stat Suite

To integrate FMR Workbench with .Stat Suite, specific configuration changes are required in both .Stat Suite and FMR Workbench settings.

In .Stat Suite configuration, update the dotstatsuite-config-data/<env>/configs/tenants.json file under the DLM scope:

Select the image to enlarge.

In FMR Workbench configuration, provide the required details in the .json configuration file for .Stat DLM dataspaces and authentication. These steps and settings remain the same as previously explained.

Knowledge check

Which of the following statements about configuring FMR Workbench are correct?

Select all that apply and then select Submit.