Difference between revisions of "Inherited Codelists - Trouble Shooting"

From FMR Knowledge Base
Jump to navigation Jump to search
(Environment Synchronisation)
(Interaction with FXL)
 
(17 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[Category:How_To]]
 
 
[[Category:How_To V11]]
 
[[Category:How_To V11]]
  
Line 7: Line 6:
 
As a work around you can either
 
As a work around you can either
  
* Restore the inheritance manually (easiest option if the codelist has none of its own codes), or follow these steps:
+
* Restore the inheritance manually (easiest option if the codelist has none of its own codes),  
 +
* or follow these steps:
  
 
# Delete the codelist from the target Registry
 
# Delete the codelist from the target Registry
 
# Export the codelist from the source Registry (ticking the settings box RAW)
 
# Export the codelist from the source Registry (ticking the settings box RAW)
 
# Upload the exported codelist into the Target Registry
 
# Upload the exported codelist into the Target Registry
 +
 +
== Using Rollback ==
 +
 +
When the Rollback facility is used, either from the Codelist page (Revisions), the Activity - SDMX Transaction page or the Activity - Structure Submissions page any inheritance as such is not maintained. Instead the codes which were inherited from another codelist will be included in the 'Rollbacked" version of the codelist.
 +
 +
If this behaviour is not acceptable, prior to performing rollback, export any inherited codelists as detailed for Environment Synchronisation above. This will restore the inheritance link.
 +
 +
== Re-assigning structures to a different Agency ==
 +
 +
When using the Delete and Reassign Agency feature the Inheritance link will not be retained. This is a known issue and will be addressed in a future release. <br>
 +
 +
To rectify this, you will need to manually recreate the inheritance. To assist with this process, you can follow these steps: 
 +
 +
# Take a copy of any codes that exist in the codelist which has the inheritance link prior to using Re-assign by editing the codelist and copying the contents of the "Show CSV" option in step 4 of the wizard.
 +
# In the codelist which needs re-instating, add the linked codelist in step 1 of the codelist wizard
 +
# In step 4 or the wizard, go to show CSV and remove all the codes shown
 +
# Paste the copy you too prior to Re-assign (see step 1 above) back in and then update and save the codelist.
 +
 +
== Changing the ID of a Codelist which has Inheritance ==
 +
 +
Unfortunately, if you change the ID, the inheritance is lost. This is a known issue and will be addressed in a future release. <br>
 +
 +
To rectify this, you will need to manually recreate the inheritance. To assist with this process you can follow these steps: 
 +
 +
# Take a copy of any codes that exist in the codelist which has the inheritance link prior to using changing the ID  by editing the codelist and copying the contents of the "Show CSV" option in step 4 of the wizard.
 +
# In the codelist which needs re-instating, add the linked codelist in step 1 of the codelist wizard
 +
# In step 4 or the wizard, go to show CSV and remove all the codes shown
 +
# Paste the copy you too prior to changing the ID (see step 1 above) back in and then update and save the codelist.
 +
 +
== Interaction with FXL ==
 +
Using FXL it is possible to Browse and Load codelists which use Inheritance. The codes displayed will follow the same logic as discussed in this article: [[Creating_an_inherited_codelist| Creating an inherited codelist]].  However, it is not possible to save any amendments to a coldelist which has an Inheritance link to another code. If you need to add codes to the codelist, please do not use FusionXL.
 +
 +
== Exporting and Importing Codelists ==
 +
If you want to download an individual codelist which uses the inheritance feature, the button on the codelist page "Export SDMX-ML V3.0" does not maintain the inheritance neither does the Export to Excel button. Thus if you use either of these formats and subsequently upload the codelist, the inheritance link is lost.
 +
 +
Instead, use either of these options.
 +
 +
# Bulk Actions - Individual Structures. Select the codelist and choose the option RAW. Thevalid formats are SDMX-3.0 and FUSION-JSON only. This will retain the inheritance when uploaded.
 +
# Web Services - select the individual structure and set the Detail to Raw.

Latest revision as of 03:55, 30 March 2024


Environment Synchronisation

When using the Pull facility to obtain a codelist which has inherited it's codes from another codelist, the Inheritance link will not be retained. This is a known issue and will be addressed in a future release.
As a work around you can either

  • Restore the inheritance manually (easiest option if the codelist has none of its own codes),
  • or follow these steps:
  1. Delete the codelist from the target Registry
  2. Export the codelist from the source Registry (ticking the settings box RAW)
  3. Upload the exported codelist into the Target Registry

Using Rollback

When the Rollback facility is used, either from the Codelist page (Revisions), the Activity - SDMX Transaction page or the Activity - Structure Submissions page any inheritance as such is not maintained. Instead the codes which were inherited from another codelist will be included in the 'Rollbacked" version of the codelist.

If this behaviour is not acceptable, prior to performing rollback, export any inherited codelists as detailed for Environment Synchronisation above. This will restore the inheritance link.

Re-assigning structures to a different Agency

When using the Delete and Reassign Agency feature the Inheritance link will not be retained. This is a known issue and will be addressed in a future release.

To rectify this, you will need to manually recreate the inheritance. To assist with this process, you can follow these steps:

  1. Take a copy of any codes that exist in the codelist which has the inheritance link prior to using Re-assign by editing the codelist and copying the contents of the "Show CSV" option in step 4 of the wizard.
  2. In the codelist which needs re-instating, add the linked codelist in step 1 of the codelist wizard
  3. In step 4 or the wizard, go to show CSV and remove all the codes shown
  4. Paste the copy you too prior to Re-assign (see step 1 above) back in and then update and save the codelist.

Changing the ID of a Codelist which has Inheritance

Unfortunately, if you change the ID, the inheritance is lost. This is a known issue and will be addressed in a future release.

To rectify this, you will need to manually recreate the inheritance. To assist with this process you can follow these steps:

  1. Take a copy of any codes that exist in the codelist which has the inheritance link prior to using changing the ID by editing the codelist and copying the contents of the "Show CSV" option in step 4 of the wizard.
  2. In the codelist which needs re-instating, add the linked codelist in step 1 of the codelist wizard
  3. In step 4 or the wizard, go to show CSV and remove all the codes shown
  4. Paste the copy you too prior to changing the ID (see step 1 above) back in and then update and save the codelist.

Interaction with FXL

Using FXL it is possible to Browse and Load codelists which use Inheritance. The codes displayed will follow the same logic as discussed in this article: Creating an inherited codelist. However, it is not possible to save any amendments to a coldelist which has an Inheritance link to another code. If you need to add codes to the codelist, please do not use FusionXL.

Exporting and Importing Codelists

If you want to download an individual codelist which uses the inheritance feature, the button on the codelist page "Export SDMX-ML V3.0" does not maintain the inheritance neither does the Export to Excel button. Thus if you use either of these formats and subsequently upload the codelist, the inheritance link is lost.

Instead, use either of these options.

  1. Bulk Actions - Individual Structures. Select the codelist and choose the option RAW. Thevalid formats are SDMX-3.0 and FUSION-JSON only. This will retain the inheritance when uploaded.
  2. Web Services - select the individual structure and set the Detail to Raw.