===== 🧩 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.

Deployment is managed entirely through the **Squirrel Portal** — no PowerShell scripts or manual SPFx package uploads are required.

**Key Features:**

  * ✅ One-Click Archive & Restore directly from SharePoint
  * 🔐 Secure authentication using the logged-in user's **Entra ID (formerly Azure AD)**
  * ⚙️ Fully portal-managed deployment — enable, scope, and exclude sites without leaving the browser
  * 🔔 Configurable restore confirmation thresholds to protect users from accidental large restores

----

==== 🖥️ Accessing the Button Deployment Settings ====

  - Log in to the **Squirrel Portal**.
  - Navigate to **Settings** and click the **Button Deployment** button.
  - The page contains two tabs: **Deployment** and **Restore Thresholds**.

----

==== ⚙️ Configure Deployment (Deployment Tab) ====

=== Enable Button Deployment ===

At the top of the Deployment tab you will find an **Enable Button Deployment** toggle.

  * **Enabled** — Squirrel will automatically deploy Archive/Restore buttons to document libraries across your SharePoint environment each night.
  * **Disabled** — No deployment will occur. Existing buttons already in place are unaffected.

Toggle this on to activate the service.

{{:software:squirrel:archive_restore_button_deployment.png?400|}}

=== Deployment Scope ===

Once deployment is enabled, choose one of two deployment scope options:

^ Option ^ Description ^
| **Deploy buttons to all Sites** | Archive/Restore buttons will be added to every site in your SharePoint environment (except any sites in the exclusion list). |
| **Deploy buttons only to Archive-enabled Sites** | Buttons will only be deployed to sites that have Squirrel archiving actively enabled. |

Select the option that matches your rollout preference. Changes are saved immediately.

> ℹ️ **Note:** The nightly deployment process automatically skips system libraries such as the Style Library and Site Assets regardless of the scope selected.

=== Site Exclusions ===

If there are specific SharePoint sites where you do **not** want Archive/Restore buttons deployed, add them to the exclusion list.

**To add a site:**

  - Enter the full SharePoint site URL in the input field (e.g. ''https://contoso.sharepoint.com/sites/Finance'').
  - Click **Add Site** (or press Enter).
  - The site will appear in the exclusion list and will be skipped during the next nightly deployment run.

**To remove a site:**

  - Locate the site in the exclusion list (use the search box to filter if needed).
  - Click the ✕ button next to the site URL.
  - The site will be removed from the exclusion list and will receive buttons on the next nightly run.

> 🛡️ **Note:** You must be authenticated in the portal to make changes. All changes are attributed to your logged-in account.

----


==== 💡 How the Nightly Deployment Works ====

Once deployment is enabled, Squirrel runs an automated process each night that:

  - Loops through all SharePoint sites in your tenant (or only archive-enabled sites, depending on your scope setting).
  - Adds the Archive/Restore column with buttons to eligible document libraries.
  - Skips system libraries (Style Library, Site Assets, etc.).
  - Skips any sites listed in the Site Exclusions list.

No manual intervention is required after initial configuration.

----

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