Event Correlator
Event Correlator contexts are stored in the Event Correlators container in the System Tree. Each context lets you access and manage a single event correlator.
Unique Actions
Configure
The Configure action is used to edit the properties of the event correlator.
 | Changing Name field during this operation will cause renaming of current context. This may lead to malfunctioning of other system components that use context name/path as a primary identifier. |
Action Type: |
Common Actions
Delete, Make Copy, Replicate, Edit Context Permissions, Monitor Related Events, View Status
Context States and Icons
Icon | Code | State |
| 0 | This event correlator is enabled. |
| 1 | This event correlator is disabled. |
Advanced Information |
Context Information
Context Type: eventCorrelator
Context Name: provided by user
Context Description: provided by user
Context Path: users.USER_NAME.eventCorrelators.CORRELATOR_NAME
Context Mask: users.*.eventCorrelators.*
Context Permissions
Level | Description |
None | No access allowed. |
Observer | Basic event monitoring. Status browsing. |
Operator | Event correlator configuration browsing. |
Manager | Event correlator removal. Event correlator configuration. |
Engineer | Same as Manager. |
Administrator | Same as Manager. |
Public Variables (Properties)
Common Variables: groupMembership (Group Membership), activeAlerts (Active Alerts)
Properties
Defines basic properties of an event correlator.
Variable Name: | childInfo |
Records: | 1 |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Field Description | Notes |
name | String | Context Name | Event correlator context name is used to refer to this context from other parts of the system. |
description | String | Context Description | The displayed name of an event correlator context. |
enabled | Boolean | Enabled | Whether event correlation is enabled. If this property is |
correlatorScript | String | Correlator Script | A script in the Streaming SQL language that defines event correlation logic. |
outputEventFormat | Data Table | Output Event Format | Defines event format for output events generated by the correlator. This property is used only when context name is omitted in the output stream definition. Otherwise, specified context's event is used instead. You can view the output events of a correlator context by executing the Monitor Related Events action on it. |
Public Functions
This context has no public functions.
Public Events
This context has the following public events.
Common Events: Child Added, Child Removed, Variable Definition Added, Variable Definition Removed, Function Definition Added, Function Definition Removed, Event Definition Added, Event Definition Removed, Context Basic Information Changed, Context Variable Changed, Change, Status Changed.
Was this page helpful?