View historic versions in DLM Excel Add-in
As Benjamin
I want to be able to retrieve the historic versions of data in Excel
So that I can easily see who has changed what and when.
Functional specifications
User selection
-
Add new clickable section for 'Previous data versions' on Step 2 of the Selection Wizard. The below listed options, labels and input fields are only enabled if this section is ticked. -
Add a new datetime selector valid for any radio option of this section -
Add radio option 'Data changed since:', which implements the updatedAfter
NSI parameter. The datetime must have a selection before being able to 'GET DATA'. This feature removes and replaces the 'Updated after' selection in the filter edit popup.
-
Add radio option 'All data changes since:', which implements the includeHistory
NSI parameter. If the datetime has a selection then also set theupdatedAfter
NSI parameter. -
Like for 'Referential metadata', this section is compatible only with the flat view
of the table. The other table type options are disabled when this section is ticked.
Notes:
- The third option 'Data as of:' is implemented in a separate ticket.
- Logically, the NSI will only return non-SDMX-confidential and non-SDMX-embargoed data versions for non-authorised users.
Display of results
-
Add ACTION
(after SID) as the second column of the table to display the textual label (as defined in #54 (closed)) of the ID returned in theaction
property of the dataset containing the observation -
Add UPDATE_DATE
as the third column of the table to display the datetime returned in thevalidFrom
property of the dataset containing the observation -
Any of these options in this section will result in a read-only table. The Save to Database
menu is disabled for these tables.
Notes:
- The
UPDATED_BY
column with the account used to change the data is implemented in a separate ticket.
ORIGINAL REQUEST ------>
Here are screens related to the "View history " (versioning) feature in Excel AddIn, at the " Get data " feature level:
"New Table"/”Change Selection”: after the user has clicked on "New Table" or “Change Selection” at the component level “STAT DLM” in Excel, has entered his identifiers and has chosen a dataset in a space, the window hereafter appears.
**TO BE ADDED: two new checkboxes and a new “update date” field are accessible within the data filters section of this window. **
1. If the user is authorized, the date field is per default disabled and checkboxes active but not ticked.
- If both checkboxes are unchecked, it indicates the system will only retrieve the latest version of the observations (=per default).
- “VERSIONS HISTORY (read-only)”: when the user ticks this checkbox, it indicates the system will retrieve, for each observation that matches the « Data filters », all versions of the observations, versions making part of the history included. o Message displayed linked to “Read-only”: all versions making part of the history are read-only for all users, data owner/privileged users included. If a user is able to have access to “save to database” buttons and has updated one of these history versions, the system must display a message to the user to clearly indicate this data will not be updated in the database when “save to the database” functionality is used.
- “VALID VERSIONS”: when the user ticks this checkbox, the “DATE” field is enabled, and the user can set a date. For each observation that matches the « Data filters », the system retrieves the latest version (=active version) at the time determined by the date specified by the user.
Example: some data concerning the period of October is uploaded in the system in November. A first version of this data is created by
the system. This data concerning the period of October is updated a little bit later in January the next year. A second version
(=latest version) is created in such a case by the system. If the user sets a date in December in the field, the system will retrieve
the first version of the data updated in November and not the latest one as in December the valid version of the data was still the
first version.
- Only one checkbox can be enabled at a time. The DATE field can only be used together with the “VALID VERSIONS” checkbox. The system will take care of enabling or disabling the checkboxes/date field based on the user’s action:
o If the user ticks the checkbox “VALID VERSIONS”, the system automatically unchecks the other checkbox. The DATE field is also enabled by the system. o If the user ticks the checkbox “HISTORY VERSIONS (read-only)”, the system automatically unchecks the other checkbox and disables the DATE field. The potential value filled by the user in the DATE filed is also removed by the system.
2. If the user is not authorized, the date field is blank and disabled. Both checkboxes are also unchecked and disabled.
II. Data presentation in Excel:
- This data presentation only concerns the Excel “flat view” for the moment.
- In addition to the dimensions and attributes linked to each version of the observation of the selected dataflow, “UPDATED” and “UPDATED_BY” must also be retrieved and displayed in Excel. o UPDATED: this information is the timestamp saved by the system linked to the creation of the version. This information is read-only and cannot be udpated by the user. o UPDATED_BY: this information indicates who (user or system) has modified/loaded/added the observation triggering the automatic creation of the version. o ERROR MESSAGE: UPDATED is “read-only” for all users, data owners/privileged users included. If a user is able to have access to “save to database” buttons and has updated this field, the system must display a message to the user to clearly indicate this data will not be updated in the database when “save to the database” functionality is used.