RTView® 
User Guide


Alert Types: Limits, Discrete, Multi State and Event

Limits Alerts

Threshold Values
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, two or four 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. NOTE: This format cannot be used if you will be persisting your alerts.
     
  • 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.
     
  • If the specified threshold table has four columns, include the following:
Alert Index
(String)
For single index alerts, this column must contain the alert index.

For multiple column alerts, this column must contain concatenated values for the columns used by the specified Index Type. If you have not defined any index types, this column must contain the concatenated values for all index columns. When concatenating index column values, use the Multiple Index Delimiter as specified in Application Options>Alert Definitions or on the command line. Default is tilde (~).

If the specified Index Type is Default, then use a  value of Default for this column as well.
 

Index Type
(String)
Enter one of the index types specified in the indexTypes property on this alert or one of the two built-in index types:

Default - This value will be used for any indexes that are not specified in this table.

All - The index value will be the concatenated values for all index columns.

NOTE: The Default and All index types are available for both single index and multiple index alerts even if no custom index types are specified in the indexTypes property.
 

Value
(Double)
Enter comparison value to use for rows in the valueTable that match the specified Alert Index.
 
Use Index Value
(Boolean)
Indicate whether or not to use this row. If false, this row will be ignored.
 

When the Alert Index in a row of the valueTable matches more than one of the indexes specified in the threshold table, then the row with an Index Type of All takes precedence. For all other index types, the order in which they are specified on the indexTypes property controls the order of precedence.

In the case where an Alert Index in the valueTable doesn't match any of the Alert Indexes in the threshold table,  then the row with an Index Type set to Default will be used. If there is no row with an Index Type of Default, then the value of rows in the valueTable with indexes that don't match any of the indexes in the threshold table table will be not be evaluated.

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. NOTE: This format cannot be used if you will be persisting your alerts.

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.

 

Alert Text Values
Specify on the AlertText properties (valueHighAlertText, valueHighWarningText, valueLowAlertText, valueLowWarningText) the alert text to display in the Alert Text column of the AlertTable. If no alert text is specified, the default alert text will be used.

Enter a scalar or tabular value. All alert substitutions available on the alertCommand, except $alertText and $alertEmailBody, can be used in the alert text. NOTE: The $alertText and $alertEmailBody substitutions contain the same string shown in the Alert Text column of the AlertTable.

If a tabular value is specified, the input table requires two or four columns:

  • If a two column table is specified, the first must contain indexes and the second must contain alert text values. The index value for each row in the valueTable will be used to look up a corresponding index value in the alert text table. If the index value is not found in the specified alert text table and/or the useTabularDataFlag is not selected, the default alert text will be used.
     
  • If a four column table is specified, include the following:

Alert Index
(String)
For single index alerts, this column must contain the alert index.

For multiple column alerts, this column must contain concatenated values for the columns used by the specified Index Type. If you have not defined any index types, this column must contain the concatenated values for all index columns. When concatenating index column values, use the Multiple Index Delimiter as specified in Application Options>Alert Definitions or on the command line. Default is tilde (~).

If the specified Index Type is Default, then use a  value of Default for this column as well.

Index Type
(String)
One of the index types specified in the indexTypes property on this alert or one of the two built-in index types:

Default - This value will be used for any indexes that are not specified in this table.

All - The index value will be the concatenated values for all index columns.

NOTE: The Default and All index types are available for both single index and multiple index alerts even if no custom index types are specified in the indexTypes property.

Value
(String)
Alert text to display in the Alert Text column of the AlertTable for rows in the valueTable that match the specified Alert Index.
 
Use Index Value
(Boolean)
Indicates whether or not to use this row. If false, this row will be ignored.

When the Alert Index in a row of the valueTable matches more than one of the indexes specified in the AlertText table, then the row with an Index Type of All takes precedence. For all other index types, the order in which they are specified on the indexTypes property controls the order of precedence.

In the case where an Alert Index in the valueTable doesn't match any of the Alert Indexes in the AlertText table, then the row with an Index Type set to Default will be used. If there is no row with an Index Type of Default, then the Alert Text for rows in the valueTable with indexes that don't match any of the indexes in the AlertText table will use the default alert text.

 

Alert Command Text Values
Specify on the alert command text properties (valueHighAlertCommandText, valueHighWarningCommandText, valueLowAlertCommandText, valueLowWarningCommandText) text to use for the $alertCommandText substitution.

Enter a scalar or tabular value. If the value is tabular, the input table requires two or four columns:

  • If a two column table is specified, the first must contain indexes and the second must contain alert command text values. The index value for each row in the valueTable will be used to look up a corresponding index value in the alert command text table. If the index value is not found in the specified alert command text table and/or the useTabularDataFlag is not selected, the $alertCommandText substitution will set to an empty string.
     
  • If a four column table is specified, include the following:

Alert Index
(String)
For single index alerts, this column must contain the alert index.

For multiple column alerts, this column must contain concatenated values for the columns used by the specified Index Type. If you have not defined any index types, this column must contain the concatenated values for all index columns. When concatenating index column values, use the Multiple Index Delimiter as specified in Application Options>Alert Definitions or on the command line. Default is tilde (~).

If the specified Index Type is Default, then use a  value of Default for this column as well.

Index Type
(String)
One of the index types specified in the indexTypes property on this alert or one of the two built-in index types:

Default - This value will be used for any indexes that are not specified in this table.

All - The index value will be the concatenated values for all index columns.

NOTE: The Default and All index types are available for both single index and multiple index alerts even if no custom index types are specified in the indexTypes property.

Value
(String)
Alert command text to use for the $alertCommandText substitution for rows in the valueTable that match the specified Alert Index.
 
Use Index Value
(Boolean)
Indicates whether or not to use this row. If false, this row will be ignored.

When the Index Value in a row of the valueTable matches more than one of the indexes specified, then an Index Type of All takes precedence. For all other index types, the order in which they are specified on the indexTypes property controls the order of precedence.

In the case where an Alert Index in the valueTable doesn't match any of the Alert Indexes, then the row with an Index Type set to Default will be used. If there is no row with an Index Type of Default, then rows in the valueTable with indexes that don't match any of the indexes in this table will will use an empty string for the $alertCommandText substitution.

 

Limits Alert Properties
Property Name Description
alertClearedCommand If specified, this command is executed when an alert is cleared. NOTE: This command supports all of the same alert substitutions as the alertCommand, as well as the following:
Substitution Description
$alertClearedReason Reason the alert was cleared. This is the same value in the Cleared Reason column of the AlertTable
$alertClearedTime Time the alert was cleared. It is the same value in the Cleared Time column of the AlertTable.
alertCommand The action executed when an alert is activated. Any available RTView commands can be used, as well as the following substitutions:
Substitution Description
$alertCommandText Alert command text.
$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 property.
$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. 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 alertName and $region is the substitution string).

commentAddedCommand If specified, this command will be executed after a comment is added to the alert by the Add Comment command. All substitutions supported for alertCommand are also supported for this command, as well as the following two additional substitutions:
Substitution Description
$alertComment This is set to the value of the Comments field for the command after the new comment has been added.
$alertLastComment This is set to the value of the last comment added to the Comments field.

customPropertyMap

Use one or more columns from the valueTable as the value for one or more Custom Alert Definition Properties that you defined in the Custom Alert Fields tab in the Application Options dialog.

Use the following syntax:

customPropName:valueTableColumnName;customPropName2:valueTableColumnName2

For example, if you have a defined a Custom Alert Definition Property named My Custom Property and you want to use the value from the My Data Column column in your valueTable, you would specify the following:

My Custom Property:My Data Column

NOTE: In order to use customPropertyMap, the useTabularDataFlag property must be selected.

description If specified, a description of the alert will be displayed in the Alerts dialog and in the Description column of the Alert Variables Table.
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.
indexColumnNames

Enter one or more index column name(s). If left blank, the alert is assumed to have a single index column and the first column of the valueTable will be used.

For multiple index columns, enter a ; (semicolon) delimited list of column names. The valueTable must contain all specified index columns in addition to, and preceding, the required data column. The combination of all index column values in a single row must uniquely identify that Alert Index.  

indexTypes

For alerts with multiple indexes, create custom index types for use in the following tables (Threshold, Alert Text, Alert Command Text and rowEnabledTable) so you can specify a value for a group of alert indexes instead of having to specify a value for each unique alert index combination.

Use the following syntax to map one or more index columns to an index type:

typeName:columnName;typeName2;columnName1,columnName2

For example:

PerRegion:Region;PerRegionalService:Region,Service

NOTE: Default and All are built-in index types and therefore cannot be entered as a typeName.

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.
reNotificationCommand If specified, this command will be used instead of the value of the alertCommand property for renotifications. Otherwise, the specified alertCommand will be used. NOTE: This command supports all of the same alert substitutions as the alertCommand.
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.

reNotifyOnSevChangeMode Specifies the conditions for alerts to send renotification when the alert severity increases. There are three modes:
  • Renotify on First Sev Change: The alert renotifies when the severity of the alert changes for the first time.
  • Renotify on All Sev Increases: The alert renotifies every time the severity increases.
  • None: Do not renotify when the severity changes.

For the Renotify on First Sev Change and Renotify on All Sev Increases modes, alert renotification only occurs if the alert is either not acknowledged, or the Unacknowledge Alerts on First Severity Change application option is enabled. The renotification executes the reNotificationCommand if configured, otherwise it executes the alertCommand.

By default this option is None.

For the Renotify on First Sev Change and Renotify on All Sev Increases modes, alert renotification only occurs if the alert is not acknowledged. The renotification executes the reNotificationCommand if configured, otherwise it executes the alertCommand. To revert acknowledged alerts to unacknowledged when the severity changes, select the Unacknowledge on Severity Change Mode application option. To update the severity of acknowledged alerts you must select the Update Severity on Acknowledged Alerts application option.

NOTE: When run against alerts configured in an older version of RTView, the correct renotification mode is automatically applied. That is, the reNotifyOnFirstSevChangeFlag property (from an older RTView version) converts to the equivalent value for reNotifyOnSevChangeMode so the alert behavior is the same.

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. NOTE: 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. NOTE: This format cannot be used if you will be persisting your alerts.

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 semi-colon (;) 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. NOTE: This format cannot be used if you will be persisting your alerts.
List of index/enabled value pairs This should be a semi-colon (;) 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.
Tabular data
(four columns)

Specify a four column table that includes:

Alert Index
(String)
For single index alerts, this column must contain the alert index.

For multiple column alerts, this column must contain concatenated values for the columns used by the specified Index Type. If you have not defined any index types, this column must contain the concatenated values for all index columns. When concatenating index column values, use the Multiple Index Delimiter as specified in Application Options>Alert Definitions or on the command line. Default is tilde (~).

If the specified Index Type is Default, then use a  value of Default for this column as well.
 

Index Type
(String)
Enter one of the index types specified in the indexTypes property on this alert or one of the two built-in index types:

Default - This value will be used for any indexes that are not specified in this table.

All - The index value will be the concatenated values for all index columns.

NOTE: The Default and All index types are available for both single index and multiple index alerts even if no custom index types are specified in the indexTypes property.
 

Value
(Boolean)
Enabled value to use for rows in the valueTable that match the specified Alert Index.
 
Use Index Value
(Boolean)
Indicates whether or not to use this row. If false, this row will be ignored.

When the Alert Index in a row of the valueTable matches more than one of the indexes specified in the rowEnabledTable, then the row with an Index Type of All takes precedence. For all other index types, the order in which they are specified on the indexTypes property controls the order of precedence.

In the case where an Alert Index in the valueTable doesn't match any of the Alert Indexes in the rowEnabledTable,  then the row with an Index Type set to Default will be used. If there is no row with an Index Type of Default, then the value of rows in the valueTable with indexes that don't match any of the indexes in the rowEnabledTable table will be false.

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.

NOTE: By default, once an alert is acknowledged the severity of that alert will no longer update. To enable updating the severity of acknowledged alerts you must select the Update Severity on Acknowledged Alerts application option.

timeColumnName Optionally specify a column in the valueTable to be used for the Last Update Time in the AlertTable. 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 useTabularDataFlag and attach your input to valueTable.
value Attach your input data to this property if your input data is scalar. For tabular input data, select the useTabularDataFlag and attach your input data to the valueTable property.
valueCommandFormat Specify the numeric format (using syntax from the Java DecimalFormat class) for the following alertCommand substitutions: $alertCurValue and $alertCompValue. If left blank, values that are eight whole numbers or more will be written in exponential format.
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.
valueHighAlertCommandText Specify alert command text to use for the $alertCommandText substitution. Enter either a scalar or tabular value.
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, the default alert text will be used. Enter either a scalar or tabular value.
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.
valueHighWarningCommandText Specify alert command text to use for the $alertCommandText substitution. Enter either a scalar or tabular value.
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, the default alert text will be used. Enter either a scalar or tabular value.
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.
valueLowAlertCommandText Specify alert command text to use for the $alertCommandText substitution. Enter either a scalar or tabular value.
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, the default alert text will be used. Enter either a scalar or tabular value.
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.
valueLowWarningCommandText Specify alert command text to use for the $alertCommandText substitution. Enter either a scalar or tabular value.
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, the default alert text will be used. Enter either a scalar or tabular value.
valueTable Attach your input data to this property if it is tabular. For scalar input data, deselect the useTabularDataFlag and attach your input data to the value property.

Data attached to the valueTable property must contain at least two columns. The first one or more columns must be index columns. The combination of all index columns must be a unique value for each row and will be used as the Alert Index. If your data contains more than one index column, specify the index column names in the indexColumnNames property. Following the index column(s) must be one data column containing numeric values to compare to the thresholds. Additional columns can be mapped to a Custom Alert Definition Property using the customPropertyMap property.

 


 

Discrete Alerts

Threshold Values
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, two or four 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. NOTE: This format cannot be used if you will be persisting your alerts.
     
  • 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.
     
  • If the specified threshold table has four columns, include the following:
Alert Index
(String)
For single index alerts, this column must contain the alert index.

For multiple column alerts, this column must contain concatenated values for the columns used by the specified Index Type. If you have not defined any index types, this column must contain the concatenated values for all index columns. When concatenating index column values, use the Multiple Index Delimiter as specified in Application Options>Alert Definitions or on the command line. Default is tilde (~).

If the specified Index Type is Default, then use a  value of Default for this column as well.
 

Index Type
(String)
Enter one of the index types specified in the indexTypes property on this alert or one of the two built-in index types:

Default - This value will be used for any indexes that are not specified in this table.

All - The index value will be the concatenated values for all index columns.

NOTE: The Default and All index types are available for both single index and multiple index alerts even if no custom index types are specified in the indexTypes property.
 

Value
(String)
Enter comparison value to use for rows in the valueTable that match the specified Alert Index.
 
Use Index Value
(Boolean)
Indicate whether or not to use this row. If false, this row will be ignored.
 

When the Alert Index in a row of the valueTable matches more than one of the indexes specified in the threshold table, then the row with an Index Type of All takes precedence. For all other index types, the order in which they are specified on the indexTypes property controls the order of precedence.

In the case where an Alert Index in the valueTable doesn't match any of the Alert Indexes in the threshold table, then the row with an Index Type set to Default will be used. If there is no row with an Index Type of Default, then the value of rows in the valueTable with indexes that don't match any of the indexes in the threshold table table will not be evaluated.

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. NOTE: This format cannot be used if you will be persisting your alerts.

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.

 

Alert Text Values
On the AlertText properties (valueHighAlertText, valueMediumAlertText, valueLowAlertText), specify the alert text to display in the Alert Text column of the AlertTable. If no alert text is specified, the default alert text will be used.

Enter a scalar or tabular value. All alert substitutions available on the alertCommand, except $alertText and $alertEmailBody, can be used in the alert text. NOTE: The $alertText and $alertEmailBody substitutions contain the same string shown in the Alert Text column of the AlertTable.

If a tabular value is specified, the input table requires two or four columns:

  • If a two column table is specified, the first must contain indexes and the second must contain alert text values. The index value for each row in the valueTable will be used to look up a corresponding index value in the alert text table. If the index value is not found in the specified alert text table and/or the useTabularDataFlag is not selected, the default alert text will be used.
     
  • If a four column table is specified, include the following:

Alert Index
(String)
For single index alerts, this column must contain the alert index.

For multiple column alerts, this column must contain concatenated values for the columns used by the specified Index Type. If you have not defined any index types, this column must contain the concatenated values for all index columns. When concatenating index column values, use the Multiple Index Delimiter as specified in Application Options>Alert Definitions or on the command line. Default is tilde (~).

If the specified Index Type is Default, then use a  value of Default for this column as well. 

Index Type
(String)
One of the index types specified in the indexTypes property on this alert or one of the two built-in index types:

Default - This value will be used for any indexes that are not specified in this table.

All - The index value will be the concatenated values for all index columns.

NOTE: The Default and All index types are available for both single index and multiple index alerts even if no custom index types are specified in the indexTypes property.

Value
(String)
Alert text to display in the Alert Text column of the AlertTable for rows in the valueTable that match the specified Alert Index.
 
Use Index Value
(Boolean)
Indicates whether or not to use this row. If false, this row will be ignored.

When the Alert Index in a row of the valueTable matches more than one of the indexes specified in the AlertText table, then the row with an Index Type of All takes precedence. For all other index types, the order in which they are specified on the indexTypes property controls the order of precedence.

In the case where an Alert Index in the valueTable doesn't match any of the Alert Indexes in the AlertText table, then the row with an Index Type set to Default will be used. If there is no row with an Index Type of Default, then the Alert Text for rows in the valueTable with indexes that don't match any of the indexes in the AlertText table will use the default alert text.

 

Alert Command Text Values
Specify on the alert command text properties (valueHighAlertCommandText, valueMediumAlertCommandText, valueLowAlertCommandText) text to use for the $alertCommandText substitution.

Enter a scalar or tabular value. If the value is tabular, the input table requires two or four columns:

  • If a two column table is specified, the first must contain indexes and the second must contain alert command text values. The index value for each row in the valueTable will be used to look up a corresponding index value in the alert command text table. If the index value is not found in the specified alert command text table and/or the useTabularDataFlag is not selected, the $alertCommandText substitution will set to an empty string.
     
  • If a four column table is specified, include the following:

Alert Index
(String)
For single index alerts, this column must contain the alert index.

For multiple column alerts, this column must contain concatenated values for the columns used by the specified Index Type. If you have not defined any index types, this column must contain the concatenated values for all index columns. When concatenating index column values, use the Multiple Index Delimiter as specified in Application Options>Alert Definitions or on the command line. Default is tilde (~).

If the specified Index Type is Default, then use a  value of Default for this column as well. 

Index Type
(String)
One of the index types specified in the indexTypes property on this alert or one of the two built-in index types:

Default - This value will be used for any indexes that are not specified in this table.

All - The index value will be the concatenated values for all index columns.

NOTE: The Default and All index types are available for both single index and multiple index alerts even if no custom index types are specified in the indexTypes property.

Value
(String)
Alert command text to use for the $alertCommandText substitution for rows in the valueTable that match the specified Alert Index.
 
Use Index Value
(Boolean)
Indicates whether or not to use this row. If false, this row will be ignored.

When the Index Value in a row of the valueTable matches more than one of the indexes specified, then an Index Type of All takes precedence. For all other index types, the order in which they are specified on the indexTypes property controls the order of precedence.

In the case where an Alert Index in the valueTable doesn't match any of the Alert Indexes, then the row with an Index Type set to Default will be used. If there is no row with an Index Type of Default, then rows in the valueTable with indexes that don't match any of the indexes in this table will will use an empty string for the $alertCommandText substitution.

 

Discrete Alert Properties
 
Property Name Description
alertClearedCommand If specified, this command is executed when an alert is cleared. NOTE: This command supports all of the same alert substitutions as the alertCommand, as well as the following:
Substitution Description
$alertClearedReason Reason the alert was cleared. This is the same value in the Cleared Reason column of the AlertTable
$alertClearedTime Time the alert was cleared. It is the same value in the Cleared Time column of the AlertTable.
alertCommand The action executed when an alert is activated. Any available RTView commands can be used, as well as the following substitutions:
Substitution Description
$alertCommandText Alert command text.
$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 property.
$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. 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 alertName and $region is the substitution string).

commentAddedCommand If specified, this command will be executed after a comment is added to the alert by the Add Comment command. All substitutions supported for alertCommand are also supported for this command, as well as the following two additional substitutions:
Substitution Description
$alertComment This is set to the value of the Comments field for the command after the new comment has been added.
$alertLastComment This is set to the value of the last comment added to the Comments field.

customPropertyMap

Use one or more columns from the valueTable as the value for one or more Custom Alert Definition Properties that you defined in the Custom Alert Fields tab in the Application Options dialog.

Use the following syntax:

customPropName:valueTableColumnName;customPropName2:valueTableColumnName2

For example, if you have a defined a Custom Alert Definition Property named My Custom Property and you want to use the value from the My Data Column column in your valueTable, you would specify the following:

My Custom Property:My Data Column

NOTE: In order to use customPropertyMap, the useTabularDataFlag property must be selected.

description If specified, a description of the alert will be displayed in the Alerts dialog and in the Description column of the Alert Variables Table.
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.
indexColumnNames

Enter one or more index column name(s). If left blank, the alert is assumed to have a single index column and the first column of the valueTable will be used.

For multiple index columns, enter a ; (semicolon) delimited list of column names. The valueTable must contain all specified index columns in addition to, and preceding, the required data column. The combination of all index column values in a single row must uniquely identify that Alert Index.

indexTypes

For alerts with multiple indexes, create custom index types for use in the following tables (Threshold, Alert Text, Alert Command Text and rowEnabledTable) so you can specify a value for a group of alert indexes instead of having to specify a value for each unique alert index combination.

Use the following syntax to map one or more index columns to an index type:

typeName:columnName;typeName2;columnName1,columnName2

For example:

PerRegion:Region;PerRegionalService:Region,Service

NOTE: Default and All are built-in index types and therefore cannot be entered as a typeName.

nonRepetitionTime Amount of time (in seconds) that must pass after a cleared alert is again executed.
reNotificationCommand If specified, this command will be used instead of the value of the alertCommand property for renotifications. Otherwise, the specified alertCommand will be used. NOTE: This command supports all of the same alert substitutions as the alertCommand.
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. NOTE: 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. NOTE: This format cannot be used if you will be persisting your alerts.

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 semi-colon (;) 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. NOTE: This format cannot be used if you will be persisting your alerts.
List of index/enabled value pairs This should be a semi-colon (;) 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.
Tabular data
(four columns)

Specify a four column table that includes:

Alert Index
(String)
For single index alerts, this column must contain the alert index.

For multiple column alerts, this column must contain concatenated values for the columns used by the specified Index Type. If you have not defined any index types, this column must contain the concatenated values for all index columns. When concatenating index column values, use the Multiple Index Delimiter as specified in Application Options>Alert Definitions or on the command line. Default is tilde (~).

If the specified Index Type is Default, then use a  value of Default for this column as well.
 

Index Type
(String)
Enter one of the index types specified in the indexTypes property on this alert or one of the two built-in index types:

Default - This value will be used for any indexes that are not specified in this table.

All - The index value will be the concatenated values for all index columns.

NOTE: The Default and All index types are available for both single index and multiple index alerts even if no custom index types are specified in the indexTypes property.
 

Value
(Boolean)
Enabled value to use for rows in the valueTable that match the specified Alert Index.
 
Use Index Value
(Boolean)
Indicates whether or not to use this row. If false, this row will be ignored.

When the Alert Index in a row of the valueTable matches more than one of the indexes specified in the rowEnabledTable, then the row with an Index Type of All takes precedence. For all other index types, the order in which they are specified on the indexTypes property controls the order of precedence.

In the case where an Alert Index in the valueTable doesn't match any of the Alert Indexes in the rowEnabledTable,  then the row with an Index Type set to Default will be used. If there is no row with an Index Type of Default, then the value of rows in the valueTable with indexes that don't match any of the indexes in the rowEnabledTable table will be false.

timeColumnName Optionally specify a column in the valueTable to be used for the Last Update Time in the AlertTable. 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 useTabularDataFlag and attach your input to valueTable.
value Attach your input data to this property if your input data is scalar. For tabular input data, select the useTabularDataFlag 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.  
valueHighAlertCommandText Specify alert command text to use for the $alertCommandText substitution. Enter either a scalar or tabular value.
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, the default alert text will be used. Enter a scalar or tabular value
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.
valueLowAlertCommandText Specify alert command text to use for the $alertCommandText substitution. Enter either a scalar or tabular value.
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, the default alert text will be used. Enter a scalar or tabular value.
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.
valueMediumAlertCommandText Specify alert command text to use for the $alertCommandText substitution. Enter either a scalar or tabular value.
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, the default alert text will be used. Enter a scalar or tabular value.
valueTable Attach your input data to this property if it is tabular. For scalar input data, deselect the useTabularDataFlag and attach your input data to the value property.

Data attached to the valueTable property must contain at least two columns. The first one or more columns must be index columns. The combination of all index columns must be a unique value for each row and will be used as the Alert Index. If your data contains more than one index column, specify the index column names in the indexColumnNames property. Following the index column(s) must be one data column containing values to compare to the thresholds. Additional columns can be mapped to a Custom Alert Definition Property using the customPropertyMap property.

 


 

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, two or four 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. NOTE: This format cannot be used if you will be persisting your alerts.
     

  • 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).
     

  • If the specified alertStateNComparison, alertStateNLowerRangeLimit or alertStateNUpperRangeLimit table has four columns, include the following:

    Alert Index
    (String)
    For single index alerts, this column must contain the alert index.

    For multiple column alerts, this column must contain concatenated values for the columns used by the specified Index Type. If you have not defined any index types, this column must contain the concatenated values for all index columns. When concatenating index column values, use the Multiple Index Delimiter as specified in Application Options>Alert Definitions or on the command line. Default is tilde (~).

    If the specified Index Type is Default, then use a  value of Default for this column as well.
     

    Index Type
    (String)
    Enter one of the index types specified in the indexTypes property on this alert or one of the two built-in index types:

    Default - This value will be used for any indexes that are not specified in this table.

    All - The index value will be the concatenated values for all index columns.

    NOTE: The Default and All index types are available for both single index and multiple index alerts even if no custom index types are specified in the indexTypes property.
     

    Value
    (Double)
    Enter comparison value to use for rows in the valueTable that match the specified Alert Index.
     
    Use Index Value
    (Boolean)
    Indicate whether or not to use this row. If false, this row will be ignored.
     

    When the Alert Index in a row of the valueTable matches more than one of the indexes specified in the threshold table, then the row with an Index Type of All takes precedence. For all other index types, the order in which they are specified on the indexTypes property controls the order of precedence.

    In the case where an Alert Index in the valueTable doesn't match any of the Alert Indexes in the threshold table,  then the row with an Index Type set to Default will be used. If there is no row with an Index Type of Default, then the value of rows in the valueTable with indexes that don't match any of the indexes in the threshold table table will not be evaluated.

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. NOTE: This format cannot be used if you will be persisting your alerts.

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

alertClearedCommand If specified, this command is executed when an alert is cleared. NOTE: This command supports all of the same alert substitutions as the alertCommand, as well as the following:
Substitution Description
$alertClearedReason Reason the alert was cleared. This is the same value in the Cleared Reason column of the AlertTable
$alertClearedTime Time the alert was cleared. It is the same value in the Cleared Time column of the AlertTable.

alertCommand

The action executed when an alert is activated. Any available RTView commands can be used, as well as the following substitutions:

Substitution

Description

$alertCommandText Alert command text.

$alertID

Unique ID for the alert.

$alertCompValue

Comparison value.

$alertCurValue

Current input value.

$alertName

Value from the alertName property.

$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 alertName and $region is the substitution string).

alertStateNAlertCommandText Specify alert command text to use for the $alertCommandText substitution.

Enter a scalar or tabular value. If the value is tabular, the input table requires two or four columns:

  • If a two column table is specified, the first must contain indexes and the second must contain alert command text values. The index value for each row in the valueTable will be used to look up a corresponding index value in the alert command text table. If the index value is not found in the specified alert command text table and/or the useTabularDataFlag is not selected, the $alertCommandText substitution will set to an empty string.
     
  • If a four column table is specified, include the following:

Alert Index
(String)
For single index alerts, this column must contain the alert index.

For multiple column alerts, this column must contain concatenated values for the columns used by the specified Index Type. If you have not defined any index types, this column must contain the concatenated values for all index columns. When concatenating index column values, use the Multiple Index Delimiter as specified in Application Options>Alert Definitions or on the command line. Default is tilde (~).

If the specified Index Type is Default, then use a  value of Default for this column as well.
 

Index Type
(String)
One of the index types specified in the indexTypes property on this alert or one of the two built-in index types:

Default - This value will be used for any indexes that are not specified in this table.

All - The index value will be the concatenated values for all index columns.

NOTE: The Default and All index types are available for both single index and multiple index alerts even if no custom index types are specified in the indexTypes property.

Value
(String)
Alert command text to use for the $alertCommandText substitution for rows in the valueTable that match the specified Alert Index.
 
Use Index Value
(Boolean)
Indicates whether or not to use this row. If false, this row will be ignored.

When the Index Value in a row of the valueTable matches more than one of the indexes specified, then an Index Type of All takes precedence. For all other index types, the order in which they are specified on the indexTypes property controls the order of precedence.

In the case where an Alert Index in the valueTable doesn't match any of the Alert Indexes, then the row with an Index Type set to Default will be used. If there is no row with an Index Type of Default, then rows in the valueTable with indexes that don't match any of the indexes in this table will use an empty string for the $alertCommandText substitution.

alertStateNAlertText

Specify the alert text to display in the Alert Text column of the AlertTable. If no alert text is specified, the following is used:

Alert State N condition met: current value XX > comparison value YY

If a tabular value is specified, the input table requires two columns or four columns:

  • If a two column table is specified, the first must contain indexes and the second must contain alert text values. The index value for each row in the valueTable will be used to look up a corresponding index value in the alert text table. If the index value is not found in the specified alert text table and/or the useTabularDataFlag is not selected, the default alert text will be used.
     
  • If a four column table is specified, include the following:

Alert Index
(String)
For single index alerts, this column must contain the alert index.

For multiple column alerts, this column must contain concatenated values for the columns used by the specified Index Type. If you have not defined any index types, this column must contain the concatenated values for all index columns. When concatenating index column values, use the Multiple Index Delimiter as specified in Application Options>Alert Definitions or on the command line. Default is tilde (~).

If the specified Index Type is Default, then use a  value of Default for this column as well.
 

Index Type
(String)
One of the index types specified in the indexTypes property on this alert or one of the two built-in index types:

Default - This value will be used for any indexes that are not specified in this table.

All - The index value will be the concatenated values for all index columns.

NOTE: The Default and All index types are available for both single index and multiple index alerts even if no custom index types are specified in the indexTypes property.

Value
(String)
Alert text to display in the Alert Text column of the AlertTable for rows in the valueTable that match the specified Alert Index.
 
Use Index Value
(Boolean)
Indicates whether or not to use this row. If false, this row will be ignored.

When the Alert Index in a row of the valueTable matches more than one of the indexes specified in the AlertText table, then the row with an Index Type of All takes precedence. For all other index types, the order in which they are specified on the indexTypes property controls the order of precedence.

In the case where an Alert Index in the valueTable doesn't match any of the Alert Indexes in the AlertText table, then the row with an Index Type set to Default will be used. If there is no row with an Index Type of Default, then the Alert Text for rows in the valueTable with indexes that don't match any of the indexes in the AlertText table will use the default alert text.

The following substitutions are supported in the alert text. NOTE: The $alertText and $alertEmailBody substitutions contain the same string shown in the Alert Text column of the AlertTable.

Substitution

Description

$alertID

The unique ID for the alert.

$alertCompValue

The comparison value.

$alertCurValue

The current input value.

$alertName

The value from the alertName property.

$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.

commentAddedCommand If specified, this command will be executed after a comment is added to the alert by the Add Comment command. All substitutions supported for alertCommand are also supported for this command, as well as the following two additional substitutions:
Substitution Description
$alertComment This is set to the value of the Comments field for the command after the new comment has been added.
$alertLastComment This is set to the value of the last comment added to the Comments field.

customPropertyMap

Use one or more columns from the valueTable as the value for one or more Custom Alert Definition Properties that you defined in the Custom Alert Fields tab in the Application Options dialog.

Use the following syntax:

customPropName:valueTableColumnName;customPropName2:valueTableColumnName2

For example, if you have a defined a Custom Alert Definition Property named My Custom Property and you want to use the value from the My Data Column column in your valueTable, you would specify the following:

My Custom Property:My Data Column

NOTE: In order to use customPropertyMap, the useTabularDataFlag property must be selected.

description If specified, a description of the alert will be displayed in the Alerts dialog and in the Description column of the Alert Variables Table.

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.

indexColumnNames

Enter one or more index column name(s). If left blank, the alert is assumed to have a single index column and the first column of the valueTable will be used.

For multiple index columns, enter a ; (semicolon) delimited list of column names. The valueTable must contain all specified index columns in addition to, and preceding, the required data column. The combination of all index column values in a single row must uniquely identify that Alert Index.

indexTypes

For alerts with multiple indexes, create custom index types for use in the following tables (alertStateNAlertText, alertStateNAlertCommandText and rowEnabledTable) so you can specify a value for a group of alert indexes instead of having to specify a value for each unique alert index combination.

Use the following syntax to map one or more index columns to an index type:

typeName:columnName;typeName2;columnName1,columnName2

For example:

PerRegion:Region;PerRegionalService:Region,Service

NOTE: Default and All are built-in index types and therefore cannot be entered as a typeName. 

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.

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.

reNotificationCommand If specified, this command will be used instead of the value of the alertCommand property for renotifications. Otherwise, the specified alertCommand will be used. NOTE: This command supports all of the same alert substitutions as the alertCommand.
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.

reNotifyOnSevChangeMode Specifies the conditions for alerts to send renotification when the alert severity increases. There are three modes:
  • Renotify on First Sev Change: The alert renotifies when the severity of the alert changes for the first time.
  • Renotify on All Sev Increases: The alert renotifies every time the severity increases.
  • None: Do not renotify when the severity changes.

For the Renotify on First Sev Change and Renotify on All Sev Increases modes, alert renotification only occurs if the alert is either not acknowledged, or the Unacknowledge Alerts on First Severity Change application option is enabled. The renotification executes the reNotificationCommand if configured, otherwise it executes the alertCommand.

By default this option is None.

For the Renotify on First Sev Change and Renotify on All Sev Increases modes, alert renotification only occurs if the alert is not acknowledged. The renotification executes the reNotificationCommand if configured, otherwise it executes the alertCommand. To revert acknowledged alerts to unacknowledged when the severity changes, select the Unacknowledge on Severity Change Mode application option. To update the severity of acknowledged alerts you must select the Update Severity on Acknowledged Alerts application option.

NOTE: When run against alerts configured in an older version of RTView, the correct renotification mode is automatically applied. That is, the reNotifyOnFirstSevChangeFlag property (from an older RTView version) converts to the equivalent value for reNotifyOnSevChangeMode so the alert behavior is the same.

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. NOTE: 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. NOTE: This format cannot be used if you will be persisting your alerts.

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 semi-colon (;) 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. NOTE: This format cannot be used if you will be persisting your alerts.
List of index/enabled value pairs This should be a semi-colon (;) 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.
Tabular data
(four columns)

Specify a four column table that includes:

Alert Index
(String)
For single index alerts, this column must contain the alert index.

For multiple column alerts, this column must contain concatenated values for the columns used by the specified Index Type. If you have not defined any index types, this column must contain the concatenated values for all index columns. When concatenating index column values, use the Multiple Index Delimiter as specified in Application Options>Alert Definitions or on the command line. Default is tilde (~).

If the specified Index Type is Default, then use a  value of Default for this column as well.
 

Index Type
(String)
Enter one of the index types specified in the indexTypes property on this alert or one of the two built-in index types:

Default - This value will be used for any indexes that are not specified in this table.

All - The index value will be the concatenated values for all index columns.

NOTE: The Default and All index types are available for both single index and multiple index alerts even if no custom index types are specified in the indexTypes property.
 

Value
(Boolean)
Enabled value to use for rows in the valueTable that match the specified Alert Index.
 
Use Index Value
(Boolean)
Indicates whether or not to use this row. If false, this row will be ignored.

When the Alert Index in a row of the valueTable matches more than one of the indexes specified in the rowEnabledTable, then the row with an Index Type of All takes precedence. For all other index types, the order in which they are specified on the indexTypes property controls the order of precedence.

In the case where an Alert Index in the valueTable doesn't match any of the Alert Indexes in the rowEnabledTable,  then the row with an Index Type set to Default will be used. If there is no row with an Index Type of Default, then the value of rows in the valueTable with indexes that don't match any of the indexes in the rowEnabledTable table will be false.

skipDuplicateAlertsFlag

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. If deselected, an alert will be issued for each alertStateNCondition that evaluates to true.

NOTE: By default, once an alert is acknowledged the severity of that alert will no longer update. To enable updating the severity of acknowledged alerts you must select the Update Severity on Acknowledged Alerts application option.

timeColumnName Optionally specify a column in the valueTable to be used for the Last Update Time in the AlertTable. 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 useTabularDataFlag and attach your input to valueTable.

value

Attach your input data to this property if your input data is scalar. For tabular input data, select the useTabularDataFlag property and attach your input data to the valueTable property.

valueCommandFormat Specify the numeric format (using syntax from the Java DecimalFormat class) for the following alertCommand substitutions: $alertCurValue and $alertCompValue. If left blank, values that are eight whole numbers or more will be written in exponential format.

valueTable

Attach your input data to this property if it is tabular. For scalar input data, deselect the useTabularDataFlag and attach your input data to the value property.

Data attached to the valueTable property must contain at least two columns. The first one or more columns must be index columns. The combination of all index columns must be a unique value for each row and will be used as the Alert Index. If your data contains more than one index column, specify the index column names in the indexColumnNames property. Following the index column(s) must be one data column containing numeric values to compare to the thresholds. Additional columns can be mapped to a Custom Alert Definition Property using the customPropertyMap property.

 


 

Event Alerts
The Event alert is meant to be used as a wrapper around an external event source such as IBM® Netcool. For this alert, RTView does not do a threshold comparison to determine when to execute/clear an alert or to determine the severity of the alert. Instead, columns in the valueTable are mapped to the columns in the RTView AlertTable using the valueTableMap and customPropertyMap properties.

Event alerts behave like the other alerts in terms of notifications (i.e. alertCommand, reNotificationCommand, commentAddedCommand, alertClearedCommand). They also appear in the AlertTable like the other alerts. However, Event alerts do not have a corresponding per-tabular-alert-table like Limits and Discrete alerts. If indexed, the indexes for these alerts are only stored until the alert is cleared and then removed.

The valueTable for this alert does not have to be indexed. In order to indicate that you have an index, map the Alert Index property to the index column in your valueTable using the valueTableMap.

  • If no Alert Index is specified in the valueTableMap, this indicates that the valueTable is not indexed and an alert will be generated for each row of each table. No check for duplicates and no support for status change is supported. This means that the only way for an alert to be cleared is via the alertExpireTime property, which will clear the alert after it has been active for the specified amount of time.
  • If there is an Alert Index specified in the valueTableMap, this indicates that the valueTable is indexed. In this case, an alert will be generated for each row where there is not already an active alert for that index. Indexed alerts can be cleared via the valueTable if the Cleared column is also specified in the valueTableMap. NOTE: The value in the Cleared column must equal the alertClearedValue property. Indexed alerts can also be cleared via alertExpireTime. Indexed alerts support updates to the Severity, Cleared and Custom Property columns.
Property Name Description
alertClearedCommand If specified, this command is executed when an alert is cleared. NOTE: This command supports all of the same alert substitutions as the alertCommand, as well as the following:
Substitution Description
$alertClearedReason Reason the alert was cleared. This is the same value in the Cleared Reason column of the AlertTable
$alertClearedTime Time the alert was cleared. It is the same value in the Cleared Time column of the AlertTable.
alertClearedValue The value specified here will be compared to the value in the Cleared column from the valueTableMap. If they match, the alert will be cleared.

The alertClearedValue property is only supported if there is an Alert Index specified in the valueTableMap property. If no Alert Index is specified, the only way for an alert to be cleared is via the alertExpireTime property.

alertCommand The action executed when an alert is activated. Any available RTView commands can be used, as well as the following substitutions:
Substitution Description
$alertCommandText Alert command text.
$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 property.
$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.
alertExpireTime Specify (in seconds) how long an alert can remain active before it is cleared. NOTE: Alerts will be cleared regardless of whether an alert has been acknowledged or not.
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 alertName and $region is the substitution string).

commentAddedCommand If specified, this command will be executed after a comment is added to the alert by the Add Comment command. All substitutions supported for alertCommand are also supported for this command, as well as the following two additional substitutions:
Substitution Description
$alertComment This is set to the value of the Comments field for the command after the new comment has been added.
$alertLastComment This is set to the value of the last comment added to the Comments field.

customPropertyMap

Use one or more columns from the valueTable as the value for one or more Custom Alert Definition Properties that you defined in the Custom Alert Fields tab in the Application Options dialog.

Use the following syntax:

customPropName:valueTableColumnName;customPropName2:valueTableColumnName2

For example, if you have a defined a Custom Alert Definition Property named My Custom Property and you want to use the value from the My Data Column column in your valueTable, you would specify the following:

My Custom Property:My Data Column

description If specified, a description of the alert will be displayed in the Alerts dialog and in the Description column of the Alert Variables Table.

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.

indexColumnNames

Enter one or more index column name(s). If left blank, the Alert Index value in the valueTableMap will be used. For multiple index columns, enter a ; (semicolon) delimited list of column names. The combination of all index column values in a single row must uniquely identify that Alert Index.  

NOTE: If the valueTableMap contains an index column and indexColumnNames is specified, the indexColumnNames property takes precedence.

indexTypes

For alerts with multiple indexes, create custom index types for use in the rowEnabledTable so you can specify a value for a group of alert indexes instead of having to specify a value for each unique alert index combination.

Use the following syntax to map one or more index columns to an index type:

typeName:columnName;typeName2;columnName1,columnName2

For example:

PerRegion:Region;PerRegionalService:Region,Service

NOTE: Default and All are built-in index types and therefore cannot be entered as a typeName. 

reNotificationCommand If specified, this command will be used instead of the value of the alertCommand property for renotifications. Otherwise, the specified alertCommand will be used. NOTE: This command supports all of the same alert substitutions as the alertCommand.
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 severity of an alert 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.

reNotifyOnSevChangeMode Specifies the conditions for alerts to send renotification when the alert severity increases. There are three modes:
  • Renotify on First Sev Change: The alert renotifies when the severity of the alert changes for the first time.
  • Renotify on All Sev Increases: The alert renotifies every time the severity increases.
  • None: Do not renotify when the severity changes.

For the Renotify on First Sev Change and Renotify on All Sev Increases modes, alert renotification only occurs if the alert is either not acknowledged, or the Unacknowledge Alerts on First Severity Change application option is enabled. The renotification executes the reNotificationCommand if configured, otherwise it executes the alertCommand.

By default this option is None.

For the Renotify on First Sev Change and Renotify on All Sev Increases modes, alert renotification only occurs if the alert is not acknowledged. The renotification executes the reNotificationCommand if configured, otherwise it executes the alertCommand. To revert acknowledged alerts to unacknowledged when the severity changes, select the Unacknowledge on Severity Change Mode application option. To update the severity of acknowledged alerts you must select the Update Severity on Acknowledged Alerts application option.

NOTE: When run against alerts configured in an older version of RTView, the correct renotification mode is automatically applied. That is, the reNotifyOnFirstSevChangeFlag property (from an older RTView version) converts to the equivalent value for reNotifyOnSevChangeMode so the alert behavior is the same.

rowEnabledTable

The rowEnabledTable property is only supported if there is an Alert Index specified in the valueTableMap property.

Sets the enabled state for each row in the valueTable, so you can enable or disable each index in a tabular alert. 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. NOTE: This format cannot be used if you will be persisting your alerts.

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 semi-colon (;) 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. NOTE: This format cannot be used if you will be persisting your alerts.
List of index/enabled value pairs This should be a semi-colon (;) 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.
Tabular data
(four columns)

Specify a four column table that includes:

Alert Index
(String)
For single index alerts, this column must contain the alert index.

For multiple column alerts, this column must contain concatenated values for the columns used by the specified Index Type. If you have not defined any index types, this column must contain the concatenated values for all index columns. When concatenating index column values, use the Multiple Index Delimiter as specified in Application Options>Alert Definitions or on the command line. Default is tilde (~).

If the specified Index Type is Default, then use a  value of Default for this column as well.
 

Index Type
(String)
Enter one of the index types specified in the indexTypes property on this alert or one of the two built-in index types:

Default - This value will be used for any indexes that are not specified in this table.

All - The index value will be the concatenated values for all index columns.

NOTE: The Default and All index types are available for both single index and multiple index alerts even if no custom index types are specified in the indexTypes property.
 

Value
(Boolean)
Enabled value to use for rows in the valueTable that match the specified Alert Index.
 
Use Index Value
(Boolean)
Indicates whether or not to use this row. If false, this row will be ignored.

When the Alert Index in a row of the valueTable matches more than one of the indexes specified in the rowEnabledTable, then the row with an Index Type of All takes precedence. For all other index types, the order in which they are specified on the indexTypes property controls the order of precedence.

In the case where an Alert Index in the valueTable doesn't match any of the Alert Indexes in the rowEnabledTable,  then the row with an Index Type set to Default will be used. If there is no row with an Index Type of Default, then the value of rows in the valueTable with indexes that don't match any of the indexes in the rowEnabledTable table will be false.

valueTable This table is required, but all columns are optional. Use the valueTableMap property to map one or more columns in your data to standard columns in the AlertTable. If your events are indexed with more than one column, use the indexColumnNames property to map your multiple index columns to the Alert Index. Additional columns can be mapped to a Custom Alert Definition Property using the customPropertyMap property.
valueTableMap Map one or more items in the valueTable to standard columns in the AlertTable. Use the following syntax:

AlertProp:valueTableCol;AlertProp2:valueTableCol2

The following Alert properties are supported, but none are required:

Alert Index If specified, this is used as the index column and will be used in the Alert Index column of the AlertTable. The Cleared column and alertClearedValue and rowEnabledTable properties will be supported.

If not specified, this is an un-indexed table and any new rows coming in to the valueTable will just be forwarded to the AlertTable with no way to update an existing row.
 

Time If specified, this time will be used in the Last Update Time column of the AlertTable. The data type of the value of this column must be Long or Date.

If not specified, RTView will set the Last Update Time to the time the alert received the last update.
 

Severity If specified, this column must contain integers > 0. If a value less than 1 is specified, a value of 1 will be used. This column will be used to set the value in the Severity column of the AlertTable. The severity of an alert will update whenever the mapped column changes.

If not specified, RTView will assign all alerts a Severity value of 1.

NOTE: To enable updating the severity of acknowledged alerts you must select the Update Severity on Acknowledged Alerts application option.

Alert Text If specified, the value in this column will be used in the Alert Text field of the AlertTable.

If not specified, RTView will assign an Alert Text of Event Received.
 

Cleared If specified, the value in this column will be compared to the alertClearedValue property. If they match, the alert will be cleared.

This is only supported if an Alert Index was specified. If no Alert Index is specified, the only way for an alert to be cleared is via the alertExpireTime property.

 

 
SL, SL-GMS, GMS, RTView, SL Corporation, and the SL logo are trademarks or registered trademarks of Sherrill-Lubinski Corporation in the United States and other countries. Copyright © 1998-2012 Sherrill-Lubinski Corporation. All Rights Reserved.

 

JMS, JMX and Java are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries. They are mentioned in this document for identification purposes only. 

 

Third Party Notice Requirements