DOCUMENTATION EN LIGNE
DE WINDEVWEBDEV ET WINDEV MOBILE

Aide / Outils / Robot de surveillance / Robot
  • Présentation
  • Configuration des paramètres du robot
  • Options d'alerte
  • Alerte par WDBal
  • Alerte par email
  • Utilisation d'un programme tiers
  • Paramétrage du rapport
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaEtats et RequêtesCode Utilisateur (MCU)
WEBDEV
WindowsLinuxPHPWEBDEV - Code Navigateur
WINDEV Mobile
AndroidWidget AndroidiPhone/iPadWidget IOSApple WatchMac CatalystUniversal Windows 10 App
Autres
Procédures stockées
Robot de surveillance : Configuration des paramètres du robot
Présentation
Depuis le moniteur, il est possible de modifier les options de configuration :
  • du robot,
  • du contre-robot,
  • du moniteur.
Configuration des paramètres du robot
Les paramètres du robot correspondent aux paramètres indiqués dans l'assistant de configuration du robot.
Pour afficher les paramètres du robot :
  1. Dans le menu, dans le groupe "Paramétrage", cliquez sur "Paramétrer" puis sélectionnez l'option "Paramètres du robot de surveillance".
  2. La fenêtre qui s'affiche reprend les caractéristiques du robot :
    • Nom, machine, répertoire d'accès.
    • Options d'alerte. Ces options d'alerte sont configurables pour :
      • alerte via WDBal,
      • alerte via Email,
      • alerte via programme tiers,
      En cas d'alerte par Email ou WDBal, il est possible de paramétrer le rapport envoyé.
Options d'alerte

Alerte par WDBal

L'onglet "WDBal" permet de paramétrer l'envoi de rapport d'erreurs par la messagerie PC SOFT nommée WDBal. Pour utiliser ce mode de message d'alerte, la base de données des Centres de Contrôle doit être accessible depuis le poste où le robot est installé.
Si l'option d'envoi de messages par WDBal est activée (option "Envoi par WDBal activé" cochée), ce mode d'alerte sera utilisé par défaut pour tous les contrôles présents dans le moniteur. Il est ensuite possible pour chaque utilisateur de définir des paramètres spécifiques.
La section "Configuration de WDBal" permet de définir le mode d'accès aux données des Centres de Contrôle :
  • En mode partage réseau : répertoire des fichiers de données.
  • En mode HFSQL Client/Serveur : serveur utilisé, port et base de données, ainsi que l'utilisateur et le mot de passe.

Alerte par email

L'onglet "Email" permet de paramétrer l'envoi de rapport d'erreurs par email. Pour utiliser ce mode de message d'alerte, un serveur SMTP doit être accessible depuis le poste où le robot est installé.
Si l'option d'envoi de messages par email est activée (option "Envoi par Email activé" cochée), ce mode d'alerte sera utilisé par défaut pour tous les contrôles présents dans le moniteur. Il est ensuite possible pour chaque utilisateur de définir des paramètres spécifiques.
La section "Configuration de l'envoi d'emails" permet de définir les caractéristiques du serveur SMTP utilisé :
  • Serveur et port SMTP.
  • Utilisateur et mot de passe associé pour utiliser le serveur SMTP.
  • Sécurité utilisée.

Utilisation d'un programme tiers

L'onglet "Programme tiers" permet de :
  • paramétrer l'envoi du rapport d'erreurs à un programme spécifique. Ce programme tiers se chargera de traiter les messages d'alerte.
    Pour utiliser ce mode de message d'alerte, indiquez le chemin de l'exécutable voulu. Cet exécutable doit être accessible depuis le poste d'installation du robot.
  • spécifier une Webhook. L'appel à la webhook sera réalisé après chaque exécution de tests, en passant en paramètre un fichier JSON.
    Pour utiliser une webhook, il suffit de spécifier l'URL de la Webhook à appeler.
Envoi du rapport d'erreur à un programme tiers
Dans ce mode d'envoi, le rapport d'erreur est un fichier XML. Le chemin du rapport d'erreur sera passé en ligne de commande au programme tiers et devra être traité par ce programme.

Le format du fichier XML est le suivant :
<Test>
<NumeroTest>%1</NumeroTest>
<NomTest>%2</NomTest>
<CategorieTest>%3</CategorieTest>
<PrioriteTest>%4</PrioriteTest>
<SyntaxeTest>
%5
</SyntaxeTest>
<SolutionTest>
%6
</SolutionTest>
<DateErreur>%7</DateErreur>
<HeureErreur>%8</HeureErreur>
<MessageErreurPersonnel>
%9
</MessageErreurPersonnel>
<MessageErreur>
%10
</MessageErreur>
</Test>
<Test>
...
</Test>

Dans ce code :
  • %1 = Numéro identifiant le test
  • %2 = Nom du test
  • %3 = Nom de la catégorie du test
  • %4 = Priorité du test
  • %5 = Syntaxe du test (paramètres associées)
  • %6 = Solution proposée pour le test
  • %7 = Date de l'erreur
  • %8 = Heure de l'erreur
  • %9 = Message d'erreur renseigné dans la fiche du test
  • %10 = Message d'erreur renvoyé par le robot
Si l'option d'envoi de messages par programme tiers est activée (option "Envoi par programme tiers activé" cochée), ce mode d'alerte sera utilisé par défaut pour tous les contrôles présents dans le moniteur.
Appel d'une webhook
L'appel sera réalisé après chaque test exécuté, en passant en paramètre un fichier JSON.
Le fichier JSON a le format suivant :
{
 "RobotName": "Nom robot",
 "ControlName": "Nom du contrôle",
 "ControlCategory": "Nom de la catégorie",
 "Severity": "Niveau erreur"
 "ResponsibleList": "Responsable",
 "FirstError": "DateHeure de la première erreur",
 "ErrorMessage": "Message d'erreur",
 "IsError": 0/1
 "CustomError" : "Message personnalisé"
}
Les éléments présents dans le fichier JSON sont les suivants :
  • RobotName : nom du robot de surveillance (utile si vous avez plusieurs robots dans votre organisation et si vous souhaitez tous les orienter vers la même webhook).
  • ControlName : nom (libellé) du contrôle.
  • ControlCategory : nom (libellé) de la catégorie du contrôle.
  • Severity : niveau de gravité du contrôle. En version 26, ce paramètre vaut toujours "Erreur".
  • ResponsibleList : liste des utilisateurs recevant les alertes de ce contrôle.
  • FirstError : date et heure de la première erreur signalée. Ce membre est utile pour savoir depuis combien de temps un contrôle est en erreur.
  • IsError : booléen indiquant si le contrôle est en erreur.
  • ErrorMessage : message d'erreur du contrôle.
  • CustomError : message de complément d'erreur (qui a été saisi dans les paramètres du contrôle, depuis le moniteur du robot).
Remarque : Si vous souhaitez réaliser une Webhook en WEBDEV :
  1. Créez un projet WEBDEV avec une page AWP vide.
  2. Dans la page AWP :
    • Déclarez la structure d'export :
      // Structure d'export
      STWebHookExport est une Structure
      RobotName est une chaîne
      ControlName est une chaîne
      ControlCategory est une chaîne
      Severity est une chaîne
      ResponsibleList est une chaîne
      FirstError est une DateHeure
      ErrorMessage est une chaîne
      IsError est un booléen
      CustomError est une chaîne
      FIN
       
      gtabInfoWebhook est un tableau de STWebHookExport
    • Récupérez et désérialisez les données avant de les utiliser :
      bufDonnéesPOST est un Buffer = PageParamètre(paramBuffer)
      Désérialise(gtabInfoWebhook,bufDonnéesPOST,psdJSON)
Liste des exemples associés :
WW_Statut_Liste Exemples didactiques (WEBDEV) : WW_Statut_Liste
[ + ] Cet exemple est une implémentation très simple de la webhook mise à disposition par le robot de surveillance.
Il suffit d'indiquer l'URL de la page webhook de l'exemple comme webhook à appeler dans les paramètres du robot de surveillance puis de définir les catégories et les contrôles.
La page affichera toutes les 2 minutes l'état des contrôles.

Paramétrage du rapport

L'onglet "Paramétrage du rapport" permet de paramétrer le sujet du message envoyé (par email ou par WDBal).
  • La section "Objet de l'email envoyé" permet de construire le titre du message. Des macros permettent d'obtenir des informations spécifiques (nom du robot, nombre de contrôles en erreur, ...).
  • La section "Mode d'alerte" permet de choisir le mode d'alerte retenu :
    • Mode "Alerte continue" (par défaut) :
      Si un contrôle donné est en erreur plusieurs fois de suite (par exemple, si le serveur ne répond pas pendant plusieurs minutes), le robot enverra systématiquement une alerte pour chaque erreur.
    • Mode "Panne/reprise"
      Si un contrôle donné est en erreur plusieurs fois de suite (par exemple, si le serveur ne répond pas pendant plusieurs minutes), le robot effectue les opérations suivantes :
      1. Le robot enverra une alerte lors de la première erreur détectée.
      2. Le robot enverra des alertes intermédiaires, toutes les xx minutes. Le délai entre chaque envoi est paramétrable.
      Il est également possible de n'envoyer aucun message intermédiaire.
      3. Le robot enverra un message lorsque le contrôle ne sera plus en erreur (par exemple si le serveur est redémarré).
      Notes :
      • Le mode "Panne/Reprise" s'applique à tous les contrôles (il n'est pas possible de préciser ce mode pour un contrôle en particulier).
      • Si ce mode est activé et que le robot surveille des éléments sensibles, il est conseillé d'envoyer des messages intermédiaires.
      • Exemple de déroulement :
        TempsEtat du contrôleMode Alerte continueMode Panne/Reprise
        Instant TContrôle en erreurAlerte envoyéeAlerte envoyée
        Instant T+1Contrôle en erreurAlerte envoyéeAucune alerte envoyée
        Instant T+2Contrôle en erreurAlerte envoyéeAucune alerte envoyée
        Instant T+3Contrôle en erreurAlerte envoyéeAucune alerte envoyée
        Instant T+4Contrôle en erreurAlerte envoyéeAucune alerte envoyée
        Instant T+5Contrôle correctAucune alerte envoyéeAlerte envoyée
Version minimum requise
  • Version 14
Documentation également disponible pour…
Commentaires
Cliquez sur [Ajouter] pour publier un commentaire

Dernière modification : 02/06/2022

Signaler une erreur ou faire une suggestion | Aide en ligne locale