Tag: Select

The Select tag, along with the applicable SetParam options, lets you automate the selection of rows within a target grid.


<Select Lines="ByValue">
	<SetParam ColumnID="4" Value="alog4.ntf"/>
</Select>
XML


NOTEThe Select action can be used for selecting entries within trees and grids; the selection mechanics, attributes and compatible values, and the attributes and SetParam options are different depending on what you need to select.

o

For selections in grids, server/database trees, and scanEZ's selection tree, please see these pages:

Tag Attributes

AttributesAttribute ValuesValue DescriptionComment
TargetApplicable Grid Code

N/A

Not Mandatory - see detailed description
LinesAll

ByValue

Selects all lines in the target grid

Selects specified lines as set through the SetParam options

Mandatory
ColumnIDThe corresponding Column ID as shown in the Grid Manager

N/A

Mandatory
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

SetParam Options

AttributesAttribute ValuesValue DescriptionComment
ColumnIDThe corresponding Column ID as shown in the Grid ManagerSource item names. Separate multiple field names with a semicolon.Mandatory – see detailed description
ValueUser definable


OR these set values

True

False

Blank

Partial

The value to use as selection criteria


Acceptable values for checkbox cells

Mandatory – see detailed description
AndTrue/FalseUsed only for multi-value conditionsNot mandatory
RawFormatTrue/FalseDetermines if Date/Time values will be selected based on the text-formatted value displayed in the grid, or the real value (real value is based on standard YYYY-MM-DD hh:mm:ss format)Not mandatory

Detailed Description

The Select action can be used either without the Target attribute, or with it set to "Grid", when the desired selection is to be carried out on the main grid.

The Lines attribute sets the type of selection process that will be used.

  • Using the value of "All" will select all the lines in the target grid. For example, <Select Target="Grid" Lines="All"/> would select all lines in the main grid.


Using the attribute ByValue will allow you to specify conditions using SetParam options within nested child actions.

The SetParam option attribute ColumnID is used to identify the column within which the mandatory Value string will be located—all lines that contain this string are candidates for selection.

<Select Lines="ByValue">
<SetParam ColumnID="DB1" Value="alog4.ntf"/>
</Select>


In the script block above, lines that contain the string "alog4.ntf" within the column with the ID of "DB3" will be selected.

Within a Select action block, multi-value conditions can be set up using the And attribute. By setting its value to "True", all conditions set by the list of SetParam lines must be met for a line to be selected.


<Select Lines="ByValue">
	<SetParam And="True" ColumnID="4" Value="a_log4.nsf"/>
	<SetParam And="True" ColumnID="3" Value="\"/>
	<SetParam And="True" ColumnID="7" Value="Standard"/>
	<SetParam And="True" ColumnID="112" Value="Not Enabled"/>
	<SetParam And="True" ColumnID="2" Value="ACMELog (Archive)"/>
</Select>
XML


In the script block above, only lines that meet ALL the conditions set by the combination of ColumnID's and Value strings will be selected.


NOTE

You may use more than one multi-value condition within the same nested SetParam block. This will create an OR condition.

In the script block above, there are two separate multi-value conditions set. The first SetParam line in the list that does not contain a And="True" closes the first multi-value condition, and allows the second multi-value condition to be set in the block. This will set up an OR condition between part 1 and part 2. If conditions are met in part 1, part 2 will not be evaluated.


NOTE

The Server attribute is only used for consoleEZ (Mandatory for Target="LogAnalyzer" or Target="VolumeAnalyzer").

The Index attribute sets the desired positive integer window index. This attribute is only used for consoleEZ (Mandatory for Target="LogAnalyzer" or Target="VolumeAnalyzer").