Archives mensuelles : octobre 2014

Utiliser jQuery UI autocomplete et l’API REST de SharePoint pour obtenir des résultats de recherche de personne

Introduction

Le complètement automatique, ou encore par anglicisme l’autocomplétion, est une fonctionnalité informatique permettant à l’utilisateur de limiter la quantité d’informations qu’il saisit, en se voyant proposer un complément qui pourrait convenir à la chaîne de caractères qu’il a commencé à taper. Dans SharePoint, ce type de fonctionnalité n’existe pas nativement pour obtenir des résultats de recherche de personnes et pourtant ça semble être très en demande par plusieurs clients qui veulent offrir une expérience utilisateur similaire à Google.

Prérequis

  • Avoir SharePoint 2013 sur site (On-Premise) ou SharePoint 2013 Online (O365)
  • Avoir configuré votre service de recherche ainsi que la recherche de personnes
  • Avoir une référence aux librairies tierces suivantes : jQuery, jQuery.UI et jQuery.Ui.Autocomplete

Librairies tierce

Il y a quelque années, j’avais réalisé une composante permettant d’utiliser l’autocomplétion en utilisant la composante RadAutoCompleteBox de Telerik. Cette composante payante avait requis relativement beaucoup d’effort afin d’être intégré dans SharePoint en plus de nécessiter le déploiement et l’hébergement d’un service Web spécifique pour fournir les résultats de recherche.

Maintenant, il existe plusieurs librairies tierces gratuites permettant d’effectuer le travail en s’intégrant dans SharePoint beaucoup plus facilement et en interrogeant l’API REST de recherche natif. Une des librairies populaires est le plugin Autocomplete de jQuery.

Intégrer le plugin AutoComplete

Je m’inspire du code provenant du billet de Murad qui nous offre un bon point de départ pour intégrer le plugin. Le code intègre les librairies tierces requises pour cette démonstration en plus de fournir un champ texte pour effectuer la recherche. Il suffit donc d’insérer le code suivant dans une WebPart de type Éditeur de Script :

<link rel="stylesheet" href="http://code.jquery.com/ui/1.10.0/themes/base/jquery-ui.css" />
<link rel="stylesheet" href="http://code.jquery.com/ui/1.10.0/themes/base/jquery.ui.autocomplete.css" />
<script src="http://code.jquery.com/jquery-1.8.3.js"></script>
<script src="http://code.jquery.com/ui/1.10.0/jquery-ui.js"></script>
//[...]
//Code retiré pour simplifier l'exemple
//[...]
<table>
<tbody>
	<tr>
		<td>REST Search</td>
		<td>
 		<div id="menu-container" style="width:600px">
			<input type="text" id="restSearch" size="50"/>
			</div>
		</td>
	</tr>
</tbody>
</table>

Construire une requête pour obtenir des résultats de recherche de personnes

Tout d’abord, il faut construire une requête sur l’API REST de recherche. Ce site est une excellente référence sur les divers points d’entrés ainsi que sur les paramètres disponibles pour construire notre requête.

Ex : https://<NomWebApplication>/_api/search/query?querytext=’lev*’&sourceid=’B09A7990-05EA-4AF9-81EF-EDFAB16C4E31’&clienttype=’Custom’

  • Le paramètre querytext représente le terme que l’on recherche
  • Le paramètre SourceId indique le GUID du résultat Source à utiliser pour l’exécution de la requête de recherche

Remarquez la propriété SourceId qui fait partie de la requête. On aurait pu utiliser le paramètre « ContentClass=urn:content-class:SPSPeople » à la place, mais SharePoint 2013 expose le SourceId des résultats. Le SourceId pour les résultats de personnes semble être le même pour toutes les installations soit « B09A7990-05EA-4AF9-81EF-EDFAB16C4E31 ». Alors je ne me sens pas coupable de hardcoder ce GUID.

On peut tester cette requête en l’exécutant directement dans le fureteur  qui nous affichera le résultat sous une forme XML :

rest_people_search_results_xml

Ajouter le code pour exécuter la requête et afficher les résultats de recherche de personnes

Afin de retourner des résultats de recherche de personne, il faut modifier le code initial afin de lancer un appel asynchrone lorsqu’un certain nombre de caractères seront saisie par l’utilisateur. La requête construite précédemment sera par la suite exécuté et finalement on affichera les résultats en dessous du champ texte recherche.

<link rel="stylesheet" href="http://code.jquery.com/ui/1.10.0/themes/base/jquery-ui.css" />
 <link rel="stylesheet" href="http://code.jquery.com/ui/1.10.0/themes/base/jquery.ui.autocomplete.css" />
 <script src="http://code.jquery.com/jquery-1.8.3.js"></script>
<script src="http://code.jquery.com/ui/1.10.0/jquery-ui.js">
 </script>

<script type="text/javascript">
 // Parse an item and create an title/value dictionary with all the properties available
 function getFields(results) {
 r = {};
 for(var i = 0; i<results.length; i++) {
 if(results[i] != undefined && results[i].Key != undefined) {
 r[results[i].Key] = results[i].Value;
 }
 }
 return r;
 }

 $(document).ready(function() {

 var autocomplete = $( "#restSearch" ).autocomplete({
 minLength: 3,
 source: function( request, response ) {
 $.ajax({
 beforeSend: function (request)
 {
 request.setRequestHeader("Accept", "application/json;odata=verbose;charset=utf-8");
 },
 url: "/_api/search/query?sourceid='B09A7990-05EA-4AF9-81EF-EDFAB16C4E31'&querytext='" + request.term + "*'",
 dataType: "json",
 success: function( data ) {
 response( $.map( data.d.query.PrimaryQueryResult.RelevantResults.Table.Rows.results, function( item ) {
 return {
 fields: getFields(item.Cells.results)
 }
 }));
 },
 error: function( data ) {
 alert('search error');
 }
 });
 },
 // Run this when the item is in focused (not selected)
 focus: function( event, ui ) {
 //$( "#restSearch" ).val(ui.item.value );
 return false;
 },
 // Run this when the item is selected
 select: function( event, ui ) {
 location.href = ui.item.fields.Path;
 },
 appendTo: $('#menu-container')
 }).data( "uiAutocomplete" )._renderItem = function( ul, item ) {
 return $("<li>").append('<a>' + item.fields.PreferredName + '</a>' )
 .appendTo( ul );
 };
 });
</script>

<table>
 <tbody>
 <tr>
 <td>REST Search:</td>
 <td>
 <div id="menu-container" style="width:600px">
 <input type="text" id="restSearch" size="50"/>
 </div>
 </td>
 </tr>
 </tbody>
 </table>

Résultat :

rest_people_search_results

Dans de grandes entreprises on peut retrouver plusieurs personnes ayant le même nom  et prénom. Pour éviter la confusion, il est facile d’ajouter la photo, le titre ou la direction de la personne.

Pour s’y faire, simplement modifier la ligne suivante :

return $("<li>").append('<a><img style="margin-right:3px;top:3px;" src="/_layouts/15/images/'+ img +'">' + item.fields.Title + '</a>' ) .appendTo( ul );

Par ceci :

var hasPicture = item.fields.PictureURL;
var currentItem;
 if(hasPicture){
 currentItem = '<a><img src="' + item.fields.PictureURL + '"/>' + item.fields.PreferredName + ' - ' + item.fields.JobTitle + '</a>'
 }
 else{
 currentItem = '<a><img src="/_layouts/images/o14_person_placeholder_96.png"/>' + item.fields.PreferredName + ' - ' + item.fields.JobTitle + '</a>'
 }
return $("<li>").append(currentItem).appendTo( ul );

Résultat :

rest_people_search_results_with_img

Conclusion

On peut réaliser une fonctionnalité d’autocomplétion des résultats de recherches de personnes très rapidement en intégrant le plugin gratuit jQuery Autocomplete et en utilisant les API REST de recherche natif. Cette solution fonctionne pour les environnements SharePoint 2013 sur site (On-Premise) ainsi que dans SharePoint 2013 Online (O365). Le code ne nécessite pas de déploiement de solution et il pourrait facilement être amélioré pour ajouter toute autres propriétés que vous jugeriez pertinente (Ex : Département, intérêts, etc…).

Cliquez ici pour télécharger le code source

Citation

Murad Sæter. (2013, 20 février). Using jQuery UI autocomplete with the REST API to get search results in the search box [Billet de blogue]. Repéré à http://blogs.msdn.com/b/murads/archive/2013/02/20/using-jquery-ui-autocomplete-with-the-rest-api-to-get-search-results-in-the-search-box.aspx