Installation

Admin  This guide is for SharePoint or Global Administrators. End users do not need to perform these steps.

Prerequisites

Before you begin, confirm you have:

  • A Microsoft 365 tenant with SharePoint Online
  • SharePoint Administrator or Global Administrator role
  • Access to the SharePoint Admin Center (to approve API permissions)
  • The .sppkg package file from your Tenantrix account

Step 1 — Upload to the App Catalog

You can deploy to either a Tenant App Catalog (available to all sites) or a Site Collection App Catalog (scoped to one site).

  1. Go to the SharePoint Admin Center → More features → Apps → App Catalog.
  2. If prompted, create the app catalog (this is a one-time setup).
  3. Navigate to Apps for SharePoint.
  4. Click Upload and select the teambook-connected.sppkg file.
  5. When prompted, choose “Make this solution available to all sites” → click Deploy.

Site Collection App Catalog

  1. Enable the App Catalog for the target site (Site Settings → Site Collection Features → Site Collection App Catalog).
  2. Navigate to Site Contents → Apps for SharePoint.
  3. Upload the .sppkg file and click Deploy.

Step 2 — Approve API permissions

TeamBook Employee Directory requires Microsoft Graph permissions to read user and presence data. These must be approved by a Global Administrator or SharePoint Administrator.

  1. Open the SharePoint Admin Center → Advanced → API access.
  2. You will see pending permission requests for:
    • User.Read.All — read all user profiles
    • People.Read.All — read people data and relevance
    • Presence.Read.All — read Teams presence status
  3. Select each request and click Approve.
Important: The web part will load but show incomplete or no data if permissions are not approved. Approving these permissions applies to the whole tenant.

Step 3 — Add the web part to a page

  1. Navigate to the SharePoint page where you want to embed the people hub (or create a new page).
  2. Edit the page (click the pencil icon or press E).
  3. Click the + button to add a new web part section.
  4. Search for TeamBook Employee Directory and click it to insert the web part.
  5. The web part will load with default settings.
  6. Publish the page when ready.

Step 4 — Initial configuration

After adding the web part to the page, configure it via the property pane (click the web part, then click the pencil/settings icon on the left).

At minimum, set:

  • Web part title — the label shown at the top of the people hub
  • Default view — which tab opens by default (Directory, Org Chart, Departments, or Locations)
  • Results per page — how many people to show per page

See the full Configuration reference for all available options.

Updating to a newer version

To update TeamBook Employee Directory when a new release is available:

  1. Download the new .sppkg from your Tenantrix account.
  2. Upload it to the App Catalog — it will replace the existing version automatically.
  3. If new Graph permissions are requested, approve them in API access as in Step 2.
  4. The update is applied to all pages using the web part — no page edits required.

Uninstalling

  1. Remove the web part from all pages where it is used.
  2. Go to the App Catalog → Apps for SharePoint.
  3. Select teambook-connected.sppkg and click Delete.
  4. Optionally, revoke the Graph permissions in the API access panel.