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

<tool> Element

The <tool> element in an XML search definition defines a custom tool in the toolbar of the Search Results page.

The supported entities are as follows:

name

Specifies the required name of the tool.

tooltip

(Optional) Specifies the tooltip text shown when the mouse pointer hovers over the toolbar button.

Example:

tooltip="My button"

icon

Specifies the required icon file for the toolbar button.

Example:

icon="MyButton.gif"

The image file must be in the \images folder in the CA DataMinder installation folder on the iConsole front-end Web server.

function

Specifies the required function that is called when a reviewer clicks the toolbar button. See Standard Scripting Functions.

Example:

function="MyTool"