WAAPI elements

The elements that are defined in the WAAPI DTD.

If you use a deprecated element, an entry is logged in JazzSM_Home/ui/logs.

<acl>

Obsolete: To migrate existing WAAPI scripts that use this element, use the IBM® WebSphere® Application Server wsadmin scripting commands. For more information about wsadmin scripting, go to http://publib.boulder.ibm.com/infocenter/wasinfo/v6r1/index.jsp and search for wsadmin scripting.

<button>

This element is a child element of the <map> element, and is used to define how buttons are displayed.

<cgi>

This element is a child element of the <method> element, and is used to register, modify, or unregister common gateway interface (CGI) programs that on the Web GUI server. Unregistering a CGI does not remove the CGI file from the server.

<columns>

This element is a child element of the <view> element, and is used to define the appearance of column entries within the AEL.

<dependentList>

This element is a child element of the <method> element and is used to specify a list of dependent filters.

<entity>

Deprecated: Use the <filter> element instead of this element.

<entitygroup>

Deprecated: Use the <filterCollection> element instead of this element.

<entitylist>

Deprecated: Use the <dependentList> element instead of this element.

<entityview>

Deprecated: Use the <view> element instead of this element.

<file>

This element is a child element of the <method> element, and is used to add, remove, or recursively remove files and directories. It can also be used to move files from one location to another.

<filter>

This element is a child of the <method> element, and is used to specify a filter.

<filterCollection>

This element is a child element of the <method> element and is used to specify a filter collection.

<icon>

This element is a child element of the <map> element, and is used to define how icons are displayed.

<line>

This element is a child element of the <map> element, and is used to define how lines are drawn.

<map>

This element is a child element of the <method> element, and is used to add, remove, or configure maps. This element has a number of child elements that define the appearance and behavior of map features such as lines and monitor boxes.

<member>

Obsolete: This element is a child element of the <acl> element.

<menu>

This element is a child element of the <supermenu> element, and is used to define menu entries within the AEL. See <supermenu>.

<method>

This element is the only child element of the <methodCall> element, and contains the group of child elements that govern all of the administrative areas of the Web GUI.

<methodCall>

This element is the root element. The root element is the top-level element in the XML document hierarchy, and contains all other elements in your XML file. Each document can have only one root element, and all other elements must be nested within it. The <methodCall> element must contain at least one <method> element.

<metric:command>

This element is a child element of <metric.metric> and must be used with the metric namespace. The element defines the type of command that obtains the current value of the gauge in the type attribute and the mode that is used to create the metric.

Resolved from fix pack
1 The basic mode for creating, replacing, or modifying a metric has been deprecated. The advanced mode now ensures that any restriction filters are applied to the query.

<metric:metric>

This is a child element of <method> and must be used with the metric namespace. The element identifies a metric (gauge) and optionally defines its characteristics by using the following attributes:

name: Required: The name of the metric.
description: A description of what the gauge displays.
descriptionKey: A key that uniquely identifies the description.
displayName: The name that appears on the Gauges page.
displayNamekey: A key that uniquely identifies the display name.
units: The units that the gauge displays.
unitsKey: A key that uniquely identifies the units.
maxValue: The maximum value that the gauge can display.
minValue: The minimum value that the gauge can display.
threshold1: The threshold between the gauge's low and medium ranges.
threshold2: The threshold between the gauges medium and high ranges.

<metric:text>

This is a child element of <metric.command> and must be used with the metric namespace. The element defines the text of the command that obtains the current value of a metric (gauge) in its data attribute, when in advanced mode. For basic mode, the command is contained in the selectField, whereCaluse, databaseName, and tableName attributes.

<monitor>

This element is a child element of the <map> element, and is used to define the appearance and behavior of a monitor box.

<prompt:prompt>

This element is a child element of the <tools> element, and is used to specify the options that are presented to the user (in the form of a menu prompt) when an SQL tool is selected in the AEL. This element has the following attributes:

name: Uses a predefined SQL variable to parse the execution options.
type: Indicates the type of prompt that is used to display the execution options. The default value is choice, which dynamically presents the data in a list.

<prompt:parameters>

This element defines the main parameters that are needed for all prompt types and must always be used with the prompt namespace. The attributes are as follows:

label: Records the text users see when the prompt appears, typically an instruction.
order: Sets the order relative to other prompts within the window.
localized: Defines whether a prompt can be localized, and can be set to either true or false
errorMessage: Defines text that is displayed in responses to an incorrect response to a prompt.
defaultValue: Records a default value a user can accept, such as the default path to a data source.

<prompt:additionalParams> (<prompt:param>)

This element defines additional parameters that are needed by some prompt types and must always be used with the prompt namespace. The attributes that define the additional parameters are name and value.

<prompt:choice> (<prompt:item>)

This element defines the choices available for Fixed Choice prompts and must always be used with the prompt namespace. The attributes that define the additional parameters are value and label.

<resource>

This element is a child element of the <resources> element, and is used to select the background image that is used in a map view.

<resources>

This element is a child element of the <method> element. See <resource>.

<separator>

This element is a child element of the <supermenu> element, and inserts a separator line into a menu. See <supermenu>.

<session>

Obsolete.

<sortColumn>

This element is a child element of the <sorting> element, and is used to create a view configuration within the Web GUI. Use this element to add entries to the Sorted By field for views, and to determine the order in which the entries are displayed.

<sorting>

This element is a child element of the <view> element. See <sortColumn>.

<supermenu>

This element is a child element of the <method> element, and is used to add, remove, or configure top-level menus within the Web GUI. The <supermenu> element can contain lower-level menus entries, which are defined by the <menu> element. In addition, the <supermenu> element can also contain the <tool> element. See also <tool>.

<text>

This element is a child element of the <map> element, and is used to define how text is displayed.

<tool:access>

This element must always be used with the tool namespace. This element defines access criteria for an AEL tool.

<tool:cgiurl>

This element must always be used with the tool namespace. This element defines a CGI/URL tool.

<tool:cmdline>

This element must always be used with the tool namespace. This element defines a command-line tool.

<tool:command>

This element must always be used with the tool namespace. This element defines a platform-specific command within a command-line tool.

<tool:criterion>

This element must always be used with the tool namespace. When <tool:criterion> is a child of <tool:osfield>, the name attribute must have the value Class. This value refers to the Class field in the ObjectServer. When <tool:criterion> is a child of <tool:security>, the name attribute must have the value Group. This value refers to the Dashboard Application Services Hub group.

Other fields from alerts.status can be used as values.

<tool:equals>

This element must always be used with the tool namespace. This element is used to assign a value to the object that is identified by the <tool:criterion> element.

<tool:field>

This element must always be used with the tool namespace. This element defines an ObjectServer field to be used in CGI/URL tools.

<tool:fieldlist>

This element must always be used with the tool namespace. This element contains a list of ObjectServer fields to be used in CGI/URL tools.

<tool:journal>

This element must always be used with the tool namespace. This element contains the journal entry to be made when an AEL tool is run.

<tool:notequals>

This element must always be used with the tool namespace. This element is used to assign a non-matching value to the object that is identified by the <tool:criterion> element.

<tool:osfield>

This element must always be used with the tool namespace. This element contains any ObjectServer fields that are used in an AEL tool.

<tool:security>

This element must always be used with the tool namespace. This element contains groups that are used to define access criteria for AEL tools.

<tool:script>

This element must always be used with the tool namespace. This element contains the script and the associated options for a script tool and attributes are for each command.

<tool:sql>

This element must always be used with the tool namespace. This element contains the SQL command and the associated options for an SQL AEL tool.

<tool:tool>

This element must always be used with the tool namespace. This element contains all operations (adding, deleting, or modifying) that relate to a single AEL tool.

<view>

This element is a child element of the <method> element, and is used to add, remove, or configure views.

<visualEntry>

This element is a child element of the <columns> element, and is used to define how a view column is displayed.