Map integration components

Last Update: 3/6/2017

TFS 2015 | TFS 2013

NOTE

TFS 2017 and later versions no longer support native integration with Microsoft Project Server. If you upgrade to TFS 2017 or want to use a third party option, see Synchronize TFS with Project Server.

You can synchronize data between Visual Studio Team Foundation Server 2013 and Microsoft Project Server if you first configure several points of integration between them. To configure this integration, you use the TFSAdmin ProjectServer command-line tool. To access this tool, open a Command Prompt window where either Visual Studio or Team Explorer is installed and enter:

cd %programfiles(x86)%\Microsoft Visual Studio 12.0\Common7\IDE  

On a 32-bit edition of Windows, replace %programfiles(x86)% with %programfiles%..

NOTE

For an overview of this configuration, see Administer TFS-Project Server integration.

Global parameters

You can use the parameters in the following table to display information about TfsAdmin ProjectServer.

Parameter Description
/help

or

/?
Displays the syntax and parameters for the command-line tool.
Command /help

or

Command /?
Displays the syntax and parameters for the TfsAdmin ProjectServer command that you specify.

Commands that support TFS-Project Server integration

Tasks Related content
Manage the registration of Project Server to Team Foundation Server. To integrate Project Server and Team Foundation Server, you must first register an instance of Project Web Access or Project Web App (PWA) to Team Foundation Server. To manage this type of registration, you use the following command options:

- /RegisterPWA: Registers an instance of Project Web Access to Team Foundation Server.
- /GetRegisteredPWA: Returns the list of registered instances.
- /UnregisterPWA: Removes the registration of an instance.
Register an instance of PWA
Manage the association of team project collections to an instance of PWA. You manage the association of team project collections to an instance by using the following command options:

- /MapPWAToCollection: Maps a team project collection to an instance of Project Web Access. Before you can map a collection to an instance, you must register the instance.
- /GetMappedCollections: Returns the list of mapped collections.
- /UnMapPWAFromCollection: Removes the mapping between a collection and an instance.
Map a team project collection
Manage the association of enterprise project plans to team projects. To synchronize tasks in an enterprise project with work items in a team project, you must map the project plan to the team project. You can manage this type of mapping by using the following command options:

- /MapPlanToTeamProject: Maps an enterprise project to a team project. Before you create this type of mapping, you must map the instance of PWA instance that is associated with the enterprise team project.
- /GetMappedProjects: Returns the list of enterprise projects that are mapped to team projects.
- /UnmapPlanFromTeamProject: Removes a mapping between a team project and an enterprise project.
Manage mappings
Manage which types of work items participate in data synchronization. After you have made your initial configurations and mapping, you can change the types of work items that are mapped. You can manage the types of work items that participate in synchronization by using the following command options:

- /MapWorkItemTypes: Defines the types of work items that can participate in synchronization for a team project. Regardless of whether you map a given type of work item, work items of that type will not be synchronized unless a user submits them for publishing.
- /GetMappedWorkItemTypes: Returns the list of work item types that are configured to participate in synchronization for a team project.
- /UnmapWorkItemTypes: Removes types of work items from participating in synchronization for a team project.
Define the work item types to synchronize
Customize how fields are mapped between Team Foundation Server and Project Server. You must map fields between the two server products and define how the data is synchronized. You can either upload the default mappings or add mappings and customize how fields are synchronized. You maintain the field mappings by using the following command options:

- /DownloadFieldMappings: Downloads the field mappings to a file.
- /UploadFieldMappings: Uploads the field mappings that are defined in a file.
Upload or download field mappings
Retrieve recent error messages that occurred when data was synchronized. To support your troubleshooting efforts, you can retrieve information about the most recent errors that were logged for a team project collection if you use the /GetSyncMessages command option. View error messages

Configure TFS-Project Server integration
Remove a component
Change your deployment configuration
Administer TFS-Project Server integration