Plugin installed incorrectly. Rename plugin directory 'swiftmail.backup' to 'swiftmail'.
en:software:tim:mail_configuration
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
en:software:tim:mail_configuration [2017/10/30 16:09] Julian Le |
en:software:tim:mail_configuration [2021/07/01 09:52] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====Editing e-mails for tasks and groups==== | + | ==== Editing e-mails for tasks and groups ==== |
| - | It is possible to edit e-mails sent by TIM, for example e-mails that are meant to inform users about new task assignments. The text of an e-mail may be changed. | + | It is possible to edit e-mails sent by TIM, for example e-mails that are meant to inform users about new task assignments. The text of an e-mail may be changed. To do this, the file **[[:en:software:tim:tim.properties|]]** has to be opened with a word-processing program. This file is located in the following directory:<code> |
| - | To do this, the file **[[tim.properties]]** has to be opened with a word-processing program. This file is located in the following directory: | + | .../standalone/configuration/ |
| - | + | </code> | |
| - | ...\server\default\deploy\loom.ear\config | + | |
| - | All e-mails may be sent either as a normal text or as [[en:software:tim:mail_configuration#html-taskmails| HTML-mails]]. | + | All e-mails may be sent either as a normal text or as [[:en:software:tim:mail_configuration#html-taskmails|HTML-mails]]. |
| - | ------ | + | ---- |
| == Notification mails == | == Notification mails == | ||
| Via the menu item **Notification Mails**, e-mails used to inform users about completed tasks can be edited. | Via the menu item **Notification Mails**, e-mails used to inform users about completed tasks can be edited. | ||
| - | * **notification-assignee-mail-subject** : This options changes the subject of an e-mail | ||
| - | * **notification-assignee-mail-text** : This option changes the textual content of an e-mail | ||
| - | ----- | + | * **notification-assignee-mail-subject** : This options changes the subject of an e-mail |
| + | * **notification-assignee-mail-text** : This option changes the textual content of an e-mail | ||
| + | ---- | ||
| + | |||
| + | == Archivation == | ||
| - | ==Archivation== | ||
| Via this menu item, e-mails used to inform users about archived instances can be edited: | Via this menu item, e-mails used to inform users about archived instances can be edited: | ||
| - | ***archivation-mail-subject** : This option changes the subject of an e-mail | ||
| - | ***archivation-mail-text** : This option changes the textual content of an e-mail | ||
| - | ----- | + | * **archivation-mail-subject** : This option changes the subject of an e-mail |
| + | * **archivation-mail-text** : This option changes the textual content of an e-mail | ||
| + | ---- | ||
| + | |||
| + | == Reactivation(Unarchivation) == | ||
| - | ==Reactivation(Unarchivation)== | ||
| Via this manue item, email used to inform users about archived instances can be edited: | Via this manue item, email used to inform users about archived instances can be edited: | ||
| - | ***unarchivation-mail-subject** : This option changes the subject of an e-mail | ||
| - | ***unarchivation-mail-text** : This option changes the textual content of an e-mail | ||
| - | ------ | + | * **unarchivation-mail-subject** : This option changes the subject of an e-mail |
| + | * **unarchivation-mail-text** : This option changes the textual content of an e-mail | ||
| + | ---- | ||
| - | ==Adhoc== | + | == Adhoc == |
| - | Via this menu item, e-mails informing users about [[en:software:tim:ad_hoc_tasks | AdHoc]] tasks can be edited: | + | |
| - | * **notification-adhoc-close-subject** : This option changes the subject of an e-mail | + | |
| - | * **notification-adhoc-close-text** : This option changes the textual content of an e-mail | + | |
| - | ----- | + | Via this menu item, e-mails informing users about [[:en:software:tim:ad_hoc_tasks|AdHoc]] tasks can be edited: |
| - | ==Reopened Adhoc== | + | * **notification-adhoc-close-subject** : This option changes the subject of an e-mail |
| - | Via this menu item, emails used to inform users about a reactivated [[en:software:tim:ad_hoc_tasks | AdHoc]] tasks can be edited. | + | * **notification-adhoc-close-text** : This option changes the textual content of an e-mail |
| - | * **notification-adhoc-reopen-close-subject** : This option changes the subject of an e-mail | + | ---- |
| - | * **notification-adhoc-reopen-close-text** : This option changes the textual content of an e-mail | + | |
| - | ------ | + | == Reopened Adhoc == |
| - | ==Process accompanying documents== | + | Via this menu item, emails used to inform users about a reactivated [[:en:software:tim:ad_hoc_tasks|AdHoc]] tasks can be edited. |
| - | Via this menu item, emails used to inform users about an newly attached blog-article. | + | |
| - | * **business-obj-message-subject-en** : Changes the english subject of an e-email | + | |
| - | * **business-obj-message-de** : Changes the german text of the e-mail | + | |
| - | * **business-obj-message-en** : Changes the english text of the e-mail | + | |
| - | * **business-obj-recipient-label-de** : Changes the german recipant-label | + | |
| - | * **business-obj-recipient-label-en** : Changes the english recipant-label | + | |
| - | ------ | + | * **notification-adhoc-reopen-close-subject** : This option changes the subject of an e-mail |
| + | * **notification-adhoc-reopen-close-text** : This option changes the textual content of an e-mail | ||
| + | ---- | ||
| - | ==Taskmail== | + | == Process accompanying documents == |
| - | Via this menu item, texts of e-mails used to assign new tasks to employees can be edited: | + | |
| - | * **taskmail-subject** : This option changes the subject of an e-mail | + | |
| - | * **taskmail-text** : This option changes the textual content of an e-mail | + | |
| + | Via this menu item, emails used to inform users about an newly attached blog-article. | ||
| + | * **business-obj-message-subject-en** : Changes the english subject of an e-email | ||
| + | * **business-obj-message-de** : Changes the german text of the e-mail | ||
| + | * **business-obj-message-en** : Changes the english text of the e-mail | ||
| + | * **business-obj-recipient-label-de** : Changes the german recipant-label | ||
| + | * **business-obj-recipient-label-en** : Changes the english recipant-label | ||
| + | ---- | ||
| + | == Taskmail == | ||
| + | |||
| + | Via this menu item, texts of e-mails used to assign new tasks to employees can be edited: | ||
| + | |||
| + | * **taskmail-subject** : This option changes the subject of an e-mail | ||
| + | * **taskmail-text** : This option changes the textual content of an e-mail | ||
| The e-mails that are sent by the system as reminders for unfinished tasks can be edited in a similar manner: | The e-mails that are sent by the system as reminders for unfinished tasks can be edited in a similar manner: | ||
| - | * **taskreminder-subject** : This option changes the subject of an e-mail | ||
| - | * **taskreminder-text** : This option changes the textual content of an e-mail | ||
| + | * **taskreminder-subject** : This option changes the subject of an e-mail | ||
| + | * **taskreminder-text** : This option changes the textual content of an e-mail | ||
| The e-mails that are sent by the system as reminders for unfinished nodes can be edited in a similar manner: | The e-mails that are sent by the system as reminders for unfinished nodes can be edited in a similar manner: | ||
| - | * **nodereminder-text** : This option changes the subject of an e-mail | ||
| - | * **nodereminder-subject** This option changes the text of an e-mail | ||
| - | ----- | + | * **nodereminder-text** : This option changes the subject of an e-mail |
| + | * **nodereminder-subject** This option changes the text of an e-mail | ||
| + | ---- | ||
| + | |||
| + | == Mail-not-send == | ||
| - | ==Mail-not-send== | ||
| Via this menu item, e-emails used to infeorm users about an e-mail which couldn't be sent can be edited: | Via this menu item, e-emails used to infeorm users about an e-mail which couldn't be sent can be edited: | ||
| - | * **mail-not-sent-subject** This option changes the subject of an e-mail | ||
| - | * **mail-not-sent-text** This option changes the text of an e-mail | ||
| - | ----- | + | * **mail-not-sent-subject** This option changes the subject of an e-mail |
| - | ==Escalation== | + | * **mail-not-sent-text** This option changes the text of an e-mail |
| - | E-mails that inform about the [[en:software:tim:escalation | escalation]] of a process are also editable: | + | ---- |
| - | * **escalation-email-subject** : This option changes the subject of an e-mail | + | == Escalation == |
| - | * **escalation-email-message** : This option changes the textual content of an e-mail | + | |
| + | E-mails that inform about the [[:en:software:tim:escalation|]] of a process are also editable: | ||
| - | ----- | + | * **escalation-email-subject** : This option changes the subject of an e-mail |
| + | * **escalation-email-message** : This option changes the textual content of an e-mail | ||
| + | ---- | ||
| - | ==Using variables in the text of e-mails== | + | == Using variables in the text of e-mails == |
| - | Within the e-mail text, system variables can be used. These variables will then be replaced by the respective values. The example below shows this functionality in action. | + | |
| - | <code> | + | Within the e-mail text, system variables can be used. These variables will then be replaced by the respective values. The example below shows this functionality in action.<code> |
| Hello, | Hello, | ||
| please review the documents attached to task ${SYS.TASK_NAME} and verfify their correctness. | please review the documents attached to task ${SYS.TASK_NAME} and verfify their correctness. | ||
| Line 96: | Line 100: | ||
| Thanks you. | Thanks you. | ||
| </code> | </code> | ||
| - | The variables **${SYS.TASK_NAME}** and **${SYS.PROCESSINSTANCE_NAME}** will be replaced in the email text by the task name and the process instance name respectively. For a complete list of available system variables visit the [[faq:variableshelper|variable helper page]]. | + | |
| - | ----- | + | The variables **${SYS.TASK_NAME}** and **${SYS.PROCESSINSTANCE_NAME}** will be replaced in the email text by the task name and the process instance name respectively. For a complete list of available system variables visit the [[:faq:variableshelper|variable helper page]]. |
| + | |||
| + | ---- | ||
| ==== HTML-Taskmails ==== | ==== HTML-Taskmails ==== | ||
| - | [[en:software:tim:tim.properties#Mails|HTML-Taskmails]] can be used to edit the content of an e-mail. For example, pictures can be included and simple links may be embedded within the text. In contrast, this option would not be possible to implement with ordinary Taskmails. To enable this kind of functionality in an HTML-mail, the parameter of the Taskmail text has to start with the following value: | + | |
| - | <code> | + | [[:en:software:tim:tim.properties#mails|HTML-Taskmails]] can be used to edit the content of an e-mail. For example, pictures can be included and simple links may be embedded within the text. In contrast, this option would not be possible to implement with ordinary Taskmails. To enable this kind of functionality in an HTML-mail, the parameter of the Taskmail text has to start with the following value:<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> | ||
| - | |||
| **For example:** | **For example:** | ||
| - | <code html> | + | |
| + | <code html4strict> | ||
| taskmail-text=<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"></head><body>You have received a new task: ${taskName} <br/> in the process: ${processDefinitionName}. <br/> \nn\nGo directly to the task: <a href="${taskLink}">${taskName}</a></body></html> | taskmail-text=<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"></head><body>You have received a new task: ${taskName} <br/> in the process: ${processDefinitionName}. <br/> \nn\nGo directly to the task: <a href="${taskLink}">${taskName}</a></body></html> | ||
| </code> | </code> | ||
| - | + | ---- | |
| - | ----- | + | |
| ==== Differences between Taskmails with each definition and node (starting with version v4.0) ==== | ==== Differences between Taskmails with each definition and node (starting with version v4.0) ==== | ||
| - | An individualized subject heading and text for each e-mail can be implemented with each definition and/or node. | ||
| - | The corresponding entry in the file tim.properties would then look like this: \\ | ||
| - | taskmail-text-processdefinitionsname-nodename-with-spacecharacter=The text in the mail is referring to a specific node within a certain process | ||
| - | taskmail-subject-processdefinitionsname-nodename-with-spacecharacter=You have been assigned the task ${SYS.TASK_NAME} within the process ${SYS.PROCESSINSTANCE_NAME} | ||
| - | If possible, an individual text will be assigned to a specific node for each taskmail. If this is not possible, a search for a related e-mail message will be conducted for the process definition. Finally, if this text is also not available, then the standardized text will be used. \\ | + | An individualized subject heading and text for each e-mail can be implemented with each definition and/or node. The corresponding entry in the file tim.properties would then look like this: |
| - | The following is an example of an individualized e-mail text for each process definition: \\ | + | |
| - | taskmail-text-processdefinitionname-with-spacecharacter=This is the text for the task of the process definition ${SYS.PROCESSDEFINITION_NAME} | + | <code> |
| - | taskmail-subject-processdefinitionname-with-spacecharacter=The task ${SYS.TASK_NAME} in the process ${SYS.PROCESSINSTANCE_NAME} has been assigned | + | taskmail-text-processdefinitionsname-nodename-with-spacecharacter=The text in the mail is referring to a specific node within a certain process |
| + | taskmail-subject-processdefinitionsname-nodename-with-spacecharacter=You have been assigned the task ${SYS.TASK_NAME} within the process ${SYS.PROCESSINSTANCE_NAME} | ||
| + | </code> | ||
| + | |||
| + | If possible, an individual text will be assigned to a specific node for each taskmail. If this is not possible, a search for a related e-mail message will be conducted for the process definition. Finally, if this text is also not available, then the standardized text will be used. The following is an example of an individualized e-mail text for each process definition: | ||
| + | |||
| + | <code> | ||
| + | taskmail-text-processdefinitionname-with-spacecharacter=This is the text for the task of the process definition ${SYS.PROCESSDEFINITION_NAME} | ||
| + | taskmail-subject-processdefinitionname-with-spacecharacter=The task ${SYS.TASK_NAME} in the process ${SYS.PROCESSINSTANCE_NAME} has been assigned | ||
| + | </code> | ||
| <note important>Names of process definitions and nodes have to be written in small **letters**! Spaces and special characters are notated by using **-**! </note> | <note important>Names of process definitions and nodes have to be written in small **letters**! Spaces and special characters are notated by using **-**! </note> | ||
| - | ----- | + | |
| + | ---- | ||
| ==== Multilingual mails ==== | ==== Multilingual mails ==== | ||
| - | Depending the language of the logged in user, the mails can have different languages. The location/language is deoted by a prefix: \\ | ||
| - | de-taskmail-subject-processdefinitionsname-nodename = Here is a german subject | ||
| - | de-taskmail-text-processdefinitionsname-nodename = Here is a german text | ||
| - | en-taskmail-subject-processdefinitionsname-nodename = This an english subject | + | Depending the language of the logged in user, the mails can have different languages. The location/language is deoted by a prefix: |
| - | en-taskmail-text-processdefinitionsname-nodename = This is the english mailtext | + | |
| - | <note important>If there are multiple languages in the [[en:software:tim:processrepository|process repository]], then the definitionname and nodename must be taken from the default language </note> | + | <code> |
| - | ----- | + | taskmail-subject-de-processdefinitionsname-nodename = Here is a german subject |
| + | taskmail-text-de-processdefinitionsname-nodename = Here is a german text | ||
| + | </code> | ||
| + | |||
| + | <code> | ||
| + | taskmail-subject-en-processdefinitionsname-nodename = This an english subject | ||
| + | taskmail-text-en-processdefinitionsname-nodename = This is the english mailtext | ||
| + | </code> | ||
| + | |||
| + | <note important>If there are multiple languages in the [[:en:software:tim:processrepository|process repository]], then the definitionname and nodename must be taken from the default language </note> | ||
| + | |||
| + | ---- | ||
| ==== Enabling and disabling taskmails ==== | ==== Enabling and disabling taskmails ==== | ||
| - | To enable the functionality of [[en:software:tim:taskmail|taskmails]] for individual users, the option **"Prefer to receive messages by e-mail"** can be activated in the [[en:software:tim:userprofil_profile| user profile]]. This setting is also available to users within the entire system by accessing the [[en:software:tim:client_profile|client profile]]. | ||
| - | ====Error mails==== | + | To enable the functionality of [[:en:software:tim:taskmail|taskmails]] for individual users, the option **"Prefer to receive messages by e-mail"** can be activated in the [[:en:software:tim:userprofil_profile|user profile]]. This setting is also available to users within the entire system by accessing the [[:en:software:tim:client_profile|client profile]]. |
| - | If an error occurs while sending a mail and the "send message in case of failure" is selected within the Client Profile, then a mail will be sent to the selected group. The mail has the following form:\\ | + | |
| - | mail-not-sent-subject=Mail not sent Id: ${MAIL.ID} Subject: ${MAIL.SUBJECT} | + | ==== Error mails ==== |
| - | mail-not-sent-text=The following errors occurred during sending.\n\n | + | |
| + | If an error occurs while sending a mail and the "send message in case of failure" is selected within the Client Profile, then a mail will be sent to the selected group. The mail has the following form:<code> | ||
| + | mail-not-sent-subject=Mail not sent Id: ${MAIL.ID} Subject: ${MAIL.SUBJECT} | ||
| + | mail-not-sent-text=The following errors occurred during sending.\n\n | ||
| + | </code> | ||
| Additionally, the exception that occurred will be attached to the mail text | Additionally, the exception that occurred will be attached to the mail text | ||
| + | |||
en/software/tim/mail_configuration.txt · Last modified: 2021/07/01 09:52 (external edit)
Except where otherwise noted, content on this wiki is licensed under the following license: 2013 T!M Solutions GmbH
