Benachrichtigung (CALL)
Als Administrator oder als Entwickler und Objektdesigner legen Sie Benachrichtigungsobjekte an, um benutzerdefinierte Nachrichten und Eingabeaufforderungen zu konfigurieren. Es gibt verschiedene Arten von Benachrichtigungen. Die Automation Engine enthält Benachrichtigungsvorlagen mit Informationen über die Aufgaben, auf die sie sich beziehen. Sie können sie bearbeiten und an Ihre Bedürfnisse anpassen.
Beispiel:
Ein Job benötigt in der Regel einige Minuten, um erfolgreich abzuschließen. Wenn die Ausführung des Jobs länger dauert, könnte ein Fehler aufgetreten sein. Ein anderer Job braucht in der Regel viel länger, um beendet zu werden (z.B. eine Datenbankreorganisation). Wenn der Job innerhalb von wenigen Sekunden beendet wird, ist dies auch ein Anzeichen für ein Problem.
In diesen Fällen möchten Sie wahrscheinlich so bald wie möglich informiert werden. Hierfür erstellen Sie Benachrichtigungsobjekte. Diese lenken Ihre Aufmerksamkeit auf den Status von Aufgaben oder Ereignissen oder auf wichtige Änderungen. Je nach Art der Benachrichtigung werden die Informationen entweder per E-Mail versendet oder es werden Meldungen online angezeigt. Siehe Eingabeaufforderungen.
Objektklasse: Ausführbares Objekt
Objekttyp/Kurzform: CALL
Standard-Objektvorlagen: ALARM, MAIL, STANDARD, SLM
Dieses Thema beinhaltet Folgendes:
Benachrichtigungs-Templates enthalten Script-Variablen, die Daten von den Objekten abrufen, auf die sie sich beziehen. Es gibt Templates für die folgenden Arten von Benachrichtigungen:
Verwendung
ALARM-Benachrichtigungen sind nützlich, wenn Sie die Automation Engine-Scriptsprache in Ihrer Meldung verwenden möchten.
Vordefinierte Einstellungen
ALARM-Benachrichtigungen beinhalten ein Script auf der Seite Script, das Daten liest und im Nachrichtentext verwendet. Der Benutzer, der das Objekt ausführt, wird automatisch als Empfänger der Nachricht festgelegt.
ALARM-Benachrichtigungsobjekte werden immer unmittelbar nach der Erstellung ausgeführt.
Die folgenden Parameter sind standardmäßig auf der Seite Benachrichtigung eingestellt. Sie können sie bei Bedarf ändern:
- Typ = Alarm
- Priorität = Hoch
- Reports mitsenden = &UC_CAUSE_NR
Der Meldungstext wird in der benötigten Sprache ausgegeben. Der Text beinhaltet dynamische Werte, wie den Namen der Aufgabe, die den Alarm ausgelöst hat, deren RunID etc.
Beispiele für Scripting finden Sie unter Beispiele für Scripting von Benachrichtigungsobjekten.
Mit Alarmen arbeiten
Alarme können akzeptiert oder abgelehnt werden:
- Mit der Annahme der Eingabeaufforderung übernimmt der Empfänger die Verantwortung für die Lösung des Problems.
- Wenn der Empfänger oder der letzte von mehreren Empfängern die Eingabeaufforderung ablehnt, wird das Problem eskaliert.
- Wenn die Empfänger innerhalb des definierten Zeitraums nicht verfügbar sind, ist nur eine zeitbezogene Eskalation möglich. Falls diese Art der Eskalation nicht definiert wurde, wird die Benachrichtigung erneut aufgerufen.
MAIL-Benachrichtigungen
Verwendung
MAIL-Benachrichtigungen sind Templates für den Versand von E-Mail-Meldungen.
Vorbedingungen
Die folgenden Keys müssen im VARA-Objekt UC_CLIENT_SETTINGS gesetzt sein (siehe UC_CLIENT_SETTINGS - Diverse Mandanten-Einstellungen).
Vordefinierte Einstellungen
Die folgenden Parameter sind standardmäßig auf der Seite Benachrichtigung eingestellt. Sie können sie bei Bedarf ändern:
- Typ = E-Mail
- Priorität = Hoch
- Reports mitsenden = &UC_CAUSE_NR
Dieses Template enthält ein Beispiel-Script auf der Seite Script. Das Script liest die Werte des verursachenden Objekts aus und schreibt diese in den Meldungstext.
Der Nachrichteninhalt im HTML-Format wird ebenfalls standardmäßig erstellt. Sie können ihn bei Bedarf ändern.
E-Mail-Benachrichtigungen können nur vom Empfänger quittiert werden. Eine Eskalation ist nicht möglich.
STANDARD-Benachrichtigungen
Verwendung
Verwenden Sie diese Vorlage, um Ihre eigenen Meldungen zu definieren, ohne die Automation Engine-Scriptsprache anzuwenden.
Vordefinierte Einstellungen
Die folgenden Parameter sind standardmäßig auf der Seite Benachrichtigung eingestellt, können aber bei Bedarf geändert werden:
- Typ= Eingabeaufforderung
- Priorität = Hoch
Eingabeaufforderung können akzeptiert oder abgelehnt werden. Für diese Benachrichtigungen ist nur eine zeitbezogene Eskalation möglich. Wenn diese Art der Eskalation nicht definiert wurde, findet keine Eskalation statt.
Verwendung
SLO-Objekte geben Aktionen an, die das System ausführen soll, wenn ein Service (ausführbare Objekte) erfüllt/nicht erfüllt wird. Benachrichtigungen zu senden ist eine der Möglichkeiten.
Folgende SLM-Benachrichtigungsvorlagen stehen zur Verfügung:
-
FULFILLMENT_MAIL-Benachrichtigung
Dieses Template erstellt eine E-Mail
-
FULFILLMENT-Benachrichtigung
Dieses Template erstellt eine Anforderung.
Vordefinierte Einstellungen
Die Automation Engine stellt die folgenden Script-Variablen in Bezug auf SLO-Objekte zur Verfügung. Diese rufen Daten über die überwachten Services ab. Sie zeigen auch die Gründe an, warum die geforderten Kriterien nicht erfüllt wurden:
- &uc_slm_slo_name#
- &uc_slm_service_name#
- &uc_slm_service_runid#
- &uc_slm_service_time#
- &uc_slm_violation_msg_number#
- &uc_slm_violation_msg_insert#
Weitere Informationen finden Sie unter Service Level Objective (SLO).
Wenn Sie die Benachrichtigungs-Template auswählen, ist die Art der Meldung vorausgewählt. Sie können ihn bei Bedarf ändern. Folgende Typen stehen zur Verfügung:
-
Eingabeaufforderung
Meldungen werden an die Benachrichtigungsleiste gesendet und können von Benutzern angenommen oder abgelehnt werden.
Optional können sie auch per E-Mail verschickt werden. Bei der Ablehnung einer Eingabeaufforderung wird die Benachrichtigung nicht eskaliert. Die Eskalation von Eingabeaufforderungen erfolgt ausschließlich auf Basis der Zeiteinstellungen, die Sie unten vornehmen.
-
Meldung
Meldungen werden auch an die Benachrichtigungsleiste gesendet. Optional können sie auch per E-Mail verschickt und nur vom Empfänger bestätigt werden. Eine Eskalation steht nicht zur Verfügung.
-
Alarm
Meldungen werden ebenfalls an die Benachrichtigungsleiste gesendet und können vom Benutzer akzeptiert oder abgelehnt werden. Optional können sie auch per E-Mail verschickt werden. Die Ablehnung von Alarmbenachrichtigungen erfolgt ausschließlich auf Basis der Zeiteinstellungen, die Sie unten vornehmen.
Mit der Annahme des Alarms übernimmt der Empfänger die Verantwortung für die Lösung des Problems.
-
E-Mail
Für diesen Benachrichtigungstyp steht eine Eskalation nicht zur Verfügung. E-Mail-Benachrichtigungen werden nicht im Benachrichtigungsbereich angezeigt.
Hinweis: Die E-Mail-Kopplung in der Variable UC_CLIENT_SETTINGS ist ordnungsgemäß einzurichten ( UC_CLIENT_SETTINGS - Diverse Mandanten-Einstellungen).
Benachrichtigungsobjekte definieren
Die Definition eines Benachrichtigungsobjekts besteht aus den folgenden Seiten:
- Standardseiten, die unabhängig von dem von Ihnen definierten Objekttyp zu jeder Zeit verfügbar sind:
- Für ausführbare Objekte sind immer die folgenden zusätzlichen Seiten verfügbar:
- Die hier beschriebene, objektspezifische Seite.
Definieren von benachrichtigungsspezifischen Einstellungen
- Klicken Sie in der Perspektive Process Assembly auf Objekt hinzufügen.
- Erweitern Sie im Dialog Objekt hinzufügen die Liste Benachrichtigung (CALL) und wählen Sie das Template aus. Weitere Informationen finden Sie unter Objekte hinzufügen.
- Öffnen Sie den Tab Benachrichtigungen im linken Navigationsbereich.
-
Definieren Sie die Empfänger der Benachrichtigungen.
Bei ALARM-Benachrichtigungen wird der Benutzer, der das Objekt ausführt, automatisch als Benachrichtigungsempfänger ausgewählt; Sie können hier jedoch weitere Empfänger eingeben.
-
Wählen Sie unter Empfänger einen Benutzer oder eine Benutzergruppe aus. Geben Sie den Namen des Benutzers ein oder wählen Sie ihn in der Liste aus.
Sie können auch eine E-Mail-Adresse als Empfänger eingeben.
-
Wählen Sie optional einen Kalender und eines der Kalenderereignisse, die ihm zugewiesen sind.
Die Benachrichtigung wird gesendet, wenn diese Kalenderbedingung zutrifft.
- Klicken Sie auf Hinzufügen, um diese Kombination von Empfängern und Daten zuzuordnen. Sie können beliebig viele Kombinationen hinzufügen.
Sie können in diesen Feldern Variablen und „&“ verwenden.
-
-
Wenn Sie ein anderes Template als STANDARD auswählen, sind Betreff und Textkörper des Textes im Abschnitt Nachricht vordefiniert. Sie können diese ändern.
-
Geben Sie den Betreff ein oder klicken Sie auf das Variablensymbol, um einen einzufügen.
Wenn Sie dies nicht ausfüllen, wird der E-Mail-Betreff automatisch erstellt und setzt sich dann aus Objektname+RunID+Mandant der Benachrichtigung zusammen.
- Geben Sie den Text der Benachrichtigung ein. Sie können Variablen verwenden. Die Anzahl der Zeichen, die eingegeben werden können, ist unbegrenzt.
Wichtig! Wenn Sie Benachrichtigungen mithilfe der Automation Engine-Scriptsprache auf der Seite Script eingeben, werden diese Einstellungen ignoriert.
-
-
Die Einstellungen variieren je nach gewähltem Template.
- Die Priorität dient nur zu Informationszwecken. Sie wird in den E-Mails und in den Meldungen der Benachrichtigungsleiste angezeigt.
- Der Typ bestimmt die Art des Versands und ob eine Eskalation möglich ist.
-
Optional können Sie die SNMP-Kopplung aktivieren, um beim Start einer Benachrichtigung eine SNMP-Trap zu erstellen.
Vorbedingungen:
- muss SNMP auf dem Rechner installiert sein und als Dienst laufen,
- Der AE SNMP-Sub-Agent muss installiert sein.
- Die SNMP Koppelung muss in der Automation Engine INI Datei (ucsrv.ini) durch Setzen des SNMP-Parameters auf
snmp=2
aktiviert sein.
Diese Option ist für E-Mail-Benachrichtigungen nicht verfügbar.
Tipp: Da die SNMP-Technologie bereits eher veraltet ist, sollte die hochmoderne JMX-Lösung verwendet werden. SNMP nutzt das weniger sichere UPD-Netzwerkprotokoll und unterstützt nicht den gesamten AE-Funktionsumfang
-
Aktivieren Sie Zusätzlich E-Mail senden, um die Benutzer darüber zu informieren, dass die Benachrichtigung ausgelöst wurde. Die Adresse in der Benutzerdefinition wird übernommen. Wurden dem verantwortlichen Benutzer zwei Adressen zugeordnet, wird die E-Mail an beide gesendet.
Es kann auch festgelegt werden, dass Reports an die E-Mail angehängt werden sollen:
-
Geben Sie unter Reports mitsenden die RunID der Aufgabe ein, die die Benachrichtigungs-E-Mail ausgelöst hat. Diese Option ist nur für Jobs relevant.
Für jeden Reporttyp wird eine Datei gesendet. Der Name der Datei lautet wie folgt:
RunID.report type.txt. Zum Beispiel 002523059.LOG.txt.
Die Optionen für die Quelle werden angezeigt. Dort können Sie angeben, wo die Reports abgerufen werden sollen.
-
Datenbank
Es werden nur die Standard-Reports des Jobs mitgesendet, die sich in der Automation Engine-Datenbank befinden.
-
Externe Dateien
Dateien, die sich am Rechner des Agenten befinden, werden angehängt. Betrifft den Job-Report (wenn dieser als Datei gespeichert wurde) und registrierte Job-Output-Dateien, sofern vorhanden.
Der Empfänger muss bei externen Reports (EXTREP) und Jobs über das Recht Zugriff auf Reports verfügen. Ansonsten werden die Dateien nicht mitgesendet und eine Fehlermeldung in den Report der Benachrichtigung geschrieben.
Weiters muss der Agent aktiv sein, auf dem der Job durchgeführt wurde und die Dateien existieren.
-
All
Reports aus der Datenbank und aus dem Agenten-Rechner werden angehängt. Existiert derselbe Report in beiden, so wird dieser trotzdem nur einmal versendet.
Sind Daten am Agenten vorhanden, so werden zwei Mails gesendet (eines von der Automation Engine und eines vom Agenten).
-
-
Tragen Sie unter AE-Anhang den Pfad und den Namen der anzuhängenden Datei ein. Die Datei muss sich in einem Verzeichnis befinden auf das die E-Mail-Kopplung zugreifen darf.
Maximale Länge: 255 Zeichen
Wenn Sie Variablen verwenden, darf die Länge des Pfades bei der Auflösung der Variablen nicht länger als 255 Zeichen sein.
-
- Die Eskalationsoption ist für E-Mail-Benachrichtigungen nicht verfügbar. Für alle anderen können Sie die Zeit festlegen, nach der eine zweite Benachrichtigung gesendet wird, wenn keine Antwort erfolgt.
- Wenn Sie Beende aktuelle Benachrichtigung aktivieren, wird die ursprüngliche Benachrichtigung durch das Versenden der Folgebenachrichtigung automatisch mit dem Status ENDED_ESCALATED geschlossen.
Sie können Objekte zum Versenden von Benachrichtigungen wie folgt konfigurieren:
-
Seite „Laufzeit“
Wenn Sie die allgemeinen Einstellungen eines ausführbaren Objektes definieren, können Sie ihm eine maximale und eine minimale Laufzeit zuweisen. Wenn die für die Ausführung des Objekts benötigte Zeit von diesen Werten abweicht, können Sie eine Aufgabe vom System ausführen lassen. Bei dieser Aufgabe kann es sich um ein Benachrichtigungsobjekt handeln. Gleiches gilt für die Laufzeiten von Aufgaben, die in Workflows oder Schedules eingefügt werden. -
Seiten „Output“ in Jobs
Bei der Definition des Outputs können Sie einen Status angeben und das System anweisen, eine Benachrichtigung zu senden, wenn dieser erreicht ist. -
Seite „Attribute“
Für Workflows (JOBP), Schedules (JSCH) und Remote Task Monitor (JOBQ). Sie können ein Benachrichtigungsobjekt vom System ausführen lassen, wenn eine Aufgabe einen bestimmten Status hat. -
Seiten „Script“
Auf diesen Seiten können Sie mit der Automation Engine-Scriptsprache individuelle Benachrichtigungen erstellen. Klicken Sie hier für Beispiele für Scripting von Benachrichtigungsobjekten.
Workflows
In den folgenden Situationen können Sie ein Benachrichtigungsobjekt vom System senden lassen:
- Eine Aufgabe in einem Workflow kann nicht an einem Kontrollpunkt gestartet werden
- Eine Aufgabe beginnt oder endet nicht zum erwarteten Zeitpunkt
- Eine Aufgabe endet nicht mit dem erwarteten Status
- Die in den Bedingungen (Pre-Conditions und Post-Conditions) definierte Aktion löst die Ausführung einer Benachrichtigung aus
- Die vordefinierte maximale Laufzeit wird nicht eingehalten
Siehe Zeit & Abhängigkeiten.
Schedules
In den folgenden Situationen können Sie ein Benachrichtigungsobjekt vom System senden lassen:
- Die vordefinierte maximale Laufzeit wird nicht eingehalten
- Eine Aufgabe endet nicht mit dem erwarteten Status
Informationen aus dem Read-Buffer
Benachrichtigungen, die aufgrund der Bedingungen starten, die für Aufgaben in Workflows oder Schedules definiert sind, enthalten detaillierte Systeminformationen. Diese Informationen können im Script der Benachrichtigung aus dem Read Buffer gelesen werden. Dafür wird das Script-Statement :READ verwendet.
- UC_CAUSE_NAME - Name der verursachenden Aufgabe.
- UC_CAUSE_NR - RunID der verursachenden Aufgabe.
- UC_CAUSE_STATE - Status der verursachenden Aufgabe.
- UC_CAUSE_RETCODE - Rückgabewert der verursachenden Aufgabe.
Beispiele
:READ &UC_CAUSE_NAME,,
:READ &UC_CAUSE_NR,,
:READ &UC_CAUSE_STATE,,
:READ &UC_CAUSE_RETCODE,,
Wichtig! Dies ist nur möglich, wenn die Benachrichtigung mit der Einstellung Zum Aktivierungszeitpunkt generieren in der Seite „Attribute“ aktiviert wurde.
Auf Benachrichtigungen reagieren
Falls es Meldungen oder Eingabeaufforderungen gibt, die Sie verarbeiten sollten, wird Ihnen dies im Bereich für Benachrichtigungen in der Menüleiste angezeigt, siehe Eingabeaufforderungen.
Abhängig von der Art der Benachrichtigung, die Sie erhalten, gibt es verschiedene Möglichkeiten, darauf zu reagieren:
-
Eingabeaufforderungen
Meldungen werden auch an die Benachrichtigungsleiste gesendet. Sie können akzeptiert oder abgelehnt werden. Mehr Informationen finden Sie in den Zeiteinstellungen, die im Benachrichtigungsobjekt definiert sind, das die Meldung ausgelöst hat.
-
Meldungen
Meldungen werden ebenfalls an die Benachrichtigungsleiste gesendet und können vom Benutzer akzeptiert oder abgelehnt werden. Optional können sie auch per E-Mail verschickt werden.
Die Ablehnung von Alarmen erfolgt ausschließlich auf Basis der Zeiteinstellungen, die Sie vornehmen.
Mit der Annahme des Alarms übernimmt der Empfänger die Verantwortung für die Lösung des Problems.
-
Alarme
Meldungen werden auch an die Benachrichtigungsleiste gesendet und können von Benutzern angenommen oder abgelehnt werden. Optional können sie auch per E-Mail gesendet werden.
Die Ablehnung von Alarmbenachrichtigungen erfolgt ausschließlich auf Basis der Zeiteinstellungen, die Sie vornehmen.
Mit der Annahme des Alarms übernimmt der Empfänger die Verantwortung für die Lösung des Problems.
-
E-Mails
Für diesen Benachrichtigungstyp steht eine Eskalation nicht zur Verfügung. E-Mail-Benachrichtigungen werden nicht im Benachrichtigungsbereich angezeigt.
Wichtig! Die E-Mail-Verbindung muss in der Variable UC_CLIENT_SETTINGS eingerichtet sein.
Siehe auch:
- Beispiele für Scripting von Benachrichtigungsobjekten
- Sehen Sie sich das Video an
- Benachrichtigungsattribute
- UC_CLIENT_SETTINGS - Diverse Mandanten-Einstellungen
Auf Benachrichtigungen reagieren: