Differences

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

--- software:squirrel:restore_buttons [2025/03/26 13:24] – support@smikar.com
+++ software:squirrel:restore_buttons [2026/03/28 11:49] (current) – support@smikar.com
@@ Line 5: / Line 5: @@
 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.
+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
+  * ✅ One-Click Archive & Restore directly from SharePoint
-- 🔐 Secure authentication using the logged-in user’s **Entra ID (formerly Azure AD)**
+  * 🔐 Secure authentication using the logged-in user's **Entra ID (formerly Azure AD)**
-- 🔁 Easy deployment via SPFx package and PowerShell automation
+  * ⚙️ Fully portal-managed deployment — enable, scope, and exclude sites without leaving the browser
-- ⚙️ Works across all sites or can be targeted to individual SharePoint sites
+  * 🔔 Configurable restore confirmation thresholds to protect users from accidental large restores
 ----
-==== 🧱 Step 1: Upload the SPFx Package ====
+==== 🖥️ Accessing the Button Deployment Settings ====
-| 📦 Obtain the SPFx package from SmiKar Software. | {{:software:squirrel:squirrel_restore_package.png?400}} |
+  - Log in to the **Squirrel Portal**.
-| 🔧 Go to your SharePoint Admin Center (`https://TENANTNAME-admin.sharepoint.com`). | {{:software:squirrel:sharepoint_admin.png?400}} |
+  - Navigate to **Settings** and click the **Button Deployment** button.
-| 🧭 Navigate to **More Features > Apps > Open**. | {{:software:squirrel:sharepoint_apps.png?400}} |
+  - The page contains two tabs: **Deployment** and **Restore Thresholds**.
-| ⬆️ 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 ====
+==== ⚙️ Configure Deployment (Deployment Tab) ====
-SmiKar provides three PowerShell scripts:
+=== Enable Button Deployment ===
-- `Create and associate restore button.ps1` – Adds the Restore column to **all sites**
+At the top of the Deployment tab you will find an **Enable Button Deployment** toggle.
-- `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.
+  * **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.
-**Deploying to All Sites:**
+Toggle this on to activate the service.
-| 🛠️ Open `Create and associate restore button.ps1` in Visual Studio Code. | {{:software:squirrel:restore_buttons_powershell_scripts.png?200}} |
+{{:software:squirrel:archive_restore_button_deployment.png?400|}}
-| ✏️ 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}} |
-----
+=== Deployment Scope ===
-==== 🔄 Step 3: Deploy to an Individual SharePoint Site ====
+Once deployment is enabled, choose one of two deployment scope options:
-When a new SharePoint site is created, run this script to enable the Restore button for that site.
+^ 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. |
-| 🛠️ Open `Add Button to Individual Site.ps1` in Visual Studio Code. | {{:software:squirrel:create_columns.png?200}} |
+Select the option that matches your rollout preference. Changes are saved immediately.
-| ✏️ 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}} |
-----
+> ℹ️ **Note:** The nightly deployment process automatically skips system libraries such as the Style Library and Site Assets regardless of the scope selected.
-==== 🧹 Step 4: Delete the Restore Column from All Sites ====
+=== Site Exclusions ===
-Use this when you need to **fully remove** the Squirrel Restore Column from all document libraries.
+If there are specific SharePoint sites where you do **not** want Archive/Restore buttons deployed, add them to the exclusion list.
-| 🗑️ Open `Delete and Unassociate Restore Buttons.ps1` in Visual Studio Code. | {{:software:squirrel:create_columns.png?200}} |
+**To add a site:**
-| ✏️ 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}} |
+  - Enter the full SharePoint site URL in the input field (e.g. ''https://contoso.sharepoint.com/sites/Finance'').
-| ✅ Confirmation: "🎉 ✅ All Restore columns have been fully deleted from all sites!" | {{:software:squirrel:delete_all_sites_successful.png?200}} |
+  - Click **Add Site** (or press Enter).
-| 🔍 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}} |
+  - 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.
 ----
-Need assistance with deployment or scripts? Contact [support@smikar.com](mailto:support@smikar.com) or your SmiKar representative for help.
+==== 💡 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.