Defining commands
A command is defined by associating it with an action property of a dashboard object such as a push button. When the action is triggered, in this case, when the button is pressed, the command is performed.
For control objects such as push buttons, commands are defined by setting the actionCommand property. For other objects such as labels and charts, the commands are defined by setting the command property.
To see how this works
1. Create a new dashboard.
2. From the Controls tab in the Object Palette, select the Push Button object and add it to the dashboard canvas.
3. With the push button object selected, in the Object Properties panel, right-click the actionCommand property and select Define Command > Apama from the popup menu.
This displays the Define Apama Command dialog.
4. To define a command, select a command type and specify values for the remaining fields.
The fields vary based on the command being defined. The common set of fields is as follows.
Command — The command to be performed when the action is triggered. The command selected will hide or show many of the other fields.
Correlator — The correlator where the command is to be run. If creating a new instance, this is the correlator where the instance will be created.
Data server — Advanced users can specify the logical name of the data server to serve the data for the command execution. For more information, see
Working with multiple data servers.
In this documentation, some of the Define Apama Command dialogs are shown without the Data server field, which was added in a later release.
The fields in the Parameters section are specific to the specified instance.
Note:
When executing commands in display server deployed dashboards, warning and error dialogs are not displayed to warn of error conditions that occur.