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

  • Article

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

Remarque

Cette fonctionnalité est actuellement disponible en préversion pour les développeurs. Pour utiliser les fonctionnalités de la préversion pour les développeurs, veillez à utiliser la --plusbeta version du package. Pour plus d’informations, consultez : Essayer SharePoint Framework fonctionnalités en préversion.

Importante

Même si cette extension est disponible dans la version SharePoint Framework v1.10, elle n’est pas prise en charge dans SharePoint Online.

Une extension de requête agit comme une extension SharePoint Framework normale, mais elle est appelée juste avant l’exécution de la requête de recherche, afin que la requête puisse être éventuellement modifiée. Pendant la préversion, les extensions de requête présentent 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 des résultats de la recherche personnalisée peut utiliser une nouvelle mise en page sans en-têteSearchResults pour réduire le contenu d’en-tête
  • La mise en page headerlessSearchResults est prise en charge uniquement 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 d’une 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 des packages SharePoint Framework version 1.10 ou ultérieure. Comme cette fonctionnalité est en préversion, vous devez exécuter le générateur Yeoman à l’aide du --plusbeta commutateur, comme illustré 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 créer une structure d’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 feature Framework empaquetées automatiquement dans le cadre du package de solution. Techniquement, cette association est effectuée à l’aide de la UserCustomAction collection avec ClientSideExtension.SearchQueryModifier comme Location attribut .

Lorsque vous créez une solution avec le modificateur de requête de recherche, elements.xml fichier suivant 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 étendu au locataire d’extensions SharePoint Framework pour associer automatiquement l’extension à plusieurs collections de sites dans un locataire.

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éversion :

  1. Déployer la solution sur le catalogue d’applications SharePoint
  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 la page de résultats de recherche personnalisée pour une collection de sites à partir des paramètres du site en cliquant sur Paramètres de recherche , puis en activant l’option expérience de recherche personnalisée.

Pic