L'objectif des expressions utilisées dans les modèles de message est de pouvoir adapter l'objet ou le corps du message au contexte. Ainsi, dans l'objet même du courriel reçu, le destinataire aura directement des informations sur l'événement.

Il pourra même ouvrir directement l'objet référencé dans CARL Source, grâce aux liens hypertextes.

Attributs de l'entité en paramètre du modèle de message

Ces attributs sont relatifs à l'entité référencée sur le modèle de message.
L'entité n'est pas forcément renseignée pour un message d'indicateur, elle ne l'est jamais pour un message de traitement automatique.

Attributs simples de l'entité

Pour pouvoir afficher la valeur des attributs d'une entité, renseignez le champ "Entité" du modèle de message.

Ensuite, ajoutez à l'objet ou au corps les attributs de l'entité entre accolades.
Les entités et leurs attributs sont consultables dans le dictionnaire.

Exemple :

• Entité = MR (Demande de travaux).
• Objet du message = Vous avez été nommé responsable de la DT {code} créée le {creationDate}.
  → Dans l'objet du message, {code} et {creationDate} seront remplacés respectivement par l'identifiant et la date de création de la Demande de travaux.

Attributs complexes de l'entité

Vous pouvez également afficher la valeur d'attributs d'objets associés à l'entité, de manière indirecte, en écrivant entre accolades les noms des objets hiérarchiques suivis de l'attribut du dernier objet, séparés par des points.
Vous pouvez ainsi descendre en cascade les objets liés.

• Entité = MEASUREPOINT (Point de mesure).
• Corps du message = Une mesure d'un équipement de la responsabilité de {material.supervisor.fullName} est en anomalie.
  → Dans le corps du message, {material.supervisor.fullName} est remplacé par le nom de l'acteur responsable de l'équipement du Point de mesure.

Exemple 2 :

• Entité = MR (Demande de travaux).
• Corps du message = une DT portant sur le point de structure {MR.boxMain.description} est en anomalie.
  → Dans le corps du message, {MR.boxMain.description} est remplacé par le libellé du point de structure de la DT.

Ces expressions sont comparables à celles utilisées dans la définition des indicateurs.

Détail d'un changement d'état

Vous pouvez afficher toutes les informations du changement d'état, qui sont disponibles dans l' historique des états. Il est nécessaire pour cela de connaître le code de l'état (voir Workflow d'états).

Exemple :

• Entité = MR (Demande de travaux).
• Corps du message = la DT {code} a été acceptée par {statusHisto.AWAITINGREAL.changedBy.fullName}, avec le commentaire suivant : {statusHisto.AWAITINGREAL.comment}.

Élément d'une collection liée

Vous pouvez également afficher le détail d'une collection, si vous connaissez la position de l'élément à afficher, en la mettant entre [].

Exemple :

• Entité = WO (Intervention).
• Corps du message = L'intervention de la DT {MRlinks[0].code} a été soldée.
  → Dans le corps du message, {MRLinks[0].code} est remplacé par le code de la première DT reliée à l'intervention.

Élément d'une liste de valeurs

Afin de pouvoir récupérer la description d’une valueList dans un modèle de message, il faut ajouter l’expression suivante : {valueListDesc(<attribut> )}. L’attribut peut aussi provenir d’une autre entité.

Exemples :

• Entité = WO (Intervention).
• {valueListDesc(workPriority)} : affiche le libellé de la priorité de l'intervention.
• {valueListDesc(customer.paymentMethod)} : affiche le libellé du mode paiement de la part du client lié à l'intervention.
• {valueListDesc(customer.mainCustomer.paymentMethod)} : affiche le libellé du mode paiement de la part du client principal lié à l'intervention.

Gestion multi-fuseaux horaires

Dans un contexte international, vous pouvez préciser le fuseau horaire dans lequel vous souhaitez afficher un champ de type Date ou Date-heure dans un modèle de message.

Il est désormais possible d'utiliser une conversion de contexte temporel dans les expressions dynamiques via l'opérateur @<contexte temporel> . Celui-ci permet de convertir une valeur temporelle dans un contexte temporel donné. Autrement dit, il permet par exemple d'exprimer une date-heure dans un fuseau horaire différent.

Le format est :

• {path.to.value[,@[timeZoneId]][,formatType][,formatStyle]}
• {path.to.value[,@{path.to.temporalContext}][,formatType][,formatStyle]}

Quelques exemples utilisables dans des messages sur Occupation

• "La date d'occupation est le : {occupationDate,@[Europe/Brussels]}."
• "La date d'occupation est le : {occupationDate,@{loggedUser.temporalContext}}."
• "La date d'occupation est le : {occupationDate,@[Europe/Brussels],date,dd/MM/yyyy HH:mm:ss VV}."

Quelques exemples utilisables dans des messages sur Travaux

• {WOEndDate,@[Asia/Hong_Kong]} : affiche la date de fin de l'intervention dans le fuseau horaire Asia/Hong_Kong.
• {WOEndDate,@[Asia/Hong_Kong],date,dd/MM/yyyy HH:mm:ss V} : permet d'indiquer également le format de date et heure souhaité.
• {WOEndDate,@{bean.WO.temporalContext}} : affiche la date de fin de l'intervention dans le fuseau horaire de l'intervention.
• {WOEndDate,@{loggedUser.temporalContext}} : affiche la date de fin de l'intervention dans le fuseau horaire de session de l'utilisateur.

Toutes les valeurs temporelles de CARL Source ont leur propre contexte temporel. Par conséquent, si rien n'est précisé dans le template du message, les valeurs temporelles sont affichées dans leur contexte propre.

Pour afficher l'identifiant de la TimeZone (ex : Europe/Paris) avec la valeur temporelle, il faut utiliser un pattern avec le symbole VV. Exemple : dd/MM/yyyy HH:mm:ss VV    

L’utilisation de cette conversion fonctionne également lorsque des opérations sont faites sur les données temporelles : addition, soustraction, etc.

Exemples :

• {bean.deliveryDate} + 10{day} @{bean.supplier.temporalContext} : permet d'exprimer la date de livraison d'une commande, plus 10 jours, dans le fuseau horaire du fournisseur.
• {bean.deliveryDate} + 10{day} @[Europe/Brussels] : permet de préciser un fuseau horaire fixe et prédéfini. Il vous suffit d'écrire l'identifiant du fuseau horaire entre crochet [...].

Lorsque l'on précise un pattern dans les formatages des dates-heures, on peut utiliser les symboles suivants (extrait de la documentation d'ICU http://userguide.icu-project.org/formatparse/datetime)

Liens hypertextes

Vous pouvez inclure dans le corps du message un lien hypertexte vers la fiche de détail de l'élément.

Il suffit pour cela de mettre le texte entre les parenthèses de l'expression : {detailLink()}.

Vous pouvez également préciser l'identifiant du formulaire souhaité, au cas où il y ait plusieurs formulaires (détail et compte-rendu intervention, DT et DT à prendre en compte).    

Exemple 1 :

• Entité = PR (Demande d'achat).
• Corps du message = La demande d'achat {detailLink({code})} a été refusée.
  → Dans le corps du message, {detailLink({code})} est remplacé par le code de la DA, sous forme de lien hypertexte vers la fiche de détail de la DA.

Exemple 2 :

• Entité = WO (Intervention).
• Corps du message = L'intervention {detailLink(this,WOReport_DETId, {code})} est à réaliser.
  → Dans le corps du message, le lien est remplacé par le code de l'intervention, sous forme de lien hypertexte vers compte-rendu de l'intervention.

Lien vers un élément connexe

Vous pouvez aussi inclure dans le corps du message un lien hypertexte vers le détail d'un attribut de l'élément.
Par exemple : le Matériel de la DT, le fournisseur de la commande, etc.

Il suffit pour cela d'indiquer l'attribut dans la parenthèse, suivi du libellé du lien hypertexte : {detailLink(<attribut> ,{valeur libellé})}.

Exemple :

• Entité = MR (Demande de travaux).
• Corps du message = la DT {detailLink({code})} sur le Matériel {detailLink(material,{material.code})} a été prise en compte par l'intervention {detailLink(WO,WOReport_DETId,{code})}.

Expressions spécifiques au modèle de message pour un indicateur

Si le modèle de message est utilisé sur un indicateur, vous disposez de mots clés particuliers.

• {indicator} désigne l'indicateur en question, et l'attribut doit être précisé, par exemple {indicator.description}.
• {indicatorValue} désigne la valeur de l'indicateur.
• {indicatorUser} désigne l'utilisateur éventuellement en paramètre de l'indicateur, et un attribut peut être précisé, par exemple {indicatorUser.fullName}.

Modèle de message pour un traitement automatique

Si le modèle de message est utilisé sur un traitement automatique, vous pouvez faire apparaître les attributs du traitement automatique, comme si cela était l'entité référencée.

Exemple :

• {detailLink({code})} est un lien hypertexte vers le détail du traitement automatique.
• {lastExecution.cronEnd.time} désigne la date et heure de fin de la dernière exécution du traitement.