Personnalisation des e-mails de workflow

Communication

Donnez plus d'intérêt à votre communication en personnalisant vos emails d'alerte et de workflow !

Les bénéfices

Ce module vous offre une totale autonomie et liberté pour personnaliser le contenu et l’apparence des emails d'alerte de workflow sur tous les types de publication de votre plateforme.

Il vous permet de faciliter la lecture et de véhiculer votre identité à travers ces e-mails que vos utilisateurs reçoivent quotidiennement.

Les fonctionnalités

Personnalisation intégrales des e-mails : vous pouvez personnaliser le sujet et le corps du mail, l'en-tête et le pied de page. Vous pouvez insérer des données provenant des contenus directement (contenus standards ou spécifiques) que ce soit des métadonnées textuelles (titre, description, résumé...), des pièces jointes (documents, médias...) ou encore des entrées pointant vers d'autres données (publication, membre, groupe, catégorie). Si vous disposiez déjà d'une structure HTML de vos e-mails, vous pouvez insérer directement le code source ;
Gestion multilingue : vous pouvez personnaliser les e-mails dans les différentes langues actives de votre plateforme ;
Interface de gestion des personnalisations : vous pouvez créer autant de personnalisations que vous le souhaitez, les activer/désactiver selon le besoin (si désactivé, les notifications standards seront utilisées).
Gestion d'envoi à des utilisateurs externes à votre plateforme : vous pouvez gérer l'envoi d'un e-mail personnalisé à des internautes anonymes ou non connectés (exemple : formulaire d’inscription à votre plateforme « Confirmation de votre inscription »).

Captures d'écran

Les clients aiment

Possibilités de personnalisation.

Interfaces de personnalisation et de gestion des e-mails.

FAQ

Comment utiliser les champs image, média et document dans les zones de texte riche de la personnalisation (en-tête, pied de page et description) ?

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 ») : # upload/docs/image/png/2016-11/workflowcustommailerplugin_faq_wysiwyg.png # 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.*

A quoi sert le champ « Documents du contenu à insérer en pièce jointe dans l'email » et quelle(s) différence(s) avec le « Champs du contenu à insérer dans l'email » ?

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 :# upload/docs/image/png/2016-11/workflowcustommailerplugin_faq_pj.png

Qu’indiquent les informations entre parenthèses dans la liste des champs du contenu à insérer ?

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 : # upload/docs/image/png/2016-11/workflowcustommailerplugin_faq_champs_du_contenu.png

Peut-on créer plusieurs personnalisations avec exactement les mêmes critères ?

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 :# upload/docs/image/png/2016-05/workflowmailerplugin_faq3.png # 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.

Y-a-t-il une différence entre l’interface de personnalisation d’un espace de travail et l’interface accessible depuis l’administration technique ?

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.

Pourquoi certaines de mes publications ne sont pas associées à un workflow et comment faire pour les rattacher à un workflow ?

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é :# upload/docs/image/png/2016-05/workflowmailerplugin_faq2.png

A quoi sert le mode brouillon et quelle est la différence avec l’activation et désactivation ?

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.

Comment utiliser les champs du contenu dans l’en-tête, la description et le pied de page ?

L’insertion des valeurs dans ces champs se fait via la syntaxe suivante : « [ » + position du champ dans la liste des champs sélectionnés + « ] »# upload/docs/image/png/2016-06/workflowcustommailerplugin_champs_de_la_publication_1.png upload/docs/image/png/2016-06/workflowcustommailerplugin_champs_de_la_publication_2.png Exemple :# * Pour insérer le « Titre » : insérer [1] dans le champ * Pour insérer le « Résumé » : insérer [2] dans le champ

Informations détaillées

Prérequis 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.

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.

Interface de création et gestion des personnalisations

Pour personnaliser les e-mails, vous devez vous rendre :

dans l’espace de travail, onglet "Administration" dans le bloc Configuration ou via un sous-onglet spécifique "Mails de workflow" si vous êtes administrateur d'un espace
dans l’espace d’administration technique via le bloc "Organisation" si vous êtes administrateur central

Remarque :

Une nouvelle ACL spécifique amenée par le module vous permet de donner le droit de création et de gestion des personnalisations à des contributeurs.

Depuis cette interface, vous pouvez créer autant de personnalisations que vous le souhaitez.

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 paramétrables en standard via les workflows (actions entrantes et actions sortantes).

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.

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 (à gauche)
Une zone de création de nouvelle personnalisation proposée en 2 étapes (à droite)

Les personnalisations affichées sont celles de l’espace de travail courant indiqué dans le titre de l’interface. Les nouvelles personnalisations créées depuis cette interface seront effectives pour cet espace également.

Création d'une personnalisation

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 :

N°	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 :
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.

Remarque :

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.

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

N°	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 : 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 s'affiche uniquement si vous avez sélectionné une donnée de type "Lien vers" pointant vers d'autres publications de la plateforme. Vous avez alors la possibilité de choisir une ou plusieurs métadonnées de ce contenu lié que vous pourrez utiliser dans votre personnalisation au même titre que les autres données. Pour appeler ces données liés, il faut utiliser la règle d'appel suivante : [x1-x2], x1 représentant la position du champ de type lien vers, x2 la position de la donnée à insérer.
8	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é :
9	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.
10	Permet de personnaliser l’en-tête du mail. Si la valeur est « non », le mail conservera l’en-tête standard des notifications.
11	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).
12	Permet de personnaliser le pied de page du mail. Si la valeur est « non », le mail conservera le pied de page standard des notifications.
13	Sélection du format des dates qui sera appliqué aux dates sélectionnées dans le champ « Champs de la publication ».
14	Séparateur pour les champs à valeur multiple. Si vide, les valeurs seront présentées sous forme de liste à puce.
15	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.
16	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.
17	En activant le mode brouillon, un nouveau champ à valeur multiple apparaît afin de saisir le(s) membre(s) destinataire(s) du brouillon :

L’interface de personnalisation accessible depuis l'administration centrale 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 central peut donc créer une personnalisation générique sur un type de contenu pour l’intégralité des espaces de travail du site.

Personnalisation pour des internautes anonymes ou membres non connectés

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 :

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é.

Ajoute la possibilité dans une personnalisation de sélectionner l'auteur du changement d'état de workflow

Ajoute la possibilité dans une personnalisation de sélectionner un champ de type "E-mail" qui sera utilisé comme destinataire (bypass les rôles)

Exemple : pour une candidature à une offre d'emploi, envoi du mail à une adresse e-mail définie dans l'offre d'emploi au lieu des acteurs de l'état de workflow

Refonte de l'interface de création d'une personnalisation
- Possibilité d'insérer dans les e-mails les entrées de type "Lien vers" ou une entrée pointant vers une donnée (Membre, Groupe, Catégorie)
- Il peut s'agit de champs standards JPlatform, d'extension, d'extraData et autres métadonnées
Ajout d'ACL : ajout d'une ACL d'espace de travail et pour l'administration technique "Mails de workflow"
Correctif sur les champs énumérés : ce correctif permet de remonter le libellé du champ et non sa donnée technique

Fix NullPointer lorsque le mail est généré depuis une Publication stockée en base de données.

Le script fait une requête en base de données afin de récupérer tous les attributs d'une Publication mais dans certain cas, la Publication n'est pas encore persistée donc NullPointer. Ajout d'un code qui fait la requête tant que la Publication est null pendant 5 secondes (pause de 100ms entre chaque requête)

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

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é.