Help & DocumentationAlertingAlerting Types of Alert Rules[KPI Alert Rules] Wizard, types, criteria, user subscriptions

[KPI Alert Rules] Wizard, types, criteria, user subscriptions

There are multiple variations of Alert Wizard, the correct one will be chosen for you based on where you begin to create an alert. This article will use the KPI Alert Creation Wizard as an example. The other wizards are very similar in design.

Security requirement:  Power and Regular Users should have a "Create Custom Alert" Privilege assigned to them either directly or via Group Membership.

NOTE: The video below shows the User Interface of Version 4.2 / 5.0/x. The changes made in Version 5.1.x:

  • slight difference of the step ordering
  • an ability to apply an Alert Workflow.

Create new KPI alert rule

Create new KPI alert rule
  1. Admin and Power Users can access the wizard from New > Alert Rule > KPI Alert
  2. All Users can access the wizard via the Metric Viewer > Alert icon > Alert Кules pop-up > [ + New Rule]
Coming from the "New" menu involves choosing the Metric to which the Alert Rule should be applied
Coming from the New menu, requires choice of an existing metric

You can choose one of the following:

  1. Create a New Metric: You are going to be redirected to the Metric Editor. After the Metric is created, a similar set of wizard steps will allow you to create a KPI Alert. Reference articles:
  2. If you choose to use Existing Metric, select it from the drop-down list below.

KPI Alert Wizard

1. Alert Rule Type

Select the Type of rule
  1. Choose which Type of Alert Rule you plan to create:
    • Fixed Value: This will compare the latest measurement value to a specific threshold that you set
    • Prior Value: Compare the latest measurement value to a prior value for the same metric (e.g. value from same time last year)
    • Average of prior values: Compare the latest measurement value to the average of values recorded recently
    • Target Value: Set the Alert based on how the latest measurement time compares with a target value
    • Recent Volatility Levels: Compare the latest measurement value to the standard deviations of the average of values recorded recently
    • Combination of multiple Alerts: a flexible way to customize your criteria

For detailed explanation per each option visit: Alert Comparison options

  1. Public / Private Alert: Choose whether you want to use this Alert Rule individually or other Users can subscribe to it as well.

2. Alert Criteria

This step is going to have different set of Alert criteria options depending on the Alert Rule Type selected in Step 1 (see above).

Select the Alert criteria

The process of setting the Alert criteria is similar to constructing a sentence: you choose  conditions and the values which are going to serve as a reference.

If the data values that should trigger an Alert are fetched in bulk, you might face the issue when the Alert is not triggered for the values it is supposed to. The number of latest values that can trigger an Alert is to be set in the Alert Window parameter within the Measurement Interval used for the Metric. For more information see the Update Measurement Interval Settings article.

3. Content

Select exactly what the Content of Alert will contain

You can customize the defaults for:

  1. Subject: You have an option to provide different Subject line displayed both for email and phone alerts
  2. Alert Text: The text that displays on Viewers and in emails for this Alert
  3. Send with the Alert: You can choose to add Alternative Visualization by selecting it from the drop-down list or attach Nothing
  4. Additional message is optional
  5. The Preview & Test section will display the Content as you change it - you can also trigger a Test Alert to be generated to verify spacing for the alert.

4. Default Notification Method / Alert Workflow

  1. Choose whether you want to add an Alert Workflow. To know more about Managed Alerting, refer to this section of our Help: Managed Alerting
  2. Define the default distribution method and alerting frequency for this Alert. If this Alert Rule is public and other users will be subscribing to it, they can choose their preferred delivery method and frequency.
Once the Alert is ready, you are going to be automatically subscribed to it

NOTE: To unsubscribe from this Alert, clear the check box next to the Alert Subject.

How to subscribe other Users to this Alert?

1. Access Metric Viewer > Alert Icon > Alert Rules

You are going to be redirected to the Alert Rule Editor.

2. Open Subscriptions & Alert Workflows tab

You can add subscribers via:

  1. A User Map. For more details refer to: Create a User Map
  2. Adding a Group of Users. Refer to: Create/Maintain Groups and Assign Privileges
  3. Individually checking users from the list. Users shown in Red may be subscribed to the Alert but will not receive Alerts until they are granted View Access to either the Metric or any associated Payload, such as a Report. Hover over the name to see exactly what element access is missing.