Application management : Alerts : Alerts - Field Descriptions : Notification definition fields
Notification definition fields
Field
Description
Code
Enter a code number for the notification definition.
Description
Specify a meaningful name for the notification definition.
Alert condition
Click the Select a value button to open the Alert condition dialog box. In this dialog box, click Add to select the business object for which you are creating a definition.
Specify a code and the filter, and provide a filter name.
For details on creating filters, refer to
Using filters (Fundamentals).
Use reference date
When set to Yes, the reference date (= current date) is taken into account when using a mail merge report or recipient report.
For life cycle aware business objects (contracts, rentable units etc.) the reference date should always be taken into account for mail merge reports and recipient reports.
For life cycle aware business objects, the alert condition also takes the reference date into account.
The value of this field is not used when executing an alert condition.
For other reference data aware business objects, the reference date is never used when the alert condition is applied.
This setting can be used in following situation:
When creating a notification on a business object that is not life cycle aware (for example contract actions) and this notification has a mail merge report in which fields of a lifecycle aware business object are added (for example contract.name).
Attachment mail template
Click the Select a value button to open the Mail template dialog box. Select a mail merge template and click OK. This template is used for the attachment that is sent with an email.
* 
The mail merge templates in .doc/.docx format are only supported as an attachment.
Send attachment as PDF
Select Yes to send the mail merge report as a PDF attachment. This field is only enabled when the Attachment mail template field has a value. By default No is selected and the report is sent as .doc/.docx attachment.
Mail template
Click the Select a value button to open the Mail template dialog box. Select a mail merge template and click OK. This template will be the e-mail message's body.
Sender’s email address
Click the Select a value button to open the Sender's email address dialog box. Specify the e-mail address to be used as sender and reply address when sending a notification mail.
This will allow customers to have mail sent from a specific address.
If the sender’s email address is not specified, the Sender's email address from System Settings is used.
Reply email address
Click the Select a value button to open the Reply email address dialog box. Specify the e-mail address to be used as reply address when sending a notification mail.
If the Reply email address is not specified, the Reply email address from System Settings is used.
Recipients report
Click the Select a value button to open the Recipients report dialog box. Select a report in order to run it against the condition. When processed by the scheduler, this will result in a list of recipients to be notified via email.
* 
The alert condition and the recipient report should both be created on the same business object.
* 
For more information, refer to Emailing notifications via a recipients report.
Schedule
Click the Select a value button to open the Schedule dialog box. Enter the frequency and the pattern for sending notifications.
You can select: Minutes, Hourly, Weekly, Monthly or Calendar.
If you select Weekly, you can specify a the schedule time per day - select the day's check box and choose a time from the list.
• The list only shows whole hours and you must use the list (cannot type in the field).
• Click the plus icon to add additional schedule times.
• The order of scheduled times is not important, the application will sort them in the correct order.
• You can schedule a maximum of 5 times per day.
• Click the bin icon to remove a schedule time. Only the last schedule time will have a bin icon.
• If no time is specified, the schedule will be based on the start date-time of the alert/notification.
Schedule dialog box
* 
Select Calendar if you want to send the notification on specific dates. You can select the required dates by clicking them in the calendar while holding down the CTRL key.
Start date-time
Specify the start date and time for checking the notification condition. The date-time specified is time-zone-aware, which means that the start date-time is based on the time zone of the user who created the notification definition.
Example
The start date-time (Monday, July 27, 2009 12:00 PM) is based on the user’s time zone (GMT +01). The schedule will start at 6:00 locally because the server is based in Boston, US (EST) and there is a 6 hour time zone offset.
The initial start date-time is used to calculate the next start date-time.
Last result
Displays the definition’s current status, which is either OK or Failed.
If the scheduler encounters an error when checking a notification / an alarm condition, the Last result field is updated accordingly.
Refer to Supporting data > Log Viewer for a list of all errors encountered by the scheduler.
Next run date
Indicates the next date for the scheduler to check the notification condition. This field is automatically updated so that the user can see when the next check is scheduled.
For more information, refer to Next run date calculation.
Log successful alerts
Click Yes if you want to receive a detailed list of items that meet the condition. This list is published in Supporting data > Log viewer.
The Source column will display the definition’s code.
The User column will display “SCHEDULERENGINEADMIN”.
Log to communication log
Click Yes if you want to log a communication log created for the item being notified on. When you enable this field, fill the Communication log field to identify which communication log must be created. This logging can be used only for business objects which are communication log aware.
The following fields of the communication log will be populated by default:
BeginDate: Time of alerting.
Code: Alert definition code.
Name: Alert definition description.
Comment: Will be extended with a list (comma separated values) of the user codes or email addresses of the people that are alerted.
Communication log
Select the communication log type used for the notification logging.
Click the Select a value button to open the Communication log dialog box. Select a business object and click OK.
When the Log to Communication log is set to Yes, an instance of the communication log type is created. In Field Definer you can create user types for communication logs (for example: telephone call, email and so on).
Store mail attachment?
Select Yes if you want to store the attachment of an email in a communication log. This field is only available if Yes is selected in the Log to communication log field.
After you have sent the email, a communication log record is created and the attachment is stored at the secure document location. The name of the attachment is displayed in the Document (secure) field at Order details > Communication logs - Order.
User running the alert
Specify the user whose account will be used to run the alert definition. By default, this field will be populated with the name of the user who created the alert definition.
We recommend that all alert definitions are run by a special user/account and not the personal account of a Planon administrator. See also Run account.
Report
Select the report defined on the business object for which you are creating a notification definition.