Project Archiving (Functionality) - Revision history

Dgreenwood: /* Example: safeguard before a major redesign */

2026-01-30T22:26:11Z

Example: safeguard before a major redesign

← Older revision		Revision as of 17:26, 30 January 2026
Line 76:		Line 76:
	* Files are sorted chronologically by their timestamp in the name, helping you find the most recent archives first.		* Files are sorted chronologically by their timestamp in the name, helping you find the most recent archives first.

	== Example: ~~safeguard~~ before a major redesign ==		== Example: Safeguard before a major redesign ==
	Before restructuring a Content Model and its Data Fields across a Project:		Before restructuring a Content Model and its Data Fields across a Project:
	# Use '''Archive Project''' and set "Prefix" to <code>PreRedesign</code>.		# Use '''Archive Project''' and set "Prefix" to <code>PreRedesign</code>.
	# Proceed with changes.		# Proceed with changes.
	# If the redesign causes issues, use '''Restore From Archive''' and select the <code>PreRedesign_Archive_yyyy-MM-dd_HHmmss.zip</code> to roll back to the known-good configuration.		# If the redesign causes issues, use '''Restore From Archive''' and select the <code>PreRedesign_Archive_yyyy-MM-dd_HHmmss.zip</code> to roll back to the known-good configuration.

Dgreenwood at 22:24, 30 January 2026

2026-01-30T22:24:46Z

← Older revision		Revision as of 17:24, 30 January 2026
Line 18:		Line 18:
	⚠		⚠
	\|		\|
	Archive Project only works on ~~the full Project~~. You cannot archive individual ~~objects~~ inside a Project ~~or Batch~~.		Archive Project only works on Projects. You cannot archive individual nodes inside a Project nor can you archive Batches.
	\|}		\|}

Rpatton at 21:51, 30 January 2026

2026-01-30T21:51:59Z

← Older revision		Revision as of 16:51, 30 January 2026
Line 1:		Line 1:
	{{AutoVersion}}		{{AutoVersion}}

	<blockquote>{{#lst:Glossary\|~~Archive~~}}</blockquote>		<blockquote>{{#lst:Glossary\|ProjectArchiving}}</blockquote>

	{\|class="download-box"		{\|class="download-box"
Line 12:		Line 12:

	== Introduction ==		== Introduction ==
	~~The~~ Archive command creates a versioned ZIP snapshot of a [[Project]] so you can preserve, audit, and roll back configuration as needed. Archiving saves a copy of the Project's configuration into a file attached to the Project.		Project Archiving, through the use of the Archive Project command, creates a versioned ZIP snapshot of a [[Project]] so you can preserve, audit, and roll back configuration as needed. Archiving saves a copy of the Project's configuration into a file attached to the Project.

	{\|class="attn-box"		{\|class="attn-box"
Line 18:		Line 18:
	⚠		⚠
	\|		\|
	Archive only works on the full Project. You cannot archive individual objects inside a Project or ~~Batches~~.		Archive Project only works on the full Project. You cannot archive individual objects inside a Project or Batch.
	\|}		\|}

	== When to use ==		== When to use ==
	Use Archive when you want to:		Use Archive Project when you want to:
	* '''Retain a historical copy''' of a Project before making significant changes.		* '''Retain a historical copy''' of a Project before making significant changes.
	* '''Recover from accidental modifications or deletions''' by rolling back to a known-good configuration.		* '''Recover from accidental modifications or deletions''' by rolling back to a known-good configuration.
Line 28:		Line 28:

	Prerequisites:		Prerequisites:
	* The Archive command is available on Projects.		* The Archive Project command is available on Projects.
	* To restore, the Project must have one or more archived ZIP files attached.		* To restore, the Project must have one or more archived ZIP files attached.

	== How to use the Archive command ==		== How to use the Archive Project command ==
	The Archive command can be accessed by right-clicking on a Project Node Type and selecting the relevant command from the fly out menus. There are no special configurations needed prior to archiving a Project.		The Archive command can be accessed by right-clicking on a Project Node Type and selecting the relevant command from the fly out menus. There are no special configurations needed prior to archiving a Project.

Line 57:		Line 57:
	# (Optional) By default, the "Archive Current" property is set to "True". This will preserve the current Project configuration before restoration. To disable, click the check box to the right of the property. When enabled:		# (Optional) By default, the "Archive Current" property is set to "True". This will preserve the current Project configuration before restoration. To disable, click the check box to the right of the property. When enabled:
	* Grooper first archives the current state (using the same naming format and "Prefix" if set).		* Grooper first archives the current state (using the same naming format and "Prefix" if set).
	* You can set a Prefix to the new Archive with the Prefix property.		* You can set a Prefix to the new Project Archive with the Prefix property.
	# Execute the command to import the selected archive into the Project.		# Execute the command to import the selected archive into the Project.

Line 72:		Line 72:

	=== Where archived Projects are stored ===		=== Where archived Projects are stored ===
	* ~~Archives~~ are saved as files attached to the Project and appear in the Project's file list on the "Advanced" tab.		* Archived Projects are saved as files attached to the Project and appear in the Project's file list on the "Advanced" tab.
	* Valid archive files are ZIPs that contain <code>Archive_</code> in the name and end with <code>.zip</code>.		* Valid archive files are ZIPs that contain <code>Archive_</code> in the name and end with <code>.zip</code>.
	* Files are sorted chronologically by their timestamp in the name, helping you find the most recent archives first.		* Files are sorted chronologically by their timestamp in the name, helping you find the most recent archives first.

Rpatton: Created page with "{{AutoVersion}}
{{#lst:Glossary|Archive}}
{|class="download-box" | File:Asset 22@4x.png | You may download the ZIP below and upload it into your own Grooper environment (version 2025). The Zip contains one or more '''Projects''' with resources used in examples throughout this article. * Media:2025 Wiki Archive Project.zip |} == Introduction == The Archive command creates a versioned ZIP snapshot of a Project so you can preserve, au..."

2026-01-30T21:44:08Z

Created page with "{{AutoVersion}} <blockquote>{{#lst:Glossary|Archive}}</blockquote> {|class="download-box" | File:Asset 22@4x.png | You may download the ZIP below and upload it into your own Grooper environment (version 2025). The Zip contains one or more '''Projects''' with resources used in examples throughout this article. * Media:2025 Wiki Archive Project.zip |} == Introduction == The Archive command creates a versioned ZIP snapshot of a Project so you can preserve, au..."

New page

{{AutoVersion}}

<blockquote>{{#lst:Glossary|Archive}}</blockquote>

{|class="download-box"
|
[[File:Asset 22@4x.png]]
|
You may download the ZIP below and upload it into your own Grooper environment (version 2025). The Zip contains one or more '''Projects''' with resources used in examples throughout this article.
* [[Media:2025 Wiki Archive Project.zip]]
|}

== Introduction ==
The Archive command creates a versioned ZIP snapshot of a [[Project]] so you can preserve, audit, and roll back configuration as needed. Archiving saves a copy of the Project's configuration into a file attached to the Project.

{|class="attn-box"
|
⚠
|
Archive only works on the full Project. You cannot archive individual objects inside a Project or Batches.
|}

== When to use ==
Use Archive when you want to:
* '''Retain a historical copy''' of a Project before making significant changes.
* '''Recover from accidental modifications or deletions''' by rolling back to a known-good configuration.
* '''Audit or inspect''' previously published configurations.

Prerequisites:
* The Archive command is available on Projects.
* To restore, the Project must have one or more archived ZIP files attached.

== How to use the Archive command ==
The Archive command can be accessed by right-clicking on a Project Node Type and selecting the relevant command from the fly out menus. There are no special configurations needed prior to archiving a Project.

=== Archive a Project ===
'''Follow these steps on the Grooper Design page:'''
# In your Node Tree, select the Project you want to archive.
# Right-click on the Project. Then in the fly-out menu hover over "Archive" and then click on "Archive Project..."
# (Optional) When the pop up appears, set the "Prefix" property to prepend a label to the archive file name. For example, entering <code>Version 1.0</code> results in files like <code>Version 1.0_Archive_yyyy-MM-dd_HHmmss.zip</code>.
# Execute the command to save the archive.

'''Results:'''
* Grooper creates a ZIP archive and saves it as a file on the Project. You can see what files are attached by selecting the "Advanced" tab of the Project node.
* The archive file name format is <code>Archive_yyyy-MM-dd_HHmmss.zip</code> with optional prefix: <code>''Prefix''_Archive_yyyy-MM-dd_HHmmss.zip</code>.

<div style="position: relative; box-sizing: content-box; max-height: 80vh; max-height: 80svh; width: 100%; aspect-ratio: 1.78; padding: 40px 0 40px 0;"><iframe src="https://app.supademo.com/embed/cmjxgntgw0073zd0ihdx24cv5?embed_v=2&utm_source=embed" loading="lazy" title="01 Creating a Project Archive(Copy)" allow="clipboard-write" frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>

=== Restore an archived Project ===
'''Use this to roll back the current Project to a previously archived state.'''
# Select the Project you want to restore.
#* If the Project CAN be restored, an Archived zip file will be attached to the Project. To check for an archived file, visit the "Advanced" tab of the Project Node.
# Right-click on the Project. Then in the fly-out menu, hover over "Archive" and click on "Restore From Archive...".
# In the pop up, click the "..." to the right of the Archive File Name property.
# Choose the archive file you want to restore from the list. Only valid files are listed (names containing <code>Archive_</code> and ending with <code>.zip</code>).
# Click "OK".
# (Optional) By default, the "Archive Current" property is set to "True". This will preserve the current Project configuration before restoration. To disable, click the check box to the right of the property. When enabled:
* Grooper first archives the current state (using the same naming format and "Prefix" if set).
* You can set a Prefix to the new Archive with the Prefix property.
# Execute the command to import the selected archive into the Project.

'''Results:'''
* If "Archive Current" is enabled, the current configuration is saved first.
* The Project is cleared and then reloaded from the selected archive ZIP, restoring the prior configuration.

'''Deleting an Archive:'''
# Navigate to the "Advanced" tab of the Project node.
# Select the Archive zip file on the right that you want to delete.
# Click the delete icon in the top right corner of the Files panel.

<div style="position: relative; box-sizing: content-box; max-height: 80vh; max-height: 80svh; width: 100%; aspect-ratio: 1.78; padding: 40px 0 40px 0;"><iframe src="https://app.supademo.com/embed/cmjxgnwfq0087zd0idhzplwhk?embed_v=2&utm_source=embed" loading="lazy" title="02 Restoring a Project Archive(Copy)" allow="clipboard-write" frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>

=== Where archived Projects are stored ===
* Archives are saved as files attached to the Project and appear in the Project's file list on the "Advanced" tab.
* Valid archive files are ZIPs that contain <code>Archive_</code> in the name and end with <code>.zip</code>.
* Files are sorted chronologically by their timestamp in the name, helping you find the most recent archives first.

== Example: safeguard before a major redesign ==
Before restructuring a Content Model and its Data Fields across a Project:
# Use '''Archive Project''' and set "Prefix" to <code>PreRedesign</code>.
# Proceed with changes.
# If the redesign causes issues, use '''Restore From Archive''' and select the <code>PreRedesign_Archive_yyyy-MM-dd_HHmmss.zip</code> to roll back to the known-good configuration.