Jump to: navigation, search

Dialog Input Elements

The <dialog> tags define the user-interface elements that are displayed in the wizard to collect user input. A <dialog> section can have one or more <input> elements to collect user input.

<input>

The <input> tag defines user-interface elements in the wizard to collect user input. One <dialog> tag can have one or more <input> elements to collect user input. It can define different types of input (for example: string, integer, date, boolean, selectOne or selectMultiple configuration objects), and validation rules for these inputs.

Child Elements

Attributes

Name

Type

Description

Default

Values

default

string

Defines the default value to display in the user interface as the default input value.

hidden

Boolean

Defines whether to hide the input parameter in the user interface (true == hide, false == show). You can use this attribute in conjunction with a JavaScript expression evaluation to dynamically hide or show an input parameter in a subsequent <dialog>.

false

name

string (required)

A unique name for this input parameter. A JavaScript variable with this name is instantiated where the entered value is stored.

readonly

Boolean

Defines whether the input parameter is read-only or changeable in the user interface (true == readonly, false == changeable). You can use this attribute in conjunction with a JavaScript expression evaluation to dynamically hide or show an input parameter in a subsequent <dialog>.

false

required

Boolean

Defines whether an input value is a required parameter. If it is a required parameter, it must be filled out prior to advancing to the next step in the wizard.

false

title

string

Defines the title that is displayed in the user interface for this input element.

type

string

Defines the expected input type and constrains what the user can input.

string

string, integer, boolean, password, selectOne, selectMultiple

<description>

This tag describes what the SPD will do. For example:

<description>This is the solution file to deploy a GVP solution</description>

The <input> tag can be used to provide descriptive information that helps the user to determine what to fill in for the input value.

This element has no attributes or child elements.

<objectselect>

For <input> elements with type="selectOne" or type="selectMultiple", this tag can be used to indicate that a configuration object is to be selected. The child <filter> element(s) indicate to the user interface which configuration object is to be selected for this <input> element.

This element has no attributes.

Child Elements

<filter>

Defines a user-interface element to filter the objects displayed in the object picker. Multiple <filter> elements can be defined.

This element has no child elements.

Attributes

Name

Type

Description

Default

Values

name

string (required)

Defines the parameter of an to use as a filter. The following parameters are supported: "type", "subtype" and "name".

value

string (required)

Defines the value for a filter. For example:

<filter name="type" value="CfgApplication" />
<filter name="subtype" value="CfgGVPMCP" />
<filter name="name" value="MCP" />

<selection>

For <input> elements with type="boolean", type="selectOne", or type="selectMultiple" types, the <selection> tag can be used to specify a constrained list of input values. The child <option> elements can define these allowed input values, or a JavaScript array can be used to define these allowed input values.

Child Elements

Attributes

Name

Type

Description

Default

Values

array

string

Specifies a JavaScript variable that contains a simple array of values to be used as the allowed input values in the user interface.

errormsg

string

Specifies an error message to display in the user interface if no value is selected.

index

string

Specifies the name of a JavaScript variable that contains the index value when the array renders the user interface. This value can be used in the <option> tag to provide a more intuitive user interface.

<option>

The <option> element can be used as a template when an array is specified in the <selection> element. For example:

<selection array="foo" index="i" errormsg="Please select a value from Foo.">
    <option name="${foo[i].firstname+' '+ foo[i].lastname}" value="${i}"/>
</selection>

Attributes

Name

Type

Description

Default

Values

default

Boolean

Defines whether this option is selected by default in the user interface.

false

name

string (required)

Defines the option name to be displayed in the user interface.

value

string (required)

Defines the value to be assigned to the input parameter JavaScript variable if this option is selected.

<validation>

For <input> elements with type="string" or type="integer" types, this element can be used to specify validation constraints on the input value.

Child Elements

Attributes

Name

Type

Description

Default

Values

default

string

Defines whether by default the input value is accepted or rejected. If default="accept" is specified, then all <rule> elements must be set to type="reject". If default="reject" is specified, then all <rule> elements must be set to type="accept".

accept

accept, reject

errormsg

string

Specifies an error message to be displayed in the user interface if the value is rejected. This attribute is required if default="reject" is specified.

<rule>

Defines a validation rule.

This element has no child elements.

Attributes

Name

Type

Description

Default

Values

errormsg

string

Specifies an error message to be displayed in the user interface if the value is rejected. This attribute is required if type="reject" is specified.

expr

string

Defines a JavaScript expression to be evaluated. It must evaluate to a true (non-falsy) value for the input to be accepted or rejected, depending on the rule type.

range

string

If specified, then wildcard is ignored. This attribute defines a range of values for the input value to be accepted or rejected, depending on the rule type. For example: range="1,3,4-8,>20,<100".

regex

string

If specified, then range and wildcard are ignored. This attribute defines a regular expression that must be matched for the input value to be accepted or rejected, depending on the rule type.

type

string

Defines the type of validation rule.

accept

accept, reject

wildcard

string

If specified, then this attribute defines a wildcard string that must be matched for the input value to be accepted or rejected, depending on the rule type. Wildcard characters include "*" and "?". For example: wildcard="foo*", wildcard="b?r", and wildcard="*sg03*".

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on February 10, 2015, at 14:16.