Event Filter
This context lets you access and manage a single event filter.
Unique Actions
[?]
Parameterize
This action is used to parameterize the event filter.
Action Flow:
The server prepares a list of event categories that are suitable for parameterization.
The user is prompted to select event categories to be parameterized.
The server generates parameterization data and stores it in filter properties.
A parameterized filter is opened for editing using the Edit Properties UI Procedure.
Action Name: | parameterize |
Non-Interactive Mode: | Not Supported |
Permissions: | Accessible at Observer permission level |
Configure Filter
This action is used to edit the properties of an event filter.
 | 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 filter is a normal filter |
 | 1 | This filter is the default (auto-activated) filter of the owning user |
Advanced Information
Context Information
Context Type: eventFilter
Context Name: provided by user
Context Description: provided by user
Context Path: users.USER_NAME.filters.FILTER_NAME
Context Mask: users.*.filters.*
Context Permissions
[?]
Level | Description |
None | No access allowed. |
Observer | Filter activation. Basic event monitoring. Status browsing. |
Operator | Configuration browsing. |
Manager | Filter configuration and removal. |
Engineer | Same as Manager. |
Administrator | Same as Manager. |
Public Variables (Properties)
[?]
Common Variables: groupMembership (Group Membership), activeAlerts (Active Alerts)
Filter
Properties
See description of the variable and its fields here.
Variable Name: | childInfo |
Records: | 1 |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
name | String | 1-50 characters |
description | String | 1-50 characters |
defaultFilter | Boolean |
|
showDataFieldNames | Boolean | |
showServerContextNames | Boolean | |
showServerEventNames | Boolean |
Filter Rules
See description of the variable and its fields here.
Variable Name: | rules |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
description | String | |
mask | String | |
event | String | |
enabled | Boolean | |
level | Integer | |
expression | String | |
parameterized | Boolean | |
color | Color |
Primary Visible Fields
See description of the variable and its fields here.
Variable Name: | shownFields |
Records: | 1 |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
context | Boolean | |
event | Boolean | |
level | Boolean | |
data | Boolean | |
ack | Boolean | |
enrichments | Boolean |
Additional Visible Fields
See description of the variable and its fields here.
Variable Name: | additionalFields |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
name | String | Read-only |
description | String | Read-only |
edescs | String | Read-only |
shown | Boolean |
Custom Highlighting
See description of the variable and its fields here.
Variable Name: | customHighlighting |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
mask | String | |
event | String | |
level | Integer | |
expression | String | |
color | Color |
History Browser Settings
See description of the variable and its fields here.
Variable Name: | historySettings |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
limitTimeFrame | Boolean | |
timeFrame | Integer | |
timeUnit | Integer | |
useCustomEndTimePoint | Boolean | |
customEndTimePoint | Date |
Public Functions
[?]
Get Parameters
Returns an initial (non-filled) parameters table that can be filled and used for activating a parameterized filter.
Function Name: | getParameters | ||
Permissions: | Accessible at Observer permission level | ||
Input Records: | 1 | ||
Input Format: | |||
Name | Type | Description | |
|---|---|---|---|
realtime | Boolean | Indicates whether a parameters table suitable for real-time (if true) or historical (if false) section of the Event Log should be returned. | |
Output Records: | 0...unlimited | ||
Output Format: | Dynamic | ||
Public Events
[?]
Common Events: info (Information)
Was this page helpful?