HCL Workload Automation, Version 9.4

HCL Workload Automation event management plug-ins

Describes the different types of event management plug-ins.

The two main objects that make up event rules are:
  • Event conditions
  • Actions

Event condition plug-ins

An event condition is represented by an instance of the EventCondition class, which consists of the following:
  • A pluginName, which identifies the event monitoring plug-in (or provider) that is able to capture the event
  • An eventName, which identifies the condition in the rule
  • An eventType, which qualifies the event to be captured
  • A filteringPredicate, which defines a filter that must be applied to the event content in order to check that it matches the event condition
  • A read-only scope attribute, which is calculated by the event plug-in when the rule is created or updated. It includes a definition of the scope of the event condition, which has different meanings for different types of events

An event plug-in is a collection of event types grouped because they share similar characteristics, focus on the same operational area, or monitor similar objects.

Event action plug-ins

An action is represented by an instance of the RuleAction class, which consists of:
  • A pluginName, which identifies the action plug-in (or provider)
  • One or more specific action types to be run on a specific point in time defined by responseType in the rule
  • A read-only scope attribute, which is calculated by the action plug-in when the rule is created or updated. It includes a definition of the scope of the specific action.

An action plug-in is a collection of action types grouped because they share similar characteristics, focus on the same operational area, or operate on similar objects.

Structure of an event condition or action

In HCL Workload Automation, event condition and action plug-ins are structured in the following components:
TWSPluginConfiguration.xml
An XML file used to declare the event conditions or actions and the attributes related to them.
TWSPlugin.properties
A properties file that defines the following configurable characteristics of the plug-in:
  • The name
  • The type (condition or action)
  • The Java™ class name that directly implements the plug-in interface
One or more Java compilation units
One of them contains a class that implements the Java interface for the event plug-in (this class name is defined in TWSPlugin.properties). The Java class can add features to the plug-in and can also generate events or actions. In the sample plug-ins these features are generally included in other compilation units contained in the same Java package.