beautypg.com

Brocade Virtual ADX Graphical User Interface Guide (Supporting ADX v03.1.00) User Manual

Page 277

background image

Brocade Virtual ADX Graphical User Interface Guide

265

53-1003242-01

XML schema element reference

B

variable.dataType

enumerated
string

The variable data type:

"xxxList" types are
comma-separated strings

"xxxNonBlank" types do not
allow empty strings

"predictor" is an enumerated
predictor type

"portOrProtocol" is either a
well-known port or valid
protocol number.

See

“templateVariableDataTypeEnum”

in the Brocade Virtual ADX XML
Programmer’s Guide
.

boolean

string

stringNoWhiteSpace

stringList

ipAddress

ipAddressNonBlank

ipAddressSubnet

ipAddressSubnetNonBlank

ipAddressList

ipAddressAndPort

macAddress

macAddressNonBlank

integer

integerNonZero

predictor

portOrProtocol

variable.screenPositionIndex

integer

The recommended position in a
User Interface layout

1 to 100. This hint is advisory; clients
are advised to use it but may not,
optional

variable.shortPrompt

string

The prompting text for user input

This hint is advisory; clients are
advised to use it but may not; optional

variable.longHelpText

string

The longer help text for user input

This hint is advisory; clients are
advised to use it but may not; optional

variable.defaultValue

string

The default value of the variable

If this variable is needed by any other
element and the default is empty,
then the template is considered "raw"
(not ready to execute for lack of input
data); optional

variable.visual

boolean

If "true", the variable should be
presented to users for input

If not included, the default is true;
optional

variable.allowBlank

boolean

If "true", the variable can have no
value

If not included, the default is false;
any template element using a blank
variable must be able to allow a blank
value and the template developer is
responsible to insure this; optional

variable.autoIncrement

boolean

if "true", the variable increments
when used in a "repeater”

If not included, the default is false;
numbers increment numerically, IP
addresses increment their last
address digit, strings have an
increasing number appended to them;
optional

variable.includeConditionally

container

Indicates the variable should only
be shown to users for input under
certain limited conditions

Sub-element "variableName" refers to
another variable, which must be
boolean; if the other referenced
variable is "true", then this variable
should be shown visually for user
input; optional

TABLE 88

Variable schema elements (Continued)

Element

Type

Description

Rules / Notes