====== Nest Versions ======

Nest Versions allow you (an admin) to save a version of your nest at a certain date and time. This version can be restored any time, creating an editable nest copy and contains all the work saved in the nest at that point before changes were made. 

===== Saving a Version =====

Navigate to Settings and scroll to the "Nest Versions." Click "Save a Version" to save a version of your nest at the present time. **Versions can only be saved manually this way.** This version will only contain work up to the point the version was saved, and any changes to the nest after saving a version will not be reflected in the nest version.

{{ :undefined:screenshot_2024-06-14_at_13.57.37.png?nolink |}}

Once a version is saved, the date & time, total number of records, included records and a Synthesis checkbox will be shown. You can edit the Version Name using the pencil icon. 

<WRAP center round info 60%>
You can only save a version at the present time. You cannot save a version from a past date.
</WRAP>

===== Synthesis Versions =====

Both the AutoLit and Synthesis portions of the nest are saved within a version and, if you wish, you may select a Synthesis Version to be displayed in the current state of your nest. In other words, if you're making updates to your nest, but want your Synthesis page to reflect a previous version, you can check the box for that version and the Synthesis will remain unchanged/reflective of that previous nest version.

If no version Synthesis checkbox is selected, Synthesis will automatically update as changes are made in the nest.

{{ :undefined:screenshot_2024-06-14_at_14.01.16.png?nolink |}}

===== Restoring a Copy =====

A saved version will remain in the list in Settings until deleted. 

**Take care when deleting a version, because this action cannot be undone. Deleting a versionp removes your ability to make a copy of that saved nest.**

To restore the version and create a copy of this saved nest, click "Restore Copy."

{{ :undefined:screenshot_2024-06-14_at_14.06.46.png?nolink |}}

This action is the same as making a nest copy. You will see a modal to name your copy, upon clicking "Create" you will be automatically taken to this new nest copy and the nest will show up in your AutoLit menu.

===== When should you save a Nest Version? =====

Like in any project, it is recommended you save a version before taking any major changes to your nest. This could be before:

  * Any major changes in Settings (e.g. Screening modes)
  * Applying a bulk action (especially if you are unsure if this action is reversible)
  * Any type of deletion (search, exclusion reasons, tags etc.)
  * Any fundamental changes to your project (altering the tag hierarchy, general study design)

Alternatively, nest versions can be useful to save periodically as a "just in case," and not for a particular reason!