Load Structures

From Metadata Technology Wiki
Jump to navigation Jump to search

Overview

Structures can be loaded into the registry in a number of ways but first you have to have some to load. If you already have structures to load, please skip to the Loading Structures Section below.

Obtaining Structures

All structures must be compliant with the SDMX Standard. See this article for a full list of Maintainable Structures. You can learn more about the Standards on the SDMX web sites.

Whilst you can easily create Structure from scratch, there are a number of other options available.

Using Export Structures options in another Registry

Please see this article which explains how to do this and where you can find the Metadata Technology Demo Site.

Using Web Services option in another Registry

Structures can be obtained using the Web Service option from another Registry. The image below shows the Demo Site with Web Services and Structure selected.

Web Service Page in metadata Technology's Demo site

You can use the selection boxes to define what you want and then you can either download the structures OR copy the URL to use when uploading.

Using Environmental Sync

See this article for more information on how to do this.

Loading Structures

Before you start

  • To Load a Structure(s) you do need to be logged in to the Registry.
  • To successfully load a Structure make sure that the owning Agency already exists (select Organisation from the main menu then Agencies).

Loading a Structure

On the home page of the Registry, at the top right of the page you will see the Load Structures button (as long as you are logged in).

LS0.PNG

Once this button is clicked the Upload option will open as shown in the image below.

Loading using a File

Either search for and a select file (individual files or Zip files can be used) using Windows Explorer OR select the URL button which will display an additional field for you to enter a URL location of the structure. See the Web Services option above for more details on how to obtain an appropriate URL as shown in the example below.

Loading using an URL

Import Actions

Before the structures are imported you have further options available:

Append

A structure file loaded with action 'Append' may only add new structures and may not overwrite any existing structures.

Replace

A structure file loaded with action 'Replace' may add new structures to the Registry, and can also replace existing structures with new ones. Replace is the default selection.

Merge

A structure file loaded with action 'Merge' may add new structures and replace existing structures - however for Item Schemes (Codelists, Concept Schemes, Agency Schemes, Data Provider Schemes) the items submitted will be added to the existing scheme. For example if a Codelist exists with Codes A, B, and C, and the same Codelist is submitted with Codes B and X, then the resulting Codelist will have Codes A, B, C, X - the Merge submission has Replaced Code B and Added code X to the Codelist.

Full Replace

A structure file loaded with action 'Full Replace' will remove all existing structures from the Registry and replace them with the contents of the loaded file. This is a useful feature when you are copying structures from one environment to another.

Upload Successful

Once the import process has finished, you will see a Submission report as shown in the example below. You can also Abort the process from here.

Submission Report

If you Confirm the structure will be loaded into the relevant area where you can view and edit it.

Note: if you are uploading a large number of Structures it can take a little while before the structures are visible. A good way of checking is to Navigate to the bulk Actions page.

Upload Unsuccessful

If for whatever reason the upload fails, you will be presented with an error message advising you what the problem was, similar to the one shown below.

Example Error Message

Common Problems

  • No change detected from the structure already present
  • Incorrect file type
  • Owning Agency not present