Event Filter

Top  Previous  Next

This context lets you access and manage a single event filter.

Unique Actions [?]

Parameterize

Other unique actions:

CONFIGURE FILTER

This action is used to edit the properties of an event filter.

note_warning-wt

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:

Configure

Common Actions [?]

Delete, Make Copy, Replicate, Edit Context Permissions, Monitor Related Events, View Status

Context States and Icons

This context has no states. It is always represented by the st_eventfilter icon.

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: Observer

Public Variables (Properties) [?]

Common Variables: groupMembership (Group Membership)

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

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

 

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 [?]

This context has no public functions.

Public Events [?]

Common Events: info (Information)