Tag: Filter

The Filter tag, when used with specific combinations of attributes, lets you automate the various filter functions available in column headers.


<Filter ColumnID="5" Regex="names.nsf" CaseSensitive="True"/>
<Filter ColumnID="5" Mode="Contains" Text="Bug"/>
<Filter Target="NotesCounter" ColumnID="10" Mode="GreaterOrEquals" Number="100"/>
XML

Tag Attributes

AttributesAttribute ValuesValue DescriptionComment
TargetThe corresponding Grid CodeSets the target grid on which the action will be appliedNot mandatory.
If no target is set, the target will default to the main grid (for products containing a main grid).
ColumnIDThe corresponding Column ID as shown in the Grid ManagerSets the column on which the action will be appliedMandatory regardless of filter mode used
ServerAbbreviated server names (separated by comma)

N/A

Only applicable in consoleEZ - see detailed description
IndexPositive integerWindow index numberOnly applicable in consoleEZ - see detailed description

Conditional Attributes

The following attributes are presented in the pairs that allow the attribute values to be compatible:

Filter Out Empty Cells

AttributesAttribute ValuesValue DescriptionComment
EmptyTrue/False

N/A

N/A

Filter by Regular Expression

AttributesAttribute ValuesValue DescriptionComment
RegexUser defined Regex value

N/A

N/A

CaseSensitiveTrue/False

N/A

N/A

Number Filters

AttributesAttribute ValuesValue DescriptionComment
Mode
  • Equals
  • NotEquals
  • GreaterThan
  • GreaterOrEquals
  • LessThan
  • LessOrEquals
Sets the filter mechanics

N/A

NumberUser definableThe number to be used in your search

N/A

Text Filters

AttributesAttribute ValuesValue DescriptionComment
Mode
  • Begins
  • NotBegins
  • Equals
  • NotEquals
  • Contains
  • NotContains
  • Ends
  • NotEnds
Sets the filter mechanics

N/A

TextUser definableThe text to be used in your search

N/A

Date Filters

AttributesCompatible Attribute Values (value compatibility is contingent on specific attribute combination)Value DescriptionComment
Mode
  • Equals
  • NotEquals
  • After
  • AfterOrEquals
  • Before
  • BeforeOrEquals
Sets the filter mechanics

N/A

DateUser definable date in standard YYYY-MM-DD formatThe date to be used in your search

N/A

Time Filters

AttributesCompatible Attribute Values (value compatibility is contingent on specific attribute combination)Value DescriptionComment
Mode
  • Equals
  • NotEquals
  • After
  • AfterOrEquals
  • Before
  • BeforeOrEquals
Sets the filter mechanics

N/A

TimeUser definable time in standard HH:MM:SS formatThe time to be used in your search

N/A

Cutoff-Date/Time Filters

Attribute NameCompatible Attribute Values (value compatibility is contingent on specific attribute combination)Value DescriptionComment
ModeLastFromSets the filter mechanics

N/A

YearsUser definableAmount of years back from the current date

N/A

MonthsUser definableAmount of months back from the current date

N/A

DaysUser definableAmount of days back from the current date

N/A

HoursUser definableAmount of hours back from the current date

N/A

MinutesUser definableAmount of minutes back from the current date

N/A

Tag: Filter

The Filter tag, when used with specific combinations of attributes, lets you automate the various filter functions available in column headers.

<Filter ColumnID="5" Regex="names.nsf" CaseSensitive="True"/>
<Filter ColumnID="5" Mode="Contains" Text="Bug"/>
<Filter Target="NotesCounter" ColumnID="10" Mode="GreaterOrEquals" Number="100"/>
XML

Tag Attributes

AttributesAttribute ValuesValue DescriptionComment
TargetThe corresponding Grid CodeSets the target grid on which the action will be appliedNot mandatory.
If no target is set, the target will default to the main grid (for products containing a main grid).
ColumnIDThe corresponding Column ID as shown in the Grid ManagerSets the column on which the action will be appliedMandatory regardless of filter mode used
ServerAbbreviated server names (separated by comma)

N/A

Only applicable in consoleEZ - see detailed description
IndexPositive integerWindow index numberOnly applicable in consoleEZ - see detailed description

Conditional Attributes

The following attributes are presented in the pairs that allow the attribute values to be compatible:

Filter Out Empty Cells

AttributesAttribute ValuesValue DescriptionComment
EmptyTrue/False

N/A

N/A

Filter by Regular Expression

AttributesAttribute ValuesValue DescriptionComment
RegexUser defined Regex value

N/A

N/A

CaseSensitiveTrue/False

N/A

N/A

Number Filters

AttributesAttribute ValuesValue DescriptionComment
Mode
  • Equals
  • NotEquals
  • GreaterThan
  • GreaterOrEquals
  • LessThan
  • LessOrEquals
Sets the filter mechanics

N/A

NumberUser definableThe number to be used in your search

N/A

Text Filters

AttributesAttribute ValuesValue DescriptionComment
Mode
  • Begins
  • NotBegins
  • Equals
  • NotEquals
  • Contains
  • NotContains
  • Ends
  • NotEnds
Sets the filter mechanics

N/A

TextUser definableThe text to be used in your search

N/A

Date Filters

AttributesCompatible Attribute Values (value compatibility is contingent on specific attribute combination)Value DescriptionComment
Mode
  • Equals
  • NotEquals
  • After
  • AfterOrEquals
  • Before
  • BeforeOrEquals
Sets the filter mechanics

N/A

DateUser definable date in standard YYYY-MM-DD formatThe date to be used in your search

N/A

Time Filters

AttributesCompatible Attribute Values (value compatibility is contingent on specific attribute combination)Value DescriptionComment
Mode
  • Equals
  • NotEquals
  • After
  • AfterOrEquals
  • Before
  • BeforeOrEquals
Sets the filter mechanics

N/A

TimeUser definable time in standard HH:MM:SS formatThe time to be used in your search

N/A

Cutoff-Date/Time Filters

Attribute NameCompatible Attribute Values (value compatibility is contingent on specific attribute combination)Value DescriptionComment
ModeLastFromSets the filter mechanics

N/A

YearsUser definableAmount of years back from the current date

N/A

MonthsUser definableAmount of months back from the current date

N/A

DaysUser definableAmount of days back from the current date

N/A

HoursUser definableAmount of hours back from the current date

N/A

MinutesUser definableAmount of minutes back from the current date

N/A

Value Filters

Attribute NameCompatible Attribute Values (value compatibility is contingent on specific attribute combination)Value DescriptionComment
Value
  • User definable

  • Checked
  • Unchecked
The values to be used in your search—multiple values must be separated by a semicolon.


These two values are used when searching for checkbox cells.

N/A

Detailed Description

The Filter action emulates the use of the filters found in column headers. The attributes are used in pairs to determine the type of filter to use and how it will be used.



In the screenshot above, the column 'Database Filename' is to be filtered using the 'Text Filters' option, using the filter mode 'equal to', to find the database filename of 'time.nsf'.The actions that would be performed in the UI have been marked and correlated in the example script block below:



The Server attribute is only applicable to consoleEZ, in which case it will be mandatory for Target="LogAnalyzer" or Target="VolumeAnalyzer".

The Index attribute is also only used in consoleEZ and is mandatory when using Target="LogAnalyzer" or Target="VolumeAnalyzer", it is the value found on the Log Analyzer and Volume Analyzer windows.


Value Filters

Attribute NameCompatible Attribute Values (value compatibility is contingent on specific attribute combination)Value DescriptionComment
Value
  • User definable

  • Checked
  • Unchecked
The values to be used in your search—multiple values must be separated by a semicolon.


These two values are used when searching for checkbox cells.

N/A

Detailed Description

The Filter action emulates the use of the filters found in column headers. The attributes are used in pairs to determine the type of filter to use and how it will be used.



In the screenshot above, the column 'Database Filename' is to be filtered using the 'Text Filters' option, using the filter mode 'equal to', to find the database filename of 'time.nsf'.
The actions that would be performed in the UI have been marked and correlated in the example script block below:



The Server attribute is only applicable to consoleEZ, in which case it will be mandatory for Target="LogAnalyzer" or Target="VolumeAnalyzer".

The Index attribute is also only used in consoleEZ and is mandatory when using Target="LogAnalyzer" or Target="VolumeAnalyzer", it is the value found on the Log Analyzer and Volume Analyzer windows.