Version > 2.11.12

Modèle de courriel pour les cycles

Il est possible de paramétrer le cycle par l'interface afin d'envoyer des courriels lors d'un changement d'état. Les courriels peuvent être définis pour un état ou pour une transition. Si on associe un ou plusieurs courriels à un état, ils seront envoyés à chaque fois qu'un document aura ce nouvel état (quel que soit la transition). Les courriels liés aux transitions seront envoyés lors du passage de la transition.

Soit un document basique associé au cycle de test. Nous prenons comme exemple la famille déclarée dans le fichier wbasictest.ods. Cette famille est associée au cycle 'Cycle de test' défini dans le fichier Class.WDocTest.php - à mettre dans le répertoire '/usr/share/what/FDL' du serveur (voir Création de cycle pour plus de détail). Voici le document de test en édition. Il comprend un rédacteur et un valideur.

Le but est d'envoyer un courriel pour avertir le documentaliste d'archiver le document lorsque celui-ci est validé (passage à l'état validé).

Pour cela on édite le cycle de test et clique sur le '+' de l'attribut 'Modèle de courriel Validé'. Cela affiche le document suivant :

Le modèle de courriel permet de définir l'émetteur, les destinataires et le corps du message.

Définir l'émetteur

L'émetteur doit faire référence à une adresse email valide. Si l'émetteur reste vide, c'est l'adresse de l'utilisateur qui fait la transition qui sera utilisée.

Plusieurs possibilités de choix de l'émetteur sont possibles:

  • adresse fixe : choisir dans la carnet d'adresse une personne. C'est l'adresse mail de cette personne qui sera utilisée. (attribut US_MAIL).L'adresse indiquée doit uniquement contenir l'adresse “pure” : préférez jean.dupont@mail.fr à jean dupont jean.dupont@mail.fr.
  • attribut texte : un attribut du document portant le cycle. Cet attribut doit renseigner une adresse email. Il est possible d'utiliser la notation ':' (TST_MYID:THE_MAIL) pour aller chercher des valeurs sur les documents liés.
  • attribut relation : un attribut de type 'docid' du document portant le cycle. Cet attribut doit renseigner une personne ou un groupe. Ce sera l'attribut 'US_MAIL'/'GRP_MAIL' de la personne/groupe lié à cet attribut qui sera utilisé pour renseigner l'émetteur.
  • attribut paramètre : un attribut paramètre (PARAM) de la famille du document portant le cycle. Cet attribut doit renseigner une adresse email. Il est possible d'utiliser la notation ':' pour aller chercher des valeurs sur les documents liés.
  • attribut cycle : un attribut du document cycle de vie. Cet attribut doit renseigner une adresse email. Il est possible d'utiliser la notation ':'.
  • relation cycle : un attribut de type 'docid' du document cycle de vie. Ce sera l'attribut 'US_MAIL'/'GRP_MAIL' de la personne/groupe lié à cet attribut qui sera utilisé pour renseigner l'émetteur.
  • paramètre cycle : un attribut paramètre (PARAM) de la famille du cycle de vie portant le cycle. Cet attribut doit renseigner une adresse email. Il est possible d'utiliser la notation ':' pour aller chercher des valeurs sur les documents liés.

Définir les destinataires

La définition des destinataires se fait comme pour l'émetteur. Vous pouvez choisir ensuite le mode d'envoi :

  • à : destinataire principal
  • cc : destinataire en copie
  • bcc : destinataire en copie cachée

Définir le sujet

Le sujet est un texte libre. Il peut contenir des parties variables issues du document qui va être envoyé. On notera les attributs (en majuscules) entre crochets. Exemple [BT_APPROVDATE] si le document à un attribut 'BT_APPROVDATE'. La partie entre crochets sera remplacée par la valeur de l'attribut.

Définir le corps du message

Le corps du messages est un texte HTML. Il peut contenir des parties variables qui sont les attributs du document et les paramètres de transitions du cycle. Ces parties variables peuvent être notées de 2 formes :

  1. [MY_ATTR] : cela affichera la valeur brute , c'est à dire la valeur inscrite en base de données.
  2. [V_MY_ATTR] : cela affichera la valeur formatée, c'est à dire telle qu'elle est présentée à l'utilisateur sur l'interface web.

Concrètement, par exemple, la valeur brute d'un énuméré sera la clef, la valeur formaté sera la traduction du libellé. Le barre de menu de l'éditeur de texte propose les différentes possibilités pour les attributs formatés du document. Le commentaire de transition peut être récupéré par le mot clef '[WCOMMENT]'. Les propriétés du document peuvent aussi être affichée : [ID] [TITLE] [CDATE]. Par contre, les [V_ID] ne sont pas possibles; ce ne sont pas des attributs. Seul [V_TITLE] est possible pour afficher un lien vers le document.

Si on utilise les valeurs formatées, des hyperliens peuvent apparaitre dans le courriel à destination du serveur d'envoi. Si vous ne souhaitez pas avoir de liens il faut décocher la case 'avec liens'. Ceci est à faire si vous destinez votre courriel à des personnes extérieures à votre système d'information.

Tout mail sans corps ne sera pas envoyé.

Ajouter des fichiers attachés

Les fichiers attachés font référence à des attributs de type fichier (ou image) du document. Les fichiers seront alors en pièce jointe du courriel. Bien sûr ces attribut peuvent être des listes de fichiers (attribut fichier ou image dans un tableau).

Enregistrer le messages

Depuis la version 2.14.2 de freedom, vous pouvez conserver l'enregistrement du message envoyé. Celui-ci sera stocké dans la famille “message envoyé”. Son profil sera celui du document servant à l'envoi. Pour stocker le message il faut cliquer sur le champ “Enregistrer une copie”.

Ajout de courriel pour les cycles

Une fois le modèle de courriel créé, il faut l'associer au cycle (utiliser les '…' pour sélectionner le modèle. Les envois de courriel sont visibles dans le graphe du cycle avec l'option 'avec les traitements'.

Les modèles de courriels peuvent être associés à un état ou à une transition. Lorsqu'on mets le courriel sur un état il sera envoyé dès que le document changera vers cet état, même si la transition est non définie (cas possible lorsque l'utilisateur 'admin' utilise le cycle).

freedom_2.14/admin/cycle_de_vie/mailtemplate.txt · Dernière modification: 09/03/2010 09:37 (édition externe)