Manuel des Scripts Automation Engine > Organisation fonctionnelle > Traitement d'Evènements > GET_CONSOLE

GET_CONSOLE, GET_EVENT_INFO

Fonction de script : lit les valeurs des événements qui viennent de la console, des fichiers ou de la base de données.

Syntaxe

GET_CONSOLE(Keyword, [Index])
GET_EVENT_INFO(Keyword, [Index])

Syntaxe	Description / format
Mot clé	Indique quelle partie du message doit être lue. Format : Nom AE, littéral de script ou variable de script Les mots clés pour chaque plate-forme sont expliqués dans les tableaux ci-dessous.
Index	Ne peut être utilisé qu'en combinaison avec les mots clés INSERT, RESULT1 et RESULT2. Format : littéral de script, nombre ou variable de script. Valeur par défaut : 1 Pour INSERT : Accès aux champs à 16 bits d'un message de console sur z/OS ou à la partie variable du texte de notification (Insert) d'un message OS/400. Pour RESULT1 et RESULT2 : Numéro de colonne de la requête SQL (événement de la base de données)

Syntaxe

Description / format

Mot clé

Indique quelle partie du message doit être lue.
Format : Nom AE, littéral de script ou variable de script

Les mots clés pour chaque plate-forme sont expliqués dans les tableaux ci-dessous.

Index

Ne peut être utilisé qu'en combinaison avec les mots clés INSERT, RESULT1 et RESULT2.

Format : littéral de script, nombre ou variable de script. Valeur par défaut : 1

Pour INSERT :

Accès aux champs à 16 bits d'un message de console sur z/OS ou à la partie variable du texte de notification (Insert) d'un message OS/400.

Pour RESULT1 et RESULT2 :

Numéro de colonne de la requête SQL (événement de la base de données)

Mots clés

Mot clé	Console BS2000	Console z/OS	Console OS/400	Console SAP (ABAP)	Console SAP (XI)	Console SAP (Java)	Console Windows	Système de fichiers	Système de fichiers automatiquement z/OS	Base de données
ACCESS
ACTIVATIONSTATE
ALERT_OPTION
CATEGORY
CHANNEL
DDNAME
EVENT_ADDITIONAL_PARM
EVENT_COUNTOFJOBS
EVENT_GUID
EVENT_ID
EVENT_PARM
EVENT_PROCESSSTATE
EVENT_SERVER
EVENT_STATE
EVENT_TYPE
FILENAME
FILESIZE
ID
INFO_ACTION
INFO_TEXT
INSERT
INSERT_COUNT
JOB_ABENDED
JOB_ENDED
JOB_ID
JOB_NAME
LPAR_NAME
MEMGEN
MSG_DESCRIPTOR
MSG_FILE_LIBRARY
MSG_FILENAME
MSG_ID
MSG_KEY
MSG_LEVEL
MSG_LIBRARY_USED
MSG_MISC
MSG_SEVERITY
MSG_TEXT
MSGNR
MSGTYPE, MSGTYP
OS_NAME
PARTY
PROCESSID
PROGRAM_NAME
REPLY_ID
RESULT
RESULT1
RESULT2
RETCODE
RETCODE_STATE
SEND_JOB
SEND_JOB_NUMBER
SEND_USER_PROFILE
SERVICE
SMS_MANAGEMENT_CLASS SMS_DATA_CLASS SMS_STORAGE_CLASS
SOURCE
STATE
STEP_NAME
SYS_NAME
SYSPLEX_NAME
TIMESTAMP
TYPE
USER

Notez que les mots clés listés dans la colonne "Système de fichiers", ne peuvent être utilisés que pour les événements de systèmes de fichiers avec le paramètre "Vérification" égal à "FILE_SIZE" ou "vide" (avec ou sans combinaison de "FILE_STABLE" ou "FILE_CHANGED") et "PATH_FILE_COUNT" (uniquement en combinaison avec "FILE_STABLE" ou "FILE_CHANGED").

Description

Mot clé	Description
ACCESS	Accès au fichier. Valeur autorisée : "CLOSE" : ferme le fichier
ACTIVATIONSTATE	Statut de l'adaptateur Valeurs autorisées : "STARTED" et "STOPPED"
ALERT_OPTION	Retourne si et quand une alerte SNA est créée et envoyée au message. Valeurs autorisées : "DEFER" : une alerte est envoyée après l'analyse locale du problème. "IMMED" : une alerte est immédiatement envoyée en même temps que le message. L'attribut "Autoriser l'alarme" doit être défini à "YES" pour la file d'attente des messages. "NO" : aucune alerte n'est envoyée. "UNATTEND" : une alerte est envoyée uniquement lorsque le système est exécuté en mode non surveillé. Le statut d'alarme de l'attribut de réseau (ALRSTS) est "UNATTEND".
CATEGORY	Catégorie de l'événement
CHANNEL	Canal de communication
DDNAME	Désignation DD
EVENT_ADDITIONAL_PARM	Paramètres supplémentaires des événements du planificateur Java de SAP.
EVENT_COUNTOFJOBS	Nombre de jobs SAP déclenchés (ABAP)
EVENT_GUID	Numéro d'instance de l'événement SAP (ABAP)
EVENT_ID	ID de l'événement (ABAP /événement Java)
EVENT_PARM	Paramètres d'événement SAP (événements ABAP/Java)
EVENT_PROCESSSTATE	Statut du traitement SAP (ABAP)
EVENT_SERVER	Serveur d'événements SAP (ABAP)
EVENT_STATE	Statut de l'événement SAP (ABAP)
EVENT_TYPE	Type d'événement du planificateur Java dans SAP
FILENAME	Nom du fichier Pour les événements du système de fichiers avec des caractères génériques, la valeur suivante est renvoyée comme nom de fichier : ALL : si l'option "Vérifier tous les fichiers" est activée. ONE: si l'option "Vérifier tous les fichiers" est désactivée.
FILESIZE	Taille du fichier
ID	Identifiant du message
INFO_ACTION	Action Valeurs autorisées : "Y" et "N" "Y" : un objet a été activé. "N" : aucun objet n'a été activé.
INFO_TEXT	Nom de l'objet activé.
INSERT	Index permet d'accéder à une partie variable spécifique du message.
INSERT_COUNT	Détermine le nombre de parties variables du message.
JOB_ABENDED	Statut de fin du job ayant fermé le fichier Valeurs autorisées : "Y" et "N" "Y" : le job s'est terminé de façon anormale. "N" : le Job s'est terminé normalement.
JOB_ENDED	Statut du job ayant fermé le fichier Valeurs autorisées : "Y" et "N" "Y" : le job est déjà terminé. "N" : le job est encore en cours.
JOB_ID	Nom identifiant le job
LPAR_NAME	Renvoie le nom du LPAR.
JOB_NAME	Nom du job
MEMGEN	Nom du membre ou numéro de génération
MSG_DESCRIPTOR	Description du message dans un champ de 16 bits. Bit 01(correspond à X'80') = SYSTEM_FAILURE : défaillance système Bit 02 (correspond à X'40') = IMMEDIATE_ACTION : action immédiate requise Bit 03 (correspond à X'20') = EVENTUAL_ACTION : action éventuelle requise Bit 04 (correspond à X'10') = SYSTEM_STATUS : statut du système Bit 05 (correspond à X'08') = IMMEDIATE_COMMAND : réponse de commande immédiate Bit 06 (correspond à X'04') = JOB_STATUS : statut du job Bit 07 (correspond à X'02') = APPLICATION : programme / processeur de l'application Bit 08 (correspond à X'01') = OUT_OF_LINE : hors ligne Bit 09 (correspond à X'80') = OPERATOR_REQUEST : requête de l'opérateur Bit 10 (correspond à X'40') = TRACK_COMMAND_R : suivi des réponses de commande Bit 11 (correspond à X'20') = CRITICAL_ACTION : action d'évaluation critique Bit 12 (correspond à X'10') = IMPORTANT_INFO : informations importantes Bit 13 (correspond à X'08') = PREVIOUSLY_AUTO : automatisé précédemment Bit 14 (correspond à X'04') : réservé Bit 15 (correspond à X'02') : réservé Bit 16 (correspond à X'01') : réservé
MSG_FILE_LIBRARY	Nom de la bibliothèque contenant le fichier de message ou les valeurs utilisées par le programme d'envoi "CURLIB" ou "LIBL".
MSG_FILENAME	Nom du fichier message contenant le message reçu.
MSG_ID	Identifiant message du message reçu. En cas de message improvisé, un espace est renvoyé.
MSG_KEY	Clé de message du message reçu. Valeur à 4 chiffres au format hexadécimal X'xxxxxxxx'.
MSG_LEVEL	Niveau d'urgence du message dans un champ de 16 bits. Bit 01(correspond à X'80') = WTOR - WTOR Bit 02 (correspond à X'40') = IMMEDIATE_ACTION : action immédiate Bit 03 (correspond à X'20') = CRITICAL_ACTION : action critique éventuelle Bit 04 (correspond à X'10') = EVENTUAL_ACTION : action éventuelle requise Bit 05 (correspond à X'08') = INFO : information Bit 06 (correspond à X'04') = BROADCAST Bit 07 (correspond à X'02') : réservé Bit 08 (correspond à X'01') : réservé Bit 09 (correspond à X'80') : réservé Bit 10 (correspond à X'40') : réservé Bit 11 (correspond à X'20') : réservé Bit 12 (correspond à X'10') : réservé Bit 13 (correspond à X'08') : réservé Bit 14 (correspond à X'04') : réservé Bit 15 (correspond à X'02') : réservé Bit 16 (correspond à X'01') : réservé
MSG_LIBRARY_USED	Nom effectif de la bibliothèque utilisée pour envoyer le message. La bibliothèque peut contenir des instructions d'écrasement et n'est donc pas nécessairement la biblitohèque dans laquelle le message se trouve actuellement.
MSG_MISC	Diverses informations sur le message dans un champ de 16 bits. Bit 01(correspond à X'80') = DISPLAY_UD_MSG : afficher les messages UD Bit 02 (correspond à X'40') = DISPLAY_ONLY_UD_MSG : afficher uniquement les messages UD Bit 03 (correspond à X'20') = QUEUE_BY_ID_ONLY : trier selon ID Bit 04 (correspond à X'10') = QUEUE_BY_AUTO : trier selon automatisation Bit 05 (correspond à X'08') = QUEUE_BY_HARDCOPY : trier selon version papier Bit 06 (correspond à X'04'): réservé Bit 07 (correspond à X'02') : réservé Bit 08 (correspond à X'01') : réservé Bit 09 (correspond à X'80') = ECHO_OPERATOR_CMD : commande écho opérateur Bit 10 (correspond à X'40') = ECHO_INTERNAL_CMD : commande écho interne Bit 11 (correspond à X'20') = RESULT_OF_WTL_MACRO : résultat de la macro wtl Bit 12 (correspond à X'10') : réservé Bit 13 (correspond à X'08') : réservé Bit 14 (correspond à X'04') : réservé Bit 15 (correspond à X'02') : réservé Bit 16 (correspond à X'01') : réservé
MSG_SEVERITY	Sévérité du message reçu. Valeurs autorisées : "0" à "99"
MSG_TEXT	Texte du message (valeur par défaut)
MSGNR	Numéro du message
MSGTYPE, MSGTYP	Type de message Valeurs autorisées spécialement pour OS/400 : "01" : fin "02" : diagnostic "04" : information "05" : requête "06" : copie de l'émetteur "08" : demande "10" : demande guidée "14" : remarque (exception déjà traitée) "15" : échappement (exception déjà traitée) "16" : remarque (exception pas encore traitée) "17" : échappement (exception pas encore traitée) "21" : réponse, validité non vérifiée "22" : réponse, validité vérifiée "23" : réponse, message par défaut "24" : réponse, réponse par défaut du système "25" : réponse issue de la liste de réponses du système
OS_NAME	Nom du système d'exploitation défini par IBM dans le message de console. Actuellement toujours "MVS".
PARTY	Partenaire
PROCESSID	Numéro de la tâche (TSN) dans le message de console.
PROGRAM_NAME	Description du programme
REPLY_ID	Reply ID du message de console.
RESULT	Indique si la condition a été remplie pour les événements du système de fichiers dotés des vérifications FILESIZE ou PATH_FILE_COUNT. Valeurs autorisées : "Y" et "N" "Y" : la condition a été remplie. "N" : la condition n'a pas été remplie.
RESULT1 RESULT2	RESULT1 et RESULT2 permettent d'accéder aux résultats de la requête SQL pour les valeurs "valeur 1" et "valeur 2" respectivement. Indiquez pour l'index le numéro de la colonne dans laquelle la valeur doit être lue. Notez qu'un événement de base de données ne lit que les 10 premières colonnes. Le contenu des colonnes excédant 255 caractères est tronqué. La fonction de script fournit la valeur " " en cas de tentative d'accès à une colonne qui n'existe pas.
RETCODE	Code retour du job dans le format converti
RETCODE_STATE	Filtrage sur le code retour Valeurs autorisées : "Y" et "N" "Y" : le code retour a été filtré. "N" : le code retour n'est pas important pour le déclenchement de l'événement.
SEND_JOB	Nom du job dans lequel le message reçu a été envoyé.
SEND_JOB_NUMBER	Numéro du job dans lequel le message reçu a été envoyé.
SEND_USER_PROFILE	Nom du profil utilisateur qui a envoyé le message reçu.
SERVICE	Service
SMS_MANAGEMENT_CLASS SMS_DATA_CLASS SMS_STORAGE_CLASS	Nom de la classe
SOURCE	Source de l'événement
STATE	Statut Valeurs autorisées : "*" "ERROR" "OK" "INACTIVE" "UNKNOWN" "UNREGISTERED"
STEP_NAME	Nom du step du job
SYS_NAME	Nom système défini par l'utilisateur
SYSPLEX_NAME	Nom du SYSPLEX
TIMESTAMP	Date et heure du message de la console.
TYPE	Type de l'événement Valeurs autorisées : "I" : information "W" : avertissement "E" : erreur "S" : surveillance réussie "F" : surveillance échouée
USER	Utilisateur

Remarques

Les scripts GET_CONSOLE et GET_EVENT_INFO peuvent être utilisés pour récupérer des informations sur un événement survenu. La syntaxe est la même dans les deux scripts.

La fonction de script GET_CONSOLE permet de récupérer les données d'un message lorsqu'un événement de console survient. Il s'agit de composants définis du message console qui peuvent être indiqués avec un mot clé. La fonction renvoie par défaut le texte du message.

Cette fonction de script peut être utilisée dans un événement de type "Console". Le message de console peut ainsi être lu dans BS2000 et z/OS. Dans OS/400, cette fonction de script sert à récupérer des informations provenant de la file d'attente des messages. La file d'attente des messages à surveiller peut être définie dans le fichier INI de l'agent OS/400.

GET_EVENT_INFO permet de lire des informations dans les scripts des événements du système de fichiers. Plusieurs mots clés sont disponibles spécialement pour z/OS.

Fonctionnalités spécifiques aux plates-formes

z/OS

Les mots clés MSG_DESCRIPTOR, MSG_LEVEL et MSG_MISC ont des fonctionnalités spéciales. Il s'agit de champs à 16 bits dont chaque bit a une signification particulière. Cette fonction de script permet d'interroger chaque bit. L'index permet d'indiquer le bit en tant que valeur ou constante. Le code retour de la fonction de script est "1" (le bit est défini) ou "0" (le bit n'est pas défini).

OS/400

Si INSERT_COUNT est le mot clé, le nombre de parties variables d'un message OS/400 peut être défini. Lorsque INSERT est le mot clé et qu'un index est indiqué, on accède à une partie variable spécifique du message. Si aucun index n'est indiqué, la fonction renvoie la première partie variable du message.

Exemples

La fonction GET_CONSOLE est utilisée pour récupérer le TSN du processus qui a déclenché l'événement.

:GET_CONSOLE(PROCESSID)

Dans le deuxième exemple, le nombre de parties variables d'un message OS/400 est déterminé en premier. Puis, une boucle de traitement est exécutée dans laquelle toutes les insertions sont écrites dans le rapport d'activation.

:SET &COUNT# = GET_CONSOLE("INSERT_COUNT")
:SET &IDX# = 1
:WHILE &COUNT# > 0
:   SET &INSERT# = GET_CONSOLE("INSERT", &IDX#)
:   SET &HELP# = FORMAT(&IDX#, "000")
:   PRINT "INSERT[&HELP#] = '&INSERT#'"
:   SET &IDX# = ADD(&IDX#, 1)
:   SET &COUNT# = SUB(&COUNT#, 1)
:ENDWHILE

Les lignes suivantes sont journalisées dans le rapport d'activation :

20010110/235011.000 - U0020408 INSERT[001] = 'QPFRMON'
20010110/235011.000 - U0020408 INSERT[002] = 'QPGMR'
20010110/235011.000 - U0020408 INSERT[003] = '007982'
20010110/235011.000 - U0020408 INSERT[004] = '23:48:43'
20010110/235011.000 - U0020408 INSERT[005] = '10/01/01'
20010110/235011.000 - U0020408 INSERT[006] = '0'

Dans le troisième exemple, un composant du message console de z/OS est demandé. Le bit 03 du mot clé MSG_DESCRIPTOR est lu. Le bit 03 est indiqué en tant que valeur ou en tant que constante.

:SET &RET# = GET_CONSOLE("MSG_DESCRIPTOR", 3)

:SET &RET# = GET_CONSOLE("MSG_DESCRIPTOR", "EVENTUAL_ACTION")

L'exemple suivant montre un extrait de script qui récupère le nom du fichier et qui lit le contenu du fichier ligne par ligne.

:SET &FILE NAME# = GET_EVENT_INFO (FILENAME)
:SET &HND# = PREP_PROCESS_FILE ("MVSHOST", &FILE_NAME#)

Le cinquième exemple lit les valeurs d'une requête SQL (pour la "valeur 1") dans un événement de base de données.

Résultats SQL :

Nom	Prénom	Emplacement
Henri	Jean	Paris

Le prénom est récupéré comme suit :

:SET &First name# = GET_EVENT_INFO (RESULT1, 2)

La ligne suivante fournit l'emplacement :

:SET &Location# = GET_EVENT_INFO (RESULT1, 3)

Rubriques connexes :

Elément de script	Description
GET_BIT	Vérifie si un bit particulier est défini dans un champ de bit.

Eléments de script - Traitement d'événement

Exemples
Réaction à des événements externes

Généralités sur les scripts
Eléments de script - Liste alphabétique
Eléments de script - Répartition fonctionnelle