Differences

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

--- software:squirrel:restore_buttons [2025/02/11 09:46] – support@smikar.com
+++ software:squirrel:restore_buttons [2025/03/26 13:24] (current) – support@smikar.com
@@ Line 1: / Line 1: @@
-**Overview: [[https://www.smikar.com/squirrel/|Squirrel]] 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.
+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.
-  * 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)**
+- 🔁 Easy deployment via SPFx package and PowerShell automation
+- ⚙️ Works across all sites or can be targeted to individual SharePoint sites
-**Setting Up Restore Buttons in SharePoint**
+----
-Step 1: Upload the SPFx Package
+==== 🧱 Step 1: Upload the SPFx Package ====
-| Obtain the SPFx package provided by SmiKar Software. | {{:software:squirrel:squirrel_restore_package.png?400 }}|
+| 📦 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}}  |
+| 🔧 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}} |
+| 🧭 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}}  |
+| ⬆️ 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}} |
+| 🗂️ Choose to deploy to **all sites** or a specific collection. | {{:software:squirrel:enable_app.png?400}} |
-| The app has now been enabled | {{:software:squirrel:app_enabled.png?400}} |
+| ✅ The app will now be 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}}|
+| 🔍 Confirm the app shows as "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;
+==== 📌 Step 2: Deploy the Restore Column to All SharePoint Sites ====
-  * 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
+SmiKar provides three PowerShell scripts:
-**Step 2: Create and Deploy the Restore Column to all your SharePoint Sites.**
+- `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
-We will run the "__create and associate restore button.ps1__" to add the Squirrel Restore Column to all of your current SharePoint Sites.
+> 🛡️ **Note:** You must be a **Global Administrator** to run these scripts successfully.
+**Deploying to All Sites:**
-| Obtain the powershell script provided by SmiKar Software.   "Create and associate restore button.ps1| {{:software:squirrel:restore_buttons_powershell_scripts.png?200 }}|
+| 🛠️ Open `Create and associate restore button.ps1` in Visual Studio Code. | {{:software:squirrel:restore_buttons_powershell_scripts.png?200}} |
-| Open the Powershell script in Visual Studio Code |   {{:software:squirrel:create_columns.png?200 }} |
+| ✏️ Update the tenant name on **line 2**. Replace `"TENANTNAME"` with your actual tenant name. | {{:software:squirrel:tenant_name_update.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 |}}  |
+| ▶️ 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}} |
-| 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 will see: "🎉 ✅ SPFx Field Customizer installed and associated on all sites!" | {{:software:squirrel:restore_column_added_successfully.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 |}} |
+| 🔍 Confirm the Restore column appears in any document library where a file has been archived. | {{:software:squirrel:restore_column_added.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.**
+----
-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.
+==== 🔄 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 the Powershell script in Visual Studio Code. ""Add Button to Individual Site.ps1" |   {{:software:squirrel:create_columns.png?200 }} |
+| 🛠️ Open `Add Button to Individual Site.ps1` 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" 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 |}}  |
+| ✏️ On **line 2**, update `"TENANTNAME"` and `"SITENAME"` or directly replace with your site’s URL. | {{: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 |}}|
+| ▶️ Press **F5** to run 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 |}}|
+| ✅ Success message: "🎉 ✅ 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 |}} |
+| 🔍 Verify the column is present in the document library of the new site. | {{:software:squirrel:individual_site_restore_column_added.png?200}} |
+----
-**Step 4: Deleting the Restore Column from all of your SharePoint Sites.**
+==== 🧹 Step 4: Delete the Restore Column from All Sites ====
-We will run the "__Delete and Unassociate Restore Buttons.ps1__" to delete the Squirrel Restore Columns from all of your SharePoint 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.
-| Open the Powershell script in Visual Studio Code. "Delete and Unassociate Restore Buttons.ps1" |   {{: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.  | {{:software:squirrel:delete_column_running.png?200 |}} |
-| 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 |}} |