Defining Synchronization Scheme for TopTeam VSTS Connector

This article describes the procedure for defining a Synchronization Scheme in TopTeam Visual Studio Team System Connector (VSTS).

• TopTeam Users

The user must have System Administrator privileges for defining a Synchronization Scheme.

The user must also be a member of the Team Foundation Server Administrators Group or a member of the Project Collection Administrators Group. This is optional and is required only when you need to create Work Item Types (WITs) or WIT fields (using the Connector).

A Synchronization Scheme is a set of rules defined for synchronizing records between TopTeam Repository and the Visual Studio Team System (TFS) Repository.

The scheme contains rules such as:

• Record Types that can be synchronized.
• Mapping between Record Types and WITs.
• Mapping between Record Type fields and WIT fields.
• Mapping between TopTeam Link Types and Work Item Link Types.

The scheme is defined between a TopTeam project and a Team System project and is automatically applied whenever you perform synchronization between the selected project pair.

This step is mandatory for each pair of TopTeam and Team System projects that need to be synchronized.

Microsoft Visual Studio Team Services (Cloud) does not support the API call required to create custom Work Item Types (WITs). Therefore, you have to manually create WITs corresponding to TopTeam artifact types (record types that you want to synchronize) on VSTS Cloud and then synchronize corresponding TopTeam artifact types (record types) with VSTS Cloud.

To create custom Work Item Types on Team Services, refer to the Microsoft Visual Studio Team Services article.

Refer to the article Configuring TopTeam Connector for Visual Studio Team System.

For more details, refer to the article Create custom Work Item Type and Work Item Type fields using TopTeam VSTS Connector. Microsoft Visual Studio Team Services (Cloud) does not support the API call required to create custom Work Item Types (WITs). Therefore, you have to manually create WITs corresponding to TopTeam artifact types (record types that you want to synchronize) on VSTS Cloud and then synchronize corresponding TopTeam artifact types (record types) with VSTS Cloud.

To create custom Work Item Types on Team Services, refer to the Microsoft Visual Studio Team Services article.

This page displays and allows mapping of Record Types to WITs while importing records from Team Foundation Repository to TopTeam Repository.

One-to-one mapping of Record Types to WITs is disabled. However, when multiple Record Types are mapped to a single WIT, you need to select the Record Type that will be used for creating records in TopTeam during the import.

NOTE: The Connector will display warnings and error messages when there is a mismatch between the selected field types or when a WIT field is getting reused.

NOTE: Check Do not show this dialog box to stop the dialog from displaying for every field mapping.

For more details, refer to the article Create custom Work Item Type and Work Item Type fields using TopTeam VSTS Connector. Microsoft Visual Studio Team Services (Cloud) does not support the API call required to create custom Work Item Types (WITs). Therefore, you have to manually create WITs corresponding to TopTeam artifact types (record types that you want to synchronize) on VSTS Cloud and then synchronize corresponding TopTeam artifact types (record types) with VSTS Cloud.

To create custom Work Item Types on Team Services, refer to the Microsoft Visual Studio Team Services article.

Exported permalinks will be added as Work Item Hyperlinks to all work items.
You can view these hyperlinks under the Links tab of each work item in Team Explorer.

Any Traceability Link with a Test Case record type will be exported as a Tested By – Tests Link Type to Team Foundation Server.

NOTE: Disabled gray cells will be automatically enabled when a VSTS Work Item Link Type is selected.

NOTE: The steps from 19 to 22 illustrated below cannot be performed when you are connected to Team Services.

If new fields have been created in WITs, you can update their form layout so that those fields are visible in VSTS.
If the State field is mapped for some WITs, you can update their workflow so that the mapped TopTeam Record Type’s States are available on the WIT.

For new WITs, these actions are performed by default.

For successful synchronization of values between record type fields and WIT fields, their list of values should be the same. Select the WIT fields for which you want to update their values with TopTeam field values.

Click Save definition to xml for manual update only when you want to upload WIT Definition (.xml) files.
This is an expert option and is not recommended for basic users.

1. Create an execution profile for this Synchronization Scheme.
For more details, refer to the article Creating Execution Profile for TopTeam VSTS Connector.

2. Synchronize data between TopTeam Project and Team System Project for this Synchronization Scheme.
For more details, refer to the article Synchronizing records between TopTeam and TFS repositories using TopTeam VSTS Connector.

Creating a Synchronization Parameter File
Creating custom Work Item Types or Work Item Type fields using TopTeam VSTS Connector

Revised: April 27th, 2018