When adding a build parameter (system property, environment variable, or configuration parameter) you can extend its definition with specification that will regulate parameter's control presentation and validation.
This specification is a parameter's "meta" information that is used to display parameter in Run custom build dialog. It allows to make custom build run more user-friendly and usable by non-developers.
Consider a simple example. You have a build configuration in which you have a monstrous-looking build parameter that regulates if a build has to include license or not; can be either true or false; and by default is false. It may be clear for a build engineer, which build parameter regulates license generation and which value should it have, but it can be not obvious to a regular user. With build parameter's specification you can make your parameters more readable in "Run custom build" dialog. Currently you can present parameters in following forms:
The default. Represents a usual text string without any extra handling
True/false otpion represented with a checkbox.
"Select one" or "select many" control to set the value to one of predefined settings
Setting the parameter to type password does not guarantee that the raw value cannot be retrieved. Any project administrator can retrieve it and also any developer who can change the build script can in theory write malicious code to get the password.
- simple text field with ability to validate its value using regular expression;
- check box;
- select control;
- password field.
Pattern: In this field specify Java-style regular expression to validate field value.
Check box name: Title of the check box to be displayed in Run Custom Build dialog.
Select Control (Enum)
Items: Specify items for the list. Each item on new line. Use following syntax
A password specification serves different purpose. It allows you to avoid storing passwords in settings. Instead, values of password parameters will be hidden from build log, and from Build Parameters tab of the build. Also it is impossible to see values of these parameters in custom build dialog. In configuration files such parameters are stored in scrambled form.
Manually configuring parameter's specification
Alternatively you can manually configure a specification using specially formatted string with syntax similar to the one used in service messages (
For example, for text:
text label='some label' regex='some pattern'.
Copying parameter's specification
If you start editing a parameter that has some specification, you can see a link to its raw value in "Edit parameter" dialog. Click it to view the specification in its raw form (in service message format). To use this specification in another build configuration, just copy it from here, and paste in another configuration.
Administrator's Guide: Configuring Build Parameters | Defining and Using Build Parameters in Build Configuration | Predefined Build Parameters