Noções básicas sobre como modelos de exibição de item e realce de clique funcionam na experiência de pesquisa clássica no SharePoint Server

APLICA-SE A: yes-img-132013 yes-img-162016 yes-img-192019 yes-img-seSubscription Edition no-img-sopSharePoint no Microsoft 365

Neste artigo, você aprenderá:

Como mapear sua unidade de rede

Ao trabalhar com modelos de exibição, você facilitará muito a vida se mapear sua unidade de rede. Ao fazer isso, você poderá trabalhar com modelos de exibição do Windows Explorer. Para obter instruções, consulte Como mapear sua unidade de rede.

Por que é importante saber sobre nomes de propriedades gerenciadas

A seção Como a pesquisa funciona em algumas palavras do tópico introdutório desta série explicou como colunas de site e valores de coluna de site são "transformados" em propriedades gerenciadas e valores de propriedade gerenciada durante um rastreamento. É importante que você aprenda a localizar o nome da propriedade gerenciada que representa uma coluna do site, pois para adicionar novas informações aos resultados da pesquisa, você precisará adicionar o nome da propriedade gerenciada a um modelo de exibição de item. Se você não tiver certeza de como as propriedades gerenciadas são nomeadas, consulte Da coluna do site para a propriedade gerenciada – O que há com isso?

Confuso? Bem, não se desespere. Mostraremos as etapas de como localizar e adicionar um nome de propriedade gerenciada a um modelo de exibição de item posteriormente nesta série.

Sobre elementos importantes no modelo de exibição de item

O artigo Noções básicas sobre como os resultados da pesquisa são exibidos no SharePoint Server explicou que o SharePoint Server inclui muitos modelos de exibição de item. Embora esses modelos de exibição não sejam 100% idênticos, todos eles contêm determinados elementos que controlam como os resultados da pesquisa são exibidos.

Vamos nos aprofundar e abrir um modelo de exibição de item, por exemplo: Item_Excel.

Observação

Como mapeado uma unidade de rede, podemos abrir o arquivo em nosso editor de HTML favorito, por exemplo, Bloco de notas++.

Abrir Modelo de Exibição de Item

Sobre a <title> marca

A parte superior do modelo de exibição tem uma <title> marca. O texto nessa marca é o que será mostrado quando você fizer configurações na interface do usuário do SharePoint, por exemplo, quando você configurar um tipo de resultado.

A captura de tela a <title> seguir mostra como o texto da marca no modelo de exibição do item, Item do Excel, é mostrado na configuração do tipo de resultado do Microsoft Excel .

Título do Item do Excel

Sobre o elemento ManagedPropertyMapping

Após a <title> marca, há um conjunto de elementos em uma <mso:CustomDocumentProperties> marca, o mais importante dos quais é <mso:ManagedPropertyMapping>.

O elemento ManagedPropertyMapping contém as propriedades gerenciadas que podem ser usadas para exibir os resultados da pesquisa. A sintaxe a seguir é usada para armazenar essas propriedades no modelo de exibição de item:

'<Display template reference name>':<Managed property name>'

A captura de tela a seguir mostra o elemento ManagedPropertyMapping padrão para o modelo de exibição de Item do Excel .

Mapeamento de Propriedade Gerenciada

Observe que o nome de referência do modelo de exibição é o mesmo que o nome da propriedade gerenciada, por exemplo 'Title':'Title' or 'FileType':'FileType'. Embora isso possa parecer um pouco confuso no início, ter nomes idênticos facilitará a manutenção do arquivo.

Por padrão, as propriedades gerenciadas incluídas nesse elemento variam ligeiramente para os diferentes modelos de exibição de item. Mas há duas propriedades gerenciadas incluídas em todos os modelos de exibição: HitHighlightedProperties e HitHighlightedSummary. Exploraremos essas duas propriedades em "Como funciona o realce de ocorrências – é mágico!" seção deste tópico.

Sobre a <body> marca

Dentro da <body> marca, há uma marca <div> com uma ID. Por padrão, a ID dessa marca <div> corresponde ao nome do arquivo. No nosso caso, isso é Item_Excel.

Div ID

Qualquer HTML ou código que o modelo de exibição deve usar para exibir os resultados da pesquisa é incluído dentro dessa <div> marca.

Nessa marca <div> , há um ou mais blocos que começam com <!--#_ and end with _#-->. O código JavaScript é usado dentro desses blocos e HTML fora dos blocos. Você também pode usar esses blocos para controlar o HTML com instruções condicionais. Mostraremos como você pode fazer isso em um artigo posterior.

Sobre a variável de modelo de exibição do painel de foco

Temos que considerar uma variável que é usada dentro desse bloco: var hoverUrl. No Entendimento de como os resultados da pesquisa são exibidos no SharePoint Server, abordamos como cada modelo de exibição de item contém uma referência a um modelo de exibição do painel de foco. A variável var hoverUrl contém essa referência.

A captura de tela a seguir mostra como var hoverUrl aponta para o Item_Excel_HoverPanel de exibição do painel de foco.

URL de foco var

Sobre o ícone que aparece nos resultados da pesquisa

Também quero mencionar o valor ctx. CurrentItem.csr_Icon. Esse valor aponta para o ícone que deve ser exibido ao lado de cada resultado da pesquisa, por exemplo, o ícone do Excel.

A captura de tela a seguir mostra como o valor ctx. CurrentItem.csr_Icon aponta para um ícone.

Valor do ícone

Mais adiante nesta série, examinaremos como você pode alterar esse valor para que ele aponte para um ícone personalizado.

Sobre a referência ao modelo de exibição de item comum

No final do , uma <div> linha de código muito importante é incluída: #=ctx. RenderBody(ctx)=#. Noções básicas sobre como os resultados da pesquisa são exibidos no SharePoint Server, examinamos como isso é uma referência ao modelo de exibição de item usado por todos os tipos de resultados.

A captura de tela a seguir mostra como #=ctx. RenderBody(ctx)=# é usado no Item_Excel de exibição.

Referência de Item Comum

Sobre o realce de ocorrências

Mesmo que você nunca tenha ouvido falar em realce de cliques antes, você já viu o recurso em ação, mesmo que você não tenha pensado muito nele.

O recurso de realce de ocorrência usa as palavras que um usuário inseriu em uma caixa de pesquisa e as exibe em negrito nos resultados da pesquisa. Dessa forma, os usuários podem facilmente examinar os resultados da pesquisa para ver o contexto no qual suas palavras de consulta são encontradas. Por exemplo, a captura de tela a seguir mostra que "tipo de resultado" foi inserido na caixa de pesquisa. Nos resultados da pesquisa, "result" e "type" são exibidos em negrito.

Realce de Ocorrências

Como o realce de cliques funciona - é mágico!

Por padrão, o realce de ocorrências está habilitado para determinadas propriedades gerenciadas. Para ver essas propriedades gerenciadas, em uma página de resultados da pesquisa, edite a Web Part resultados da pesquisa. No Painel de Ferramentas de Web Part, expanda a seção Modelos de Exibição. As propriedades habilitadas para realce de ocorrência são listadas na seção JSON ( propriedades realçadas por clique).

Web Part Propriedades Realçadas de Ocorrência

Há um pouco mais do que isso, mas por enquanto é importante que você saiba onde essas propriedades gerenciadas estão listadas.

Vamos voltar para nossa pesquisa de "tipo de resultado" e examinar mais detalhadamente o primeiro resultado da pesquisa, que. foi retornado porque os valores nas colunas Título e Nome do Projeto/ Arquivo continham as palavras que estávamos procurando.

Item nos resultados da pesquisa

Conforme explicado anteriormente na seção "Sobre o elemento ManagedPropertyMapping" deste tópico, o elemento ManagedPropertyMapping no modelo de exibição de item contém as propriedades gerenciadas que podem ser usadas para exibir os resultados da pesquisa. Com base nisso, você pode entender por que "Sobre a configuração de tipos de resultado" é exibido. Isso ocorre porque "Sobre a configuração de tipos de resultado" é o valor de Título no item de lista e Title é uma das propriedades gerenciadas encontradas no elemento ManagedPropertyMapping no modelo de exibição. As palavras "tipo de resultado" são exibidas em negrito (ocorrência realçada) porque Título é um dos cliques realçados listados na Web Part resultados da pesquisa.

Mas por que "CSH_Configure_ result_types... " exibido nos resultados da pesquisa? No item de lista, podemos ver que esse é o valor do Nome do Projeto/Arquivo, mas a propriedade gerenciada para essa coluna de site não está incluída no elemento ManagedPropertyMapping no modelo de exibição. Ele também não está listado como uma das propriedades realçadas na Web Part resultados da pesquisa. Então, por que esse valor é exibido?

Sobre a propriedade "resumo mágico"

Se você tiver adivinhado o realce de ocorrências, está correto. Além das propriedades padrão que você viu na seção JSON ( propriedades realçadas por clique) da Web Part Resultados da Pesquisa, há uma propriedade que contém um resumo para cada item. Isso é quase como uma propriedade mágica, pois armazena um resumo de cada item no índice de pesquisa. Esse resumo é criado nos bastidores do SharePoint, portanto, você não precisa se preocupar com isso. O que é importante é que, quando eu pesquiso por "tipo de resultado", uma correspondência foi encontrada no Título e nessa propriedade "resumo mágico".

Se você está pensando agora, espere! Entendo que o valor de Título é exibido porque Title é uma das propriedades gerenciadas encontradas no modelo de exibição do elemento ManagedPropertyMapping . Mas não vejo nenhuma propriedade "resumo mágico" no elemento ManagedPropertyMapping do modelo de exibição. Então, como o valor pode ser exibido?

É aí que as duas propriedades HitHighlightedProperties e HitHighlightedSummary são úteis. O diagrama a seguir não representa como o SharePoint realmente lida com essas propriedades. No entanto, você pode pensar sobre isso da seguinte maneira:

Gráfico de Fluxo de Realce de Ocorrências

  1. As propriedades gerenciadas listadas na seção JSON ( propriedades realçadas por clique) da Web Part resultados da pesquisa e a propriedade "resumo mágico" são passadas para a propriedade HitHighlightedProperties .

  2. Todos os valores da propriedade HitHighlightedProperties são passados para a propriedade HitHighlightedSummary .

  3. Uma versão truncada dos valores em HitHighlightedSummary é exibida na Web Part resultados da pesquisa.

Se você examinar de perto os resultados da pesquisa, observará que muitos resultados da pesquisa são exibidos com três pontos no final.

Pontos de resultado

Esses pontos indicam que esses são valores da propriedade HitHighlightedSummary .

Se você quiser exibir apenas uma quantidade mínima de informações para cada resultado da pesquisa, poderá contar com a mágica de realce de ocorrências e provavelmente estar ok com a maneira padrão de exibição dos resultados da pesquisa. Mas, se você quiser que informações personalizadas sejam exibidas para cada resultado da pesquisa, você precisará fazer alguma personalização.

No próximo artigo, você aprenderá a primeira etapa na personalização dos resultados da pesquisa: criar um novo tipo de resultado.

Próximo artigo desta série

Como exibir valores de propriedades gerenciadas personalizadas nos resultados da pesquisa – opção 1 no SharePoint Server