Search:     Advanced search

Surround SCM TeamCity Integration

Article ID: 765  |  Last updated: 28 Mar, 2018

Surround SCM supports integration with TeamCity.

This article includes information about integration requirements, installing the plug-in, configuring a Surround SCM repository as a VCS root, and managing the version control username setting for notifications.


  • Make sure you are using a supported TeamCity version.
  • The Surround SCM command line client (CLI), sscm.exe, must be installed on the build server computer. If you use agent-side check outs, the CLI must also be installed on the agent computer.
  • You must have permission to log in to Surround SCM and get files. If you use labels in TeamCity, you must use Surround SCM 2013.2 and later and have permission to label files in Surround SCM.

Installing the plug-in

Note: Make sure you are using the current TeamCity integration plug-in version. The plug-in is backward compatible, which means it supports data created using earlier plug-in versions but not later versions. The current plug-in version is 2.1, which was released in December 2014.

  1. Download the plug-in. Do not unzip the file.
  2. In TeamCity, click Administration.
  3. In the Server Administration area, click Plugins List.
  4. Click Upload plugin zip. The Upload File dialog box opens.
  5. Click Choose File to select the plug-in zip file.
  6. Click Save.
  7. Restart TeamCity.

Configuring a Surround SCM repository as a VCS root

The Version Control System (VCS) root is the Surround SCM branch and repository to associate with your build configuration.

  1. In TeamCity, choose Administration > Edit Build Configuration > Edit VCS Root.
  2. Select Surround SCM as the Type of VCS and enter a unique VCS root name.
  3. Enter the Surround SCM Application Directory path. The path must end with a slash. For example, C:\Program Files\Perforce\Surround SCM\ (Windows) or /usr/bin/ (Unix).
  4. Enter the Full Path to Repository to use as the root and the Branch name. The repository path cannot end with a slash.
  5. Enter the Surround SCM Server Address and Server Port. If you received a server settings file for RSA key exchange from your Surround SCM administrator, enter the full path to the XML file instead.
  6. Select Username and Password as the Authentication Method and enter the Surround SCM username and password.
  7. Specify the Checking interval to indicate how often TeamCity should check Surround SCM for changes.
  8. Optionally select Make this VCS root available for all projects.
  9. Click Save to attach the VCS root to the build configuration.

Managing version control username settings for notifications

To receive notifications about changes included in builds, you must update the VCS username association setting to use the following format: LastName, FirstName Initial. Do not use your Surround SCM username. See the TeamCity documentation for information about managing your user account.

Article ID: 765  |   Last updated: 28 Mar, 2018

Prev   Next
Surround SCM Visual Studio Integration     Surround SCM Adobe Illustrator, InDesign, and Photoshop...