|
<< Click to Display Table of Contents >> RayFlow > 7.4 u1 > User and Administration Guide > Configuration > Basic > Plugin Configuration > Advanced Notification Plugin Notification Settings |
The NotificationSettings property contains an array of objects. Each of this objects is a notification filter that specifies under which conditions an email notification should be sent, as well as the recipients and the content of the mail. These are defined in the config.file. The config.file needs to be created manually.
The following properties exist and can be used in the config.file:
Property |
Type |
Mandatory |
Description |
|---|---|---|---|
Name |
String |
Yes |
This property is used for dignostic purposes only and does not affect the behavior of the filter. |
Active |
Boolean |
Yes |
Determines whether the filter is currently active. If set to false, the filter will not be applied and no email notifications will be sent. |
TemplatePath |
String |
Yes |
The path to the HTML template that will be used to create the email notification. This property can be an absolute path or a relative path to the location of the plugin DLL file. |
PhaseFilter |
Array of Strings |
No |
An array of phase names for which the filter should be applied. If empty, the filter will be applied for all phases. |
StatusFilter |
Array of Strings |
No |
An array of status names for which the filter should be applied. If empty, the filter will be applied for all status. |
Triggers |
Array of Strings |
Yes |
An array of event types that should trigger the filter. Supported event types are Status, User, File, Datafield, and Comment. At least one trigger type must be specified. |
Subject |
String |
Yes |
The subject of the notification. |
Recipients |
Array of Strings |
No |
An array of email addresses, group names, or user names to whom the email notification will be sent. If this property is not set, the DatafieldTarget property must be provided. |
DatafieldTarget |
GUID |
No |
The ID of the datafield that contains the email addresses, group names, or user names to whom the email notification should be sent. This property needs to be provided if the Recipients property is not set. |
Attachments |
Object |
No |
An object that specifies the properties of the file attachments to be included in the email notification. |
FileNameRegex |
String |
No |
A regular expression that filters the files to be attached based on their names. If this property is not set, all files will be attached. |
Limit |
Integer |
No |
The maximum number of files to be attached. If this property is not specified, all matching files will be attached. |