Inhaltsverzeichnis
TaskNotificatorEx
Mit dem TaskNotificatorEx Job-Step ist es möglich Taskbenachrichtigungen per E-Mails zu versenden.
Hinweis: Per default wird eine Benachrichtigung an die beim Benutzer hinterlegte E-Mail Adresse gesendet. Bei automatisierten Jobs ist das der Benutzer welcher bei der Automatisierung hinterlegt wurde.
| Eigenschaften | |
|---|---|
| Name | Beschreibung |
| Typ | Der Klassenname des Job-Steps |
| Name | Der Name des Job-Steps wie er im Job Designer erscheinen soll |
| Beschreibung | Eine optionale Erläuterung des Job-Steps |
| Kommunikationkanal | Name des Channels, der zum Versenden der E-Mails verwendet wird. |
| Umfang der Benachrichtigung | Anhand dieser Einstellung kann eingegrenzt werden welche Tasks vom Notificator verarbeitet werden sollen: \\- Alle Fehler des Jobs \\- Nicht benachrichtigte Fehler des Jobs \\- Nicht erledigte Fehler des aktuellen Jobs (ohne unter Jobs)\\- Nicht benachrichtigte des aktuellen Jobs (ohne unter Jobs) |
| Relevante Fehlerzustände | Eine Menge von TaskLevel für die der Notificator zuständig ist. Ist diese Menge leer, so wird der Notificator Benachrichtungeng für sämtliche ihm übergebenen Tasks erstellen. Andernfalls werden nur Tasks die einen der TaskLevels aus dieser Menge aufweisen vom Notifactor berücksichtigt. |
| Min. Anzahl fehlerhafte Ausführung | Die Benachrichtigung wird nur geschickt, wenn die Nachricht die angegeben Anzahl an fehlerhaften Läufen überschritten hat. Das ist sinnvoll, wenn eine Nachricht im Fehlerfall n-mal erneut gestartet wird, bevor ein Fehler ausgegeben werden soll. |
| Sytempartner benachrichtigen | Ist der Wert auf 'true' gesetzt, dann wird die Benachrichtigung auch an den ResponsibleAdministrator bzw. an den ResponsibleAdminNotificationAddress des betroffenen SystemPartners geschickt. |
| Handelspartner benachrichtigen | Ist der Wert auf 'true' gesetzt, dann wird die Benachrichtigung auch an den ResponsibleAdministrator bzw. an den ResponsibleAdminNotificationAddress des betroffenen TradingPartner geschickt. |
| An die Message „ComSender“ Adresse | Je nach gewählter Einstellung wird der „ComSender“ anstelle der in der Konfiguration des Senders (System-/Handelspartner) hinterlegten administrativen Adresse verwendet. |
| An die Message „ComReceiver“ Adresse | Je nach gewählter Einstellung wird der „ComReceiver“ anstelle der in der Konfiguration des Empfängers (System-/Handelspartner) hinterlegten administrativen Adresse verwendet. |
| Betreff | Das Betreff der Mail. Wenn nicht gesetzt, dann wird das Subject vergeben als „[<Zeitstempel>] eBiss Notification for: Empfänger“. Alternativ kann man hier einen festen Betreff vergeben und alle unten genannten Variablen verwenden, z.B.: „We cannot process docnumer $DocumentNumber“ |
| Zusätzliche(r) Empfänger | Hier können weitere Empfänger eingetragen werden. E-Mail-Adressen werden mit Komma oder Semikolon separiert.\\(Beispiel mit Muster Frau und Muster Mann: mf@pranke.com, mm@pranke.com) |
| CC Empfänger | Hier können CC Empfängern eingetragen werden. E-Mail-Adressen werden mit Komma oder Semikolon separiert.\\(Beispiel mit Muster Frau und Muster Mann: mf@pranke.com, mm@pranke.com) |
| Typ der Benachrichtigung | Der Inhalt kann entweder als HTML, TEXT oder aus einer Vorlage (siehe 'Benachrichtigungsvorlage') heraus erstellt werden. |
| Benachrichtigungsvorlage | Ist beim Typ der Benachrichtigung (s.o.) der Wert Template ausgewählt, dann wird die hier angegeben Datei verwendet, um die Benachrichtigung zu formatieren. Beispielvorlagen befinden sich im eBiss Verzeichnis unter StandardTemplates\TaskNotificatorEx\. |
| URL Referenz | Angabe einer URL, auf die sich der TaskNotificator bezieht. |
| Task- und Nachrichtenstatus zurücksetzen | Definieren Sie ob verschickte Tasks auf erledigt gesetzt werden sollen und der Nachrichtenfehlerstatus zurückgesetzt werden soll. Bei den mit '(PI)' markierten Optionen wird die Aktion nur ausgeführt, wenn eine Nachricht an den System- oder Trading-Partner geschickt wurde |
| Anhang anfügen | Die Nachricht (der Anhang) wird an die Mail gehängt |
Hinweis: Die Option CreateSingleTaskMessage des eBissUsers sollte unbeding verwendet werden,
damit das erstellen einzelner Tasks für jeden Fehler ermöglicht wird, um die TaskMessages an den Administrator des betreffenden TradingPartner schicken zu können.
Folgende JobSteps werden i.d.R. mit dem TaskNotificatorEx verbunden
Benachrichtung bei Verwendung einer Vorlage
Um die TaskNotification Inhalte in einer anderen Form darzustellen ist es möglich das Default Template zu ändern.
Hier für bietet sich z.Bsp. HTML an.
Wobei die variablen Inhalte mit den folgenden Variablen befüllt werden können.
| Name | Bedeutung |
|---|---|
| $CommunicationReference | Referenz der Kommunikation (ComRef) z.B. die Nachrichten-ID der zugehörigen Nachricht. |
| $CommunicationReferences | Liefert durch Komma getrennt die Liste der $CommunicationReference Werte. Sinnvoll, wenn dem Task mehrere Nachrichten zugeordnet sind. |
| $DocumentExcerpt | Auszug aus der betroffenen Nachricht (Max. erste 256 Zeichen). |
| $DocumentNumber | Eine Dokumentennummer. Bei mehrere Dokumente die Dokumentennummer des ersten Dokumentes. |
| $DocumentType | Der Typ des Dokumentes. Bei mehrere Dokumente der Typ des ersten Dokumentes. |
| $DocumentNumbers | Liefert durch Komma getrennt die Liste der Dokumentennummern. Sinnvoll, wenn dem Task mehrere Dokumente betrifft. |
| $DocumentTypes | Liefert durch Komma getrennt die Liste der Typen der Dokumente. Sinnvoll, wenn dem Task mehrere Dokumente betrifft. |
| $MessageTradingPartner.Name | Name des mit der Nachricht verknüpften Handelspartners. |
| $MessageTradingPartner.TNr | Teilnehmernummer des mit der Nachricht verknüpften Handelspartners. |
| $MessageSystemPartner.Name | Name des mit der Nachricht verknüpften Systempartners. |
| $MessageSystemPartner.TNr | Teilnehmernummer des mit der Nachricht verknüpften Systempartners. |
| $MessageTradingPartners.Name | Liefert durch Komma getrennt die Liste der $MessageTradingPartner.Name Werte. Sinnvoll, wenn dem Task mehrere Nachrichten zugeordnet sind. |
| $MessageTradingPartners.TNr | Liefert durch Komma getrennt die Liste der $MessageTradingPartner.TNr Werte. Sinnvoll, wenn dem Task mehrere Nachrichten zugeordnet sind. |
| $MessageSystemPartners.Name | Liefert durch Komma getrennt die Liste der $MessageSystemPartner.Name Werte. Sinnvoll, wenn dem Task mehrere Nachrichten zugeordnet sind. |
| $MessageSystemPartners.TNr | Liefert durch Komma getrennt die Liste der $MessageSystemPartner.TNr Werte. Sinnvoll, wenn dem Task mehrere Nachrichten zugeordnet sind. |
| $NotifiedParty | Anrede des Empfängers (entspricht dem Namen des Ansprechpartners im Handelspartner). |
| $Subject | Betreff der betroffenen Nachricht. |
| $Subjects | Liefert durch Komma getrennt die Liste der $Subject Werte. Sinnvoll, wenn dem Task mehrere Nachrichten zugeordnet sind. |
| $TaskCreated | Fehlerzeitpunkt. |
| $TaskMessage | Fehlermeldung. |
Falls gewünscht kann ein Fallback angegeben werden das verwendet werden soll wenn die gewünschte Information fehlt.
Die Syntax für Variablenplatzhalter mit Fallback: $(<Name der Variable>|„<alternativer Text>“).
Ein Beispiel für HTML Template ist unter .\eBiss 3\StandardTemplates\TaskNotificatorEx\ abgelegt.
Hinweis: alternatives TaskNotificatorEx Template.