1. Home
  2. Installation & Configuration
  3. Install VisualSP
  4. Deploy VisualSP to SharePoint On-Premises via PowerShell

Deploy VisualSP to SharePoint On-Premises via PowerShell

Applies to: VisualSP
Print Friendly, PDF & Email

Activating VisualSP throughout a SharePoint farm is a three-step process:

  • Deploy to web applications
  • Enter Subscription ID
  • Activate the feature on the site collections

To deploy to all web applications and activate in all site collections in the SharePoint farm:

  1. Download the following 2 files and save in C:\temp\ on the SharePoint server:
    https://sharepoint-videos.s3.amazonaws.com/VisualSPOnline/On-Prem/Deploy-SPSolutions.ps1

    SharePoint 2019 / Subscription Edition - SP 2019/SE WSP

    SharePoint 2016 - SP 2016 WSP

  2. Launch SharePoint Management Shell as Administrator.
  3. Change to the c:\temp directory cd c:\temp
  4. Add and deploy the SharePoint solution package to the farm: .\Deploy-SPSolutions Deploy-SPSolutions c:\temp\VisualSPOnlineHelpApp.OnPrem.wsp -upgradeexisting
  5. Launch SharePoint Central Administration and go to General Application Settings > VisualSP Online > Set Subscription Enter your VisualSP Online Subscription ID and click the OK button.
    Note: The subscription ID will be cached for 15 minutes on each web application. If you need this to take place immediately, perform an IISRESET.
  6. Activate VisualSP Online in all site collections:
    Get-SPSite -Limit All | % { Enable-SPFeature -Identity "VisualSPOnlineHelpApp.OnPrem.Consumer" -Confirm:$false -Url $_.Url -ErrorAction SilentlyContinue }
    Note: While the feature must be activated in all existing site collections, it will be automatically activated in new site collections that are created in the web applications to which VisualSP Online has been deployed.

To deploy to select web applications and activate in select site collections:

  1. Download the following 2 files and save in C:\temp\ on the SharePoint server:
    https://sharepoint-videos.s3.amazonaws.com/VisualSPOnline/On-Prem/Deploy-SPSolutions.ps1

    SharePoint 2019 / Subscription Edition - SP 2019/SE WSP

    SharePoint 2016 - SP 2016 WSP

  2. Launch SharePoint Management Shell as Administrator.
  3. Change to the c:\temp directory cd c:\temp
  4. Add the SharePoint solution package to the farm:
    Add-SPSolution -LiteralPath c:\temp\VisualSPOnlineHelpApp.OnPrem.wsp
    Note: If an older version has been previously installed, use the following instead: update-spsolution -LiteralPath c:\temp\VisualSPOnlineHelpApp.OnPrem.wsp -identity VisualSPOnlineHelpApp.OnPrem.wsp -GACdeployment
  5. Launch SharePoint Central Administration and go to General Application Settings > VisualSP Online > Set Subscription
  6. Enter your VisualSP Online Subscription ID and click the OK button.
    Note: The subscription ID will be cached for 15 minutes on each web application. If you need this to take place immediately, perform an IISRESET.
  7. In Central Administration, go to System Settings > Farm Management > Manage Farm Solutions.
  8. Click onprem.wsp.
  9. Click Deploy Solution.
  10. Select the Web application to which you wish to deploy the solution and click OK.
  11. Repeat the previous step for each web application to which you wish to deploy VisualSP Online.
  12. In each site collection in which you wish to activate VisualSP Online, go to Site Actions > Site Settings. In the Site Collection Administration section, click Site collection features.
  13. Scroll down to find the VisualSP Online Consumer Feature and click the Activate button for the feature.
  14. Repeat the previous step for each site collection on which you wish to activate VisualSP Online.
    Note: While the feature must be activated in any existing site collections, it will be automatically activated in new site collections that are created in the web applications to which VisualSP Online has been deployed.

Modern SharePoint Support

If your SharePoint version is new enough to include an App Catalog you must also perform these steps:

  1. Download the SPFx application extension from this link on our support site.
  2. Upload the application extension to your on-prem app catalog(s).

Connectivity Setup

Note: VisualSP does not require internet access from your SharePoint servers. However, it does require client-side access to the following domains for anyone trying to access the help tab.

You should explicitly allow access to the following URLS on your firewalls and other network security layers:

  • visualsponline.azurewebsites.net
  • media.contextall.com
  • static.contextall.com
  • api.contextall.com

Uninstall VisualSP

  1. Launch SharePoint Management Shell as Administrator.
  2. Disable the VisualSP Online Consumer Feature in all site collections by executing the following:
    Get-SPSite -Limit All | % { Disable-SPFeature -Identity "VisualSPOnlineHelpApp.OnPrem.Consumer" -Confirm:$false -Url $_.Url -ErrorAction SilentlyContinue }
  3. Retract the solution files by executing: Uninstall-SPSolution -Identity visualsponlinehelpapp.onprem.wsp
  4. Delete the solution from the farm by executing: Remove-SPSolution -Identity visualsponlinehelpapp.onprem.wsp
Updated on January 3, 2024

Related Articles