RuleBasedAlertDefinition
Alert that fires when data matches a rule in the given column scope
export interface RuleBasedAlertDefinition extendsExtends
Properties
| Property | Type | Description |
|---|---|---|
| AlertForm | string |AlertButtonForm | Form to display in Alert with buttons and inputs |
| AlertProperties | RuleAlertProperties | Properties which set what happens when the Alert is triggered (notification and grid behaviours) |
| Rule | string | 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. |
| Scope | ColumnScope | Where Alert can be triggered: one, some or all columns or DataTypes |
| TriggerPolicy | AlertTriggerPolicy | 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. |
| IsReadOnly | boolean | Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full') |
| IsSuspended | boolean | Suspends (i.e. turns off) an Adaptable Object |
Property Details
AlertForm
Form to display in Alert with buttons and inputs
AlertForm?: string | AlertButtonForm;Property Value
string |AlertButtonForm
AlertProperties
Properties which set what happens when the Alert is triggered (notification and grid behaviours)
AlertProperties?: RuleAlertProperties;Property Value
Rule
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.
Rule: string;Property Value
string
Scope
Where Alert can be triggered: one, some or all columns or DataTypes
Scope: ColumnScope;Property Value
TriggerPolicy
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.
TriggerPolicy?: AlertTriggerPolicy;Property Value
IsSuspended
Inherited from SuspendableObject
Suspends (i.e. turns off) an Adaptable Object
IsSuspended?: boolean;Property Value
boolean
IsReadOnly
Inherited from AdaptableObject
Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')
IsReadOnly?: boolean;Property Value
boolean