Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file modified app/save-and-restore/app/doc/images/filter-highlight.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified app/save-and-restore/app/doc/images/launch-search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified app/save-and-restore/app/doc/images/restore-with-scale.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified app/save-and-restore/app/doc/images/snapshot-new.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified app/save-and-restore/app/doc/images/snapshot-restore-filter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified app/save-and-restore/app/doc/images/snapshot-restore.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified app/save-and-restore/app/doc/images/snapshot-taken.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified app/save-and-restore/app/doc/images/snapshot-threshold.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified app/save-and-restore/app/doc/images/toggle-delta-zero.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified app/save-and-restore/app/doc/images/toggle-readback.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
43 changes: 34 additions & 9 deletions app/save-and-restore/app/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -221,15 +221,20 @@ 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:

.. 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.
Expand Down Expand Up @@ -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%
Expand Down Expand Up @@ -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%
Expand Down Expand Up @@ -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: <no filter>. 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:

Expand All @@ -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
Expand Down