Nouveau : le pare-feu IA surveille toute la plateforme et explique chaque incident en termes simples. Découvrez comment ça marche

Blocs d’alarme, de commande et de notification

Référence de Raise alarm, Clear alarm, Acknowledge alarm, Send command, Answer device request et Notify, incluant les destinataires d'une notification selon le canal.

Ces blocs agissent sur les personnes et les appareils : ils ouvrent et ferment des alarmes, envoient des commandes, répondent aux demandes propres à un appareil et envoient des notifications. Les blocs d’alarme et de commande exigent un message dont l’émetteur est un appareil ; Notify fonctionne sur tout message.

Lever une alarme

Ouvre une alarme sur l’appareil du message, ou met à jour l’alarme ouverte du même type : une seule alarme ouverte par appareil et par type.

ParamètreSignificationPar défautValeurs
alarmLe type d’alarmeobligatoireun modèle, par ex. tank.{{ msg.metadata.topic }}.low ; lettres, chiffres, _ . : -, 128 caractères au maximum après rendu
severityGravitéwarningcritical, major, minor, warning, info
textTitrele typeun modèle, 256 caractères au maximum
valueConservée dans le détail de l’alarmemsg.payloadun chemin
notify_toQui est prévenupersonneidentifiants d’utilisateurs, adresses e-mail, les rôles OWNER, ADMIN, USER
notify_channelsCanauxchoix de chacunidentifiants de canaux comme inapp, mail
notify_min_severityPrévenir seulement à partir de cette gravitéinfoune gravité
notify_repeat_secRappeler tant qu’elle est ouverte et non acquittéepas de rappel0, ou 60 secondes et plus

out : l’alarme (msgType alarm, l’alarme dans msg.payload). Erreurs : not_a_device, bad_alarm_id. Les notifications suivent le même cycle de vie que les règles d’alarme : limitation de débit, récapitulatif lors d’une tempête d’alarmes, les alarmes critiques contournent les préférences personnelles sauf si votre organisation a désactivé cette option. Une escalade notifie à nouveau ; une nouvelle levée à la même gravité ne le fait pas. Un message tardif ne modifie aucune alarme. Voir Alarm notifications in depth.

Effacer une alarme

Résout l’alarme ouverte d’un type sur l’appareil du message.

ParamètreSignificationValeurs
alarmLe type d’alarmeobligatoire, un modèle

out : l’alarme effacée, ou le message inchangé si aucune alarme n’était ouverte. Les personnes prévenues de l’alarme sont informées qu’elle a été résolue.

Acquitter une alarme

Acquitte les alarmes ouvertes de l’appareil : elles restent ouvertes, les rappels s’arrêtent.

ParamètreSignificationPar défautValeurs
alarmQuelles alarmestoutes les alarmes ouvertes*, un type, ou un préfixe suivi de *
min_severitySeulement à partir de cette gravitéinfoune gravité
noteUne note sur la chronologie de chaque alarmeaucune256 caractères au maximum

Les trois blocs d’alarme produisent des alarmes exactement comme le font les règles d’alarme. Une modification d’alarme qu’ils effectuent est perçue par les déclencheurs Device message à l’écoute de alarm ; un flux qui lève une alarme et écoute aussi les alarmes peut se relancer lui-même, et le déploiement affiche « May start its own flow again ». Voir Working with alarms.

Envoyer une commande

Envoie une commande de la liste de commandes du profil d’appareil à l’appareil du message. Rien n’attend : le message poursuit son chemin avec la requête qu’il a faite ; la réponse de l’appareil arrive plus tard.

ParamètreSignificationPar défautValeurs
commandUne commande de la liste de commandes du profilobligatoire (ou une méthode brute)choisie parmi les commandes de vos profils
paramsLes paramètres de la commandeaucunun objet comme {"on": true}, ou un chemin comme msg.payload
methodUne méthode brute hors de la liste de commandesvidenamespace.verb, 64 caractères au maximum

out : le message avec msg.metadata.rpcId (la requête, visible aussi dans l’onglet Commands de l’appareil) et msg.metadata.rpcStatus (QUEUED, ou FAILED lorsque la commande n’a pu attendre et que l’appareil était hors ligne). Erreurs (aucune requête n’a été faite) :

CodeSignification
not_a_device, device_not_foundNe fait pas partie de vos appareils
unknown_commandLe profil de l’appareil ne contient pas cette commande
bad_paramsLes paramètres ne correspondent pas à la commande (msg.error.param en nomme un)
method_refusedUne réinitialisation d’usine, un appairage ou un oubli du réseau n’est jamais envoyé depuis le cloud
limitTrop de commandes vers cet appareil au cours de la dernière minute (30 par défaut depuis les flux)
device_not_active, rpc_not_supported_by_profile, payload_too_largeComme le dirait la console
  • La commande est recherchée dans le profil de l’appareil de chaque message : un flux desservant plusieurs profils n’envoie qu’à ceux dont le profil possède la commande.
  • La requête est faite au nom du flux et apparaît dans l’historique des commandes de l’appareil comme celles de la console. Une commande à fort impact ne demande aucune confirmation à son exécution : elle a été confirmée au déploiement.
  • Déployer exige l’autorisation d’envoi du niveau de la commande dans chaque profil qui la possède, Deploy flows with control-level nodes pour une commande à fort impact, et l’autorisation RPC brute pour une méthode brute.
  • Un message rejoué ou transmis à nouveau retrouve la requête déjà faite et n’envoie rien de nouveau. Un message tardif n’envoie aucune commande.
  • Chaque requête se termine par un message rpc_response (SUCCESSFUL, FAILED, TIMEOUT, EXPIRED, CANCELLED) portant msg.metadata.rpcStatus, rpcId et requestedBy. C’est un message d’appareil, il atteint donc le flux racine de l’appareil ; acheminez-le à partir de là.

Répondre à une requête de l’appareil

Répond à une requête que l’appareil a envoyée à la plateforme (un message rpc_request : l’appareil appelle une méthode sur le cloud). Les méthodes intégrées getCurrentTime et getSessionLimits sont traitées avant qu’un flux ne voie quoi que ce soit.

ParamètreSignificationPar défautValeurs
resultCe que la méthode renvoiemsg.payloadtoute valeur ; envoyée sous la forme {"ok": true, "result": …}
errorRefuser à la placeaucununsupported_method, bad_params, busy, timeout, expired, forbidden, payload_too_large, internal ; envoyé sous la forme {"ok": false, "error": …}
messageTexte envoyé avec un refusvide256 caractères au maximum, modèles autorisés

La première réponse l’emporte. Lorsqu’aucun flux ne répond dans un délai de 5 secondes, la plateforme répond unsupported_method. Erreurs : rpc_request_closed, not_an_rpc_request, payload_too_large, invalid_value. Un appareil MQTT reçoit la réponse sur v1/rpc/up/res/{id}, un appareil HTTP sur sa requête en attente. Placez ce bloc sur la branche rpc_request du flux racine (le flux racine par défaut se contente de journaliser ces requêtes).

Notify

Envoie une notification et transmet le message.

ParamètreSignificationPar défautValeurs
RecipientsLignes d’un Kind et d’une valeurobligatoire20 lignes au maximum ; 20 destinataires après développement
Repeat reasonCe qui rend deux notifications « identiques » pour le délai de répétitionles mots de la notificationmodèle, 200 caractères
ChannelsLimiter à ces canauxpréférences de chaque destinataireidentifiants de canaux comme inapp, mail, sms, push
Urgencycritical contourne les préférences personnelles sauf si votre organisation a désactivé cette optionnormalnormal, critical
Title, TextLe messagemodèles, 200 et 4 000 caractères
Text formattext, ou html pour le courriertexttext, html
Mail subject, Reply toOptions du courrierle titre, aucunmodèles
Copy, Hidden copyDestinataires supplémentaires du courrier ; chacun reçoit son propre courrieraucunmodèles
Mail attachmentsFichiers joints au courrieraucun10 fichiers, 1 MiB au total

Qui est atteint, sur quel canal

KindValueAtteint
userL’identifiant d’un membreCe membre, dans l’application, par push et dans les applications de discussion liées
roleOWNER, ADMIN ou USERChaque membre actif avec ce rôle, comme ci-dessus
custom_roleUne clé de rôle personnaliséSes membres, comme ci-dessus
teamUn identifiant d’équipeSes membres, comme ci-dessus
originator_ownerVideLes propriétaires de l’émetteur du message, lorsqu’un module les déclare, comme ci-dessus
addressUne ou plusieurs adresses e-mail, séparées par des virgulesE-mail
phoneUn ou plusieurs numéros au format international, séparés par des virgulesSMS

Les membres sont désignés uniquement par leur identifiant utilisateur. Les e-mails et SMS ne sont envoyés qu’aux lignes address et phone. Un membre listé comme user, ou atteint par un rôle, un rôle personnalisé ou une équipe, reçoit la notification dans l’application, par push et dans les applications de chat liées selon ses préférences, mais ni par e-mail ni par SMS, même s’il possède une adresse e-mail. Pour envoyer un e-mail à ces personnes, ajoutez leurs adresses dans une ligne address.

Un rôle ou une équipe comptant plus de 20 membres actifs est refusé (too_many_recipients) plutôt que de transmettre un message partiel.

Délai de répétition, quotas et messages tardifs

  • Une personne ne reçoit qu’une notification pour le même motif et depuis le même flux toutes les 10 minutes (votre forfait peut définir une autre valeur, d’au moins 1 minute). Définissez Répéter le motif lorsque le texte change à chaque mesure, par exemple level of {{ msg.metadata.deviceName }}. La notification suivante, après la fin du délai, porte la mention « (+n) ».
  • Avant l’envoi, le bloc vérifie les quotas mensuels d’e-mails et de SMS ; un canal ayant épuisé son quota est exclu (msg.metadata.notify.quota). Ce n’est que lorsque tous les canaux ont épuisé leur quota qu’il échoue avec limit.
  • Un message tardif n’envoie aucune notification.

out transporte msg.metadata.notify : recipients, delivered, failed, suppressed, invalid, quota, held. Erreurs : no_recipients, too_many_recipients, members_unavailable, invalid_attachment, notify_failed, node_not_ready, circuit_open, limit.

Voir Notifications from rules and flows pour les modèles, les e-mails HTML et les pièces jointes.