Dependence on the Console API

When a configuration object is created using the corresponding editor on the TIBCO Hawk Console, the context of the configuration object is implied by the agent or repository for which the configuration object is defined. For example, when creating rulebases in the rulebase editor, this context is used when presenting to you the choices for data sources and actions, in the form of the related microagents, methods and arguments. When creating rulebases using the Configuration Object API, the microagent name, method name and the data item names must be passed to the methods. These are obtained from the following classes of the COM.TIBCO.hawk.talon package of the Console API:

MethodSubscription
MethodInvocation
MicroAgentDescriptor
MethodDescriptor
OpenData

The data source of a rule requires a microagent name and a MethodSubscription object. Actions require a microagent name and a MethodInvocation object.

Microagent names, and the information required to build valid MethodSubscription and MethodInvocation objects, are available in MicroAgentDescriptor objects. The methods used as data sources must be Open Methods since the RuleBaseEngine can only process OpenData.

A MicroAgentDescriptor holds MethodDescriptor objects for all methods of a microagent. The MethodDescriptor for the method chosen as the data source describes the data the method returns. This information is needed to construct test expression operators. The getRuleData operator is used by test expressions to access a method's data. It requires the name of a data item. This name needs to be one of the names of the elements in the method's return which are specified in the MethodDescriptor. Obtaining MicroAgentDescriptor objects is accomplished with the COM.TIBCO.hawk.hawkeye package of the Console API.

Retrieving and updating configuration objects on a TIBCO Hawk agent or repository is accomplished by invoking methods on the RuleBaseEngine or Repository microagents. This involved both the monitoring and management components of the TIBCO Hawk Console API as agents and microagents need to be discovered and method invocations are performed on the required microagents. See Common Configuration Object API Methods, for commonly used methods on RuleBaseEngine or Repository microagent when using the Configuration Object API.

See the TIBCO Hawk Console API Reference and the TIBCO Hawk Methods Reference for more information.