Previous Topic: Registry SettingsNext Topic: Search Definition Syntax


Reserved Parameter and Column Names

All parameter and column names beginning with $ are reserved for use by the iConsole. These reserved parameters are interpreted as having special meaning by the iConsole.

Name

Parameter/Column

Type

Description

$CONTROL

parameter

choice

This parameter signals to the iConsole when the results from the search will be a total record count or an unlimited result set, rather than a normal, limited result set.

$DEBUG

parameter

numeric

This parameter is used to request logging in the search stored procedure.

Although no special processing is performed in the iConsole, it is defined as a reserved word for future enhancement.

$GROUPS

Parameter

lookupbyid

When a group lookup parameter begins with '$GROUPS', the report value for the parameter is set to the list of the user's management groups when no groups are selected. (or the top level of the hierarchy if the user has the Admin: Disable Security Group Filtering privilege).

$ROWLIMIT

parameter

numeric

This parameter is used by the stored procedure to limit the number of results returned; this can make a significant difference to the performance of the procedure. If the value specified exceeds the currently defined system results limit the iConsole constrains it to that value. This is a performance optimization for SQL Server.

$SID

column

text

This column is used to return the Security ID associated with the record.