Invoking Microagent Methods

Copyright © TIBCO Software Inc. All Rights Reserved

Chapter 6 Monitoring the Adapter Using TIBCO Hawk : Invoking Microagent Methods

Invoking Microagent Methods

A set of default microagents is loaded when a TIBCO Hawk Agent is started. When you install and start the adapter, its microagents are dynamically added to the local agent.

To invoke a microagent method:

1.

Start TIBCO Hawk Display, then right-click on the agent icon and select Get Microagents.

If TIBCO Hawk security is implemented on your system and you do not have access to microagents on this agent, an error dialog displays. Select another agent, or contact your system administrator to obtain access.

The Microagents, Methods and Arguments dialog displays. The panel on the upper left lists microagents you can access on the current agent.

Figure 17 Microagents, Methods and Arguments Dialog

This dialog has two modes, Invoke and Subscribe. Invoking a method immediately returns a single set of current results. Subscribing provides updates of current results at regular intervals. Radio buttons at the bottom of the dialog control these modes.

2.

Click a microagent name, such as Self, to display a list of associated methods and text descriptions in the panels below.

3.

Click the name of the method to invoke, such as getComponentInfo.

Figure 18 Displaying a Method

If the method accepts arguments, fields for each argument display in the upper right panel. Detailed help text displays in the lower panel.

4.

Specify any arguments for the method invocation.

5.

Verify that the Invoke radio button is clicked.

6.

Click the Invoke button to invoke the selected method. The Invocation Results dialog displays the results returned by the method.

Figure 19 Invocation Results Dialog

7.

Click the Done button to close the dialog.

These steps describe how to interactively invoke a microagent method and receive a single set of results in TIBCO Hawk Display. You can also use a microagent method as the data source of a TIBCO Hawk rule. Rules automatically receive method results, apply tests to evaluate them, then take action if necessary. For more information on building TIBCO Hawk rules and rule bases, see your TIBCO Hawk Administrator’s Guide.