Enterprise RTView® 
User Guide


Define/Execute Command

There are several types of commands you can assign to objects with Enterprise RTView, including custom commands. Commands can be setup to execute when you click on an object or automatically execute the command when the value of an object reaches a specified threshold.

Depending on which data sources are licensed in your Enterprise RTView application, there are several commands that can be assigned to an object. For information on the Define Command dialog for your data source, refer to the Data Sources section of this documentation. NOTE: Some data sources do not support commands.

How your command is executed depends on the type of command. There are three types of commands:

  • Commands
  • Threshold Commands

Commands
Commands work with the Display Builder, Display Viewer, Display Viewer Applet, and the Display Server. When you deploy Enterprise RTView as a Thin Client Browser or Served Data deployment, depending on the command, it is executed either on the server or the client. See command descriptions for information on where commands are executed.

Define Command
For Control Objects, assign a command by right-clicking on actionCommand in the Object Properties window. For all other objects, assign a command by right-clicking on command in the Object Properties window. Select Define Command and choose SYSTEM, ALERT, MULTIPLE or your data source. For information on the Define Command dialog for your data source, refer to the Data Sources section of this documentation. NOTE: Some data sources do not support commands.

Execute Command
Once a command has been assigned to a control object, it is executed when the control object is activated. For more information on how each control object is activated, see the Controls section. For all other objects, double-click on the object in the Display Builder, single-click in the Display Viewer, or right-click and select Execute Command from the popup menu to execute the command. In the Display Server, commands execute on a single-click or by right-clicking and selecting Execute Command from the popup menu. NOTE: Select Tools>Options to execute commands on non-control objects in the Display Viewer with a double-click.

Multiple commands are executed as a series of individual commands that are launched in sequence. NOTE: There is no guarantee that any individual command will have completed before the execution of the next command due to their potentially asynchronous nature.

It is possible to execute a command from an individual element in an object that displays tabular data (i.e., a cell in a table or a bar in a bar graph). Based on your data attachment, substitutions are created that will be applied to the command before it is executed. See the Drill Down Substitutions section for information on how to customize which substitutions will be passed into the command.


Command Confirmation
By default, the command confirmation dialog is disabled. To control this option for each individual object, use the commandConfirm check box in the the Object Properties window. If confirmation is required for a multiple command, a single confirmation dialog is presented. If you confirm the execution, all individual commands will be executed in sequence with no further confirmation. If the you cancel the execution, none of the commands in the sequence will executed.

Use the commandConfirmText property to write your own text for the confirmation dialog. Otherwise, text from the command property will be used.

It is also possible to override the confirmation status of individual objects with an application wide policy. Select Tools>Options to choose from three confirmation values:
Policy Description
Do not confirm Indicates that no commands require confirmation (regardless of each object's confirmation status).
Confirm all Indicates that all commands require confirmation (regardless of each object's confirmation status).
Use object confirm flag Indicates that the confirmation status of each object will determine whether confirmation is required. This is the default policy.


Close Window Command

Use the commandCloseWindowOnSuccess check box to automatically close the window that initiates a system command when the system command is executed successfully. This applies to system commands only. With data source commands, the window is closed whether or not the command is executed successfully. For multiple commands, the commandCloseWindowOnSuccess is applied to each command individually. Therefore if the first command in the multiple command sequence succeeds, the window will close before the rest of the commands are executed.

NOTE: The commandCloseWindowOnSuccess property is not supported in the Display Server.
 




Threshold Commands
Threshold commands work with the Display Builder, Display Viewer and the Display Viewer Applet. Threshold commands do not work with the Display Server. Threshold commands can be assigned to objects found on the General tab that are labeled either discrete dynamic or range dynamic.
Depending on how you have deployed Enterprise RTView, threshold commands are executed either on the Display Server or the client machine.

Define Threshold Command
To assign a threshold command, right-click on a threshold command property in the Object Properties window. Select Define Command and choose SYSTEM,
ALERT, MULTIPLE or your data source.

Execute Threshold Command
Once a threshold command has been assigned to an object, it is executed when the current value of the object (based on the attached data source) reaches the specified threshold. Multiple commands are executed as a series of individual commands that are launched in sequence. NOTE: There is no guarantee that any individual command will have completed before the execution of the next command due to their potentially asynchronous nature.
 



Open/Close Display Commands
You can define a command to be activated when a display (.rtv) file is opened or closed.

Define Open/Close Display Command
Select Edit>Model Properties and right-click on either onCloseCommand or onOpenCommand. Select Define Command and choose SYSTEM,
ALERT, MULTIPLE or your data source. NOTE: When onCloseCommand and onOpenCommand are defined by a SYSTEM drill down command, this functionality is not supported in the Display Server.

Execute Open/Close Display Command
Open Display and Close Display commands are executed when the display (.rtv) file where you set the Model Properties is opened/loaded or closed/replaced.

 



Multiple Commands
You can define multiple commands to execute when a command is activated.

Define Multiple Commands
To define multiple commands, right-click on a command property in the Object Properties window. Select Define Command and choose
MULTIPLE. To create multiple commands, click on the Add button. Select an existing command and click on Edit to modify, Duplicate to copy or Remove to delete.

Execute Multiple Commands
Multiple commands are executed as a series of individual commands that are launched in sequence. There is no guarantee that any individual command will have completed before the execution of the next command due to their potentially asynchronous nature. Therefore, you cannot count on a result of the first command to apply to the rest of the commands. Command failure dialogs will appear for any command in the sequence that fails.
 
 


Command Failure
Commands executed by a data source or a system command can return a dialog window or a console message indicating whether the command was successful. Where and how the dialog window appears depends on which type of command is executed and the type of Enterprise RTView deployment:

Application or Rich Client Browser with Direct Data Connection:
System command - Dialog window appears on the client
Data source command - Console message appears on the client. For the data sources that support error dialogs for command failure, a dialog will also appear on the client. See the Define Command section for your data source to see if it supports error dialogs.

Application or Rich Client Browser with Served Data:
System command - Dialog window appears on the client
Data source command - Message appears in Data Server console

Thin Client Browser with Served Data:
System command - Message appears in Display Server console
Data source command - Message appears in Data Server console

Thin Client Browser with Direct Data:
For both command types - Message appears in Display Server console

 

 
Enterprise RTView contains components licensed under the Apache License Version 2.0.

 

Treemap Algorithms v1.0  is used without modifications and licensed by MPL Version 1.1. Copyright © 2001 University of Maryland, College Park, MD

 

Datejs is licensed under MIT. Copyright © Coolite Inc.

 

JCalendar 1.3.2 is licensed under LGPL. Copyright © Kai Toedter.

 

jQuery is licensed under MIT. Copyright © John Resig,

 
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. 

 
SL, SL-GMS, GMS, Enterprise 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-2009 Sherrill-Lubinski Corporation. All Rights Reserved.