Previous Topic: Default Sort and Column Selection OptionsNext Topic: Search Class


XML Elements

The main elements and attributes are summarized below.

<searches> root element

The root element must be <searches> and it must declare the XML Schema namespace and the location of the search definition schema document.

<search> element

The <search > element attributes define the name of the stored procedure (spname), the major and minor versions, a label that identifies the search in the iConsole, a description of the search, and an HTML help page and image for the help button.

<parameter> element

In the MyEmailSearch example, the <parameters> collection contains a single <parameter> element with these attributes:

name

This can be used in to identify the parameter in a script. It does not need to match the argument name in the SP.

type

This parameter type must be compatible with the SP.

label

This specifies the text that is shown next to the search parameter in the Customize Search screen in the iConsole.

argpos

This specifies the order in which the parameter is listed in the arguments passed to the SP (see the CREATE line in the examples on page ). This allows you to change the parameter layout in a search screen independently of the order they are passed to the SP.

<results> element

This defines the columns in the search results screen. In the MyEmailSearch example, there are two <column> elements for the event UID and e-mail title columns. Each <column> element has these attributes:

name

The column name must match the name in the SP.

type

This column type must be compatible with the database type.

label

This specifies the column heading shown in the Search Results screen in the iConsole.

More information:

Search Result Column Type Mappings

Parameter Type Mappings

Reference Information