3.11 Individuelle Nachrichten & Fehlermeldungen in der OCT Weboberfläche anzeigen

Durch das Einbinden der Prozedur system.spSEND_Message ist es möglich an vielen Stellen in OCT individuelle Nachrichten oder Fehlermeldungen anzuzeigen.

Aufruf der Prozedur

Die Prozedur system.spSEND_Message erwartet zwei Parameter:

• MessageType: Art der Meldung

  • DEBUG - Hinweis für Entwickler

  • INFO - Information für den Anwender

  • WARNING - Warnung für den Anwender

  • ERROR - Fehlermeldung, die den aktuellen Vorgang üblicherweise abbricht

• Message: ein beliebiger Text, der dem Benutzer angezeigt werden soll

Einbindung in andere Prozeduren

Der Aufruf von system.spSEND_Message kann in beliebigen Prozeduren oder innerhalb von bestimmten Pipeline-Steps (z.B. “SQL Ausführen”) erfolgen.

Um eine individuelle Nachricht oder Fehlermeldung in der OCT Weboberfläche anzuzeigen, muss die Prozedur system.spSEND_Message in der passenden Prozedur an eine passende Stelle eingefügt werden.

Beispiel: Warnung beim Öffnen einer Produktdatentabelle

Um eine Warnung beim Öffnen einer Produktdatentabelle anzuzeigen muss der Aufruf von system.spSEND_Message in die Prozedur dbo.sx_pf_GET_ProductDataTableValues eingefügt werden.

EXEC system.spSEND_Message 'WARNING', 'Achtung, das Ändern der Werte sollte nur mit höchster Vorsicht gemacht werden!'

Idealerweise wird dieser Befehl zwischen dem BEGIN TRY und END TRY Befehlen der Prozedur eingefügt. Das Beispiel führt zu folgender Meldung beim Öffnen einer Produktdatentabelle:

Beispiel: mehrere Nachrichten

Es ist auch möglich mehrere Aufrufe von system.spSEND_Message in eine Prozedur hinzuzufügen. Das führt dazu, dass sämtliche Nachrichten gesammelt in einem Fenster angezeigt werden. Zusätzlich zum vorherigen Beispiel wurde folgende Zeile in die dbo.sx_pf_GET_ProductDataTableValues Prozedur an eine spätere Position eingefügt:

EXEC system.spSEND_Message 'INFO', 'Die angezeigten Daten sind validiert.'

Das führt zu folgender Meldung beim Aufrufen einer Produktdatentabelle:

Die einzelnen Nachrichten werden mit dem zugewiesenen “MessageType” angezeigt. Als globaler “MessageType” wird immer der Typ mit der höchsten Priorität genutzt, wobei die Reihenfolge ERROR > WARNING > INFO > DEBUG gilt.

Einbindung in Pipeline Steps

Mit Hilfe des Aufrufs von system.spSEND_Message ist es möglich, individuelle Log Nachrichten bei Pipeline-Ausführungen zu erzeugen.

Beispiel: Step “SQL-Ausführung”

Definiert man im Step “SQL-Ausführung” den Aufruf von system.spSEND_Message, werden die entsprechenden Nachrichten in das Log der Pipeline Ausführung geschrieben.

EXEC system.spSEND_Message 'DEBUG', 'Das ist eine DEBUG Nachricht'
EXEC system.spSEND_Message 'INFO', 'Das ist eine INFO Nachricht'
EXEC system.spSEND_Message 'WARNING', 'Das ist eine WARNING Nachricht'

Führt zu folgenden Log-Einträgen:

Das Ergebnis der Step-Ausführung ist dadurch mindestens eine Warnung, falls es abgesehen davon keine Fehlermeldung gibt.

Bei einem Aufruf von system.spSEND_Message mit dem “MessageType” ERROR wird die Ausführung des Steps mit der hinterlegten Fehlermeldung abgebrochen.

EXEC system.spSEND_Message 'ERROR', 'Das ist eine ERROR Nachricht'

Führt zu folgenden Log-Einträgen: