Guide technique - Personnalisation des emails de notification
Goodflag Signature permet de personnaliser les emails de notification envoyés aux utilisateurs au cours d'un processus de signature ou de validation. Ce guide permet au référent technique ou à l'intégrateur de votre organisation de configurer et personnaliser ces modèles d'emails.
1. Objectif
Cette personnalisation des notifications email émises par la plateforme Goodflag, permet de :
- adapter les messages à la charte graphique de votre organisation ;
- personnaliser les textes affichés ;
- intégrer des informations métier ;
- afficher les métadonnées d'un parapheur ;
- modifier la mise en page HTML des notifications.
Les modèles de notification sont regroupés dans un fichier JSON pouvant être personnalisé puis réimporté dans la plateforme :
2. Les modèles de notification
Chaque type de notification possède son propre modèle.
Exemples :
| Modèle | Description |
|---|---|
signatureInviteEmail | Invitation à signer |
signatureFinishedEmail | Signature effectuée |
signatureRefusedEmail | Signature refusée |
signatureUninviteEmail | Signature annulée |
approbationInviteEmail | Invitation à valider |
approbationFinishedEmail | Validation effectuée |
approbationRefusedEmail | Validation refusée |
workflowStartedEmail | Démarrage d'un workflow |
Chaque modèle comporte deux propriétés :
{
"subject": "...",
"content": "<html>...</html>"
}
- subject : objet de l'email ;
- content : contenu HTML du message.
3. Le moteur de templates
Les notifications utilisent un moteur de templates reposant sur une syntaxe de type Handlebars.
Les variables sont insérées entre doubles accolades.
Exemple :
{{notification.creatorName}}
Les blocs conditionnels utilisent la syntaxe suivante :
{{#if workflow.data1}}
...
{{/if}}
4. Variables disponibles
Informations de la notification
Les informations relatives au workflow sont accessibles via l'objet notification.
Exemples :
{{notification.creatorName}}
{{notification.workflowName}}
{{notification.linkUrl}}
Ces variables sont utilisées dans les modèles fournis par défaut avec Goodflag.
Métadonnées du parapheur
Les métadonnées configurées dans Workflow Manager sont accessibles depuis l'objet workflow.
Par exemple, avec la configuration suivante :
{
"data1": {
"name": "Safe name",
"type": "text"
}
}
la valeur peut être affichée avec :
{{workflow.data1}}
Si la valeur saisie est :
Safe name test
l'email affichera :
Safe name test
Les métadonnées ne sont pas accessibles directement avec :
{{data1}}
ni avec :
{{notification.data1}}
La bonne syntaxe est :
{{workflow.data1}}
5. Affichage conditionnel
Il est possible d'afficher une information uniquement lorsqu'une métadonnée possède une valeur.
Exemple :
{{#if workflow.data1}}
Nom du coffre :
<strong>{{workflow.data1}}</strong>
{{/if}}
Si la métadonnée n'est pas renseignée, le bloc n'est pas affiché.
6. Exemple complet
Supposons les métadonnées suivantes :
| Identifiant | Libellé |
|---|---|
| data1 | Nom du coffre |
| data2 | Code |
| data3 | Commentaire |
| data4 | Confirmé |
| data5 | Région |
| data6 | Département |
Le modèle suivant :
<p>
Bonjour,
</p>
<p>
Vous êtes invité à signer le document :
<strong>{{notification.workflowName}}</strong>
</p>
{{#if workflow.data1}}
<p>
Nom du coffre :
<strong>{{workflow.data1}}</strong>
</p>
{{/if}}
{{#if workflow.data2}}
<p>
Code :
<strong>{{workflow.data2}}</strong>
</p>
{{/if}}
{{#if workflow.data3}}
<p>
Commentaire :
<strong>{{workflow.data3}}</strong>
</p>
{{/if}}
{{#if workflow.data5}}
<p>
Région :
<strong>{{workflow.data5}}</strong>
</p>
{{/if}}
{{#if workflow.data6}}
<p>
Département :
<strong>{{workflow.data6}}</strong>
</p>
{{/if}}
générera automatiquement un email adapté aux informations renseignées dans le parapheur.
7. Personnalisation HTML
Le contenu des notifications est un document HTML complet.
Il est donc possible de personnaliser :
- les couleurs ;
- les polices ;
- les logos ;
- les images ;
- les tableaux ;
- les boutons ;
- les icônes ;
- le pied de page.
Il est vivement recommandé de conserver les liens techniques générés par Goodflag, notamment le lien de signature ({{notification.linkUrl}}).8. Bonnes pratiques
Pour garantir le bon fonctionnement des notifications :
- conserver les variables présentes dans les modèles fournis ;
- tester les modifications sur un environnement de recette avant la mise en production ;
- utiliser les blocs
{{#if}}pour éviter l'affichage d'informations vides ; - conserver une copie des modèles d'origine avant toute personnalisation.
- pour prévenir toute problématique d'encodage, utiliser des accolades triples lorsqu'une variable est intégrée à l'objet de l'email :
{{{variable}}}au lieu de{{variable}}
9. Informations complémentaires
| Expression | Résultat |
|---|---|
{{workflow.data1}} | Affiche la valeur de la métadonnée. |
{{#if workflow.data1}} | Affiche le bloc uniquement si une valeur est présente. |
{{data1}} | Ne retourne aucune valeur. |
{{notification.data1}} | Ne retourne aucune valeur. |
Les métadonnées du parapheur sont accessibles via l'objet workflow.
10. Tableau récapitulatif
| Variable | Description |
|---|---|
{{notification.creatorName}} | Nom du créateur du workflow |
{{notification.workflowName}} | Nom du parapheur |
{{notification.linkUrl}} | Lien sécurisé vers le workflow |
{{workflow.data1}} | Valeur de la métadonnée data1 |
{{workflow.data2}} | Valeur de la métadonnée data2 |
{{workflow.data3}} | Valeur de la métadonnée data3 |
{{workflow.data4}} | Valeur de la métadonnée data4 |
{{workflow.data5}} | Valeur de la métadonnée data5 |
{{workflow.data6}} | Valeur de la métadonnée data6 |
{{log.reason}} | Motif d'un refus de signature (selon le type de notification) |
{{step.validityPeriod}} | Durée de validité de l'invitation |