Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
Beide Seiten der vorigen Revision Vorhergehende Überarbeitung Nächste Überarbeitung | Vorhergehende Überarbeitung | ||
action:personmailnotificator [20.09.2013 ] 172.16.1.171 [Beispielkonfiguration] |
action:personmailnotificator [13.11.2014 ] (aktuell) |
||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
+ | ====== PersonMailNotificator ====== | ||
+ | Der PersonMailNotificator dient dem Versand von E-Mails an Personen. In der Regel sind dies E-Mails die durch Prozesse in der [[:engine|SmartEngine]] ausgelöst werden (wie Abokündigungen, Opt-Ins bei Personenanlage etc.). | ||
+ | |||
+ | |||
+ | ===== Action-Parameter ====== | ||
+ | |||
+ | Die folgenden Parameter können zur Action als Action-Parameter übergeben werden: | ||
+ | |||
+ | ^Parameter-Name ^Beschreibung ^Pflicht? ^ | ||
+ | |TemplateName|Dateiname (ohne Pfad und [[wp>Locale]]-Information) eines Templates. Je nach Endung des Dateinamen wird entweder die Template-Engine [[http://velocity.apache.org|Apache Velocity]] (Endung ''.vm'') oder [[wp>JasperReports]] (Endung ''.jrxml'') verwendet.| ja | | ||
+ | |PersonID|Mit den Daten dieser Person soll das Template "gefüllt" werden|ja| | ||
+ | |ToEmail|An diese E-Mail Adresse soll die E-Mail versendet werden.|ja| | ||
+ | |FromEmail|E-Mail Adresse die als Absenderadresse verwendet werden soll.|ja| | ||
+ | |FromName|Name zur E-Mail-Adresse der in der Absenderadresse verwendet werden soll.|ja| | ||
+ | |Subject|Inhalt des "Betreffs" der E-Mail|ja| | ||
+ | ===== Template-Erstellung ===== | ||
+ | |||
+ | Die Erstellung von Templates ist beim [[action:ordermailnotificator#template-erstellung|Action-Handler: OrderMailNotificator]] beschrieben. Natürlich stehen die dort beschriebenen, auftragsbezogenen Informationen in den Templates nicht zur Verfügung. | ||
+ | ===== Konfiguration ====== | ||
+ | |||
+ | ==== statische ==== | ||
+ | |||
+ | Es werden die folgenden statischen Parameter unterstützt: | ||
+ | ^Name ^Beschreibung ^Pflicht? ^ | ||
+ | |outputPath|In dieses (lokale) Verzeichnis werden die erzeugten E-Mails vor dem Versand gespeichert.|ja| | ||
+ | |templatePath|Es werden die Templates für die Erzeugung der E-Mails aus diesem (lokalen) Verzeichnis verwendet|ja| | ||
+ | |errorsTo|Diese E-Mail Adresse wird im "Return-Path"-Header der gesendeten E-Mail gesetzt.|ja| | ||
+ | |BCC:<Template>|E-Mail Adresse die bei Verwendung des angegebenen Templates in den Action-Parametern als Blind-Carbon-Copy (BCC) gesetzt wird. Anwendungsfall ist z.B. eine Adresse zur externen Archivierung bestimmter E-Mails.|nein| | ||
+ | |||
+ | |||
+ | Über die oben genannten Parameter hinaus gelten die folgenden, bei allen Action-Handlern vorhandenen, statischen Parameter: | ||
+ | |||
+ | ^Name ^Beschreibung ^Pflicht? ^ | ||
+ | |commandID|Dieser Handler verarbeitet alle [[dstoreterm>ActionID|Actions]] dieses "Typs" ([[dstoreterm>CommandID|CommandID]])|ja| | ||
+ | |runningState|In diesen Status (eine ID, siehe [[dstoreproc>ac_ChangeActionState_Ad]]) soll die Action bei Beginn der Ausführung gesetzt werden. Best-Practice: ''100''|ja| | ||
+ | |successState|In diesen Status soll die Action nach der erfolgreichen Ausführung gesetzt werden. ''0'', falls die Action durch [[dstoreproc>mi_GarbageCollect_Ad]] gelöscht werden darf, sonst ''255''|ja| | ||
+ | |errorState|In diesen Status soll die Action nach der fehlerhaften Ausführung gesetzt werden. Best-Practice: ''-99''|ja| | ||
+ | ==== dynamische ==== | ||
+ | |||
+ | ^Name ^Beschreibung ^Pflicht? ^ | ||
+ | |isActive|Sollen von diesem Action-Handler Actions verarbeitet werden (mögliche Werte: ''0'' oder ''1'')? Dient dem kurzfristigen "anhalten" der Verarbeitung von Actions eines bestimmten Typs|ja| | ||
+ | |||
+ | ==== Beispielkonfiguration ==== | ||
+ | |||
+ | Hier eine Beispielkonfiguration welche mittels admin_SmartGate importiert werden und dann entsprechend angepasst werden kann: | ||
+ | |||
+ | {{:action:applicationsettings_action-handler_personmailnotificator.xml|}} |