1. Home
  2. Installation & Configuration
  3. VisualSP SharePoint Web Part

VisualSP SharePoint Web Part

Applies to: VisualSP
Print Friendly, PDF & Email

You can now supercharge your ability to present the right help items to your users at the right time with the VisualSP SharePoint Web Part. This web part can be added to modern pages in SharePoint Online. This web part exposes 100s of help and training content items in-context to the user within their SharePoint interface. With the VisualSP web part inserted onto your modern SharePoint Online page, you have the power to display help items within a site instead of solely through the VisualSP Help panel. When combined with the VisualSP Term Store and custom term sets, this new web part gives you new options when it comes to displaying help items to your users.

Watch this demo for an overview of what you can do with the VisualSP web part.

Installation to the SharePoint App Catalog

The VisualSP web part can be downloaded from within the Manage My Subscription page, or with the link below. Once downloaded, you will need to install the web part to your SharePoint App Catalog at the root, which will make it available throughout your SharePoint Online environment.

Note

You can also install it into an individual SharePoint Online site collection app catalog, but doing so will limit the web part to that one site collection.

  1. Click here to download the VisualSP web part
  2. Visit your Microsoft 365 SharePoint Admin Center
  3. Go to Apps > App Catalog

If you already have an App Catalog created, the App Catalog link will open up your App Catalog site collection. It will look like this:

If you don't already have an app catalog, here are instructions for creating one.

  1. Click on the Apps for SharePoint link in the quick launch.

Note: You must be using the Classic view of this library; if it is displaying in Modern view, switch to Classic view.

  1. Click Upload and select the VisualSP web part you downloaded in step 1.
  2. Check the box for Make this solution available to all sites in the organization and click the Deploy button:

Check in the file:

A successful installation will show no errors:

Alert

If you receive an App Package Error Message stating, "Deployment failed," simply delete the visualsp-webpart.sppkg file and repeat steps 5 and 6 to redeploy.

Inserting the web part into a SharePoint Modern page

Create a new modern page and click the symbol to add a web part and search for visualsp.

Click the VisualSP icon to install the web part to your page. After loading, it will look like this:

To edit the web part, click the pencil icon:

This will open the settings panel:

Alert

If the web part doesn't display any help items, check that the subscription ID is properly filled in. It should have picked up the subscription ID from the browser extension, but if you don't have the browser extension installed, just add your subscription ID to the field. You can find your subscription ID on your Manage My Subscription page.

Settings Panel Configuration

This toggles on or off the search box from appearing in the web part.

Refiners by

Your options in the Refiners by dropdown are the main column headings you see in the Help Item gallery. You will also see any term sets you have setup in the VisualSP Term Store.

Show refiners as pills

Toggling this to 'on' will display the refiners as pills:

Toggling this to 'off' will display the refiners as a drop down:

Sort by and Filter

This web part can be sorted and filtered by various metadata fields, as configured in the Help editor and the VisualSP Term Store.

Layout

Here you have the option to toggle off the web part title, and to control the layout.

Updated on June 23, 2021

Related Articles