Deploy VisualSP to SharePoint Online Via PowerShell

This is the process for deploying VisualSP Online for Site Collections to SharePoint Online via PowerShell.

Add visualsp-online.sppkg to SharePoint App Catalog

Note: If you do not wish to add VisualSP Online support to Modern UI pages, you can skip the steps in this section.

1. Download visualsp-online.sppkg
2. Visit your Office 365 SharePoint Admin Center
3. Go to Apps > App Catalog > Apps for SharePoint
   Note: You must be using the Classic view of this library; if it is displaying in Modern view, switch to Classic view.
4. Click Upload and select the visualsp-online.sppkg you downloaded in step 1
5. Check the box for Make this solution available to all sites in the organization and click Deploy
   

Note If you should receive an App Package Error Message stating, “Deployment failed,” as shown here, simply delete the .sppkg file and repeat steps 4 and 5 to redeploy.

Install VisualSP Online on all site collections

1. Download Set-VisualSPOnline.ps1 and save in your C:\temp folder
2. Launch SharePoint Online Management Shell and Run as Administrator
   Note: If you don’t have the SharePoint Online Management Shell installed on your computer, download it here
3. Change to the c:\temp directory
   cd c:\temp
4. Load the Set-VisualSPOnline cmdlet
   .\Set-VisualSPOnline.ps1
5. Run Connect-SPOService and add the tenant admin URL to the URL prompt

6. At the next C:\temp prompt run (Get-SPOSite -Limit All).Url | Set-VisualSPOnline -SubscriptionId "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" -ModernExperience -Target Online

7. Spot check a few site collections to confirm that the VisualSP Online help tab is visible in them

Install VisualSP Online on a single site collection

1. Download Set-VisualSPOnline.ps1 and save in your C:\temp folder
2. Launch SharePoint Online Management Shell and Run as Administrator
   Note: If you don’t have the SharePoint Online Management Shell installed on your computer, you can download it here.
3. Change to the c:\temp directory
   cd c:\temp
4. Load the Set-VisualSPOnline cmdlet
   .\Set-VisualSPOnline.ps1
5. Associate VisualSP Online with the site collection
   Set-VisualSPOnline -SiteCollectionUrl "https://tenant.sharepoint.com/sites/examplesite" -SubscriptionId "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" -ModernExperience -Target Online

6. Visit the site collection and confirm that the VisualSP Online help tab is visible in the site collection

Uninstall VisualSP Online from all site collections

1. Download Remove-VisualSPOnline.ps1 and save in your C:\temp folder
2. Launch SharePoint Online Management Shell and Run as Administrator
   Note: If you don’t have the SharePoint Online Management Shell installed on your computer, you can download it here
3. Change to the c:\temp directory
   cd c:\temp
4. Load the Remove-VisualSPOnline cmdlet
   .\Remove-VisualSPOnline.ps1
5. Run the following command to remove VisualSP Online from all site collections
   Connect-SPOService "https://tenant-admin.sharepoint.com"  (Get-SPOSite -Limit All).Url | Remove-VisualSPOnline

Uninstall VisualSP Online from a single site collection

1. Download Remove-VisualSPOnline.ps1 and save in your C:\temp folder
2. Launch SharePoint Online Management Shell and Run as Administrator
   Note: If you don’t have the SharePoint Online Management Shell installed on your computer, you can download it here
3. Change to the c:\temp directory
   cd c:\temp
4. Run the following command to remove VisualSP Online from a single site collection
   .\Remove-VisualSPOnline -SiteCollectionUrl "https://tenant.sharepoint.com/sites/examplesite"