Define
TIBCO Hawk Command
NOTE: The TIBCO Hawk data
source may not be licensed in your RTView installation.
From the Object Properties window you
can access the Define TIBCO Hawk Command dialog. This dialog is used to
assign a TIBCO Hawk Agent's microagent method to
an object's command property, giving you the
ability to invoke methods from within a display. If
you execute a TIBCO Hawk 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 TIBCO Hawk Command
dialog, right-click on the appropriate command property in the Object Properties
window and select
Define Command>HAWK. The Define TIBCO Hawk Command
dialog provides several drop down menus to specify information regarding
assigning a method to an object. The information supplied assigns a microagent
method as a command. See the
Object
Commands section for information on how to execute a command.
|
 |
| Agent Name |
Name of the
agent containing the microagent method to invoke. To specify an agent on
a specific connection, append the connection name enclosed in parentheses.
For example:
Agent1 - Agent1 on the default connection.
Agent1(ConnectionA) - Agent1 on ConnectionA.
Agent1(ConnectionB) - Agent1 on ConnectionB.
To invoke a method on all agents with
the same name on all connections, append (*) to the Agent Name value.
For example:
Agent1(*) - Agent1 on all connections.
To specify all agents for a particular
connection, use the TIBCO Hawk Agent Group that is automatically created
for that connection. For example:
*:ConnectionB - All agents from ConnectionB.
The
TIBCO Hawk Agent and Microagent Groups
tab allows you to define Agent Groups and add them to the drop down menu in the
Define Command dialog. See Special Values for
more supported values for this field. |
| Microagent Name |
Name of the microagent
containing the method to invoke.
The
TIBCO Hawk Agent and Microagent Groups
tab allows you to define Microagent Groups and add them to the drop down menu in
the Define Command dialog. See Special
Values for more supported values for this field. |
| Method Name |
Name of the method to invoke. |
| Method Argument(s) |
Method argument fields
(e.g. Color) depend on which microagent and method are selected. To attach a
method argument to data, right-click and choose Attach to Data or
double-click in the field. |
| Data Server |
Select to read data through your configured Data
Server and not directly from the TIBCO Hawk data source.
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.
Multi-Server Command - When multiple
data servers are specified, the command will be executed on each data server
in the list.
To configure multiple data servers, enter a
semicolon (;) delimited list containing two or more
Named Data Servers (e.g. ds101;ds102). Each name specified must
correspond with a
Named Data Server
that you configured in Application Options>Data Server. It is also possible to
specify __default and __none (e.g. __default;ds101;ds102).
NOTE: The values __default and __none begin with two
underscore characters.
Alternatively, a value of * can be
entered to specify all data servers, including __default and __none.
|
A Method Repository file is used to
populate the initial values in the drop down menus for all fields when
agents and microagents are not available. This makes it easy to create
displays for agents and microagents when they are not online. See
Application
Options for information on how to create a Method Repository file.
As new agents and microagents come
online, drop down menus are automatically updated. If a drop down menu
does not contain the item you require, type your selection into the field.
The method argument fields that appear
depend on the microagent and method that you select. Argument fields are
labeled according to the selected method's requirements. If the method
is not recognized, five generic argument fields are provided.
Validation Colors
Fields in the dialog change colors
according to the information entered. These colors indicate whether or
not information is valid. Information entered into the dialog is validated
against the contents of the Method Repository, as well as information contained
in live agents and microagents. Only methods that are not asynchronous
and have an impact value equal to IMPACT_ACTION or IMPACT_ACTION_INFO are
considered to be valid. NOTE: The assigned method will be invoked only
if all entries are valid.
The following describes the significance
of the Define TIBCO Hawk Command dialog validation colors:
| |
Blue |
Unknown |
Entry was not
found in the Method Repository, nor can it be confirmed against a live
agent/microagent. When a microagent is unknown, the Method and Argument(s)
fields are all also unknown. |
| |
Yellow |
Offline |
Entry was either
found in the Method Repository or was previously available, but is not
currently online. This applies to agents and microagents. |
| |
White |
Valid
state |
Entry
is valid and was either found in the Method Repository
or can be confirmed against a live agent/microagent. For the Method Name
field, this indicates entry is not asynchronous and has an impact value
equal to IMPACT_ACTION or IMPACT_ACTION_INFO. |
| |
Red |
Invalid state |
Entry is not
valid. For the Method Name field, this indicates entry is asynchronous
and does not have an impact value equal to IMPACT_ACTION or IMPACT_ACTION_INFO. |
| |
Gray |
Not Required |
Field does
not require a value. |
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
for agents, such as $agent1 and $agent2, are used instead of values for
specific agents. Later when the display is running, these generic values
are defined by the actual names of specific agents, such as computer6 and
computer11. In this way, a single display
can be reused to execute commands for a number of different sources. For
more information on creating displays using substitution values, see Substitutions.
Special Values
| Agent
Name |
* |
This
indicates that the method of the specified microagent will be executed
on all agents. |
| Agent(Connection) |
When the connection is
specified after the agent name, the agent on the specified connection will
be used.
Agent1 - Agent1 on the default connection.
Agent1(ConnectionA) - Agent1 on ConnectionA.
Agent1(ConnectionB) - Agent1 on ConnectionB.
To invoke a method on all agents with
the same name on all connections, append (*) to the Agent Name value.
For example:
Agent1(*) - Agent1 on all connections.
To specify all agents for a particular
connection, use the TIBCO Hawk Agent Group that is automatically created
for that connection. For example:
*:ConnectionB - All agents from ConnectionB |
*:groupname
(*:group1) |
When *:groupname is entered, the return
fields from all specified microagents on all agents in the specified Agent
Group will be used to update the object property. This value is
only useful for objects which display tabular data. |
| Microagent
Name |
Name
(HawkSpot)
name*
(HawkSpot*)
|
When
only the name of a microagent is listed, the first microagent found on
the specified agent is the one on which the method will execute. You
can also use a wildcard character at the end of the Microagent Name. Commands will use the first instance found for
all microagents that start with the specified name. If multiple microagents are found for a command, the command
will execute on each microagent. |
| name:index
(HawkSpot:1) |
When
:index is added after the microagent name, the microagent with the index
indicated is the one on which the method will execute. You
can also use a wildcard character at the end of the Microagent Name. Commands will use
the instance for the the specified index for all microagents that start with
the specified name. If multiple microagents
are found for a command, the command will execute on each microagent. |
name:*
(HawkSpot:*) |
When
* is used as the index for a microagent, the method will be executed on
all instances of the specified microagent. You
can also use a wildcard character at the end of the Microagent Name. Commands will use all active instances for all microagents that start with
the specified name. If multiple microagents
are found for a command, the command will execute on each microagent. |
*:groupname
(*:group1) |
When *:groupname is entered,
Method Name, Return Field Name and Argument fields
will validate and populate against the first microagent in the
Microagent
Group.
This value is only useful for objects which display
tabular data. |
| This value may
be used in any field in the Define TIBCO Hawk Command dialog. |
$value |
When an actionCommand
is executed $value is replaced with the value from the control. NOTE: This
value may only only be used for Action
Commands. |
The following describes Define TIBCO
Hawk 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 method (once Apply or OK is selected). |
| Cancel |
Closes the dialog with
last values applied. |
|
