Modificar a experiência de Pesquisa da Microsoft usando extensões da Estrutura do SharePoint

A versão Estrutura do SharePoint v1.10 apresenta extensões de Consulta de Pesquisa. Estas são extensões Estrutura do SharePoint (SPFx), que podem ser usadas para modificar a consulta de pesquisa executada usando a experiência de pesquisa.

Observação

Esse recurso está atualmente no recurso de visualização do desenvolvedor. Para usar recursos na versão prévia do desenvolvedor, verifique se você usa a --plusbeta versão do pacote. Para obter mais informações, consulte: Tente Estrutura do SharePoint recursos de visualização.

Importante

Mesmo achando que essa extensão está disponível na versão do Estrutura do SharePoint v1.10, ela não tem suporte no SharePoint Online.

Uma extensão de consulta atua como uma extensão de Estrutura do SharePoint normal, mas será invocada pouco antes da consulta de pesquisa ser executada, para que a consulta possa ser potencialmente modificada. Durante a visualização, as extensões de consulta têm as seguintes características:

• As extensões de consulta funcionam apenas no contexto do SharePoint
• Você precisará habilitar explicitamente as extensões de consulta no site ou no escopo da coleção de sites
• As extensões de consulta só funcionam quando a coleção de sites está associada ao uso de uma página de resultados de pesquisa personalizada
• A página de resultados da pesquisa personalizada pode usar o novo layout de página HeaderlessSearchResults para conteúdo de cabeçalho reduzido
• O layout da página HeaderlessSearchResults só tem suporte para páginas associadas como uma página de resultado de pesquisa personalizada
• Você pode fornecer uma experiência de pesquisa moderna usando a solução de experiência de pesquisa moderna de software livre

Processo de desenvolvimento

Você pode começar a desenvolver extensões de consulta simplesmente usando os pacotes Estrutura do SharePoint v1.10 ou posteriores. Como esse recurso está no status de visualização, você precisará executar o gerador Yeoman usando o --plusbeta comutador, conforme demonstrado abaixo.

yo @microsoft/sharepoint --plusbeta

Você pode ver uma nova opção chamada Modificador de Consulta de Pesquisa na seleção de extensão para criar um componente de extensão de consulta.

Associando extensões de consulta a sites

A extensão de consulta por padrão está associada a uma coleção de sites quando uma solução que contém a extensão é instalada no site. Isso acontece usando automaticamente as definições do Feature Framework empacotadas automaticamente como parte do pacote de solução. Tecnicamente, essa associação é feita usando a UserCustomAction coleção com ClientSideExtension.SearchQueryModifier como o Location atributo.

Quando você cria uma nova solução com o Modificador de Consulta de Pesquisa, o seguinte arquivoelements.xml é incluído:

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

Tecnicamente, você também pode usar a implantação no escopo do locatário de extensões Estrutura do SharePoint para associar automaticamente a extensão a várias coleções de sites em um locatário.

Implantação de sua extensão

A implantação é um processo de duas etapas por padrão para o Modificador de Consulta de Pesquisa pelo menos durante a visualização:

1. Implantar solução no Catálogo de Aplicativos do SharePoint
2. Instalar a solução no conjunto de sites em que você deseja usar a extensão
3. Criar uma página de resultados de pesquisa personalizada e configurá-la para ser usada na coleção de sites

Você pode configurar a página de resultados de pesquisa personalizada para uma coleção de sites nas configurações do site clicando em Configurações de Pesquisa e habilitando a opção de experiência de pesquisa personalizada.