Überblick
Chioro bietet die Möglichkeit an verschiedenen Stellen Benachrichtigungen zu versenden oder ein Skript auszulösen.
Mit Benachrichtigungen können entweder Nutzer (per E-Mail) oder externe Systeme (per Skript) auf die Beendigung eines Flows oder einer Operation hingewiesen werden. (Aktuell nur Validation und Datenziel Operationen.) Benachrichtigungen von Operationen haben Vorrang.
Jede Konfiguration besteht aus dem Status (1) welcher die Benachrichtigung auslöst und einem Kanal (2) welcher das Ziel definiert. Es ist möglich mehrere Status für einen Kanal zu haben, falls mehrere Kanäle gewünscht sind, müssen weitere Konfigurationen mit dem + (3) hinzugefügt werden. Wenn keine Kanäle oder kein Passender vorhanden ist, muss ein neuer als AdminConfig hinzugefügt werden. Dies erfordert entsprechende Benutzerrechte.
Kanal anlegen
- neue Adminconfig anlegen
- Namen vergeben, dieser Name wird dann im Flow oder der Operation ausgewählt
- Typ auswählen, in diesem Fall “Benachrichtigungs Kanal”
- Methode auswählen, E-Mail (es werden Mails verschickt) oder Skript (beliebiges Javascript ausführen)
- Diese Mail-Adressen werden benachrichtigt
- E-Mail-Vorlage oder Skript, je nach Auswahl bei 4tens Sind die Einstellungen komplett, speichern nicht vergessen :-)
Die Methode “E-Mail” im Detail
Bei der Methode “E-Mail” ist, als Standard, dieses Template hinterlegt:
In diesem Fall ist die Mail mit HTML formatiert und enthält, in doppelten geschweiften Klammern, die Schlüsselwerte die von Chioro belegt werden. Diese können frei im Text verwendet werden und natürlich auch mehrfach vorkommen.
Die Methode “Script” im Detail
Bei der Methode “Skript” wird kein Template vorgegeben. Hier kann, wie auch an vielen anderen Stellen in Chioro, in Java-Script definiert werden was beim Auslösen der Benachrichtigung passieren soll.
Die Umgebungsvariablen aus der Tabelle unten können über context('xxx') erreicht werden.
Also z.B. context('fileName') oder context('status').
Ein Beispiel:
let url = "https://postman-echo.com/post";
let body = {"fileName": context('fileName')};
let headers = {"token": "12345678" }; // optional
let response = postJson(url, body, headers);
Hier werden zunächst die 3 benötigten Variablen belegt, mit postJson versendet und die Antwort
des Servers/der API in response gespeichert.
postJson und getJson
postJson(url, payload, header) verschickt Daten an eine URL,
getJson(url, payload, header) holt Daten bei einer URL ab.
Verwenden auf Flow Ebene
Die Benachrichtigungen sind unter dem Brief-Symbol zu finden.
- Im Dropdown auswählen bei welchen Ereignissen eine Benachrichtigung gesendet wird.
- Auswählen welche Admin-Config verwendet werden soll
- Speichern der Konfiguration
Verwenden im Datenziel/Validation
Im Datenziel und in der Validierung gibt es bei der Konfiguration den Reiter Benachrichtigung.
Analog zur flowweiten Konfiguration wird ausgewählt bei welchen Ereignissen benachrichtigt wird und welche Admin-Config zum Versenden genutzt werden soll.
Hinweis: Der im Datenziel erzeugte Dateiname (entweder direkt vergeben oder per Skript) taucht in der Admin-Config als Variable “fileName” wieder auf.
Tabelle der möglichen Variablen im Template/Skript
| Variable | Erklärung |
|---|---|
| flowName | Name des auslösenden Flows |
| flowOperationName | Name der Operation |
| status | Status |
| statusMessage | ausführlicher Status |
| startTime | Start der Ausführung |
| endTime | Ende der Ausführung |
| totalNumberOfRecords | Anzahl der verarbeiteten Datensätze |
| numberOfSuccessfulRecords | Anzahl der ausgegebenen Datensätze |
| numberOfFailedRecords | Anzahl der Verarbeitungsfehler |
| numberOfInvalidRecords | Anzahl der ungültigen Datensätze (Validierung) |
| numberOfErrors | Anzahl Fehler bei der Verarbeitung |
| numberOfValidationErrors | Anzahl Validierungsfehler (Validierung) |
| tenant | Name des Benutzers |
| flowOperationUri | Link zur Operation |
| fileName | Dateiname von der Datenziel Operation, sonst leerer String |