Parameter Widget Examples

This document is a guide to the various types of parameter widgets available, and the syntax for creating them.

String types

Parameters that have a string value should be of the phylum string

Freeform strings

Freeform strings do not need to specify any other specific format or type information.

<parameter phylum="string" cardinality="single" key="result"
              friendly-name="Result Name"  group="Required" />

String selection

To select a particular string from a list, the format should be specified as select, and a set of values should be included.

<parameter phylum="string" format="select"
            group="Required"  cardinality="single" key="test" friendly-name="Test" >
      <values>
         <value>choice1</value>
         <value>choice2</value>
         <value>choice3</value>
      </values>
</parameter>

Boolean values

All boolean values should be specific by phylum boolean.

Checkboxes

Checkboxes are the default widget for boolean values.

<parameter phylum="boolean" cardinality="single" key="choice"
              friendly-name="Check Me"  group="Required" />