Creating custom tool definition files for HP Systems Insight Manager 5.1 or greater (481365-002, January 2009)

26
Appendix D: Common tool attributes
Table D
-
1
lists the common name values avai
lable to use for TDEFs.
Table D
-
1
.
Common attribute name values
Names Values
Description
Task Wizard names values
show
-
cmdline
Displays command line equivalent of GUI action.
Values: True | False (default: true)
Custom
-
pa
ge
-
n
Value is a string giving relative path to jsp page that should be displayed, where n =
sequential value starting at 1.
ListType
Limits the types of selections available for choosing to only System Lists or only Event Lists.
If
this value is not prese
nt then both System and Events lists are available.
Values: systemLists | eventLists
SelectionType
Limits the type of selections allowed for the tool.
If “list”, then only lists (criteria) are allowed
for selection.
If “collection”, then only collection
s (non
-
criteria) are allowed for selection.
If
“individual”, then only individual systems are allowed for selection. Values: list | individual
| collection
Targets
-
are
-
events
This informs the task wizard that the selections made for this tool are the a
ctual events and
not the systems from which the events were generated, which is the default behavior.
When
using this attribute, the task wizard will assume a “listType” or “eventLists” and a
“selectionType” of “list”.
PageIndex
By default, the task wiza
rd displays the target selection page as the first page during task
creation.
When a tool defines its own custom parameter pages, they may instruct the task
wizard where to place the target selection page. n = value starting at 1.
TargetSelection
lockTar
getSelection
A tool may wish to show the target selection page without allowing the user to change the
target.
Values: true | false
(default: false)
Defined name values
product
-
name
32 character string
Product
-
version
24 character number
Insert
-
separ
ator
Insert a separator line in the menu structure before (“true”) or after (“after”) this tool. Values:
true | after | false
(default: false)
I18n
-
attrs
String. Name of a resource bundle for storing localized tool parameters. See the section on
tool inte
rnationalization.
Tool
-
id
String.
Normally, the portal will refer internally to the tool using its database GUID. If a tool
needs a well
-
known ID that will not change, this attribute can be used.
Show
-
selections
Have the portal show
—
in the workspace
—
the
number of selected nodes, linked to a popup
window that displays a list of selected nodes.
Values: true | false
(default: false)
help
-
url
String. Set this URL as the portal’s current help URL when this tool loads. The help URL will be
loaded into a sepa
rate browser window, and the name of the browser frame will be
“helpWindow”.
All tools values
show
-
snap
-
off
Have the portal provide a hyperlink for tool’s workspace to be snapped off into a separate
browser window. Values: true | false (default: false)