Relative Change Alerts

Summary

Relative Change Alerts evaluate based on the nature of the data change in a Cell’s value
They can respond to any change, a relative change or an absolute change

Relative Change Alerts are similar to Data Change Alerts, but they evaluate on the relative nature of the change made to a given Cell's value.

There are 3 Relative Change Alerts types, each levaraging an associated Relative Change Expression:

Function	When Alert is Triggered
ANY_CHANGE	Any change at all to the Cell's value
PERCENT_CHANGE	If the value of Cell changes by a given percent amount
ABSOLUTE_CHANGE	If the value of Cell changes by a given absolute amount

Find Out More

See Relative Change Expressions in AdapTableQL for more details

Any Change

Any Any Change Alert fires if there is any change at all to the Cell's value.

It leverages the ANY_CHANGE Expression Function.

Alerts: Relative Any Change

Fork Fork

This example displays an Info Alert which fires when there is any change to a Cell's value in any numeric column (using ANY_CHANGE expression)

Percent Change

A Percent Change Alert fires if the value of a Cell changes by a given percent amount.

It leverages the PERCENT_CHANGE Expression Function.

Hint

PERCENT_CHANGE can be given a "direction" to limit the evaluation to percent increases or decreases

Alerts: Relative Percent Change

Fork Fork

This example displays 2 Warning Alerts which check for relative percent changes (leveraging the PERCENT_CHANGE expression function)
- on the Github Stars column if the cell's value changes by more than 50% (in any direction)
- on the Github Watchers column if the cell's value increases by more than 50%

Absolute Change

An Absolute Change Alert fires if the value of a Cell changes by a given absolute amount.

It leverages the ABSOLUTE_CHANGE Expression Function.

Hint

ABSOLUTE_CHANGE can be given a "direction" to limit the evaluation to percent increases or decreases

Alerts: Relative Absolute Change

Fork Fork

This example displays 2 Success Alerts which check for relative absolute changes (leveraging the ABSOLUTE_CHANGE expression function)
- on the Github Stars column if the cell's value changes by more than 100 (in any direction)
- on the Github Watchers column if the cell's value decreases by exactly 20

import {AdaptableOptions} from '@adaptabletools/adaptable';
import {WebFramework} from './rowData';

export const adaptableOptions: AdaptableOptions<WebFramework> = {
  primaryKey: 'id',
  adaptableId: 'Relative Absolute Change Alert',
  initialState: {
    Dashboard: {
      ModuleButtons: ['Alert'],
      Tabs: [
        {
          Name: 'Toolbars',
          Toolbars: ['Alert'],
        },
      ],
    },
    StatusBar: {
      StatusBars: [
        {
          Key: 'Center Panel',
          StatusBarPanels: ['Alert'],
        },
      ],
    },
    Theme: {CurrentTheme: 'dark'},
    Alert: {
      AlertDefinitions: [
        {
          Name: 'alert-info-name-change',
          MessageType: 'Info',
          Scope: {
            ColumnIds: ['name'],
          },
          Rule: {
            BooleanExpression: 'ANY_CHANGE([name])',
          },
          AlertProperties: {
            DisplayNotification: true,
            HighlightCell: true,
          },
        },
        {
          Name: 'alert-warning-open-issues-count',
          MessageType: 'Warning',
          Scope: {
            ColumnIds: ['open_issues_count'],
          },
          Rule: {
            BooleanExpression: 'PERCENT_CHANGE([open_issues_count]) > 50',
          },
          AlertProperties: {
            DisplayNotification: true,
            HighlightCell: true,
          },
        },
        {
          Name: 'alert-warning-closed-issues-count',
          MessageType: 'Warning',
          Scope: {
            ColumnIds: ['closed_issues_count'],
          },
          Rule: {
            BooleanExpression:
              'PERCENT_CHANGE([closed_issues_count], "INCREASE") > 50',
          },
          AlertProperties: {
            DisplayNotification: true,
            HighlightCell: true,
          },
        },
        {
          Name: 'alert-success-github-stars',
          MessageType: 'Success',
          Scope: {
            ColumnIds: ['github_stars'],
          },
          Rule: {
            BooleanExpression: 'ABSOLUTE_CHANGE([github_stars]) > 100',
          },
          AlertProperties: {
            DisplayNotification: true,
            HighlightCell: true,
          },
        },
        {
          Name: 'alert-success-github-watchers',
          MessageType: 'Success',
          Scope: {
            ColumnIds: ['github_watchers'],
          },
          Rule: {
            BooleanExpression:
              'ABSOLUTE_CHANGE([github_watchers], "DECREASE") = 20',
          },
          AlertProperties: {
            DisplayNotification: true,
            HighlightCell: true,
          },
        },
      ],
    },
    Layout: {
      CurrentLayout: 'Standard Layout',
      Layouts: [
        {
          TableColumns: [
            'name',
            'language',
            'github_stars',
            'github_watchers',
            'license',
            'has_projects',
            'has_pages',
            'created_at',
            'has_wiki',
            'updated_at',
            'pushed_at',
            'week_issue_change',
          ],
          Name: 'Standard Layout',
          AutoSizeColumns: true,
        },
      ],
    },
  },
};

PreviousData Change Alerts NextRow Change Alerts