Meldungs-management

Aufgabe

In allen Ebenen einer Software-Applikation gibt es Nachrichten und Fehlermeldungen. Das sind aktiv und unaufgefordert ausgesendete Meldungen der Software-Anwendung an einen Nutzer oder ein technische Komponente, die eine Reaktion bei Erhalt einer Meldung ausführen. Sie haben unterschiedlichen Inhalt und unterschiedliche Semantik und können in allen Ebenen der Applikation entstehen. In CBA werden Nachrichten und Fehlermeldungen unter dem Begriff der Meldungen zusammengefasst und einheitlich behandelt.

Fehlerbehandlung, Logging und Monitoring stellen spezielle Reaktionen auf Meldungen dar, wobei ein und dieselbe Meldung mehrfache Reaktionen auslösen kann. Während normale Meldungen in der Regel an der Bedienoberfläche dem interaktiven Nutzer angezeigt werden, werden Logging-Informationen in eine Logging-Datenbank gespeichert, um von einem Administrator bei Bedarf eingesehen zu werden. Ein Monitoring-System wertet einen bestimmten Teil der Meldungen aus, um einen permanenten Überblick über die Arbeit des Systems zu erhalten. Meldungen können auch Fragen an den Nutzer darstellen oder einen Workflow initiieren.

Eine Meldung trägt in CBA neben der eigentlichen Information einen Zeitstempel und häufig Zusatzinformationen wie Sitzung, Transaktion, Nutzer etc. Damit sind aus Meldungen bei gezielter Nutzung z.B. auch Aufrufhäufigkeiten, Aufrufdauer u.a. ermittelbar. Das Ausbleiben von Meldungen kann auch ausgewertet werden.

Das CBA-Meldungs-Management ist mandanten- und mehrsprachfähig und kann parametrierte Meldungen generieren. Diese kann neben Fehlern auch jede andere Art von Meldungen und Textbausteinen verwalten. Das können z.B. Abfragen für Bedienoberflächen, formatierte Ausschriften, Textbausteine für E-Mails oder Protokoll-Einträge sein.

Anforderung

CBA implementiert ein einheitliches Meldungs-Management, das auch die Anforderungen an die Fehlerbehandlung, das Logging und das Monitoring berücksichtigt:

Meldungen werden nach ihrer Bedeutung klassifiziert.

Meldungen definieren zusammen mit Systemeinstellungen eindeutig die notwendigen Reaktionen. Die Reaktion auf Meldungen ist parametrierbar.

Beim Senden einer Meldung (z.B. eines Fehlers) kann wahlweise die ausgeführte Funktion durch einen CbaException abgebrochen oder innerhalb einer logischen Transaktionsklammer (z.B. innerhalb eines Service-Aufrufes) alle Meldungen gesammelt und komplett übergeben werden. Damit ist eine fehlertolerante Arbeitsweise möglich.

Die Meldungen können einen oder mehrere Parameter enthalten, die durch die Funktionen übergeben werden, z.B. den Dateinamen einer nicht gefundenen Datei.

Das Meldungs-Management generiert aus den parametrierten Meldungen einen lesbaren Meldungstext.

Neben Fehlern können auch andere Arten von Meldungen und Textbausteinen verwaltet werden wie z.B. Abfragen für Bedienoberflächen oder formatierte Ausschriften.

Meldungen untergelagerter Programmsysteme wie z.B. Datenbank-Systeme oder Datei-Systeme werden in das einheitliche Meldungs-Management überführt.

Das CBA-Meldungs-Management ist mehrsprachfähig, d.h. die Meldungen werden in der Sprache des Nutzers generiert.

In verteilten Anwendungen sind Meldungen transparent, d.h. sie werden so zwischen Service-Aufruf und Service kommuniziert, das ein einheitliches Verhalten unabhängig vom Ort der Meldungs-Entstehung realisiert wird.

Architektur

Das Meldungs-Management ist in das CBA-Framework eingebettet. Es besteht aus

der Meldungs-Definition

dem temporären Meldungs-Puffer

den Meldungs-Funktionen

vorgefertigten Elementen zur Meldungs-Anzeige

der Logging-Datenbank

der Möglichkeit der Anbindung eines Monitoring-Systems

Konfiguration

Die potenziellen Meldungen werden mit einer Meldungs-Nummer konfiguriert. In der Meldungs-Definition sind Platzhalter für die später einzufügenden Parameter definierbar. Die Meldungstexte sind mehrsprachfähig.

Funktionen

Das CBA-Framework stellt eine Menge von Funktionen zum Meldungs-Management zur Verfügung:

clearMessage Löschen des Meldungs-Puffers

setMessage Einfügen einer Meldung in den Meldungs-Puffer

getMessageText Konvertierung einer Meldung in einen Text

getMessages Rückgabe des Meldungs-Puffers

saveMessage Speichern der Meldungen in der Logging-Datenbank

removeMessage Löschen der zuletzt eingestellten Meldung aus dem Meldungs-Puffer

Der Funktion setMessage werden eine Meldungsnummer, ggf. Meldungs-Parameter (z.B. Informationen über das fehlerhafte Objekt u.ä.), die Klassifikation und ein Flag zur Verhaltens-Spezifikation übergeben. Weitere Parameter können die Meldung stärker spezifizieren und sind insbesondere für einen Fehleranalyse wichtig. Mit Hilfe der Funktion getMessageText wird anhand der Meldungsnummer eine sprachabhängige Zeichenkette ermittelt, die mit den angegebenen Meldungs-Parametern formatiert wird. {0} ist dabei der Platzhalter für den ersten Meldungs-Parameter, {1} für den zweiten etc. Die Meldungs-Parameter sind eine Zeichenkette, in der beliebig viele Parameter durch â€š|â€™ getrennt hintereinander angegeben werden können. Automatisch wird der Meldung der Zeitstempel, die Session-Zuordnung und (wenn vorhanden) die Transaktionsnummer angefügt, sodass Meldungen in einen Kontext eingeordnet werden können.

Beispiel:

Meldungsnummer: 1234

Meldungstext: 'Die Datei '{0}' hat folgenden Fehler verursacht: {1}

Aufruf: setMessage (1234, „bild.gif|Datei schreibgeschützt“, „E“, „e6“, myTable, null, 4711);

Meldung: Die Datei 'bild.gif' hat folgenden Fehler verursacht: Datei schreibgeschützt