Overview

Adding QuickHelp to the App Catalog

Adding QuickHelp to a Site Collection

Adding QuickHelp to a Site Page


Overview


Using APIs and BrainStorm-provided SharePoint packages (attached below), you can integrate QuickHelp with your SharePoint to provide another access point to help your end users help themselves. This support document details the steps needed to complete the SharePoint integration.


Requirements

  1. SharePoint Online
    • Classic Mode for the App Catalog section only
  2. App Catalog site collection
  3. Site collection administrator (for the App Catalog)
  4. Full Control rights (for sites where web parts will be added)
  5. Web Parts (.sppkg file(s)) for the three different SharePoint Integrations (attached below)
    • QuickHelp Events
    • QuickHelp Search
    • QuickHelp Skill Paths
  6. Authorization KeyQuickHelp Admin Portal > Settings > Configure > Customer API Key
  7. Subscription Key – Click hereto go to the Azure API portal
    • Click here for more information on setting up an account on the BrainStorm API Portal



Adding QuickHelp to the App Catalog

  1. Go to the SharePoint App Catalog
    1. Similar to https://{{yourURL}}.sharepoint.com/sites/appcatalog
  2. If you are not currently in classic SharePoint, click Return to classic SharePoint
  3. Click Apps for SharePoint
  4. Drag and drop the desired .sppkg file to add it to the list of available apps
  5. SharePoint will ask you to trust and deploy the web part you are adding
    1. Check Make this solution available to all sites in the organization if desired. If you check this box, skip the Adding QuickHelp to a Site Collection section
  6. Click Deploy
  7. Repeat for any additional .sppkg files


Adding QuickHelp to a Site Collection

If you did not previously make the web part available to all sites, please use the following steps to add the app to individual site collections.

  1. Go to the desired Site Collection
  2. Click on the gear in the upper right-hand corner
  3. Select Add an app
  4. Select From Your Organization
  5. Click the web part to add (use Find an app if necessary)
  6. You will be redirected to the Site Contents page
  7. Once the app is loaded (no longer grayed out), it is ready to use


Adding QuickHelp to a Site Page

  1. Go to the desired site page
  2. Click Edit
  3. Add a new section for the Web Part, if needed
  4. Click Add a new web part… + icon to add the web part to any existing section (supported section layouts are One Column or Two Columns)
  5. Search QuickHelp to see all available web parts – click the web part to be added to the page
  6. Once added, click the Edit Web Part icon
  7. Enter the correct Authorization Key and Subscription Key
    1. Authorization KeyQuickHelp Admin Portal > Settings > Configure > Customer API Key
    2. Subscription Key – Click here to go to the Azure API portal
  8. Once both keys are validated, there may be additional fields to populated – complete as required
    1. You can edit the Title of the Web Part as desired.
    2. A slider will be presented to choose the number of each item to display - number of Skill Paths, Events, Search Results.
    3. The Skill Paths web part will require the selection of the number of Skill Paths to display
  9. Click Publish