Differences

This shows you the differences between two versions of the page.

--- planning:userguide:tutorials:plan_history [2017/02/16 18:35] – kmobile
+++ planning:userguide:tutorials:plan_history [2021/07/29 18:28] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
 ====== Plan History ======
-The //Plan History// allows the user to see all changes and modifications made to a plan.Each modification to a plan will result in a new //Revision// of the plan (note: in a complex plan there may be hundreds of revisions). If the user is not satisfied with the results of a modification they may go back to any of the previous //Revision//s and make that instance the active instance (note: this will cause another //Revision// to be created for the reversion). Below is a walk through and more detailed explanation of this feature.
+Since the Astroid system captures and stores the user inputs (rather than the results), it is able to maintain an exhaustive history of all edits made to your data with relatively low storage needs. Users are able to benefit from this information through the //Plan History// feature that is available within each treatment plan. The //Plan History// is a feature that allows the user to see and explore __all__ the changes and modifications made to a plan. Each modification to a plan will result in a new //Revision// of the plan (note: in a complex plan there may be hundreds of revisions). If the user is not satisfied with the results of a modification they may go back to any of the previous revisions and restore it to the active instance (note: this will cause another //Revision// to be created for the reversion). Below is a walk through and more detailed explanation of this feature.
-  - Open the //General// block from the Plan Overview {{ :planning:userguide:tutorials:plan_history_general_tab.png?300 |}}
-  - The summary of the latest revisions will expand to the right {{ :planning:userguide:tutorials:plan_history_history_list.png?300 |}}
+  - Open the //General// block from the Plan Overview and the History item can be seen at the bottom of this block {{ :planning:userguide:tutorials:plan_history_general_tab.png?300 |}}
-  - Expand the //History// (this is not mandatory)
+  - The summary of the latest revisions will appear in the right display pane {{ :planning:userguide:tutorials:plan_history_history_list.png?300 |}}
+  - Expand the //History// details by clicking the small arrow (this is not mandatory)
     - The number of plan revisions will be listed (In the above example there are 4 revisions)
   - The user can now review the various revision summaries
-    -  Clicking the blue //show// link will expand that particular version of the plan and explain what was changed.
+    -  Clicking the blue //show// link will expand that particular version of the plan and explain what was changed
-     - "op": is the operation performed in this version that differs from the previous version (i.e. delete: an item was deleted)
+     - "op": is the operation performed in this version that differs from the previous version (e.g. insert: an item was added)
-     - "path": is the item in the treatment plan data that had the operation performed
+     - "path": is the item in the treatment plan data that had the operation performed (e.g. points: a point geometry was changed)
-     - "val": is the value in the path that had the operation performed
+     - "val": is the value of the data that was changed (see image below for the "val" of an added point)
   - If the user would like to return to this version they may do so by clicking the blue //make active// link
   - The user can close the expanded version by clicking the blue //hide// link {{ :planning:userguide:tutorials:plan_history_revisions_details.png?300 |}}