Archives du blog

Sharepoint et des favoris !!!

Favoris … comment faire des favoris avec Sharepoint ? Voila la question que l’on me posait il y a pas si longtemps.

Ce que mon project owner entendait par favoris, c’est un système qui tiens informé quand une modification est faite sur un document, de pouvoir choisir quand je suis informé et de pouvoir désactiver le favoris ou de le réactiver à ma guise.

Après des recherches, je dois l’admettre, pas très fructueuse je me suis dit :  « On n’est jamais mieux servi que par soit même ». Donc… j’ai commencé à regarder ce que je pouvais faire avec l’élément « AlertMe » car il faisait déjà une grande partie du travail. Il ne me restait plus qu’à ajouter une interface et quelques options pour que ça ressemble à quelque chose.

J’ai créé plusieurs listes pour contenir les informations suivantes : Les différents filtres CAML utilisé avec Alert Me, les paramètres de l’utilisateur et la liste des différents favoris.

La liste des paramètres pour chaque utilisateur  est composé comme indiqué ci-dessous

  • UserName
  • FilterID me permet d’aller chercher le CAML spécifique au filtre que je veux faire
  • Frequency est l’id de référence par rapport à l’enum SPAlertFrequency.
  • Day id du jour par rapport à l’enum  DayOfWeek
  • Hours
  • document (boolean) ce champ est utile seulement pour indiquer si le document que l’on met en favoris doit être actif ou non

J’ai créé un webpart pour gérer cette partie comme ça l’utilisateur est toujours maitre de ses choix. On a choisi de mettre a jours tous les favoris avec les nouveaux paramètres de l’utilisateur a chaque fois qu’il les sauvegarde.

Les requêtes  CAML utilisées se trouvent dans une liste de filtre

  • FilterID
  • FilterName nom du filtre
  • CAML les différentes requêtes

les filtres utilisés sont les mêmes que ceux de base de l’alert me.

  • Quand on veut tout les changements la requête est simple puisqu’il ne faut pas mettre de CAML mais un espace.
  • Quand on veut être informé seulement des changements fais par les autres voila la CAML

<Query><Neq><Value type=’string’>{0}</Value><FieldRef Name=’Editor/New’/></Neq></Query> {0} est égal au nom de l’utilisateur qui fait le favoris.

  • Quand on veut être informé des changement fais les autres sur un document où j’étais le dernier ç avoir modifié quelque chose, on utilise ce CAML :

<Query><And><Eq><Value type=’string’>{0}</Value><FieldRef Name=’Editor/Old’/></Eq><Neq><Value type=’string’>{0}</Value><FieldRef Name=’Editor/New’/></Neq></And></Query> {0} est égal au nom de l’utilisateur qui fait le favoris

La dernière liste que j’ai créé est celle utilisé pour afficher la liste des favoris que l’utilisateur a.

  • Title nom du favoris affiché
  • UserName nom du user
  • documentid guid du document
  • Enable true si le favoris est actif (valeur par défaut : false)

Voila toutes les listes sont prête à être utilisée.

La façon dont on ajout un document au favoris de l’utilisateur est très simple, on a une liste qui affiche des documents en fonction d’une recherche et sur chaque document on a un menu style sharepoint dans lequel on a ajouté une entrée « Ajouter aux favoris ». En cliquant sur le lien on passe en paramètre l’id du document au système d’ajout de favoris.

Maintenant on va lier le tous avec un peu de code mais pas trop sinon c’est pas facile à digérer 😉

SPListItemCollection listItems = SPContext.Current.Web.Lists[docLibraryNameFav].Items;
SPListItem splistItem =
listItems .Add();
splistItem[« 
UserName« ] = user;le type de user est SPUser
splistItem[« FicheID« ] = ID;id du document
splistItem[« Title »] = GetFicheElement(ID, « Title »).ToString();ici je génère un titre
Utility.ExecuteUnsafeUpdates(() => splistItem.Update());

ici on vient de créé une nouvelle entrée dans les favoris mais on doit encore créé l’alerte. Il faut aussi récupérer les paramètres de l’utilisateur pour les appliquer à l’alert.

userParam est l’objet qui contient les paramètres de l’utilisateur

SPAlert alert = user.Alerts.Add();
alert.AlertType = SPAlertType.Item;
alert.Item = item;
ici l’item c’est un SPListItem qui représente le document suivi
alert.EventType = SPEventType.All;
alert.AlertFrequency = userParam.Frequency;
if (userParam.Frequency != SPAlertFrequency.Immediate)
alert.AlertTime = userParam.ATime;
on calcule la date à laquelle l’alerte est envoyer
alert.User = user;
if (userParam.IsEnable(item.Title)) 1
alert.Status = SPAlertStatus.On;
else
alert.Status = SPAlertStatus.Off;
SPAlertTemplate spat = new SPAlertTemplate();
spat.Name = « SPAlertTemplateType.DocumentLibrary »;
alert.AlertTemplate = spat;
alert.Filter = userParam.Filter.Filter;
alert.Title = « Titre de l’alerte »
;
alert.Update(false);
if (userParam.IsEnable(item.Title)) 2
ChangeStatusChapter(
documentID, user, item.Title, SPContext.Current.Web.ID, true);

  1. Cette fonction test si l’alerte doit être activée ou non, grâce aux paramètres de l’utilisateur
  2. Si l’alerte est active on change le statut du favoris à true

Dernier point, dans mon interface j’ai un tableau affichant la liste des favoris qui sont associés à mon compte. Chaque ligne comporte une étoile jaune pour actif ou grise pour inactif, quand on clique dessus le statut de l’alerte et du favoris changent. J’ai réalisé ça avec  un peu de code WCF et un peu de javascript mais j’expliquerai ça une prochaine fois.

J’attends vos commentaires constructif avec impatience. 😉

Référence vers l’article que j’ai utilisé.

How to create SharePoint alerts for lists or list items programmatically du blog The SharePoint’s Live for Me de Jérôme Noirfalise

Publicités
%d blogueurs aiment cette page :