The Zoom element in an XML search definition 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:
See <parameters> Element.
See <results> Element.
(Optional) Specifies whether to hide the Settings tab in the Search Properties dialog. By default, this tab is displayed and contains options such as the Column Selector and Display Sort Order. Set this attribute to 'true' to hide the Settings tab:
no_settings="true"
(Optional) Defines 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.
Example:
spname="MyEmailSearch"
You can create multiple search variants that all refer to the same stored procedure: Create search definitions with a different label but the same stored procedure name.
Example:
spname="simple.MyEmailSearch"
This specifies a search variant named 'simple' for the MyEmailSearch SP.
Limits: 64 characters
(Optional) Specifies the package name for the SP (Oracle only).
Limits: 30 characters
Defines the required major version number of the search. Search definitions with different major versions are not guaranteed to be compatible.
Example:
major="2"
(Optional) Defines the minor version number of the search. Search definitions with different minor versions but the same major version are guaranteed to be compatible with existing customized searches.
Example:
minor="1"
Defines the required text label used to identify the search in the iConsole search screens.
Example:
label="My First Search"
Limits: 64 characters
(Optional) Defines a brief description of the search. This is shown below the search label in the iConsole Search screen.
Example:
description="Finds emails with specific titles"
Limits: 255 characters
(Optional) Specifies the search class which determines the set of predefined tools (that is, toolbar buttons) that 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.
(Optional) Defines 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.
Example:
help="help/htm/MyEmailSearchHelp.htm"
(Optional) Defines 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.
(Optional) Specifies whether you want to bypass the Search Progress page. If the search typically runs very quickly, set this to 'true'.
Default: false
Example:
quick="true"
Note: Quick searches cannot be canceled.
(Optional) 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.
Example: Use the following value to update the results every minute:
refresh="60"
(Optional) Specifies under which category the search is listed. You can organize published searches into categories in the 'Published' folder in the iConsole.
Example:
category="Compliance breaches"
Limits: 20 characters
(Optional) 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"
(Optional) Specifies which type of database to access. This can be:
database="cache" database="cms " database="combined " database="content "
(Optional) 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.
Limits: 20 characters
(Optional) Specifies whether search results are displayed in a report.
Example:
report="true"
(Optional) Specifies whether the search parameters used in the search are displayed in the resulting report where report="true".
Example:
show_parameters="true"
(Optional) Specifies that the search results are not cached on the iConsole application server. This attribute is intended for use with searches that only retrieve a single record. Its purpose is to avoid loading the cache unnecessarily, which could undermine the performance of subsequent searches.
Example:
no_cache="true"
(Optional) Specifies the version of the iConsole product (both web and application servers) that is required to support this search definition. You need to specify the version if the search definition takes advantage of a new feature (for example, parameter type) which is only available in this version. For details see Search Visibility.
Example:
requires="12.5"
(Optional) Specifies whether to allows searches that return only a single result to format this as a list of column values (false) rather than in a table (true). Used in conjunction with the report attribute.
Example:
tabular="false"
(Optional) Specifies a target XML stylesheet 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).
Advanced use only.
Example:
target="MyResults"
Limit: 20 characters
(Optional) Specifies whether the search should be run restricted (that means, 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.
Advanced use only.
Example:
restricted="false"
(Optional) For a manually created derived search, specifies the name of the search upon which the derived search is based.
Advanced use only.
(Optional) For a manually created derived search, specifies the location of the search upon which the derived search is based.
Advanced use only.
(Optional) Specifies a legal notice to be included in the search definition. If prefixed with ‘*’ has the same effect as task_page="true".
Example:
legal="© Copyright CA 2010. All rights reserved."
(Optional) Specifies whether the search should have a tab of its own on the iConsole main page.
Example:
task_page="true"
(Optional) Specifies that the search should open in the properties window (true) rather than in the results window (false). Setting this attribute to true allows the user to specify parameters for each run. A typical case where the user generally wishes to specify a search term is the Content Search.
Example:
must_edit="true"
|
Copyright © 2014 CA.
All rights reserved.
|
|