Modification de l’expérience Recherche Microsoft à l’aide des extensions SharePoint Framework

La SharePoint Framework version 1.10 présente les extensions de requête de recherche. Il s’SharePoint Framework extensions (SPFx), qui peuvent être utilisées pour modifier la requête de recherche exécutée à l’aide de l’expérience de recherche.

Notes

Cette fonctionnalité est actuellement dans la fonctionnalité de prévisualisation pour les développeurs. Pour utiliser les fonctionnalités de la prévisualisation pour les développeurs, veillez à utiliser --plusbeta la version du package. Pour plus d’informations, voir : Essayez SharePoint Framework prévisualisation.

Important

Même si vous avez pensé que cette extension est disponible dans SharePoint Framework version 1.10, elle n’est pas prise en charge dans SharePoint Online.

Une extension de requête agit comme une extension de SharePoint Framework normale, mais elle est invoquée juste avant l’exécution de la requête de recherche, afin que la requête puisse être potentiellement modifiée. Pendant la prévisualisation, les extensions de requête ont les caractéristiques suivantes :

  • Les extensions de requête fonctionnent uniquement dans le contexte de SharePoint
  • Vous devez activer explicitement les extensions de requête dans le site ou dans l’étendue de la collection de sites
  • Les extensions de requête fonctionnent uniquement lorsque la collection de sites est associée pour utiliser une page de résultats de recherche personnalisée
  • La page de résultats de recherche personnalisée peut utiliser la nouvelle mise en page HeaderlessSearchResults pour le contenu d’en-tête réduit
  • La mise en page HeaderlessSearchResults est uniquement prise en charge pour les pages associées en tant que page de résultats de recherche personnalisée.
  • Vous pouvez fournir une expérience de recherche moderne à l’aide de la solution d’expérience de recherche moderne open source

Processus de développement

Vous pouvez commencer à développer des extensions de requête simplement à l’aide SharePoint Framework v1.10 ou des packages ultérieurs. Comme cette fonctionnalité est en état d’aperçu, vous devez exécuter le générateur Yeoman à l’aide du commutateur, comme indiqué --plusbeta ci-dessous.

yo @microsoft/sharepoint --plusbeta

Vous pouvez voir une nouvelle option appelée Modificateur de requête de recherche sous la sélection d’extension pour vous faire modèle un composant d’extension de requête.

Association d’extensions de requête à des sites

L’extension de requête par défaut est associée à une collection de sites lorsqu’une solution contenant l’extension est installée sur le site. Cela se produit automatiquement à l’aide des définitions d’infrastructure de fonctionnalité empaquetées automatiquement dans le cadre du package de solution. Techniquement, cette association est effectuée à l’aide UserCustomAction de la collection avec comme ClientSideExtension.SearchQueryModifier Location attribut.

Lorsque vous créez une solution avec le Modificateur de requête de recherche, le fichier elements.xml est inclus :

<?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>

Techniquement, vous pouvez également utiliser le déploiement d’extensions SharePoint Framework client pour associer automatiquement l’extension à plusieurs collections de sites dans un client.

Déploiement de votre extension

Le déploiement est un processus en deux étapes par défaut pour le modificateur de requête de recherche au moins pendant la prévisualisation :

  1. Déployer la solution dans SharePoint catalogue d’applications
  2. Installer la solution sur la collection de sites où vous souhaitez utiliser l’extension
  3. Créer une page de résultats de recherche personnalisée et la configurer pour qu’elle soit utilisée dans la collection de sites

Vous pouvez configurer une page de résultats de recherche personnalisée pour une collection de sites à partir des paramètres du site en cliquant sur Paramètres puis en activant l’option d’expérience de recherche personnalisée.

pic