Item Base Genie
- Last UpdatedJul 18, 2023
- 2 minute read
Genie Name: item_base
Genie Library: sa_filter
System Project: SA_Include
The Item Base Genie (named "item_base") is used to create a customized alarm filter button. This Genie is designed for use with the Situational Awareness Default Alarm Pages.
For more information, see Add an Alarm Filter Button.
Genie Properties
Complete the following properties for the Genie in the Genie Properties dialog box.
-
AN: This is an automatically-generated unique ID for the genie object.
-
Name: Optional. If you need to reference the Genie at runtime using Cicode, specify a unique name.
Genie Parameters
Select the Genie, then double-click on it. The Genie’s parameters are displayed. Complete the following parameters:
|
Parameter |
Description |
|---|---|
|
IsExclusion |
Determines if the results of an applied filter are excluded or included in the list that is displayed. TRUE = Filter results are excluded. For example. if the value of the filter is "CATEGORY <> 3", when the filter is applied category 3 alarms will be excluded. FALSE = Filter results are included. For example, if the value of the filter is "CATEGORY=3", only category 3 alarms will be included in the list. |
|
FilterExpr |
Enter the Cicode expression that returns the name of a filter. To use the default filter name that is applied to Situational Awareness alarm pages, enter the following: AlarmPage_GetFilter("TopBar") To use a custom filter, you need to create the required Cicode as on OnPageEntry event. You can then call the filter name. |
|
ValueExpr |
Enter the Cicode expression that returns the value of the filter string. For example, "CATEGORY<>3". |
|
Tooltip |
An optional description of the Genie that appears when the mouse points at it. |
|
Label |
Enter the text that will appear in the header row of the alarms list when the filter is applied. For example, "No Cat 3 Alarms". |