Zum Inhalt springen

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen RevisionVorhergehende Überarbeitung
Nächste Überarbeitung		Vorhergehende Überarbeitung
server:ansteuerungen:mail [12.08.2024 16:53] – [OAuth2] Patrick Vogelserver:ansteuerungen:mail [30.09.2026 05:45] (aktuell) – Externe Bearbeitung 127.0.0.1
Zeile 1: Zeile 1:
-=====EDP Server -- Ansteuerung Mailserver=====+====== EDP-Server: Ansteuerung Mailserver ======
  
- +Mit dieser Schnittstelle sendet der EDP-Server E-Mails mit Einsatzinformationen an beliebige E-Mail-Adressen. Diese Seite beschreibt die Einstellungen der Ansteuerung, die Parameter in Aufgaben, den bedingten Mailversand und die Anmeldung per OAuth2.
  
-Mit dieser Schnittstelle kann der EDP-Server E-Mails mit Einsatzinformationen an beliebige E-Mail-Adressen senden. Mit der Schnittstelle ist es nicht möglich, E-Mails zu empfangen, auszuwerten und zur Erstellung eines Einsatzes zu nutzen. Nutzen Sie für diese Funktion bitte den [[einsatzserver:e-mail| Einsatzserver]].+===== Funktionsumfang ===== 
 + 
 +Mit der Schnittstelle können Sie keine E-Mails empfangen, auswerten und zur Erstellung eines Einsatzes nutzen. Verwenden Sie für diese Funktion den [[einsatzserver:e-mail|Einsatzserver]].
  
 ^ Funktion ^ Daten senden ^ Daten empfangen | ^ Funktion ^ Daten senden ^ Daten empfangen |
 | E-Mails| ✔| ✘ | | E-Mails| ✔| ✘ |
  
 +✔ = Die Schnittstelle unterstützt diese Funktion. ✘ = Die Schnittstelle unterstützt diese Funktion nicht. (Leer) = Entfällt.
  
-✔ = Die Schnittstelle unterstützt diese Funktion. ✘ = die Schnittstelle unterstützt diese Funktion nicht. (Leer) = Entfällt.  +===== Konfiguration =====
  
-Die Konfiguration der Ansteuerung geschieht mit dem Programm EDPServerKonfig.exe unter dem Punkt Ansteuerungen. Nach dem Klicken auf den Bearbeiten-Knopf erscheint folgendes Fenster, in dem alle Einstellungen der Ansteuerung vorgenommen werden:+Die Ansteuerung konfigurieren Sie mit dem Programm ''EDPServerKonfig.exe'' unter dem Punkt "Ansteuerungen". Nach einem Klick auf den Button "Bearbeiten" erscheint das folgende Fenster, in dem Sie alle Einstellungen der Ansteuerung vornehmen:
  
-  
 {{:server:ansteuerungen:konfig_mail.png?400|}} {{:server:ansteuerungen:konfig_mail.png?400|}}
  
 +==== SMTP-Server / Server-Port ====
  
- +DNS-Name oder IP-Adresse und Port (Standard: ''25'') des SMTP-Servers.
  
-=== SMTP-Server / Server-Port=== +==== Benutzername / Passwort ====
  
-DNS-Name oder IP-Adresse und Port (Standard: 25) des SMTP-Servers. +Benutzername und Passwort für die Anmeldung am SMTP-Server.
  
- +==== Absender ====
  
-=== Benutzername / Passwort=== +Absender der E-Mail (E-Mail-Adresse).
  
-Benutzername und Passwort zur Anmeldung am SMTP-Server.+> **Hinweis:** Die meisten E-Mail-Provider erwarten hier die Angabe der E-Mail-Adresse. Tragen Sie diese deshalb unbedingt in diesem Feld ein, sonst erscheint in der Regel eine Fehlermeldung.
  
- +==== ReplyTo ====
  
-=== Absender=== +Antwortadresse, an die Antworten auf die E-Mail gesendet werden. Wird die Absenderadresse nicht auf eingehende E-Mails überprüft, tragen Sie hier ein, an welche alternative Adresse die Antworten gehen sollen.
  
-Absender der E-Mail (e-Mailadresse). \\ +==== Kopie (CC/ BCC) ====
-**Wichtig: Die meisten e-Mailprovider erwarten hier die Angabe der e-Mailadresse. Diese sollte zwingend in diesem Feld angegeben werden. Ansonsten erfolgt in der Regel eine Fehlermeldung.**+
  
- +Gibt an, an welche E-Mail-Adresse die Nachricht als Kopie (CC) bzw. als Blindkopie (BCC) gesendet wird.
  
-=== ReplyTo=== +==== Betreff ====
  
-Anwortadresse, an die Antworten auf die E-Mail gesendet werden sollen. Wird die Absenderadresse nicht auf eingehende E-Mails überprüft, kann hier eingetragen werden an welche alternative Adresse die Antworten gesendet werden sollen.+Betreff der E-Mail. Sie können die in den Reports definierten Platzhalter verwenden. Über den Button "Datenfeld hinzufügen" fügen Sie die gängigsten Platzhalter automatisch ein.
  
- +==== Inhalt ====
  
-=== Kopie (CC/ BCC)=== +Inhalt der E-Mail. Sie können die in den Reports definierten Platzhalter verwenden. Über den Button "Datenfeld hinzufügen" fügen Sie die gängigsten Platzhalter automatisch ein.
  
-Gibt an, an welche E-Mailadresse die Nachricht als Kopie (CC) bzw. als Blindkopie (BCC) gesendet werden soll. +==== Bericht 1 / 2 ====
  
- +Hier legen Sie fest, welche Reports an die E-Mail angehängt werden. Geben Sie dazu den Namen des Reports ein. Es können maximal zwei Reports als Anhang versendet werden.
  
-=== Betreff=== +===== Spezifische Parameter der Ansteuerung =====
  
-Betreff der E-Mail. Es können die in den Reports definierten Platzhalter verwendet werden. Mit dem Knopf Datenfeld hinzufügen können die gängisten Platzhalter automatisch eingefügt werden.+Wenn Sie die Ansteuerung in einem Alarmvorschlag verwenden, müssen Sie der Aufgabe je nach Schnittstelle unter Umständen spezifische Parameter zuweisen. Siehe dazu auch die Dokumentation des EDP4-Einsatzleitplatzes.
  
- +Bei dieser Ansteuerung tragen Sie die E-Mail-Adresse des Empfängers als spezifischen Parameter ein.
  
-=== Inhalt=== +==== Weitere Parameter in der Aufgabe ====
  
-Inhalt der E-Mail. Es können die in den Reports definierten Platzhalter verwendet werden. Mit dem Knopf Datenfeld hinzufügen können die gängisten Platzhalter automatisch eingefügt werden.+> **Hinweis:** Die folgenden Ausführungen gelten erst ab EDP 2024.01.03.
  
-  +Zusätzlich können Sie weitere Parameter in der Aufgabe hinterlegen, um mit einer Schnittstelle verschiedene Szenarien abzudecken. Diese Parameter geben Sie in einer bestimmten Syntax an, die URL-Parametern ähnelt. Ein Beispiel:
- +
-=== Bericht 1 / 2===  +
- +
-Hier kann festgelegt werden, welche Reports an die E-Mail angehangen werden sollen. Bitte geben Sie dazu den Namen des Reports ein. Es können maximal zwei Reports als Anhang versendet werden. +
- +
-  +
- +
-=== Spezifische Parameter der Ansteuerung===  +
- +
-Bei der Verwendung der Ansteuerung in einem Alarmvorschlag müssen der Aufgabe unter Umständen (je nach Schnittstelle) spezifische Parameter zugewiesen werden, siehe auch Dokumentation des EDP4-Einsatzleitplatzes.  +
- +
-Bei dieser Ansteuerung ist die Empfänger-EMail-Adresse als spezifischer Parameter einzutragen.  +
- +
-Zusätzlich können auch weitere Parameter in der Aufgabe hinterlegt werden, um verschieden Szenarien mit einer Schnittstelle abdecken zu können. Diese Parameter müssen in einer bestimmten Syntax, die URL-Parametern ähnelt, angegeben werden. Ein Besipiel kann so aussehen:+
  
 <code> <code>
Zeile 80: Zeile 68:
 </code> </code>
  
-Dabei ist zu beachten, dass alle Parameter, die in der Aufgabe nicht angegebenen werden, einfach von der Grundkonfiguration der Schnittstelle übernommen werden. Folgende Parameter können im Aufgaben-Wert übergeben werden: +Alle Parameter, die Sie in der Aufgabe nicht angeben, werden aus der Grundkonfiguration der Schnittstelle übernommen. Folgende Parameter können Sie im Wert der Aufgabe übergeben: 
-  * empfänger +  * ''empfänger'' 
-  * absender +  * ''absender'' 
-  * replyto +  * ''replyto'' 
-  * copycc +  * ''copycc'' 
-  * copybcc +  * ''copybcc'' 
-  * betreff +  * ''betreff'' 
-  * inhalt +  * ''inhalt'' 
-  * fdsdatei +  * ''fdsdatei'' 
-  * anhang1 +  * ''anhang1'' 
-  * anhang2 +  * ''anhang2''
  
 +===== Bedingter Mailversand - ab Version 4.9 =====
  
- 
- 
- 
- 
-==== Bedingter Mailversand - ab Version 4.9 ==== 
 <note important> **Diese Option ist nur für erfahrene Benutzer empfohlen.**</note> <note important> **Diese Option ist nur für erfahrene Benutzer empfohlen.**</note>
  
-Ab der EDP-Version 4.9 kann in der Aufgabe eine Bedingung für den Mailversand hinterlegt werden. \\ +Ab der EDP-Version 4.9 können Sie in der Aufgabe eine Bedingung für den Mailversand hinterlegen. Die Bedingung ist eine SQL-Abfrage. Die Mail wird nur versendet, wenn die hinterlegte SQL-Abfrage ein Ergebnis zurückgibt (mehr als 0 Ergebniszeilen). In der SQL-Abfrage können Sie den Platzhalter ''<%EINSATZNUMMER%>'' verwenden.
-Die Bedingung wird in Form einer SQL-Abfrage hinterlegt, die Mail wird nur dann versendet, wenn die Hinterlegte SQL-Abfrage ein Ergebnis zurückgibt (>0 Ergebniszeilen). Dabei kann der Platzhalter <%EINSATZNUMMER%> in die SQL-Abfrage integriert werden.+
  
-Die bedingte Abfrage betrifft nur die Aufgaben, die in der Form "mail@adresse|SQL-ABFRAGE" hinterlegt sind; Wird keine Abfrage gefunden, wird die Aufgabe normal ausgeführt. +Die Bedingung betrifft nur Aufgaben, die in der Form ''mail@adresse|SQL-ABFRAGE'' hinterlegt sind. Wird keine Abfrage gefunden, wird die Aufgabe normal ausgeführt.
- \\ +
- \\+
  
-Um den bedingten Mailversand zu aktivieren, muss in der Konfig-Datei der Schnittstelle der folgende Text hinterlegt werden. Klicken Sie dazu bitte in der EDP-Konfiguration mit Rechts auf die Schnittstelle, wählen im Menü "Definition" und klicken dann im sich öffnenden Dialog auf den Button "Konfig-Datei anzeigen":+Um den bedingten Mailversand zu aktivieren, hinterlegen Sie in der Konfig-Datei der Schnittstelle den folgenden Text. Klicken Sie dazu in der EDP-Konfiguration mit der rechten Maustaste auf die Schnittstelle, wählen Sie im Menü "Definition" und klicken Sie im folgenden Dialog auf den Button "Konfig-Datei anzeigen":
 <code> <code>
 [Advanced] [Advanced]
 ConditionalMailSend=1 ConditionalMailSend=1
 </code> </code>
-Diese Einstellung ist in der normalen Konfigmaske nicht vorhanden und kann nur wie oben beschrieben manuell in der Grundkonfiguration ergänzt werden.+Diese Einstellung ist in der normalen Konfigurationsmaske nicht vorhanden. Sie kann nur wie beschrieben manuell in der Grundkonfiguration ergänzt werden.
  
- \\ +Das folgende Beispiel für das Feld "Wert" einer Aufgabe enthält eine SQL-Abfrage, mit der die Mail nur versendet wird, wenn die Einsatzart ungleich "T" (z.B. Test) ist:
-Nachfolgend wird ein Beispiel für das Feld "Wert" einer Aufgabe genannt. Dort ist die SQL-Abfrage so gestaltet, dass der Mailversand nur dann erfolgt, wenn die Einsatzart ungleich "T" (z.B. Test) ist:+
 <code> <code>
 email@adresse.de|SELECT EINSATZNUMMER FROM EINSAETZE WHERE EINSATZART<>'T' AND EINSATZNUMMER='<%EINSATZNUMMER%>' email@adresse.de|SELECT EINSATZNUMMER FROM EINSAETZE WHERE EINSATZART<>'T' AND EINSATZNUMMER='<%EINSATZNUMMER%>'
 </code> </code>
  
-Bitte beachten Sie, dass das Auslösen der Aufgabe trotzdem in EDP dokumentiert wird und nur im Logfile erkenntlich ist, ob auf Grund der Bedingung der Versand unterdrückt wurde. +Beachten Sie, dass das Auslösen der Aufgabe trotzdem in EDP dokumentiert wird. Ob der Versand wegen der Bedingung unterdrückt wurde, ist nur im Logfile erkennbar.
- +
-==== OAuth2 ==== +
- +
-Ab der Version 2024.01.03 kann die Authentifizierung auch mittels OAuth2 durchgeführt werden. Dies ist unter anderem für Nutzer von Microsoft 365 vorgesehen. +
- +
-Die Authentifizierung und initiale Abfrage eines Tokens kann über die Schnittstellen-Konfiguration gestartet werden.  +
- +
-Im ersten Schritt muss OAuth2 aktiviert werden. +
- +
-{{:server:ansteuerungen:screenshot_2024-08-08_180207.png?400|}} +
- +
-Nach der Aktivierung kann über den "Token anfordern"-Button die eigentliche Authentifizierung durchgeführt werden.+
  
-Dadurch werden die benötigten Tokens im Server-Ordner als .txt-Datei abgelegt. Danach müssen nur noch die Verbindungsdaten für den eigentlichen SMTP-Server angegeben werden. Die Standarddaten für Micosoft 365 können per Knopfdruck eingesetzt werden.+===== OAuth2 =====
  
-Der im Browser angegebene Account muss schließlich noch als Username hinterlegt werden:+Ab der Version 2024.01.03 kann die Authentifizierung auch per OAuth2 erfolgen. Das ist unter anderem für Nutzer von Microsoft 365 vorgesehen.
  
-{{:server:ansteuerungen:screenshot_2024-08-08_180301.png?400|}}+Die Authentifizierung und die erste Abfrage eines Tokens starten Sie über die Schnittstellen-Konfiguration:
  
 +  - Aktivieren Sie OAuth2. {{:server:ansteuerungen:screenshot_2024-08-08_180207.png?400|}}
 +  - Führen Sie über den Button "Token anfordern" die eigentliche Authentifizierung durch. Die benötigten Tokens werden dabei im Server-Ordner als ''.txt''-Datei abgelegt.
 +  - Geben Sie die Verbindungsdaten für den eigentlichen SMTP-Server an. Die Standarddaten für Microsoft 365 können Sie per Knopfdruck einsetzen.
 +  - Hinterlegen Sie den im Browser angegebenen Account als Benutzernamen. {{:server:ansteuerungen:screenshot_2024-08-08_180301.png?400|}}