software:squirrel:restore_buttons []

This is an old revision of the document!

Overview: Squirrel Restore Buttons for SharePoint

The Squirrel Restore and Archive Buttons integrate seamlessly with SharePoint, providing a user-friendly interface to restore archived files with a single click. This functionality is powered by an SPFx package and a custom Restore column in your SharePoint sites.

Key Features:

One-Click Restore and Archive: Quickly restore or archive files directly from the SharePoint UI.
Flexible Configuration: Apply to individual sites or across all SharePoint sites.
Secure Operations: Restores are managed through secure a custom SPFX extension, and uses the logged in users Entra ID for authentication.

This functionality is powered by a combination of a provided SPFx package and PowerShell scripts, ensuring seamless integration with your SharePoint environment.

Setting Up Restore Buttons in SharePoint

Step 1: Upload the SPFx Package

Obtain the SPFx package provided by SmiKar Software.
Go to your SharePoint Admin Center. (https://TENANTNAME-admin.sharepoint.com/)
Navigate to More Features > Apps > Open.
Click Upload and select the SPFx package.
Optional. Choose All sites to deploy the package to all of your sharepoint sites / or select
The app has now been enabled
Confirm the App shows that the status is enabled and available to all sites.

Add the Restore Column to your SharePoint Sites.

SmiKar will provide you with three powershell scripts. These are;

Delete and Unassociate Restore Buttons.ps1. This script will remove the Squirrel Restore column from all of your SharePoint Sites.
Create and associate restore button.ps1. This script will add the Squirrel Restore column to all of your SharePoint Sites.
Add Button to Individual Site.ps1. This script will add the Squirrel Restore column to one individual SharePoint Site.
You will need to ensure that you have Global Administrator rights to your SharePoint Tenant

Step 2: Create and Deploy the Restore Column to all your SharePoint Sites.

We will run the “create and associate restore button.ps1” to add the Squirrel Restore Column to all of your current SharePoint Sites.

Obtain the powershell script provided by SmiKar Software. “Create and associate restore button.ps1
Open the Powershell script in Visual Studio Code
You will need to update the powershell script, with the Tenant Name of your SharePoint environment. On line 2, within the brackets replace “TENANTNAME” with your details. Make sure to save the file before continuing.
Now that you have saved the file, you are ready to run the script against your SharePoint Environment. Within Visual Studio Code, press F5 to start running the script. The script will now run through all your SharePoint Sites, and add the Restore Column to each Document Library.
Once completed, you should see the script say “🎉 ✅ SPFx Field Customizer installed and associated on all sites!”
Once completed, to confirm, choose a document library from one of your SharePoint Sites. You should now see a Restore Column for the Squirrel Restore Button to show when a file is archived by Squirrel.

Step 3: Adding the Restore Column to an individual SharePoint Site.

We will run the “Add Button to Individual Site.ps1” to add the Squirrel Restore Column a specific SharePoint Site. This should be done anytime you create a new SharePoint site, and want the Squirrel Restore button to be available for your end users.

Open the Powershell script in Visual Studio Code. ”“Add Button to Individual Site.ps1”
You will need to update the powershell script, with the Tenant Name of your SharePoint environment. On line 2, within the brackets replace “TENANTNAME” and “SITENAME” with your details. (or replace the whoe URL with the URL of your new site.. Make sure to save the file before continuing.
Now that you have saved the file, you are ready to run the script against your SharePoint Environment. Within Visual Studio Code, press F5 to start running the script.
Once it has completed, the script will respond with “🎉 ✅ Restore button added successfully to Your New Site URL”
Now you confirm the column is available on your New SharePoint Site. Go to your new Document Library, and verify you can see the Restore Column is available.

Step 4: Deleting the Restore Column from all of your SharePoint Sites.

We will run the “Delete and Unassociate Restore Buttons.ps1” to delete the Squirrel Restore Columns from all of your SharePoint Sites.

Open the Powershell script in Visual Studio Code. “Delete and Unassociate Restore Buttons.ps1”
You will need to update the powershell script, with the Tenant Name of your SharePoint environment. On line 2, within the brackets replace “TENANTNAME” with your details. Make sure to save the file before continuing.
Now that you have saved the file, you are ready to run the script against your SharePoint Environment. Within Visual Studio Code, press F5 to start running the script.
Once it has completed deleting the Restore Column from all of your SharePoint Sites, the script will return “🎉 ✅ All Restore columns have been fully deleted from all sites!”.
To confirm that the Restore Column has been removed, you can visit a few sites and look at the document libraries to visually see the column no longer exists. Make sure to refresh your page to ensure its not cached.