Predefined Properties

The predefined properties can originate from several scopes:

• Server Build Properties - the properties provided by TeamCity on the server-side in the scope of a particular build. An example of such property is a build number
• Agent Properties - properties provided by an agent. The properties are not specific to any build and characterize agent environment. e.g. path to .Net framework.
• Agent Build Properties - properties provided on the agent side in the scope of a particular build. These properties are passed into a build. e.g. path to a file with a list of changed files.

Server Build Properties

System Property Name	Environment Variable Name	Description
teamcity.version	TEAMCITY_VERSION	Version of TeamCity server. This property can be used to determine the build is run within TeamCity.
teamcity.projectName	TEAMCITY_PROJECT_NAME	Name of the project the current build belongs to.
teamcity.buildConfName	TEAMCITY_BUILDCONF_NAME	Name of the Build Configuration the current build belongs to.
build.is.personal	BUILD_IS_PERSONAL	Is set to true if the build is a personal one. Is not defined otherwise.
build.number	BUILD_NUMBER	Build number assigned to the build by TeamCity using the build number format. The property is assigned based on the build number format.
build.vcs.number.<simplified VCS root name>	BUILD_VCS_NUMBER_<simplified VCS root name>	Latest VCS revision included in the build for the root identified. Here <simplified VCS root name> is the VCS root name with all non-alphanumeric characters replaced with _ symbol. Please ensure your VCS roots names differ sufficiently and are not mapped into the same simplified name (in this case the value of the property can get any). If there is only a single root in the configuration, build.vcs.number property (without the root name) is also provided. Please note that this value is a VCS-specific (e.g. for SVN the value is a revision number while for CVS it is a timestamp) In previous versions of TeamCity we used different format for VCS build number: {build.vcs.number.N} where N is VCS root order number in the build configuration. If you still need this to work you can launch TeamCity with special JVM option: -Dteamcity.buildVcsNumberCompatibilityMode=true

For a complete list of supported properties please refer to the Properties and environment variables section of Build Configuration settings in TeamCity Web UI.

Agent Properties

Agent-specific properties are defined on each build agent and vary depending on its environment. Aside from standard properties (for example os.name or os.arch, etc. — these are provided by JVM running on agent) agents also have properties based on installed applications. TeamCity automatically detects a number of applications including the presence of .NET Framework, Visual Studio and adds the corresponding system properties and environment variables. A complete list of predefined agent-specific properties is provided in the table below.

If additional applications/libraries are available in the environment, the administrator can manually define the property in the <agent home>/conf/buildAgent.properties file. These properties can be used for setting various build configuration options, for defining build configuration requirements (e.g. existence or lack of some property) and inside build scripts. For more information on how to reference these properties see Using Properties page.

The actual properties defined on agent can be reviewed on the Agent Details page.

Make sure to replace "." with "_" when using properties in MSBuild scripts. That is use teamcity_dotnet_nunitlauncher_msbuild_task instead of teamcity.dotnet.nunitlauncher.msbuild.task _x86 and _x64 property suffixes are used to designate the specific version of the framework. teamcity.dotnet.nunitlauncher properties can not be hidden or disabled.

You can disable the automatic detection of the predefined properties by editing the buildAgent.properties file and adding the disableDotNetDetection property.

Please note that disableDotNetDetection property is case-sensitive.

This property can have the following values:

You can refer to the Agent Details page of the TeamCity web UI to view properties set for a particular Build Agent.

Agent Build Properties

These properties are unique for each build: they are calculated on the agent right before the build start and are then passed into the build.

<relative file path>:<change type>:<revision>

See Also:

• Administrator Reference: Defining Properties | Using Properties
• UI Reference: Properties and environment variables