Notifications

PeakTMS allows to automatically send emails for defined events in the business process. The notification allows to define events and conditions triggering emails. You can define receivers directly or dynamic using their role in the process and include all information of the related business object into the emails subject and content. In the administration you can manage all notification templates. Based on the trigger in the templates the system will generate emails and puts them into the queue. Later mails in the queue are sent out by a background job.

Setup mailserver

Read in the documentation of the backgroundscheduler how to set up the email server and define the email sending job.

The notifications list view

The list view provides you with an overview over all currently registered notification templates. You can use the table headers to define filters or to change the column width and order. Pressing the column chooser icon will give the possibility to add additional columns, e.g. about the change history.

Overview registered users

Create / Edit a notification template

Press the create or edit button. In the upcoming edit mask fill the relevant properties

Input mask to define the user role properties

Notification trigger properties

The first part of an email template is the definition under which conditions an automatic email is sent.

Name and trigger attributes of an email template

Name

Name of the email template

Category

Select if the mail is either triggered by a resource, activity or project

Type

Specific type of the business object which triggers the message. The choice is necessary to calculate possible trigger attributes.

Trigger attributes

You can choose several attributes as trigger attributes. Currently, fields of type “BOOLEAN”, “VALUELIST”, “ROOT_VALUELIST”, “TEMPLATE_VALUELIST”, “APPROVE”, “APPROVE_REJECT”, ”STATUS_ENGINE” and “TEXT” can serve as trigger attributes. After choosing the attribute you need to specify the value of the attribute which triggers the message.

Additional condition

Here additional conditions can be declared which need to be matched to trigger an email. It provides the same fields as in trigger attributes. Additionally conditions on assigned resources can be checked, e.g. only send an email if a sample belongs to a particular producer.

Notification reminder properties

The definition of a reminder pattern is optional. The aim of the function is to remind receivers to take actions. Therefore, here you can define an interval in which the message is sent and a criteria for finishing reminding receivers.

Reminder attributes of an email template

Reminder

Once set the check mark the reminder is activated and additional attribute will appear

Reminder interval

specifies the amount of time between sending messages. The units d (days), h (hours) and m (minutes) can be used, e.g. "1d 4h 30m".

Reminder end attribute

Choose an attribute which will hold the condition to stop sending reminders. Here the same attributes as in the attribute trigger are available.

Reminder end value

When this value is satisfied by activity, the system will stop sending reminders. The values depend on the data type of the "Reminder end attribute".

Notification receiver

PeakTMS allows to specify a static list of receivers (e.g. a user group) as well as dynamic calculation based on business process (e.g. the test responsible person).

Receiver attributes of an email template

User group receiver

Specify user groups as static receivers. All users of the group will be notified.

Receiver

Specify specific users as static receivers.

Receiver attribute

This setting is used to calculate receivers dynamically. All attributes of type USER in activities or users can be selected here.

Notification content

PeakTMS allows to include all information of the trigger object and related objects (e.g. assigned resources, projects) into the mail content.

Definition of the email content

Subject

Specify the email subject.

Content

Specify the email content.

Possible variables

Here the system lists all available information as parameters. You can select them here and copy directly into the Subject and Content part. Later when generating mails the system will replace them with the values of the parameters

Integrate links into mails

You can integrate links to the trigger object described in Type in the generated email. Therefore, copy the .URL parameter into subject or content. E.g. {ACTIVITY.CAR.URL} will give a link to a car assigned to the activity, ${ACTIVITY.URL} will provide a link directly to the activity.

info

To include full links it is necessary to properly define the property TMS_BASEURL in the .env file!