Define
Alert Command
From the Object Properties window
you can access the Define Alert Command dialog. This dialog is used to assign
alert commands allowing you to manage your alerts from within
an Enterprise
RTView
display. If you execute
an alert command from a Thin Client with Direct Data Connection or any Served
Data deployment, the command will execute on the server.
To bring up the Define Alert
Command dialog, right-click on the appropriate command property in the
Object Properties window and select Define Command>ALERT. The
Define Alert Command dialog provides a drop down menu with available commands.
Argument fields vary based on the selected command type.
See
the Object Commands section for
information on how to execute a command.
Command |
Enter
a Command Type |
Data Server |
Select to read data through your configured Data
Server and not directly from alert data.
Default - Select the default Data
Server you configured in Application
Options>Data Server.
None - Bypass data being redirected
through the specified data server(s) for this attachment and instead attach
directly to the data source.
Named Data Servers - Select a
Named Data Server
that you configured in Application Options>Data Server.
|
Command Types
Command
Type |
Description |
Argument |
|
|
Name |
Description |
Acknowledge Alert |
Specify the ID, or list
of IDs, for the alerts to acknowledge. Once
an alert is acknowledged, the AlertTable Acknowledged field
updates and if the reNotificationTime is greater than zero, it does not
re-execute. |
ID |
The ID of the alert to
acknowledge. This can either be a single ID or a semi-colon (;) delimited list
of IDs. |
Add Alert Definition File |
Adds an
Alert
Definition file to the data source. Alerts without names or with duplicate names are not added. |
Alert Definition File |
The name of the
Alert
Definition file. |
Substitution |
Specify substitutions
for this Alert Definition File. Substitutions are optional and must use the following syntax:
$subname:subvalue $subname2:subvalue2
If a substitution value contains
a single quote, it must be escaped using a / :
$filter:Plant=/'Dallas/'
If a substitution value contains
a space, it must be enclosed in single quotes. Do not escape these single
quotes:
$subname:subvalue $subname2:'sub
value 2'
A substitution string cannot contain
the following:
:
|
|
|
.
|
tab
|
space
|
,
|
;
|
=
|
<
|
>
|
'
|
"
|
& |
/ |
\ |
{ |
} |
[ |
] |
( |
) |
|
Enable Alert Definition |
Enables/disables the
specified alert definition object.
NOTE: It is not recommended that you use
this command on an alert that has the enabledFlag property attached to
data. |
Alert Name |
The name of the alert
definition object. |
Enable |
Enter True to enable
and False to disable. |
Enable Alerts |
Enables/disables
all alerts in the active Alert
Definition files. |
Enable |
Enter True to enable
and False to disable. |
Remove Alert Definition |
Removes the
Alert
Definition file from the data source. |
Alert
Definition |
The name of
the Alert
Definition file. |
Substitution |
Specify substitutions
for this Alert Definition file. This must match the substitution used
when the Alert
Definition file was added.
|
Substitutions
Substitutions allow you
to build open-ended displays in which commands depend on values defined
at the time the display is run. Generic names
are used instead of arguments for specific commands. Later when the display
is running, these generic values are defined by the actual arguments. In
this way, a single display can be reused to issue a number of different
commands. Substitutions are not applied to Drill Down or Set Substitution
commands. For more information on creating displays using substitution
values, see Substitutions.
Special Values
$value |
When an actionCommand
is executed $value is replaced with the value from the control. This value
may be used in any field in the Define Alert Command dialog. NOTE: This
value may only be used for Action
Commands. |
The following describes Define
Alert Command dialog commands:
Command |
Description |
OK |
Applies values
and closes the dialog. |
Apply |
Applies values
without closing the dialog. |
Reset |
Resets all fields
to last values applied. |
Clear |
Clears all fields.
Detaches object from assigned command (once Apply or OK is selected). |
Cancel |
Closes the dialog
with last values applied. |
|