MM Method Reference TIBCO BusinessEvents Monitoring and Management provides the following groups of methods you can use to manage a deployed cluster: • Inference Agent Methods • Process Methods • Query Agent Methods See the following table for details. Inference Agent Methods Table 41 Inference Agent Methods Property Notes Agent Group GetNumberOfEvents Retrieves the total number of events currently in the agent’s Rete network. Note that events with time to live zero (ttl=0) do not persist in the Rete network. GetNumberOfInstances Retrieves the total number of concept instances existing in this agent’s Rete network. Resume Resumes the execution of this agent. Suspend Suspends the execution of this agent. Channels Group GetSessionInputDestinations Retrieves the destinations enabled for input in this agent. Object Management Group GetEvent Retrieves the event with the specified ID from this agent. GetInstance Retrieves the concept instance with the specified ID from this agent. GetScorecards If URI is not provided: Returns a table with of all of the scorecards in this agent. If URI is provided: Retrieves the agent's scorecard information. Profiler Group The performance profiler is primarily used towards the end of the development phase, to check for bottlenecks and refine the project design. For full details about using profiler as well as a detailed reference, see Chapter 22, TIBCO BusinessEvents Performance Profiler in TIBCO BusinessEvents Developer’s Guide. StartFileBasedProfiler Turns on the profiler and starts collecting data for the specified duration. When time is complete or the profiler is turned off, profiling data is saved to a file in a comma-separated format. StopFileBasedProfiler Turns off the profiler and stops collecting data. Working Memory Group ActivateRule Activates the specified rule in this agent. DeactivateRule Deactivates the specified rule in this agent. ResetTotalNumberRulesFired Resets to zero the total number of rules fired in this agent, resetting the statistics. GetWorkingMemoryDump Retrieves the working memory dump of this agent. GetRule Retrieves information about the rule with the specified URI in this agent. GetRules Retrieves a table listing the rules deployed in this agent. GetTotalNumberRulesFired Retrieves a table listing the total number of rules fired in this agent since startup or since statistics were last reset. GetRuleSession Retrieves a table with the name of this agent. Process Methods Table 42 Process Methods Property Notes Channels Group ReconnectChannels Restarts all channels or a single channel. resumeChannels Resumes all channels or a single channel. suspendChannels Suspends all channels or a single channel. ResumeDestinations Resumes one or all of the destinations of one or all of the channels, depending on the arguments provided. SuspendDestinations Suspends one or all of the destinations of one or all of the channels, depending on the arguments provided. GetChannels Retrieves channel information. GetDestinations Retrieves destination information. GetSessionInputDestinations Retrieves the destinations enabled for input in the specified agent. Engine Group StopEngine Shuts down the processing unit (engine). ActivateTraceRole Enables a specified trace role. GetHostInformation Retrieves the value of the specified host information property, or of all properties if none specified. GetNumberOfEvents Retrieves the total number of events existing in the specified agent or in every agent. GetNumberOfInstances Retrieves the total number of instances existing in the specified agent or in every agent. GetMemoryUsage Retrieves the engine's memory usage information. Object Management Group GetEvent Retrieves an event with the specified Id from the specified agent or from every agent. GetInstance Retrieves an instance with the specified ID from the specified agent or from every agent. GetScorecards If URI is not provided: Returns a table with of all of the scorecards in the specified agent or in every agent. If URI is provided: retrieves scorecard information in the specified agent or in every agent. Profiler Group StartFileBasedProfiler Turns on the profiler and starts collecting data for the specified duration. When the time is complete or the Profiler is turned off, profiling data will be saved to a file in comma separated format. StopFileBasedProfiler Turns off the profiler and stops collecting data. Rule Service Provider Group ResumeRuleServiceProvider Resumes the agents in the processing unit. SuspendRuleServiceProvider Suspends the agents in the processing unit. Working Memory Group Applies only to inference agents. Other agent types are ignored. ActivateRule Activates a rule in the specified inference agent or in every inference agent. DeactivateRule Deactivates a rule in the specified inference agent or in every inference agent. ResetTotalNumberRulesFired Resets the total number of rules fired to zero for the specified inference agent or for every inference agent. GetWorkingMemoryDump Gets the working memory dump for the specified inference agent or for every inference agent. GetRule Gets info about the rule with the specified URI for the specified inference agent or for every inference agent. GetRules Gets a table listing the rules deployed for the specified inference agent or for every inference agent. GetTotalNumberRulesFired Gets a table listing the total number of rules fired for the specified inference agent or for every inference agent. GetRuleSession Gets a table listing every active inference agent. Query Agent Methods Table 43 Query Agent Methods Property Notes Agent Group Resume Resumes the execution of this agent. Suspend Suspends the execution of this agent. Channels Group GetSessionInputDestinations Retrieves the destinations enabled for input in this agent.
Copyright © TIBCO Software Inc. All Rights Reserved.