NOT_DISPLAYED annotation for dimensions, their values, attributes and their values
As a .Stat DE user
In order to not be disturbed by unnecessary or confusing information
I want to to not see dimension, dimension values (from a Codelist), attributes or attribute values (from a Codelist) that were marked by the data owner as "NOT_DISPLAYED", in certain circumstances.
Scenario 1: Hide dimensions marked with annotation "NOT_DISPLAYED"
Given that I'm using the DE visualisation page
When a dataflow dimension has an annotation "NOT_DISPLAYED" (see SDMX-JSON syntax below)
Then in addition of hiding the dimension in the table's/chart's sub-title (when only one single value is selected or returned (as of Release v0.5 March 2019)), this dimension should also not appear in the filters.
Scenario 2: Hide dimension values marked with annotation "NOT_DISPLAYED"
Given that I'm using the DE visualisation page
When a dimension value has an annotation "NOT_DISPLAYED" (see SDMX-JSON syntax below)
Then it is not shown in the table/chart sub title. It is still shown in the filter of the visualisation page.
Scenario 3: Hide attributes marked with annotation "NOT_DISPLAYED"
Given that I'm using the DE visualisation page
When a dataflow attribute has an annotation "NOT_DISPLAYED" (see SDMX-JSON syntax below)
Then the attribute is not displayed in the table.
Scenario 4: Hide attribute values marked with annotation "NOT_DISPLAYED"
Given that I'm using the DE visualisation page
When an attribute value has an annotation "NOT_DISPLAYED" (see SDMX-JSON syntax below)
Then it is not shown in the table.
SDMX-JSON syntax (structure or data message)
- Syntax - in dimension or attribute definition (data message or within the DSD in structure message) to hide dimensions or attributes:
"annotations": [{
"type": "NOT_DISPLAYED"
}]
- Syntax - in dataflow definition (structure message) or dataset definition (data message) to hide dimensions or attributes:
"annotations": [{
"type": "NOT_DISPLAYED",
"title": "DIM3,DIM6,ATTR5,ATTR6" <-- These are the related dimension and attribute IDs
}]
- Syntax - in code definition within the codelist (structure message) or in dimension/attribute value (data message) to hide dimension values or attribute values:
"annotations": [{
"type": "NOT_DISPLAYED"
}]
- Syntax - in DSD or dataflow definition (structure message) or dataset definition (data message) to hide dimension values or attribute values:
"annotations": [{
"type": "NOT_DISPLAYED",
"title": "DIM1=CODE1+CODE2,DIM3=CODE4,ATTR7=CODE5+CODE6" <-- These are the related IDs of dimensions and their values, and attributes and their values
}]
Note: See functional specifications here: https://oecd.aha.io/features/ONEDATA-72 (paragraphs for "Annotation for hiding dimensions in the table" and "NOT_DISPLAYED annotation with an extended behavior")