Text Parameter

This will prompt the user to enter a text value 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

<textParameter>
  <name>Target</name>
</textParameter>

Full example

<textParameter>
  <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>
</textParameter>

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>
    <textParameter>
      <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>
    </textParameter>
  </parameters>
</project>

Configuration Elements

Element	Description	Type	Required	Default	Version
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
maximum	The maximum allowed length of the parameter.	Int32	No	2147483647	1.5
minimum	The minimum allowed length.	Int32	No	0	1.5
name	The name of the parameter.	String	Yes	n/a	1.5

Automatically Generated

Documentation generated on Monday, 7 Dec 2009 at 3:18:31 AM

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