[SP2013] – implémenter un JSLink dans les Annonces – Afficher le contrôle Like

Posted on 1 November 2015 Updated on 30 October 2015

Bonjour à tous,

Cette fois-ci je vais vous parler d’une personnalisation de SharePoint 2013 au travers des JSLink. Ces JSLink sont apparus avec SharePoint 2013 et permettent de personnaliser les affichages des données à plusieurs niveaux grâce à ce que l’on appelle le Client-Side Rendering (CSR). Vous pourrez ainsi personnaliser :

• Les Vues (List View)
• Les Formulaires (dispform, editform)
• Les champs (SPFields)

Il s’agit donc ici de contrôler la manière dont ces différents éléments seront rendus dans les pages SharePoint à l’aide de JavaScript principalement. Je ne serai volontairement pas exhaustif dans cet article car il me faudrait beaucoup de temps et cela me laissera peut-être l’opportunité d’écrire de nouveaux articles.

Voici donc mon périmètre : proposer un bouton Like/Unlike dans le formulaire d’affichage d’une actualité (Dispform de la liste Announcements (TemplateID = 104) et ceci sans recourir au déploiement d’une solution SharePoint WSP, mais en réalisant les opérations seulement coté “client”, avec des droits Administrateur de site (pas de ferme).

L’idée est donc de produire et déployer un fichier JavaScript dans SharePoint et de l’utiliser en l’associant à mon formulaire Dispform, sans perdre de fonctionnalités natives ou brider le comportement de ma liste, formulaires etc.

1/ Activer le Like sur la liste d’Announcements (Annonces)

Rien de très compliqué ici. La plupart des administrateurs fonctionnels ou techniques de sites SharePoint sauront réaliser l’opération. Pour cela, il faut naviguer jusqu’à la liste en question, et aller dans ses Paramètres. Dans cette page, nous allons dans le menu Paramètres d’évaluation (Rating Settings) :

Puis d’autoriser les évaluations de type “Like” :

1. Autoriser les éléments à être évalués (traduction approximative…) : Oui
2. Quel type d’évaluation : Likes

Et bien sûr, nous validons la page avec le bouton “OK”.

2/ Activer le JSLink sur le formulaire Dispform de la liste Announcements

En effet, une phase de préparation est nécessaire. Les formulaires (Dispform, Editform) ne proposent pas directement le paramètres JSLink sur le composant WebPart positionné dans ces pages. C’est bien ce composant WebPart qui est chargé d’afficher le formulaire avec ses champs (entêtes et contrôles de rendu).

Pour cela, il faut se rendre dans les paramètres du site > MasterPage Gallery (dans la catégorie Web Designer Galleries) :

Pour ma part, je choisis de placer mon JSLink dans le sous-dossier Display Templates mais il est préférable de les placer dans un sous-dossier afin de s’y retrouver à l’avenir…

Ensuite, on Upload un fichier JavaScript presque vide (SharePoint n’accepte pas de télécharger des fichiers vides…), ici appelé “jsnewsdispform.js” :

On clique sur “OK” pour valider et on renseigne le formulaire suivant. Ici il faudra être précis !

• Choisir le Content Type : JavaScript Display Template
• Name : Nom du fichier JavaScript (conservez celui indiqué)
• Title : Au choix
• Target Control Type : Form
• Standalone : Override
• Target Scope : Url du site où se situe l’Application Announcements (l’url de mon site en l’occurence)
• Target List Template ID : 104 (Template ID pour les Annonces SharePoint)

On valide en cliquant sur “Save”. Le fichier est enregistré (il faudra penser à le publier en version principale si la gestion des versions est activée) :

Copier l’url du document jsnewsdispform.js (url absolue dans un fichier texte, cela nous resservira plus tard).

3/ Modification du Dispform.aspx et ajout du lien vers le fichier JavaScript

Le prérequis sont en place, il nous faut maintenant indiquer au formulaire Dispform.aspx de notre liste d’annonces qu’il doit utiliser l’attribut JSLink… et bien sûr le faire pointer vers notre fichier JavaScript.

Pour cela, naviguez vers l’Application d’annonce créé sur votre site. Si aucune actualité n’est présente, créez en une qui nous servira pour aller sur la page Dispform.aspx.

Une fois fait, cliquez sur une actualité. La page s’ouvre, c’est bien la page Dispform.aspx.

Puis on passe en mode Edition sur la page. Pour cela, utilisez le menu Site Settings (Paramètres du site) et cliquez sur “Edit page” (Editer la page) :

La page se rafraichit, elle est en mode Modification. Dans le coin haut-droit du WebPart, cliquez sur “Edit Web Part” :

La boite à outil (Toolbox) du WebPart s’affiche. Dans la catégorie “Miscellaneous” (Divers de mémoire…), le champ JSLink est bien disponible (si vous n’avez pas réalisé les étapes précédentes, il ne sera pas disponible).

Dans ce champ JSLink, entrez (en modifiant l’url si besoin, suivant l’emplacement du fichier jsnewsdispform.js) :

~site/_layouts/15/reputation.js|~site/_catalogs/masterpage/Display%20Templates/jsnewsdispform.js

Notez l’emploi de “|” pour demander à SharePoint de charger plusieurs fichiers JavaScript. Et ici nous aurons besoin à la fois du fichier jsnewsdispform.js mais également reputation.js pour gérer les Likes/Unlike.

Validez en cliquant sur “OK” et sauvegardez la page :

A partir de ce moment, lorsque que la page dispform sera affichée, notre fichier sera chargé.

4/Implémentation du JSLink

Nous abordons ici l’aspect le plus complexe. Comme je l’ai dit au début de l’article, je ne vais pas détailler l’usage du JSLink, mais je peux déjà vous conseiller la lecture de l’article proposé par Tobias Zimmergren (et l’ensemble de ses excellents articles) ici : http://zimmergren.net/technical/sp-2013-using-the-spfield-jslink-property-to-change-the-way-your-field-is-rendered-in-sharepoint-2013 et également la série d’articles de Martin Hatch ici : http://www.martinhatch.com/2013/08/jslink-and-display-templates-part-1.html.

Ensuite, quelques précisions. L’implémentation JavaScript peut être complexe, et dans l’exemple présent, le code est loin d’être parfait et vous demandera forcément une phase d’optimisation, de refactorisation afin de l’adapter pour de la production. Une fois mes excuses présentées aux grands chefs du JavaScript, voici mon exemple qui fonctionne !

4.1 Charger les éléments nécessaires

Effectivement, pour faire fonctionner la plupart des JSLink il est bon de se documenter et de bien connaitre les Features proposées par SharePoint 2013. En particuler le MDS (Minimal Download Strategy) qui aura un impact fort sur tous vos développements JSLink. Je ne vais pas détailler non plus le pourquoi du comment, il y a des dizaines d’article qui traitent du sujet (Cf. Google & compagnie, en particulier l’article de Wictor Wilén : http://www.wictorwilen.se/the-correct-way-to-execute-javascript-functions-in-sharepoint-2013-mds-enabled-sites).

Pour pouvoir fonctionner avec et sans la fonctionnalité MDS activée, voici ce que l’on peut écrire :

//Load CSR-MDS module if feature is activated
if (typeof _spPageContextInfo != "undefined" && _spPageContextInfo != null) {
    RegisterInMDS();
}
else {
    RegisterLikes();
}

//Register CSR-MDS module then call template registration
function RegisterInMDS() {
    // MDS enabled site
    RegisterModuleInit(_spPageContextInfo.siteServerRelativeUrl + "/_catalogs/masterpage/Display%20Templates/jsnewsdispform.js", RegisterLikes);
    // MDS disabled site
    RegisterLikes();
}

4.2 Afficher les contrôles

Puis on appelle la fonction RegisterLikes() qui se charge d’indiquer qu’un nouveau Template de rendu est associé au champ “LikesCount”, pour le formulaire DisplayForm. J’ajoute également une ligne qui permettra de charger JQuery que j’utiliserai dans ma solution (s’il n’est pas déjà présent).
Je demande donc ici d’appeler la fonction LikeFieldViewTemplate lorsque le champ LikesCount est appelé dans un formulaire de type Dispform :

//Register Template for Number Of Like Field
function RegisterLikes () {

   // Loading jQuery from a CDN path if the local is unavailable
   (window.jQuery || document.write("< script src="//ajax.aspnetcdn.com/ajax/jquery/jquery-1.10.0.min.js">< /script>"));
   var likeFieldCtx = {};

   likeFieldCtx.Templates = {};   
   likeFieldCtx.Templates.Fields = {"LikesCount": {
	"DisplayForm": LikeFieldViewTemplate
   }};

   SPClientTemplates.TemplateManager.RegisterTemplateOverrides(likeFieldCtx);
}

NB : j’aurai également dû, et c’est la bonne pratique, déclarer un namespace pour rassembler mes fonctions.

Puis on déclare la fonction qui se chargera du rendu :

//Display Number Of Like field with custom format
function LikeFieldViewTemplate(ctx) { 
	
   var likeFieldcontext = SPClientTemplates.Utility.GetFormContextForCurrentField(ctx);
	
   ExecuteOrDelayUntilScriptLoaded(function() { GetItemData(ctx, ctx.FormContext, likeFieldcontext.fieldName); },"sp.js");
	
}

Ici je récupère le contexte associé au formulaire courant. Vous trouverez sur le net plusieurs façon de réaliser cela, mais dans le contexte du Dispform, c’est la seule qui a fonctionné pour moi : utiliser SPClientTemplates.Utility.GetFormContextForCurrentField(ctx). Ensuite j’appelle la fonction GetItemData mais après que sp.js soit chargé (ExecuteOrDelayUntilScriptLoaded).

Cette fonction GetItemData permet de charger le contexte dont j’aurai besoin, en particulier les Fields qui ne sont pas affichés dans le formulaire (de manière générale, s’ils ne sont pas affichés, ils ne sont pas chargé). Hors j’ai besoin du champ “LikedBy” pour afficher le nom des personnes qui ont déjà liké cet élément.

On charge donc ici l’item (colonnes : LikedBy, ID, LikesCount et Title) et pour cela on utilise la fonction load() et executeQueryAsync() en JSOM à partir de l’ID de l’item :

function GetItemData(ctx, formContext, likeFieldName) {

   var itemId = formContext.itemAttributes.Id;
   var listId = formContext.listAttributes.Id;

   var clientContext = SP.ClientContext.get_current();
   var list = clientContext.get_web().get_lists().getById(listId);
   clientContext.load(list, 'Title', 'Id');
   var item = list.getItemById(itemId);
   clientContext.load(item, "LikedBy", "ID", "LikesCount", "Title");
   clientContext.executeQueryAsync(
      Function.createDelegate(this, 
            function(){onLoadItemDataSucceeded(item, listId, ctx, likeFieldName);}),
            Function.createDelegate(this, onLoadItemDataFailed));
}

La fonction “onLoadItemDataSucceeded()” appelée en cas de succès du chargement de l’item permet d’afficher les contrôles : smiley + bouton Like/Unlike dans la page. Ce bouton appellera une fonction JavaScript personnalisée qui se chargera d’appeler l’API sociale de SharePoint.
On stocke le html nécessaire dans une variable htmlresult. Cet HTML sera injecté grâce à JQuery dans la page.

Dans ce premier extrait de la fonction onLoadItemDataSucceeded, le but est de récupérer le nom de toutes les personnes ayant liké l’élément avec une limite imposée à 5 noms et de placer “You” en début de liste si l’utilisateur connecté l’a déjà liké. Par ailleurs on peut arriver à 6 noms si l’utilisateur connecté arrive en dernier. Mais pour moi, cela n’est pas un problème. Le fait d’indiquer que l’utilisateur connecté a déjà liké prévaut sur le nombre de “likers”.

function onLoadItemDataSucceeded(item, listId, ctx, likeFieldName) {
   var likesCount = item.get_item('LikesCount');
   var itemId = item.get_item('ID')
   var likedBy = null;
   var likers = [];
   var likerslist = '';
   var userAlreadyLike = false;
   var currentUserId = _spPageContextInfo.userId;
   var linkerslimit = 5;
   var linkerslimitOverpass = false;
	
   var htmlresult = "";
	
   //Get likes & likers on current item
   if(likesCount != 0) {
      var likedBy = item.get_item("LikedBy");
		
      if (!SP.ScriptHelpers.isNullOrUndefined(likedBy)) {
	
         for(var i=0; i < likedBy.length; i++) {
            likers[likers.length] = {
               id: String(likedBy[i].get_lookupId())
               , title: likedBy[i].get_lookupValue()
            };
            //If user in loop is current user, then display You on first row of the tooltip
            if(likers[i].id == currentUserId) {
               userAlreadyLike = true;
               likerslist = 'You' + likerslist;
            }	
            else if(i < linkerslimit){				
               likerslist += likers[i].title + "\\r";				
         }
         else linkerslimitOverpass = true;
      }
      if(linkerslimitOverpass == true) {
         //If limit of likers is overpass, then display "..." at the end of the tooltip
         likerslist += '...';
      }
   }
   else {
      likesCount = 0;
   }
}
else {
   likesCount = 0;
}   

Ce second extrait construit le HTML et l’injecte via JQuery. Le but ici est de modifier l’entête de la colonne qui est “Number of likes” par “Do you like it?” puis de remplacer l’espace vide par le fameux smiley (au survol on consulte les noms des personnes qui ont liké) et le bouton Like/Unlike :

//Change DOM of page to insert Like controls
//Get td with column name : SPBookmark_LikesCount
var headerAnchorName = 'SPBookmark_' + likeFieldName;
var fieldid = '#SPFieldLikes';
	
//get td with column header => change text
$('a[name=' + headerAnchorName + ']').parent('h3').text("If you like it");
	
//get td with field value => add controls to like/unlike etc.
//add like control with smiley, number of likes, etc.
if(likesCount == 0 || userAlreadyLike == false) {

   htmlresult += '' + likesCount + 'Like';

}
else if (userAlreadyLike == true) {
   
   htmlresult += '' + likesCount + 'Unlike';

}

   //clear field content then insert buttons, icons etc.
   $(fieldid).empty();
   $(fieldid).append(htmlresult);
}

//Function called if refresh data on like/unlike controls fails
function onLoadItemDataFailed(sender, args) {
   alert('ERROR !');
   console.log('Error when loading item data.');
}

4.3 Gérer les likes/unlikes

Enfin, il faut développer les fonctions qui gèreront les clics utilisateur sur le bouton Like/Unlike. Pour cela, il faut s’assurer que “reputation.js” soit bien chargé puis appeler la fonction “Microsoft.Office.Server.ReputationModel.Reputation.setLike()” sans oublier executeQueryAsync() pour exécuter la requête :

//set like or unlike on selected item when current user clicks on like / unlike button
function setLikeOnNews(listId, itemId, like, itemtitle) { 

   var clientContext = new SP.ClientContext();
   //register native JS for social capabilities	
   //set like. If like == true => Like item ; if like == false => Unlike item	
   EnsureScriptFunc('reputation.js', 'Microsoft.Office.Server.ReputationModel.Reputation',
      function () {                     
         Microsoft.Office.Server.ReputationModel.Reputation.setLike(clientContext,listId,itemId, like);
  
         clientContext.executeQueryAsync(
               Function.createDelegate(this, function(){onQuerySucceeded(listId, itemId, like, itemtitle);}),
	       Function.createDelegate(this, onQueryFailed));
       }
   );
}

4.4 Afficher une notification

Petit bonus, j’ai choisi d’afficher une popup non-persistante afin d’avoir un retour utilisateur et confirmer que le like/unlike a bien été pris en compte. Pour cela :

//If like function is ok (without error)
function onQuerySucceeded(listId, itemId, like, itemtitle) {
   //Display a notification and change text on like/unlike link
   var message = "";
   if(like == "true") {
      var message ="You like the item";
   }
   else if(like == "false") {
      var message ="You unlike the item ";
   }
   else {
      var message ="An error occurred. Please try again";
   }
	
   //Display a popup on top right corner to confirm like / unlike
   var extraData = new SPStatusNotificationData(
   STSHtmlEncode(''),
   STSHtmlEncode(decodeURIComponent(itemtitle)),
   _spPageContextInfo.webLogoUrl
   );
 
   var myNotification = new SP.UI.Notify.Notification(
   SPNotifications.ContainerID.Status,
   STSHtmlEncode(message),
   false,
   '',
   function () { },
    extraData
   );
 
   myNotification.Show();
	
   //refresh data on tooltip (likers, number of likes)
   refreshLikeData(listId, itemId, like, itemtitle);	
}

//If like function throws an error
function onQueryFailed(sender, args) {
   //display an error
   var message = "An error occurred when you try yo like the item. : " + args.get_message();
   var notifyId = SP.UI.Notify.addNotification(message, false);
}

4.5 Mettre à jour les contrôles après un like/unlike

Bien sûr, après que l’utilisateur ait liké/déliké (anglicisme… quand tu nous tiens), il convient de rafraichir les contrôles affichés afin d’incrémenter/décrémenter le nombre de likes, la liste des personnes ayant liké et également modifier le bouton pour pouvoir déliké si on a liké et inversement.

Pour cela, il faut recharger l’item courant en utilisant la même technique que pour le premier chargement :

//Refresh data when user is liking / unliking an item
function refreshLikeData(listId, itemId, like, itemtitle) {
   //get data from list item
   var clientContext = SP.ClientContext.get_current();
   var list = clientContext.get_web().get_lists().getById(listId);
   clientContext.load(list, 'Title', 'Id');
   var item = list.getItemById(itemId);
   clientContext.load(item, "LikedBy", "ID", "LikesCount", "Title");
   clientContext.executeQueryAsync(
         Function.createDelegate(this, function(){onRefreshLoadDataSucceeded(itemId, like, item, list);}),
         Function.createDelegate(this, onRefreshLoadDataFailed)
   );
}

Et enfin on injecte les mises à jour toujours via du JQuery (que j’aurai pu factoriser…) :

//when refresh data succeeds, change html controls like/unlike and tooltip, number of likes
function onRefreshLoadDataSucceeded(itemId, like, item, list) {
	
   //set number of likes
   $('.ms-comm-likesCount.ms-comm-reputationNumbers').text(item.get_item('LikesCount'));
	
   //change like button to unlike or unlike to like (or error) + command onclick
   if(like == "true") {
      $('a#likesElement-' + itemId).text('Unlike');
      $('a#likesElement-' + itemId).attr("onclick" , 'setLikeOnNews("' + list.get_id() + '","' + item.get_item('ID') + '","false","' + encodeURIComponent(item.get_item('Title')) + '");return false;');
   }
   else if(like == "false") {
      $('a#likesElement-' + itemId).text('Like');
      $('a#likesElement-' + itemId).attr("onclick" , 'setLikeOnNews("' + list.get_id() + '","' + item.get_item('ID') + '","true","' + encodeURIComponent(item.get_item('Title')) + '");return false;');
   }
   else {
      $('a#likesElement-' + itemId).text('ERROR');
      $('a#likesElement-' + itemId).attr("onclick" , '');
   }
	
   //change tooltip on like/unlike button
   var likers = [];
   var likerslist = '';
   var likerslimit = 5;
   var likerslimitOverpass = false;
   var currentUserId = _spPageContextInfo.userId;
   //Set likers on span
   if(item.get_item('LikesCount') != 0) {
      var likedBy = item.get_item('LikedBy');
		
      if (!SP.ScriptHelpers.isNullOrUndefined(likedBy)) {
         for (var i = 0; i < likedBy.length; i++) {
			
            likers[likers.length] = {
		id: String(likedBy[i].get_lookupId())
		, title: likedBy[i].get_lookupValue()
	    };
				
	    if (likers[i].id == currentUserId) {
               userAlreadyLike = true;
               likerslist = 'You \r' + likerslist;
            }
            else if(i < likerslimit) {
               likerslist += likers[i].title + '\r';					
            }
            else
               likerslimitOverpass = true;
            }
            if(likerslimitOverpass == true) {
               likerslist += '...\r';
            }	
         }
	else {
           likesCount = 0;
         }
      }
      else {
         likesCount = 0;
      }   	
	
   $('.ms-comm-likesMetadata.ms-metadata').attr('title',likerslist.replace(/\r$/, ""));
}

//Function called if refresh data on like/unlike controls fails
function onRefreshLoadDataFailed(sender, args) {
   //set number of likes
   $('.ms-comm-likesCount.ms-comm-reputationNumbers').text(item.get_item('ERROR'));
   $('a#likesElement-' + itemId).text('ERROR');
   $('a#likesElement-' + itemId).attr("onclick" , '');
}

Et tout devrait fonctionner ! La preuve en images… et en français :

Voici donc un exemple “assez simple” d’une personnalisation, sans code serveur, sans solution à déployer… et qui ouvre la porte à de nouvelles personnalisations.
Et je sais que certains vont me poser la question : “Mais ça y sera dans SP2016 ?” ===> La réponse est OUI 🙂

A bientôt !