Module de personnalisation des e-mails de notification

Ce module vous offre la possibilité d'être complètement autonome pour personnaliser le contenu et l’apparence des emails d'alerte de workflow sur tous les types de publication de votre site :

  • Modification du titre et de la description de l’alerte (et donc du sujet et du corps du mail) en pouvant y insérer la valeur des champs du contenu en question
  • Modification de l’en-tête et du pied de page de l’e-mail

Il permet également de personnaliser des emails à destination d'utilisateurs non identifiés sur votre site (exemple : envoi d'email de confirmation de demande d'inscription à votre site).

Module Module de personnalisation des e-mails de notification- Illustration

Thèmes : Contribution, Notification
Version 1.2
Compatibilité : JCMS 9, 10

Documentation

Personnalisation des emails de workflow

La personnalisation est applicable sur le niveau ACTION (actions entrantes) et sur le niveau INFO (actions sortantes) des notifications emails.

Elle concerne tous les types d’action ci-dessous :

 workflowcustommailerplugin 1

 

La personnalisation est multilingue.

 

L’outil est accessible pour des administrateurs techniques et fonctionnels sous 2 entrées :

  • Dans l’espace de travail, onglet "Administration" dans le bloc Configuration ou via un sous-onglet spécifique "Mails de workflow"
  • Dans l’espace d’administration technique via le bloc "Organisation" 

 

L’administrateur fonctionnel peut créer, modifier, supprimer une personnalisation sur l’espace de travail courant.

L’administrateur technique peut créer, modifier, supprimer une personnalisation sur l’espace de travail courant ET sur l’ensemble des espaces de travail depuis l’administration technique du site.

  

workflowcustommailerplugin 2

Espace de travail

  

workflowcustommailerplugin 3

Espace d’administration technique

 

L’interface de gestion des mails de workflow se décompose en deux parties :

  • Une zone listant l’ensemble des personnalisations créées, activées ou désactivées
  • Une zone de création de nouvelle personnalisation proposée en 2 étapes

  

workflowcustommailerplugin 4

Interface de gestion des personnalisations des mails de workflow

 

Les personnalisations affichées sont celles de l’espace de travail courant indiqué dans le titre de l’interface. Dans l’écran ci-dessus, nous visualisation les mails de l’espace de travail par défaut. Les nouvelles personnalisations créées depuis cette interface seront effectives pour cet espace également.

 

L’interface de création d’une personnalisation est structurée en deux sections :

1. « Sélection des critères de personnalisation » 

Les critères de personnalisation (sauf le type de publication sélectionné) restent à tout moment modifiables dans la section suivante.

2. « Définition du mail personnalisé »

Cette section apparaît une fois la section « Sélection des critères de personnalisation » entièrement renseignée et validée.

 

1. Section « Sélection des critères de personnalisation »

Cette section permet d’indiquer au système quelle alerte et donc quel mail doit être personnalisé. Pour cela, plusieurs critères obligatoires doivent être renseignés.

  

workflowcustommailerplugin 5

Sélection des critères de personnalisation

 

DESCRIPTION

1

Sélection d’un type de publication (Contenu, Contenu utilisateur, Portlet, Formulaire) autorisé dans l’espace de travail courant.

2

Sélection du workflow associé au type de contenu.

Ce champ reste grisé si aucun workflow n’est associé au type de publication sélectionné. Un message d’avertissement s’affiche :

 workflowcustommailerplugin 6

3

Sélection d’un état du workflow sélectionné pour lequel vous souhaitez appliquer une personnalisation.

4

Sélection du type d’action (entrante / sortante / ou les deux) pour lequel vous souhaitez personnaliser l’email.

5

Sélection de la cible d’utilisateurs destinataire de l’email.

 

 2. Section « Définition du mail personnalisé »

Cette section permet de personnaliser le contenu de l’email (en-tête, corps et pied de page).

Elle se divise en 4 parties :

  • Critères de personnalisation
  • Style général de l'email
  • Personnalisation du contenu de l'email
  • Paramétrages

 workflowcustommailerplugin modification des critères de personnalisation

Définition du mail personnalisé – Critères de personnalisation

 

 

WorkflowcustomMailerplugin Style général de l'email

Définition du mail personnalisé – Style général de l’email

 

workflowcustommailerplugin 7

Définition du mail personnalisé – Personnalisation du contenu de l’email

 

 workflowcustommailerplugin 8

Définition du mail personnalisé – Paramétrages

 

DESCRIPTION

1 Choix de la largeur de l’email en pixels. Par défaut la largeur proposée de l’email est à 600px (taille recommandée).
2 Permet de centrer le contenu de l’email. Si la valeur est « Non », le contenu du mail sera aligné à gauche.
3 Permet de définir une couleur de fond de derrière le contenu de l’email.

4

Permet d’ajouter une bordure encadrant la zone de contenu du mail. Il est ensuite possible de déterminer l’épaisseur (en pixel) et la couleur de la bordure.

5

Choix de la langue d’édition de cette personnalisation. Si vous avez des contenus multilingues, vous avez la possibilité de créer plusieurs personnalisations (1 par langue) pour adapter le contenu des emails.

Remarque : la langue par défaut du site est obligatoire

6

Ce champ a pour vocation d’insérer dans les différents blocs de contenu de l’email (titre, en-tête, description, pied de page), des informations issues du type de publication sélectionné : champs du contenu, extensions, ExtraData et ExtraDBData, Dates, Workflow, Métadonnées du contenu, etc.

L’insertion de ces données dans les différents blocs de contenu (titre, en-tête, description et pied de page) se fait via la syntaxe suivante : « [ » + position du champ dans la liste des champs sélectionnés + « ] »

Exemple :

Champs de la publication sélectionnés :

 workflowcustommailerplugin champs de la publication 1workflowcustommailerplugin champs de la publication 2

  • Pour utiliser le titre du contenu, insérer « [1] »
  • Pour utiliser le résumé, insérer « [2] »
  • Et ainsi de suite…

Remarque : Les informations entre parenthèses présentes dans la liste déroulante pour certaine valeur indique ce qui sera affiché dans l’e-mail. Elles concernent généralement les champs impliquant une liaison avec d’autres publications.

7

Ce champ permet d’insérer en pièces jointes de l’e-mail un ou plusieurs documents et DB document (documents en base) issus du type de publication sélectionné :

WorkflowCustomMailerPlugin 7

8

Titre de l’alerte et sujet du mail.

Remarque : il est fortement déconseillé d’insérer un « Champs de la publication » qui est à valeur multiple.

9

Permet de personnaliser l’en-tête du mail. Si la valeur est « non », le mail conservera l’en-tête standard des notifications.

10

Permet de personnaliser la zone centrale (description) du mail.

Remarque : Le champ est obligatoire dans la langue par défaut du site uniquement. Si vous êtes sur un site multilingue et que le champ description de votre personnalisation n’est pas renseigné dans les autres langues, votre personnalisation ne sera pas appliquée pour ces autres langues (les notifications par défaut de JCMS seront envoyées).

11

Permet de personnaliser le pied de page du mail. Si la valeur est « non », le mail conservera le pied de page standard des notifications.

12

Sélection du format des dates qui sera appliqué aux dates sélectionnées dans le champ « Champs de la publication ».

13

Séparateur pour les champs à valeur multiple. Si vide, les valeurs seront présentées sous forme de liste à puce.

14

Si la personnalisation est activée, la personnalisation est tout de suite appliquée et utilisée dans l’alerte. Si vous ne l’activez pas tout de suite, celle-ci apparaitra dans votre liste de personnalisation mais ne sera pas appliquée.

15

Afin de vérifier que l’alerte et le mail associé répondent à votre besoin fonctionnel et esthétique, vous pouvez tester votre personnalisation en utilisant le mode brouillon.

  • Oui : une version en mode brouillon de cette personnalisation sera créée (celle-ci ne remplacera pas une personnalisation déjà publiée pour ce type de contenu)
  • Non : cette personnalisation remplacera celle déjà publiée pour ce type de contenu. Si une personnalisation en mode brouillon existe pour ce type de contenu, elle sera automatiquement supprimée.

16

En activant le mode brouillon, un nouveau champ à valeur multiple apparaît afin de saisir le(s) membre(s) destinataire(s) du brouillon :

 workflowcustommailerplugin 9

 

Interface de personnalisation technique :

L’interface de personnalisation technique (accessible depuis l’espace d’administration technique de JCMS) est identique néanmoins certaines règles fonctionnelles changent :

  • La personnalisation s’applique à tous les espaces de travail
  • Le champ « Type de publication » affiche tous les types de publications du site
  • Le champ « Workflow » affiche tous les modèles de workflows du site

L’administrateur technique peut donc créer une personnalisation générique, sur un type de contenu pour l’intégralité des espaces de travail du site.

 

Priorisation des personnalisations :

Les critères de personnalisation paramétrés le plus finement seront prioritaires sur les autres personnalisations.

Exemple : Une personnalisation sur le type « Article » sur un espace de travail précis est prioritaire par rapport à une personnalisation sur le tous les types de contenu sur le même espace de travail.

 

Personnalisation pour des internautes anonymes ou membres non connectés

En natif, JCMS ne gère pas l’envoi de notification à des membres non connectés ou à des internautes anonymes.

Ce module permet de gérer l’envoi automatique d’email personnalisable pour des soumissions de formulaires de membres non connectés ou internaute anonyme.

Exemple : formulaire d’inscription « Confirmation de votre inscription »

 

Pour gérer l’envoi d’un mail personnalisé pour un internaute anonyme, un champ spécifique « Champ mail du formulaire » est affiché dans la section de définition du mail personnalisé après avoir sélectionner le type « Formulaire » dans la section de sélection des critères de personnalisation :

 workflowcustommailerplugin anonyme

Il vous suffit de préciser le champ email de votre formulaire dans lequel les internautes anonymes doivent renseigner leur adresse email pour que votre personnalisation leur soit envoyée. Assurez-vous par ailleurs d'avoir paramétrer dans le workflow sélectionné l'action "Prévenir le rédacteur" sur l'état désiré.

 

Informations techniques

Compatibilité JSync

Ce module est compatible jSync, il fonctionnera sans problème sur un environnement à plusieurs réplicas.

 

Compatibilité JDK

Ce module est compatible avec la version 1.7 de JDK (Java Development Kit). Si vous êtes sur la version 1.6 de JDK, contactez-nous.

 

Prérequis

Pour une meilleure compréhension et utilisation de ce module, il est conseillé d’avoir suivi les formations JCMS suivantes :

  • Formation d’administrateur technique
  • Formation d’administrateur fonctionnel

 

Installation du module

Ajouter ce module avec le gestionnaire de modules depuis l’administration technique.

Une fois le module déposé, redémarrez deux fois le site.

 

Paramétrage

Liste des propriétés

Aucune propriété à paramétrer pour ce module.

  

Exemples de modèle de personnalisation

Article passant dans l’état publié

Ci-dessous un exemple de mail sans le Header et Footer personnalisés.

 workflowcustommailerplugin 10

 

Code source de la Description :

<div class="wysiwyg classic"><p>Bonjour [3]</p><p>Votre article « [1] » que vous avez créé le [2] vient d'être publié sur le site.</p><p>Vous pouvez le consulter en <a href="[5]">cliquant ici</a>.</p><p>Cordialement,</p><p>L'équipe contributeur WISEN </p></div>

 

Formulaire d’inscription en mode anonyme

Ci-dessous un exemple de mail avec un en-tête et pied de page personnalisés :

 workflowcustommailerplugin 11

FAQ

L’insertion des valeurs dans ces champs se fait via la syntaxe suivante : « [ » + position du champ dans la liste des champs sélectionnés + « ] »
workflowcustommailerplugin champs de la publication 1 workflowcustommailerplugin champs de la publication 2

Exemple :

  • Pour insérer le « Titre » : insérer [1] dans le champ
  • Pour insérer le « Résumé » : insérer [2] dans le champ

Un contrôle est en place pour empêcher la création de personnalisations identiques dans un même espace de travail. Un message est affiché dans le bloc d’ajout d’une nouvelle personnalisation :
workflowmailerplugin FAQ3

Par ailleurs, des personnalisations identiques peuvent être créées sur différents espaces ou depuis l’administration technique (personnalisation pour le site). Pour ce dernier cas, les critères de personnalisation paramétrés le plus finement seront prioritaires sur les autres personnalisations.
Exemple : Une personnalisation sur le type « Article » sur un espace de travail précis est prioritaire par rapport à une personnalisation sur le tous les types de Contenu sur le même espace de travail.

Le mode brouillon permet de tester une personnalisation avant de l’utiliser sur votre site en l’envoyant à des membres déterminés.
L’activation et désactivation vous permet d’appliquer ou de ne plus appliquer la personnalisation en lieu et place des notifications standard Jalios à tout moment.

Lors de la création d’une personnalisation, il est possible que vous tombiez sur un message d’information vous indiquant qu’aucun workflow n’est associé à la publication sélectionnée. Pour utiliser la personnalisation de mail, les types de publication doivent obligatoirement être paramétrés sur un workflow étant donné que l’on utilise le système d’alerte de JCMS. Pour paramétrer un workflow sur votre publication, il vous faut aller dans l’administration de l’espace courant, puis Types de publication et paramétrer un workflow sur le type désiré :
workflowmailerplugin FAQ2

Oui. L’interface accessible depuis l’espace d’administration technique de JCMS est identique que celle accessible depuis les espaces de travail, néanmoins certaines règles fonctionnelles changent :

  • La personnalisation s’applique à tous les espaces de travail
  • Le champ « Type de publication » affiche tous les types de publications du site
  • Le champ « Workflow » affiche tous les modèles de workflows du site.

L’administrateur technique peut donc créer une personnalisation générique, sur un type de contenu pour l’intégralité des espaces de travail du site.

Ces informations vous indiquent ce qui sera affiché dans l’email si vous insérez ce champ dans votre personnalisation. Elles sont affichées pour les champs qui impliquent une liaison avec d’autres contenus (contenus liés, illustration ou image du contenu, documents associés, etc.) pour savoir quelle valeur de champ du contenu lié est remontée.
Exemple pour le champ illustration ci-dessous, si vous l’insérer via la balise [ ] avec le numéro du champ associé, la valeur affichée sera le chemin d’accès à l’illustration sur le serveur. Pour les contenus liés, la valeur affichée sera le titre de chaque publication :
WorkflowCustomMailerPlugin FAQ champs du contenu

Le premier permet d’utiliser les différents champs du type de publication pour les insérer dans les zones de contenu de votre personnalisation (en-tête, description et pied de page).
Tandis que le second permet d’insérer directement en pièces jointes de l’email des documents :
WorkflowCustomMailerPlugin FAQ pj

Il est possible d’utiliser les images, médias et documents de différentes manières dans les zones de textes riches.
Par défaut, si vous insérer directement la balise [ ] avec le numéro concerné dans la zone de texte riche, la valeur qui sera affichée dans l’e-mail est précisée entre parenthèses dans la liste déroulante (exemple : chemin Upload, titre de la publication, etc.).
D’autres usages sont possibles mais nécessite de passer par le code source HTML du champ (bouton « Editer le code source HTML ») :
WorkflowCustomMailerPlugin FAQ wysiwyg

Vous pouvez créer un lien vers le contenu en utilisant la balise HTML suivante :
<a href="[numéro du champ]">Texte cliquable dans l’email</a>
Pour des images, vous pouvez également les intégrer directement dans la zone de texte en utilisant la balise :
<img src="[numéro du champ]" alt="">

Remarque :
Attention, l’insertion d’un lien ou d’une image dans la zone fonctionne uniquement si le champ n’est pas à valeurs multiples.



Journal des changements

Ajout d'un champ permettant d’insérer en pièces jointes de l’e-mail un ou plusieurs documents et DB document (documents en base) issus du type de publication sélectionné.

Ajout de la possibilité de modification des critères de personnalisation lors de l'édition.




Glossaire

A

ACSII

L'American Standard Code for Information Interchange (Code américain normalisé pour l'échange d'information), plus connu sous l'acronyme ASCII ([askiː]) est une norme de codage de caractères en informatique ancienne. Le jeu de caractères codés ASCII est le principal système qui a permis l'échange de textes en anglais à un niveau mondial, limitant ainsi l'usage des langues locales au travers d'extensions régionales.

Actions entrantes & actions sortantes

Ces actions sont paramétrables dans les workflows. Elles définissent l’entrée ou la sortie d’un état de workflow. Une action entrante signifie l’arrivée dans un état du workflow (ex : une publication qui est planifié). Une action sortante signifie la sortie d’un état vers un autre (ex : une publication qui passe de l’état planifié vers l’état publié).

C

Classe

En programmation orientée objet, une classe définie un ensemble d’objets ayant des attributs communs, et le même ensemble d'opérations.

J

Jsync

Jsync est un moteur de réplication des données et des fichiers. La tâche principale de JSync est de synchroniser les données d'un groupe de serveurs JCMS (aussi appelés réplicas), et de répartir la charge de ces serveurs. Ainsi, toute création, modification ou suppression de données (catégorie, membre, contenu, …) sur l'un des réplicas sera propagée par le réplica leader aux réplicas membres du groupe. JSync assure ainsi la cohérence globale des données d'un groupe de serveur JCMS. Ajouter un lien vers la fiche jsync sur jalios.com.

L

LOG

Correspond à un historique d’évènements stockés dans un fichier, appelé fichier de log (diminutif de logging), permettant de suivre et repérer toutes activités du site. Les évènements sont horodatés et ordonnés en fonction du temps.

LOG4J

Log4j est une bibliothèque de log en Java. Elle permet entre autres de gérer plusieurs niveaux de log :
- FATAL: utilisé pour journaliser une erreur grave pouvant mener à l'arrêt prématuré de l'application
- ERROR: utilisé pour journaliser une erreur qui n'empêche cependant pas l'application de fonctionner
- WARN: utilisé pour journaliser un avertissement, il peut s'agir par exemple d'une incohérence dans la configuration, l'application peut continuer à fonctionner mais pas forcément de la façon attendue
- INFO: utilisé pour journaliser des messages à caractère informatif (nom des fichiers, etc.)
- DEBUG: utilisé pour générer des messages pouvant être utiles au débogage
- TRACE: utilisé par exemple pour journaliser l'entrée ou la sortie d'une méthode

M

MailPolicyFilter

Il s’agit d’un point de débranchement (hook) intervenant lors de l’envoi d’un e-mail dans JCMS. Plus détails ici.

N

Notifications email

Il s’agit de notifications transmises par email à un ou plusieurs utilisateurs JCMS. Ces emails permettent d’alerter, informer ou d’envoyer un rappel aux utilisateurs concernant un évènement passé ou à venir, d’une action traitée ou à traiter. Sous JCMS, il existe 3 types de notification : INFO, ACTION, ALERTE.

P

Portail

Un portail permet d’agréger et de personnaliser des informations de provenances multiples pour en offrir une vision unique. On distingue les portails documentaires étroitement liés à la gestion de contenu, et les portails d’infrastructure liés à des problématiques d’intégration d’applications.

Portlet

Elément de portail. Il existe différents types de portlets : - portlets de construction de page
- portlets de contenu (en charge de récupérer et de formater l'information),
- portlets de navigation,
- portlets fonctionnelles,
- portlets de log.
L'assemblage des différents types de portlets permet de construire des gabarits de page portail.

S

Store

Fichier .xml stockant des données sur les publications, les portlets, les espaces de travails, et d'autres fonctionnalités propres à JCMS. Certaines données de l'application peuvent aussi être stockées en base.

Voir les contenus liés :
- Fiche "Utiliser le store" (fiche Jalios ou Wisen)
- Fiche "Nettoyer le store" (fiche Jalios ou Wisen)
- Autre entrée de glossaire

T

Top-bar

La top-bar ou super-header correspond à la barre de menu affichée en haut de page : topbar

W

Wiki

Le wiki est une site Web ou page web collaborative dont le contenu peut être modifié par les internautes autorisés.

Workflow

Les circuits de validation (ou workflow) permettent de gérer les cycles de vie des contenus dans l’outil. Ils sont paramétrables et personnalisables par contenu.

Wysiwyg

WYSIWYG (What You See Is What You Get), en français « ce que vous voyez est ce que vous obtenez », s'applique aux éditeurs de texte et outils de présentation qui permettent d'éditer directement un contenu sous la forme qui sera affichée aux utilisateurs finaux.