Define
System Command
From the Object Properties
window you can access the Define System Command dialog. This dialog is
used to assign system commands allowing you to issue commands. Commands can be
executed from within
an RTView
display in the client (the Builder,
Viewer or Display Server). Additionally, several commands can be executed
on
a Data Server (the Execute Custom Command, Execute URL, Run DOS
Command or Unix Shell, Send Email and Send SNMP Trap
commands). For details, see
Execute Commands on a Data Server. By default, commands execute on
the client.
To bring up the Define System
Command dialog, right-click on the appropriate command property in the
Object Properties window and select Define Command>SYSTEM. The
Define System Command dialog provides a drop down menu with available commands.
When a command can execute on a Data
Server, the Data Server drop down menu appears at the bottom of the
dialog. Argument fields vary based on the selected command type.
See
the Object Commands section for
information on how to execute a command.
Command Types
The following commands are executed in the
client or, where indicated, can also be redirected to a Data Server.
Command
Type |
Description |
Beep |
Plays the system
default audio beep. This command does not work in the Display Server.
NOTE: If you
execute this command from one of the Served Data deployments, this command will execute on the client. |
Close
Window |
Closes the window
specified in the Window Name
argument. If no Window Name is given it closes the window containing
the object that generated the command. This command cannot be used to close
the main window.
NOTE: If you execute this command from a Thin Client with Direct Data
Connection or any Served Data deployment, this
command will execute on the client. |
Drill
Down or Set Substitution |
Drill down to
a new display or set substitutions on the current display. Click on Edit
Drill Down Target to open the Drill Down
Properties dialog and define your drill down or substitution. Substitutions
are not applied to this command before it is executed.
In the Drill Down Properties dialog, to
attach one of the following fields to data,
right-click and choose Attach to Data or double-click in the field:
- Drill Down Display Name
- Window Title
- Drill Down Substitution Value
NOTE: If you execute this
command from a Thin Client with Direct Data Connection or any Served Data deployment, this command will execute on the client. |
Execute
Custom Command |
Executes the
custom command in the Command Name field with the specified Command Value.
You may define your own custom commands in the Custom
Command Handler. The specified Command Name and Command Value will
be passed into the invokeCommand method in the Custom Command Handler.
If you execute this
command in a Thin Client deployment, it will execute on the server if
implemented in Java and on the client if implemented in JavaScript.
NOTE: If you execute this command from
from one of the Served Data deployments, this command will execute on the server.
Otherwise, this command executes on the client.
This command can also
execute on a Data Server. |
Execute
URL |
Executes the
specified URL String. This can be used to execute JSP, ASP or CGI scripts.
This command will not open the specified URL in a browser.
NOTE: If you execute this command from a Thin
Client with Direct Data Connection or any Served Data deployment, this command will execute on the client.
This command can also
execute on a Data Server. |
Open
Browser |
Opens the specified URL
in a browser window. Select Current, Parent, Top,
New,
or Named in the Browser Window property to set which window the
page will come up in. New is the default setting.
NOTE: If you execute this command from a Thin
Client with Direct Data Connection or any Served Data deployment, this command will execute on the client. |
Play
Audio File |
Plays the specified
audio file. The File Name should include a relative path from your RTView display to the audio file. This command does not work in the Display
Server.
NOTE: If you execute this
command from one of the Served Data deployments,
this command will execute on the client. |
Run
DOS Command or UNIX Shell |
Executes the
specified DOS command or UNIX Shell. This will be executed in the directory
where you started RTView.
NOTE: This command does not work in the
Display Viewer Applet or in the Display Server.
This command can also
execute on a Data Server. |
Send Email |
Sends the specified email
message. NOTE: Multiple addresses or attachments should be separated by spaces or commas.
Contact your system administrator for SMTP
Host address and SMTP Port number. SMTP Port field is optional. If left blank,
SMTP Port 25 is used.
User and Password
fields are optional, unless authenticated mail sever access is required. This
command executes on the server.
NOTE: This command requires additional
setup when used with the Display Viewer Applet.
Attachments are not supported in the Display Viewer Applet.
This command can also
execute on a Data Server. |
Send SNMP Trap |
Enables a display to send
an SNMP Trap message, such as would be sent from an SNMP Agent to a SNMP
Management Station. Requires
outgoing access to UDP port 162 (or a different port as specified in your
command).
NOTE: If you execute this command from a thin-client deployment it
will execute on the server, otherwise it will execute on the client.
This command can also
execute on a Data Server.
Use the following fields to define your
SNMP Trap Message:
Field Name |
Description |
Trap Type |
SNMP
version of the trap. |
Destination Address |
System
name or IP address of the receiving system. Default value is
127.0.0.1 (localhost). To attach the
Destination Address to data, right-click and choose Attach to Data or
double-click in the field. |
Destination Port |
UDP
port on the receiving system. Default value is 162. Value
must be an integer greater than 0. To
attach a Destination Port to data, right-click and choose Attach to Data
or double-click in the field. |
Community Name |
SNMPv2 Community Name string. Default value is public.
To attach the Community Name to data, right-click
and choose Attach to Data or double-click in the field. |
Enterprise OID |
SNMP
Object ID to be used as the sender's Enterprise. Default value is
1.3.6.1.6.3.1.1.5. |
Generic Trap |
List of
generic traps. |
Specific Trap |
List of
specific traps available will depend on the property for which you are
defining a command. NOTE: The Generic Trap selected must be
enterpriseSpecific to enable this menu.
Currently the only Specific Trap
option is Alert, which is available if you are defining a command for
the alertCommand property. The Alert trap is sent with the
name rtviewAlert and includes the following MIB definition:
rtview OBJECT IDENTIFIER ::= { sl 1 }
rtviewNotifications OBJECT IDENTIFIER ::= { rtview 1 }
rtviewAlert NOTIFICATION-TYPE
OBJECTS {
rtviewAlertName,
rtviewAlertIndex,
rtviewAlertTime,
rtviewAlertLastUpdateTime,
rtviewAlertSeverity,
rtviewAlertText,
rtviewAlertID,
rtviewAlertLabel,
rtviewAlertCommandText,
rtviewAlertCurrentValue,
rtviewAlertComparisonValue
}
::= { rtviewNotifications 2 }
NOTE: Traps sent by RTView use
Enterprise OID private.enterprises.sl (.1.3.6.1.4.1.34605). |
|
Execute Commands on a
Data Server The Data Server drop
down menu appears at the bottom of the dialog when a command can be executed on
a Data Server. Drop down menu options are:
- none: Sets the command
to execute on the client. This is the default.
- default: Sets the command to execute
on the default Data Server. If there is no connection defined for
that Data Server, the command is not executed.
- Enter a named Data Server: Enter a named
Data Server in the Data Server field on which to execute the command.
If there is no connection defined for that Data Server, the command is not
executed.
- Substitution: Enter a substitution in
the Data Server field, such as $server.
For example:
$server: |
An empty string sets the command to execute on
the client. |
$server:__none |
__none sets the command to execute on the
client. NOTE: This value starts with two underscore characters. |
$server:__default |
__default sets the command to
execute on the default Data Server. If there is no connection defined for that
Data Server, the command is not executed. NOTE: This value starts with two
underscore characters. |
$server:SalesDS |
A named Data Server sets the command
to execute on the named Data Server. If there is no connection defined for that
Data Server, the command is not executed. |
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 System Command dialog. NOTE: This
value may only only be used for Action
Commands. |
The following describes Define
System 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. |
|