Product / Knowledge Base / 1. Getting Started

1. Getting Started

User & Administration Guide — Version 1.0.0.25

Guide summary

Install SearchHub 365 on its own SharePoint subsite, publish the page, and finish setup.

On this page

Requirements

  • Microsoft 365 with SharePoint Online. SharePoint Server on-premises is not supported.
  • A current browser: Microsoft Edge, Google Chrome, Mozilla Firefox, or Safari.
  • Permission to deploy the package to the tenant app catalog.
  • Site owner permission on the subsite where the page will live.
  • Microsoft Graph Mail.Send approval before people can email search results. The app does not read the mailbox.

Deploy the app

The package is one SharePoint Framework web part. It runs on a modern SharePoint page, as a full-page app, and in Microsoft Teams as a channel tab or a personal app.

  • Install SearchHub 365 on its own SharePoint subsite so the settings lists stay separate from the parent site.
  • Create or edit a modern page, add the web part, and publish the page. In page edit mode the app asks you to publish before it will run.
  • People open the app from that SharePoint URL.

Add it to Microsoft Teams

  • Deploy searchhub-365.sppkg first, then sync TeamsSPFxApp.zip.
  • A channel tab uses the SharePoint site behind that team. Finish setup on that site before using the tab.
  • In Teams the navigation starts closed and opens from the menu as a drawer.

First-time setup

A site owner runs setup once. Setup creates three hidden lists:

  • SH365Settings stores appearance, language, app admins, search settings, and email settings.
  • SH365Scopes stores one row per site or hub: URL, title, kind, and whether it is enabled.
  • SH365Queries stores the query term, area, result count, latency, zero-result flag, clicked rank, and a correlation id.

Result titles, paths, and document contents are not written to these lists. Running setup again is safe. An existing site picks up a new column on the next read.

Setup page with the three SearchHub 365 lists marked Ready
Setup creates SH365Settings, SH365Scopes, and SH365Queries.

Allow items from this list to appear in search results is off by default. It matches SharePoint’s list setting for these three lists.

Additional notes

Trial and subscription

A 14-day trial starts on first use of the site. After the trial, SearchHub 365 is $499 per year for unlimited users in the tenant. Checkout and the billing portal run on the Chronodat subscription service.

A signed license key remains a valid way to open the app. A site key must match this site. A tenant key must match this tenant.