Squirrel – Data Rehydration Overview
Squirrel helps you optimize storage costs by archiving files and their versions to your own Azure Blob storage—a significantly cheaper storage option—while leaving behind a convenient placeholder (a “stub”) in SharePoint. Whenever you need the original file, simply restore (rehydrate) it in a few clicks.
What Is a Stub File?
A stub file is a placeholder left behind by Squirrel after it archives an original file from SharePoint. Rather than permanently deleting the file from your document library, Squirrel replaces it with a small, lightweight “stub” that acts as a marker for the archived content. The stub retains the appearance and location of the original file, ensuring users can easily find and restore it when needed.
Stub files are an essential feature of Squirrel, allowing organizations to reduce storage costs and optimize SharePoint performance while maintaining accessibility to archived content. Here’s how it works:
Archiving the Original File: When a file is archived, its full content—including all versions—is moved to secure, cost-effective storage (such as Azure Blob Storage). This reduces the size of your SharePoint environment while still keeping the file accessible.
Creating the Stub: The stub is left behind in the same location as the original file, retaining key metadata such as the file name, location, and modification details. For example, if the original file is example.docx, the stub will be named example.docx.html. This stub is in HTML format and can be opened in a browser.
On-Demand Restoration: When a user needs the original file, they simply open the stub file. The stub provides a Restore link, allowing the user to rehydrate the file seamlessly, restoring it to its original format and location, including all historical versions.
Why Stub Files Are Useful?
Storage Efficiency: By archiving the actual content of files, stub files drastically reduce the amount of storage required in SharePoint.
User Transparency: Stub files appear in the same location as the original files, so users can find and restore files without needing to access a separate archive.
Preserved Metadata: Stub files retain important metadata, ensuring seamless integration with existing workflows and tools.
Version History: All file versions are archived alongside the original file and are restored together, maintaining full historical records.
Stub files provide a balance between cost-saving storage optimization and the user-friendly accessibility of archived content, ensuring that businesses can manage their data effectively without disrupting daily workflows.
Restoring Files in SharePoint with Squirrel
Squirrel offers flexible and intuitive options for restoring archived files, making it simple for end users to bring their content back into SharePoint when needed. Depending on the user’s workflow and preference, there are three primary ways to restore (rehydrate) archived files. These options ensure that users can access their data with minimal effort, while maintaining all associated file versions and metadata.
Each method is designed to seamlessly reintegrate the archived content back into the SharePoint environment. Whether users prefer working through the SharePoint interface, leveraging mapped drives, or using OneDrive-synced folders, Squirrel provides an end-to-end solution for efficient file restoration.
All methods ensure that the restored files are returned to their original location in SharePoint—complete with their version history, and full functionality—so users can work with them as if they were never archived. These flexible options allow Squirrel to integrate into various workflows, making it accessible and efficient for a wide range of use cases.
Restoring Archived Files Using A Stub Within the SharePoint UI
Opening the Stub & Clicking “Restore”
End users can open a stub file directly within the SharePoint document library to initiate the restore process. This option provides detailed information about the file being restored and tracks progress, making it ideal for single-file restores.
Step 1: Find the Stub
Look for the archived file’s stub in your SharePoint library (e.g., example.docx.html).
In this example, we are going to restore the file called AssetInventory Roster Jan.xlsx.html
You can see that the file is a Stub File, as it has the original file name and has amended .html at the end.
Step 2: Open the Stub
Click on it as if you’re opening the original file.
When you locate the stub in your SharePoint document library (for example, filename.docx.html), click on it as if you’re opening any standard file. Instead of opening the original document, you’ll be directed to a Squirrel Restore page (often referred to as the “stub page”) that contains important file restore details, such as:
Filename to Restore – Shows the name of the original file you’re trying to rehydrate (e.g., AssetInventory Roster Jan.xlsx).
SharePoint Site – Displays the specific SharePoint URL or site collection where this file originally resided, such as:
https://CUSTOMERSHAREPOINTSITE.sharepoint.com/sites/SalesDept
Full File URL – Shows the complete path to the archived file, including libraries and folders, for full clarity:
https://CUSTOMERSHAREPOINTSITE.sharepoint.com/sites/SalesDept/Shared Documents/Contracts/AssetInventory Roster Jan.xlsx
SiteGUID & FileGUID – These are unique identifiers that Squirrel uses to keep track of which SharePoint site the file belongs to, and the specific file in question and they ensure restoration accuracy.
Restore Link – The User will see a prompt (e.g., “Right-click here and select ‘Open link in new tab’ to restore your file.”) which, when clicked, initiates the rehydration process. Squirrel will retrieve the file (including all versions) from its Azure Blob storage archive and replace the stub with the original document back in SharePoint.
Step 3: Restoration Process
After clicking the Restore link in the previous step, you’ll be taken to the Squirrel Restore Request screen (shown in the adjacent image). Here, you’ll see:
Filename – This is the name of the file to be restored.
Restore Status – The status of the file restoration process.
File Size – The size of the original file (file to be restored) in bytes.
Date Archived – When the file was archived.
File GUID – The unique identifier for the file.
Site GUID – The unique identifier for the site/location where the file was stored or restored
Beneath these details is a progress bar that outlines the major stages of the restore process:
Queued: This stage represents the point at which the file restore request is received and added to a processing queue, waiting for further action in the restore workflow.
Stage Transfer: This step involves the initial movement of the requested file from its storage or archive location to a temporary or staging area in preparation for the next phases of the restore process.
Decrypted: During this phase, the file undergoes a decryption process to convert it back to its original, readable format if it was previously encrypted for security purposes.
Final Transfer: This step refers to the relocation of the decrypted file from the staging area to its designated final destination, where it will be accessible to the requester.
Restored: At this stage, the file has been successfully placed in its intended location and is fully accessible for use by the requester.
As each phase completes, its status will change (or show a check mark), giving you real-time visibility into the progress. This entire process begins the moment you click that Restore link—Squirrel fetches the archived file from its secure storage, decrypts it if necessary, and finally transfers it back into SharePoint (along with all versions). Once Restored is marked complete, your file is fully rehydrated and ready to use.
This page can be closed once the tick has appeared under the Queued Heading.
Step 4: Full Content Restored
After Squirrel finishes fetching and transferring your file from its archive, you’ll see a “Squirrel Restore Request” page indicating the process is complete. The screenshot shows each stage in the restore workflow—Queued, Stage Transfer, Decrypted, Final Transfer, and Restored—marked with a green check. You’ll also find important file details, such as:
Filename: The original name of the restored document (e.g., “AssetInventory Roster Jan.xlsx”).
Restore Status: Confirmed as “Restored.”
File Size – The size of the file in bytes.
Date Archived – When the file was archived by Squirrel.
File GUID and Site GUID: Unique identifiers that confirm precisely which file and site were involved in the restore.
At the bottom of the screen, a link labeled “Click here to go to your file location” takes you directly to the file in SharePoint. Now that the restoration is complete, the stub in your SharePoint library is replaced with the fully accessible original file, including all its versions.
With this final confirmation, you can confidently open or edit your document as needed—Squirrel has successfully rehydrated your archived file!
Step 5: Access Your Restored File
Once Squirrel’s restore process completes, you’ll see the fully rehydrated file back in your SharePoint library with its original name—no more “.html” at the end. As shown in the adjacent screenshot, the file appears just like any other document:
File Restored: The stub is replaced by the actual file, complete with all its historical versions.
Open & Edit: Click to open, edit, or share it just as you would any standard SharePoint document.
Version History: Right-click on the filename (or use SharePoint’s native version history feature) to view or revert to prior versions—Squirrel preserves the entire revision record.
At this point, your archived file is once again fully accessible, ensuring a seamless user experience and peace of mind that all data is intact.
Restoring Archived Files Using the Restore Button Within the SharePoint UI
Restoring Archived Files Using the Restore Button
SharePoint’s Restore button, visible in the ArchiveRestore column, allows users to quickly rehydrate files with a single click. This streamlined method is perfect for users who want a fast, no-frills restore option directly from the library interface.
Step 1: Locate the File Stub
In your SharePoint document library, look for the stub file created by Squirrel.
You may notice an ArchiveRestore column in the SharePoint view; if an item is recognized as a Squirrel stub, you’ll see a Restore button next to it.
This button indicates the file has been archived and can be rehydrated with just a click.
Step 2: Restore Progress View
After clicking the Restore button in the previous step, you’ll be directed to the Squirrel Restore Request page.
This page starts the file restoration process and provides real-time updates on the progress.
The details shown here are the same as those displayed earlier in the SharePoint stub view, ensuring consistency and clarity for the user.
Step 3: Restoration Complete
Once the restoration process is finalized, the Squirrel Restore Request page updates to reflect the successful completion of all steps. The progress bar now displays green checkmarks for every stage, indicating that the file has been fully restored. The details shown include:
Filename: Displays the name of the file successfully restored (e.g., “Carbon Budget.xlsx”).
Restore Status: Updated to “Restored” to confirm the process is complete.
File Size: Indicates the size of the restored file.
Date Archived: When the file was originally archived.
File GUID and Site GUID: These unique identifiers verify the specific file and SharePoint site restored.
At the bottom of the page, you’ll see a link labeled “Click here to go to your file location.” Clicking this link will take you directly to the SharePoint document library where the file is now fully rehydrated.
The restored file replaces the stub and is ready for immediate use, complete with its version history and metadata. This seamless process ensures users have easy access to their content with minimal disruption.
Step 4: File Restored and Available in SharePoint:
After the restoration process is complete, the file is now fully available in your SharePoint document library. The stub has been replaced by the original file, and you can open or edit it as needed. The restored file retains all its metadata and includes the full version history, ensuring you have access to every prior iteration of the document.
Here’s what you’ll see in the SharePoint UI:
Restored File: The file appears in its original location, with no “.html” extension, indicating it has been fully rehydrated.
Version History: You can access the file’s version history via the native SharePoint functionality, ensuring that all previous versions are preserved and available.
Ready for Use: The file can now be opened, edited, or shared just like any other document in SharePoint.
This final step demonstrates how seamlessly Squirrel integrates with SharePoint, restoring archived files while preserving their full history and usability. Users can proceed with their work without any interruptions or loss of data.
From Within Windows Explorer
Restoring Archived Files Within a SharePoint Mapped Drive or a OneDrive Synced Folder
For users who prefer accessing SharePoint files through File Explorer, stub files can be restored from a mapped network drive or a OneDrive-synced folder. This option offers a familiar desktop workflow for interacting with and restoring archived files.
Step 1: Locate the File to Restore
In this example, the SharePoint site has been synced using OneDrive Sync, making the files accessible directly in Windows Explorer.
Within the synced folder, you’ll see several stub files, such as AssetInventory Presentation.pptx.html, which represent archived files.
To restore the file, the user simply opens the desired stub to initiate the restore process.
Step 2: The Stub File is Displayed
When the stub file is opened, it launches in the end user’s web browser. The page displays the same details about the archived file as previously mentioned, providing clarity on the file being restored.
To initiate the restoration, the user simply needs to right-click on the link provided and select ‘Open link in new tab’ to begin the process.
Step 3: The Restore Process Begins
Once the link is opened, the restore process is initiated.
The steps involved in the restoration are the same as previously detailed, ensuring the file is seamlessly rehydrated and returned to its original location.
Step 4: The File is Restored
Once the restore process completes, the Squirrel Restore Request page confirms that the file has been fully restored. All steps in the restore process—Queued, Stage Transfer, Decrypted, Final Transfer, and Restored—are marked as Complete with green checkmarks, ensuring the restoration was successful.
Step 5: The File is Fully Restored
After the restoration process is complete, the file is fully rehydrated and appears in the synced folder or mapped drive, as shown in the example. In this case, the file AssetInventory Presentation.pptx has been restored to its original format and is now ready for use.
Original Format Restored: The file is no longer a stub (e.g., .html) but is restored to its original format (e.g., .pptx), ready to open, edit, or share.
All Versions Restored: Along with the current version, all historical versions of the file are also restored, ensuring that the full version history is available for review or rollback if needed.
Ready for Use: The restored file integrates seamlessly back into your SharePoint or synced folder, retaining all metadata and usability.
This step confirms that Squirrel’s restoration process fully preserves the file and its version history, making it accessible as though it had never been archived. The user can now continue working with the file without any interruptions.
Squirrel: Smart SharePoint Archiving, Seamless Restoring!
Optimize your storage, reduce costs, and retrieve your files effortlessly with Squirrel—the ultimate solution for intelligent archiving and seamless restoration in SharePoint.
