Notification (CALL)
Si vous êtes un utilisateur administrateur ou développeur et concepteur d'objets, les objets Notification vous permettent de configurer des messages et requêtes personnalisés. Il existe différents types de notifications. Automation Engine contient des modèles de notifications avec des informations relatives aux tâches auxquelles ils se réfèrent. Vous pouvez les éditer et les adapter à vos besoins.
Exemple :
Un job a généralement besoin de quelques minutes pour se terminer avec succès. S'il prend plus de temps, c'est peut-être le signe qu'il y a eu un problème. Un autre job (telle qu'une réorganisation de base de données) aura généralement besoin de plus de temps pour se terminer. S'il se termine au bout de quelques secondes, c'est également le signe qu'il y a eu un problème.
Dans ces cas-là, vous voudrez probablement en être informé dès que possible. C'est à cela que servent les objets Notification. Ils attirent votre attention sur le statut des tâches, des événements ou d'importantes modifications. Selon le type de notification utilisé, les informations sont envoyées par e-mail ou les messages s'affichent en ligne. Voir Requêtes.
Classe de l'objet : Objet exécutable
Type d'objet / nom court : CALL
Modèles d'objets par défaut : ALARM, MAIL, STANDARD, SLM
Cette rubrique contient les sujets suivants :
Les modèles de notifications contiennent des variables de script capables d'extraire les données des objets auxquels elles se réfèrent. Des modèles sont disponibles pour les types de notifications suivants :
Utilisation
Les notifications de type ALARM sont utiles pour utiliser le langage de script Automation Engine dans vos messages.
Paramètres prédéfinis
Les notifications de type ALARM incluent un script dans la page Traitement qui lit les données et les utilise dans le texte du message. L'utilisateur qui exécute cet objet est automatiquement spécifié comme destinataire du message.
Les objets Notification ALARM sont toujours exécutés immédiatement après leur création.
Les paramètres suivants sont définis par défaut dans la page Notification. Vous pouvez les modifier, si nécessaire :
- Type = alerte
- Priorité = haute
- Attacher les rapports = &UC_CAUSE_NR
Le texte du message est fourni dans le langage requis. Le texte se compose de valeurs dynamiques, telles que le nom de la tâche ou son RunID.
Pour obtenir des exemples de scripts, voir Exemples de scripts d'objet Notification.
Travailler avec des alertes
Les alertes peuvent être acceptées ou refusées :
- Lorsqu'il accepte la requête, le destinataire prend la responsabilité de résoudre le problème.
- Si le destinataire ou le dernier de plusieurs destinataires refuse la requête, le problème est escaladé.
- Si les destinataires ne sont pas disponibles dans la période définie, seule une escalade temporelle est possible. Si ce type d'escalade n'a pas été défini, la notification est de nouveau appelée.
Notifications MAIL
Utilisation
Les notifications de type MAIL sont des modèles permettant d'envoyer des courriels.
Prérequis
Il faut définir les clés suivantes dans l'UC_CLIENT_SETTINGSobjet VARA (voir UC_CLIENT_SETTINGS - Divers paramètres du client).
Paramètres prédéfinis
Les paramètres suivants sont définis par défaut dans la page Notification. Vous pouvez les modifier, si nécessaire :
- Type = courriel
- Priorité = haute
- Attacher les rapports = &UC_CAUSE_NR
Ce modèle inclut un échantillon de script dans la page Traitement. Le script lit les valeurs de l'objet ayant déclenché la notification et les écrit dans le texte de notification.
Le corps du message au format HTML est également défini par défaut. Vous pouvez le modifier, si nécessaire.
Les courriels ne peuvent être acquittés que par le destinataire. Aucune escalade n'est possible.
Notifications STANDARD
Utilisation
Utile si vous souhaitez définir vos propres messages de notification sans appliquer le langage de script Automation Engine.
Paramètres prédéfinis
Les paramètres suivants sont définis par défaut dans la page Notification, mais vous pouvez les modifier, si nécessaire :
- Type = requête
- Priorité = haute
Les requêtes peuvent être acceptées ou refusées. Cependant, seule une escalade temporelle est possible pour ces notifications. Si ce type d'escalade n'a pas été défini, aucune escalade n'a lieu.
Utilisation
Les objets SLO spécifient les actions à entreprendre si un service (objets exécutables) est exécuté / non exécuté. L'une des possibilités consiste à envoyer des notifications.
Les modèles Notification SLM suivants sont proposés et prêts à l'emploi :
-
FULFILLMENT_MAIL Notification
Ce modèle génère un courriel
-
Notification FULFILLMENT
Ce modèle génère une requête.
Paramètres prédéfinis
Automation Engine propose les variables de script suivantes selon les objets SLO. Elles extraient les données à partir des services surveillés. Elles donnent également les motifs des échecs d'exécution :
- &uc_slm_slo_name#
- &uc_slm_service_name#
- &uc_slm_service_runid#
- &uc_slm_service_time#
- &uc_slm_violation_msg_number#
- &uc_slm_violation_msg_insert#
Pour plus d'informations, voir Objet Service Level Objective (SLO).
Lorsque vous sélectionnez le modèle Notification, le type de message est pré-sélectionné. Vous pouvez le modifier, si nécessaire. Les types disponibles sont les suivants :
-
Requête
Les messages sont envoyés vers la barre notification et les utilisateurs peuvent les accepter ou les refuser.
Ils peuvent également être envoyés par courriel. Le refus d'un message de requête n'entraîne pas l'escalade de la notification. Les requêtes ne sont escaladées qu'en fonction des paramètres de temps que vous définissez en-dessous.
-
Message
Les messages sont également envoyés vers la barre Notification. Ils peuvent également être envoyés par courriel. Ils ne peuvent être acceptés que par le destinataire. L'escalade n'est pas disponible.
-
Alerte
Les messages sont envoyés vers la barre Notification et les utilisateurs peuvent les accepter ou les refuser. Ils peuvent également être envoyés par courriel. Le refus d'un message d'alarme déclenche l'escalade en fonction des paramètres de temps définis en-dessous.
Lors de l'acceptation de l'alerte, le destinataire prend la responsabilité de résoudre le problème.
-
E-mail
Aucune escalade n'est disponible pour ce type de notification. Les notifications de courriels n'apparaissent pas dans la zone de notification.
Remarque : La connexion e-mail doit avoir été configurée correctement dans la variable UC_CLIENT_SETTINGS (UC_CLIENT_SETTINGS - Divers paramètres du client).
Définir des objets notification
La définition d'un objet Notification se compose des pages suivantes :
- Pages standard toujours accessibles, quel que soit le type d'objet à définir :
- Pages supplémentaires toujours disponibles pour les objets exécutables :
- Page spécifique à l'objet décrite ici.
Définir des paramètres spécifiques à la notification
- Dans la perspective Conception des processus, cliquez sur Ajouter objet.
- Dans la boîte de dialogue Ajouter objet, développez la liste Notification (CALL) et sélectionnez un modèle. Pour plus d'informations, voir Ajouter des objets.
- Ouvrez l'onglet Notifications dans le volet de navigation de gauche.
-
Définissez les destinataires des notifications.
Pour les notifications ALARM, l'utilisateur exécutant l'objet est automatiquement affecté en tant que destinataire des messages, mais vous pouvez en spécifier d'autres ici.
-
Dans Destinataires, sélectionnez un utilisateur ou un groupe d'utilisateurs. Saisissez le nom de l'utilisateur ou sélectionnez-le dans la liste déroulante.
Vous pouvez également saisir l'adresse de messagerie comme destinataire.
-
Vous pouvez également sélectionner un calendrier et l'un de ses événements de calendrier.
La notification est envoyée lorsque la condition de calendrier s'applique.
- Cliquez sur Ajouter pour affecter cette combinaison de destinataires et de dates. Vous pouvez ajouter autant de combinaisons que souhaité.
Ces champs acceptent les variables et les "&".
-
-
Si vous sélectionnez un autre modèle que STANDARD, le sujet et le corps de texte de la section Message sont prédéfinis. Vous pouvez les modifier.
-
Saisissez le sujet ou cliquez sur l'icône de variable pour en insérer une.
Si vous le laissez vide, le système créera automatiquement un sujet, qui se composera du nom de l'objet Notification+RunID+Client.
- Saisissez le corps du message. Vous pouvez utiliser des variables. Le nombre de caractères pouvant être utilisé est illimité.
Important ! Si vous créez vos notifications avec le langage de script Automation Engine de la page Traitement, ces paramètres seront ignorés.
-
-
Les paramètres diffèrent en fonction du modèle sélectionné.
- La priorité sert uniquement à des fins d'information. Elle apparaît dans les courriels et dans les messages de la barre de notification.
- Le type détermine la manière dont elle sera envoyée et si elle sera ou non escaladée.
-
Vous pouvez également activer Connexion SNMP pour créer une trap SNMP au lancement d'une notification.
Prérequis :
- SNMP doit être installé sur l'ordinateur et doit être exécuté en tant que service.
- Le sous-agent SNMP AE doit être installé.
- La connexion SNMP doit être activée dans le fichier INI Automation Engine (ucsrv.ini) avec le paramètre SNMP sur
snmp=2
.
Cette option n'est pas disponible pour les notifications de courriels.
Conseil : La technologie SNMP étant maintenant considérée comme obsolète, il est recommandé d'utiliser la solution de pointe JMX. SNMP, qui utilise le protocole réseau UPD moins sécuritaire, est parfois incapable de prendre en charge la gamme complète des fonctions AE.
-
Activez Envoyer un E-mail suppl. pour informer les utilisateurs du déclenchement de la notification. C'est l'adresse indiquée dans la définition de l'utilisateur qui s'applique. Si deux adresses ont été définies pour l'utilisateur responsable, alors le courriel est envoyé aux deux
Vous pouvez également spécifier que des rapports soient attachés au courriel :
-
Dans Attacher rapports, saisissez le RunID de la tâche ayant déclenché le courriel. Cette option n'est utile que pour les jobs.
Un fichier est envoyé pour chaque type de rapport. Le nom du fichier se compose comme suit :
RunID.type de rapport.txt. 002523059.LOG.txt., par exemple
Les options Source s'affichent à l'emplacement que vous indiquez pour récupérer les rapports :
-
Base de données
N'attache que les rapports par défaut des jobs enregistrés dans la base de données Automation Engine.
-
Fichiers externes
Attache les fichiers enregistrés dans l'ordinateur agent. Ceci s'applique aussi au rapport du job (s'il a été enregistré comme fichier) et aux fichiers de sortie, si disponible.
Le destinataire doit avoir le droit d'accès aux rapports pour les rapports externes (EXTREP) et les jobs. Sinon, les fichiers ne sont pas joints et un message d'erreur est écrit dans le rapport de la notification.
L'agent sur lequel le job est exécuté doit être actif et les fichiers doivent exister.
-
Tous
Attache à la fois les rapports de la base de données et ceux de l'ordinateur agent. Si le même rapport existe dans les deux, il n'est envoyé qu'une seule fois.
S'il existe des données dans l'agent, deux courriels sont envoyés (un par Automation Engine et un autre par l'agent).
-
-
Dans Pièce jointeAE, spécifiez le chemin et le nom du fichier à attacher. Il doit se trouver dans un répertoire accessible par la connexion e-mail.
Longueur maximum : 255 caractères
Si vous utilisez des variables ici, veillez à ce que chemin ne dépasse pas 255 caractères après résolution des variables.
-
- L'option Escalade n'est pas disponible pour les notifications E-mail. Pour toutes les autres, vous pouvez définir l'heure à partir de laquelle une seconde notification est envoyée en cas de non réponse.
- Si vous activez Quitter la notification courante, l'envoi de la notification de suivi entraînera la fermeture automatique de la notification d'origine avec le statut ENDED_ESCALATED.
Vous pouvez configurer des objets pour qu'ils envoient des notifications comme suit :
-
Page Exécution
Lorsque vous définissez les paramètres généraux d'un objet exécutable, vous pouvez lui affecter une durée d'exécution minimale et maximale. Si le temps nécessaire à l'exécution de l'objet diffère de ces valeurs, vous pouvez demander au système d'exécuter une tâche. Cette tâche peut être un objet Notification. Il en est de même pour les exécutions de tâches insérées dans des workflows ou dans des schedules. -
Pages Sortie des Jobs
Lors de la définition de la sortie, vous pouvez spécifier un statut et demander au système d'envoyer une notification dès qu'il est atteint. -
Page Attributs
Pour les objets Workflow (JOBP), Schedule (JSCH) et Gestionnaire de tâche distantes (JOBQ). Il est possible de demander au système d'exécuter une tâche lorsqu'un certain statut est atteint. -
Pages Traitement
Ces pages vous permettent d'utiliser le langage de script Automation Engine pour créer des notifications personnalisées. Cliquez ici pour obtenir des Exemples de scripts d'objet Notification.
Workflows
Il est possible de demander au système d'envoyer un objet Notification dans les situations suivantes :
- Si une tâche de workflow ne peut pas être lancée à un point de vérification
- Si une tâche ne démarre pas et ne se termine pas à l'heure attendue
- Si une tâche ne se termine pas avec le statut attendu
- Si l'action définie dans les conditions (pré- et postconditions) déclenche l'exécution d'une notification
- Si la durée d'exécution maximale prédéfinie n'est pas atteinte
Voir Heure & dépendances.
Schedule
Il est possible de demander au système d'envoyer un objet Notification dans les situations suivantes :
- Si la durée d'exécution maximale prédéfinie n'est pas atteinte
- Si une tâche ne se termine pas avec le statut attendu
Informations du tampon de lecture
Une notification démarrant à la suite des conditions définies pour les tâches de workflows ou de schedules contient des informations système détaillées. Ces informations peuvent être lues dans le script de la notification, à partir du tampon de lecture. On utilise pour ce faire l'instruction de script :READ.
- UC_CAUSE_NAME : Le nom de la tâche à l'origine.
- UC_CAUSE_NR : Le RunID de la tâche à l'origine.
- UC_CAUSE_STATE : Le statut de la tâche à l'origine.
- UC_CAUSE_RETCODE : Le code retour de la tâche à l'origine.
Exemples
:READ &UC_CAUSE_NAME,,
:READ &UC_CAUSE_NR,,
:READ &UC_CAUSE_STATE,,
:READ &UC_CAUSE_RETCODE,,
Important ! Cette opération n'est possible que si la notification a été activée avec le paramètre Générer à l'activation de sa Page Attributs.
Si vous devez traiter des messages ou des requêtes, la zone de notifications de la barre de menus attire votre attention à ce sujet, voir Requêtes.
Selon le type de notification reçue, vous pouvez réagir de différentes manières :
-
Requêtes
Les messages sont envoyés vers la barre Notification. Ils peuvent être acceptés ou refusés. Pour plus d'informations, voir les paramètres de temps définis dans l'objet Notification les ayant déclenchées.
-
Messages
Les messages sont envoyés vers la barre Notification et les utilisateurs peuvent les accepter ou les refuser. Ils peuvent également être envoyés par courriel.
Le refus d'une d'alerte déclenche l'escalade en fonction des paramètres de temps que vous avez définis.
Lors de l'acceptation de l'alerte, le destinataire prend la responsabilité de résoudre le problème.
-
Alertes
Les messages sont également envoyés vers la barre de Notification et les utilisateurs peuvent les accepter ou les refuser. Ils peuvent également être envoyés par courriel.
Le refus d'un message d'alerte déclenche l'escalade en fonction des paramètres de temps que vous avez définis.
Lors de l'acceptation de l'alerte, le destinataire prend la responsabilité de résoudre le problème.
-
Courriels
Aucune escalade n'est disponible pour ce type de notification. Les notifications de courriels n'apparaissent pas dans la zone de notification.
Important ! La connexion e-mail doit avoir été configurée correctement dans la variable UC_CLIENT_SETTINGS.
See also:
- Exemples de scripts d'objet Notification
- Regardez la vidéo
- Attributs d'une Notification
- UC_CLIENT_SETTINGS - Divers paramètres du client
Réagir aux notifications :