Notifications
En tant qu'administrateur, vous pouvez utiliser des notifications pour envoyer des e-mails ou des messages texte aux utilisateurs ThingWorx en fonction d'un
événement.
Les notifications sont constituées d'un ou de plusieurs déclencheurs. Un déclencheur définit quels utilisateurs sont informés des événements spécifiés et quel message ils reçoivent. En créant un déclencheur, vous devez définir les éléments suivants :
• Source : entité et événement source qui entraînent l'envoi de la notification.
• Gestionnaire : entité qui fournit des services permettant d'envoyer des messages de notification. Le gestionnaire définit le type de contenu qu'il peut envoyer. Vous pouvez utiliser les gestionnaires suivants :
◦ MailServer : objet de l'extension Mail (version 3.5.0 et supérieure de l'extension).
Ses messages incluent un objet et un corps.
◦ Twilio : objet de l'extension Twilio (version 3.1.0 et supérieure de l'extension).
Ses messages incluent un corps.
Vous pouvez télécharger ces extensions à partir de la
page de téléchargement de ThingWorx Foundation.
 |
Une notification ne peut pas avoir plusieurs déclencheurs utilisant la même entité gestionnaire. Si plusieurs déclencheurs utilisent le même gestionnaire, vous devez créer une autre entité notification.
|
• Contenu : message envoyé à l'utilisateur. Le contenu peut inclure des informations supplémentaires issues de l'événement qui a déclenché la notification, émanant notamment du paquet de données d'événement défini dans la forme de données (consultez la rubrique
Evénements d'objet). Vous pouvez inclure des données d'événement à l'aide d'une notation utilisant des doubles crochets et des deux-points. Par exemple, [[:<event_data>:]], où event_data fait référence au nom du paramètre d'événement. C'est le même nom qui est utilisé lors de l'ajout d'un abonnement à l'événement (consultez la rubrique
Abonnements objets).
Pour rechercher des paramètres d'événement disponibles, procédez comme suit :
1. Dans Composer, choisissez > (ou Modèles d'objet ou Formes d'objet), puis ouvrez une entité.
2. Dans la zone Abonnements, pour ajouter un abonnement temporaire, cliquez sur le bouton Ajouter.
3. Cliquez sur la zone Entrées, puis sélectionnez un Evénement dans la liste déroulante.
4. Si vous le souhaitez, vous pouvez sélectionner une propriété dans la liste déroulante.
Une liste d'entrées s'affiche.
5. Pour ajouter un paramètre à la zone de script, cliquez sur la flèche (
).
).Le nom du paramètre qui apparaît dans la zone de script peut être utilisé dans le contenu de notification.
6. Cliquez sur Terminé.
Une bonne pratique concernant le contenu de notification consiste à internationaliser le texte en créant des jetons dans la table de localisation par défaut et en y définissant le texte. Vous pouvez définir le contenu de notification en spécifiant le nom du jeton de localisation entre double crochets, comme dans [[<token_name>]].
| | Il peut exister des limitations quant aux éléments pouvant être envoyés, selon l'implémentation du gestionnaire et le service utilisé pour envoyer les messages. Ainsi, il peut y avoir des limitations de taille applicables à la longueur du corps d'un e-mail par un serveur de messagerie particulier. Twilio présente une limite de caractères pour les messages SMS. Pour en savoir plus, consultez la documentation accompagnant le service de messagerie afin de veiller à respecter de telles limitations applicables au contenu. |
• Destinataires : un ou plusieurs utilisateurs ThingWorx auxquels le message de notification doit être envoyé.
| | Afin de pouvoir recevoir des e-mails et/ou des messages texte, les utilisateurs doivent posséder une adresse e-mail valide (propriété emailAddress ) et/ou un numéro de téléphone mobile (propriété mobilePhone ) spécifié dans leur configuration Extensions utilisateur (forme d'objet UserExtensions). Les messages texte sont envoyés au numéro de téléphone mobile spécifié et pas à l'adresse SMS (propriétésmsAddress ). |
Evénements de notification
Lorsque des notifications sont déclenchées, les événements suivants se produisent :
• NotificationSent
• NotificationFailed
Pour vous abonner aux événements afin d'y répondre (par exemple, pour rédiger une entrée dans un flux ou un fichier journal), procédez comme suit :
1. Dans Composer, choisissez > , puis sélectionnez un objet de notification.
2. Cliquez sur l'onglet Entrées, puis sélectionnez l'événement NotificationSent ou NotificationFailed comme entrée de l'abonnement.
3. Spécifiez la logique d'abonnement.
Pour plus d'informations, consultez la rubrique
Abonnements objets.
Importation ou exportation de notifications
Les notifications sont exportées dans un fichier contenant des informations de notification de base et des informations afférentes aux déclencheurs (par exemple, NotificationDefinition_<nom>.xml).
Vous pouvez également exporter toutes les entités système dans Composer depuis > > > ou depuis > > . Cette opération exporte les notifications et les déclencheurs vers leur fichier attitré dans les dossiers NotificationDefinitions et NotificationContents du référentiel spécifié. Les déclencheurs ne peuvent pas être exportés en spécifiant un tag de modèle ni un nom de projet.
L'importation de notifications doit respecter les prérequis suivants :
• Assurez-vous que l'événement et l'entité source existent.
• Les entités gestionnaires (objet MailServer ou objet Twilio) doivent exister.
• Les entités utilisateur spécifiées en tant que destinataires existent.
Pour plus d'informations, consultez la rubrique
Ajout de notifications.