===== 🧩 Squirrel Archive and Restore Buttons for SharePoint =====

==== 🔍 Overview ====

The [[https://www.smikar.com/squirrel/|Squirrel]] Archive and Restore buttons integrate seamlessly with SharePoint, giving users a simple and secure way to **archive or restore files** with a single click — directly within the SharePoint interface.

This feature is powered by a lightweight **SPFx package** and a **custom Restore column**, which you can deploy to one or all SharePoint sites using provided PowerShell scripts.

**Key Features:**

- ✅ One-Click Archive & Restore directly from SharePoint
- 🔐 Secure authentication using the logged-in user’s **Entra ID (formerly Azure AD)**
- 🔁 Easy deployment via SPFx package and PowerShell automation
- ⚙️ Works across all sites or can be targeted to individual SharePoint sites

----

==== 🧱 Step 1: Upload the SPFx Package ====

| 📦 Obtain the SPFx package from SmiKar Software. | {{:software:squirrel:squirrel_restore_package.png?400}} |
| 🔧 Go to your SharePoint Admin Center (`https://TENANTNAME-admin.sharepoint.com`). | {{:software:squirrel:sharepoint_admin.png?400}} |
| 🧭 Navigate to **More Features > Apps > Open**. | {{:software:squirrel:sharepoint_apps.png?400}} |
| ⬆️ Click **Upload** and select the SPFx package. | {{:software:squirrel:sharepoint_app_upload.png?400}} |
| 🗂️ Choose to deploy to **all sites** or a specific collection. | {{:software:squirrel:enable_app.png?400}} |
| ✅ The app will now be enabled. | {{:software:squirrel:app_enabled.png?400}} |
| 🔍 Confirm the app shows as "Enabled" and "Available to all sites". | {{:software:squirrel:app_available.png?400}} |

----

==== 📌 Step 2: Deploy the Restore Column to All SharePoint Sites ====

SmiKar provides three PowerShell scripts:

- `Create and associate restore button.ps1` – Adds the Restore column to **all sites**
- `Add Button to Individual Site.ps1` – Adds the Restore column to a **single site**
- `Delete and Unassociate Restore Buttons.ps1` – Removes the Restore column from all sites

> 🛡️ **Note:** You must be a **Global Administrator** to run these scripts successfully.

**Deploying to All Sites:**

| 🛠️ Open `Create and associate restore button.ps1` in Visual Studio Code. | {{:software:squirrel:restore_buttons_powershell_scripts.png?200}} |
| ✏️ Update the tenant name on **line 2**. Replace `"TENANTNAME"` with your actual tenant name. | {{:software:squirrel:tenant_name_update.png?200}} |
| ▶️ Press **F5** to run the script. It will loop through your SharePoint sites and add the Restore column. | {{:software:squirrel:restore_column_running.png?200}} |
| ✅ Once completed, you will see: "🎉 ✅ SPFx Field Customizer installed and associated on all sites!" | {{:software:squirrel:restore_column_added_successfully.png?200}} |
| 🔍 Confirm the Restore column appears in any document library where a file has been archived. | {{:software:squirrel:restore_column_added.png?200}} |

----

==== 🔄 Step 3: Deploy to an Individual SharePoint Site ====

When a new SharePoint site is created, run this script to enable the Restore button for that site.

| 🛠️ Open `Add Button to Individual Site.ps1` in Visual Studio Code. | {{:software:squirrel:create_columns.png?200}} |
| ✏️ On **line 2**, update `"TENANTNAME"` and `"SITENAME"` or directly replace with your site’s URL. | {{:software:squirrel:indiviudal_site_powershell_site_update.png?200}} |
| ▶️ Press **F5** to run the script. | {{:software:squirrel:individual_site_running.png?200}} |
| ✅ Success message: "🎉 ✅ Restore button added successfully to Your New Site URL" | {{:software:squirrel:individual_site_powershell_successful.png?200}} |
| 🔍 Verify the column is present in the document library of the new site. | {{:software:squirrel:individual_site_restore_column_added.png?200}} |

----

==== 🧹 Step 4: Delete the Restore Column from All Sites ====

Use this when you need to **fully remove** the Squirrel Restore Column from all document libraries.

| 🗑️ Open `Delete and Unassociate Restore Buttons.ps1` in Visual Studio Code. | {{:software:squirrel:create_columns.png?200}} |
| ✏️ Update the tenant name on **line 2** with your tenant’s actual name. | {{:software:squirrel:tenant_name_update.png?200}} |
| ▶️ Press **F5** to run the script. | {{:software:squirrel:delete_column_running.png?200}} |
| ✅ Confirmation: "🎉 ✅ All Restore columns have been fully deleted from all sites!" | {{:software:squirrel:delete_all_sites_successful.png?200}} |
| 🔍 Visit a few SharePoint document libraries to confirm the column is no longer visible. Refresh the page if needed. | {{:software:squirrel:delete_column_site.png?200}} |

----

Need assistance with deployment or scripts? Contact [support@smikar.com](mailto:support@smikar.com) or your SmiKar representative for help.