Freigeben über

Ändern der Microsoft Search-Benutzeroberfläche mithilfe von SharePoint-Framework-Erweiterungen

Mit SharePoint-Framework Version v1.10 werden Suchabfrageerweiterungen eingeführt. Dies sind SharePoint-Framework (SPFx)-Erweiterungen, die verwendet werden können, um suchabfragen zu ändern, die mithilfe der Suchoberfläche ausgeführt werden.

Hinweis

Dieses Feature befindet sich derzeit in der Entwicklervorschau. Um Features in der Entwicklervorschau zu verwenden, stellen Sie sicher, dass Sie die --plusbeta Version des Pakets verwenden. Weitere Informationen finden Sie unter Testen SharePoint-Framework Vorschaufunktionen.

Wichtig

Selbst wenn diese Erweiterung in version 1.10 von SharePoint-Framework verfügbar ist, wird sie in SharePoint Online nicht unterstützt.

Eine Abfrageerweiterung fungiert als normale SharePoint-Framework-Erweiterung, wird aber unmittelbar vor der Ausführung der Suchabfrage aufgerufen, sodass die Abfrage möglicherweise geändert werden kann. Während der Vorschau haben Abfrageerweiterungen die folgenden Merkmale:

  • Abfrageerweiterungen funktionieren nur im Kontext von SharePoint
  • Sie müssen Abfrageerweiterungen im Website- oder Websitesammlungsbereich explizit aktivieren.
  • Abfrageerweiterungen funktionieren nur, wenn eine Websitesammlung zur Verwendung einer benutzerdefinierten Suchergebnisseite zugeordnet ist
  • Benutzerdefinierte Suchergebnisse können das neue HeaderlessSearchResults-Seitenlayout für reduzierte Kopfzeileninhalte verwenden
  • HeaderlessSearchResults-Seitenlayout wird nur für Seiten unterstützt, die als benutzerdefinierte Suchergebnisseite zugeordnet sind
  • Sie können eine moderne Suchumgebung bereitstellen, indem Sie eine moderne Open-Source-Suchlösung verwenden.

Entwicklungsprozess

Sie können mit der Entwicklung von Abfrageerweiterungen beginnen, indem Sie einfach die Pakete SharePoint-Framework v1.10 oder höher verwenden. Da sich dieses Feature im Vorschaustatus befindet, müssen Sie den Yeoman-Generator mithilfe des --plusbeta Schalters ausführen, wie unten gezeigt.

yo @microsoft/sharepoint --plusbeta

Unter der Erweiterungsauswahl wird eine neue Option namens Suchabfragemodifizierer angezeigt, um ein Gerüst für eine Abfrageerweiterungskomponente zu erstellen.

Zuordnen von Abfrageerweiterungen zu Websites

Abfrageerweiterungen werden standardmäßig einer Websitesammlung zugeordnet, wenn eine Lösung, die die Erweiterung enthält, auf der Website installiert ist. Dies geschieht automatisch mithilfe der Feature Framework-Definitionen, die automatisch als Teil des Lösungspakets gepackt werden. Technisch gesehen erfolgt diese Zuordnung mithilfe der UserCustomAction Auflistung mit ClientSideExtension.SearchQueryModifier als Location Attribut.

Wenn Sie eine neue Projektmappe mit dem Suchabfragemodifizierer erstellen, ist die folgendeelements.xml Datei enthalten:

<?xml version="1.0" encoding="utf-8"?>
<Elements xmlns="http://schemas.microsoft.com/sharepoint/">
  <CustomAction
      Title="QueryModifyer"
      Location="ClientSideExtension.SearchQueryModifier"
      ClientSideComponentId="801f82d5-1a21-4b2c-94b6-f13f6672142c"
      ClientSideComponentProperties="{&quot;testMessage&quot;:&quot;Test message&quot;}">
  </CustomAction>
</Elements>

Technisch gesehen können Sie auch die mandantenbezogene Bereitstellung von SharePoint-Framework Erweiterungen verwenden, um die Erweiterung automatisch mehreren Websitesammlungen in einem Mandanten zuzuordnen.

Bereitstellung Ihrer Erweiterung

Die Bereitstellung ist standardmäßig ein zweistufiger Prozess für den Suchabfragemodifizierer , zumindest während der Vorschauphase:

  1. Bereitstellen einer Lösung im SharePoint-App-Katalog
  2. Installieren der Lösung für die Websitesammlung, in der Sie die Erweiterung verwenden möchten
  3. Erstellen einer benutzerdefinierten Suchergebnisseite und Konfigurieren der Seite für die Verwendung in der Websitesammlung

Sie können benutzerdefinierte Suchergebnisse für eine Websitesammlung aus den Websiteeinstellungen konfigurieren, indem Sie auf Sucheinstellungen klicken und dann die Option benutzerdefinierte Sucherfahrung aktivieren.

Pic