Edit (DSD-linked) referential metadata in .Stat DLM Excel add-in
-
* Implemented as extension of DLM Excel add-in, keeping the current approach in the flat format with SID column and one column per component -
* DLM Excel add-in wizard adds possibility to extract alternatively ref metadata, but only in flat format (not for time-series-oriented formats) -
* Maintain original attachment levels (dataflow, partial keys) -
* Like for data and attributes, allow retrieval and editing (re-uploading) of complete ref metadata tables or currently selected ref metadata lines -
* A rich-text editor is required for the cell content of ref metadata -
* The rich-text editor takes the ref metadata representation into account and proposes appropriate editing screens -
* Multi-valued ref metadata are not yet to be supported -
* Multi-language ref metadata are to be supported: a single ref metadata value in a cell could contain several languages (the rich text editor must accommodate for multiple languages) -
* All other add-in editing features (ribbon menus and icons) are the same than for data editing. -
* Tbd: actions to be supported right from the beginning: append, replace, delete?
DLM Excel add-in wizard mockup to choose ref metadata (exclusive choice)
Excel sheet example to edit referential metadata:
Notes:
-
- The button to edit a ref metadata cell content should be easily reachable within the DLM menu ribbon. Exact placement tbd! -
- In addition, the cell's context menu with "Edit rich content" should allow opening the editor. -
- Currently, we do not (yet) need to support multi-valued and hierarchical ref metadata attributes.
Single-valued non-localised HTML ref metadata:
Single-valued localised HTML ref metadata:
The rich-text editor can/should be an already existing open-source solution, the mock-up is thus not binding. Rich-text editing should allow for editing XHTML text:
-
- WYSIWYG approach -
- bold, italic, underline, strikethrough, subscript, superscript styles -
- clear styles -
- ordered (numbered), unordered (bullet) list -
- add/delete tables, table header, columns, lines -
- add/remove links -
- insert (linked) image -
- text colour -
- select all (text) -
- delete -
- editing several (pre-defined) locals -
- HTML preview (to view the HTML code) -
Instead of opening a popup, it would be even nicer if the user could choose to open the rich text editor as integrated Excel side panel, e.g.:
Technical notes
- Ref metadata retrieval: use of new SDMX data API to retrieve only ref metadata for given data filter in new SDMX-CSV format
- In retrievals where there are no current ref metadata (HTTP 404 - not found), it would be very useful to still have the table header and allow users adding new lines for submissions
- Ref metadata saving: use of new Transfer data import to upload SDMX-CSV with ref metadata (according to supported action types)
- See attached simple example of rich text editor: Metadata_Template_V4.xlsm
Previous outdated specifications...
To mirror epic &10
Technical_Specifications_for_the_storage_and_retrieval_of_SDMX_Referential_Metadata_Values.docx
Design
- To implement the outcome design of dotstatsuite-data-lifecycle-manager#54 (moved)
Original functional specifications
DLM List all structural artifacts
dotstatsuite-data-lifecycle-manager#137
Metadata upload, download and transfer features
dotstatsuite-data-lifecycle-manager#89 (closed)
Metadata search feature
Metadata filters
To consider: review the current OECD 42 Attribute types. Also consider if Control Codes should be managed an additional Attribute type.
To consider: Attached to a DSD? Do we attach Metadata at a DSD or Dataflow level? If yes, choosing a DSD or a Dataflow in a facet would only display the corresponding Metadata.
List of Dataflows (can be pre-filtered when filtering by DSD) and user can select one only for viewing its associated Metadata.
To consider: Coordinate/Dimension? How would those facets be built? Maybe it would be better to replace this feature by an auto-fill free text search?
Coordinate box associated to Target Dimensions
Have a coordinate box where coordinates would automatically get built when selecting dimensions
- Dimension 1 : country > AUS and CAN
- Dimension 2 : year
- Dimension 3 : variable
- The coordinate would get build: AUS+CAN
- Dimension 1 : country > AUS and CAN
- Dimension 2 : year > 1999 to 2002 : outside the coordinate in sdmx
- Dimension 3 : variable
- The coordinate would still be: AUS+CAN.
- Dimension 1 : country > AUS and CAN
- Dimension 2 : year > 1999 to 2002 : outside the coordinate in sdmx
- Dimension 3 : variable > GDP national
- The coordinate would then be: AUS+CAN.GDP
Slider feature
Combination of 2 components: single selection box for Metadata Owners and Date Picker.
Metadata user actions
Create
- Using the UI (for one coordinate or for the group)
- Select coordinate(s), add coordinate title (in several languages)
- Select metadata type
- Add metadata (in several languages)
- Text
- Enumerated
- Metadata security (private/public): can be solved with annotations?
- Upload metadata from a file
- Consider reusing the same features and functionalities as in "Transfer Data" wizard.
- Should the transfer Metadata wizard be integrated in the Metadata page management, or should the user be redirected to the "Transfer Data" wizard?
Edit
- One coordinate
- Multiple coordinates update: input one text for several coordinates, keeping the metadata duplicated though.
Maybe use a checkbox for multiple edit?
Delete
Copy
To consider:
- Important is to differentiate EDIT and VIEW.
- Edit in a grid would be really nice – what would replace the Excel?
- What about artefact versions?
For example, which codelist do we display for Country if we have several versions? Each would be related to a particular DSD… Should we add a ‘last updated version’?
- What about language? Prioritized language with possibility to change it? Notify the user if text in default language is missing (for INS: if Arabic is missing, the user has to be notified that Arabic text is missing).
- What about import functionality? Be able to import ready-made Metadata. Continue using Excel (with macros) for uploading metadata (there should be a way to upload big amounts of Metadata, not only creating one by one)?
- Grouping by Dataflow or Title (Metastore)? Do we wish to have any grouping? Any specific order?