Compléments de recherche dans SharePoint

Article
03/21/2023

Découvrez comment rechercher des compléments SharePoint et comment créer vos propres compléments de recherche. Les compléments que vous créez peuvent être ajoutés au catalogue de compléments SharePoint afin qu’ils puissent être utilisés à la fois dans le déploiement local et Office 365. Les compléments de recherche fonctionnent uniquement avec les données stockées dans l’index de recherche et non avec les documents sources d’origine.

Les compléments pour SharePoint sont des éléments de fonctionnalité autonomes qui étendent les capacités d’un site web SharePoint. Ces compléments résolvent des besoins spécifiques de l’entreprise et des utilisateurs finaux en intégrant le meilleur du web et de SharePoint. Un complément peut contenir différents éléments SharePoint tels que listes, récepteurs d’événements distants, types de contenu, flux de travail, activités personnalisées de flux de travail, colonnes de site, modules, actions personnalisées d’élément de menu, composants WebPart clients et configurations de recherche. Pour plus d’informations, reportez-vous à la rubrique Compléments SharePoint.

Un complément de recherche est un Complément SharePoint utilise les fonctionnalités de recherche. Dans un complément de recherche, vous pouvez utiliser l’API Recherche SharePoint pour localiser du contenu. Selon le type d'autorisations définies dans votre manifeste d'application add-in, vous pouvez rechercher à l'intérieur ou à l'extérieur du contenu de la macro complémentaire. En outre, vous pouvez également utiliser un complément de recherche pour distribuer des configurations de recherche à partir d'une installation de SharePoint vers un autre. La conception de base d'un complément de recherche dépend de la méthode de déploiement que vous choisissez. La section suivante résume les options disponibles ainsi que leurs avantages. Pour plus d’informations, voir Choisir des modèles pour le développement et l’hébergement de votre complément SharePoint

Déployer votre recherche complémentaires

Il existe deux façons de déployer votre complément recherche :

SharePoint hébergé - déploiement sur site. Le complément de recherche est hébergé à l'intérieur du réseau d'entreprise sur les serveurs de la société. Gérer les administrateurs de la société du complément. Ce scénario offre une flexibilité de déploiement et de prise en charge, car la configuration matérielle et logicielle est conservée localement par les administrateurs.
Fournisseur hébergé - n'importe quel serveur web qui héberge. Le complément de recherche est hébergé par n'importe quel fournisseur, en dehors du serveur de SharePoint du client.

Environnement de développement de compléments de recherche

Pour créer un complément de recherche, utilisez l’environnement suivant :

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

Visual Studio 2013 et les versions ultérieures, vous pouvez publier vos compléments recherche à la fois sur site ou dans Office 365. Pour plus d’informations sur les environnements de développement et leur utilisation pour créer des compléments de recherche, voir Configurer un environnement de développement général pour SharePoint.

API pour la recherche des compléments

Vous pouvez utiliser la grande variété d'API liées à la recherche que SharePoint offre des compléments de la recherche. Le tableau suivant répertorie ces API et l'emplacement de leurs bibliothèques de classes.

APIs SharePoint pour les compléments de recherche

Nom de l'API	Bibliothèque de classes
Modèle objet client .NET (CSOM)	Microsoft.SharePoint.Client.Search.dll
Silverlight CSOM	Microsoft.SharePoint.Client.Search.Silverlight.dll
modèle d'objet ECMAScript (JavaScript, JScript) (JSOM)	SP.search.js
API REST de Search	http://server/_api/search/query

Exemples de code

Voici quelques exemples de code à l'aide de l'API différentes. Chaque exemple de code envoie une requête simple Search qui contient le mot clé «SharePoint » à la Application de service de recherche (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

Demande HTTP GET


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

Demande HTTP POST

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

Complément les autorisations de recherche

Recherche des compléments envoient les demandes de requête à la Application de service de recherche (SSA) et les compléments requièrent différents types d'autorisations pour fonctionner correctement. Vous pouvez configurer ces autorisations par le biais du complément de fichier manifeste, qui fait partie de chaque macro complémentaire SharePoint. Vous pouvez modifier le fichier manifeste du complément directement avec un éditeur de texte, ou vous pouvez la modifier avec Visual Studio ou Outils de développement Office 365 « Napa », comme indiqué dans les figures suivantes.

La figure 1: Définir les autorisations pour la recherche des compléments dans Visual Studio 2015

Configuration d'autorisation d'application de recherche avec VS

La figure 2: Définir les autorisations pour la recherche des compléments dans « Napa » Office 365 Development Tools

Configuration d'autorisation d'application de recherche via Napa

Un Complément SharePoint possède sa propre identité et être associé à une entité de sécurité appelée un complément principal. Comme les utilisateurs et groupes, un principal d'application add-in a certains droits et autorisations. Principal add-in dispose de droits de contrôle total sur le complément de site web, afin qu'il ne doit demander des autorisations à des ressources SharePoint dans le site web hôte ou d'autres emplacements à l'extérieur du web add-in, tels que les collections de sites. Contrairement à d'autres Compléments SharePoint, un complément de recherche requiert uniquement des autorisations au niveau de l'utilisateur, appelées QueryAsUserIgnoreAppPrincipal. Cette autorisation vous permet d'interroger le complément recherche basé sur les autorisations de l'utilisateur. Cela signifie que les résultats seront afficheront la recherche basée sur les listes ACL de l'utilisateur.

Demander des autorisations dans le fichier manifeste du complément

Le fichier manifeste du complément est au format XML et peut être modifié directement. Pour obtenir des autorisations, vous écrivez une requête, comme illustré dans l'exemple suivant :


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

Partager via