Fehlerbehebung bei E-Mail-Benachrichtigungen

Wie Benachrichtigungen in ADOGRC funktionieren

ADOGRC stellt eine Reihe von Diensten bereit, um Objekte im Hintergrund zu überprüfen und E-Mail-Benachrichtigungen an verantwortliche Benutzer:innen zu senden, falls eine Aufgabe zu erledigen ist. Dies ist ein zweistufiger Prozess:

1. Zuerst prüft der GRC-Scheduler ein Objekt, ob eine Aktion erforderlich ist:

• Ist ein Statusübergang notwendig, z.B. ein Objekt automatisch "zur Bewertung" weiterleiten beim Start einer neuen Periode?
• Ist eine Benachrichtigung erforderlich, z.B. wurde ein Übergang ausgeführt oder muss eine Erinnerung gesendet werden? Falls dies der Fall ist, führt der GRC-Scheduler den Statusübergang aus und erstellt ein Benachrichtigungsobjekt.

2. Der GRC-Notification Dienst sammelt dann diese Benachrichtigungsobjekte, ermittelt, welche Benutzer:innen informiert werden müssen, und erstellt eine E-Mail pro Benutzer:in mit allen für diese relevanten Objekten.

Der Grund für diese Art der Benachrichtigungsverarbeitung ist, dass häufig mehrere Benutzer:innen über den Status eines Objekts informiert werden müssen, aber jede(r) Benutzer:in nur eine E-Mail erhalten soll, die alle relevanten Informationen für anstehende Aufgaben enthält.

Falls Benutzer:innen eine erwartete E-Mail-Benachrichtigung nicht wie erwartet erhalten, gibt es mehrere Möglichkeiten, das Problem zu identifizieren und zu beheben. Das folgende Kapitel bietet einige Hinweise zu häufigen Problemen – von einer grundlegenden Überprüfung der Konfiguration bis hin zur spezifischen Analyse der Protokolldateien.

Konfigurationseinstellungen in der ADOGRC Administration überprüfen

GRC-Scheduler und GRC-Notification

Wie oben beschrieben, müssen sowohl der GRC-Scheduler als auch der GRC-Notification Dienst korrekt konfiguriert sein, damit Benachrichtigungen funktionieren. Weitere Informationen finden Sie im entsprechenden Abschnitt der Hilfe zur Administrations.

GRC-Scheduler Logeinträge

Wenn die Konfiguration korrekt ist, sollten Sie in der _aworker.log Datei Einträge wie die folgenden finden:

• Scheduler wird gestartet, um Statusübergänge auszuführen:

[INFO] WEBMETHOD START: com.boc.services.grc.scheduler.Jobs.performTransitions
[INFO] ADOGRC Scheduler: Execution of WM: performTransition with object IDs: [{"repoObjID":"{<Repository ID>}","libObjID":"{<Objekt ID>}","name":"<Objektname>"},]

• Scheduler verarbeitet Objekte für Erinnerungen oder Eskalationen:

[INFO] WEBMETHOD START: com.boc.services.grc.scheduler.privileged.Jobs.performReminder
[INFO] ADOGRC Scheduler: Execution of WM: performReminder with object IDs: [{"repoObjID":"{<Repository ID>}","libObjID":"{<Objekt ID>}","name":"<Objektname>"}]

[INFO] WEBMETHOD START: com.boc.services.grc.scheduler.privileged.Jobs.performEscalation
[INFO] ADOGRC Scheduler: Execution of WM: performEscalation with object IDs: [{"repoObjID":"{<Repository ID>}","libObjID":"{<Objekt ID>}","name":"<Objektname>"}]

• Scheduler erstellt Benachrichtigungsobjekte:

[INFO] ADOGRC - Created notification with id "{<ID der Benachrichtigung>}" for source object with id " {<Objekt für welches die Benachrichtigung erstellt wird>}" for recipient [user: <verschlüsselter Benutzername>]

GRC-Notifications Logeinträge

Um zu prüfen, ob ein bestimmtes Objekt vom Scheduler verarbeitet wurde, öffnen Sie in der ADOGRC Administration die Rechteverwaltung. Suchen Sie im Tab Objekt das Objekt und klicken Sie auf das Mehr Menü. Wählen Sie ID in die Zwischenablage kopieren. Verwenden Sie diese ID für die Suche im _aworker.log.

Anschließend übernimmt der GRC-Notification Dienst die Objekte, erstellt E-Mails und entfernt dann die vom Scheduler erzeugten Benachrichtigungsobjekte. Wenn Sie Protokolleinträge wie den folgenden finden, bedeutet dies, dass der Notification-Dienst das Objekt erfolgreich verarbeitet hat (die ID ist dieselbe wie die Benachrichtigungs-ID im obigen Beispiel):

[INFO] WEBMETHOD START: com.boc.services.grc.notification.NotificationManager.deleteNotificationWM
[INFO] Removed the object "" with ID: {<ID der Benachrichtigung>}

Sie können auch prüfen, ob der Notification-Dienst die notwendigen Jobs ausführt (dieser Log-Eintrag befindet sich im Webserver-Protokoll. Dieses trägt den Namen der Web Applikation, z.B. ADONIS17_0.log):

INFO  [QuartzScheduler_Worker-4] [*] [1608404084:15409] User specific job [GRC-Notification] COMPLETED

Probleme mit Technischen Benutzern

• Wenn es ein Problem mit den technischen Benutzern für den GRC-Scheduler oder GRC-Notification gibt, finden Sie Protokolleinträge wie diesen:

[WARN] Technical user with loginname '[user:<verschlüsselter Benutzername>]' not existing or lacking the right to do trusted login.
[WARN] Validation of technical user not successful - Configured technical user '[user:<verschlüsselter Benutzername>]' will not be available on the Web Server.

Mailserver-Konfiguration

Ein Mailserver ist erforderlich, um die vom GRC-Notification-Dienst erstellten E-Mails tatsächlich zu versenden. Überprüfen Sie, ob die Konfiguration korrekt ist – Details finden Sie im entsprechenden Abschnitt der Hilfe zur Administration.

Falls der Mailserver nicht konfiguriert ist oder eine ungültige Konfiguration vorliegt, finden Sie einen entsprechenden Log-Eintrag:

WARN  [pool-2-thread-1] [*] MAIL API sender unavailable due to missing or invalid config

Beachten Sie bitte, dass dies lediglich eine formale Validierung der Mailserver-Einstellungen ist. Es bedeutet nicht, dass die Anmeldung am Mailserver erfolgreich sein wird, wenn z. B. Servername oder Benutzername/Passwort falsch sind.

Sobald die E-Mails vom Notification-Dienst vorbereitet wurden, werden sie vom Mailserver gesendet. Dies wird in der Datei MailAudit.log protokolliert und enthält die ID(s) der Objekte in der Benachrichtigung und die Empfänger:

INFO  [QuartzScheduler_Worker-4] [MAIL AUDIT] [*] [1608432980:16322] Notification objects IDs: [[JSONPropertyValueString@0x34260228: data={<Objekt ID>}]]: send success (SUCCESS): recipients: TO:[[enc:<verschlüsselter Benutzername>]] CC:[] BCC:[] subject: [user:<verschlüsselter Benutzername>]

Benutzer und Rollen überprüfen

Zugriff auf Objekte und Repositories

Die technischen Benutzer von GRC-Scheduler und GRC-Notification benötigen Zugriff auf die relevanten Objekte, um Benachrichtigungen versenden zu können. Um Zugriff zu haben, müssen die folgenden Punkte erfüllt sein:

• alle notwendigen Freigabeworkflow-Systemrollen wurden zugewiesen
• Zugriff auf die Repositorys, in denen sich die Objekte befinden
• Zugriff auf die Objektgruppen, in denen sich die Objekte befinden

Die technischen Benutzer benötigen keinen Zugriff auf das Named-Use-Benutzer Szenario von ADOGRC oder auf Contributor/Reader Rollen.

Wenn die technischen Benutzer keinen Zugriff auf die relevanten Objekte haben, „sehen“ sie diese Objekte nicht – deshalb werden in diesem Fall auch keine entsprechenden Log-Einträge geschrieben werden.

Fehlende E-Mail-Adresse bei Benutzer:innen

Um E-Mails an die jeweiligen Benutzer:innen senden zu können, muss eine gültige E-Mail-Adresse konfiguriert sein. Wenn keine E-Mail-Adresse vorhanden ist, finden Sie Log-Einträge wie diesen:

[ERROR] ADOGRC - Skipping user with ID "{18185052-173e-4cb1-8eb0-7911c57fa299}" because no mail address is configured.

Details zum Anlegen und Bearbeiten von Benutzern finden Sie im Kapitel Benutzer verwalten der ADOGRC Administration.

Rollenzuweisung an Benutzer:innen überprüfen

Öffnen Sie in der Webanwendung das Objekt, für das eine Benachrichtigung erwartet wurde, und überprüfen Sie, welche Rollen zugewiesen wurden. Überprüfen Sie dann, ob die Benutzer:innen dieser Rolle als „Rolleninhaber“ zugewiesen ist.

Weitere Probleme im Zusammenhang mit Benachrichtigungen

ADOGRC Basis-URL

Die von ADOGRC gesendeten Benachrichtigungen enthalten direkte Links zu den Objekten, damit Benutzer:innen diese per Klick in der E-Mail aufrufen können. Damit diese Links korrekt auf die ADOGRC Installation verweisen, muss die Basis-URL korrekt gesetzt sein. Weitere Informationen finden Sie im Abschnitt Systemeinstellungen der Hilfe zur Administration.

Maximale Mailgröße

Wenn Benachrichtigungen eine große Anzahl an Objektnamen und zugehörige Links enthalten, kann eine E-Mail so groß werden, dass sie die maximale Mailgröße überschreitet. Die Größe einer von ADOGRC verssendeten E-Mail ist standardmäßig begrenzt, kann jedoch bei Bedarf erhöht werden. Es ist wichtig zu berücksichtigen, dass nur E-Mails nicht gesendet werden, die diese Größe überschreiten, alle anderen E-Mails werden normal versendet. Dies könnte eine mögliche Ursache sein, wenn nur bestimmte Benachrichtigungen nicht wie erwartet eintreffen.

Details hierzu finden Sie im Abschnitt Einstellungen im Web-Client im ADOGRC Setup Guide.