Alarm definition fields
Field | Description | ||
|---|---|---|---|
Code | Enter a code number for the alarm definition. | ||
Description | Specify a meaningful name for the alarm 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). | ||
| |||
Icon | Select an icon to represent the alarm status. For convenience, users can filter on icons to get a list of high priority items or a list of items of the same type (e.g. all hard-hat items representing orders). | ||
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 lifecycle aware BOs (contracts, rentable units etc..) the reference date should always be taken into account for mail merge reports and recipient reports. For life cycle business object, 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). | ||
Recipients report | Specify the recipient report in order to run it against the condition. When processed by the scheduler, this will result in a list of recipients to be alerted via My alarms. The alert condition and the recipient report should both be created for the same business object.
| ||
Use recipient related filtering | When the recipient report condition is met, alarm status records are created in the application. When this field is set to No, the specified TSI selection step will only display records that meet the filter condition. When this field is set to Yes, the specified TSI selection step will display records that meet the filter condition AND the recipient report condition.
See also: Use recipient related filtering. | ||
TSI selection step | Specify the TSI step to which the user should be directed to view all instances that meet the alarm condition. The TSI step you specify here is linked to the Show results action on the My alarms step. Preconditions You must select a step that is available for the business object to which the alarm condition applies. To ensure the Show results action works as intended, you must link to a TSI that is available in the user’s/users’ Navigation Panel . You can only link to a TSI that is accessible via direct navigation and does not require descending via a specific drill-down path. As a workaround, you can configure a Solution Extension to support this navigation feature, but this only provides a read-only view of alarms. | ||
Priority | Indicate a priority for the alarm at hand; this enables users to filter on priority and decide which action should be taken first. The priority may be any number in the range of 1 to 1000. | ||
Check at login | Indicate whether the alarm condition is to be checked when the user logs on to Planon ProCenter . If the alarm goes off, the user will be directed to the My Alarms selection step. | ||
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. 
| ||
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 alarm 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. For more information, refer to Next run date calculation. | ||
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 run date for the scheduler to check the alarm 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 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 | In this field, you need to select which communication log type must be created for alarm logging. Click the Select a value button to open the Communication log dialog box. In 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). | ||
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.
|
