Change the list of related dataflows in the Overview page using an ad-hoc query defined in an annotation
As Bettina,
I want to see in the Overview tab, in the list of related dataflows, only a specific list of dataflows defined by an SDMX structure query, e.g. those that are categorized within the same topic as the current dataflow, whatever their DSD,
So that the displayed list of dataflows is more relevant.
Details
To define an alternative list of dataflows to be displayed, the data owner can use an annotation, which provides the structure query to be used instead of the currently auto-generated DSD+DF query.
- The annotation type is
RELATED_DATA
. - The annotation title contains the structure query without the service root, e.g.,:
V2/structure/categoryscheme/OECD/OECDCS1/*/ENV,ENV.ENV_AC?references=dataflow
categoryscheme/OECD/OECDCS1/1.0/ENV?references=dataflow
datastructure/OECD/DSD_TEST/1.0?references=dataflow
dataflow/OECD.DIR.PROJECT/all/all
<common:Annotation>
<common:AnnotationTitle>V2/structure/categoryscheme/OECD/OECDCS1/*/ENV,ENV.ENV_AC?references=dataflow</common:AnnotationTitle>
<common:AnnotationType>RELATED_DATA</common:AnnotationType>
</common:Annotation>
If the annotation is not present, then the current behaviour (list of DFs of the underlying DSD) is maintained.
Example
With an annotation RELATED_DATA
=V2/structure/categoryscheme/OECD/OECDCS1/*/ENV,ENV.ENV_AC?references=dataflow
instead of the current list:
[none because there are no other DFs for this DSD]
the related DFs displayed would be:
- A3205 Inventory of air pollutants (in 1000 tons) 1990 - 2017
- Annotation test
- Dataflow for testing of HTML text
Technical details
The user should not provide the service root as the DF maybe copied from one space to another with its annotation. Thus the DE needs to complement the query with the service root of the DF (https://nsi-qa-stable.siscc.org/rest/
):
https://nsi-qa-stable.siscc.org/rest/V2/structure/categoryscheme/OECD/OECDCS1/*/ENV,ENV.ENV_AC?references=dataflow
Only the DFs returned by the query are returned. Errors are ignored, in which case the related DFs section is omitted.