1. Home
  2. Customization
  3. Customize VisualSP On-Premises
  4. Enable a Site Collection to Provide Help Items

Enable a Site Collection to Provide Help Items

Applies to: VisualSP On-Premises
Print Friendly, PDF & Email

Overview

VisualSP Help Items can be provided to a site collection from any of three different locations:

  • The VisualSP Farm Hub
  • A VisualSP Web Application Hub
  • The site collection itself

If VisualSP was installed following the recommended settings, then the VisualSP Farm Hub will be set up to provide its Help Items throughout the SharePoint farm. If you are setting up a new VisualSP Farm Hub, a new VisualSP Web Application Hub, or you want a site to show content specific to that particular site collection, then you will need to follow the steps in this section to enable it.

Note for VisualSP Express users: The following process must be performed on each site collection since it does not support VisualSP Hub Sites and all Help Items are managed within each site collection level.

Just as the VisualSP Help Consumer Feature allows a site collection to display Help Items, the VisualSP Help Provider Feature allows a site collection to manage Help Items and to provide them to VisualSP Consumers. The site collection administrator must first activate the VisualSP Help Provider Feature to be able to administer the Help content at the site collection level.

Note: When VisualSP is installed, it is typically deployed to all Web Applications in the SharePoint Farm. If you do not see the VisualSP Help Provider Feature in the Site Collection Features page, your SharePoint Administrator will need to deploy VisualSP to the web application.

When this feature is activated, it will create a VisualSP Help Items list in the site collection. The Site Settings page will show links to Manage VisualSP Help Provider Settings and Manage VisualSP Help Items.

There are several options on the Manage VisualSP Help Provider Settings page. Most of these are considered to be “Advanced Functionality” and will be covered in a later section of this document. We will look at enabling and disabling the providing of inline help in this section since it relevant to the following section on adding and editing Help Items.

Enable and Disable Providing Inline Help

Inline help can be turned on and off at any of four levels:

  • The VisualSP Provider Settings in the VisualSP Farm Hub
  • The VisualSP Provider Settings in each VisualSP Web Application Hub
  • The VisualSP Consumer Settings in each Site Collection
  • At the page level by each user

The last two are covered in the preceding section. We will look at the first two options here.

Enable or Disable Providing of Inline Help from the VisualSP Farm Hub

To enable or disable Inline Help at the VisualSP Farm Hub, visit the Site Settings page of the VisualSP Farm Hub site and click Manage VisualSP Help Provider Settings in the VisualSP Settings section. Checking the box for Enable Inline Help for Provider Hub Scope will allow Inline Help to be enabled or disabled at the Web Application level. If this box is unchecked, Inline Help cannot be enabled anywhere in the Farm.

Enable or Disable Providing of Inline Help from a VisualSP Web Application Hub

To enable or disable Inline Help for a particular web application, navigate to the site collection that is serving as the VisualSP Web Application Hub for a particular web application. This may not necessarily be the root level site for the Web Application. visit the Site Settings page of the VisualSP Web Application Hub site and click Manage VisualSP Help Provider Settings in the VisualSP Settings section. Checking or unchecking the box for Enable Inline Help for Provider Hub Scope will allow Inline Help to be enabled or disabled at the site collection level for each site collection in this web application. If this box is unchecked, Inline Help cannot be enabled by any user in this particular web application.

Updated on January 18, 2018

Related Articles