Voir également Exemple Infos complémentaires
Gestion des fenêtres de consignation, notamment navigation dans la liste des événements et filtrage.
Support WebVue partiel. Voir le tableau avec la liste des modes ci-dessous. Les modes non supportés renvoient un code d'erreur si exécutés dans ce contexte.
Lors de l'utilisation de régions multiples, vous devez positionner la région avant l'exécution d'instructions qui interagissent avec l'IHM. Pour plus d'informations, voir la rubrique REGION.
Le filtrage sur population basé sur la source n'est pas supporté pour filtrer dans les fenêtres de consignation (et l'impression des journaux de bord) lorsque les données sont archivées en utilisant une unité d'archivage en base de données (HDS).
| Mode | Mnémonique | Syntaxe | Support WebVue |
| 0 | BEGIN | 1 | Oui |
| 1 | BEFORE | 1 | Oui |
| 3 | AFTER | 1 | Oui |
| 4 | END | 1 | Oui |
| 5 | LINEUP | 1 | Oui |
| 6 | LINEDOWN | 1 | Oui |
| 9 | DOMAIN | 2 | Oui |
| 10 | NATURE | 2 | Oui |
| 11 | PRINTALL | 1, 8 | Non |
| 12 | SETDATETIME | 3, 7 | Oui |
| 13 | FILTER | 4 | Oui |
| 14 | PRINTSELECTED | 1, 8 | Non |
| 15 | PRINTDISPLAY | 1, 8 | Non |
| 16 | FIRST | 1 | Oui |
| 17 | LAST | 1 | Oui |
| 18 | EVENTMASK | 6 | Oui |
| 19 | MINMAX | 5 | Oui |
| 20 | EXECUTE | 1 | Oui |
| 21 | LOGLIST | 2 | Oui |
| 22 | EVENTMASKEX | 12 | Oui |
| 23 | LINESELECT | 9 | Oui |
| 24 | SETSORT | 10 | Oui |
| 25 | GETSORT | 11 | Oui |
| 26 | AUTOREFRESH_SET | 17 | Oui |
| 27 | AUTOREFRESH_PAUSE | 1 | Oui |
| 28 | AUTOREFRESH_RESUME | 1 | Oui |
| 29 | ISLINESELECTED | 13 | Non |
| 30 | ISLINEVISIBLE | 13 | Non |
| 31 | GETLINECOUNT | 1 | Non |
| 32 | COPY_CLIPBOARD | 14 | Non |
| 33 | GETLINES | 15 | Non |
| 34 | GETSELECTEDLINES | 15 | Non |
| 35 | GETCELL | 16 | Non |
| 36 | AUTOREFRESH_STATUS | 1 | Non |
| 37 | AUTOREFRESH_PERIOD | 1 | Non |
| 38 | GET_NAME_FROM_LINE | 18 | Non |
| 39 | UNSELECTALL | 1 | Oui |
| 40 | SETCOLUMNWIDTH | 19 | Non |
| 41 | GETCOLUMNWIDTH | 20 | Non |
Arguments communs
| Argument | Définition |
| Window | Nom de la fenêtre qui contient l'animation à piloter. Type STR |
| Branch | La branche de la fenêtre. "*" pour utiliser la branche courante du programme. Type STR. |
| Identity | Identifiant de l'animation fenêtre de consignation. Type STR. |
| DelayExecution | Flag indiquant si l'instruction doit être exécutée immédiatement (0) ou s'il faut attendre une instruction Execute (1). |
Utilisation de l'argument DelayExecution et du mode EXECUTE
Les modes suivants supportent le flag DelayExecution :
- Si DelayExecution est omis ou s'il est positionné à 0, alors l'instruction est exécutée immédiatement.
- Si DelayExecution est positionné à 1, l'exécution de l'instruction est retardée jusqu'au prochain appel au mode EXECUTE. Cela vous permet d'apporter plusieurs modifications à un filtre de la Fenêtre de consignation qui sont ensuite toutes exécutées en même temps. Comme chaque fois qu'un filtre de la Fenêtre de consignation est modifié, une nouvelle requête aux archives est faite, ceci évite de faire plusieurs requêtes là où une seule est suffisante.
De nombreux modes de filtrage prennent en charge le flag facultatif DelayExecution.
DOMAIN, NATURE, LOGLIST, SETDATETIME, FILTRE, MINMAX, EVTMASK et EVENTMASKEX.
Syntaxe 1
IntVal = LOGDISPLAY(Mode, Window, Branch, Identity);
Type de retour: INTEGER.
Exécution
| Mode | Mnémonique | Action |
| 0 | BEGIN | Demande le buffer précédent. Equivalent au bouton << de l'affichage de consignations. |
| 1 | BEFORE | Remonte d'une page même si on est en début de buffer. Equivalent au bouton < de l'affichage de consignations. |
| 3 | AFTER | Descend d'une page même si on est en fin de buffer. Equivalent au bouton > de l'affichage de consignations. |
| 4 | END | Demande le buffer suivant. Equivalent au bouton >> de l'affichage de consignations. |
| 5 | LINEUP |
Remonte d'une ligne. |
| 6 | LINEDOWN |
Descend d'une ligne. |
| 11 | PRINTALL | Imprime toutes les lignes du buffer configuré dans la fenêtre de consignations. |
| 14 | PRINTSELECTED | Imprime la ligne sélectionnée. |
| 15 | PRINTDISPLAY | Imprimer toutes les lignes actuellement visibles dans la fenêtre de consignation. |
| 16 | FIRST | Permet d'aller au début des historiques. Equivalent au bouton |< de l'affichage de consignations. |
| 17 | LAST | Permet d'aller à la fin des historiques. Equivalent au bouton >| de l'affichage de consignations. |
| 20 | EXECUTE | Déclenche une requête aux archives afin de rafraîchir la fenêtre de consignation et ainsi d'appliquer le filtre défini par des appels successifs à des modes de filtrage tels que MINMAX, EVENTMASK… |
| 27 | AUTOREFRESH_PAUSE | Mettre en pause le mécanisme de mise à jour automatique. |
| 28 | AUTOREFRESH_RESUME | Reprend le mécanisme d'auto-refresh. |
| 31 | GETLINECOUNT | Retourne le nombre de lignes dans la fenêtre de consignations. |
| 36 | AUTOREFRESH_STATUS |
Retourne le status du mécanisme d'auto-refresh : 1 = En cours 2 = Pause 3 = Non positionné (période à 0) |
| 37 | AUTOREFRESH_PERIOD | Retourne la période d'auto-refresh en secondes. |
|
39 |
UNSELECTALL |
Désélectionne toutes les lignes. |
| Retour : 1 si OK, 0 sinon (fenêtre inexistante, etc). Excepté pour les modes 31, 36 et 37. |
Le nombre maximum de lignes d'une fenêtre de consignations est de 32 000.
Syntaxe 2
IntVal = LOGDISPLAY(Mode, Window, Branch, Identity, Argument[, DelayExecution]);
Type de retour : INTEGER.
| Argument | Définition |
| Argument | Nom d'un nouveau domaine ou d'une nouvelle nature. Pour spécifier tous les domaines et toutes les natures, Argument doit être une chaîne nulle. Type STR. |
Exécution
Sélectionne le nouveau domaine, la nouvelle nature ou la liste de consignations.
| Mode | Mnémonique | Action |
| 9 | DOMAIN | Nouveau domaine. |
| 10 | NATURE | Nouvelle nature. |
| 21 | LOGLIST | Nouvelle liste de consignations. |
| Retour : 1 si OK, 0 sinon. |
Si le filtre de l'animation de la fenêtre de consignations a été configuré avec un domaine et/ou une nature, le mode FILTER du verbe LOGDISPLAY ne sera pas pris en compte.
Syntaxe 3
IntVal = LOGDISPLAY(Mode, Window, Branch, Identity, StartTime [ ,EndTime[, DelayExecution]]);
Type de retour : INTEGER.
| Argument | Définition |
| StartTime |
Date de début, exprimée en nombre de millisecondes depuis 1980. Voir l'instruction DateTimeValue. Type DOUBLE. Si elle est omise c'est l'horodate courante qui est utilisée. |
| EndTime |
Date de fin, exprimée en nombre de millisecondes depuis 1980. Voir l'instruction DateTimeValue. Type DOUBLE. Si elle est omise c'est l'horodate courante qui est utilisée. |
Exécution
| Mode | Mnémonique | Action |
| 12 | SETDATETIME | Vérifie si la ligne est sélectionnée. Retour : 1 si sélectionné, 0 sinon. |
Syntaxe 4
IntVal = LOGDISPLAY(Mode, Window, Branch, Identity, Filter[, DelayExecution]);
Type de retour : INTEGER
| Argument | Définition |
| Filter | Expression de filtre. Vous pouvez utiliser soit un Expressions de Filtre natif ou Expression SQL pour filtrer la liste des variables de type STR. |
Exécution
| Mode | Mnémonique | Action |
| 13 | FILTER |
Définit les informations à afficher dans la fenêtre de consignation en appliquant le filtre d'expression :
Retour : 1 si OK, 0 sinon (la fenêtre introuvable, etc.). |
Si le filtre de l'animation de la liste de consignations est configuré avec un domaine et/ou une nature, le mode FILTER du verbe LOGDISPLAY sera ignoré.
Si le filtre est positionné à #T et que la fenêtre de consignations est dans une unité d'archivage Base de données, vous devez inclure la colonne Description dans la table de consignation autrement le résultat sera une fenêtre vide.
Les critères de filtre supportés par la syntaxe Sql sont décrits dans la rubrique Utilisation d'une Expression Sql pour Filtrer la Liste de Variables de la section IHM.
La chaîne de caractères Filter est utilisée comme clause Where. De manière générale, les opérateurs et éléments de syntaxe supportés par le SGBD peuvent être utilisés, notamment la syntaxe avec des crochets pour les critères de filtres (colonnes des tables).
Par exemple [TextAttr11] IS NOT NULL
Syntaxe 5
IntVal = LOGDISPLAY(Mode, Window, Branch, Identity, Min, Max[, DelayExecution]);
Type de retour : INTEGER.
| Argument | Définition |
| Min | Niveau de priorité minimum des alarmes. Type INTEGER |
| Max | Niveau de priorité maximum des alarmes. Type INTEGER |
Exécution
| Mode | Mnémonique | Action |
| 19 | MINMAX | Filtre de sélection de Min priorité à Max priorité dans la fenêtre de consignations. Retour : 1 si OK, 0 sinon. |
Syntaxe 6
IntVal = LOGDISPLAY(Mode, Window, Branch, Identity, EventMask[, DelayExecution]);
Type de retour : INTEGER
| Argument | Définition |
| EventMask | Masque d'événements. Pour plus d'informations, voir la rubrique Masque d'événements. Type DOUBLE. |
Exécution
| Mode | Mnémonique | Action |
| 18 | EVENTMASK | Modifie le masque d'événements. Retour : 1 si OK, 0 sinon. |
Si exécuté dans un contexte WebVue, les événements Logon et Logoff sont tous les 2 récupérés lorsque vous filtrez en utilisant EVENTMASK et EVENTMASKEX.
Syntaxe 7
IntVal = LOGDISPLAY(Mode, Window, Branch, Identity, StartTime[, EndTime[, DelayExecution[, ChangeNoOfLines]]]);
Type de retour : INTEGER.
| Argument | Définition |
| StartTime |
Date de début, exprimée en nombre de millisecondes depuis 1980. Voir l'instruction DateTimeValue. Type DOUBLE. Si elle est omise c'est l'horodate courante qui est utilisée. |
| EndTime |
Date de fin, exprimée en nombre de millisecondes depuis 1980. Voir l'instruction DateTimeValue. Type DOUBLE. Si elle est omise c'est l'horodate courante qui est utilisée. |
| ChangeNoOfLines | Un indicateur optionnel qui provoque une modification temporaire de la taille de la mémoire buffer de la fenêtre de consignation. Voir ci-dessous |
Exécution
| Mode | Mnémonique | Action |
| 12 | SETDATETIME | Sélectionne une nouvelle heure pour la fenêtre de consignation Retour : 1 si OK, 0 sinon. |
Modification du nombre de lignes
Si le nombre de lignes correspondant à la requête est supérieure au nombre de lignes déclaré dans le buffer temps-réel, une valeur à 1 pour le flag ChangeNoOfLines modifiera le nombre de lignes dans le buffer temps-réel. L'affichage est alors positionné sur la ligne correspondant à l'horodate de début.
If you make a further request, other than SETDATETIME with ChangeNoOfLines set to 1, or if you close the Log Viewer animation, the size of the Log Viewer buffer reverts to its original value.
Syntaxe 8
IntVal = LOGDISPLAY(Mode, Window, Branch, Identity[, PrintFormat]);
Type de retour : INTEGER
| Argument | Définition |
| PrintFormat |
Paramètre optionnel pour sélectionner le format d'impression : |
Exécution
| Mode | Mnémonique | Action |
| 11 | PRINTALL | Imprime toutes les lignes du buffer configuré dans la fenêtre de consignations. |
| 14 | PRINTSELECTED | Imprime la ligne sélectionnée. |
| 15 | PRINTDISPLAY | Imprime toutes les lignes du buffer. |
| Retour : 1 si OK, 0 sinon (fenêtre inexistante, etc). |
Syntaxe 9
IntVal = LOGDISPLAY(Mode, Window, Branch, Identity, ProgramModule, ProgramBranch, ProgramFunction, ProgramParameter);
Type de retour : INTEGER.
| Argument | Définition |
| ProgramModule | Programme à exécuter. |
| ProgramBranch | Branche du programme. |
| ProgramFunction | Fonction du programme à exécuter. |
| ProgramParameter | Paramètres du programme. |
Exécution
| Mode | Mnémonique | Action |
| 23 | LINESELECT | Spécifie un programme à exécuter lorsqu'une ligne sélectionnée/désélectionnée apparaît. Retour : 1 si OK, 0 sinon. |
L'instruction XMLPATH est utilisée pour obtenir les informations du mode LINESELECT . Un namespace est créé automatiquement en utilisant Branch, Window et Identity.
Les significations des chemins XML sont les suivantes.
| Chemin | Définition |
| lineselect/variable | Nom de la variable |
| lineselect/x | Position X |
| lineselect/y | Position Y |
| lineselect/selected | Sélectionné/désélectionné |
| lineselect/time | Date-heure |
| lineselect.element[1-8].value | Elément de la colonne |
Syntaxe 10
IntVal = LOGDISPLAY(Mode, Window, Branch, Identity, Column, Sort);
Type de retour : INTEGER
| Argument | Définition |
| Column | Valeurs de 0 à 7 pour identifier la colonne, - 1 pour réinitialiser le tri. |
| Sort | Valeur 1 pour un tri ascendant, 0 pour descendant. |
Exécution
| Mode | Mnémonique | Action |
| 24 | SETSORT |
Tri dynamique d'une liste d'alarme en fonction d'une colonne. Retour : 1 si OK, 0 sinon. |
Syntaxe 11
IntVal = LOGDISPLAY(Mode, Window, Branch, Identity, Column);
Type de retour : INTEGER
| Argument | Définition |
| Column | Valeurs de 0 à 7 pour identifier la colonne, - 1 pour réinitialiser le tri. |
Exécution
| Mode | Mnémonique | Action |
| 25 | GETSORT | Obtient le status d'un tri. Retour : 1 si OK, 0 sinon (paramètre incorrect...). |
XMLPATH est utilisé pour obtenir les informations du mode GETSORT. Un namespace est créé automatiquement lors en utilisant Branch, Window et Identity.
Les significations des chemins XML sont les suivantes.
| Chemin | Définition |
| getsort/column | Valeurs de 0 à 7 pour identifier la colonne, - 1 pour réinitialiser le tri. |
| getsort/sort | Valeur 1 pour un tri ascendant, 0 pour un tri descendant. |
Syntaxe 12
IntVal = LOGDISPLAY(Mode, Window, Branch, Identity, lLowPart, lHighPart[, DelayExecution] );
Type de retour : INTEGER
| Argument | Définition |
| lLowPart | Partie basse du masque. Pour plus d'informations sur la construction des masques, voir la rubrique Masques d'Evénements. Type de retour : LONG. |
| lHighPart | Partie haute du masque. Pour plus d'informations sur la construction des masques, voir la rubrique Masques d'Evénements. Type de retour : LONG. |
| Context | Un flag facultatif. Si défini à 1, l'action requise par l'instruction est retardée jusqu'à ce que la prochaine instruction du mode EXECUTE soit utilisée. |
Exécution
| Mode | Mnémonique | Action |
| 22 | EVENTMASKEX | Modifie le filtre d'événements de la fenêtre de consignations. Retour : 1 si OK, 0 sinon (paramètre incorrect...).. |
Si exécuté dans un contexte WebVue, les événements Logon et Logoff sont tous les 2 récupérés lorsque vous filtrez en utilisant EVENTMASK et EVENTMASKEX.
Syntaxe 13
IntVal = LOGDISPLAY(Mode, Window, Branch, Identity, Line);
Type de retour : INTEGER.
| Argument | Définition |
| Line | Numéro de ligne (1ère ligne = 1). Type INTEGER |
Exécution
| Mode | Mnémonique | Action |
| 29 | ISLINESELECTED | Vérifie si la ligne est visible. Retour : 1 si visible, 0 sinon. |
| 30 | ISLINEVISIBLE | Vérifie si la ligne est visible. Retour : 1 si visible, 0 sinon. |
Syntaxe 14
IntVal = LOGDISPLAY(Mode, Window, Branch, Identity, Separator);
Type de retour : INTEGER.
| Argument | Définition |
| Separator | Caractère(s) utilisé(s) pour délimiter le contenu de chaque colonne. Type STR. |
Exécution
| Mode | Mnémonique | Action |
| 32 | COPY_CLIPBOARD | Copie les lignes sélectionnées vers le presse-papier Windows. Retour : 1 si OK, 0 sinon. |
Syntaxe 15
StrVal = LOGDISPLAY(Mode, Window, Branch, Identity, LineStart[, LineEnd, ColSeparator, LineSeparator]);
Type de retour : STR
| Argument | Définition |
| Linestart | Numéro de ligne (1ère ligne = 1) dans le buffer de la fenêtre de consignation. Type INTEGER |
| LineEnd | Numéro de ligne (1ère ligne = 1) dans le buffer de la fenêtre de consignation. Type INTEGER |
| ColSeparator | Caractère(s) utilisé(s) pour séparer les colonnes dans la chaîne de retour. Par défaut : virgule ",". Type STR. |
| LineSeparator | Caractère(s) utilisé(s) pour séparer les lignes dans la chaîne de retour. Par défaut : nouvelle ligne "\n". Type STR. |
Exécution
| Mode | Mnémonique | Action |
| 33 | GETLINES | Retourne les lignes de LineStart à LineEnd (inclus) dans une seule chaîne délimitée par les caractères ColSeperator et LineSeperator. Si LineEnd est omis, une seule ligne est retournée en utilisant les caractères par défaut pour délimiter les colonnes. Retour : Lignes demandées de la fenêtre de consignations. |
| 34 | GETSELECTEDLINES | Idem à GETLINES excepté que seules les lignes sélectionnées sont retournées. |
| Retourne une chaîne vide en cas d'erreur. |
Syntaxe 16
StrVal = LOGDISPLAY(Mode, Window, Branch, Identity, Line, Column);
Type de retour : STR.
| Argument | Définition |
| Line | Numéro de ligne (1ère ligne = 1) dans le buffer de la fenêtre de consignations. Type INTEGER |
| Column | Numéro de colonne (1ère colonne = 1) dans le buffer de la fenêtre de consignations. Type INTEGER |
Exécution
| Mode | Mnémonique | Action |
| 35 | GETCELL |
Retourne le contenu de la cellule spécifiée ou une chaîne vide en cas d'erreur. |
Syntaxe 17
IntVal = LOGDISPLAY(Mode, Window, Branch, Identity, AutoRefreshPeriod, PauseWhenNavigating );
Type de retour : INTEGER.
| Argument | Définition |
| AutoRefreshPeriod | Période d'auto-refresh en secondes. Si exécuté dans le contexte d'une session WebVue, la valeur ne peut pas être inférieure à 5 secondes. Type INTEGER |
| PauseWhenNavigating |
Flag indiquant si la fenêtre de consignations est mise en pause en utilisant les boutons de navigation. 0 = Pas de pause, 1 = pause. Type INTEGER |
Exécution
| Mode | Mnémonique | Action |
| 26 | AUTOREFRESH_SET |
Définit l'action et la période d'auto-refresh en cours de navigation. Retour : 1 si OK, 0 sinon. |
Syntaxe 18
IntVal = LOGDISPLAY(Mode, Window, Branch, Identity, LineNumber);
Type de retour : STR.
|
Argument |
Définition |
|
LineNumber |
Position de la ligne dans la fenêtre de consignation, commence à 1. |
Exécution
|
Mode |
Mnémonique |
Action |
|
38 |
GET_NAME_FROM_LINE |
Retourne le nom de l'élément à la ligne sélectionnée ou une chaîne de caractères vide en cas d'erreur. |
Syntaxe 19
IntVal = LOGDISPLAY(Mode, Window, Branch, Identity, Column, Width);
Type de retour : INTEGER.
| Argument | Description |
| Column | Numéro de colonne 1 dans le buffer de la fenêtre de consignations. Type INTEGER |
| Width | Largeur de colonne en pixels. Plage 0 à 3000. Type INTEGER |
Exécution
| Mode | Mnémonique | Action |
| 40 | SETCOLUMNWIDTH |
Définit la largeur de la colonne spécifiée en pixels. |
Syntaxe 20
IntVal = LOGDISPLAY(Mode, Window, Branch, Identity, Column);
Type de retour : INTEGER.
| Argument | Description |
| Column | Numéro de colonne 1 dans le buffer de la fenêtre de consignations. Type INTEGER |
Exécution
| Mode | Mnémonique | Action |
| 41 | GETCOLUMNWIDTH |
Récupère la largeur de la colonne spécifiée en pixels. |
Exemple
Pour un exemple, sélectionnez le lien Exemple ci-dessus.