Ereignisse (Event Handler)

../../_images/fsw-reference-event-handler-1.jpg

Mit den Ereignissen definierst du was in bestimmten Situationen passieren soll. Das Fenster ist dabei in die folgenden Bereiche aufgeteilt:

A Die Ereignisliste enthält alle definierten Ereignisse für den Job. Falls mehrere Ereignisse für ein Ereignistyp existieren, werden diese in der definierten Reihenfolge ausgeführt.

B Mit den Knöpfen rechts von der Ereignisliste, kannst du neue Ereignisse erstellen und bestehende verschieben oder löschen.

C Unter der Ereignisliste ist der Bereich mit den Einstellungen. Sobald du ein Ereignis in der Liste auswählst, kannst du dessen Einstellungen in diesem Bereich editieren.

Allgemeine Einstellungen

Alle Ereignisse starten mit einem Abschnitt mit allgemeinen Einstellungen:

../../_images/fsw-event-shared-settings.jpg

A In das Beschreibungsfeld (Description) schreibst du einen kurzen Text, aus welchem Grund du dieses Ereignis in dem Job verwendest. Der Text wird direkt in der Ereignisliste angezeigt, ansonsten hat er keine Funktion.

B Mit der Eventtyp (Event Type) Einstellung definierst du den Zeitpunkt, wann das Ereignis ausgeführt wird. Dabei wählst du einen der folgenden Eventtypen:

Job Start

Das Ereignis wird gleich beim Start des Jobs ausgeführt, bevor der Scanvorgang beginnt.

Job Success

Das Ereignis wird nach einer erfolgreichen Ausführung des Jobs ausgeführt.

Job Failure

Das Ereignis wird ausgeführt, falls der Job mit einem Fehler beendet wurde.

C Mit der Einstellung zum Verhalten bei Fehlern (Behaviour on Error) definierst du, was mit dem Job passieren soll, wenn das Ereignis mit einem Fehler abgebrochen wird. Dabei hast du die Auswahl folgender Einstellungen:

Ignore and continue job.

Hier wird der Fehler komplett ignoriert. Der Job wird fortgesetzt, als wäre nichts passiert.

Ignore and continue the job with an error.

Der Job wird fortgesetzt, jedoch wird dieser am Ende mit einem Fehler beendet.

Stop further event handler for this job and continue the job.

Es werden keine weiteren Ereignisse des selben Typs ausgeführt, aber der Job wird ohne Fehler fortgesetzt.

Stop further event handler for this job and continue the job with an error.

Auch hier werden keine weiteren Ereignisse des selben Typs ausgeführt, der Job wird forgesetzt, jedoch wird dieser am Ende mit einem Fehler beendet.

Stop this job with an error.

Der Job wird sofort mit einem Fehler abgebrochen.

E-Mail senden (Send Email)

Das E-Mail senden Event schickt eine E-Mail über einen SMTP-Server. Beispielsweise kannst du damit eine Nachricht senden, falls der Job mit einem Fehler abbricht. Mittels Platzhaltern kannst du fast alle Einstellungen und selbstverständlich den Inhalt der E-Mail ergänzen.

Der erste Abschnitt Mail definiert den Inhalt der E-Mail:

../../_images/fsw-event-send-email-1.jpg

A Das Absender Feld (From) setzt die E-Mail Adresse des Absenders.

B Das Empfänger Feld (To) setzt die E-Mail Adresse des Empfängers. Dieses Feld kann nur eine einzelne E-Mail Adresse enthalten. Falls du eine E-Mail an mehrere Empfänger senden möchtest, musst du dies über eine Empfängerliste auf deinem Mailserver umsetzen.

Bei dem Absender und Empfänger kannst du folgende zwei Adressformate verwenden:

  1. user.name@example.com

  2. User Name <user.name@example.com>

C In dem Betreff Feld (Subject) definierst du die Betreffzeile der E-Mail.

D Das letzte Feld (Content) definiert den Inhalt der Email. Neben reinem Text stehen dir einfache Formatierungen zur Verfügung. Die Email wird immer im HTML-Format aber auch als einfacher Text gesendet.

In dem nächsten Abschnitt SMTP definierst du die Einstellungen für den verwendeten SMTP-Server.

../../_images/fsw-event-send-email-2.jpg

E In diesem Feld (Host) definierst du die Adresse des SMTP-Servers als IP-Adresse oder Hostnamen.

F Falls der SMTP-Server einen nicht-standard Port verwendet, kannst du diesen hier definieren. Setzt du die Einstellung auf Default, wird automatisch der Standardport für das gewählte Protokol verwendet.

G Die Verschlüsselungseinstellung (Encryption) definiert das verwendete Protokoll. Du hast dabei folgende Möglichkeiten:

  • No Encryption - Keine Verschlüsselung. Wir raten von dieser Einstellung ab!

  • TLS Encrypion - Unsere Empfehlung: Bei der TLS Verschlüsselung wird nach dem initialen Handshake eine sichere Verbindung über das TLS Protokoll aufgebaut.

  • SSL Encryption - Bei der SSL Verschlüsselung wird eine SSL gesicherte Verbindung zu dem Mailserver aufgebaut.

H, J Mit diesen beiden Feldern kannst du einen Benutzernamen und ein Passwort definieren, welches für den Versand von E-Mails über den gewählten SMTP-Server benötigt wird.

Warnung

Das hier definierte Passwort wird unverschlüsselt, im Klartext in der Job-Datei gespeichert. Wir raten dir daher von der Verwendung von Passwörtern in Job Dateien ab. Konfiguriere stattdessen den Mailserver so, dass er E-Mails von dem System das die Jobdatei ausführt ohne Passwort akzeptiert. Installiere alternativ einen kleinen SMTP Relay Server, der die E-Mails an den Hauptserver weiterleitet.

Im letzten Abschnitt Attachments kannst du der E-Mail Anhänge hinzufügen.

../../_images/fsw-event-send-email-3.jpg

K In dieser Liste siehst du die Pfade zu den Dateien welche der E-Mail als Anhänge hinzugefügt werden. Diese Dateien müssen erst existieren, wenn die E-Mail generiert wird. So kannst du beispielweise eine Datei verschicken, welche in deinem Job erstellt wird.

L Mit diesem Knopf editierst du den aktuell markierten Pfad.

M Dieser Knopf löscht den aktuell markierten Pfad.

N Mit diesem Knopf fügst du einen neuen Pfad der Liste hinzu.