Previous Topic: XML ElementsNext Topic: Multi-Select List Parameters


Search Class

Pre-defined behavior for a search can be applied by simply specifying the class attribute of the <search > tag. For the current release, the following search classes are supported:

EventReview

Creates tools for reviewing events and enables the 'Quick View' pane on the iConsole search results page.

The Quick View pane also provides a link to the Context Search which provides a popup window with events in the context of the current event. Searches of this class are subject to Security ID processing if this is configured.

EventReport

Searches of this class are also subject to Security ID processing if this is configured.

Administration

Searches of this class only require an administrative privilege (see the table below).

Each class requires that the user has the correct privileges as defined in the following table:

Class

Type

Required Privileges

EventReview

Metadata

Events: Allow event searches

AND

Events: View captured data

Content

Events: Allow content searches

AND

Events: View captured data

EventReport

Metadata

Events: Allow event searches

AND

Events: View captured data

Content

Events: Allow content searches

AND

Events: View captured data

Administration

Metadata

Admin: Allow administration searches

<None>

Metadata

Admin: Allow administration searches

OR

Events: Allow event searches

Content

Events: Allow content searches

More information:

Security ID Processing

Parameter Types

The search can define a number of different parameter types:

date

A date selectable via a calendar dialog (see Date Specification).

date_range

A date range selectable from specified or predefined periods, or using calendar dialogs (see Date Specification).

icon

Image for display only.

label

Text for display only.

numeric

An integer value.

real

A floating point number.

text

A text string.

checkbox

A Boolean value.

list

A list of possible values. Either a single or multiple values may be selected. A variety of display formats are possible for multi-select lists (see Multi-Select List Parameters).

choice

A set of exclusive choices displayed as a collection of radio buttons.

lookup

A list dynamically populated by a search, allowing selection of one or more values (such as trigger names).

lookupbyid

Similar to lookup but provides a list of unique IDs to the search, rather than the displayed ‘user-friendly’ values (for example, users).

systemid

Provides the id of one of a predefined set of values (for example, user, group).