Select Parameter

This will prompt the user to select a value from a list of values when a force build is requested.
This parameter can then be used by a dynamic value in a task.

Version

Available from version 1.5

Examples

Minimalist example

<selectParameter>
  <name>Target</name>
  <allowedValues>
    <value name="Development">DEV</value>
    <value name="Test">TEST</value>
    <value name="Production">PROD</value>
  </allowedValues>
</selectParameter>

Full example

<selectParameter>
  <name>Target</name>
  <display>Target to Build</display>
  <description>Which target do you want to build?</description>
  <default>DEV</default>
  <minimum>3</minimum>
  <maximum>10</maximum>
  <required>false</required>
  <sourceFile>C:\Builds\Values.txt</sourceFile>
</selectParameter>

Example in Context

<project name="Test Project">
  <sourcecontrol type="svn">
    <!-- Omitted for brevity -->
  </sourcecontrol>
  <triggers>
    <intervalTrigger />
  </triggers>
  <tasks>
    <!-- Omitted for brevity -->
  </tasks>
  <publishers>
    <!-- Omitted for brevity -->
  </publishers>
  <parameters>
    <selectParameter>
      <name>Target</name>
      <allowedValues>
        <value name="Development">DEV</value>
        <value name="Test">TEST</value>
        <value name="Production">PROD</value>
      </allowedValues>
    </selectParameter>
  </parameters>
</project>

Configuration Elements

Element	Description	Type	Required	Default	Version
allowedValues	An array of allowed values.	Named Value array	No	None	1.5
default	The default value to use.	String	No	None	1.5
description	The description of the parameter.	String	No	None	1.5
display	The display name of the parameter.	String	No	None	1.5
required	Is the parameter required?	Boolean	No	false	1.5
name	The name of the parameter.	String	Yes	n/a	1.5
sourceFile	Load the values from a file.	String	No	None	1.5

Notes

In order for this parameter to work, either the allowed values or a source file must be set. If both are set, the source file will be used.

Automatically Generated

Documentation generated on Monday, 7 Dec 2009 at 3:22:47 AM

Document generated by Confluence on Jan 23, 2011 08:52