Allow editing daily start and end time periods since August 24, 2023 Release .Stat Suite elote / DLM Excel-addin v3.3.3
Configurable content language selector since July 4, 2023 Release .Stat Suite dragonfruit / DLM Excel-addin v3.3.0
Time period boundaries in the filter selector since October 26, 2022 Release .Stat Suite DLM Excel-addin v3.2.3
Data availability on dimension values since April 28, 2022 Release .Stat Suite .NET 8.1.0
Table of Content
- Selection wizard
- Table contents
- Change selection
Clicking on “Get data: New table” allows first selecting a source data space, both internal and external, through a dropdown box. The data spaces displayed are to be configured per installation package (see more details here).
If the Excel-addin is configured to get data from external sources, then clicking on “New table > External sources…” will open a second list of data sources in a popup window with the list of those external data sources.
Once a data space is selected, the Selection wizard guides the user through a two-steps process:
- Step 1 - Select data
- Step 2 - Specify output
The step 1 of the Selection wizard provides a dropdown selector of dataflows for the selected data source. It is possible to:
- filter the dataflow list by “favorites” or “all” with a radio button (all by default)
- filter the dataflow list by keyword(s)
The Excel-addin configuration allows defining a list of languages used for the display of the content in the selection wizard and the table. Each source has its own configuration. The first language in the list is used as the initial/default language (see more details here on how to setup the configuration).
The “Content language” option displays a dropdown list of available languages. Selecting a different language from the dropdown list will automatically update the content of the below dataflow selector. If a dataflow has no name in a selected content language, then only the dataflow ID is displayed. The same rule applies to all other localised contents in the “Edit filters” window.
Any change in the language selection by the user is memorised and maintained.
The user can add a dataflow to its favorites by clicking on the star icon once a dataflow is selected. Clicking on “EDIT FAVORITES” opens an extra window with the list of dataflows already flagged as favorites (with a yellow star) and all other dataflows from the same data source not flagged as favorites (with a grey star). Clicking on a grey star makes it yellow and thus the related dataflow is flagged as favorite, and vice-versa.
It is also possible to filter the list to show only favorites. The user can unflag favorites dataflows by clicking on “CLEAR”, or confirm its list of favorites by clicking on “SAVE”.
The DLM Excel-Addin has an in-built cache with 2 functions:
- Caching structures for the duration of 3 days,
- Caching data for the duration of the current Excel session (only for the case that the user changes the table layout but not the data selection).
In order to allow you getting fresher structures than those in the current cache, clicking the cache clean-up refresh button empties the cache for all structures.
Selecting a dataflow automatically displays the list of corresponding dimensions and the current filters. To edit filters, by clicking on the “EDIT FILTERS” button, the user can:
- Modify the default “all” selection for a given dimension filter by selecting elements one by one;
- Select all elements or none for a given dimension filter;
- Search for a specific element (spotlight feature) in a dimension filter;
- Show only selected elements per dimension filter;
- Apply the user’s final selection(s), or cancel all (No filter, re-applying the “all” default setup).
Only dimension values with available data are displayed in the edit filters panel. It means that, if e.g. a dataflow has only annual data but it is using a codelist with more frequency values (e.g. Monthly, or Daily), then only Annual frequency will appear in the Frequency selector.
Similarly, when the dataflow has a time dimension, the default start and end periods reflect the current data availability by applying the related values in the SDMX actual content constraint as default time period boundaries (e.g. start:2017 end:2022). If the dataflow has no actual content constraint, then the time period start and end values are empty by default.
Once the user has applied a filter selection(s), it is possible to view and directly modify it/them by editing the “Current filters” fields (add/remove).
The dataflow selection, including filtered dimensions, is also displayed at the bottom of the wizard using SDMX Rest syntax, and the user can edit this query directly in the field and apply the desired modifications. The filter selections will then be updated accordingly in the above data filters.
Clicking on “Next step” will display the step 2 of the selection wizard.
The step 2 provides output options for the selected data or referential metadata. The user can:
- Choose in which Excel cell the output table should start;
- Specify the output table layout as “Flat”, “Time series down”, or “Time series across”;
- Choose whether to return the localised names (labels) for dimensions and dimension members, with or without excluding the underlying codes (IDs). The language of the localised names can be picked from the ones that are available in the sourced data.
Note that the content language selected in the initial step will also be pre-selected in this step, if it exists for the given dataflow. If it does not exist, then the first available language for that dataflow will be pre-selected. The list of available output languages is always ordered according to the order of name languages in the dataflow definition.
The user can choose one of the following content type (combinations):
- Values for observations values
- Values and Attributes for observation and attributes values
- Referential metadata if they are available for the selected dataflow
If there are no referential metadata defined for a selected dataflow (in case that the DSD doesn’t have the
METADATA annotation type), and/or if the configuration of the data source is not set with the paramater
isMetadata="true" (see the installation documentation here), then the option to return referential metadata is disabled. Instead, this option has a question mark icon added, which shows the tooltip message on mouse-over: “See here for information on how to define referential metadata” with a link to the related documentation.
Note that for attribute values defined at higher level than the observation value, those high-level attribute values are retrieved and replicated for each time-series in the 2 time-series formats, and for each observation in the flat format.
The DLM Excel-Addin also generates the user selection in various supported formats by clicking on “SHOW QUERY SYNTAX” (also accessible in the right-click menu):
- SDMX Rest query
Clicking on “Get data” generates the Excel table filled with all available observations values or referential metadata for the given selection.
Data table content
The data table generated by the DLM Excel-addin includes a header row with several well-ordered columns:
- first column: SID (stands for “Series Identifier”).
- one column for the ID of each dataflow dimension
- one column OBS_VALUE
- one column for the ID of each dataflow attribute (if selected and if any)
After the header row, the data table has one row per observation, which contains:
- SID column: contains the full coordinate (key) of each time series constructed as the combination of the IDs of the values of each dimension, except the Time Period dimension, separated with ‘.’, e.g.
- Dimension column: ID of the corresponding dimension value
- OBS_VALUE column: the corresponding observation value (no value: empty)
- Attribute column: the corresponding attribute value (coded: ID, non-coded: value, no value: empty)
- The SID is mandatory for adding new observation or attribute values.
- When data are not available while trying to retrieve them, and if the user has write access to the data space for this dataflow, then a warning message “No (meta)data available for this selection” is displayed and only the header row of the data table is generated. This allows the user immediately adding new rows with new data.
Referential metadata table content
A referential metadata table generated by the DLM Excel-addin includes a header row with several well-ordered columns:
- first column: SID (stands for “Series Identifier”)
- one column for the ID of each dataflow dimension
- one column for the ID of each referential metadata attribute
After the header row, the referential metadata table has one row per attachment, which contains:
- SID column: contains the full or partial coordinate (key) of the attachment constructed as the combination of the IDs of the values of each dimension, and except the Time Period dimension, separated with ‘.’. The positions of dimensions to which the referential metadata are not attached remain empty, e.g.
- Dimension column: if the referential metadata is attached to this dimension then the ID of the corresponding dimension value, otherwise the cell is empty.
- Referential metadata attribute column: the corresponding attribute value (coded: ID, non-coded: value, no value: empty)
- The SID is mandatory for adding new referential metadata values.
- The SID of referential metadata attached at dataflow level is only composed of a number of dots (depending on the number of non-time-period dimensions, e.g. ‘.’ or ‘…’).
- When referential metadata are not available while trying to retrieve them, and if the user has write access to the data space for this dataflow, then a warning message “No (meta)data available for this selection” is displayed and only the header row of the referential metadata table is generated. This allows the user immediately adding new rows with new referential metadata.
The “Refresh” section of the Excel-addin ribbon provides two options to whether
- request to refresh the data or referential metadata tables in your “Current Sheet”, or
- all data or referential metadata tables in “All Sheets”.
Clicking one of the options will fully refresh the data or referential metadata table(s) with updated values from the underlying source(s).
Clicking on “Get Data - Change Selection” re-opens the selection wizard back to Step 1 (Select data) where the user can modify the current selection and filter(s).
Applying new options all the way through Step 2 (Specify output) and “Get data” will generate a new Excel table thus replacing the previous one.