Hierarchical Codelists Output Format

From Fusion Registry Wiki
Jump to navigation Jump to search

This issue is about the output format of the SDMX 2.1 structure "Hierarchical Codelist". In SDMX 3, this has been replaced by the Hierarchy structure.

The Fusion Registry can read SDMX 2.1 Hierarchical Codelists (HCL) in 2 different forms:

  • the code is referenced by URN
  • the code is referenced by Alias and ID

Before version 10.9.2, HCLs could be output in either form, with the form depending on how they had been submitted: their output form would match their input form. However, if at any point an HCL is edited in the User Interface, then it will now always be output in the "Alias and ID" form. It became difficult for users to predict what output they were going to get and so it was decided to always output the URN form, so the end consumer would always know what form an HCL would be output, and also since this is closer to SDMX 3. This was implemented in Fusion Registry version 10.9.2

If you have end-systems that rely on the "alias" format, then the Fusion Registry version 10, can be switched back into the manner in which it worked before version 10.9.2. This is by the use of the System Parameter "HCL_OUTPUT_PERMIT_ALIAS_REF". When this is set to "true" the behaviour of the Registry is the same as the behaviour before version 10.9.2. This is "opt-in" behaviour. If this value is not set or set to false, then from Fusion Registry 10.9.2 onwards, HCLs are only output in the "URN" form.