Navigation extensions

This section describes the Semaphore Navigation extensions. These extensions can be used on any site to allow users to select concepts from the model. Optionally, a click through can display documents tagged with those concepts on a search results page or topic page.

Semaphore A-To-Z Menu extension

This extension can be used in any site in your SPO tenant. It displays an A to Z list of concepts within a properly configured model (a model that has concepts flagged with the attribute A-Z Entry). This allows users to view search results tagged with specific concepts.

Configure the Semaphore A-To-Z Menu extension

The Semaphore A-To-Z Menu extension can be deployed either tenant wide or in individual sites. The configuration for both options are outlined in this section.

Tenant wide configuration

1. In your SPO tenant app catalog site, click on Site contents then click Tenant Wide Extensions.

2. If present, select the SemaphoreAToZMenu list item (if not present see instructions below).

3. In the ribbon, click ITEMS and then click Edit Item.

4. update these values in the Component Properties.

   Copy

   {
     "cloudUrl":"<Semaphore Cloud URL>",
     "apiKey":"<Semaphore Cloud API Key>",
     "sesEndpoint":"<Semaphore Cloud URL>/svc/<SES Service ID>/SES/",
     "modelName":"<SES Model Name>",
     "facetName":"<**Optional** Model Facet Name for Menu Items>",
     "linkUrl":"<SPO Link for Menu Items>",
     "urlLabelParameter":"<URL Parameter Name for Topic Page Title Web Part>",
     "urlIdParameter>":"<URL Parameter Name for Search Web Parts>",
     "sidePanelTitle":"<Text to Display in Side Panel Menu>",
     "searchBoxText":"<Search Box Placeholder Text>"
   }
   

5. Click Save and navigate to a site in the tenant to verify that the menu appears.

If the SemaphoreAtoZmenu tenant wide extension does NOT exist it can be added as follows:

1. In your SPO tenant app catalog site, click on Site contents then click Tenant Wide Extensions.
2. Click the new item link at the top of the list or select ITEMS then New Item in the ribbon. If present, select the SemaphoreAToZMenu list item, if not present see below.
3. Add these values for the new item:

5. Click Save and navigate to a site in the tenant to verify that the menu appears.

Individual site configuration

To configure individual sites:

1. In the site where you want to deploy the extension, click the settings icon and then click Add an app.

2. Click on the Semaphore SPO Components app and wait for the installation to finish.

3. Open the SharePoint Online Management Shell and run these commands (if required, use "connect-pnpOnline" to first connect PowerShell to your SharePoint Online subscription):

   Copy

   Add-PnPApplicationCustomizer -Title 'SemaphoreAToZMenu' -ClientSideComponentId 'af8eb48b-7d2d-4497-b5d3-aa4968bce30a' -ClientSideComponentProperties "{`"cloudUrl`":`"<Semaphore Cloud URL>`",`"apiKey`":`"<Semaphore Cloud API Key>`",`"sesEndpoint`":`"<Semaphore Cloud URL>/svc/<SES Service Id>/SES/`",`"modelName`":`"<SES Model Name>`",`"facetName`":`"<**Optional** Model Facet Name for Menu Items>`",`"linkUrl`":`"<SPO Link for Menu Items>`",`"urlLabelParameter`":`"<URL Parameter Name for Topic Page Title Web Part>`",`"urlIdParameter`":`"<URL Parameter Name for Search Web Parts>`",`"sidePanelTitle`":`"<Text to Display in Side Panel Menu>`",`"searchBoxText`":`"<Search Box Placeholder Text>`"}"
   

Remove the Semaphore A-To-Z Menu extension

Remove from the tenant

• In your SPO tenant app catalog, delete the Semaphore SPO Components app.

Remove from an individual site

1. Open the SharePoint Online Management Shell and run this command:

   Copy

   Get-PnPApplicationCustomizer | Select Title,Id
   

2. Find the customizer with the title SemaphoreAToZMenu and copy the Id.

3. In the SharePoint Online Management Shell, run this command:

   Copy

   Remove-PnPApplicationCustomizer -Identity <id>
   

4. Delete the Semaphore SPO Components app from the site.