COM.TIBCO.hawk.microagent.RuleBaseEngine

Microagent

Purpose

The RuleBaseEngine microagent (on all platforms) 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.

Methods

 

Method

Description

Page

RuleBaseEngine:deleteRuleBase

Deletes the specified rulebase.

RuleBaseEngine:deleteRuleBase

RuleBaseEngine:getExternalVariables

Returns the currently loaded external variables as tabular data

RuleBaseEngine:getExternalVariables

RuleBaseEngine:getRuleBaseNames

Returns the names of the currently loaded rulebases

RuleBaseEngine:getRuleBaseNames

RuleBaseEngine:getScheduleNames

Returns names of currently loaded schedules

RuleBaseEngine:getScheduleNames

RuleBaseEngine:loadRuleBase

Attempts to find and load the named rulebase

RuleBaseEngine:loadRuleBase

RuleBaseEngine:loadRuleBaseFromFile

Attempts to find and load a rulebase from a file path

RuleBaseEngine:loadRuleBaseFromFile

RuleBaseEngine:unloadRuleBase

Attempts to unload the named rulebase

RuleBaseEngine:unloadRuleBase

RuleBaseEngine:getConfigInfo

Returns configuration information for the rulebase

RuleBaseEngine:getConfigInfo

RuleBaseEngine:sendMail

Sends email notification upon a rulebase event

RuleBaseEngine:sendMail

RuleBaseEngine:onAlertCount

Provides current and average rulebase engine alert rate statistics

RuleBaseEngine:onAlertCount

RuleBaseEngine:onAlertCountForRulebase

Provides the rulebase engine alert rate statistics

RuleBaseEngine:onAlertCountForRulebase

RuleBaseEngine:suspendAlert

Suspends an alert

RuleBaseEngine:suspendAlert

RuleBaseEngine:suspendAllAlerts

Suspends alerts for the specified number of milliseconds

RuleBaseEngine:suspendAllAlerts

RuleBaseEngine:resumeSuspendedAlerts

Restarts alerts after alert suspension

RuleBaseEngine:resumeSuspendedAlerts

RuleBaseEngine:updateExternalVariables

Updates the external variables and saves them to the variable file

RuleBaseEngine:updateExternalVariables

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.

Proprietary Method Summary

 

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