iConsole Search Definition Reference Guide › Reference Information › <search > Element

<search > Element

Defines an individual search, including the SP reference, screen labels, category and class, and whether the search displays in tabular format or in a report.

The supported entities are as follows:

<parameters>

See <parameters> Element.

<results>

See <results> Element.

spname

The name of the stored procedure that performs the search. This name is combined with the major and minor version numbers (see below) to generate the name used to call the stored procedure. For example:

spname="MyEmailSearch" 

You can create multiple search variants that all refer to the same stored procedure.

From version 5.0 onwards, this is simply a matter of creating search definitions with a different label but the same stored procedure name. To define a search variant prior to version 5.0, add a prefix to the stored procedure name. For example:

spname="simple.MyEmailSearch"

This specifies a search variant named 'simple' for the MyEmailSearch SP.

The stored procedure is limited to 64 characters.

Required: No

sppackage

A package name for the SP (Oracle only).

The package name is limited to 30 characters.

Required: No

major

The major version number of the search. For example:

major="2"

Search definitions with different major versions are not guaranteed to be compatible.

Required: Yes

minor

The minor version number of the search. For example:

minor="1"

Search definitions with different minor versions but the same major version are guaranteed to be compatible with existing customized searches.

Required: No

label

A text label used to identify the search in the iConsole search screens. For example:

label="My First Search" 

The label for the search is limited to 64 characters.

Required: Yes

description

A brief description of the search. This is shown below the search label in the iConsole Search screen. For example:

description="Finds e-mails with specific titles"

The description for the search is limited to 255 characters.

Required: No

class

The search class determines which set of predefined tools (that is, toolbar buttons) are available in the Search Results screen, and the privileges required to access the search.

For the current release, the following search classes are supported:

class="EventReview"
class="EventReport"
class="Administration"

The first two classes support Security ID checking when this is enabled (see Security ID Processing ) and require Events: View captured data and either Events: Allow event searches for metadata searches or Events: Allow content searches for content searches.

Required: No

help

Specifies the path and file name of the HTML page containing the help for the current custom search. The path is relative to the front-end Web server virtual directory. For example:

help="help/htm/MyEmailSearchHelp.htm"

Required: No

help_icon

Specifies the path and file name of the image used for the help button for the current custom search. If this parameter is not specified, the default image is used. The path is relative to the front-end Web server virtual directory. For example:

help_icon="help/htm/MyHelpButton.gif"

Note: In the search screen, the help button always appears below the custom help parameters and before the default sort and save options. See the example search results screenshot in Example iConsole Screens.

Required: No

quick

Default to false. This is a Boolean attribute. If the search typically runs very quickly, set this to 'true' to bypass the Search Progress page. For example:

quick="true"

Note: Quick searches cannot be canceled.

Required: No

refresh

Specifies an interval (in seconds) between automatic refreshes of the search results. For example, you can use this attribute to automatically update simple searches that return a statistical counter. For example, to update the results every minute:

refresh="60"

Required: No

category

Published searches can be organized into categories. This attribute specifies which category the search is listed under the 'Published' folder in the iConsole. For example:

category="Compliance breaches"

The category is limited to 20 characters.

Required: No

type

Specifies the type of search. Typically, this attribute is only used to specify 'System' searches, listed under the System folder in the iConsole. The full range of supported search types is:

type="system"

type="published" 

type="unpublished" 

Required: No

database

Specifies which type of database to access. This can be:

database="cache" 
database="cms " 
database="combined " 
database="content " 

Required: No

max_rows

Specifies the maximum number of rows that can be cached for in‑memory sorting. This attribute overrides the system-wide maximum defined in the registry.

The category is limited to 20 characters.

Required: No

report

Specifies whether search results are displayed in a report.

report="true"

Required: No

show_parameters

Specifies whether the search parameters used in the search are displayed in the resulting report where report="true". For example:

show_parameters="true"

Required: No

no_cache

Specifies that the search results are not cached on the iConsole application server. This attribute is intended for use with searches that will only retrieve a single record. Its purpose is to avoid loading the cache unnecessarily, which could undermine the performance of subsequent searches.

no_cache="true"

Required: No

requires

Specifies the version of the iConsole product (both web and application servers) that is required to support this search definition. This will be needed where the search definition takes advantage of a new feature (for example, parameter type) only available in this version. For details see Search Visibility:

requires="12.5"

Required: No

tabular

Used in conjunction with the report attribute. When set to false allows searches that return only a single result to format this as a list of column values rather than in a table.

tabular="false"

Required: No

target (no longer supported)

Advanced Use Only. Specifies a target XML stylesheet to be used to format the results in place of the default results page. This requires the development and installation of an XML stylesheet (for example, MyResults.xsl).

target="MyResults"

The target is limited to 20 characters.

Required: No

restricted

Advanced Use Only. Specifies whether the search should be run restricted (i.e. apply RLS - the default), or unrestricted. In a derived search restricted may be set to true only if the baseline search is set to false, such as a derived search can only be made more restrictive.

restricted="false"

Required: No

baseline

Advanced Use Only. For a manually created derived search, specifies the name of the search upon which the derived search is based.

Required: No

base_section

Advanced Use Only. For a manually created derived search, specifies the location of the search upon which the derived search is based.

Required: No

legal

Specifies a legal notice to be included in the search definition. If prefixed with ‘*’ has the same effect as task_page="true".

legal="© Copyright CA 2010. All rights reserved."

Required: No

task_page

When true specifies that the search should have a tab of its own on the iConsole main page.

task_page="true"

Required: No