Global Registry Technical GUI

From SDMX2 Global Registry Documentation
Jump to: navigation, search

Tutorial on Using the Global Registry Technical GUI

This page is under construction

Purpose of this Tutorial

To show how to create a DSD using the Global Registry GUI.

What this Tutorial Will Show

Whilst this tutorial shows how to author specific structural constructs, the intent is to show how to use and navigate the GUI to maintain many types of structure: because the SDMX Information Model uses inheritance from base constructs such as Identification, Naming, and Maintaining the information that needs to be entered is very similar for many constructs.

Whilst the tutorial is written in a way that assumes you are actually using the Registry it is not necessary to actually author the content. However, equally, you may wish to do so as an exercise.

Tutorial Overview

A DSD requires three types of construct:

• Code Lists

• Concepts

• DSD: the Concepts used in Dimensions, Attributes, and Measure and the Representation of these in terms of a code list or a non-coded format.

All of the structures used in this tutorial are available in SDMX-ML files.

• Code Lists and Concepts <link to the files to be made>

• DSD (including code lists and concepts) <link to the file to be made>

Note that these files assume a maintenance agency of LABORSTAT. If you wish to use these files then you will need to globally replace all occurrences of LABORSTAT with the id of your maintenance agency.

You will create a DSD by performing the following four steps:

  1. Step 1: Navigate to the Global Registry GUI and login.
  2. Step 2: Create a Code List and add some Codes.>
  3. Step 3: Create a Concept Scheme and add some Concepts.
  4. Step 4: Load the file of Code Lists and Concept Scheme into the Registry.
  5. Step 5: Create the DSD.

On-line Help

The Registry GUI has context-sensitive help.

Step 1 – Open Global Registry GUI and Log In




Select “Registry Technical Viewer” to go to the Registry GUI for maintaining structures.

caption




In order to maintain structural metadata you must be [[Users#Login|logged in]. Click on Login.

Click on “Structures”

caption




Select your agency.

caption




Step 2 - Create a Code List and Codes




Click on Codelists.

caption





Click on captipon to add a “New Item” (in this case a Code List).

caption





Enter the details (the minimum required is the Id and Name), and click on Save.

caption




Note that you can view the identity of the structures as either by Id or by Name (Label). You can commit changes made to the structure to the Registry at any time. If you do not wish to commit at this stage then click on the caption The caption shown by the code list indicates the changes have yet to be committed to the registry

Note that on committing to the registry additional validation is performed and there maybe an error reported (e.g. that you are trying to delete a code list that is referenced from a DSD).

Next add some codes to the code list.

caption





Ensure the code list is highlighted and click on caption to add a code.

caption





Add another code.

caption





Note that a simple hierarchy can be created in a code list by assigning a parent to a code.

If you wish add a few more codes.

caption




You can display the code list as a hierarchy.

caption




Commit the code list to the registry.

caption




Step 3 - Add Concepts




Concepts are maintained in a Concept Scheme.

Click on Concept Schemes and caption.

caption




Fill in the details. Add a Concept by clicking on caption .

caption




Add other Concepts in the same way and commit to the Registry – click on caption to see the changes awaiting commitment.

caption




Step 4 – Load a File into the Registry

When the code lists and concept schemes have been added to the registry then it is possible to create a DSD. If you wish to do this in a registry then you can load the SDMX-ML file containing the full set of codelists and concepts required for the DSD. You can download this file and then use it for the submission to the registry. <link to actual file>.

caption



In order to load the file click on Registry File Upload from the Main Menu. This will invite you to browse for the file.

caption




You will be shown a screen that lists the contents of the file and asked to commit this upload to the Registry.

caption




The Auto-Increment version function automatically increments version numbers in the Registry if identical structures exist already.

Click on Commit.

Note that the upload will replace any structures of the same id and version that are already in the Registry (unless the structure is marked as “final” in which case an error will be reported).

caption




Click on OK.
In order to view the structures loaded ensure the Selected Agency is LABORSTAT and then click on the relevant Registry Structure. In the screen below you can see the content of the Concept Scheme.

caption




Step 5 – Create DSD

Click

caption

Ensure the LABORSTAT agency is selected. Click on Data Structure Definitions and then click on caption .

caption




Enter the information and click on Save.

You will now enter information on:

• Primary Measure

• Dimensions

• Attributes

It does not matter in what sequence you enter the information and you can commit the Modification to the Registry at any time, and many times, just making small changes between each Commit if you wish. However, you MUST create a Primary Measure and at least one Dimension before Committing the DSD to the Registry as this is a mandatory part of a DSD. The indicates that more information is required before the structure can be saved.

So, in the description below we show the entry in the sequence Primary Measure, Dimensions, Attributes. Use the information in the handout to create the DSD.

Primary Measure


caption

caption




The caption indicates that the structure cannot be committed to the registry as mandatory items are missing. A DSD must gave a Primary Measure and at least one Dimension declared.

Ensure you have selected Primary Measure and then click on caption.

caption


You can view the information either by ID or name. For the Primary Measure we will use the OBS_VALUE from the SDMX Cross Domain Concept Scheme. Select the SDMX as the Agency and Observation (Id is OBS_VALUE). Note that you do not need to enter an Id for any of the DSD components Primary Measure, Dimension, Attribute. The default action is to place the Concept Id as the Id – this will be OBS_VALUE.

Click on Save.

caption




You will see that the Primary Measure has been given an Id of “OBS_VALUE”. The Primary Measure can be given a “text format” if required e.g. “integer” “string” etc. This can be used to enforce validation of values reported in a data set.


caption




Click on “Has Text Format” Select “Decimal” and then click on Save.

Dimensions

The following dimensions need to be added:

Dimension Concept Representation
Frequency (FREQ from SDMX) CL_FREQ (from SDMX)
Reference Area (REF_AREA from LABORSTAT) CL_REF_AREA (from LABORSTAT)
Economic Activity (ECON-ACTIVITY from LABORSTAT) CL_ECON_ACTIVITY (from LABORSTAT)
Sex (SEX from SDMX) CL_SEX (from SDMX)
Occupation (OCCUPATION from LABORSTAT) CL_OCCUPATION (from LABORSTAT)
Measure Type (MEASURE_TYPE from LABORSTAT) CL_MEASURE_TYPE (from LABORSTAT)
Status in Employment (STATUS_IN_EMPLOYMENT from LABORSTAT) CL_STATUS_EMPLY (from LABORSTAT)
Time Period (TIME_PERIOD from SDMX) Observational Time Period



caption


Ensure you have selected Dimensions and then click on caption .

Note that the sequence of the Dimensions in the DSD is important as it determines the sequence of the Dimensions in the Key in some versions and formats of an SDMX data set. Therefore, enter the Dimensions in the sequence shown in the DSD table. If you make a mistake then use the caption and caption to move the Dimensions up or down the list.

caption


The first Dimension is the Frequency. Again, the SDMX Cross Domain Concept is used and the SDMX Code List for Frequency. The Dimension type is NORMAL. Select the constructs as shown and click on Save.


caption


You will now be prompted to commit this to the Registry. Commit the Data Structure.


caption




Click on caption to add the next Dimension.


caption




The next Dimension is REF_AREA from the LABORSTAT Concept Scheme. This has a Dimension type of “NORMAL”.

Continue to enter the Dimensions until they have all been entered.

caption




Note that the Time Dimension has a Dimension type of “TIME” and a text type of “Observational Time Period”. The Dimensions FREQ, SEX, and TIME_PERIOD use the Concepts from the SDMX Cross Domain Concept Scheme.


Attributes

The following attributes need do be specified:


Attribute Concept Status Attribute Relationship/Attachment Representation
Observation Status(OBS_STATUS from SDMX) M Observation CL_OBS_STATUS (from LABORSTAT)
Observation Confidentiality (CONF_STATUS from SDMX) C Observation CL_CONF_STATUS (from SDMX)
Unit of Measure(UNIT_MEASURE from SDMX) M Dimension Group CL_UNIT_MEASURE (from LABORSTAT)
Unit Multiplier (UNIT_MULT from SDMX) M Dimension Group CL_UNIT_MULT (from SDMX)


These can be entered in any sequence

Ensure you have selected Attributes and then click on caption.

caption




For the attributes you must define the following information:

Attachment Level – this is one of Data Set, Observation, Dimension Group, or Group. Select the appropriate option. Note that there are no groups defined in this DSD.

Usage Status – this is one of Conditional or Mandatory. Select the appropriate option Click on Save.

caption


Continue with the other Attributes. Note that for UNIT_MULT and UNIT_MEASURE the attribute relationship (called “Attachment Level” in the GUI) is “Dimension Group” and it is necessary to specify the Dimensions that comprise this group as shown below. Highlight the Dimensions in the “Available Dimensions” box and use the caption to move them to the “Selected Dimensions”


caption

caption


Finally, ensure you Commit the DSD to the Registry.

caption


You have now completed the definition of the DSD.

        • END of TUTORIAL ****