Visual KPI alert notifications are sent to contact emails when any of your KPIs need attention. Here you’ll find settings for creating contacts and setting up alert templates.
These site settings apply to your entire site and make the contacts and alert templates you configure here available as you set up alerts for individual KPIs. You’ll find Contacts & Alerts under the Site Settings icon () in the Document Actions panel.
Contacts
| Attribute | Description |
|---|---|
| Name | The name of the Contact that appears in Designer drop-down menus. This name will not be displayed to site users. |
| Description | The description of the Contact, for use by Designer admins only and will not appear to site users. |
| Contact Name | A semicolon (;) delimited list of Contact names (can be a person or group) that appears on the site. The list of names, emails, and telephone numbers should correspond with each other. Pair with an interface to display a dynamic value. |
| Contact Name Interface | The interface used to retrieve the 'Contact Name', then the Contact Name field is treated as a constant value. |
| Contact Email | A semicolon (;) delimited list of Contact email addresses that will appear on the site. The list of names, emails, and telephone numbers should correspond with each other. Pair this with an interface to display a dynamic value. |
| Contact Email Interface | The interface used to retrieve the 'Contact Email' value. If this field is blank, the Contact Email field is treated as a constant value. |
| Contact Phone | A semicolon (;) delimited list of Contact telephone numbers that will appear on the site. The list of names, emails, and telephone numbers should correspond with each other. Pair this with an interface to display a dynamic value. |
| Contact Phone Interface | The interface used to retrieve the 'Contact Phone' value. If this field is blank, the Contact Phone field is treated as a constant value. |
| Reference Count | The number of times the Contact is used (read-only). |
| Contact ID | Read-only system level identifier. |
Alert Templates
| Attribute | Description |
|---|---|
| Name | The name of the Alert Template that appears in Designer drop-down menus. This name will not be displayed to site users. |
| Description | The description of the Alert Template, for use by Designer admins only and will not appear to site users. |
| Alert Reminder Interval (Minutes) | The wait time, in minutes, until reminders will be resent (0=never remind). |
| Time In State (Minutes; 0 is off)",The number of minutes that a KPI must remain in a state before any notifications will be sent. | |
| Minimum Alert Silence Duration (Minutes) | The minimum wait time, in minutes, until normal alerts are resumed. |
| Alert Silence | A boolean value used to turn the Alert Silence feature ON or OFF. If silenced, no notifications will be sent. Pair this with an interface to display a dynamic value. |
| Alert Silence Interface | The interface used to retrieve the 'In Alert Silence' value. If this field is blank, the Alert Silence field is treated as a constant value. |
| Send First KPI Alert When Silenced | Controls whether a notification is sent after the KPI alerting is silenced. |
| Alert Silence Contact | The contact notified when a KPI alert becomes silenced. This is not a standard Alert notification, but rather an informative message stating the KPI has been silenced. |
| Alert When Low Low Low | Controls whether or not a KPI with this status will trigger a notification. |
| Remind When Low Low Low | Controls whether or not a KPI with this status will trigger an Alert Reminder notification. The 'Alert Reminder Interval' must be greater than 0. |
| Notify Contact When Low Low Low | Controls whether or not the KPI Contact is notified once the KPI enters (or stays within) Time in State. |
| Notify Alt Contact 1 When Low Low Low | Controls whether or not the KPI Alt Contact 1 is notified once the KPI enter (or stays within) Time in State. Alt Contacts can be used as escalation contacts (supervisors, etc.) for severe Status. |
| Notify Alt Contact 2 When Low Low Low | Controls whether or not the KPI Alt Contact 2 is notified once the KPI enter (or stays within) Time in State. Alt Contacts can be used as escalation contacts (supervisors, etc.) for severe Status. |
| Alert When Low Low | Controls whether or not a KPI with this status will trigger a notification. |
| Remind When Low Low | Controls whether or not a KPI with this status will trigger an Alert Reminder notification. The 'Alert Reminder Interval' must be greater than 0. |
| Notify Contact When Low Low | Controls whether or not the KPI Contact is notified once the KPI enters (or stays within) Time in State. |
| Notify Alt Contact 1 When Low Low | Controls whether or not the KPI Alt Contact 1 is notified once the KPI enter (or stays within) Time in State. Alt Contacts can be used as escalation contacts (supervisors, etc.) for severe Status. |
| Notify Alt Contact 2 When Low Low | Controls whether or not the KPI Alt Contact 2 is notified once the KPI enter (or stays within) Time in State. Alt Contacts can be used as escalation contacts (supervisors, etc.) for severe Status. |
| Alert When Low | Controls whether or not a KPI with this status will trigger a notification. |
| Remind When Low | Controls whether or not a KPI with this status will trigger an Alert Reminder notification. The 'Alert Reminder Interval' must be greater than 0. |
| Notify Contact When Low | Controls whether or not the KPI Contact is notified once the KPI enters (or stays within) Time in State. |
| Notify Alt Contact 1 When Low | Controls whether or not the KPI Alt Contact 1 is notified once the KPI enter (or stays within) Time in State. Alt Contacts can be used as escalation contacts (supervisors, etc.) for severe Status. |
| Notify Alt Contact 2 When Low | Controls whether or not the KPI Alt Contact 2 is notified once the KPI enter (or stays within) Time in State. Alt Contacts can be used as escalation contacts (supervisors, etc.) for severe Status. |
| Alert When Good | Controls whether or not a KPI with this status will trigger a notification. |
| Remind When Good | Controls whether or not a KPI with this status will trigger an Alert Reminder notification. The 'Alert Reminder Interval' must be greater than 0. |
| Notify Contact When Good | Controls whether or not the KPI Contact is notified once the KPI enters (or stays within) Time in State. |
| Notify Alt Contact 1 When Good | Controls whether or not the KPI Alt Contact 1 is notified once the KPI enter (or stays within) Time in State. Alt Contacts can be used as escalation contacts (supervisors, etc.) for severe Status. |
| Notify Alt Contact 2 When Good | Controls whether or not the KPI Alt Contact 2 is notified once the KPI enter (or stays within) Time in State. Alt Contacts can be used as escalation contacts (supervisors, etc.) for severe Status. |
| Alert When High | Controls whether or not a KPI with this status will trigger a notification. |
| Remind When High | Controls whether or not a KPI with this status will trigger an Alert Reminder notification. The 'Alert Reminder Interval' must be greater than 0. |
| Notify Contact When High | Controls whether or not the KPI Contact is notified once the KPI enters (or stays within) Time in State. |
| Notify Alt Contact 1 When High | Controls whether or not the KPI Alt Contact 1 is notified once the KPI enter (or stays within) Time in State. Alt Contacts can be used as escalation contacts (supervisors, etc.) for severe Status. |
| Notify Alt Contact 2 When High | Controls whether or not the KPI Alt Contact 2 is notified once the KPI enter (or stays within) Time in State. Alt Contacts can be used as escalation contacts (supervisors, etc.) for severe Status. |
| Alert When High High | Controls whether or not a KPI with this status will trigger a notification. |
| Remind When High High | Controls whether or not a KPI with this status will trigger an Alert Reminder notification. The 'Alert Reminder Interval' must be greater than 0. |
| Notify Contact When High High | Controls whether or not the KPI Contact is notified once the KPI enters (or stays within) Time in State. |
| Notify Alt Contact 1 When High High | Controls whether or not the KPI Alt Contact 1 is notified once the KPI enter (or stays within) Time in State. Alt Contacts can be used as escalation contacts (supervisors, etc.) for severe Status. |
| Notify Alt Contact 2 When High High | Controls whether or not the KPI Alt Contact 2 is notified once the KPI enter (or stays within) Time in State. Alt Contacts can be used as escalation contacts (supervisors, etc.) for severe Status. |
| Alert When High High High | Controls whether or not a KPI with this status will trigger a notification. |
| Remind When High High High | Controls whether or not a KPI with this status will trigger an Alert Reminder notification. The 'Alert Reminder Interval' must be greater than 0. |
| Notify Contact When High High High | Controls whether or not the KPI Contact is notified once the KPI enters (or stays within) Time in State. |
| Notify Alt Contact 1 When High High High | Controls whether or not the KPI Alt Contact 1 is notified once the KPI enter (or stays within) Time in State. Alt Contacts can be used as escalation contacts (supervisors, etc.) for severe Status. |
| Notify Alt Contact 2 When High High High | Controls whether or not the KPI Alt Contact 2 is notified once the KPI enter (or stays within) Time in State. Alt Contacts can be used as escalation contacts (supervisors, etc.) for severe Status. |
| Alert When Out Of Range | Controls whether or not a KPI with this status will trigger a notification. |
| Remind When Out Of Range | Controls whether or not a KPI with this status will trigger an Alert Reminder notification. The 'Alert Reminder Interval' must be greater than 0. |
| Notify Contact When Out Of Range | Controls whether or not the KPI Contact is notified once the KPI enters (or stays within) Time in State. |
| Notify Alt Contact 1 When Out Of Range | Controls whether or not the KPI Alt Contact 1 is notified once the KPI enter (or stays within) Time in State. Alt Contacts can be used as escalation contacts (supervisors, etc.) for severe Status. |
| Notify Alt Contact 2 When Out Of Range | Controls whether or not the KPI Alt Contact 2 is notified once the KPI enter (or stays within) Time in State. Alt Contacts can be used as escalation contacts (supervisors, etc.) for severe Status. |
| Alert When Not In Service | Controls whether or not a KPI with this status will trigger a notification. |
| Remind When Not In Service | Controls whether or not a KPI with this status will trigger an Alert Reminder notification. The 'Alert Reminder Interval' must be greater than 0. |
| Notify Contact When Not In Service | Controls whether or not the KPI Contact is notified once the KPI enters (or stays within) Time in State. |
| Notify Alt Contact 1 When Not In Service | Controls whether or not the KPI Alt Contact 1 is notified once the KPI enter (or stays within) Time in State. Alt Contacts can be used as escalation contacts (supervisors, etc.) for severe Status. |
| Notify Alt Contact 2 When Not In Service | Controls whether or not the KPI Alt Contact 2 is notified once the KPI enter (or stays within) Time in State. Alt Contacts can be used as escalation contacts (supervisors, etc.) for severe Status. |
| Alert When NA | Controls whether or not a KPI with this status will trigger a notification. |
| Remind When NA | Controls whether or not a KPI with this status will trigger an Alert Reminder notification. The 'Alert Reminder Interval' must be greater than 0. |
| Notify Contact When NA | Controls whether or not the KPI Contact is notified once the KPI enters (or stays within) Time in State. |
| Notify Alt Contact 1 When NA | Controls whether or not the KPI Alt Contact 1 is notified once the KPI enter (or stays within) Time in State. Alt Contacts can be used as escalation contacts (supervisors, etc.) for severe Status. |
| Notify Alt Contact 2 When NA | Controls whether or not the KPI Alt Contact 2 is notified once the KPI enter (or stays within) Time in State. Alt Contacts can be used as escalation contacts (supervisors, etc.) for severe Status. |
| Alert When Custom Status (1-10) | Controls whether or not a KPI with this status will trigger a notification. |
| Remind When Custom Status (1-10) | Controls whether or not a KPI with this status will trigger an Alert Reminder notification. The 'Alert Reminder Interval' must be greater than 0. |
| Notify Contact When Custom Status (1-10) | Controls whether or not the KPI Contact is notified once the KPI enters (or stays within) Time in State. |
| Notify Alt Contact 1 When Custom Status (1-10) | Controls whether or not the KPI Alt Contact 1 is notified once the KPI enter (or stays within) Time in State. Alt Contacts can be used as escalation contacts (supervisors, etc.) for severe Status. |
| Notify Alt Contact 2 When Custom Status (1-10) | Controls whether or not the KPI Alt Contact 2 is notified once the KPI enter (or stays within) Time in State. Alt Contacts can be used as escalation contacts (supervisors, etc.) for severe Status. |
| Alert When Transient | Controls whether or not a KPI in a transient state, never settling in an alternate state, will trigger a notification. 'Time in State' must be greater than 0 for this to apply. |
| Remind When Transient | Controls whether or not a KPI in a transient state will trigger an Alert Reminder notification. The 'Alert Reminder Interval' must be greater than 0. |
| Notify Contact When Transient | Controls whether or not the KPI Contact is notified when the KPI becomes transient. |
| Notify Alt Contact 1 When Transient | Controls whether or not the KPI Alt Contact 1 is notified when the KPI becomes transient. Alt Contacts can be used as escalation contacts (supervisors, etc.) for severe Status. |
| Notify Alt Contact 2 When Transient | Controls whether or not the KPI Alt Contact 2 is notified when the KPI becomes transient. Alt Contacts can be used as escalation contacts (supervisors, etc.) for severe Status. |
| Alert When Status Returned To Non-Alertable | Controls whether or not a KPI that was in an alertable state, but is no longer in an alertable state, will trigger a notification. |
| Notify Contact When Status Returned to Non-Alertable | Controls whether or not the KPI Contact is notified when the KPI goes from alertable to non-alertable state. Alt Contacts can be used as escalation contacts (supervisors, etc.) for severe Status. |
| Notify Alt Contact 1 When Status Returned to Non-Alertable | Controls whether or not the KPI Alt Contact 1 is notified when the KPI goes from alertable to non-alertable state. Alt Contacts can be used as escalation contacts (supervisors, etc.) for severe Status. |
| Notify Alt Contact 2 When Status Returned to Non-Alertable | Controls whether or not the KPI Alt Contact 2 is notified when the KPI goes from alertable to non-alertable state. Alt Contacts can be used as escalation contacts (supervisors, etc.) for severe Status. |
| Include History in Alert | Controls whether or not the KPI alert history is included in the notification. |
| Include Limits in Alert | Controls whether or not the KPI limits are included in the notification. |
| Include Source (Tag) in Alert | Controls whether or not the KPI source (tag or index) is included in the notification. |
| Include Attributes in Alert | Controls whether or not the KPI custom attributes are included in the notification. |
| Include Groups in Alert | Controls whether or not the Group(s) the KPI belongs to are included in the notification. |
| Template Enabled | Controls whether or not this Alert Template is enabled. If disabled, no notifications will be sent for KPIs using the template. |
| Reference Count | The number of times this Alert Template has been used (read-only). |
| Alert Template ID | Read-only system level identifier. |
Learn more
Visual KPI Designer Site Settings
Configure Contacts
Sitewide vs Override Settings
Configure Visual KPI Alert Service
Visual KPI Alert Notifications
Configure Alert Templates
Create Alerts