DataExplorer display of Referential Metadata in table view (i)
As Gyorgy,
I want to see availability of advanced attributes and of referential metadata and their details similar to the current .Stat V7 Browser (see below),
So that I can model the data optimally and present all information about the data.
Current ref metadata display example in .Stat V7 Browser:
Attributes not already shown in flags or footnotes (which are not marked as to be hidden) and referential metadata associated to a dataflow and its data should be displayed in table views as links (with an (i) icon) that open on click a hidable side panel ("drawer") with all referential metadata and advanced attribute content.
In the following, referential metadata and advanced attribute are noted as "metadata".
Functional specifications
Metadata availability in a pivot table
- Metadata availability should be marked in the table view with an "(i)" icon ("(i)" stands for information) at the appropriate level (same levels as currently for footnote attributes).
- The metadata "(i)" icon should be shown at the level of detail where metadata is attached:
- Dataset (=dataflow level, empty coordinate)
- The "(i)" icon should be shown after the table title.
- Partial coordinate (any number of dimensions > 0) depending on the table layout
- If metadata pertains to all observations in the row, the "(i)" is shown in the corresponding cell of the extra (grey) column.
- If metadata pertains to all observations in the column, the "(i)" is shown in the corresponding cell of the extra (grey) row.
- If metadata pertains to all observations in the table, the "(i)" icon should be shown after the table title.
- If metadata pertains to the observation in a cell (some coordinate dimensions are in columns and others are in rows), the "(i)" is shown in the cell.
In the table above:
- An "(i)" next to the table title (orange for illustration purposes) is shown for a metadata related to the dataflow and for metadata that applies to all cells of the showable grid.
- An "(i)" in the left-hand column (red for illustration purposes) is shown for metadata when in it applies to all the cells of the row.
- An "(i)" in the top row (green for illustration purposes) is shown for metadata when it applies to all the cells of the column.
- An "(i)" in a data cell (blue for illustration purposes) is shown for metadata when in it applies to a specific value in the cell only.
Metadata information in the side panel
- Clicking on the "(i)" icon in the pivot table view will reveal the metadata information available through a side panel (e.g.: https://material-ui.com/components/drawers/#temporary-drawer; ltr display: right. rtl display: left) as an overlay of the data table/chart, so it does not impact the layout and behaviour of the table, the filters on any other component of the web page.
- The "(i)" icon itself should change its state to highlighted (specific colour, e.g. standard orange), while opening the drawer with additional information.
- The table "Labels" option and localised names/values are applied to all content whenever possible.
- The metadata headers are titled by their attachment:
- dataflow: same as table title
- partial coordinate: similar to fixed dimensions in table sub-title
- All advanced attributes are grouped under one parent level named (through configuration/localisation) "Data Characteristics” and ordered in the same order as they are defined in the DSD. The "Data characteristics" group is shown before the referential metadata.
- Referential metadata is displayed with a tree structure if a ref metadata attribute hierarchy is defined in the MSD.
- Metadata are titled with their name/ID according to the table "Labels" option.
- The type of the metadata value (as defined in DSD or MSD) is to be respected, e.g. string, number, coded value, date(time), etc. Referential metadata values can also be XHTML strings. The html instructions should be applied on the screen (at least for a well-defined subset including: bold, italic, underline, strike-through, subscript, superscript, ordered list, unordered list, links, external images, text colour, tables). Referential metadata values can be localised.
- If a metadata value is missing then this metadata title is not shown.
- All information groups are expanded by default. It should be possible to collapse / expand information groups one by one or all at the same time.
- The side panel is closed by clicking the overlay, clicking the 'close' icon or pressing the Esc key. This cancels also the highlight state of the "(i)" icon.
Mockup:
- see: https://sis-cc.gitlab.io/.stat-suite/design/demo/de-material/dataset.html
- graphical design (to be complemented/corrected): https://sis-cc.gitlab.io/.stat-suite/design/demo/ui-documentation/informations.html
Technical considerations
-
The referential metadata availability or information is provided through the SDMX-JSON 2.0 message format
-
It is to be decided by the devs if there would be a unique data request to get all relevant data and referential metadata at the same time or in different steps. In the later case (which might be the better approach), the first (default) data request should contain data and ref metadata availability information (e.g. by using an annotation of type "HAS_METADATA" returned at the same attachment levels), and a separate call will retrieve the referential metadata for a specific attachment.
-
Advanced attributes are retrieved from the data message like any other attribute.
-
The data structure (DSD) contains an annotation of type "METADATA"
<structure:DataStructure agencyID=“XXX“ id=“XXX" version=“1.0"> <common:Annotations> <common:Annotation> <common:AnnotationTitle>urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataStructure=OECD:MSD_TEST(1.0)</common:AnnotationTitle> <common:AnnotationType>METADATA</common:AnnotationType> </common:Annotation> </common:Annotations> <common:Name xml:lang="en">XXX</common:Name> <structure:DataStructureComponents> ... </structure:DataStructureComponents> </structure:DataStructure>
-
SDMX-JSON 1.0 structure messages can be used to retrieve the MSD with the definition of available attributes.
Functional additions potentially considered for later
- Metadata attached at higher levels in the data structure hierarchy should be also be displayed (e.g. when displaying information attached to a series, also the corresponding information at the upper dimension combinations and the dataflow that concern that observation should be displayed). The order of metadata is ascending, thus highest levels are shown last.- Download the current side panel information in HTML format.
- Include the support of Referential Metadata in chart views?
- The side panel can be anchored to the top, bottom, left or right edge of the screen. This should be configurable for each instance of .Stat DE when setting up the installation.
important snippet: sis-cc/eurostat-sdmx-ri/nsiws.net.mirrored$2191494