You are viewing the documentation of TeamCity 8.x, which is not the most recently released version of TeamCity.
Go to the latest TeamCity documentation or refer to the listing to choose the documentation corresponding to your TeamCity version.


Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0


There are three types of build parameters:

  • Environment variables (defined using "env." prefix) are passed into the spawned build process as environment
  • System properties (defined using "system." prefix) are passed into the build scripts of the supported runners (e.g. Ant, MSBuild) as build-tool specific variables
  • Configuration parameters (no prefix) are not passed into the build and are only meant to share settings within a build configuration. They are the primary means for customizing a build configuration which is based on a template or uses a meta-runner .

There is a set of predefined parameters provided by TeamCity and administrators can also add custom parameters.

The parameters can be defined at different levels (in order of precedence):

  • in a specific build (via Run Custom Build dialog)
  • Build Configuration settings (the Build Parameters page of Build Configuration settings) or Build Configuration Template
  • Project settings (the Parameters page of the Project settings). These affect all the Build Configurations and Templates found in the project and its subprojects.
  • Agent (<Agent home>/conf/buildAgent.properties file on agent)

Any textual setting can reference a parameter which makes the string in the format of %parameter.name% be substituted with the actual value at the time of build.
If there is a reference to a parameter which is not defined, it is considered an implicit agent requirement so the build will only run on the agents with the parameter defined.

See more in the corresponding sections: Defining and Using Build Parameters in Build Configuration and Project and Agent Level Build Parameters.

Wiki Markup


Ensure these are described/linked:
- defining parameters in a build step, passing from one build step to another
- Build Parameters build tab
- dep. references
* In dedicated {{teamcity.default.properties}} file, which should be put in the VCS root.
{note}Please note that the agent's environment variables can vary depending upon which user the agent process is running. The list of environment variables available on a specific build agent can be found on the *Environment variables* tab of the *Agent Details* page.{note}

Need to separate the page "Project and Agent Level Build Parameters" (or just put all the data on parameters onto the same page)


See also:


Administrator's Guide: Configuring Agent Requirements | Defining and Using Build Parameters in Build Configuration | Project and Agent Level Build Parameters | Predefined Build Parameters