diff --git a/app/save-and-restore/app/doc/images/compare-snapshots-view.png b/app/save-and-restore/app/doc/images/compare-snapshots-view.png index be7553b95f..c5fb8b30c7 100644 Binary files a/app/save-and-restore/app/doc/images/compare-snapshots-view.png and b/app/save-and-restore/app/doc/images/compare-snapshots-view.png differ diff --git a/app/save-and-restore/app/doc/images/compare-to-archiver.png b/app/save-and-restore/app/doc/images/compare-to-archiver.png new file mode 100644 index 0000000000..69036ffd2b Binary files /dev/null and b/app/save-and-restore/app/doc/images/compare-to-archiver.png differ diff --git a/app/save-and-restore/app/doc/images/compare-to-other-snapshot.png b/app/save-and-restore/app/doc/images/compare-to-other-snapshot.png new file mode 100644 index 0000000000..be83a10a59 Binary files /dev/null and b/app/save-and-restore/app/doc/images/compare-to-other-snapshot.png differ diff --git a/app/save-and-restore/app/doc/images/compare_to_archiver.png b/app/save-and-restore/app/doc/images/compare_to_archiver.png deleted file mode 100644 index 651a16fb83..0000000000 Binary files a/app/save-and-restore/app/doc/images/compare_to_archiver.png and /dev/null differ diff --git a/app/save-and-restore/app/doc/images/filter-highlight.png b/app/save-and-restore/app/doc/images/filter-highlight.png index 7c4b6c0054..b48a66625e 100644 Binary files a/app/save-and-restore/app/doc/images/filter-highlight.png and b/app/save-and-restore/app/doc/images/filter-highlight.png differ diff --git a/app/save-and-restore/app/doc/images/launch-search.png b/app/save-and-restore/app/doc/images/launch-search.png index ae863906e5..5c53dfa231 100644 Binary files a/app/save-and-restore/app/doc/images/launch-search.png and b/app/save-and-restore/app/doc/images/launch-search.png differ diff --git a/app/save-and-restore/app/doc/images/restore-failed.png b/app/save-and-restore/app/doc/images/restore-failed.png new file mode 100644 index 0000000000..b8eb1e8fa7 Binary files /dev/null and b/app/save-and-restore/app/doc/images/restore-failed.png differ diff --git a/app/save-and-restore/app/doc/images/restore-with-scale.png b/app/save-and-restore/app/doc/images/restore-with-scale.png index b23c8a734d..716435b4a5 100644 Binary files a/app/save-and-restore/app/doc/images/restore-with-scale.png and b/app/save-and-restore/app/doc/images/restore-with-scale.png differ diff --git a/app/save-and-restore/app/doc/images/snapshot-new.png b/app/save-and-restore/app/doc/images/snapshot-new.png index 56c8ac958d..d0c25cd6fb 100644 Binary files a/app/save-and-restore/app/doc/images/snapshot-new.png and b/app/save-and-restore/app/doc/images/snapshot-new.png differ diff --git a/app/save-and-restore/app/doc/images/snapshot-restore-filter.png b/app/save-and-restore/app/doc/images/snapshot-restore-filter.png index 0f281eeb32..b0600b120c 100644 Binary files a/app/save-and-restore/app/doc/images/snapshot-restore-filter.png and b/app/save-and-restore/app/doc/images/snapshot-restore-filter.png differ diff --git a/app/save-and-restore/app/doc/images/snapshot-restore.png b/app/save-and-restore/app/doc/images/snapshot-restore.png index d18b1ff1b5..a55c20407c 100644 Binary files a/app/save-and-restore/app/doc/images/snapshot-restore.png and b/app/save-and-restore/app/doc/images/snapshot-restore.png differ diff --git a/app/save-and-restore/app/doc/images/snapshot-taken.png b/app/save-and-restore/app/doc/images/snapshot-taken.png index 27cf35f3bf..7769f9ef20 100644 Binary files a/app/save-and-restore/app/doc/images/snapshot-taken.png and b/app/save-and-restore/app/doc/images/snapshot-taken.png differ diff --git a/app/save-and-restore/app/doc/images/snapshot-threshold.png b/app/save-and-restore/app/doc/images/snapshot-threshold.png index 0848b3d6d9..5e47ce7320 100644 Binary files a/app/save-and-restore/app/doc/images/snapshot-threshold.png and b/app/save-and-restore/app/doc/images/snapshot-threshold.png differ diff --git a/app/save-and-restore/app/doc/images/toggle-delta-zero.png b/app/save-and-restore/app/doc/images/toggle-delta-zero.png index 21372faf14..cadbac5171 100644 Binary files a/app/save-and-restore/app/doc/images/toggle-delta-zero.png and b/app/save-and-restore/app/doc/images/toggle-delta-zero.png differ diff --git a/app/save-and-restore/app/doc/images/toggle-readback.png b/app/save-and-restore/app/doc/images/toggle-readback.png index 9bc89faa44..52db957ace 100644 Binary files a/app/save-and-restore/app/doc/images/toggle-readback.png and b/app/save-and-restore/app/doc/images/toggle-readback.png differ diff --git a/app/save-and-restore/app/doc/index.rst b/app/save-and-restore/app/doc/index.rst index b7c4816767..eab505e600 100644 --- a/app/save-and-restore/app/doc/index.rst +++ b/app/save-and-restore/app/doc/index.rst @@ -221,7 +221,9 @@ This will open the snapshot view: :width: 80% The left-most column will show live values for the list of PVs in the configuration. If the application fails to -connect to a PV, this will be indicated accordingly. +connect to a PV, this will be indicated accordingly (one PV in this snapshot). Note that since the configuration +for this snapshot defines one non-empty read-back PV, the read-back PV related columns are automatically set to visible +when the snapshot is loaded. Clicking the Take Snapshot button will disable the UI while all PVs are read. Once the read operation completes, values are displayed in the view: @@ -229,7 +231,10 @@ values are displayed in the view: .. image:: images/snapshot-taken.png :width: 80% -Note that the Timestamp column shows the timestamp as provided by the PV record, i.e. it need not be the current timestamp. +Upon completion of the operation additional columns will indicate the outcome. In this example one PV is disconnected, +which is indicated in the extra column header as well as in the corresponding row. This is particularly useful if +disconnected PVs are outside the visible portion of the list: the header icon will indicate that a disconnected +PVs can be found when scrolling down the list. Once a snapshot has been taken, user must provide a case sensitive name and comment to be able to save it. Snapshot names for the same configuration must be unique. User may choose to take a new snapshot in the same view before saving it. @@ -291,8 +296,8 @@ toolbar is used to toggle between show/hide: .. image:: images/toggle-delta-zero.png :width: 80% -The snapshot view does by default not show PV read-back values if such have been defined in the configuration. -The left-most columns in the toolbar can be used to show/hide columns associated with such read-back PVs: +If any item in a configuration contains a non-empty read-back PV name, then columns associated with read-back PV data +are shown by default. The left-most columns in the toolbar can be used to show/hide these columns: .. image:: images/toggle-readback.png :width: 80% @@ -326,14 +331,27 @@ User may invoke a restore operation (from client or from service) from context m view or in the search-and-filer view. In this case user will not have the possibility to unselect specific PVs. However, PV items configured as read-only will not be restored. +Restore result +^^^^^^^^^^^^^^ + +Once the restore operation completes, the UI will indicate potential write failures. +The additional column to the left will indicate such failures through the column header and on each individual +failed PV row: + +.. image:: images/restore-failed.png + :width: 80% + + Comparing Snapshots ------------------- To compare two (or more) snapshots, user must first open an existing snapshot (double click in tree view). Using the -Compare Snapshots context menu item for a snapshot node user may choose a snapshot to load for comparison. +Compare Snapshots context menu item for a snapshot node user may choose a snapshot to load for comparison: + +.. image:: images/compare-to-other-snapshot.png -Once the additional snapshot has been loaded, the snapshot view will show stored values from both snapshots. In this view -the :math:`{\Delta}` Base Snapshot column will show the difference to the reference snapshot values: +Once the additional snapshot data has been loaded, the snapshot view will show stored values from both snapshots. In this view +the :math:`{\Delta}` Base Snapshot column will show the difference to the reference snapshot values. .. image:: images/compare-snapshots-view.png :width: 80% @@ -362,6 +380,12 @@ The search tool is launched as a separate view through the icon on top of the tr .. image:: images/launch-search.png +If no filters have been saved, the drop-down widget will show but one item: . Selection of this item always +disables filtering in the tree view. + +The Auto checkbox is hidden if no auto-filter activators are available. Filter activators are site specific plugins that +- based on custom business rules - will select particular filters and automatically apply them if the checkbox is ticked. + The search tool is rendered as a separate tab and will always be the left-most tab in the right-hand side pane of the save&restore UI: @@ -379,11 +403,12 @@ disabled. The bottom-right pane in the search tool shows all saved filters, which can be edited or deleted. If a filter is edited and saved it under the same name, user will be prompted whether to overwrite as filter names must be unique. -In the tree view user may select to enable and chose a saved filter: +In the tree view user may select chose a saved filter, e.g. match on configuration nodes only. .. image:: images/filter-highlight.png -Nodes in the tree view matching a filter will be highlighted, i.e. non-matching items are not hidden from the view. +Nodes matching the filter are highlighted by rendering non-matching items as if disabled. Note however that user may +still interact with non-matching items. **NOTE:** When selecting a filter in the tree view, only matching items already present in the view will be highlighted. There may be additional nodes matching the current filter, but these will be rendered and highlighted only when their parent nodes