Differences

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

--- software:squirrel:restore_process [2026/01/10 16:12] – support@smikar.com
+++ software:squirrel:restore_process [2026/01/10 16:29] (current) – support@smikar.com
@@ Line 1: / Line 1: @@
-===== 🧾 Restore Files Process =====
+===== 🔄 File Restore and Rehydration (Stub-Based Restore) =====
-In the [[https://www.smikar.com/squirrel/|Squirrel]] system, **Stub Files** are lightweight placeholders left in SharePoint after a file has been archived. These files look and feel like the original file to end users, but the actual file data is stored securely in Azure Blob Storage.
+In the [[https://www.smikar.com/squirrel/|Squirrel]] system, **file restore (rehydration)** is the process of seamlessly returning an archived file from Azure Blob Storage back into SharePoint when a user interacts with a stub file.
-Stub files allow users to continue working within SharePoint, OneDrive, or Microsoft Teams as though the file is still present, maintaining a seamless experience while significantly reducing storage usage.
+This page explains how the restore process works when an end user clicks the **Restore** option from a Squirrel stub file, and what happens behind the scenes.
 ----
-==== ⚙️ How Stub Files Work ====
+==== 👤 End User Restore Experience ====
-When a file is archived using Squirrel:
+From the end user’s perspective, restoring a file is simple and intuitive:
-. The original file is moved from SharePoint to Azure Blob storage.
+  * The user locates the stub file in SharePoint, OneDrive, or Microsoft Teams.
-. A **stub file** is left behind in its place within the SharePoint document library.
+  * The user opens the stub file and clicks the **Restore** button.
-. This stub retains the original filename, extension, and metadata — but is only a few kilobytes in size.
+  * A Squirrel restore page opens, showing a **real-time progress indicator**.
-. When the stub is clicked, the original file is retrieved (“rehydrated”) and restored to its original location.
+  * Once complete, the user is presented with options to:
+    * Open the file directly, or
+    * Open the file location in SharePoint.
-This approach allows organizations to save on storage while preserving usability for end users.
+The restored file then behaves exactly like any normal SharePoint file.
+> ✅ No administrator involvement is required.
+> ✅ No special client software is required.
+> ✅ The experience is browser-based and fully integrated into SharePoint.
 ----
-==== 🌟 Benefits of Stub Files ====
+==== ⚙️ What Happens During Restore ====
-- **📉 Reduced Storage Usage**
+When a user triggers a restore from a stub file, Squirrel performs the following operations:
-  Significantly lowers SharePoint storage consumption by offloading actual file content to low-cost Azure storage.
-- **👤 Transparent to End Users**
+  - The restore request is securely sent to the Squirrel rehydration service.
-  Users continue working as normal — stub files retain the name and format of the original, and rehydration is just a click away.
+  - Squirrel validates the file, tenant, and restore request.
+  - The archived file is located in the customer’s Azure Blob Storage.
+  - The file is **decrypted and decompressed**.
+  - The file is **streamed back into SharePoint**.
+  - The stub file is replaced with the original file.
+  - The restore is finalized and the user is notified.
-- **💰 Cost Efficiency**
+Throughout this process, the user can monitor progress in real time from the restore page.
-  Optimize Microsoft 365 storage without compromising accessibility or user experience.
 ----
-| **Example Stub File UI** | {{:software:squirrel:squirrel_stubv2.png?400}} |
+==== 🗂️ Versions and Metadata Preservation ====
-The stub file interface provides administrators with all the metadata needed to restore files manually if required:
+Squirrel restore is designed to perform a **full-fidelity rehydration**, returning archived content back into SharePoint as close as possible to its original state.
-- **📄 Filename to Restore**
+During restore, Squirrel attempts to:
-  Displays the full filename and extension (e.g., `pptx_5MB_v2_11877.pptx`)
-- **🌐 SharePoint Site Info**
+  * Restore all available file versions.
-  Shows the URL of the original SharePoint site where the file was archived from.
+  * Preserve original timestamps.
+  * Preserve SharePoint metadata.
+  * Return the file to its original SharePoint location.
-- **🔗 Full File URL**
+The objective of the restore process is to return the file so that, once completed, it behaves in SharePoint like a standard non-archived file, with version history and properties intact where supported by the platform and source data.
-  A complete path to the file in SharePoint. Admins can use this to verify the original location before restoring.
-- **🔄 Restore Link**
+Because restore operations depend on the state of the source environment and Microsoft 365 platform behaviours, exact reconstruction of all attributes may vary in exceptional cases.
-  A clickable link at the bottom of the stub. Right-click and choose **“Open link in new tab”** to trigger a manual restore.
+----
-- **🎨 Customisation**
+==== 🔁 End-to-End Restore Lifecycle ====
-  Stub files can be branded with your organization's **colors and logo**, providing a consistent user experience.
+  - User clicks **Restore** from the stub file.
+  - Squirrel validates and initiates the restore job.
+  - Archived content is securely retrieved from Azure Blob Storage.
+  - Data is decrypted and decompressed.
+  - File content and available versions are restored to SharePoint.
+  - The stub is removed and replaced with the original file.
+  - The user is offered options to open the file or its location.
 ----
-==== 👩‍💻 End User Restore Experience ====
+==== 🎯 What Administrators Should Know ====
-Squirrel makes it easy for end users to restore archived files:
+For customer administrators, the stub-based restore process means:
+  * No service desk involvement for routine file recovery.
+  * No manual handling of blobs, containers, or exports.
+  * Files are restored back into their **original SharePoint location**.
+  * File history, structure, and metadata remain intact.
+  * End users remain in control of day-to-day retrieval.
+This enables large-scale archiving without introducing operational overhead or disrupting business users.
+----
-- Stub files behave like normal files within SharePoint, OneDrive, and Teams.
+==== 🌐 Visual Walkthrough ====
-- When clicked, the file is automatically restored to its original location.
-- A real-time **progress bar** shows the status of the rehydration process.
-- All file versions and metadata are retained during the restore.
-> ✅ Files restored through stub files are seamless — no admin involvement is required.
+A full visual walkthrough of the end-user restore experience is available here:
-Want to see it in action?
+👉 [[https://www.smikar.com/squirrel-data-rehydration/|Squirrel File Rehydration Walkthrough]]
-👉 [[https://www.smikar.com/squirrel-data-rehydration/|View the End User Restore Process]]
 ----
-Need help customizing your stub file layout or troubleshooting rehydration issues? Contact [support@smikar.com](mailto:support@smikar.com).
+If you need assistance with stub configuration, restore branding, or validating restore behaviour in your environment, contact support@smikar.com.