...
This feature enables sending customizable email notifications for group and user tasks.
Emails are triggered based on user settings or tenant profile configurations.
This feature enhances the task notification system by providing flexible and customizable email notifications, ensuring that all stakeholders are informed and can access their tasks efficiently. The support for variables, HTML content, and direct task deep links further improves the usability.
...
Activate task
...
mails
The ‘Send e-mail if new task was assigned’ button can be enabled on the ‘Tenant’ page (only by admin user).
The option to "Send email if a new task is assigned" should be activated by default on the 'Tenant' page for all users. If a user chooses to override this setting in their profile by unchecking the checkbox, they will not receive any task-related emails.
...
The success pop-up message is displayed after the changes were saved successfully.
...
User task mails
If a task gets assigned, a new mail is created for the assigned user if he/she has activated the checkbox “send e-mail if new task was assigned”.
User The user task mail is successfully then displayed on in the outbound email list section and is only sent to the assigned user.:
...
...
Group task
...
The ‘Notify by group mail’ button on the 'Tenant' page should be enabled.
If true, only one mail is sent to this group email address.
If false, all group members get an email.
...
mails
If a task is assigned to a group, all members of this group which have activated the checkbox “send e-mail if new task was assigned” will get an email. Those emails are displayed on the outbound email list section.too:
...
To check if the mail was sent to all the roles that were assigned to members of the group, you can check the group information modal which you can access via the group list.
...
Notify by group mail - for e-mail distribution lists
The ‘Notify by group mail’ button on the 'Tenant' page can be enabled so that only one e-mail is sent out to the defined group email-address.
If true and the specific group has set an e-mail address: only one mail is sent to this group email address.
If false or the specific group has set no e-mail address: all group members get an email.
...
Customizing task mail subject and text
They The task mails can be customized for each task, process and language (also the hierachy) in the
The following are the tim.properties they show how this can be used to customize the text of the receiving mail once the task is assigned (Groupmail or Task mail)achieved for group or task mails.
If you want to define a general subject and text for all languages, please use:
group-taskmail-subject
...
and
taskmail-subjectandgroup-taskmail-textandtaskmail-textIf you want to define a subject and text for a specific language (en) which overrides the general one (1.), please use:
group-taskmail-subject-en
...
and
taskmail-subject-en
...
and
group-taskmail-
...
text-enandtaskmail-text-en
...
If you want to define a subject and text for a specific language (en) and a specific process (Onboarding) which overrides the one from 2., please use:
group-taskmail-
...
subject-en-Onboardingandtaskmail-subject-en-
...
Onboardingandgroup-taskmail-text-en
...
-Onboardingandtaskmail-text-en-OnboardingIf you want to define a subject and text for a specific language and a specific process and a specific node/task (Prepare file) which overrides the one from 3., please use:
group-taskmail-subject-en
...
-prepare-fileandtaskmail-subject-en
...
-prepare-fileandgroup-taskmail-text-en-
...
prepare-fileandtaskmail-text-en
...
Hierarchy
...
-prepare-file
| Info |
|---|
All spaces or special characters have to be replaced by “-”. All other characters have to be written in lower case. Example: Task name “Prepare file” becomes “prepare-file” |
Hierarchy
For custom group task mails
| Info |
|---|
group-taskmail-subject
|
User For custom user task mailmails
| Info |
|---|
taskmail-subject
|
Use case: Different text on two level using two mail text properties We want to send out a different mail for a specific process “Onboarding” and another mail for a specific task “Account setup” within this process. Let us define in tim.properties two properties. In activity level “account setup“ it is configured to receive text ‘Hello User’ as soon as :
In the first two rows, we configure to send ‘Hello User’ as subject and ‘This is the body text…’ as text if the task is assigned to the a group. In
The third and fourth row define that in all other activities tasks, the mail text subject must be “Hello 'Hello User - level Process Definition”
EN version
...
DE version
...
| Info |
|---|
For the German version please make sure to set the tenant language to DE before the assignment. |
...
Definition' and the text ‘This is the body text - level Process definition…’ for group task mails.
| Code Block |
|---|
group-taskmail-subject-en-onboarding-account-setup=Hello User
group-taskmail-text-en-onboarding-account-setup=This is the body text...
group-taskmail-subject-en-onboarding=Hello User - level Process definition
group-taskmail-text-en-onboarding=This is the body text - level Process definition
#lets define german as well
group-taskmail-subject-de-onboarding-account-setup=Hallo Benutzer
group-taskmail-text-de-onboarding-account-setup=Dies ist der Fließtext...
group-taskmail-subject-de-onboarding=Hallo Benutzer - Prozessdefinition auf Ebene
group-taskmail-text-de-onboarding=Dies ist der Fließtext - Prozessdefinition der Ebene... |
The first 4 rows were for English (en) and rows 7-10 are for users which have selected German as their language (de).
After uploading tim.properties inside the resources folder using the adequate privileges. Then when you assign task “Fill Employee Information“ to the group
...
The email containing the text ‘Hello User- level Process definition’ are sent successfully.
EN version
...
DE version for users who have selected German as their language
...
But when assigning the ‘Account Setup’ task to the group the email with the text “Hello User” is displayedsent
...
EN version
...
DE version
...
...
Including variables from
...
forms
Use case: Different text on two level using two mail text properties. Let us define in tim.properties two properties. In activity level “account setup“ it is configured to receive text ‘Hello ${user}’ as soon as the task is assigned. In all other activities the mail text must be “Hello User - level Process Definition”
...
If you have a variable, you can include it like this…
...
The email containing the text ‘Hello and the username(ex.Arlinda) We want to extend the use case from above so that the mail subject will contain variables from the form. In this case, we want to add the first name of the new employee to the task mail subject of “Account setup”. This can be achieved by changing the tim.properties in row 1:
| Code Block |
|---|
group-taskmail-subject-en-onboarding-account-setup=Hello ${first-name} |
Variables can be easily included it like this. You can find out the variable name e.g. in Form Designer.
...
After uploading the new tim.properties and reassigning the task, the email with the subject 'Hello Arlinda' is sent successfully.
...
HTML
Use case: Different text on two level using two mail text properties. We can define mail text via tim.properties or via workflow design properties for a specific node.
Let us define in tim.properties two properties. the property taskmail-text.
| Code Block |
|---|
taskmail-text=<html><head> <style> body {font-family: Arial, sans-serif; color: #323232; background-color: f1f7f7; }table { width: 480px; margin: 16px auto; border-collapse: collapse; } th, td { padding:7px; border: 1px solid #ddd; text-align: left; vertical-align: top; } th { background-color: f1f7f7; font-weight: bold; font-size: 15px; line-height: 20px; } a { text-decoration: none; background-color: #04AA6D; color: white !important; padding:15px; display: inline-block; border-radius: 4px; } </style> </head><body> <table><thead><tr><th colspan="2">Company: ${SYS.CURRENT_USER_COMPANY} </th> </tr> </thead> <tbody> <tr> <th>ID</th> <td>${SYS.TASK_ID}</td> </tr> <tr> <th>TASK NAME</th> <td>${SYS.TASK_NAME}</td> </tr> <tr><th>Date of Assignment</th> <td>${SYS.NOW}</td> </tr> <tr> <th>Priority</th> <td>High</td> </tr> <tr> <th>Workflow</th <td>${SYS.PROCESSDEFINITION_NAME}</td> </tr> </tbody></table> <p style="text-align: center;"> <a href="${SYS.TASKLINK}" target="_blank">Go to Task</a> </p></body></html> |
In activity level it is configured to receive text the HTML content. as soon as the task is assigned.
Code example: how the HTML mail is structured can be seen below.
...
After successfully uploading tim.properties to the resources folder with the appropriate privileges, you can proceed to assign tasks to either groups or individual users.
...
After uploading the tim.properties file into the resources folder with the necessary privileges, proceed to assign tasks to the appropriate users or groups.
...
| Code Block |
|---|
<html>
<head>
<style>
body {
font-family: Arial, sans-serif;
color: #323232;
background-color: #f1f7f7;
}
table {
width: 480px;
margin: 16px auto;
border-collapse: collapse;
}
th, td {
padding: 7px;
border: 1px solid #ddd;
text-align: left;
vertical-align: top;
}
th {
background-color: #f1f7f7;
font-weight: bold;
font-size: 15px;
line-height: 20px;
}
a {
text-decoration: none;
background-color: #04AA6D;
color: white !important;
padding: 15px;
display: inline-block;
border-radius: 4px;
}
</style>
</head>
<body>
<table>
<thead>
<tr>
<th colspan="2">Company: ${SYS.CURRENT_USER_COMPANY}</th>
</tr>
</thead>
<tbody>
<tr>
<th>ID</th>
<td>${SYS.TASK_ID}</td>
</tr>
<tr>
<th>TASK NAME</th>
<td>${SYS.TASK_NAME}</td>
</tr>
<tr>
<th>Date of Assignment</th>
<td>${SYS.NOW}</td>
</tr>
<tr>
<th>Priority</th>
<td>High</td>
</tr>
<tr>
<th>Workflow</th>
<td>${SYS.PROCESSDEFINITION_NAME}</td>
</tr>
</tbody>
</table>
<p style="text-align: center;">
<a href="${SYS.TASKLINK}" target="_blank">Go to Task</a>
</p>
</body>
</html> |
The HTML can also be configured via properties on the workflow for a specific node, on the task mail text field.
...
After uploading the file on Resources → admin or configuring the HTML via properties, the task can now be assigned.
...
After the mail is send to user email, it receives a nice looking email as we have provided in the HTML template
...
The HTML email received
...
...
If you click on “Go to Task” button, the link will redirect to the task.
...