Skip to end of metadata
Go to start of metadata
You are viewing documentation of TeamCity 6.5.x, which is not the most recent released version of TeamCity. Please refer to the listing to choose another version.

Table of Contents

This page contains descriptions of the fields and options available when setting up VCS roots using Perforce:


If you plan to use agent-side checkout mode, note that Perforce client must be installed on the agents, and path to p4 executable must be added to the PATH environment variable.

P4 Connection Settings




Specify the Perforce server address. The format is host:port.


Click this radio button to directly specify the client workspace. The workspace should already be created by Perforce client applications like P4V or P4Win. Only mapping rules are used from the configured client workspace. The client name is ignored.

Performance impact


When this option is used, internal TeamCity source caching on the server side is disabled, which may worsen the performance of clean checkouts. For maximum performance, we recommend using Client Mapping option (see below)

Client Mapping

Click this radio button to specify the mapping of the depot to the client computer.
If you have Client mapping selected, TeamCity handles file separators according to OS/platform of a build agent where a build is run. To enforce specific line separator for all build agents, use Client having LineEnd option specified in Perforce instead of Client mapping. Alternatively you can add an agent requirement to run builds only on specific platform.



Use team-city-agent instead of the client name in the mapping.



Specify the user login name.


Specify the password.

Path to P4 executable

Specify the path to the Perforce command-line client: p4.exe file). This path will be used both for server-side checkout and for agent-side checkout. If you need different values for this path on different build agents when using agent-side checkout, you can set the value using TEAMCITY_P4_PATH environment variable in file

Ticket-based authentication

Check this option to enable ticket-based authentication.


Select the character set used on the client computer.

Support UTF-16 encoding

Enable this option if you have UTF-16 files in your project.

Workspace options for checkout on agent

If needed, you can set here the following options for p4 client command: Options, SubmitOptions, and LineEnd.


To customize the workspace name when using client side checkout add following configuration parameter at the Build Parameters page:

Changes Checking Interval



Checking interval

Select here how often TeamCity should check for VCS changes. By default the global predefined server setting is used, that can be modified at the Administration > Server Configuration page. The interval's time starts being counted as soon as the last VCS server poll is finished. Here you can specify here custom interval for the current VCS root.


Some public servers can block access if polled frequently.

VCS Root Sharing



VCS Root Sharing

Enable this option to use this VCS root in other projects or build configurations. See Shared VCS Roots for more information.

See also:

Administrator's Guide: VCS Checkout Mode

1 Comment

  1. Some notes on Perforce integration as of TeamCity 5.1