Pesquisar suplementos no SharePoint

Artigo
03/21/2023

Saiba mais sobre pesquisar suplementos do SharePoint e como você pode criar seus próprios suplementos de pesquisa. Os suplementos que você cria podem ser adicionados ao catálogo de suplementos do SharePoint para que possam ser usados na implantação local e no Office 365. Os suplementos de pesquisa funcionam apenas com dados armazenados no índice de pesquisa e não com os documentos de origem originais.

Os Suplementos do SharePoint são peças de funcionalidade autocontidas que ampliam as capacidades de um site do SharePoint. Esses suplementos resolvem necessidades específicas de empresas e usuários finais integrando o melhor da Web e do SharePoint. Um suplemento pode conter vários elementos do SharePoint, como Listas, Receptores de Eventos Remotos, Tipos de Conteúdo, Fluxos de Trabalho, Atividades Personalizadas de Fluxo de Trabalho, Colunas de Site, Módulos, Ações Personalizadas do Item de Menu, Web Parts do Cliente e Configurações de Pesquisa. Veja mais informações em Suplementos do SharePoint.

Um suplemento de pesquisa é um Suplemento do SharePoint que usa a funcionalidade de pesquisa. Em um suplemento de pesquisa, você pode usar a API de Pesquisa do SharePoint para localizar o conteúdo. Dependendo do tipo de permissões configuradas no seu manifesto do suplemento, você pode pesquisar dentro ou fora o conteúdo do add-in. Além disso, você pode também usar um suplemento de pesquisa para distribuir as configurações de pesquisa de uma instalação SharePoint para outro. O design de núcleo de um suplemento de pesquisa depende do método de implantação que você escolher. A seção a seguir resume as opções disponíveis e seus benefícios. Para obter mais informações, confira Escolher padrões para desenvolver e hospedar seu Suplemento do SharePoint

Implantar seus suplementos de pesquisa

Há duas maneiras de implantar seu suplemento de pesquisa:

SharePoint hospedado - implantação no local. O suplemento de pesquisa é hospedado dentro da rede corporativa em servidores da empresa. Os administradores da empresa gerenciam o add-in. Neste cenário oferece flexibilidade na implantação e suporte, como o hardware e software é mantida localmente pelos administradores.
Provedor hospedado - qualquer servidor web que hospeda. O suplemento de pesquisa é hospedado por qualquer provedor, fora do servidor do SharePoint do cliente.

Ambiente de desenvolvimento do suplemento de pesquisa

Para criar um suplemento de pesquisa, use o seguinte ambiente:

Microsoft Visual Studio 2012 ou Microsoft Visual Studio 2013 ou 2015 do Visual Studio

Com Visual Studio 2013 e posterior, você pode publicar seus suplementos de pesquisa tanto no local ou em Office 365. Para obter mais informações sobre os ambientes de desenvolvimento e como usá-los para criar suplementos de pesquisa, consulte Configurar um ambiente de desenvolvimento geral para o SharePoint.

APIs para suplementos de pesquisa

Você pode usar uma ampla variedade de APIs relacionados à pesquisa que SharePoint oferece para suplementos de pesquisa. A tabela a seguir lista essas APIs e o local das suas bibliotecas de classes.

APIs do SharePoint para suplementos de pesquisa

Nome da API	Biblioteca de classe
Modelo de objeto do cliente .NET (CSOM)	Microsoft.SharePoint.Client.Search.dll
Silverlight CSOM	Microsoft.SharePoint.Client.Search.Silverlight.dll
modelo de objeto do ECMAScript (JavaScript, JScript) (JSOM)	SP.search.js
REST API de pesquisa	http://server/_api/search/query

Exemplos de código

Aqui estão alguns exemplos de código usando as diferentes APIs. Cada exemplo de código envia uma consulta simples Pesquisa que contém a palavra-chave "SharePoint " para o Search service application (SSA).

Client-side Object Model (CSOM)


using (ClientContext clientContext = new ClientContext("http://localhost"))
{
    KeywordQuery keywordQuery = new KeywordQuery(clientContext);
    keywordQuery.QueryText = "*";
    SearchExecutor searchExecutor = new SearchExecutor(clientContext);
    ClientResult<ResultTableCollection> results = 
        searchExecutor.ExecuteQuery(keywordQuery);
    clientContext.ExecuteQuery();
}

JavaScript Object Model (JSOM)


var keywordQuery = new
Microsoft.SharePoint.Client.Search.Query.KeywordQuery(context);
keywordQuery.set_queryText('SharePoint');
var searchExecutor = new Microsoft.SharePoint.Client.Search.Query.SearchExecutor(context);
results = searchExecutor.executeQuery(keywordQuery);
context.executeQueryAsync(onQuerySuccess, onQueryFail);

REST

Solicitação HTTP GET


http://mylocalhost/_api/search/query?querytext='SharePoint'

Solicitação HTTP POST

{
'__metadata' : {'type' : 'Microsoft.Office.Server.Search.REST.SearchRequest'},
'Querytext' : 'SharePoint'
}

Permissões do suplemento de pesquisa

Suplementos de pesquisa enviam solicitações de consulta para Search service application (SSA) e os suplementos exigem diferentes tipos de permissões para funcionar corretamente. Você pode configurar essas permissões por meio do suplemento manifesto arquivo, que é uma parte de cada suplemento SharePoint. Você pode modificar o arquivo de manifesto suplemento diretamente com um editor de texto, ou você pode modificá-la com Visual Studio ou Napa, conforme mostrado nas figuras a seguir.

Figura 1: Configuração de permissões para suplementos de pesquisa no 2015 do Visual Studio

Search app permission configuration with VS

Figura 2: Como configurar permissões para suplementos de pesquisa nas ferramentas de desenvolvimento do "Napa" Office 365

Search app permission configuration through Napa

Um Suplemento do SharePoint tem sua própria identidade e é associado a uma entidade de segurança, chamado um suplemento principal. Assim como os usuários e grupos, um suplemento de entidade tem determinados direitos e permissões. A entidade de segurança tem direitos de controle total à web suplemento, ele só precisa solicitar permissões para os recursos de SharePoint em web host ou outros locais externos web suplemento, como conjuntos de sites. Ao contrário de outros Suplementos do SharePoint, um suplemento de pesquisa requer apenas permissões do nível do usuário, conhecidas como QueryAsUserIgnoreAppPrincipal. Essa permissão permite que você consultar o suplemento de pesquisa com base nas permissões do usuário. Isso significa que os resultados serão retornados a pesquisa com base em ACLs do usuário.

Solicitar permissões no suplemento do arquivo de manifesto

O arquivo de manifesto add-in estiver em formato XML e pode ser editado diretamente. Para obter permissões, você escrever uma solicitação, conforme mostrado no exemplo a seguir:


<AppPermissionRequests>
  <AppPermissionRequest Scope="http://sharepoint/search" Right="QueryAsUserIgnoreAppPrincipal" />
</AppPermissionRequests>

Compartilhar via