Email Notifications

To customize the content of the email notifications like the new task email or the daily task summary, you have to implement processes with a predefined process start signature.

Mail notifications require a configured mail server and enabled notification settings as described in Email.

Implementation

To customize an email notification you need to do the following:

  1. Implement a process with a predefined process start signature in an Ivy project. See the following subchapters for more information.

  2. Deploy the Axon Ivy project with the customized standard processes in the application.

  3. Optional: If you have multiple projects which provide the default pages you may need to fix the provider in file ivy.yaml.

1# ivy.yaml located in e.g. <configuration>/ivy.yaml
2# By default the Axon Ivy Engine auto detects the mail processes. If you have multiple mail processes
3# provider you may need to fix the provider here by defining the library id.
4# The library id is <group-id>:<project-id> from the ivy project deployment definition.
5SecuritySystems:
6  default:
7    EMailNotification:
8      StandardProcess: ch.ivyteam.ivy.project.portal:portalTemplate

Notifications

The following email notifications can be customized:

Email Notification

Process Start Signature

New Task page with the new assigned task. This is done everytime a new task is created, an existing task expires or the creator of an existing tasks changes. These events affect the user directly, via his role or his substitution.

MailNotification_NewTask(Number notificationTaskId, String notificationSecurityMemberId)

Daily Task Summary page with all open tasks for the user. This notification is executed once a day for each user.

MailNotification_DailyTaskSummary(String notificationSecurityMemberId)
../../../_images/standard-process-new-task.png

New Task Mail

Hints

Subject

The <title> HTML tag is re-used as the email subject

Images

In the HTML, images can be referred to either from the CMS or the file system. These resources will be embedded as MIME parts. External images will not be embedded and the links will not be modified at all.

Skip

You can modify the standard mail sending behavior using custom conditions (e.g. do not send emails to technical users). To do so, implement an alternative process flow without displaying any User Dialog or HTML Page activity.

API

Some hints on APIs to implement email notification processes:

  • get the user with ivy.security().members().findById(notificationSecurityMemberId)

  • get the task with ivy.wf.findTask(notificationTaskId)

  • get the list of tasks that a user can work on with ivy.wf.findWorkTasks(...)