Prefer default vocabulary (if a default exists) #568
Conversation
andylolz
changed the title
andylolz
changed the title
|
Interesting, thanks @andylolz In terms of knowing the default vocabulary, my understanding is that this must be something you've inferred from the standard, as it's not a flat or explicit reference? If so, did you make a lookup table, or similar? It strikes me that would be a useful resource for the standard/users |
Good question, @stevieflow! Apologies in advance for the very long answer… There’s a mapping.xml file that is part of the Single Source of Truth (it lives in the IATI-Codelists repository), and defines the relationship between IATI attributes and IATI codelists. The dashboard and reference site both use this mapping file. For instance, the mapping file states that <mapping>
<path>//iati-activity/recipient-country/@code</path>
<codelist ref="Country" />
</mapping>When the code used depends on the <mapping>
<path>//iati-activity/default-aid-type/@code</path>
<codelist ref="CashandVoucherModalities" />
<condition>@vocabulary = '4'</condition>
</mapping>In cases where multiple vocabularies can be used, there’s usually a default vocabulary. So for example, if no <mapping>
<path>//iati-activity/default-aid-type/@code</path>
<codelist ref="AidType" />
<condition>@vocabulary = '1' or not(@vocabulary)</condition>
</mapping>So this pull request ensures the dahboard preferentially uses these default vocabularies (shown by a |
Default mappings should be preferred.
|
Doesn’t look like this will be merged; closing. |
The problem
Some attributes can contain values from different codelists, depending on the
@vocabularyused. The dashboard doesn’t have a means of showing this, as per the yellow banner shown on dashboard codelists, and #174.Given the dashboard doesn’t have the functionality to select from multiple vocabularies, it needs to choose which vocabulary to use. Where a default vocabulary exists, it seems to make sense to prefer that one. That doesn’t necessarily happen at the moment, so this PR fixes that.
So for example, in the case of
iati-activity/sector/@code, the default vocabulary isSector. However, the dashboard currently uses the SectorCategory vocabulary:Similarly (as reported in #567),
iati-activity/default-aid-type/@codeuses the AidType vocabulary by default. However, the dashboard currently uses the (rarely used) CashAndVoucherModalities vocabulary:The proposed solution
This PR ensures that when a default vocabulary exists for a given attribute, it is preferred on dashboard codelist pages.
For
iati-activity/sector/@code, that’s Sector:For
iati-activity/default-aid-type/@code, that’s AidType:It’s worth noting that for a small number of IATI attributes, there is no default codelist. For example,
iati-activity/tag/@code. In such cases, we use the codelist for the first mapping for that attribute found in the mapping file.Fixes #567.