Custom Auto-Post rule on Activity Feeds : Be notified on records you follow

In Microsoft Dynamics CRM 2013, Microsoft introduced the Out-Of-The-Box (OOB) Social Pane, with Notes, Activities and Posts, based on Activity Feeds. The behavior of Activity Feeds is just like Twitter, where users can follow or unfollow some records, mention them on post, and see all posts based on records they follow on their personal wall.

Unlike Twitter, Activity Feeds introduced some "Auto Post Rules" on a few of OOB entities ; on a particular event (let's say when a opportunity is won), a post is automatically created on the record. This feature is great because all the followers are automatically aware, by having a look at their wall, that this opportunity is closed.

Nevertheless, it has some drawbacks (I wouldn't write about it otherwise :) ). First, you cannot create an auto post rule manually (by going to Settings / Auto Post Rules / New for instance). You can only enable or disable existing ones. Second, Activity Feeds does not provide a way to notify (by email for instance) the followers of a record when a post is posted on it (like Yammer does).

As I had to provide this kind of functionality on a CRM 2013 project, I will introduce today a way of having the 2 features that are not included in the OOB Activity Feeds : the Custom Auto Post Rules (using no code, always great to fulfill requirements without code) and the Email Notifications to followers (with a little code, always good to fulfill requirements with a little of coding :) ).

Dans la version 2013 de Dynamics CRM, Microsoft a introduit, en standard le composant "Volet Social", permettant de regrouper les Notes, Activités et Publications, basées sur le flux d'activités. Le flux d'activités fonctionne de la même manière que Twitter, où les utilisateurs peuvent suivre ou ne plus suivre des enregistrements, les mentionner dans une publication, et visualiser les publications qu'ils suivent sur leurs murs personnels.

Le flux d'activités a également introduit des règles de publication automatiques sur quelques entités : lors d'un évenement particulier (lorsque une oppportunité est gagnée par exemple), une publication est automatiquement (sans action de l'utilisateur) créée. Cette fonctionnalité est très pratique car elle permet d'avertir automatiquement les abonnés ("followers") depuis leur mur personnel, que l'opportunité est gagnée.

Mais elle comporte tout de même quelques inconvénients (je n'écrirais pas cet article sinon :) ). Tout d'abord, vous ne pouvez pas créer de nouvelle règle manuellement (par exemple en navigant dans Paramètres/ Règles de publications automatiques/Nouvelle règle). Vous avez seulement la possibilité d'activer ou désactiver les règles existantes. De plus, le flux d'activités ne permet pas de notifier (par email par exemple) les abonnés d'un enregistrement lorsque une nouvelle est publiée sur celui-ci (comme Yammer).

Ayant du les implémenter dans un projet sur CRM 2013, je vais présenter dans cet article une méthode permettant d'avoir ces 2 fonctionnalités : les Règles de publication automatique personnalisées (sans développement, toujours agréable de satisfaire des demandes métier sans code) et les Notifications par email aux abonnés (avec un petit peu de développement, toujours agréable de satisfaire des demandes métier avec quelques lignes de code :) ).

So, we are going to enhance the Activity Feeds with the following example : a post is created each time an opportunity has been updated, and all the followers of the opportunity have to be notified by email. The post must contain the user that updated the opportunity.

This article is divided in two parts : Custom Auto Post Rule, where we are going to create the automatic creation of the post and Followers Email Notification, where we are going to notify, by email, all the followers of a record, each time a post (either auto or manual) is created.

Nous allons donc améliorer le flux d'activités avec l'exemple suivant : une publication est créée automatiquement dès qu'une opportunité est mise à jour, et tous les abonnés de l'opportunité sont notifiés par email de la nouvelle.

Cet article est divisé en 2 parties : Règle de publication personnalisées, où nous allons créer la publication automatique et Notification des abonnés par email, où nous allons envoyer un email aux abonnés d'un enregistrement dès qu'une publication (automatique ou manuelle) est créée.

Custom Auto Post Rule

Règles de publication personnalisées

To create an auto post, we are going to use the powerful functionality of workflows. First, we have to notice that each post used by the Activity Feeds engine is carried by the entity 'post'. So, if you create a record on this entity, using the Create step of the workflow with right values, well, you just created your automatic post. Let's see how it goes on our example :

Pour créer une publication automatique, nous allons utiliser la fonctinnalité très pratique des workflows. Tout d'abord, il faut remarquer que chaque publication utilisée par le flux d'activités est portée par l'entité Publication (nom logique "post"). Ainsi, si vous créez un enregistrement de l'entité Publication, en utilisant l'étape "Créer l'enregistrement" dans un workflow, avec les paramètres adéquats, vous avez tout simplement créé une publication automatique. Voyons cela dans notre exemple :

• Create a workflow on the Opportunity entity, named "Opportunity - Auto Post on update" :
  Créez un workflow sur l'entité Opportunité, appelé "Opportunité - Publication automatique lors de la modification" :

This workflow is triggered automatically, when the field "Modified On" is modified. By using these settings, the workflow is triggered each time the opportunity is updated, that was our original goal.

The sequence is in fact really simple, it is just using a single step, that is the creation of a record on the Post entity. The properties of this step are as below :

Ce workflow est déclenché automatiquement, lorsque le champ "Modifié le" est modifié. De cette manière, il sera déclenché à chaque fois qu'une opportunité est mise à jour (qui est notre objectif initial).

La séquence est en réalité très simple, il n'y a qu'une seule étape : la création d'un enregistrement de l'entité Publication. Les propriétés de cette étape sont à paramétrer comme ci-dessous :

Make sure that the Regarding field is set on the Opportunity record. This way, it will appear on the social pane of the record. Notice that if you want to enhance this rule, for example by creating a post on the account related to this opportunity, you can add another workflow step, and set the Regarding field to the account.

Remplissez le champ Concernant avec l'opportunité. Ainsi, il apparaîtra sur le mur de son volet social. Si vous souhaitez améliorer cette règle, par exemple en ajoutant une publication sur le compte associé à cette opportunité, vous n'avez qu'à ajouter une étape de création d'une publication dans le workflow, et remplir le champ Concernant avec le compte.

• Let's have a look about what we have done so far. Activate the workflow and update an existing opportunity (modifying the Budget Amount) :
  Jetons un oeil à ce que nous avons déjà réalisé. Activez le worklow et modifiez l'opportunité (en changeant par exemple le champ Montant budgétaire) :

Before the update of Budget Amount

Avant la modification du champ Montant budgétaire

After the update of Budget Amount

Après la modification du champ Montant budgétaire

You can see here that our post has been correctly created. Using this workflow, every opportunity will have a new post each time it is updated. The post text also indicate the user that modified the record, that was our (indeed quite simple) goal.

Let us discuss a little about this method. You can see that the creation of the post is in fact really simple, because it is basically only a "Create on Post entity" step in a workflow. If you have more complex rules to implement, the key point is to know if you can reach the event by using standard workflow.

For instance, if you want to create a post on a contact every time this contact has been added as a stakeholder to an opportunity, you can do this by creating a workflow on the Connection entity, triggered on Creation, that checks if the Connected From entity is Opportunity and Connected To Contact, and set the Regarding field of the post on Connected To field of the Connection record :

Vous pouvez voir que notre publication a bien été créée. A l'aide de ce workflow, chaque opportunité aura une nouvelle publication à chaque modification. Cette publication indique également l'utilisateur ayant modifié l'enregistrement, qui était également notre objectif initial (certes assez simple).

Discutons un peu de cette méthode. Vous pouvez voir que la création de la publication est assez simple, ce n'est ni plus ni moins qu'un étape "Créer l'enregistrement" sur l'entité Publication. Si vous avez des règles plus complexes à implémenter, le point important est de savoir si vous pouvez atteindre l'événement en utilisant les workflows standards.

Par exemple, si vous devez créer une publication sur un contact à chaque fois qu'il est ajouté en tant que partie prenante sur une opportunité, vous devez créer un workflow sur l'entité Connexion, déclenché à la création. Le workflow doit vérifier que l'entité du champ "Connecté de" est sur Opportunité et que celle sur "Connecté A" est Contact. Et le champ Concernant doit être rempli sur le champ Connecté A de l'enregistrement Connexion :

Workflow on the Connection Creation

Workflow sur la création d'une connexion

Properties of the Creation Post step

Propriétés de l'étape de création de la publication

And when a contact is added as a stakeholder on an opportunity, a post is created on the contact record :

Et lorsque un contact est ajouté en tant que partie prenante sur une opportunité, une publication est créée sur le contact.

Social Pane of the contact, after being added as a stakeholder

Volet Social du contact, après avoir été ajouté en tant que partie prenante

Finally, this kind of method is interesting because really quick to implement and using all the possibilities provided by the workflow engine, to reach a special event, with some conditions.

However, it still has 2 main drawbacks :

En conclusion, cette méthode est intéressante car elle est très rapide à implémenter et peut utiliser toutes les possibilités du moteur de workflow pour atteindre un événement particulier, avec des conditions particulières.

Cependant, elle comporte tout de même 2 inconvénients notables :

• First, even if it is quite powerful, the workflows do not allow to reach all the available events provided by Dynamics CRM. For example, you cannot create a post (using this method) every time a contact is added as a member of a marketing list. If you want to create automatic rules for this kind of event, you must develop a custom plugin.
  Même s'ils sont assez puissants, les workflows ne permettent pas d'atteindre tous les événements disponibles dans Dynamics CRM. Par exemple, nous ne pouvez pas (avec cette méthode) créer une publication dès qu'un contact est ajouté à une liste marketing. Si vous devez implémenter ce genre de règles automatiques, vous devrez développer un plugin spécifique.
• Second, you can see some posts contain hyperlinks, directing to the main form of a record. You can actually create custom posts with these kind of hyperlinks but here again, you have to write some code. See this post How to do Mentions with Activity Feeds, to go further on mentioning with Activity Feeds.
  Certaines publications contiennent des hyperliens, redirigeant sur le formulaire principal d'un enregistrement. Pour créer des publications contenant ce type de liens, vous devrez passer par du développement. Vous pouvez aller lire cet article How to do Mentions with Activity Feeds pour aller plus loin dans la création de publications pour le flux d'activités.

Followers Email Notification

Notification des abonnés par email

If you are using or ever used Yammer, you might like the possibility of being notified on a post/group/subject you follow. Well, if you like it, you cannot do this with Activity Feeds, out-of-the-box. In fact, you cannot even do this using workflows, as workflows does not allow to perform an action on a 1-N relationship (sadly). To do this, you must add a custom plugin (using C#).

Si vous utilisez ou avez déjà utilisé Yammer, vous appréciez peut-être la possibilité d'être notifié sur des publications/groupes/sujets que vous suivez. Et bien, si vous aimez ça, vous ne pouvez pas le faire en standard, avec le flux d'activités. De plus, vous ne pouvez même pas le faire en utilisant des workflows.

The key point here is to add a custom plugin on the Create message of the Post entity. This plugin will first retrieve the regarding record of the post, then retrieve all the followers of the regarding record, and finally send the post message in an email, to all of the followers.

Pour cela, la méthode est d'ajouter un plugin, sur le message Create de l'entité Publication. Ce plugin va tout d'abord récupérer l'enregistrement associé (via le champ Concernant) de la publication, puis récupérer les abonnés ("followers") de l'enregistrement, et enfin envoyer, par email, le contenu de la publication aux abonnés.

Note : The following demonstration will use some C# code, based on the Dynamics CRM SDK. You should be comfortable with classes and methods provided by the SDK, and how to write a CRM plugin, and more generally on how to work with the SDK.

Remarque : La démonstration ci-dessous utilise des exemples de code C#, basé sur le SDK de Dynamics CRM. Il est préférable que vous soyez à l'aise avec les classes et méthodes fournies par le SDK, comment écrire un plugin personnalisé, et de manière générale, comment utiliser le SDK.

1. Retrieve the regarding record 
   Récupération de l'enregistrement concerné

In this step, we are doing nothing more than retrieving the EntityReference associated with the post, with just a few basic plugin controls.
A ce stade, nous ne faisons rien de plus que récupérer l'EntityReference associée à l'enregistrement Publication, avec quelques contrôles de plugin classiques.
2. Retrieving all the followers of the record
   Récupération des abonnés de l'enregistrement

At this stage, we need to retrieve records of the System User entity, so we need to use Query Expression, on the entity 'systemuser'. The key point is the construction of the LinkEntity, based on the entity PostFollow. In fact, the entity 'postfollow' is used by the Activity Feeds to link a user and a record (for example a contact), showing that this user is currently following the record. So, we are here just adding the link between SystemUser and PostFollow, on the field OwningUser. And to retrieve only users that follow the regarding record retrieved in step 1, we just add a condition (on the field RegardingObjectId of the PostFollow entity), to filter PostFollows of this record.
Ici, nous devons récupérer des enregistrements de l'entité Utilisateur, nous allons donc utiliser une Query Expression, sur cette entité. Le point important ici est la construction de la LinkEntity, sur l'entité Suivre ("postfollow"). Cette entité Suivre est utilisée par le flux d'activités pour lier un utilisateur et un enregistrement (un contact par exemple), indiquant que cet utilisateur est abonné à celui-ci. Ainsi, nous ajoutons ici le lien entre les entités Utilisateur et Suivre, à partir du champ Propriétaire ("OwningUser"). Et pour récupérer seulement les utilisateurs abonnés à l'enregistrement de l'étape précédente, nous n'avons qu'à ajouter une condition (sur le champ Concernant de l'entité Suivre).
3. Sending a basic email to the followers
   Envoi d'un email simple aux abonnés

This final step is divided in 3 little steps. First, we create here an activity party per follower, all stored in a List of Entity (all on the entity ActivityParty). It will be used as the recipients of the email notification. Second, we create the email record. In this example, I am just using the strictly necessary inputs : the recipients, constructed at the previous step, the subject and the description, that is the content of the post. You could add here more custom content in the email body (in fact custom HTML, with hyperlinks, colors, fonts, images, sender, adapted subject etc.) but this is out of this article scope. And the final step is, once it's created, to send the email, via the message SendEmailRequest provided by the SDK.

Cette dernière partie est divisée en 3. Tout d'abord, nous créons une "Activity Party" par abonné, toutes stockées dans une liste d'Entity. Cela sera utilisé pour mettre à jour les destinataires de l'email de notification. Ensuite, nous créons l'enregistrement d'email (avec la classe Entity). Dans cet exemple, je n'utilise que le strict minimum pour l'envoi de l'email : les destinataires (créés à l'étape précédente), le sujet et la description de l'email, qui est tout simplement le contenu de la publication. Vous pouvez à ce stade personnaliser davantage le contenu de l'email (en utilisant du contenu HTML, avec hyperliens, couleurs, polices, expéditeur, sujet personnalisé, etc.) mais ce n'est pas le but de cet article. Et enfin, en dernière étape, est d'envoyer l'email que nous avons créé, en utilisant le message SendEmailRequest fourni par le SDK.

Our plugin is now done, we just have to build and register it. And of course, creating the step, in PostOperation of Create of a Post, as below :

Notre plugin est terminé, nous n'avons qu'à le compiler et l'enregistrer. Et pour finir, créer l'étape, sur le message Create de l'entité Publication, en Post Opération, comme ci-dessous :

And you are done ! Let's see as it works, by using the following scenario :

Terminé ! Voyons à quoi cela ressemble, sur le scénario suivant :

• User1 and Boris T. are following the contact John Donahue.
  User1 et Boris T. sont abonnés au contact John Donahue.
• User2 sets John Donahue as a stakeholder of an opportunity.
  User2 ajoute John Donahue en tant que partie prenante sur une opportunité.

So basically, a post is automatically created (because of our Custom Auto Post Rule see above) and User1 and Boris T. are notified, by email, that John Donahue as been set as a stakeholder :

Une publication est donc créée automatiquement, (grâce à notre Règle personnalisée créée dans la première partie) et User1 et Boris T. sont notifiés, par email, que John Donahue a été identifié en tant que partie prenante :

User2 add John Donahue as a stakeholder on an opportunity

User 2 ajoute John Donahue en tant que partie prenante sur une opportunité

An automatic post is added, on John Donahue

Une publication automatique est ajoutée sur le mur de John Donahue

Automated notification, by email

Notification automatique, par email

From CRM, to all the followers

Depuis le CRM, envoi à tous les abonnés

As mentioned before, the content of the email is not optimized, but you can, by enhancing the subject and the description of the email record, set an elaborate notifications engine.

Finally, combined with some strong auto-post rules, the method of Email Notification allows you to keep your users aware of data they care about.

Comme mentionné précédemment, le contenu de l'email généré n'est pas optimal, mais vous pouvez, en améliorant le sujet et la description de l'enregistrement email, avoir un moteur de notifications élaboré.

En conclusion, combinée avec des règles de publication automatiques puissantes, la méthode de notification par email permet à vos utilisateurs d'être toujours au fait des enregistrements qui les concernent.