Alerts Technical Reference

Alerts to evaluate. Each one is a rule-based alert (Scope + Rule), a row-change alert (RowChangeTrigger), or a scheduled alert (Schedule).

Form to display in Alert with buttons and inputs

Properties which set what happens when the Alert is triggered (notification and grid behaviours)

AdapTableQL boolean expression deciding when the Alert is triggered.

The kind is inferred from the text: a per-row rule such as
[price] > 100, an aggregated rule such as SUM{[notional]} > 1000000,
or a live (observable) rule such as CHANGE_COUNT{[price], WITHIN(5m)} >= 3.

Where Alert can be triggered: one, some or all columns or DataTypes

When a live rule (one reading change history — CHANGE_COUNT[price],
WITHIN(5m) = 3 — or the clock) fires. Live rules are re-evaluated on
data changes and on window expiry alike, and fire only on the transition
from false to true (per row, or once for a grid-level rule). Ignored for
every other rule.

Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')

Suspends (i.e. turns off) an Adaptable Object

Colours the cell that triggered the alert. true uses the colour for MessageType. An is applied instead of that colour.

Colours the row that triggered the alert. true uses the colour for MessageType. An is applied instead of that colour.

Grid will 'jump' to the changed cell which triggered the Alert

Grid will 'jump' to the newly added row which triggered the Alert

Automatically prevent any cell edit which triggered the Alert (i.e. validation)

'BecomeTrue' (the only policy, and the default): fire when the rule
turns from false to true; stay silent while it remains true; a rule that
is already true when the Alert is created does not fire until it turns
false and true again.

Matches every column. All must be true.

Data types to match, for example ['number'] or ['text', 'textArray']. Object, tuple and unknown columns are not scope data types. Name those columns with ColumnIds.

Column ids to match. These are AG Grid colId values.

AG Grid column type names, the strings set on colDef.type.

Notification properties for scheduled alerts (no grid behaviours)

When the alert should run

Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')

Suspends (i.e. turns off) an Adaptable Object

When true, the scheduled notification includes a Suspend button

Standard 5-field cron (minute hour day-of-month month day-of-week); e.g. weekdays at 09:30 → 30 9 * * 1-5

true runs once, at RunAt. false repeats on CronExpression.

ISO datetime for a one-off run (local time); set when IsOneOff is true

Full definitions of Alert Forms - the names of which are provided in Alert State

Function providing Header to display in Alert; if empty, AdapTable provides dynamically

Function providing Message to display in Alert; if empty, AdapTable provides dynamically

How long (in ms) a Cell will be highlighted when an Alert fires

Custom onClick Handlers for Buttons (displayed in Alert Forms)

When a single batch action (e.g. Bulk Update, Smart Edit) triggers multiple Alerts from the
same Alert Definition, consolidate them into a single Alert (with an occurrence count) rather
than showing one Alert per changed cell.

Per-cell effects (cell/row highlighting, console logging, the AlertFired event) still fire
for every change; only the "once" effects (the stored Alert, the toast notification and any
jump-to-cell/row) are consolidated. Alerts that use a bespoke Alert Form are never consolidated.

Whether Alert rule is evaluated against the rawValue or formattedValue of the changed cell data

How many alerts held in State at any one time; when limit is breached, oldest alert will be removed

How long (in ms) a Row will be highlighted when an Alert Fires

Shows Alert if Primary Key column in Adaptable Options is not present or incorrect

How long (in ms) Alert panel in Status Bar highlights when an Alert Fires

Alert that has been triggered

Custom application Context provided in AdaptableOptions.adaptableContext

Adds given Alert Definition to Adaptable State

Fires a scheduled Alert Definition now: its notification, system status message, or other behaviour.

Deletes given Alert Definition from Adaptable State

Displays the given Adaptable Alert.

Displays given Alert as a Toast

Updates given Alert Definition in Adaptable State

Evaluates the given Alert Definitions - will fire Alert if rule is met

Find all Alert Definitions which match the given criteria

Alert Definitions that are currently active (not suspended).

Retrieves alert definition by the technical ID (from AlertState)

Retrieves an Alert Definition by its Name

Retrieves all Alert Definitions in Alert State

Current reading of a live Alert rule — one reading change history
(CHANGE_COUNT{[price], WITHIN(5m)} >= 3) or the clock. 'Firing' while
the rule holds for rowNode (per-row rules) or for the grid (grid-level
rules; rowNode ignored); 'Normal' otherwise. undefined for
non-live, suspended or never-evaluated definitions / rows.

Retrieves Alert section from Adaptable State

Alert Definitions that are currently suspended.

Opens the Settings Panel on the Alert page.

The Alert page has two tabs: 'Alerts' (the live / triggered alerts) and
'Alert Definitions' (the alert configuration). Pass tab to open a specific tab.
When omitted, it opens the 'Alerts' tab if there are any live alerts, otherwise the
'Alert Definitions' tab.

Creates Alert based on given parameters and displays it.

Creates an Adaptable Alert based on given parameters and displays it as Error Alert.

Creates an Adaptable Alert based on given parameters and displays it as Info Alert.

Creates an Adaptable Alert from the header and message and displays it as a Success alert.

Creates an Adaptable Alert based on given parameters and displays it as Warning Alert.

Suspends Alert Definition

Suspends all Alert Definitions

Activates a suspended Alert Definition

Activates all suspended Alert Definition

Alert that was displayed.

A cell or row Alert includes the change that triggered it. A generic Alert is the message only.

Custom application Context provided in AdaptableOptions.adaptableContext

Cell DataChange which triggered Alert

For a consolidated batch Alert this is the first affected cell (jump-to-cell lands here).

All cell changes represented by this Alert when several changes from one batch
action were consolidated (occurrenceCount 1). The first entry matches
.

Used so cell / row highlighting still applies to every affected cell.

Timestamp of change occurrence (in milliseconds)

Column in which cell is situated

Value after the change.

Absent when trigger is live.

Value before the change.

Absent when trigger is live.

Whether the change was prevented by a validation rule

Primary Key Column's value for the row where edited cell is situated

Data in the Row

AG Grid RowNode that contains the cell

What triggered the change - user, background change, a reverted change, a
derived update on a Calculated Column whose source value changed, or a
live Alert rule turning true for the row (live: no old / new value,
column is the rule's first Scope column when it has one).

Row DataChange which triggered Alert

Timestamp of change occurrence (in milliseconds)

Data rows that have been added, updated, or deleted

Row Nodes that were affected by this change

Trigger for row change: Load, Add, Update, or Delete