Installation Instructions

This is meant as a generic guide only and may not suite your particular application of the tool. For advanced installation assistance, please see the contact details listed for this project.
  1. Obtain the latest release
  2. Decide on an install location
    1. Recommended location is in your Program Files directory on your TFS Server e.g. C:\Program Files\TFS Replicator
    2. The service can also be installed on a separate server. This requires that the server has Team Explorer installed to enable communication with the TFS Server.
  3. Unzip the contents of the downloaded release package into your chosen folder. Once complete the folder should contain:
    1. DependencyReplicator.exe
    2. DependencyReplicator.exe.config
  4. Open a Command Prompt and run the following command (replacing the install path with the path to the folder you’ve unzipped the above files to)
    1. C:\Windows\Microsoft.NET\Framework\v2.0.50727\InstallUtil.exe /i “install path\DependencyReplicator.exe
  5. Complete the prompt shown during the installation – providing an account with sufficient access to poll the TFS server for changes.
    1. The recommended account is the configured build account
  6. Open the DependencyReplicator.exe.config file and set up the values based on your requirements. A table of configuration element descriptions can be found in the service configuration section of this document.
  7. In the command prompt execute the following command
    1. sc start DependencyReplicator

Dependency Replication Configuration

An xml file is required to specify the files that should be polled by dependency replicator for changes. The file should be placed in a well known location, which is the "$/TeamProjectName/TeamBuildTypes/" folder. The file should be named "DependencyReplicator.xml". This configuration can be set to either replicate on each successful build, or when a build reaches a certain quality. In this way changes can be accepted conditionally based on the determined quality of the build (therefore hopefully reducing breakage) rather than on a build by build basis.

To configure for replication on successful completion of each build:
<?xml version="1.0" encoding="utf-8" ?>
<Rules>
 <Rule
   BuildType="MyTargetCIBuild"
   EventType="New"
   Source="/Release/MyAssembly.dll"
   Destination="$/Trunk/Dependencies/MyAssembly.dll" />
</Rules>

To configure for replication on attainment of a particular build quality:
<?xml version="1.0" encoding="utf-8" ?>
<Rules>
 <Rule
   BuildType="MyTargetCIBuild"
   EventType="QualityChanged"
   Source="/Release/MyAssembly.dll"
   Destination="$/Trunk/Dependencies/MyAssembly.dll" 
   BuildQuality="Beta" />
</Rules>


If you intend to target a specific build quality, the target quality must exist in the team project from which the build originates. To learn how to manage build qualities, please see http://msdn.microsoft.com/en-us/library/ms181735.aspx

Further information about the attributes that make up a rule element can be found in the Dependency Replication Configuration section of this document.

Service Configuration Element Descriptions

The table below describes the elements that make up the configuration for dependency replicator. . These values can be found in the DependencyReplicator.exe.config file in the installation directory.
Optional parameters are listed in italics.

Element Description
TeamFoundationServerURL The URL of your team foundation server services.
Poll Period The period at which dependency replicator will poll TFS for changes. Takes the form HH:MM:SS where H is hour, M is minute and S is second.
WorkspaceName The name of the workspace containing the source mapping that you wish to poll.
WorkspacePath The local path of the workspace containing the source that you wish to poll.

Dependency Replication Configuration Element Description

The table below describes the elements that make up configuration for dependency replication. The attributes listed in the table belong to the Rule element, which forms the basis for the trigger of a dependency replication activity.
Optional parameters are listed in italics.

Attribute Description Available Values
EventType The event type to poll for. When this event occurs dependency replication will be initiated New / QualityChanged
BuildType The name of the build to poll against
Source The source path for the assembly. This path is relative to the root of the build drop folder
Destination The destination path for the assembly. This path should be specified from the root of the source tree for the team project.
BuildQuality The target quality condition. To be used in conjunction with a QualityChanged event type. Values as configured against the target build for build quality.


Last edited Apr 7, 2009 at 12:22 AM by steve_godbold, version 11

Comments

No comments yet.