Email Notifications
Introduction
Notifications send emails messages automatically when there is something notable in the processes. When creating notifications, criteria for sending is defined. Notifications set defined for models, and each model can have several notifications.
Creating notifications
Notifications are edited in Email notifications dialog that can be opened in the models list by first selecting Notifications. Defining notifications requires at least project Designer or Administrator permissions (GenericWrite permission).
Notifications have following settings:
- Name: Describing name for the notification identifying the notification in the list of model's notifications.
- To, Cc, Bcc: To, cc and bcc recipients for the email message. At least one valid email address needs to be defined in any of these fields.
- Subject: Subject of the email message.
- Body: Body of the email message. The body can be defined as an html document, if Body is html is checked.
- Model filter: Model data is filtered using this filter, before the data is used for the notification calculation.
- Measures:
- Criteria:
- Body is html: When checked, the email body is an html document. If unchecked, the email body is plaintext.
- Priority: Priority of the email message: High, Normal or Low.
- From email address: Email address where the notification appears to be coming from. If there is a default from address defined for the system, this field can be left empty.
- Sender:
- Reply to address:
- Dimensions:
In the fields defining the email message (e.g. To, Cc, Bcc, Subject, Body) it's possible to define measure and dimensions names using syntax ${name}. It's also possible to define any expressions inside the curly brackets. Examples:
Email subject:
Process is blocked for total of ${numberOfCases} orders
Process is blocked for total of ${Count(EventLog.Cases)} orders
Sending notifications
Notifications can be sent either manually in the Email notifications dialog or by using the Model.TriggerNotifications function.
Notifications can be triggered using a script as follows:
(SELECT 'AnalysisType', '33') UNION ALL
(SELECT 'ContextType', 'Generic') UNION ALL
(SELECT 'Configuration', '{"Root":"ModelById(123).TriggerNotifications([""Notification 1"", ""Notification 2""])"}')
--#GetAnalysis