Automation Engine Script-Leitfaden > Funktionelle Gliederung > Ereignis-Behandlung > GET_CONSOLE

GET_CONSOLE, GET_EVENT_INFO

Script-Funktion: Liest Daten von eingetretenen Konsolen-, Dateisystem- und Datenbank-Ereignissen aus.

Syntax

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

Syntax	Beschreibung/Format
Begriff	Gibt an, welcher Bestandteil der Meldung gelesen werden soll. Format: AE-Name, Script-Literal oder Script-Variable Die Begriffe für die einzelnen Plattformen werden in den unten stehenden Tabellen erläutert.
Index	Kann nur in Verbindung mit den Begriffen INSERT, RESULT1 und RESULT2 verwendet werden. Format: Script-Literal, Zahl oder Script-Variable. Standardwert: 1 Für INSERT: Zugriff auf die 16-Bit-Felder einer Konsolen-Meldung in z/OS und Zugriff auf den variablen Teil des Nachrichtentextes (Insert) einer OS/400-Nachricht. Für RESULT1 und RESULT2: Nummer der Spalte der SQL-Abfrage (Datenbank-Ereignis)

Syntax

Beschreibung/Format

Begriff

Gibt an, welcher Bestandteil der Meldung gelesen werden soll.
Format: AE-Name, Script-Literal oder Script-Variable

Die Begriffe für die einzelnen Plattformen werden in den unten stehenden Tabellen erläutert.

Index

Kann nur in Verbindung mit den Begriffen INSERT, RESULT1 und RESULT2 verwendet werden.

Format: Script-Literal, Zahl oder Script-Variable. Standardwert: 1

Für INSERT:

Zugriff auf die 16-Bit-Felder einer Konsolen-Meldung in z/OS und Zugriff auf den variablen Teil des Nachrichtentextes (Insert) einer OS/400-Nachricht.

Für RESULT1 und RESULT2:

Nummer der Spalte der SQL-Abfrage (Datenbank-Ereignis)

Begriffe

Begriff	Konsole BS2000	Konsole z/OS	Konsole OS/400	Konsole SAP (ABAP)	Konsole SAP (XI)	Konsole SAP (Java)	Konsole Windows	Dateisystem	Dateisystem automatisch z/OS	Datenbank
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

Bitte beachten Sie, dass die Verwendung der Schlüsselwörter, die in der Spalte „Dateisystem“ aufgelistet sind, nur bei Dateisystem-Ereignissen mit der Einstellung für „Prüfung“ gleich „FILE_SIZE“ bzw. „leer“ (mit oder ohne Kombination von „FILE_STABLE“ oder „FILE_CHANGED“) und „PATH_FILE_COUNT“ (jedoch nur in Kombination mit „FILE_STABLE“ oder „FILE_CHANGED“) möglich ist.

Beschreibung

Begriff	Beschreibung
ACCESS	Zugriff auf die Datei Erlaubter Wert: "CLOSE" - Schließen der Datei
ACTIVATIONSTATE	Status des Adapters Erlaubte Werte: "STARTED" und "STOPPED"
ALERT_OPTION	Gibt zurück, ob und wann ein SNA-Warnsignal erzeugt und zur Nachricht geschickt wird. Erlaubte Werte: "DEFER" - Das Warnsignal wird nach der lokalen Problemanalyse geschickt. "IMMED" - Es wird sofort ein Warnsignal geschickt, gleichzeitig mit dem Senden der Nachricht. Für die Nachrichtenwarteschlange muss das Attribut, Alarm zu erlauben, auf "YES" gesetzt sein. "NO" - Es wird kein Warnsignal geschickt. "UNATTEND" - Ein Warnsignal wird nur dann geschickt, wenn das System im nicht überwachten Modus läuft. Dazu muss das Alarmstatus Netzwerkattribut (ALRSTS) "UNATTEND" sein.
CATEGORY	Kategorie des Ereignisses
CHANNEL	Kommunikationskanal
DDNAME	DD-Bezeichnung
EVENT_ADDITIONAL_PARM	Zusätzliche Parameter von SAP Java Scheduler Ereignissen
EVENT_COUNTOFJOBS	Anzahl an SAP-Jobs, die angestoßen wurden (ABAP)
EVENT_GUID	Instanznummer des SAP-Ereignisses (ABAP)
EVENT_ID	Ereignis-ID (ABAP/Java Ereignisse)
EVENT_PARM	SAP-Ereignisparameter (ABAP/Java-Ereignisse)
EVENT_PROCESSSTATE	SAP-Verarbeitungsstatus (ABAP)
EVENT_SERVER	SAP-Ereignisserver (ABAP)
EVENT_STATE	SAP-Ereignisstatus (ABAP)
EVENT_TYPE	SAP Java Scheduler Ereignistyp
FILENAME	Name der Datei Bei Dateisystem-Ereignissen mit Wildcards wird folgender Wert als Dateiname zurückgeliefert: ALL - Wenn die Option "Alle Dateien berücksichtigen" aktiviert ist. ONE - Wenn die Option "Alle Dateien berücksichtigen" deaktiviert ist.
FILESIZE	Größe der Datei
ID	Message ID
INFO_ACTION	Aktion Erlaubte Werte: "Y" und "N" "Y" - Ein Objekt wurde aktiviert. "N" - Es erfolgte keine Aktivierung eines Objektes.
INFO_TEXT	Name des Objektes, das aktiviert wurde.
INSERT	Greift zusammen mit Index auf einen bestimmten variablen Nachrichtenteil zu.
INSERT_COUNT	Ermittelt die Anzahl der variablen Nachrichtenteile.
JOB_ABENDED	Endstatus des Jobs, der die Datei geschlossen hat Erlaubte Werte: "Y" und "N" "Y" - Der Job endete abnormal. "N" - Der Job endete normal.
JOB_ENDED	Status des Jobs, der die Datei geschlossen hat Erlaubte Werte: "Y" und "N" "Y" - Der Job ist schon beendet. "N" - Der Job läuft noch.
JOB_ID	Identifikationsbezeichnung des Jobs
LPAR_NAME	Gibt den LPAR-Namen zurück
JOB_NAME	Name des Jobs
MEMGEN	Membername oder Generation-Number
MSG_DESCRIPTOR	Beschreibung der Meldung als 16 Bit-Feld. Bit 01(entspricht X'80') = SYSTEM_FAILURE - System failure Bit 02 (entspricht X'40') = IMMEDIATE_ACTION - Immediate Action Required Bit 03 (entspricht X'20') = EVENTUAL_ACTION - Eventual Action Required Bit 04 (entspricht X'10') = SYSTEM_STATUS - Systemstatus Bit 05 (entspricht X'08') = IMMEDIATE_COMMAND - immediate command response Bit 06 (entspricht X'04') = JOB_STATUS - job status Bit 07 (entspricht X'02') = APPLICATION - application program/processor Bit 08 (entspricht X'01') = OUT_OF_LINE - out of line Bit 09 (entspricht X'80') = OPERATOR_REQUEST - operator's request Bit 10 (entspricht X'40') = TRACK_COMMAND_R - track command response Bit 11 (entspricht X'20') = CRITICAL_ACTION - critical eventual action Bit 12 (entspricht X'10') = IMPORTANT_INFO - important information Bit 13 (entspricht X'08') = PREVIOUSLY_AUTO - previously automated Bit 14 (entspricht X'04') - reserviert Bit 15 (entspricht X'02') - reserviert Bit 16 (entspricht X'01') - reserviert
MSG_FILE_LIBRARY	Name der Bibliothek, welche die Nachrichtendatei enthält, oder die vom Sendeprogramm verwendeten Werte "CURLIB" bzw. "LIBL".
MSG_FILENAME	Name der Nachrichtendatei, welche die erhaltene Nachricht enthält.
MSG_ID	Nachrichten-ID der erhaltenen Nachricht. Bei einer improvisierten Nachricht wird ein Leerzeichen zurückgegeben.
MSG_KEY	Nachrichtenschlüssel der erhaltenen Nachricht. vier-stelliger Wert im hexadezimalen Format X'xxxxxxxx'
MSG_LEVEL	Dringlichkeitsstufe der Meldung als 16 Bit-Feld. Bit 01 (entspricht X'80') = WTOR - WTOR Bit 02 (entspricht X'40') = IMMEDIATE_ACTION - immediate action Bit 03 (entspricht X'20') = CRITICAL_ACTION - critical eventual action Bit 04 (entspricht X'10') = EVENTUAL_ACTION - Eventual Action Required Bit 05 (entspricht X'08') = INFO - informational Bit 06 (entspricht X'04') = BROADCAST Bit 07 (entspricht X'02') - reserviert Bit 08 (entspricht X'01') - reserviert Bit 09 (entspricht X'80') - reserviert Bit 10 (entspricht X'40') - reserviert Bit 11 (entspricht X'20') - reserviert Bit 12 (entspricht X'10') - reserviert Bit 13 (entspricht X'08') - reserviert Bit 14 (entspricht X'04') - reserviert Bit 15 (entspricht X'02') - reserviert Bit 16 (entspricht X'01') - reserviert
MSG_LIBRARY_USED	Tatsächlicher Name der Bibliothek, welche verwendet wurde, um die Nachricht zu senden. Weil die Bibliothek Override-Anweisungen enthalten kann, ist es nicht notwendigerweise die Bibliothek, in der sich die Nachricht gegenwärtig befindet.
MSG_MISC	Verschiedene Zusatzinformationen zur Meldung als 16 Bit-Feld. Bit 01(entspricht X'80') = DISPLAY_UD_MSG - display UD messages Bit 02 (entspricht X'40') = DISPLAY_ONLY_UD_MSG - display only UD messages Bit 03 (entspricht X'20') = QUEUE_BY_ID_ONLY - queue by id only Bit 04 (entspricht X'10') = QUEUE_BY_AUTO - queue by automation Bit 05 (entspricht X'08') = QUEUE_BY_HARDCOPY - queue by hard copy Bit 06 (entspricht X'04') - reserviert Bit 07 (entspricht X'02') - reserviert Bit 08 (entspricht X'01') - reserviert Bit 09 (entspricht X'80') = ECHO_OPERATOR_CMD - echo operator command Bit 10 (entspricht X'40') = ECHO_INTERNAL_CMD - echo internal command Bit 11 (entspricht X'20') = RESULT_OF_WTL_MACRO - result of wtl macro Bit 12 (entspricht X'10') - reserviert Bit 13 (entspricht X'08') - reserviert Bit 14 (entspricht X'04') - reserviert Bit 15 (entspricht X'02') - reserviert Bit 16 (entspricht X'01') - reserviert
MSG_SEVERITY	Bewertung der erhaltenen Nachricht. Erlaubte Werte: "0" bis "99".
MSG_TEXT	Meldungstext (Defaultwert)
MSGNR	Meldungsnummer
MSGTYPE, MSGTYP	Meldungstyp Erlaubte Werte speziell bei OS/400: "01" - Beendigung "02" - Diagnose "04" - Information "05" - Anfrage "06" - Kopie des Absenders "08" - Anforderung "10" - Anforderung mit Bedienerführung "14" - Hinweisnachricht (Ausnahmebedingung bereits behandelt) "15" - Abbruchnachricht (Ausnahmebedingung bereits behandelt) "16" - Hinweisnachricht (Ausnahmebedingung noch nicht behandelt) "17" - Abbruchnachricht (Ausnahmebedingung noch nicht behandelt) "21" - Antwort, Gültigkeit nicht geprüft "22" - Antwort, Gültigkeit geprüft "23" - Antwort, Standardnachricht "24" - Antwort, Standardantwort des Systems "25" - Antwort, aus der Antwortliste des Systems
OS_NAME	Von IBM definierter Name des Betriebssystems in der Konsolen-Meldung. Derzeit immer "MVS".
PARTY	Partner
PROCESSID	Tasknummer (TSN) in der Konsolen-Meldung.
PROGRAM_NAME	Progammbezeichnung
REPLY_ID	Reply ID der Konsolen-Meldung.
RESULT	Zeigt an, ob bei Dateisystem-Ereignissen mit den Prüfungen FILESIZE oder PATH_FILE_COUNT die Bedingung erfüllt worden ist. Erlaubte Werte: "Y" und "N" "Y" - Die Bedingung wurde erfüllt. "N" - Die Bedingung wurde nicht erfüllt.
RESULT1 RESULT2	RESULT1 erlaubt den Zugriff auf das Ergebnis der SQL-Abfrage von "Wert 1", RESULT2 auf jenes von "Wert 2". Geben Sie beim Index die Nummer der Spalte an, dessen Wert ausgelesen werden soll. Beachten Sie, dass das Datenbank-Ereignis nur die ersten 10 Spalten ausliest. Außerdem werden Spalteninhalte mit mehr als 255 Zeichen abgeschnitten. Die Script-Funktion liefert den Rückgabewert " ", wenn Sie auf eine Spalte zugreifen, die nicht existiert.
RETCODE	Rückgabewert des Jobs im umgewandelten Format
RETCODE_STATE	Filterung auf den Rückgabewert Erlaubte Werte: "Y" und "N" "Y" - Es wurde ein Filter für den Rückgabewert gesetzt "N" - Der Rückgabewert ist für das Auslösen des Ereignisses nicht relevant
SEND_JOB	Name des Jobs, in dem die erhaltene Nachricht gesendet wurde.
SEND_JOB_NUMBER	Nummer des Jobs, in dem die erhaltene Nachricht gesendet wurde.
SEND_USER_PROFILE	Name des Benutzerprofils, welches die erhaltene Nachricht gesendet hat.
SERVICE	Dienst
SMS_MANAGEMENT_CLASS SMS_DATA_CLASS SMS_STORAGE_CLASS	Name der Klasse
SOURCE	Quelle des Ereignisses
STATE	Status Erlaubte Werte: "*" "ERROR" "OK" "INACTIVE" "UNBEKANNT" "UNREGISTERED"
STEP_NAME	Name des Jobsteps
SYS_NAME	Benutzerdefinierter Systemname
SYSPLEX_NAME	SYSPLEX-Name
TIMESTAMP	Datum und Uhrzeit der Konsolen-Meldung.
TYPE	Art des Ereignisses Erlaubte Werte: "I" - Information "W" - Warnung "E" - Fehler "S" - Überwachung erfolgreich "F" - Überwachung Fehlversuch
USER	Benutzer

Anmerkungen

Die Script-Sprachmittel GET_CONSOLE und GET_EVENT_INFO bieten Ihnen die Möglichkeit, Informationen zum eingetretenen Ereignis zu ermitteln. Die Syntax ist bei beiden gleich.

Die Script-Funktion GET_CONSOLE erlaubt es, beim Eintreten eines Konsolen-Ereignisses Meldungsdaten zu ermitteln. Das sind definierte Bestandteile der Konsolen-Meldung, welche mit Begriff angegeben werden können. Als Standardwert gibt die Funktion den Meldungstext zurück.

Die Script-Funktion kann in einem Ereignis vom Typ "Konsole" verwendet werden. Im BS2000 und z/OS kann damit die Konsolen-Meldung gelesen werden. Im OS/400 dient die Script-Funktion dazu, Informationen aus einer Nachrichtenwarteschlange zu erhalten. Welche Nachrichtenwarteschlange überwacht werden soll, kann in der INI-Datei des OS/400-Agenten festgelegt werden.

Mit GET_EVENT_INFO können Sie im Script von Dateisystem-Ereignissen Informationen auslesen. Speziell bei z/OS stehen Ihnen dazu mehrere Schlüsselwörter zur Verfügung.

Plattformspezifische Besonderheiten

z/OS

Die Begriffe MSG_DESCRIPTOR, MSG_LEVEL und MSG_MISC stellen eine Besonderheit dar. Es sind 16-Bit-Felder, bei denen jedes einzelne Bit eine bestimmte Bedeutung hat. Mit der Script-Funktion kann jedes einzelne Bit abgefragt werden. Dazu wird mit Index das Bit als Wert oder als Konstante angegeben. Der Rückgabewert der Script-Funktion ist "1" (Bit ist gesetzt) oder "0" (Bit ist nicht gesetzt).

OS/400

Mit INSERT_COUNT als Begriff kann die Anzahl variabler Nachrichtenteile einer OS/400-Nachricht festgestellt werden. Mit INSERT als Schlüsselwort und der Angabe des Index wird auf einen bestimmten variablen Nachrichtenteil zugegriffen. Ohne Index gibt die Funktion den ersten variablen Nachrichtenteil zurück.

Beispiele

Die Script-Funktion GET_CONSOLE ermittelt im Beispiel die TSN des Prozesses, welcher das Ereignis auslöste.

:GET_CONSOLE(PROCESSID)

Im zweiten Beispiel wird als erstes die Anzahl der variablen Teile des Nachrichtentextes (Inserts) einer OS/400-Nachricht ermittelt. Danach wird eine Prozessschleife durchlaufen, in der alle Inserts in den Aktivierungsreport geschrieben werden.

: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

Folgende Zeilen werden im Aktivierungsreport protokolliert:

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'

Das dritte Beispiel ermittelt einen Bestandteil der Konsolen-Meldung in z/OS. Es wird auf Bit 03 des Begriffs MSG_DESCRIPTOR zugegriffen. Bit 03 wird zum einen als Wert, zum anderen als Konstante angegeben.

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

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

Das folgende Beispiel zeigt einen Scriptauszug, in dem der Dateiname ermittelt und der Dateiinhalt zeilenweise eingelesen wird.

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

Das fünfte Beispiel liest die Werte einer SQL-Abfrage (für "Wert 1") in einem Datenbank-Ereignis aus.

SQL-Ergebnisse:

Nachname	Vorname	Ort
Meier	Hans	Wolfsgraben

Der Vorname wird wie folgt ermittelt:

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

Die folgende Zeile liefert den Ort:

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

Siehe auch:

Script-Sprachmittel	Beschreibung
GET_BIT	Prüft, ob in einem Bit-Feld ein bestimmtes Bit gesetzt ist.

Script-Sprachmittel - Ereignisbehandlung

Beispielsammlung
Reaktion auf externe Ereignisse

Allgemeines zum Script
Script-Sprachmittel - Alphabetische Auflistung
Script-Sprachmittel -Funktionelle Gliederung

Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support