The COM.TIBCO.hawk.microagent.RuleBaseEngine Microagent
The RuleBaseEngine microagent returns information from rulebases and takes actions on rulebases that affect the TIBCO Hawk agent itself. RuleBaseEngine methods are used to examine auto-configuration information, to examine active microagents, and to load and unload rulebases (for example in a rulebase-management rulebase).
Remarks
In prior releases of the TIBCO Hawk software, many of the RuleBaseEngine functions were handled by the Self microagent.
Some methods of the RuleBaseEngine microagent are proprietary. They are listed here for completeness, but cannot be invoked directly.
Proprietary Methods
The following methods of the RuleBaseEngine microagent are proprietary. The TIBCO Hawk system does not support direct user invocation of these methods from the TIBCO Hawk Display or Console API.
However, these methods are used indirectly by TIBCO Hawk Display when interacting with agents and thus have security implications. Access to proprietary methods with an impact of Action should only be granted to trusted users who are allowed access to all Action methods.
| Method Name | Impact | Description |
|---|---|---|
| getCommands | Info | Returns the rulebase commands |
| getRuleBases | Info | Retrieves rulebases from the agent |
| getSchedules | Info | Returns the Schedules List |
| getRBMap | Info | Returns the RuleBaseMap file |
| addRuleBase | Action | Sends rulebases to the agent |
| updateRuleBase | Action | Updates rulebases on the agent |
| setSchedules | Action | Sets the schedules list for an agent |
| setRBMap | Action | This method sets the RuleBaseMap file for an agent |
| runTest | Action | Runs tests for network queries |
| onAlertPosted | Info | Provides data for alerts posted by the Rulebase Engine |
| onAlertCleared | Info | Provides data for alerts cleared by the Rulebase Engine |
- The RuleBaseEngine:deleteRuleBase Method
The RuleBaseEngine:deleteRuleBase method deletes the specified rulebase. - The RuleBaseEngine:getExternalVariables Method
The RuleBaseEngine:getExternalVariables method returns the currently loaded external variables as tabular data in two fields, variable name and value. - The RuleBaseEngine:getRuleBaseNames Method
The RuleBaseEngine:getRuleBaseNames method returns the names of the currently loaded rulebases. - The RuleBaseEngine:getScheduleNames Method
The RuleBaseEngine:getScheduleNames method returns the names of the currently loaded schedules. - The RuleBaseEngine:loadRuleBase Method
The RuleBaseEngine:loadRuleBase method attempts to find and load the named rulebase. - The RuleBaseEngine:loadRuleBaseFromFile Method
The RuleBaseEngine:loadRuleBaseFromFile method attempts to find and load the rulebase in the named file. An absolute file path is required. - The RuleBaseEngine:unloadRuleBase Method
The RuleBaseEngine:unloadRuleBase method attempts to unload the named rulebase. - The RuleBaseEngine:getConfigInfo Method
The RuleBaseEngine:getConfigInfo method returns information on how the rulebase is currently configured. - The RuleBaseEngine:sendMail Method
The RuleBaseEngine:sendMail method sends an email notification. - The RuleBaseEngine:onAlertCount Method
The RuleBaseEngine:onAlertCount method provides the rulebase engine alert rate statistics every 5 seconds. It provides alert rate averages over the previous 5, 10, 15, 30 and 60 seconds. - The RuleBaseEngine:onAlertCountForRulebase Method
The RuleBaseEngine:onAlertCountForRulebase method provides the rulebase engine alert rate statistics for a given rulebase every five seconds. It provides alert rate averages over the previous 5, 10, 15, 30 and 60 seconds. - The RuleBaseEngine:suspendAlert Method
The RuleBaseEngine:suspendAlert method suspends an alert for the specified number of milliseconds. The default is 10000 milliseconds. - The RuleBaseEngine:suspendAllAlerts Method
The RuleBaseEngine:suspendAllAlerts method suspends all current and future alerts in the rulebase engine for the specified number of milliseconds. - The RuleBaseEngine:resumeSuspendedAlerts Method
The RuleBaseEngine:resumeSuspendedAlerts method restarts all alerts after alert suspension. - The RuleBaseEngine:updateExternalVariables Method
The RuleBaseEngine:updateExternalVariables method reads the variables file and re-loads all rulebases that use the variables listed in the variable file.