AlertsEnterprise
RTView features a real-time alert engine
that enables management and operational personnel to monitor the health and
status of business operations. The alert
engine can monitor conditions and perform automated actions from any available
Enterprise RTView data source. Alert definitions can include thresholds,
severity, notification policies and automated actions, such as email, system
commands, performing a SQL statement or sending JMS messages. Enterprise
RTView can load any number of
alert definitions and any number of customized dashboards can be created to
view alert status, filter alerts, use alerts as drill down navigation for
analysis and corrective action, or to interactively change alert status such as
alert acknowledgement.
Adding Alerts
In the Display Builder, select Tools>Alerts to open the Alerts
dialog. When you have finished adding all of
your alerts and configuring their properties, Save the
display (.rtv) file and add your
Alert Definition file to the
Alert data source
configuration.
| Add |
To add a new alert,
click Add and enter an alert name and select an alert type. Once you have
added an alert, select that alert from the list and edit properties in the
Object Properties dialog. |
| Alert
Name |
Enter a
unique name for each alert listed. Alerts that do not specify a name, as well as
alerts with
a duplicate names, will not be created and an error will print to the
console. |
| Alert
Type |
Choose a type of alert
from the drop down menu (Limits,
Discrete or
Multi State). |
| Copy |
Select an alert from
the list and click Copy to create a duplicate of that alert. NOTE: You must
enter a unique name for each copy
you make. To copy an alert from your
current display to another display (.rtv) file, select an alert from the list
and click the Copy button 
in the toolbar (or Ctrl-C). Then open the other display (.rtv) file and
click the Paste button 
(or Ctrl-V). If an alert by that name already exists in that
display (.rtv) file, you will need to rename the alert.
NOTE: An alert pasted into another
display (.rtv) file will have the same data attachments as the original alert. |
| Remove |
Select an
alert from the list and click Remove to delete. |
| Show Filters |
Select to filter alerts by Name, Type, Command
or Value. NOTE: When filtering Alerts by Name, unnamed alerts will still be
included in the filter results.
|
Alert Definition Files
To create an Alert Definition file, save
the display (.rtv) file that contains the alert definition properties you set in
the Alerts dialog. When the Alert data source
reads in an Alert Definition file, it adds a line to the
Alert Variables
Table
for each alert in the file and creates a variable using the unique name
specified for each alert in the file.
See Application Options for
details on how to add an Alert Definition file to the Alert data source
configuration.
Creating a Reusable
Alert Definition File
You can create a reusable Alert
Definition file using the Enterprise RTView substitution feature. When you enter
an Alert Name (alertName), include a substitution string as the suffix. Use that same
substitution string for the input value in the data attachment. When you
subsequently add the Alert Definition file to the Alert data source
configuration, you then specify a substitution value.
To give an example, let us say that your sales
data is broken down by sales regions, and you need an alert for each. Instead of
manually creating an alert for each region, you can create one and reuse it as a
template for the others. First create a display containing an alert definition
object named salesAlert.$region, where salesAlert is the alert name and
$region is the substitution string. The data attachment for the input value also
uses the $region substitution string. Save the file as alert_config.rtv.
This is your Alert Definition file. You then add this Alert Definition file to
the Alert data source configuration multiple times (in our example, four times),
with $region set to a different value for each region:
alert_config.rtv $region:North
alert_config.rtv $region:South
alert_config.rtv $region:West
alert_config.rtv $region:East
You will get four copies of salesAlert with the
following names:
salesAlert.North
salesAlert.South
salesAlert.West
salesAlert.East
Running the Alert
Engine
The alert engine resides within the
Alert data source, so there is no additional process to run the alert engine. How Enterprise RTView is deployed determines where the
alert engine specifically runs:
Thin Client Browser
with Direct Data Connection - The
alert engine runs on the Display Server. The alert engine is active as long as the Display Server is
running, regardless of whether clients are connected.
Application or Rich Client Browser with Direct Data
Connection - The alert engine runs on the client
machine. The alert engine is active as long as the client application or applet is running.
All
Deployments with Served Data -
The alert engine runs on the Data Server. The alert engine is active as long
as the Data Server is
running, regardless of whether clients are connected.
Alert Behavior
Alert Execution
Alerts are evaluated once each
update period. By default, this is every two seconds. You may set the update
period in the Application Options dialog. If
the current value of the input data meets an alert condition, the alert
executes. When an alert is
executed, the variables in the Alert data source are updated and the
alertCommand executes. NOTE:
Multiple asynchronous data updates between updates will be missed. For example,
if your input data is a JMS message and you receive three messages between
Enterprise RTView updates, only the data from the last message will be used when
evaluating the alert condition.
Cleared Alerts
Alerts are evaluated once each update period. By default, this is every two
seconds. You may set the update period in the
Application Options dialog. If the current value of the input data for
an alert that has been executed is no longer in an alert state, the alert will
clear. When an alert is cleared,
the variables in the Alert data source are updated and if the
reNotificationTime for the alert was specified, it will no longer re-execute
the alertCommand. NOTE:
Multiple asynchronous data updates between updates will be missed. For example,
if your input data is a JMS message and you receive three messages between
Enterprise RTView updates, only the data from the last message will be used when
evaluating the alert condition.
Viewing Alerts
You can create a display using the Display Builder to view
your real-time alert data.
When the Alert data source reads in an
Alert Definition file, it adds a line to the Alert Variables Table for each
alert in the file and creates a variable using the alertName field for each
alert in the file. Alerts without the alertName property filled in as well
alerts that have duplicate names will not be added. An error will print to the
console. The following alert
variables are available in the Alert data source. See
Attach to Alert Data for more information on
attaching to alert variables. The
Alert Variables Table contains
one row for each alert definition with the following information.
| Item |
Description |
| Alert Name |
Value of the alertName field of the alert
definition object. |
| Alert State |
Highest current severity for the
alert definition. If the data input for the alert definition object is tabular
(i.e. the useTabularDataFlag is True), it will have one alert
severity for each row in the input data table, this value will be the highest
severity of all the rows. If an alert is disabled, the value of Alert State will
become -1. |
| Enabled |
Enabled state of the alert: true if
enabled, false if disabled. |
The
AlertTable lists all of your active
and cleared alerts and contains the following information:
| Item |
Description |
| Time |
Time the alert was activated. |
| Last Update Time |
Date/time that the alert last received a data
update. This column is
updated whenever new data is received for an active (i.e. not cleared) alert. |
| Alert Name |
Value of the alertName field of the alert
definition object. |
| Alert Index |
This is blank if the input data for the alert
definition object is scalar (i.e. the useTabularDataFlag is False).
Otherwise, it is the value from the first column in the input data table. |
| Severity |
Severity of the alert. |
| Alert Text |
Text about the alert. NOTE: Customize this text
using the value*AlertText properties. |
| Cleared |
Selected if the alert has cleared. |
| Acknowledged |
Selected if the alert has been
acknowledged. |
| ID |
Unique ID for the alert. |
An alert variable is added to the Alert
data source for each alert definition object and is named using the alertName
property of the alert definition object. For alert definition objects that use
scalar input data (i.e. the useTabularData property is False),
this variable will be scalar. It will list the highest severity for the alert
definition. For alert definition
objects that use tabular input data (i.e. the useTabularData property is
True), this variable will be a table. It contains one row for each row in
the input table with the following columns:
| Item |
Description |
| Alert Index |
Name from the first column
of the input data for the alert definition. |
| Alert State |
Highest current alert severity for this alert
index. If this alert or alert index is disabled, the value of Alert State will
become -1. |
| Enabled |
Enabled state of the alert index: true if
enabled, false if disabled. |
Managing Alerts
In addition to being able to manage your
alerts while developing your display using the
Application Options dialog, you
can also manage them from your deployed display.
Use the following alert commands to manage your alerts
from a deployed display.
- Add Alert Definition File
- Remove Alert Definition File
- Enable Alert Definition
- Enable Alerts
- Acknowledge Alert
See Define Alert
Command for more information.
NOTE: Executing these commands from your display
in the Display Builder does not cause the Application Options dialog to update. For example, if
you add an Alert Definition file by using the command, it does not show up in the
Application Options dialog until you either close and re-open it, or click Apply.
Limits Alerts
Limits alerts allow you to compare your input
value to a threshold and execute the alert if your input data goes above or below an
acceptable range. Attach the value property to your input data if the data is scalar. If the
data is tabular, select the useTabularDataFlag and attach your input to
valueTable. The data attached to the valueTable property must contain two
columns, the first column must be an index column containing a unique value in
each row. The second column must contain numeric values to compare to the
thresholds. An alert will execute for each row in the table when the value goes
above or below the acceptable range.
This alert type supports four thresholds:
valueHighAlert, valueHighWarning, valueLowAlert and valueLowWarning. The
value and valueTable properties are compared
against the specified threshold values (scalar, tabular or list) and an alert is activated when threshold
values are exceeded.
When specifying a scalar
threshold value, value and
each row in the valueTable
will be compared against the scalar value.
When specifying a tabular threshold value, the input table
can contain one or two columns:
If the specified threshold table has one
column, the column must contain comparison values and should have the same
number of rows as the input table attached to the valueTable. Each row
in valueTable will be compared against values in the corresponding rows
of the specified threshold table. If valueTable has more rows than the
specified threshold table, these extra rows will be compared against the value
of the first row of the specified threshold table. The value property
will be compared to the first row of the specified threshold table.
If the specified threshold table has two columns, the first column must
contain indexes and the second column must contain comparison values. The
index value for each row in the input table attached to valueTable will
be used to lookup the corresponding comparison value from the specified
threshold table. If the index is not found in the specified threshold table,
no alert is activated. The value property cannot be compared against a
threshold table with two columns.
When specifying a list of threshold values, the
list can contain either index/comparison value pairs or just comparison values:
If the list only contains comparison values,
this should be a semicolon (;) delimited list of comparison values (e.g.:
80;90;100) with the same number of values as there are rows in the input table
attached to valueTable. Each row in valueTable will be compared
against corresponding items in the specified threshold list. If valueTable
has more rows than items in the specified threshold list, these extra rows
will be compared against the first item in the specified threshold list. The
value property will be compared to the first item the specified
threshold list.
If the list contains index/comparison value
pairs, this should be a semicolon (;) delimited list of comma (,) separated
index/comparison value pairs (e.g.: (Chicago,80;Dallas,90;Detroit,100). The
index value for each row in the input table attached to valueTable will
be used to lookup the corresponding comparison value from the specified
threshold list. If the index is not found in the specified threshold list, no
alert is activated. The value property cannot be compared against a
threshold list of index/comparison value pairs.
Limits Alert Properties
| Property
Name |
Description |
| alertCommand |
The action executed when an alert is
activated. Any of the available Enterprise RTView commands
can be used as well
as the following substitutions. |
| Substitution |
Description |
| $alertCompValue |
Value the current
input value is being compared against. |
|
$alertCurValue |
Current input
value. |
|
$alertEmailBody |
Alert email body text. |
|
$alertEmailSubject |
Alert email subject. |
|
$alertID |
Unique ID for the alert. |
|
$alertIndex |
Alert index. This
is the same as the value in the Alert Index column of the
AlertTable. |
|
$alertLabel |
Label
indicating the alert type (Discrete alert types: High Alert, Medium Alert, Low
Alert; Limits alert types: High Alert, High Warning, Low Alert, Low Warning) |
|
$alertName |
Value from the alertName field for the alert. |
| $alertSeverity |
Severity of the alert. |
|
$alertText |
Alert text. This is the same text that is
displayed in the AlertTable. |
|
$alertTime |
Time the alert was
generated. This is the same value in the Time column of the AlertTable. |
| alertDelayTime |
Specifies the amount of time (in
seconds) that a value must remain within the alert range before the alert is
executed.
For example, if valueHighAlert is 90 and
alertDelayTime is 5, then the input value must stay over 90 for 5 seconds
before a high alert is issued.
If the skipDuplicateAlertsFlag is selected
it will apply to both threshold values. So, in the example above, if a high
alert has been issued, the
valueHighWarning is 80 and the input value drops to 85, it must stay below 90
for 5 seconds before the severity is changed to high warning. |
| alertName |
A unique name for the alert. An
entry for this property is required. To create a
reusable Alert Definition
file, include the substitution string as the suffix.
For example: salesAlert.$region (where salesAlert is the alert name and
$region is the substitution string.) |
| enabledFlag |
Enables or disables the entire
alert. If this alert is active when it is disabled, it will be cleared. NOTE: It
is not recommended that you attach data to this property if you are using the
Enable Alert Definition
command for this alert. |
| nonRepetitionTime |
Amount of time (in
seconds) that must pass after a
cleared alert is executed again. If the skipDuplicateAlertsFlag is
selected, the alert will not be cleared until both thresholds (warning and
alert) are cleared. |
| reNotificationMode |
Configure how an alert will renotify.
Default setting is Renotify on Timer. Choose from the following options:
| None
|
Do not
renotify. The alertCommand is executed only once when the alert is
activated. |
| Renotify on
Timer |
Renotify based on reNotificationTime property. The alertCommand
is executed once when the alert is activated and then re-executed every
reNotificationTime (seconds) until the alert is cleared or acknowledged.
If the reNotificationTime is set to 0, then the alert will not
renotify. |
| Renotify on
Data Changed |
Renotify when the input value changes. The alertCommand is executed
once when the alert is activated and again when a different value is
received until the alert is cleared or acknowledged. The new value must be
different than the previous value for the alert to renotify. |
| Renotify on
Data Updates |
Renotify when the input value is updated. The alertCommand is
executed once when the alert is activated and again whenever a value is
received until the alert is cleared or acknowledged. The new data value may
be the same or different than the previous value for the alert to renotify. |
|
| reNotificationTime |
Amount of time (in
seconds) that must pass before
the alertCommand for an unacknowledged or an uncleared alert is re-executed. The
alertCommand
will continue to re-execute on this interval until the alert is
acknowledged or cleared.
NOTE: This property will be ignored unless the
reNotificationMode is set to Renotify on Timer. |
| rowEnabledTable |
Sets the enabled state for each row
in the valueTable, so you can enable or disable each index in a tabular
alert. This property only applies for tabular alerts, therefore the useTabularDataFlag must be selected to
activate the rowEnabledTable property. If the enabledFlag for the
alert is disabled, each row index is disabled regardless of the value of
rowEnabledTable.
This property can be set to one of the following:
Scalar data:
If true, all rows (indexes) in the table will be enabled. If false
all rows (indexes) will be disabled.
Tabular data (one or two columns):
If
your tabular input data has one
column, the column must contain boolean values and should have the same number
of rows as the valueTable. Each row
in the valueTable will be compared against values in the corresponding rows
of the specified rowEnabledTable. If the valueTable has more rows than the
rowEnabledTable, these extra rows will be compared against the value
of the first row of the rowEnabledTable.
If your tabular input
data has two columns, the first column must
contain indexes and the second column must contain boolean values. The index
value for each row in the valueTable will
be used to lookup the corresponding enabled value from the rowEnabledTable. If the index is not found in the
rowEnabledTable,
the enabled state is set to false and the row (index) is disabled.
List of enabled (boolean) values:
This should be a semicolon (;) delimited list of boolean values (e.g.:
true;false;true) with the same number of values as there are rows in the
valueTable. Each row in valueTable will be set to corresponding
enabled values in the specified list. If valueTable has more rows than
enabled values in the list, then the first value in the list will be used.
List of index/enabled value pairs:
This should be a semicolon (;) delimited list of comma (,) separated
index/enabled value pairs (e.g.: (Chicago,true;Dallas,false;Detroit,true). The index
value for each row in the valueTable will
be used to lookup the corresponding enabled value from the specified
list. If the index is not found in the enabled value list, the enabled state
is set to false and the row (index) is disabled. |
| skipDuplicateAlertsFlag |
If selected, the severity of an
alert will update (e.g. valueHighWarning to valueHighAlert)
without multiple alerts being activated. That is, only the highest (or
lowest) alert will be activated when the input value exceeds both high (or
low) thresholds. This
property is static and cannot be attached to data.
NOTE: Once an alert
is
acknowledged, the severity of that alert will no longer update. |
| timeColumnName |
Optionally specify a column in the valueTable
to be used for the Last Update Time in the Alert
Table. NOTE: The column specified must be of type date or long. If
timeColumnName is not specified, not of type date or long,
or is not found, then the time that the alert last received data
will be used. NOTE: This property is only
supported if useTabularDataFlag is selected and does not apply to
scalar alerts. For scalar alerts, the time that the alert last received the data is
always used. |
| useTabularDataFlag |
For tabular input data, select the
useTabularDataFlag and attach your input to
valueTable. The data attached to the valueTable property must contain two
columns, the first column must be an index column containing a unique value in
each row. The second column must contain numeric values to compare to the
thresholds. |
| value |
Attach your input data to this
property if your input data is scalar. For tabular input data, select the
useTabularData property and attach your input data to the valueTable
property. |
| valueDeadband |
Specifies a deadband value for the
thresholds. If specified, the input value must go below the valueHighWarning/valueHighAlert
minus the deadband value or above the valueLowWarning/valueLowAlert
plus the deadband value for the alert to clear.
For example, if the valueHighAlert
is 90 and the valueDeadband is 5, a high alert will be issued when
the input value goes above 90, but will not clear until the input value goes
below 85.
If the skipDuplicateAlertsFlag is selected
it will apply to both threshold values. So, in the example above, if
valueHighWarning is set to 80 then the input value must go below 85 before
the severity is changed to high warning and below 75 for the alert to be
cleared. |
| valueHighAlert |
Specifies the number that
the input value must exceed to activate the high alert.
Enter either a scalar or tabular value, or specify a
list of values. |
| valueHighAlertEnabledFlag |
Enables the
high alert threshold. When executed, severity is 2. |
| valueHighAlertText |
Specify the alert text to display in
the Alert Text column of the AlertTable. If no
alert text is specified, Enterprise RTView will use default text. NOTE: All
alert substitutions available on the alertCommand, except $alertText
and $alertEmailBody, can be used to specify alert text. |
| valueHighWarning |
Specifies the number that
the input value must exceed to activate the high warning.
Enter either a scalar or tabular value, or specify a
list of values. |
| valueHighWarningEnabledFlag |
Enables the
high warning threshold. When executed, severity is
1. |
| valueHighWarningText |
Specify the alert text to display in
the Alert Text column of the AlertTable. If no
alert text is specified, Enterprise RTView will use default text. NOTE: All
alert substitutions available on the alertCommand, except $alertText
and $alertEmailBody, can be used to specify alert text. |
| valueLowAlert |
Specifies the number the input value
must go below to activate the low alert. Enter
either a scalar or tabular value, or specify a list of values. |
| valueLowAlertEnabledFlag |
Enables the
low alert threshold. When executed, severity is 2. |
| valueLowAlertText |
Specify the alert text to display in
the Alert Text column of the AlertTable. If no
alert text is specified, Enterprise RTView will use default text. NOTE: All
alert substitutions available on the alertCommand, except $alertText
and $alertEmailBody, can be used to specify alert text. |
| valueLowWarning |
Specifies the number the input value
must go below to activate the low warning. Enter
either a scalar or tabular value, or specify a list of values. |
| valueLowWarningEnabledFlag |
Enables the
low warning threshold. When executed, severity is
1. |
| valueLowWarningText |
Specify the alert text to display in
the Alert Text column of the AlertTable. If no
alert text is specified, Enterprise RTView will use default text. NOTE: All
alert substitutions available on the alertCommand, except $alertText
and $alertEmailBody, can be used to specify alert text. |
| valueTable |
Attach your input data to this
property if it is tabular. For scalar input data, deselect the useTabularData
and attach your input data to the value property. The data attached to
this property must contain two
columns, the first column must be an index column containing a unique value in
each row. The second column must contain numeric values to compare to the
thresholds. |
Discrete Alerts
Discrete alerts
allow you to compare the input value to up to three test values (one each for
low, medium and high alerts), and execute an alert if your input data equals one
of these values. The Discrete alert supports string, number and boolean
comparisons. Attach the value
property to your input data if the data is scalar. If the data is tabular,
select the useTabularDataFlag and attach your input data to the valueTable
property. The
data attached to the valueTable property must contain two columns, the first
column must be an index column containing a unique value in each row. The second
column must contain values (string, number, boolean) to compare to the test values. An alert will execute
for each row in the table when the value is equal to the specified test
values. This alert type supports three test
values: valueHighAlert,
valueMediumAlert, valueLowAlert. The
value and valueTable properties are compared
against the specified test values (scalar, tabular or list) and an alert is activated when
test
values are reached.
When specifying a scalar test
value, value and each row
in the valueTable will be
compared against the scalar value.
When specifying a tabular test value, the input table
can contain one or two columns:
If the specified test value table has one
column, the column must contain comparison values and should have the same
number of rows as the input table attached to the valueTable. Each row
in valueTable will be compared against values in the corresponding rows
of the specified test value table. If valueTable has more rows than the
specified test value table, these extra rows will be compared against the value
of the first row of the specified test value table. The value property
will be compared to the first row of the specified test value table.
If the specified
test value table has two columns, the first column must
contain indexes and the second column must contain comparison values. The
index value for each row in the input table attached to valueTable will
be used to lookup the corresponding comparison value from the specified
test value table. If the index is not found in the specified test value table,
no alert is activated. The value property cannot be compared against a
test value table with two columns.
When specifying a list of test values, the
list can contain either index/comparison value pairs or just comparison values:
If the list only contains comparison values,
this should be a semicolon (;) delimited list of comparison values (e.g.:
80;90;100) with the same number of values as there are rows in the input table
attached to valueTable. Each row in valueTable will be compared
against corresponding items in the specified test value list. If valueTable
has more rows than items in the specified test value list, these extra rows
will be compared against the first item in the specified test value list. The
value property will be compared to the first item the specified
test value list.
If the list contains index/comparison value
pairs, this should be a semicolon (;) delimited list of comma (,) separated
index/comparison value pairs (e.g.: (Chicago,80;Dallas,90;Detroit,100). The
index value for each row in the input table attached to valueTable will
be used to lookup the corresponding comparison value from the specified
test value list. If the index is not found in the specified test value list, no
alert is activated. The value property cannot be compared against a
test value list of index/comparison value pairs.
Discrete Alert Properties
| Property
Name |
Description |
| alertCommand |
The action executed when an alert is
activated. Any of the available Enterprise RTView commands
can be used as well
as the following substitutions. |
| Substitution |
Description |
| $alertCompValue |
Value the current
input value is being compared against. |
|
$alertCurValue |
Current input
value. |
|
$alertEmailBody |
Alert email body text. |
|
$alertEmailSubject |
Alert email subject. |
|
$alertID |
Unique ID for the alert. |
|
$alertIndex |
Alert index. This
is the same as the value in the Alert Index column of the
AlertTable. |
|
$alertLabel |
Label indicating the
alert type (Discrete alert types: High Alert, Medium Alert, Low Alert; Limits
alert types: High Alert, High Warning, Low Alert, Low Warning) |
|
$alertName |
Value from the alertName field for the alert. |
| $alertSeverity |
Severity of the alert. |
|
$alertText |
Alert text. This is the same text that is
displayed in the AlertTable. |
|
$alertTime |
Time the alert was
generated. This is the same value that is shown in the Time column of the AlertTable. |
| alertDelayTime |
Specifies the amount of time (in
seconds) that a value must remain equal to the input value before the
alert is executed. |
| alertName |
A unique name for the alert. An
entry for this property is required. To create a
reusable Alert Definition
file, include the substitution string as the suffix.
For example:
salesAlert.$region
where salesAlert is the alert name and $region is the substitution string. |
| enabledFlag |
Enables or disables the entire
alert. If this alert is active when it is disabled, it will be cleared. NOTE: It
is not recommended that you attach data to this property if you are using the
Enable Alert Definition
command for this alert. |
| nonRepetitionTime |
Amount of time (in
seconds) that must pass after a
cleared alert is again executed. |
| reNotificationMode |
Configure how an alert will renotify.
Default setting is Renotify on Timer. Choose from the following options:
| None
|
Do not
renotify. The alertCommand is executed only once when the alert is
activated. |
| Renotify on
Timer |
Renotify based on reNotificationTime property. The alertCommand
is executed once when the alert is activated and then re-executed every
reNotificationTime (seconds) until the alert is cleared or acknowledged.
If the reNotificationTime is set to 0, then the alert will not
renotify. |
| Renotify on
Data Changed |
Renotify when the input value changes. The alertCommand is executed
once when the alert is activated and again when a different value is
received until the alert is cleared or acknowledged. The new value must be
different than the previous value for the alert to renotify. |
| Renotify on
Data Updates |
Renotify when the input value is updated. The alertCommand is
executed once when the alert is activated and again whenever a value is
received until the alert is cleared or acknowledged. The new data value may
be the same or different than the previous value for the alert to renotify. |
|
| reNotificationTime |
Amount of time (in
seconds) that must pass before
the alertCommand for an unacknowledged or an uncleared alert is re-executed. The
alertCommand
will continue to re-execute on this interval until the alert is
acknowledged or cleared.
NOTE: This property will be ignored unless the
reNotificationMode is set to Renotify on Timer. |
| rowEnabledTable |
Sets the enabled state for each row
in the valueTable, so you can enable or disable each index in a tabular
alert. This property only applies for tabular alerts, therefore the useTabularDataFlag must be selected to
activate the rowEnabledTable property. If the enabledFlag for the
alert is disabled, each row index is disabled regardless of the value of
rowEnabledTable.
This property can be set to one of the following:
Scalar data:
If true, all rows (indexes) in the table will be enabled. If false
all rows (indexes) will be disabled.
Tabular data (one or two columns):
If
your tabular input data has one
column, the column must contain boolean values and should have the same number
of rows as the valueTable. Each row
in the valueTable will be compared against values in the corresponding rows
of the specified rowEnabledTable. If the valueTable has more rows than the
rowEnabledTable, these extra rows will be compared against the value
of the first row of the rowEnabledTable.
If your tabular input
data has two columns, the first column must
contain indexes and the second column must contain boolean values. The index
value for each row in the valueTable will
be used to lookup the corresponding enabled value from the rowEnabledTable. If the index is not found in the
rowEnabledTable,
the enabled state is set to false and the row (index) is disabled.
List of enabled (boolean) values:
This should be a semicolon (;) delimited list of boolean values (e.g.:
true;false;true) with the same number of values as there are rows in the
valueTable. Each row in valueTable will be set to corresponding
enabled values in the specified list. If valueTable has more rows than
enabled values in the list, then the first value in the list will be used.
List of index/enabled value pairs:
This should be a semicolon (;) delimited list of comma (,) separated
index/enabled value pairs (e.g.: (Chicago,true;Dallas,false;Detroit,true). The index
value for each row in the valueTable will
be used to lookup the corresponding enabled value from the specified
list. If the index is not found in the enabled value list, the enabled state
is set to false and the row (index) is disabled. |
| timeColumnName |
Optionally specify a column in the valueTable
to be used for the Last Update Time in the Alert
Table. NOTE: The column specified must be of type date or long. If
timeColumnName is not specified, not of type date or long,
or is not found, then the time that the alert last received data
will be used. NOTE: This property is only
supported if useTabularDataFlag is selected and does not apply to
scalar alerts. For scalar alerts, the time that the alert last received the data is
always used. |
| useTabularDataFlag |
For tabular input data, select the
useTabularDataFlag and attach your input data to the valueTable
property. The
data attached to the valueTable property must contain two columns, the first
column must be an index column containing a unique value in each row. The second
column must contain values to compare to the test values. |
| value |
Attach your input data to this
property if your input data is scalar. For tabular input data, select the
useTabularData property and attach your input data to the valueTable
property. |
| valueHighAlert |
Specifies the value that
the input value must be equal to for the high alert to execute.
Enter either a scalar or tabular value, or specify a
list of values. |
| valueHighAlertEnabledFlag |
Enables the
high alert. When executed, severity is 3. |
| valueHighAlertText |
Specify the alert text to display in
the Alert Text column of the AlertTable. If no
alert text is specified, Enterprise RTView will use default text. NOTE: All
alert substitutions available on the alertCommand, except $alertText
and $alertEmailBody, can be used to specify alert text. |
| valueLowAlert |
Specifies the value that
the input value must be equal to for the low alert to execute.
Enter either a scalar or tabular value, or specify a
list of values. |
| valueLowAlertEnabledFlag |
Enables the
low alert. When executed, severity is 1. |
| valueLowAlertText |
Specify the alert text to display in
the Alert Text column of the AlertTable. If no
alert text is specified, Enterprise RTView will use default text. NOTE: All
alert substitutions available on the alertCommand, except $alertText
and $alertEmailBody, can be used to specify alert text. |
| valueMediumAlert |
Specifies the value that
the input value must be equal to for the medium alert to execute.
Enter either a scalar or tabular value, or specify a
list of values. |
| valueMediumAlertEnabledFlag |
Enables the
medium alert. When executed, severity is 2. |
| valueMediumAlertText |
Specify the alert text to display in
the Alert Text column of the AlertTable. If no
alert text is specified, Enterprise RTView will use default text. NOTE: All
alert substitutions available on the alertCommand, except $alertText
and $alertEmailBody, can be used to specify alert text. |
| valueTable |
Attach your input data to this
property if it is tabular. For scalar input data, deselect the useTabularData
and attach your input data to the value property. The data attached to
this property must contain two
columns, the first column must be an index column containing a unique value in
each row. The second column must contain numeric values to compare to the
thresholds. |
Multi State Alerts
The
Multi State alert allows you to define any number of alert states. Each alert
state will have a corresponding alert condition. The input value for the alert
will be evaluated against all of the alert state conditions and an alert will be
issued for highest (1 through N) condition that is met. When an alert is
executed, the severity of the alert is set to the alert state number (1 through
N), the corresponding alert command is executed and the Alert State is set to
the highest active alert state number (1-N). If you would like an alert to be
executed for each condition that is met, deselect the skipDuplicateAlertsFlag
property.
Each alert state
evaluation is comprised of two parts: alertStateNCondition and
alertStateNComparison. The alertStateNCondition
property sets the comparison type (ex. <, >, In Range, Out of Range, etc). The
alertStateNComparison sets the corresponding comparison value to use in
the condition evaluation. However if alertStateNCondition is set to In
Range or Out of Range, then alertStateNLowerRangeLimit and
alertStateNUpperRangeLimit will be used. The alertStateNComparison,
alertStateNLowerRangeLimit and alertStateNUpperRangeLimit
properties can contain a scalar, tabular or list of comparison values.
Attach the value property to your input data if the data is scalar. If
the data is tabular, select the useTabularDataFlag and attach your input
to valueTable. The data attached to the valueTable property must
contain two columns, the first column must be an index column containing a
unique value in each row. The second column must contain numeric values to
evaluate against the conditions. An alert will execute for the highest alert
state condition that each row in the table meets, unless the
skipDuplicateAlertsFlag is turned off, in which case an alert will execute
for each alert state condition that each row in the table meets.
When specifying a scalar value for alertStateNComparison,
alertStateNLowerRangeLimit or alertStateNUpperRangeLimit, the
value and each row in the valueTable will be compared against the
scalar value.
When specifying a tabular value for alertStateNComparison,
alertStateNLowerRangeLimit or alertStateNUpperRangeLimit, the table
can contain one or two columns:
If the specified
alertStateNComparison, alertStateNLowerRangeLimit or
alertStateNUpperRangeLimit table has one column, the column must contain
numeric comparison values and should have the same number of rows as the input
table attached to the valueTable. Each row in valueTable will be
compared against values in the corresponding rows of the specified comparison
table. If valueTable has more rows than the specified comparison table,
these extra rows will be compared against the value of the first row of the
specified comparison table. The value property will be compared to the first row
of the specified comparison table.
If the specified alertStateNComparison, alertStateNLowerRangeLimit or
alertStateNUpperRangeLimit table has two columns, the first column must
contain indexes and the second column must contain numeric comparison values.
The index value for each row in the input table attached to valueTable
will be used to lookup the corresponding comparison value from the specified
comparison table. If the index is not found in the specified comparison table,
no alert is activated. The value property cannot be compared against a
comparison table with two columns (use the valueTable property instead).
When specifying a list of values for alertStateNComparison,
alertStateNLowerRangeLimit or alertStateNUpperRangeLimit, the list
can contain either index/comparison value pairs or just comparison values:
If the
alertStateNComparison list only contains comparison values, this should be a
semicolon (;) delimited list of comparison values (e.g.: 80;90;100) with the
same number of values as there are rows in the input table attached to
valueTable. Each row in valueTable will be compared against
corresponding items in the specified comparison list. If valueTable has
more rows than items in the specified threshold list, these extra rows will be
compared against the first item in the specified threshold list. The value
property will be compared to the first item the specified threshold list.
If the
alertStateNComparison list contains index/comparison value pairs, this
should be a semicolon (;) delimited list of comma (,) separated index/comparison
value pairs (e.g.: (Chicago,80;Dallas,90;Detroit,100). The index value for each
row in the input table attached to valueTable will be used to lookup the
corresponding comparison value from the specified comparison list. If the index
is not found in the specified comparison list, no alert is activated. The
value property cannot be compared against a comparison list of
index/comparison value pairs (use the valueTable property instead).
|
Property Name |
Description |
|
alertCommand |
The action executed when an alert is activated. Any of the
available Enterprise RTView commands
can be used as well as the following substitutions. |
|
Substitution |
Description |
|
$alertID |
Unique ID for the alert. |
|
$alertCompValue |
Comparison value. |
|
$alertCurValue |
Current input value. |
|
$alertName |
Value from the alertName field for the alert. |
|
$alertText |
Alert text. This is the same text that is displayed in the
AlertTable. |
|
$alertSeverity |
Severity of the alert. |
|
$alertEmailSubject |
Alert email subject. |
|
$alertEmailBody |
Alert email body text. |
|
$alertLabel |
Label indicating the alert level (e.g. Alert State 1, Alert
State 2, etc.) |
|
$alertIndex |
Alert index. This is the same as the value that is shown in the Alert Index
column of the
AlertTable. |
|
$alertTime |
Time the alert was generated. This is the same
value that is shown in the Time column of the AlertTable. |
|
alertDelayTime |
Specifies the amount of time (in seconds) that a value must
remain in an alert condition before the alert is updated or executed.
If the
skipDuplicateAlertsFlag is selected it will apply to all alert states.
In order for the alert state to change when the condition of one state is no
longer met and the condition of another state is met, it must be meet the
condition of the new state for more than the alertDelayTime specified
before the alert severity is changed. |
|
alertName |
A unique name for the alert. This property is required and cannot
be left blank.
To create a
reusable Alert Definition
file,
include the substitution string as the suffix. For example:
salesAlert.$region (where salesAlert is the alert name and
$region is the substitution string). |
|
enabledFlag |
Enables or disables the entire alert. If this alert is active
when it is disabled, it will be cleared. NOTE: It is not recommended that
you attach data to this property if you are using the
Enable Alert Definition
command for this alert. |
|
nonRepetitionTime |
Amount of time (in seconds) that must pass after a cleared alert
is again executed.
If the skipDuplicateAlertsFlag is selected, the alert will not
be cleared until all alert state conditions are cleared. |
|
reNotificationMode |
Configure how an alert will renotify. Default
setting is Renotify on Timer. Choose from the following options:
| None
|
Do
not renotify. The alertCommand is executed only once when the
alert is activated. |
| Renotify on
Timer |
Renotify based on reNotificationTime property. The
alertCommand is executed once when the alert is activated and then
re-executed every reNotificationTime (seconds) until the alert is
cleared or acknowledged. If the reNotificationTime is set to 0,
then the alert will not renotify. |
| Renotify on
Data Changed |
Renotify when the input value changes. The alertCommand is
executed once when the alert is activated and again when a different
value is received until the alert is cleared or acknowledged. The new
value must be different than the previous value for the alert to
renotify. |
| Renotify on
Data Updates |
Renotify when the input value is updated. The alertCommand is
executed once when the alert is activated and again whenever a value is
received until the alert is cleared or acknowledged. The new data value
may be the same or different than the previous value for the alert to
renotify. |
|
|
reNotificationTime |
Amount
of time (in seconds) that must pass before the alertCommand for an
unacknowledged or an uncleared alert is re-executed. The alertCommand
will continue to re-execute on this interval until the alert is acknowledged
or cleared. The alertCommand will continue
to re-execute on this interval until the alert is acknowledged or cleared.
If set to 0, the alertCommand will only execute once.
NOTE: This property will be ignored unless the
reNotificationMode is set to Renotify on Timer. |
|
rowEnabledTable |
Sets the enabled state for each row in the valueTable, so
you can enable or disable each index in a tabular alert. This property only
applies for tabular alerts, therefore the useTabularDataFlag must be
selected to activate the rowEnabledTable property. If the
enabledFlag for the alert is disabled, each row index is disabled
regardless of the value of rowEnabledTable.
This property
can be set to one of the following:
Scalar data:
If true, all rows (indexes) in the table will be enabled. If false
all rows (indexes) will be disabled.
Tabular data
(one or two columns):
If your tabular input data has one column, the column must contain boolean
values and should have the same number of rows as the valueTable.
Each row in the valueTable will be compared against values in the
corresponding rows of the specified rowEnabledTable. If the
valueTable has more rows than the rowEnabledTable, these extra
rows will be compared against the value of the first row of the
rowEnabledTable.
If your tabular input data has two columns, the first column must contain
indexes and the second column must contain boolean values. The index value
for each row in the valueTable will be used to lookup the
corresponding enabled value from the rowEnabledTable. If the index is
not found in the rowEnabledTable, the enabled state is set to
false and the row (index) is disabled.
List of enabled
(boolean) values:
This should be a semicolon (;) delimited list of boolean values (e.g.:
true;false;true) with the same number of values as there are rows in the
valueTable. Each row in valueTable will be set to corresponding
enabled values in the specified list. If valueTable has more rows
than enabled values in the list, then the first value in the list will be
used.
List of
index/enabled value pairs:
This should be a semicolon (;) delimited list of comma (,) separated
index/enabled value pairs (e.g.: (Chicago,true;Dallas,false;Detroit,true).
The index value for each row in the valueTable will be used to lookup
the corresponding enabled value from the specified list. If the index is not
found in the enabled value list, the enabled state is set to false
and the row (index) is disabled. |
|
skipDuplicateAlertsFlag |
The
default value for this is true. If selected, the severity of an alert will
update without multiple alerts being activated. That is, only the highest
severity alert will be activated when the input meets multiple conditions.
This property is static and cannot be attached to data. NOTE: Once an alert
is acknowledged, the severity of that alert will no longer update. If not
selected, an alert will be issued for each alertStateNCondition that
evaluates to true. |
|
timeColumnName |
Optionally specify a column in the valueTable to be used for the Last Update Time in the Alert
Table. NOTE: The column specified must be of type date or long. If
timeColumnName is not specified, not of type date or long,
or is not found, then the time that the alert last received data
will be used. NOTE: This property is only
supported if useTabularDataFlag is selected and does not apply to
scalar alerts. For scalar alerts, the time that the alert last received the data is
always used. |
|
useTabularDataFlag |
For tabular input data, select the useTabularDataFlag and
attach your input data to the valueTable property. The data attached
to the valueTable property must contain two columns, the first column
must be an index column containing a unique value in each row. The second
column must contain values to compare to the test values. |
|
value |
Attach your input data to this property if your input data is
scalar. For tabular input data, select the useTabularData property
and attach your input data to the valueTable property. |
|
numAlertStates |
Number of Alert Conditions to Evaluate. This number of
alertStateNCondition, alertStateNComparison,
alertStateNEnabledFlag, alertStateNLowerRangeLimit,
alertStateNUpperRangeLimit and alertStateNValueDeadband
properties is generated. (i.e. alertState1Condition, alertState1Comparison,
etc). This property is static and cannot be attached to data. |
|
alertStateNAlertText |
The text used in the Alert Text column of the alert table and in
the $alertText and $alertEmailBody substitutions. If no text
is specified text similar to the following is used:
Alert State N condition met: current value XX >
comparison value YY
The following substitutions are supported in the alert text. |
|
Substitution |
Description |
|
$alertID |
The unique ID for the alert. |
|
$alertCompValue |
The comparison value. |
|
$alertCurValue |
The current input value. |
|
$alertName |
The value from the alertName field for the alert. |
|
$alertSeverity |
The severity of the alert. |
|
$alertEmailSubject |
The alert email subject. |
|
$alertLabel |
A label indicating the alert level (ex. Alert State 1, Alert
State 2), etc. |
|
$alertIndex |
The alert index. This is the same as the value in the Alert Index
column of the
AlertTable. |
|
alertStateNCondition |
Condition to evaluate for Alert State N.
|
Condition |
Description |
|
< |
An alert is executed when the value is less than the
corresponding alertStateNComparison. It is cleared when the value
is equal to or greater than alertStateNComparison if the
corresponding alertStateNValueDeadband is 0. If the corresponding
alertStateNValueDeadband is not 0, the alert will be cleared when
the value is equal to or greater than alertStateNComparison plus
alertStateNValueDeadband.
The value and alertStateNComparison must be
numbers. The following properties are disabled:
alertStateNUpperRangeLimit and alertStateNLowerRangeLimit. |
|
> |
An alert is executed when the value is greater than the
corresponding alertStateNComparison. It is cleared when the value
is equal to or less than alertStateNComparison if the
corresponding alertStateNValueDeadband is 0. If the corresponding
alertStateNValueDeadband is not 0, the alert will be cleared when
the value is equal to or less than alertStateNComparison minus
alertStateNValueDeadband.
The value and alertStateNComparison must be
numbers.
The
following properties are disabled:
alertStateNUpperRangeLimit and
alertStateNLowerRangeLimit. |
|
<= |
An alert is executed when the value is less than or equal to
the corresponding alertStateNComparison. It is cleared when the
value is greater than alertStateNComparison if the corresponding
alertStateNValueDeadband is 0. If the corresponding
alertStateNValueDeadband is not 0, the alert will be cleared when
the value is greater than alertStateNComparison plus
alertStateNValueDeadband.
The value and alertStateNComparison must be
numbers.
The
following properties are disabled:
alertStateNUpperRangeLimit and
alertStateNLowerRangeLimit. |
|
>= |
An alert is executed when the value is greater than or equal to
the corresponding alertStateNComparison. It is cleared when the
value is less than alertStateNComparison if the corresponding
alertStateNValueDeadband is 0. If the corresponding
alertStateNValueDeadband is not 0, the alert will be cleared when
the value is less than alertStateNComparison minus
alertStateNValueDeadband.
The value and alertStateNComparison must be
numbers.
The
following properties are disabled:
alertStateNUpperRangeLimit and
alertStateNLowerRangeLimit. |
|
= |
An alert is executed when the value is equal to the
corresponding alertStateNComparison. It is cleared when the value
is not equal to alertStateNComparison.
The value and alertStateNComparison must be
numbers.
The
following properties are disabled:
alertStateNValueDeadband, alertStateNUpperRangeLimit
and alertStateNLowerRangeLimit. |
|
!= |
An alert is executed when the value is not equal to the
corresponding alertStateNComparison. It is cleared when the value
is equal to alertStateNComparison.
The value and alertStateNComparison must be
numbers.
The
following properties are disabled:
alertStateNValueDeadband, alertStateNUpperRangeLimit
and alertStateNLowerRangeLimit. |
|
In Range |
An alert is executed when the value is in the range defined by
alertStateNLowerRangeLimit and alertStateNUpperRangeLimit
(inclusive of the range limits). It is cleared when the value is outside
this range if the corresponding alertStateNValueDeadband is 0. If
the corresponding alertStateNValueDeadband is not 0, the alert
will be cleared when the value is not in the range defined by
alertStateNLowerRangeLimit minus the alertStateNValueDeadband
and alertStateNUpperRangeLimit plus alertStateNValueDeadband.
The value, alertStateNUpperRangeLimit and
alertStateNLowerRangeLimit must be numbers.
The
following property is disabled:
alertStateNComparison. |
|
Out of Range |
An alert is executed when the value is not in the range defined
by alertStateNLowerRangeLimit and alertStateNUpperRangeLimit
(inclusive of the range limits). It is cleared when the value is in this
range if the corresponding alertStateNValueDeadband is 0. If the
corresponding alertStateNValueDeadband is not 0, the alert will
be cleared when the value is in the range defined by
alertStateNLowerRangeLimit minus the alertStateNValueDeadband
and alertStateNUpperRangeLimit plus alertStateNValueDeadband.
The value, alertStateNUpperRangeLimit and
alertStateNLowerRangeLimit must be numbers.
The
following property is disabled:
alertStateNComparison. |
|
Increase |
An alert is executed if the difference between the current
value and the previous value is an increase greater than or equal to
alertStateNComparison. It is cleared if the difference between the
current value and the previous value is not an increase greater than or
equal to alertStateNComparison. Since this condition compares the
current value to the previous value, this alert will never execute until
the alert object has received at least two updates.
The value and alertStateNComparison must be
numbers.
The
following properties are disabled:
alertStateNValueDeadband , alertStateNUpperRangeLimit
and alertStateNLowerRangeLimit. |
|
%Increase |
An alert is executed if the difference between the current
value and the previous value is an increase greater than or equal to
alertStateNComparison percent. It is cleared if the difference
between the current value and the previous value is not an increase
greater than or equal to alertStateNComparison percent. Since
this condition compares the current value to the previous value, this
alert will never execute until the alert object has received at least
two updates.
The value and alertStateNComparison must be
numbers.
The
following properties are disabled:
alertStateNValueDeadband ,alertStateNUpperRangeLimit
and alertStateNLowerRangeLimit. |
|
Decrease |
An alert is executed if the difference between the current
value and the previous value is a decrease greater than or equal to
alertStateNComparison. It is cleared if the difference between the
current value and the previous value is not a decrease greater than or
equal to alertStateNComparison. Since this condition compares the
current value to the previous value, this alert will never execute until
the alert object has received at least two updates.
The value and alertStateNComparison must be
numbers.
The
following properties are disabled:
alertStateNValueDeadband , alertStateNUpperRangeLimit
and alertStateNLowerRangeLimit. |
|
%Decrease |
An alert is executed if the difference between the current
value and the previous value is a decrease greater than or equal to
alertStateNComparison percent. It is cleared if the difference
between the current value and the previous value is not a decrease
greater than or equal to alertStateNComparison percent. Since
this condition compares the current value to the previous value, this
alert will never execute until the alert object has received at least
two updates.
The value and alertStateNComparison must be
numbers.
The
following properties are disabled:
alertStateNValueDeadband, alertStateNUpperRangeLimit
and alertStateNLowerRangeLimit. |
|
Net Change |
An alert is executed if the difference between the current
value and the previous value is an increase or decrease greater than or
equal to alertStateNComparison. It is cleared if the difference
between the current value and the previous value is not an increase or
decrease greater than or equal to alertStateNComparison. Since
this condition compares the current value to the previous value, this
alert will never execute until the alert object has received at least
two updates.
The value and alertStateNComparison must be
numbers.
The
following properties are disabled:
alertStateNValueDeadband, alertStateNUpperRangeLimit
and alertStateNLowerRangeLimit. |
|
% Net Change |
An alert is executed if the difference between the current
value and the previous value is an increase or decrease greater than or
equal to alertStateNComparison percent. It is cleared if the
difference between the current value and the previous value is not an
increase or decrease greater than or equal to alertStateNComparison
percent. Since this condition compares the current value to the previous
value, this alert will never execute until the alert object has received
at least two updates.
The value and alertStateNComparison must be
numbers.
The
following properties are disabled:
alertStateNValueDeadband, alertStateNUpperRangeLimit
and alertStateNLowerRangeLimit. |
|
|
alertStateNComparison |
Specifies the value used for evaluation in the corresponding
alertStateNCondition. Not used when alertStateNCondition is In
Range or Out of Range.
Enter either a scalar or tabular value, or
specify a list of values. |
|
alertStateNUpperRangeLimit |
Specifies the upper value of the range in the corresponding
alertStateNCondition. Used only when alertStateNCondition is
In Range or Out of Range.
Enter either a scalar or tabular value, or
specify a list of values. |
|
alertStateNLowerRangeLimit |
Specifies the lower value of the range in the corresponding
alertStateNCondition. Used only when alertStateNCondition is
In Range or Out of Range.
Enter either a scalar or tabular value, or
specify a list of values. |
|
alertStateNEnabledFlag |
Enables the evaluation of the corresponding
alertStateNCondition. If an alert is executed, the severity for that
alert is set to N. |
|
alertStateNValueDeadband |
Specifies a deadband value for the corresponding
alertStateNCondition. If specified, the
input value combined with this value must not meet the corresponding
alertStateNCondition in order to clear.
For example, if the alertStateNCondition
is >, the alert will execute when value is greater than
alertStateNComparison, and will clear
when the value is less than or equal to
alertStateNComparison minus the deadband. Used only for some
alertStateNCondition types. See the
description for each alertStateNCondition
type for more information on how this property works with that type of
evaluation. |
|
valueTable |
Attach your input data to this property if it is tabular. For
scalar input data, deselect the useTabularData and attach your input
data to the value property. The data attached to this property must
contain two columns, the first column must be an index column containing a
unique value in each row. The second column must contain numeric values to
compare to the thresholds. |
|
