Format des messages

Nous changeons notre interface. Certaines informations peuvent ne pas être à jour. En savoir plus.

Comme le message d’alerte sortant sera le plus souvent formaté en JSON, il faut respecter ses règles de formattage. Pour ce faire, certains caractères tels que les sauts de ligne ou les guillemets devront être encodés avant de pouvoir être insérés dans le message d’alerte sortant au format JSON. Sinon, ils invalideraient la structure JSON du message sortant, ce qui pourrait amener le endpoint de réception à générer une erreur et à ne pas gérer correctement l’alerte entrante. Cet article passe en revue les fonctions intégrées de formatage automatique des messages.

Appliquer le formatage automatique

Par exemple, si un champ ‘Notes’ du moniteur (que vous pouvez ajouter au message d’alerte à l’aide de la variable système @monitor.notes) contient des caractères tels que des sauts de ligne, des guillemets, …), il briserait la structure JSON du message sortant.

Exemple :
{ "notes": "{{@monitor.notes}}" }
Donnerait :
{ "notes": "Notes du moniteur qui contiennent un saut de ligne ou "une citation"" }

La structure JSON est cassée et entraînera probablement une gestion incorrecte de l’alerte du côté récepteur. Pour résoudre ce problème, il y a une option qui permet de coder (ou décoder) des bouts de texte pour que le format du message JSON ou XML soit respecté. Lors de l’utilisation de cette fonction, tous les caractères qui doivent être échappés afin de garder le JSON valide seront automatiquement encodés.

Pour utiliser cette fonction, encapsulez la variable système ou le texte souhaité avec la syntaxe suivante :
{{@JsonEncode(votre-variable-ici)}}

Par exemple, la variable système Monitor Notes précédemment mentionnée doit être encapsulée comme suit :
{ "Notes": "{{@JsonEncode({{@monitor.notes}})}}"}

Et avec la fonction @JsonEncode, le texte JSON mentionné précédemment et contenant la référence aux notes du moniteur est maintenant résolu comme suit : { "notes": "Notes du moniteur qui contiennent\nun saut de ligne ou \"une citation\"" }

Comme vous pouvez le voir, nous avons maintenant correctement intégré les notes du moniteur, encodées de manière à ne pas casser la structure JSON.

Si vous utilisez XML au lieu de JSON, pas de souci - nous avons une fonction similaire pour l’encodage XML ! Vous pouvez utiliser cette fonction pour encapsuler les variables système de votre choix {{@XmlEncode()}}.

En utilisant ce site, vous consentez à l’utilisation de cookies conformément à notre Politique de cookies.