Modèle e-mail

Liste des modèles d'e-mail utilisables lors de l'envoi d'e-mails (par exemple dans l'option Modèle d'email par défaut de la section GTF).

Pour créer un nouveau modèle, cliquer sur Ajouter.

Informations générales

Les premières options de la création ou édition de modèle d'e-mail sont les informations générales.

Nom : nom du modèle d'e-mail
Contexte : si ce modèle d'e-mail est envoyé dans le cadre des demandes GTF ("Mail des demandes GTF", par défaut) ou dans le cadre d'une "Inscription et récupération de mot de passe"

Le contexte de mail permet de définir le modéle de donnée qui sera utilisé pour générer le mail.

Il n'est pas possible d'en ajouter ou d'en modifier.

Un modèle prévu pour les Mails de demandes GTF, ne sera pas utilisable pour la création de compte par exemple.

L'auto-complétion et l'aide dans la définition change en fonction du contexte.

Définition

Cette seconde partie permet de définir les différentes caractéristiques de l'e-mail.

Destinataire : adresses des destinataires principaux de l'e-mail
Cc : adresse du ou des destinataires en copie de l'e-mail
Cci : adresse du ou des destinataires en copie cachée de l'e-mail
Sujet : objet de l'e-mail envoyé
Message : corps de l'e-mail. Peut contenir du code HTML ainsi que des conditions (voir la section Balises utilisables dans les modèles d'e-mail, ci-dessous).

Créer un modèle d'e-mail

Tous les champs du formulaire peuvent utiliser des balises. Ils sont tous évalués avec le même contexte.

Un exemple fonctionnel est fourni dans la version 2020 de GTF : default-v2020.01.00.

Une infobulle d'aide et un système d'autocomplétion sont en place pour aider l'administrateur à développer les modèles de mails facilement.

Mail aide

Note

Depuis la version 2020 de GTF, il n'y a plus qu'une définition en remplacement de la définition simple et avancée. La définition du body peut se faire en texte brut ou en HTML/AngularJS, ce qui augmente la sécurité de l'application, mais apporte quelques contraintes dans la réalisation de vos modèles de mail. Lors de la mise à jour vers GTF 2020 vos templates de mails seront conservés mais devront être repris.

Balises utilisables dans les modèles d'e-mail

Plusieurs variables sont utilisables dans les champs cités précédemment. Pour les utiliser, elles doivent être entre {{ }}.

Par exemple :

Pour un traitement nommé "SHPtoDWG", {{workspace.name}} donnera "SHPtoDWG"
{{ (order_status_id == 3) && 'Traitement réussi' || 'Echec du traitement' }} signifie que si l'exécution d'un traitement a réussi (l'identifiant de statut est égal à 3), alors on écrit "Traitement réussi", sinon on écrit "Echec du traitement"

Pour utiliser des conditions au sein du message-même, les balises de paragraphes peuvent contenir la directive Angular ng-if, recevant en argument les balises propres aux modèles d'e-mail de GTF.

Exemple :

<p ng-if="order_status_id == 3">Votre demande n°{{order_id}} pour le traitement <strong>{{workspace.name}}</strong> a
	bien été exécutée</p>

<p ng-if="order_status_id != 3">
	Votre demande n°{{order_id}} pour le traitement <strong>{{workspace.name}}</strong> n'a pu être exécutée
	correctement suite à une erreur.<br/>
    Veuillez contactez votre administrateur.<br/>
</p>

Dans le code ci-dessus, le premier paragraphe ne s'affiche que si le traitement a bien été exécuté (l'identifiant de statut vaut 3). Le second paragraphe ne s'affiche que si l'exécution du traitement ne se termine pas par un succès.

En fonction du contexte indiqué, les balises disponibles diffèrent.

Balises pour le contexte "Mail des demandes GTF"

Variable	Description
order_id	Identifiant de la demande
priority_id	Numéro de priorité
order_status_id	Identifiant de l'état de la demande
wk_params	Paramètres de la demande (clé1=valeur1\|clé2=valeur2\|...)
result_url	Url vers le résultat de la demande
result_file	Chemin vers le résultat de la demande
log_url	Url vers les logs de la demande
log_file	Chemin vers les logs de la demande
order_date	Date de création de la demande
execution_date	Date d'éxécution de la demande (tentative la plus récente)
attempt	Nombre de tentatives lors de la dernière exécution
email_notifications	Adresse e-mail des personnes à mettre en copie de cet e-mail (tableau)
email_option_id	Définit dans quel cas il faut envoyer de mail : Toujours Uniquement en cas de succès Uniquement en cas d'erreur Jamais
length_sec	Durée du traitement en secondes (tentative la plus récente)
minexecdate	Date de planification (formatée pour le demandeur)
execution_end_date	Date de fin d'exécution (formatée pour le demandeur)
execution_counter	Nombre d'exécutions de la demande
encryption_key	Clé utilisée pour l'encryptage de la réponse, uniquement si encryption_mode vaut random
encryption_mode	Mode d'encryptage de la réponse, trois valeurs possibles : user : utilisation de la clé de l'utilisateur pour l'encryptage random : utilisation d'une clé générée aléatoirement pour l'encryptage none : pas d'encryptage
workspace.workspace_id	Identifiant du projet
workspace.name	Nom du projet
workspace.description	Description du projet
workspace.dataencrypt	Définit si l'auteur veut encrypter les résultats de ce projet
workspace.usepersonaldata	Définit si le projet utilise des données personelles
workspace.key	Clé unique du projet
workspace.tag	Tag du projet
workspace.author	Auteur du projet
workspace.email_template_id	Identifiant du modèle d'e-mail
workspace.category_name	Nom de la catégorie GTF
user.user_id	Identifiant de l'utilisateur qui lance la demande
user.login	Login de l'utilisateur qui lance la demande
user.email	E-mail de l'utilisateur qui lance la demande
user.company	Société de l'utilisateur qui lance la demande
user.department	Service de l'utilisateur qui lance la demande
user.last_connection	Dernière date de connexion de l'utilisateur qui lance la demande (formatée pour le demandeur)

Balises pour le contexte "Inscription et récupération de mot de passe"

Variable	Description
user.login	Identifiant de l'utilisateur
user.name	Nom de l'utilisateur
user.email	Adresse e-mail de l'utilisateur
user.company	Société de l'utilisateur
properties.hostname	Nom du serveur
properties.admin_sign_up	Adresse e-mail de l'administrateur
properties.automated_sign_up	Définit si l'inscription est en mode automatique ou validation par un administrateur
url	Lien permettant de valider l'étape en cours