Differences

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

--- software:squirrel:restore_buttons [2025/03/12 18:14] – support@smikar.com
+++ software:squirrel:restore_buttons [2026/03/28 11:49] (current) – support@smikar.com
@@ Line 1: / Line 1: @@
-**Overview: [[https://www.smikar.com/squirrel/|Squirrel]] Archive and Restore Buttons for SharePoint**
+===== 🧩 Squirrel Archive and Restore Buttons for SharePoint =====
-The [[https://www.smikar.com/squirrel-data-rehydration/|Squirrel Restore]] and [[https://www.smikar.com/squirrel-self-service-archiving/|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.
+==== 🔍 Overview ====
-Key Features:
+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.
-  * One-Click Restore and Archive: Quickly restore or archive files directly from the SharePoint UI.
+Deployment is managed entirely through the **Squirrel Portal** — no PowerShell scripts or manual SPFx package uploads are required.
-  * 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.
+**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
-**Setting Up Restore Buttons in SharePoint**
+----
-Step 1: Upload the SPFx Package
+==== 🖥️ Accessing the Button Deployment Settings ====
-| Obtain the SPFx package provided by 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}}  |
-| Optional. Choose All sites to deploy the package to all of your sharepoint sites / or select |{{:software:squirrel:enable_app.png?400}} |
-| The app has now been enabled | {{:software:squirrel:app_enabled.png?400}} |
-| Confirm the App shows that the status is enabled and available to all sites. |{{:software:squirrel:app_available.png?400}}|
-**Add the Restore Column to your SharePoint Sites.**
+----
-SmiKar will provide you with three powershell scripts. These are;
+==== ⚙️ Configure Deployment (Deployment Tab) ====
-  * 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
+=== Enable Button Deployment ===
-**Step 2: Create and Deploy the Restore Column to all your SharePoint Sites.**
+At the top of the Deployment tab you will find an **Enable Button Deployment** toggle.
-We will run the "__create and associate restore button.ps1__" to add the Squirrel Restore Column to all of your current SharePoint Sites.
+  * **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.
-| Obtain the powershell script provided by SmiKar Software.   "Create and associate restore button.ps1| {{:software:squirrel:restore_buttons_powershell_scripts.png?200 }}|
+{{:software:squirrel:archive_restore_button_deployment.png?400|}}
-| Open the Powershell script in Visual Studio Code |   {{:software:squirrel:create_columns.png?200 }} |
-| 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. |{{:software:squirrel:tenant_name_update.png?200 |}}  |
-| 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.  |{{:software:squirrel:restore_column_running.png?200 |}} |
-| Once completed, you should see the script say "🎉 ✅ SPFx Field Customizer installed and associated on all sites!"  |{{:software:squirrel:restore_column_added_successfully.png?200 |}} |
-| 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. | {{:software:squirrel:restore_column_added.png?200 |}} |
- **Step 3: Adding the Restore Column to an individual SharePoint Site.**
+=== Deployment Scope ===
-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.
+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. |
-| Open the Powershell script in Visual Studio Code. ""Add Button to Individual Site.ps1" |   {{:software:squirrel:create_columns.png?200 }} |
+Select the option that matches your rollout preference. Changes are saved immediately.
-| 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. |{{:software:squirrel:indiviudal_site_powershell_site_update.png?200 |}}  |
-| 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.  | {{:software:squirrel:individual_site_running.png?200 |}}|
-| Once it has completed, the script will respond with "🎉 ✅ Restore button added successfully to Your New Site URL"  | {{:software:squirrel:individual_site_powershell_successful.png?200 |}}|
-| 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. |{{: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: Deleting the Restore Column from all of your SharePoint Sites.**
+=== Site Exclusions ===
-We will run the "__Delete and Unassociate Restore Buttons.ps1__" to delete the Squirrel Restore Columns from all of your SharePoint Sites.
+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:**
-| Open the Powershell script in Visual Studio Code. "Delete and Unassociate Restore Buttons.ps1" |   {{:software:squirrel:create_columns.png?200 }} |
+  - Enter the full SharePoint site URL in the input field (e.g. ''https://contoso.sharepoint.com/sites/Finance'').
-| 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. |{{:software:squirrel:tenant_name_update.png?200 |}}  |
+  - Click **Add Site** (or press Enter).
-| 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.  | {{:software:squirrel:delete_column_running.png?200 |}} |
+  - The site will appear in the exclusion list and will be skipped during the next nightly deployment run.
-| 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!".  | {{:software:squirrel:delete_all_sites_successful.png?200 |}} |
-| 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.  | {{:software:squirrel:delete_column_site.png?200 |}} |
+**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.