Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
Beide Seiten der vorigen Revision Vorhergehende Überarbeitung Nächste Überarbeitung | Vorhergehende Überarbeitung Nächste Überarbeitung Beide Seiten der Revision | ||
software:tim:mail_configuration [2014/05/27 15:56] stefan.barth [Taskmails pro Definition und Node unterschiedlich (ab [[software:tim:changelog:tim40|v4.0]])] |
software:tim:mail_configuration [2016/05/17 09:19] jan.mayer |
||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
====Task- und Gruppen Emails anpasssen==== | ====Task- und Gruppen Emails anpasssen==== | ||
- | Es ist möglich die von T!M verschickten Emails, die z.B. über neue Aufgaben informieren, anzupassen. Der Text kann beliebig geändert werden. | + | Es ist möglich die von TIM verschickten Emails, die z.B. über neue Aufgaben informieren, anzupassen. Der Text kann beliebig geändert werden. |
- | Dafür muss die Datei **[[loom.properties]]** mit einem Textbearbeitungsprogramm geöffnet werden. Diese Datei befindet sich unter folgender Ordnerstruktur: | + | Dafür muss die Datei **[[tim.properties]]** mit einem Textbearbeitungsprogramm geöffnet werden. Diese Datei befindet sich unter folgender Ordnerstruktur: |
- | + | ||
- | ...\server\default\deploy\loom.ear\config | + | |
+ | ...\standalone\configuration\ | ||
+ | | ||
Alle Mailtexte können entweder normalen Text enthalten oder auch als [[:software:tim:mail_configuration#html-taskmails| HTML-Mails]] versendet werden. | Alle Mailtexte können entweder normalen Text enthalten oder auch als [[:software:tim:mail_configuration#html-taskmails| HTML-Mails]] versendet werden. | ||
Zeile 12: | Zeile 12: | ||
== Notification Mails == | == Notification Mails == | ||
- | Unter dem Punkt **Notification Mails** können die Benachrichtigungs Email über erledigte Aufgaben angepasst werden. | + | Unter dem Punkt **Notification Mails** können die Benachrichtigungs Mails über erledigte Aufgaben angepasst werden. |
* **notification-assignee-mail-subject** : Ändert den Betreff der Mail | * **notification-assignee-mail-subject** : Ändert den Betreff der Mail | ||
* **notification-assignee-mail-text** : Ändert den Text dieser Mail | * **notification-assignee-mail-text** : Ändert den Text dieser Mail | ||
Zeile 53: | Zeile 53: | ||
----- | ----- | ||
- | ==Mögliche Variablen für die Mailtexte== | + | ==Variablen in Mailtexten verwenden== |
- | Es ist möglich in den Mailtexten bestimmte Schlagwörter zu benutzen, diese werden anschließend durch die zugehörige Variable ersetzt. | + | Der Text einer Emailbenachrichtigung kann mit Systemvariablen angereichert werden. Diese werden bei der Anzeige mit den entsprechenden Werten befüllt. Das folgende Beispiel zeigt deren Verwendung in einem Mailtext. |
- | + | <code> | |
- | * **${processDefinitionName}** : Der Name der Prozessdefinition zu welcher z.b. die Task gehört | + | Hallo, |
- | * **${processInstanceName}** : Der Name der zugehörigen Prozessinstanz | + | überprüfen Sie bitte die an die Aufgabe ${SYS.TASK_NAME} angehängten Dokumente auf Korrektheit. |
- | * **${processInstanceId}** : Die Identifikationsnummer der Prozessinstanz | + | Geben Sie anschließend den Status der Prozessinstanz ${SYS.PROCESSINSTANCE_NAME} an ihren Vorgesetzten weiter. |
- | * **${processInstanceDescription} **: Die Beschreibung, welche der Prozessinstanz beim [[start_instance|Start]] hinterlegt wurde | + | Vielen Dank. |
- | * **${taskName} ** : Der Name der zugehörigen Aufgabe | + | </code> |
- | * **${nodeName} ** : Der Name der Aktivtät in welcher sich die Aufgabe befindet | + | Die Variablen **${SYS.TASK_NAME}** und **${SYS.PROCESSINSTANCE_NAME}** werden im Mailtext durch dem zugehörigen Aufgabennamen bzw. Instanznamen ersetzt. Eine vollständige Liste der verfügbaren Systemvariablen finden Sie auf der [[faq:variableshelper|Variable Helper-Seite]] |
- | * **${taskId}** : Die Identifikationsnummer der Aufgabe | + | ---- |
- | * **${nodeId}** : Die Identifikationsnummer der Aktivität | + | |
- | * **${taskLink}** : Ein Link der direkt zu der zugehörigen Aufgabe führt | + | |
- | * **${taskDescription} ** : Die Beschreibung der derzeitigen Aufgabe | + | |
- | * **${baseLink} ** : Der Baselink bildet den Basislink zu dem Server auf welchem die Aufgabe erstellt wurde (z.b. tim.taskinmotion.de) | + | |
- | * **${NOW} ** : Das aktuelle Datum | + | |
- | * **${JEDEPROZESSVARIABLE}** : Hier kann jede Prozessvariable aus einem Prozess eingesetzt werden. | + | |
- | + | ||
- | ----- | + | |
==== HTML-Taskmails ==== | ==== HTML-Taskmails ==== | ||
- | [[software:tim:loom.properties#Mails|HTML-Taskmails]] können verwendet werden um den Mailinhalt aufzubereiten. Neben der Möglichkeit einfache Textlinks einzubetten können hier bspw. auch Bilder etc. verwendet werden. Dies ist bei herkömmlichen Task-Mails nicht möglich. Um HTML-Mails zu ermöglichen, muss der Parameter taskmail-text mit | + | [[software:tim:tim.properties#Mails|HTML-Taskmails]] können verwendet werden um den Mailinhalt aufzubereiten. Neben der Möglichkeit einfache Textlinks einzubetten können hier bspw. auch Bilder etc. verwendet werden. Dies ist bei herkömmlichen Task-Mails nicht möglich. Um HTML-Mails zu ermöglichen, muss der Parameter taskmail-text mit folgenden Wert beginnen: |
<code> | <code> | ||
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"></head><body> | <html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"></head><body> | ||
</code> | </code> | ||
- | beginnen. | + | |
**Beispiel:** | **Beispiel:** | ||
<code html> | <code html> | ||
- | taskmail-text=<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> | + | taskmail-text=<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"></head><body>Sie haben eine neue Aufgabe: ${taskName} <br/> im Prozess: ${processDefinitionName} erhalten. <br/> \nn\nDirekt zur Aufgabe: <a href="${taskLink}">${taskName}</a></body></html> |
- | </head> | + | |
- | <body> | + | |
- | Sie haben eine neue Aufgabe: ${taskName} <br/> | + | |
- | im Prozess: ${processDefinitionName} erhalten. <br/> | + | |
- | Soll T!M sie sp\u00e4ter an diese Aufgabe erinnern? <br/> | + | |
- | <br/> | + | |
- | <a href="${baselink}EscalationManager/createTaskReminderWithOffsetFromNow.void?args[0]=${taskId}&args[1]=1d&i=1">Morgen Erinnern.</a><br/> | + | |
- | \n<a href="${baselink}EscalationManager/createTaskReminderWithOffsetFromNow.void?args[0]=${taskId}&args[1]=3d&i=1">In drei Tagen Erinnern.</a><br/> | + | |
- | \n<a href="${baselink}EscalationManager/createTaskReminderWithOffsetFromNow.void?args[0]=${taskId}&args[1]=1w&i=1">In einer Woche erinnern</a><br/> | + | |
- | \n<a href="${baselink}EscalationManager/createTaskReminderWithOffsetFromNow.void?args[0]=${taskId}&args[1]=1m&i=1">In einem Monat erinnern.</a><br/> | + | |
- | <br/> | + | |
- | \n\nDirekt zur Aufgabe: <a href="${taskLink}">${taskName}</a> | + | |
- | </body> | + | |
- | </html> | + | |
</code> | </code> | ||
Zeile 101: | Zeile 79: | ||
----- | ----- | ||
- | ==== Taskmails pro Definition und Node unterschiedlich (ab [[software:tim:changelog:tim40|v4.0]]) ==== | + | ==== Taskmails pro Definition und Node unterschiedlich (ab v4.0) ==== |
Es kann je Definition und/oder Node ein eigener Betreff und Mailtext benutzt werden. | Es kann je Definition und/oder Node ein eigener Betreff und Mailtext benutzt werden. | ||
- | Der Eintrag in der loom.property lautet dann wie folgt: \\ | + | Der Eintrag in der Datei tim.properties lautet dann wie folgt: \\ |
- | taskmail-text-PROZESSDEFINITIONSNAME-NODENAME-MIT-LEERZEICHEN=Hier steht der Taskmailtext für eine bestimmte Node in einem bestimmten Prozess | + | taskmail-text-prozessdefinitionsname-nodename-mit-leerzeichen=Hier steht der Taskmailtext für eine bestimmte Node in einem bestimmten Prozess |
- | Wobei alle Zeichen außer Buchstaben und Zahlen durch - ersetzt werden müssen. Der komplette Name muss klein geschrieben sein.\\ | + | taskmail-subject-prozessdefinitionsname-nodename-mit-leerzeichen=Ihnen wurde die Aufgabe ${taskName} im Prozess ${processInstanceName} zugewiesen |
- | Es wird bei jeder Task versucht einen Mailtext speziell für diese Node zu finden. Wird keiner gefunden wird ein Mailtext für die Prozessdefinition gesucht. Ist auch dieser nicht vorhanden wird der Standarttext benutzt. \\ | + | |
- | Also: \\ | + | Es wird bei jeder Aufgabenmail versucht, einen Mailtext speziell für diese Node zu finden. Wird keiner gefunden, wird ein Mailtext für die Prozessdefinition gesucht. Ist auch dieser nicht vorhanden, wird der Standarttext benutzt. \\ |
- | taskmail-text-PROZESSDEFINITIONSNAME=Das ist der Aufgabentext von der Prozessdefinition PROZESSDEFIONSNAME | + | Beispiel für einen individuellen Mailtext je Prozessdefinition: \\ |
+ | taskmail-text-prozessdefinitionsname-mit-leerzeichen=Das ist der Aufgabentext von der Prozessdefinition PROZESSDEFIONSNAME | ||
+ | taskmail-subject-prozessdefinitionsname-mit-leerzeichen=Ihnen wurde die Aufgabe ${taskName} im Prozess ${processInstanceName} zugewiesen | ||
+ | |||
+ | <note important>Prozessdefinitions- und Nodename müssen **klein** geschrieben werden! Leerzeichen und Sonderzeichen werden mit einem **-** dargestellt</note> | ||
+ | ----- | ||
+ | |||
+ | ==== Mehrsprachige Emails ==== | ||
+ | Abhängig von der Sprache des angemeldeten Nutzers könnnen die Mailtexte in verschiedenen Sprachen verschickt werden. Hierfür muss die Lokale des Nutzers angehängt werden: \\ | ||
+ | de-taskmail-subject-prozessdefinitionsname-nodename = Hier steht der Betreff der Email | ||
+ | de-taskmail-text-prozessdefinitionsname-nodename = Hier steht der Text der Email | ||
+ | |||
+ | en-taskmail-subject-prozessdefinitionsname-nodename = This is the subject | ||
+ | en-taskmail-text-prozessdefinitionsname-nodename = This is the mailtext | ||
| | ||
- | ------ | + | <note important>Falls Mehrsprachigkeit im [[software:tim:processrepository|Process Repository]] gefplegt ist müssen Prozessdefinitions- und Nodename der default Sprache verwendet werden!</note> |
+ | ----- | ||
==== Taskmails (De-)aktivieren ==== | ==== Taskmails (De-)aktivieren ==== | ||
- | Um Taskmails für einzelne Benutzer zu deaktivieren, kann im [[software:tim:userprofil_profile|Benutzerprofil]] die Option **"Benachrichtigung per Mail bevorzugen"** Ein-, bzw Ausgeschalten werden. Diese Einstellung existiert auch Systemweit im [[software:tim:client_profile|Clientprofil]] | + | Um [[software:tim:taskmail|Taskmails]] für einzelne Benutzer zu deaktivieren, kann im [[software:tim:userprofil_profile|Benutzerprofil]] die Option **"Benachrichtigung per Mail bevorzugen"** Ein-, bzw Ausgeschalten werden. Diese Einstellung existiert auch Systemweit im [[software:tim:client_profile|Clientprofil]] |
+ | ----- | ||
+ | |||
+ | ==== Fehler Mails ==== | ||
+ | Falls beim versenden einer Mail ein Fehler auftritt und im Client Profil das Feld "Benachrichtigung bei Fehler" gepflegt ist, wird an die ausgewählte Gruppe eine Mail versendet die sich wie folgt zusammensetzt: \\ | ||
+ | mail-not-sent-subject=Mail nicht gesendet Id: ${MAIL.ID} Betreff: ${MAIL.SUBJECT} | ||
+ | mail-not-sent-text=Beim Versand sind folgenden Probleme aufgetreten.\n\n | ||
+ | Zusätzlich wird die Aufgetretene Exception an den Mailtext mit angehängt. | ||
+ | ----- |