Difference between revisions of "Hierarchal Codelists"

From FMR Knowledge Base
Jump to navigation Jump to search
(Step 3 - Build Hierarchy)
m (Vmurrell moved page Hierarchal Codelists (FMR 10 only) to Hierarchal Codelists without leaving a redirect: V11 has no equiv so 10 only not needed)
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
[[Category:Structural Metadata]]
 
[[Category:Structural Metadata]]
 
 
=Overview=
 
=Overview=
  
A Hierarchical Codelist provides a hierarchical view over one or more ‘standard’ Codelists.  A Hierarchical Codelist can be thought of in the same way as a database view: it does not define any new codes, it is used to group any number of existing Codes from any number of existing Codelists. See this article [https://fmrwiki.sdmxcloud.org/All_Structures_-_FMR for more information on authoring and maintaining structures.]
+
A Hierarchical Codelist provides a hierarchical view over one or more ‘standard’ Codelists.  A Hierarchical Codelist can be thought of in the same way as a database view: it does not define any new codes; it is used to group any number of existing Codes from any number of existing Codelists. See this article [https://fmrwiki.sdmxcloud.org/All_Structures for more information on authoring and maintaining structures.]
  
 
=Wizard=
 
=Wizard=
Line 11: Line 10:
 
==Step 1 - High Level Details==
 
==Step 1 - High Level Details==
  
The steps in a Hierarchical Codelist Wizard includes step 1 which provides the generic, high level details about the Hierarchal Codelist. See this article [https://fmrwiki.sdmxcloud.org/All_Structures_-_FMR for more information on authoring and maintaining structures.]
+
The steps in a Hierarchical Codelist Wizard includes step 1 which provides the generic, high level details about the Hierarchal Codelist. See this article [https://fmrwiki.sdmxcloud.org/All_Structures for more information on authoring and maintaining structures.]
  
 
==Step 2 - Codelists and Hierarchy==
 
==Step 2 - Codelists and Hierarchy==
Line 20: Line 19:
  
  
[[File:HCL2.PNG|1200px]]<br>
+
[[File:HCL2.PNG|Step 2 - Codelists|1200px]]<br>
  
In the lower area ('''Hierarchies'''), you can specify what is to be created. Enter a Name and an ID together with an optional decsription if required.  
+
In the lower area ('''Hierarchies'''), you can specify what is to be created. Enter a Name and an ID together with an optional description if required.  
  
Note that organisations wishing to be compliant with accepted models for statistical classifications should ensure that the Id is the number associated with the Level, where Levels are numbered consecutively starting with level 1 at the highest Level].
+
Note that organisations wishing to be compliant with accepted models for statistical classifications should ensure that the Id is the number associated with the Level, where Levels are numbered consecutively starting with level 1 at the highest Level.
  
  
[[File:HCL3A.PNG|1200px]]<br>
+
[[File:HCL3A.PNG|Step 2 - Hierarchy|1200px]]<br>
  
 
==Step 3 - Build Hierarchy==
 
==Step 3 - Build Hierarchy==
Line 38: Line 37:
  
  
[[File:HCL5.PNG|1000px]]<br>
+
[[File:HCL5.PNG|Step 3 - Build Hierarchy|1000px]]<br>
  
 
The next step is to add the Child codes.  
 
The next step is to add the Child codes.  
Line 48: Line 47:
 
To change the order of the codes, you can use drag and drop to reposition.
 
To change the order of the codes, you can use drag and drop to reposition.
  
[[File:HCL5A.PNG|500px]]<br>
+
[[File:HCL5A.PNG|Step 3 - Re-order|500px]]<br>
  
 
==Step 4 - Levels==
 
==Step 4 - Levels==
Line 54: Line 53:
 
Step 4 of the wizard allows the user to provide a formal definition for each level of the hierarchy as shown in the example below.
 
Step 4 of the wizard allows the user to provide a formal definition for each level of the hierarchy as shown in the example below.
  
[[File:HCL5B.PNG|1000px]]<br>
+
[[File:HCL5B.PNG|Step 4 - Levels|1000px]]<br>

Latest revision as of 05:00, 24 August 2022

Overview

A Hierarchical Codelist provides a hierarchical view over one or more ‘standard’ Codelists. A Hierarchical Codelist can be thought of in the same way as a database view: it does not define any new codes; it is used to group any number of existing Codes from any number of existing Codelists. See this article for more information on authoring and maintaining structures.

Wizard

From the Items menu, select the Hierarchal Codelist Page and use the maintenance button to create a Hierarchal Codelist. Cogs.PNG

Step 1 - High Level Details

The steps in a Hierarchical Codelist Wizard includes step 1 which provides the generic, high level details about the Hierarchal Codelist. See this article for more information on authoring and maintaining structures.

Step 2 - Codelists and Hierarchy

The second step requires information on the Codelists that will be required when building the Hierarchies.

In the first part of the screen, click Add and select the Codelists that you intend to use (Referenced Codelists).


Step 2 - Codelists

In the lower area (Hierarchies), you can specify what is to be created. Enter a Name and an ID together with an optional description if required.

Note that organisations wishing to be compliant with accepted models for statistical classifications should ensure that the Id is the number associated with the Level, where Levels are numbered consecutively starting with level 1 at the highest Level.


Step 2 - Hierarchy

Step 3 - Build Hierarchy

Step 3 enables you to add Root Codes (the Parent) and Child Codes for each of the hierarchies created in Step 2.

The Hierarchy selection box will display the IDs entered in Step 2. Select the appropriate Reference Codelist (as added in Step 2) and then the individual code.

The example below shown that a root code has been added for LEVEL2.


Step 3 - Build Hierarchy

The next step is to add the Child codes.

First, highlight the Root Code and then click Add Child Codes. Next select the Referenced Codelist, and then the individual codes.

Once you have added the codes, you will be returned to Step 3 as shown in the example above.

To change the order of the codes, you can use drag and drop to reposition.

Step 3 - Re-order

Step 4 - Levels

Step 4 of the wizard allows the user to provide a formal definition for each level of the hierarchy as shown in the example below.

Step 4 - Levels