Voir également Exemple Infos complémentaires
Gestion des fenêtres d'alarmes, notamment navigation dans la liste des alarmes, actions sur les alarmes 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.
| Mode | Mnémonique | Syntaxe | Support WebVue |
| 0 | BEGIN | 1 | Oui |
| 1 | BEFORE | 1 | Oui |
| 2 | SELECT | 8 | Non |
| 3 | AFTER | 1 | Oui |
| 4 | END | 1 |
Oui |
| 5 | LINEUP | 1 | Oui |
| 6 | LINEDOWN | 1 | Oui |
| 7 | MODE | 1 | Non |
| 8 | DYNAMIC | 1 | Non |
| 9 | DOMAIN | 2 | Oui |
| 10 | NATURE | 2 | Oui |
| 11 | MINPRIO | 3 | Oui |
| 12 | MAXPRIO | 3 | Oui |
| 13 | ACK_ON | 4 | Oui |
| 14 | ACK_OFF | 4 | Oui |
| 15 | NOACK_ON | 4 | Oui |
| 16 | NOACK_OFF | 4 | Oui |
| 17 | NS | 4 | Oui |
| 18 | SELECTED | 5 | Oui |
| 19 | SELECNAME | 5 | Oui |
| 20 | ACTION1 | 1 | Non |
| 21 | ACTION2 | 1 | Non |
| 22 | FORMAT | 15 | Non |
| 23 | USERMASK | 4 | Oui |
| 24 | LIST | 1 | Non |
| 25 | PRINTALL | 1, 11 | Non |
| 26 | FILTER | 7 | Oui |
| 27 | ACK_SELECTED | 1 | Oui |
| 28 | ACK_DISPLAY | 1 | Oui |
| 29 | MASK_SELECTED | 1 | Oui |
| 30 | UNMASK_SELECTED | 1 | Oui |
| 31 | PRINT_SELECTED | 1, 11 | Non |
| 32 | PRINT_DISPLAY | 1, 11 | Non |
| 33 | PROGMASK | 4 | Oui |
| 34 | VARMASK | 4 | Oui |
| 35 | IS_ACTION1 | 1 | Non |
| 36 | IS_ACTION2 | 1 | Non |
| 37 | DATERANGE | 6 | Non |
| 38 | MAINTENANCEMASK | 4 | Oui |
| 39 | UNSELECTALL | 1 | Oui |
| 40 | ONLINESELECT | 9 | Oui |
| 41 | SELECDATETIME | 10 | Non |
| 42 | MASK_DISPLAY | 1 | Oui |
| 43 | UNMASK_DISPLAY | 1 | Oui |
| 44 | LINESELECT | 12 | Oui |
| 45 | SETSORT | 13 | Oui |
| 46 | GETSORT | 14 | Oui |
| 47 | ISLINEVISIBLE | 16 | Non |
| 48 | ISLINESELECTED | 16 | Non |
| 49 | GETLINECOUNT | 1 | Non |
| 50 | GET_NAME_FROM_LINE | 17 | Non |
| 51 | COPY_CLIPBOARD | 18 | Non |
| 52 | GETCELL | 20 | Non |
| 53 | GETLINES | 19 | Non |
| 54 | GETSELECTEDLINES | 19 | Non |
| 57 | SETCOLUMNWIDTH | 21 | Non |
| 58 | GETCOLUMNWIDTH | 22 | Non |
Arguments communs à tous les modes
|
Argument |
Définition |
|
Window |
Nom de la fenêtre qui contient l'animation à piloter. Type STR |
|
Branch |
Branche (si elle existe) de la fenêtre. Branche éventuelle de la fenêtre "#B" pour utiliser la branche courante du programme. Type STR |
|
Identity |
Identifiant de l'animation fenêtre d'alarme. Type STR |
Syntaxe 1
IntVal = ALARMDISPLAY(Mode, Window, Branch, Identity);
Type de retour : INTEGER.
Exécution
|
Mode |
Mnémonique |
Action |
|
0 |
BEGIN |
Début de liste. |
|
1 |
BEFORE |
Remonte d'une page. |
|
3 |
AFTER |
Descend d'une page. |
|
4 |
END |
Fin de liste. |
|
5 |
LINEUP |
Remonte d'une ligne. |
|
6 |
LINEDOWN |
Descend d'une ligne. |
|
7 |
MODE |
Passage aux modes liste ou figé. |
|
8 |
DYNAMIC |
Passage en mode fil de l'eau. |
|
20 |
ACTION1 |
Exécute l'action associée n° 1 à l'alarme sélectionnée. |
|
21 |
ACTION2 |
Exécute l'action associée n° 2 à l'alarme sélectionnée. |
|
24 |
LIST |
Bascule dans le mode Liste quel que soit le mode préalable. |
|
25 |
PRINTALL |
Imprime toutes les lignes du buffer configuré dans la fenêtre d'alarme. |
|
27 |
ACK_SELECTED |
Acquitte l'alarme sélectionnée. |
|
28 |
ACK_DISPLAY |
Acquitte toutes les alarmes visibles dans la fenêtre. |
|
29 |
MASK_SELECTED |
Masque l'alarme sélectionnée. |
|
30 |
UNMASK_SELECTED |
Démasque l'alarme sélectionnée. |
|
31 |
PRINT_SELECTED |
Imprime l'alarme sélectionnée. |
|
32 |
PRINT_DISPLAY |
Imprime toutes les alarmes visibles dans la fenêtre. |
|
|
|
Pour tous les modes : Retour : 1 si OK, 0 sinon. |
|
35 |
IS_ACTION1 |
Permet de savoir si l'alarme sélectionnée a une action associée 1. Retour : 1 si OK, 0 sinon (fenêtre introuvable, type d'animation incorrect, repère introuvable). |
|
36 |
IS_ACTION2 |
Permet de savoir si l'alarme sélectionnée a une action associée 2. Retour : 1 si OK, 0 sinon (fenêtre introuvable, type d'animation incorrect, repère introuvable). |
|
|
|
Retour pour les modes 35 et 36 :
|
|
39 |
UNSELECTALL |
Désélectionne toutes les lignes. |
| 42 | MASK_DISPLAY | Masque toutes les alarmes visibles dans la fenêtre. |
| 43 | UNMASK_DISPLAY | Démasque toutes les alarmes visibles dans la fenêtre. |
| 49 | GETLINECOUNT | Retourne le nombre de lignes dans l'affichage. |
|
|
|
Retour pour tous les modes sauf indication contraire : 1 si OK, 0 sinon (fenêtre introuvable, type d'animation incorrect, position inexistante, exécuté en contexte WebVue sans être supporté). |
Syntaxe 2
IntVal = ALARMDISPLAY(Mode, Window, Branch, Identity, Name);
Type de retour : INTEGER.
|
Argument |
Définition |
|
Name |
Le nom du nouveau domaine ou nature de la fenêtre d'alarme. Pour spécifier tous les domaines ou toutes les natures, Name doit être une chaîne vide "". Type STR. |
Exécution
Sélectionnez un nouveau domaine ou nature pour la fenêtre d'alarme.
|
Mode |
Mnémonique |
Action |
|
9 |
DOMAIN |
L'argument Name fournit un nouveau domaine. |
|
10 |
NATURE |
L'argument Name fournit une nouvelle nature. |
|
|
Pour tous les modes : Retour : 1 si OK, 0 sinon. |
Syntaxe 3
IntVal = ALARMDISPLAY(Mode, Window, Branch, Identity, Priority);
Type de retour : INTEGER.
|
Argument |
Mnémonique |
|
Priority |
Spécifie le niveau de priorité pour le filtre d'alarme |
Priority doit être de type numérique. Si Priority est hors bornes (<0 or >29), la fonction renvoie 0.
Exécution
Sélectionne les alarmes à visualiser en appliquant le filtre.
|
Mode |
Mnémonique |
Action |
|
11 |
MINPRIO |
L'argument Priority fournit une nouvelle priorité minimale. |
|
12 |
MAXPRIO |
L'argument Priority fournit une nouvelle priorité minimale. |
|
|
Pour les deux modes : Retour : 1 si OK, 0 sinon. |
Syntaxe 4
IntVal = ALARMDISPLAY(Mode, Window, Branch, Identity, Flag);
Type de retour : INTEGER
|
Argument |
Définition |
|
Flag |
Flag de type numérique = 1 pour activer, = 0 pour désactiver le mode sélectionné. |
Exécution
Active et désactive les états d'alarme dans le filtre d'alarme.
|
Mode |
Mnémonique |
Action |
|
13 |
ACK_ON |
Présentes acquittées. |
|
14 |
ACK_OFF |
Absentes acquittées. |
|
15 |
NOACK_ON |
Présentes non acquittées. |
|
16 |
NOACK_OFF |
Absentes non acquittées. |
|
17 |
NS |
Invalides. |
|
23 |
USERMASK |
Masquées opérateurs. |
|
33 |
PROGMASK |
Masquées par programme. |
|
34 |
VARMASK |
Masquées par variable. |
|
38 |
MAINTENANCEMASK |
Alarmes prises en compte. |
|
|
Pour tous les modes : Retour : 1 si OK, 0 sinon. |
Syntaxe 5
StrVal = ALARMDISPLAY(Mode, Window, Branch, Identity);
Type de retour : STR
Exécution
|
Mode |
Mnémonique |
Action |
|
18 |
SELECTED |
Récupère le rang de la dernière alarme sélectionnée; représentée en inverse vidéo dans la fenêtre d'alarme. Ceci est utilisé en conjonction avec ALARMDISPLAY mode 7 (MODE). |
|
19 |
SELECNAME |
Récupère le nom de la dernière alarme sélectionnée. La chaîne retournée peut être passée en argument au mode ACKTAG du verbe ALARMDISPLAY pour un acquittement. |
Syntaxe 6
IntVal = ALARMDISPLAY(Mode, Window, Branch, Identity, StartDate, EndDate);
Type de retour : INTEGER.
|
Argument |
Définition |
|
StartDate |
Date de début, exprimée en nombre de millisecondes depuis 1980. Voir l'instruction DateTimeValue. |
|
EndDate |
Date de fin, exprimée en nombre de millisecondes depuis 1980. Voir l'instruction DateTimeValue. |
Exécution
|
Mode |
Mnémonique |
Action |
|
37 |
DATERANGE |
Sélection de date à date de l'ensemble des alarmes en cours et affichage dans l'animation. |
|
|
|
Retour : 1 si OK, 0 sinon (fenêtre introuvable, etc.) |
Pour annuler ce filtre il faut forcer StartDate et EndDate à 0.
Notes pour les cas particuliers :
Si seulement StartDate est renseignée (EndDate=0) : l'animation restitue l'ensemble des alarmes depuis la date de début jusqu'à celles qui arrivent en temps réel (à concurrence du nombre d'alarmes paramétrées dans la liste.
Si seulement EndDate est renseignée (StartDate=0) : l'animation restitue l'ensemble des alarmes depuis la plus ancienne réelle (à concurrence du nombre d'alarmes paramétrées dans la liste).
Syntaxe 7
IntVal = ALARMDISPLAY(Mode, Window, Branch, Identity, Filter);
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 |
|
26 |
FILTER |
Sélection de date à date de l'ensemble des alarmes en cours et affichage dans l'animation. |
|
|
|
Retour : 1 si OK, 0 sinon (fenêtre introuvable, etc.) |
Syntaxe 8
IntVal =ALARMDISPLAY(Mode, Window, Branch, Identity, AlarmName, Selected );
Type de retour : INTEGER
|
Argument |
Définition |
|
AlarmName |
Nom de l'alarme à laquelle la ligne sélectionnée fait référence. |
|
Selected |
Etat de la ligne : sélectionnée (0) ou non (1). |
Exécution
|
Mode |
Mnémonique |
Action |
|
2 |
SELECT |
Sélectionne une ligne de la fenêtre d'alarmes, en mode Liste. |
|
|
|
Retour : 1 si OK, 0 sinon (fenêtre introuvable, type d'animation erroné, repère introuvable). |
Syntaxe 9
IntVal =ALARMDISPLAY(Mode, Window, Branch, Identity, Program, Branch, Function[, Farg]);
Type de retour : INTEGER
|
Argument |
Définition |
|
Program |
Programme à utiliser. |
|
Function |
Fonction à exécuter. |
|
Farg |
Contient de 1 à 8 arguments séparés par des virgules "," (facultatif, maximum 255 caractères). |
Vous pouvez utiliser la commande GETARG, au début de la fonction qui doit être exécutée, pour récupérer les valeurs des arguments contenus dans Farg.
Exécution
|
Mode |
Mnémonique |
Action |
|
40 |
ONLINESELECT |
Répond à l'événement de la sélection d'une ligne. Vous permet de spécifier une fonction qui sera exécutée lorsqu'une ligne dans l'animation d'affichage est sélectionnée, soit par clic de souris ou par programme avec le mode SELECT. |
|
|
|
Retour : 1 si OK, 0 sinon (fenêtre introuvable, type d'animation erroné, repère introuvable). |
Syntaxe 10
DblVal =ALARMDISPLAY(Mode, Window, Branch, Identity);
Type de retour : DOUBLE.
Exécution
|
Mode |
Mnémonique |
Action |
|
41 |
SELECDATETIME |
Récupère l'horodate de la dernière alarme sélectionnée dans une fenêtre d'alarme. |
|
|
|
Retour : La date et l'heure en nombre de millisecondes depuis le 1er Janvier 1980, ou 0 en cas d'erreur (aucune alarme sélectionnée, fenêtre introuvable, type d'animation incorrect, repère introuvable). |
Le mnémonique de l'instruction est 'SELECDATETIME (et non 'SELECT...').
Syntaxe 11
IntVal = ALARMDISPLAY(Mode, Window, Branch, Identity[, PrintFormat]);
Type de retour : INTEGER
|
Argument |
Définition |
|
PrintFormat |
Paramètre optionnel pour la sélection du format d'impression : 0 : Imprime l'alarme(s) en utilisant le format d'affichage défini dans l'onglet Affichage de l'alarme. (par défaut). 1 : Imprime l'alarme(s) en utilisant le format d'affichage défini dans l'onglet Exécution de la fenêtre d'alarme. |
Exécution
|
Mode |
Mnémonique |
Action |
|
25 |
PRINTALL |
Imprime toutes les lignes du buffer configuré dans la fenêtre d'alarme. |
|
31 |
PRINT_SELECTED |
Imprime l'alarme sélectionnée. |
|
32 |
PRINT_DISPLAY |
Imprime toutes les alarmes visibles dans la fenêtre. |
|
|
|
Retour pour tous ces modes : 1 si OK, 0 sinon. |
Syntaxe 12
IntVal = ALARMDISPLAY(Mode, Window, Branch, Identity, Program, ProgramBranch, Function, Arguments);
Type de retour : INTEGER
|
Argument |
Définition |
|
Program |
Fonction du programme à exécuter. |
|
ProgramBranch |
Paramètres du programme. |
| Function | Fonction du programme à exécuter. |
| Arguments | Paramètres du programme. |
Exécution
|
Mode |
Mnémonique |
Action |
|
44 |
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 (paramètre incorrect...). |
L'instruction XMLPATH est utilisée pour obtenir les informations du mode LINESELECT. Un namespace est créé automatiquement en utilisant Branch, Window et Identity. Pour des informations sur son format, voir la rubrique XMLPATH.
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 13
IntVal = ALARMDISPLAY(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 |
|
45 |
SETSORT |
Tri dynamique d'une liste d'alarme par une colonne. |
|
|
|
Retour : 1 si OK, 0 sinon (paramètre incorrect...). |
Syntaxe 14
IntVal = ALARMDISPLAY(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 |
|
46 |
GETSORT |
Obtient le status d'un tri. |
|
|
|
Retour : 1 si OK, 0 sinon (paramètre incorrect...). |
L'instruction XMLPATH est utilisée pour obtenir les informations du mode GETSORT. Un namespace est créé automatiquement en utilisant Branch, Window et Identity. Référez-vous à la rubrique XMLPATH est utilisé pour obtenir les informations sur son format.
Les significations des chemins XML sont les suivantes.
|
Chemin |
Définition |
| getsort/column | Valeurs 0 à 7 pour identifier la colonne, -1 pour réinitialiser le tri. |
| getsort/sort | Valeur 1 pour un tri ascendant, 0 pour descendant. |
Syntaxe 15
IntVal = ALARMDISPLAY(Mode, Window, Branch, Identity, DateFormat);
Type de retour : INTEGER.
|
Argument |
Définition |
|
DateFormat |
Chaîne de caractères définissant un nouveau format d'affichage pour des dates dans une alarme. |
Exécution
|
Mode |
Mnémonique |
Action |
|
22 |
FORMAT |
Sélectionne un nouveau format pour la fenêtre d'alarmes. L'argument DateFormat fournit un nouveau format d'affichage. Exemple de cette syntaxe : #h:#m:#s\t#D/#M/#y\t#T\t#E Il est n'est pas possible de modifier dynamiquement les titres des colonnes. |
|
Retour : 1 si OK, 0 sinon. |
||
Syntaxe 16
IntVal = ALARMDISPLAY(Mode, Window, Branch, Identity, LineNumber);
Type de retour : INTEGER.
|
Argument |
Définition |
|
LineNumber |
Numéro correspondant à la position de la ligne. |
Exécution
|
Mode |
Mnémonique |
Action |
|
47 |
ISLINESELECTED |
Test si la ligne est sélectionnée. |
| 48 | ISLINEVISIBLE | Test si la ligne est visible. Retour : 1 si la ligne est visible, 0 si la ligne est dans le buffer mais n'est pas visible ou si exécuté en contexte WebVue, -1 si la ligne n'existe pas. |
Syntaxe 17
IntVal = ALARMDISPLAY(Mode, Window, Branch, Identity, LineNumber);
Type de retour : STRING
|
Argument |
Définition |
|
LineNumber |
Numéro correspondant à la position de la ligne (la 1ère ligne est à la position 1). |
Exécution
|
Mode |
Mnémonique |
Action |
|
50 |
GET_NAME_FROM_LINE |
Retourne le nom de l'alarme de la ligne sélectionnée ou une chaîne de caractères vide en cas d'erreur. |
Syntaxe 18
IntVal = ALARMDISPLAY(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 |
| 51 | COPY_CLIPBOARD | Copie les lignes sélectionnées vers le presse-papier Windows. Retour : 1 si OK, 0 sinon. |
Syntaxe 19
StrVal = ALARMDISPLAY(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 d'alarmes. Type INTEGER |
| LineEnd | Numéro de colonne (1ère colonne = 1) dans le buffer de la fenêtre d'alarmes. 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 |
| 53 | GETLINES | Retourne les lignes de LineStart à LineEnd (inclusive) dans une seule chaîne délimitée par les caractères ColSeparator et LineSeparator. 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 sélectionnées de la fenêtre d'alarmes. |
| 54 | GETSELECTEDLINES | Idem à GETLINES excepté que seules les lignes sélectionnées sont retournées. |
| Retourne une chaîne de caractères vide en cas d'erreur. |
Syntaxe 20
StrVal = ALARMDISPLAY(Mode, Window, Branch, Identity, Line, Column);
Type de retour : STR
| Argument | Définition |
| Line | Numéro de colonne (1ère colonne = 1) dans le buffer de la fenêtre d'alarmes. Type INTEGER |
| Column | Numéro de colonne (1ère colonne = 1) dans le buffer de la fenêtre d'alarmes. Type INTEGER |
Exécution
| Mode | Mnémonique | Action |
| 52 | GETCELL |
Retourne le contenu de la cellule spécifique ou une chaîne de caractères vide en cas d'erreur. |
Syntaxe 21
IntVal = ALARMDISPLAY(Mode, Window, Branch, Identity, Column, Width);
Type de retour : INTEGER.
| Argument | Description |
| Column | 1 index numérique basé sur une colonne dans la fenêtre d'alarme. Type INTEGER |
| Width | Largeur de colonne en pixels. Plage 0 à 3000. Type INTEGER |
Exécution
| Mode | Mnémonique | Action |
| 57 | SETCOLUMNWIDTH |
Définit la largeur de la colonne spécifiée en pixels. |
Syntaxe 22
IntVal = ALARMDISPLAY(Mode, Window, Branch, Identity, Column);
Type de retour : INTEGER.
| Argument | Description |
| Column | 1 index numérique basé sur une colonne dans la fenêtre d'alarme. Type INTEGER |
Exécution
| Mode | Mnémonique | Action |
| 58 | GETCOLUMNWIDTH |
Récupère la largeur de la colonne spécifiée en pixels. |
Exemple
Pour un exemple, sélectionner le lien exemple ci-dessus. En particulier, pour les syntaxes 12 et 14, voir des exemples similaires dans les modes 23 et 25 du verbe LOGDISPLAY.