Install VisualSP Classic using PowerShell

Applies to: VisualSP Classic
Print Friendly, PDF & Email
This article shows the process to install VisualSP Classic using PowerShell.

The recommended process for installing the VisualSP Help System is by downloading the Setup Package for your SharePoint version and using our easy-to-use Installation Wizard that is included in each Setup Package. PowerShell should only be used if absolutely necessary, or if you would like to make the VisualSP install part of an existing build process.

Download the 2016 PowerShell package. Download the 2013 PowerShell package. Download the 2010 Powershell package. You will also need to download the appropriate file. The screenshots shown below point out how the script works and how each step in the script is equivalent to the step in the install wizard.
  1. Place all files in a folder at C:\Installs\VisualSP as shown here:
  2. Update the visualsp.config.json file as needed. Use the screenshots here to see how values in the config file match with options in the VisualSP Installer GUI. Save the file when finished.
    1. Welcome screen. No options to set in config file.
    2. System Check screen. No options to set in config file.
    3. EULA. No options to set in config file.
    4. License screen. Paste the license key provided at the time of purchase as the value for the License property.
    5.  Select Web Applications screen. In the WebApplications array property, set the URL properties the URLs of the web applications to which you wish to deploy VisualSP.
    6. Automatically Activate the VisualSP Consumer Feature screen. Set the values of the ActivateConsumerOnExisting and ActivateConsumerOnNew to true or false as needed.
    7. Select Help Provider Site Hubs screen. Set the FarmHubSite property to the URL of the site collection that will serve as the VisualSP Farm Hub. To configure VisualSP Web Application Hubs, in the WebApplication property array, set the HubSite property to '' if the web application will not have its own hub site, or set the HubSite property to the URL of the site collection that will serve as the hub site.
    8. Upload Content screen. Add the Content property array if you wish to upload content during installation.
    9. Customize Help Tab Text screen. Set the values for the LocalizedHelpTab property array as desired for each language in your environment.
    10. Turn On Inline Help Settings screen. Set the value of the EnableInlineHelpByDefault to true or false as desired.
    11. Confirm Installation screen. No options to set in config file.
  3. Launch the SharePoint 2016 Management Shell as Administrator.
  4. Change to the c:\Installs\VisualSP directory where you placed all the installation files. cd C:\Installs\VisualSP\
  5. Add the PowerShell commandlets needed for installation by dot sourcing the Deploy-VisualSP script. . .\Deploy-VisualSP
  6. Install VisualSP with the following command: Deploy-VisualSP -ConfigFile C:\Installs\VisualSP\visualsp.config.json -TranscriptFilePath C:\Installs\VisualSP\visualsp.log

Updated on April 2, 2020

Related Articles