Overview<\/h3>\n\nThis article describes the procedure for defining a Synchronization Scheme in TopTeam Visual Studio Team System Connector<\/i> (VSTS).<\/p>\n<\/div><\/div>\n\nWho should read this?<\/h3>\n\n\n- TopTeam Users<\/li>\n<\/ul>\n<\/div><\/div>\n\n
Who can define a Synchronization Scheme?<\/h3>\n\nThe user must have System Administrator privileges for defining a Synchronization Scheme.<\/p>\n
The user must also be a member of the Team Foundation Server Administrators Group<\/strong><\/i> or a member of the Project Collection Administrators Group.<\/strong><\/i> <\/strong>This is optional and is required only when you need to create Work Item Types (WITs) or WIT fields (using the Connector).<\/p>\n<\/div><\/div>\n\nWhat is a Synchronization Scheme?<\/h3>\n\nA Synchronization Scheme is a set of rules defined for synchronizing records between TopTeam Repository<\/i> and the Visual Studio Team System<\/i> (TFS) Repository.<\/p>\n
The scheme contains rules such as:<\/p>\n
\n- Record Types that can be synchronized.<\/li>\n
- Mapping between Record Types and WITs.<\/font><\/li>\n
- Mapping between Record Type fields and WIT fields.<\/font><\/li>\n
- M<\/font>apping between TopTeam Link Types and Work Item Link Types.<\/font><\/li>\n<\/ul>\n
The scheme is defined between a TopTeam<\/i> project and a Team System<\/i> project and is automatically applied whenever you perform synchronization between the selected project pair.<\/font><\/p>\nThis step is mandatory for each pair of TopTeam<\/i> and Team System<\/i> projects that need to be synchronized.<\/font><\/p>\n<\/div><\/div>\n\nIMPORTANT<\/h3>\n\nMicrosoft Visual Studio Team Services<\/i> (Cloud) does not support the API call required to create custom Work Item Types (WITs)<\/i>. Therefore, you have to manually create WITs corresponding to TopTeam<\/i> artifact types (record types that you want to synchronize) on VSTS Cloud and then synchronize corresponding TopTeam<\/i> artifact types (record types) with VSTS Cloud.<\/p>\n
To create custom Work Item Types<\/i> on Team Services,<\/i> refer to the Microsoft Visual Studio Team Services<\/a> article.<\/p>\n<\/div><\/div>\n\nStep 1. Run TopTeam VSTS Connector<\/h3>\n\nRefer to the article Configuring TopTeam Connector for Visual Studio Team System.<\/i><\/a><\/p>\n<\/div><\/div>\n\nStep 2. Choose the option for defining the synchronization scheme<\/h3>\n\n![\"wpid28861-media_1385962958692-1-1.png\"](\"data:image\/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\")
\n<\/div>\n\n <\/p>\n<\/div><\/div>\n
\nStep 3. Choose Define Synchronization Scheme<\/h3>\n\n\n<\/div>\n\n <\/p>\n<\/div><\/div>\n
\nStep 4. Read the Synchronization Scheme information and click Next<\/h3>\n\n\n<\/div>\n\n <\/p>\n<\/div><\/div>\n
\nStep 5. Select a TopTeam Project and a Team System Project<\/h3>\n\n\n<\/div>\n\n <\/p>\n<\/div><\/div>\n
\nStep 6. Select the TopTeam Record Types that you want to synchronize<\/h3>\n\n\n<\/div>\n\n <\/p>\n<\/div><\/div>\n
\nStep 7. Define mapping between Record Types and WITs<\/h3>\n\n\n<\/div>\n\n <\/p>\n
<\/p>\n<\/div><\/div>\n
\nStep 8. Create a new WIT that does not exist in the Team System Project<\/h3>\n\n\n<\/div>\n\nFor more details, refer to the article Create custom Work Item Type and Work Item Type fields using TopTeam VSTS Connector<\/a>. Microsoft Visual Studio Team Services<\/i> (Cloud) does not support the API call required to create custom Work Item Types (WITs)<\/i>. Therefore, you have to manually create WITs corresponding to TopTeam<\/i> artifact types (record types that you want to synchronize) on VSTS Cloud and then synchronize corresponding TopTeam<\/i> artifact types (record types) with VSTS Cloud.<\/p>\nTo create custom Work Item Types<\/i> on Team Services,<\/i> refer to the Microsoft Visual Studio Team Services<\/a> article.<\/p>\n<\/div><\/div>\n\nStep 9. Define mapping between WITs and Record Types while importing into TopTeam<\/h3>\n\n\n<\/div>\n\nThis page displays and allows mapping of Record Types to WITs while importing records from Team Foundation Repository <\/i>to TopTeam Repository. <\/i><\/p>\n
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.<\/p>\n<\/div><\/div>\n
\nStep 10. Select the TopTeam Record Type fields that you want to synchronize<\/h3>\n\n\n<\/div>\n\n <\/p>\n<\/div><\/div>\n
\nStep 11. Define mapping between Record Type fields and WIT fields<\/h3>\n\n\n<\/div>\n\nNOTE: <\/strong>The Connector will display <\/strong>warnings and error messages when there is a mismatch between the selected field types or when a WIT field is getting reused.<\/p>\n<\/div><\/div>\n\nStep 12. Apply similar field mapping to all other Record Types<\/h3>\n\n\n<\/div>\n\nNOTE: <\/font><\/strong>Check Do not show this dialog<\/strong><\/i> box to stop the dialog from displaying for every field mapping.<\/font><\/p>\n<\/div><\/div>\n\nStep 13. Create a new WIT field<\/h3>\n\n\n<\/div>\n\nFor more details, refer to the article Create custom Work Item Type and Work Item Type fields using TopTeam VSTS Connector<\/a>. Microsoft Visual Studio Team Services<\/i> (Cloud) does not support the API call required to create custom Work Item Types (WITs)<\/i>. Therefore, you have to manually create WITs corresponding to TopTeam<\/i> artifact types (record types that you want to synchronize) on VSTS Cloud and then synchronize corresponding TopTeam<\/i> artifact types (record types) with VSTS Cloud.<\/p>\nTo create custom Work Item Types<\/i> on Team Services,<\/i> refer to the Microsoft Visual Studio Team Services<\/a> article.<\/p>\n<\/div><\/div>\n\nStep 14. Select the option to export permalinks of the TopTeam records to Team Foundation as work item hyperlinks<\/h3>\n\n\n<\/div>\n\nExported permalinks will be added as Work Item Hyperlinks<\/i> to all work items.<\/font>
\nYou can view these hyperlinks under the Links<\/strong><\/i> tab of each work item in Team Explorer.<\/font><\/p>\n<\/div><\/div>\n\nStep 15. Choose an option for synchronizing Record Type links<\/h3>\n\n\n<\/div>\n\n <\/p>\n<\/div><\/div>\n
\nStep 16. Choose an option to synchronize the Parent-Child links hierarchy – recommended<\/h3>\n\n\n<\/div>\n\n <\/p>\n<\/div><\/div>\n
\nStep 17. Define mapping of TopTeam Link Types with Work Item Link Types<\/h3>\n\n\n<\/div>\n\nAny Traceability Link with a Test Case record type will be exported as a Tested By – Tests<\/strong><\/i> Link Type to Team Foundation Server.<\/i><\/p>\nNOTE:<\/strong> Disabled gray cells will be automatically enabled when a VSTS Work Item Link Type is selected.<\/font><\/p>\n<\/div><\/div>\n\nStep 18. Define mapping of TopTeam Link Types with Work Item Link Types<\/h3>\n\n\n<\/div>\n\nNOTE: The steps from 19 to 22 illustrated below cannot be performed when you are connected to Team Services<\/i>.<\/strong><\/p>\n<\/div><\/div>\n\nStep 19. Select the operations that you want to perform on modified WITs in TFS <\/h3>\n\n\n<\/div>\n\nIf new fields have been created in WITs, you can update their form layout so that those fields are visible in VSTS.<\/font>
\nIf the State field is mapped for some WITs, you can update their workflow so that the mapped TopTeam <\/i>Record Type’s States are available on the WIT.<\/font><\/p>\nFor new WITs, these actions are performed by default.<\/font><\/p>\n<\/div><\/div>\n\nStep 20. Select WIT fields for which you want to update list of values<\/h3>\n\n\n<\/div>\n\nFor 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<\/i> field values.<\/font><\/p>\n<\/div><\/div>\n\nStep 21. Specify how you want to update WIT Definitions on TFS<\/h3>\n\n\n<\/div>\n\nClick Save definition to xml<\/strong><\/i> <\/strong>for manual update only when you want to upload WIT Definition (.xml) files.
\nThis is an expert option and is not recommended for basic users.<\/font><\/p>\n<\/div><\/div>\n\nStep 22. Uploading WIT Definitions (XML) to Team System Project<\/h3>\n\n\n<\/div>\n\n <\/p>\n<\/div><\/div>\n
\nStep 23. Save the Synchronization Scheme<\/h3>\n\n\n<\/div>\n\n <\/p>\n<\/div><\/div>\n
\nStep 24. The Synchronization Scheme is saved<\/h3>\n\n\n<\/div>\n\n <\/p>\n<\/div><\/div>\n
\nWhat to do next?<\/h3>\n\n1. Create an execution profile for this Synchronization Scheme.
\n For more details, refer to the article Creating Execution Profile for TopTeam VSTS Connector.<\/a><\/p>\n2. Synchronize data between TopTeam Project<\/i> and Team System Project<\/i> for this Synchronization Scheme.
\n For more details, refer to the article Synchronizing records between TopTeam and TFS repositories using TopTeam VSTS Connector.<\/a><\/p>\n<\/div><\/div>\n\nSee Also<\/h3>\n\nCreating a Synchronization Parameter File<\/a>
\nCreating custom Work Item Types or Work Item Type fields using TopTeam VSTS Connector<\/a><\/p>\n<\/div><\/div>\n\n\nRevised: April 27th, 2018<\/p>\n<\/div><\/div>\n<\/p><\/div>\n
<\/p>\n","protected":false},"excerpt":{"rendered":"
Overview This article describes the procedure for defining a Synchronization Scheme in TopTeam Visual Studio Team System Connector (VSTS). Who should read this? TopTeam Users Who can define a Synchronization Scheme? 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). What is a Synchronization Scheme? A Synchronization Scheme is a set of <\/p>\n","protected":false},"author":6,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[58],"tags":[254,48],"class_list":["post-6316","post","type-post","status-publish","format-standard","hentry","category-connectors","tag-tfs","tag-vsts"],"jetpack_featured_media_url":"","jetpack_shortlink":"https:\/\/wp.me\/paoaNA-1DS","_links":{"self":[{"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/posts\/6316","targetHints":{"allow":["GET"]}}],"collection":[{"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/users\/6"}],"replies":[{"embeddable":true,"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/comments?post=6316"}],"version-history":[{"count":27,"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/posts\/6316\/revisions"}],"predecessor-version":[{"id":41174,"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/posts\/6316\/revisions\/41174"}],"wp:attachment":[{"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/media?parent=6316"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/categories?post=6316"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/tags?post=6316"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}
This article describes the procedure for defining a Synchronization Scheme in TopTeam Visual Studio Team System Connector<\/i> (VSTS).<\/p>\n<\/div><\/div>\n The user must have System Administrator privileges for defining a Synchronization Scheme.<\/p>\n The user must also be a member of the Team Foundation Server Administrators Group<\/strong><\/i> or a member of the Project Collection Administrators Group.<\/strong><\/i> <\/strong>This is optional and is required only when you need to create Work Item Types (WITs) or WIT fields (using the Connector).<\/p>\n<\/div><\/div>\n A Synchronization Scheme is a set of rules defined for synchronizing records between TopTeam Repository<\/i> and the Visual Studio Team System<\/i> (TFS) Repository.<\/p>\n The scheme contains rules such as:<\/p>\n The scheme is defined between a TopTeam<\/i> project and a Team System<\/i> project and is automatically applied whenever you perform synchronization between the selected project pair.<\/font><\/p>\n This step is mandatory for each pair of TopTeam<\/i> and Team System<\/i> projects that need to be synchronized.<\/font><\/p>\n<\/div><\/div>\n Microsoft Visual Studio Team Services<\/i> (Cloud) does not support the API call required to create custom Work Item Types (WITs)<\/i>. Therefore, you have to manually create WITs corresponding to TopTeam<\/i> artifact types (record types that you want to synchronize) on VSTS Cloud and then synchronize corresponding TopTeam<\/i> artifact types (record types) with VSTS Cloud.<\/p>\n To create custom Work Item Types<\/i> on Team Services,<\/i> refer to the Microsoft Visual Studio Team Services<\/a> article.<\/p>\n<\/div><\/div>\n Refer to the article Configuring TopTeam Connector for Visual Studio Team System.<\/i><\/a><\/p>\n<\/div><\/div>\n <\/p>\n<\/div><\/div>\n <\/p>\n<\/div><\/div>\n <\/p>\n<\/div><\/div>\n <\/p>\n<\/div><\/div>\n <\/p>\n<\/div><\/div>\n <\/p>\n <\/p>\n<\/div><\/div>\n For more details, refer to the article Create custom Work Item Type and Work Item Type fields using TopTeam VSTS Connector<\/a>. Microsoft Visual Studio Team Services<\/i> (Cloud) does not support the API call required to create custom Work Item Types (WITs)<\/i>. Therefore, you have to manually create WITs corresponding to TopTeam<\/i> artifact types (record types that you want to synchronize) on VSTS Cloud and then synchronize corresponding TopTeam<\/i> artifact types (record types) with VSTS Cloud.<\/p>\n To create custom Work Item Types<\/i> on Team Services,<\/i> refer to the Microsoft Visual Studio Team Services<\/a> article.<\/p>\n<\/div><\/div>\n This page displays and allows mapping of Record Types to WITs while importing records from Team Foundation Repository <\/i>to TopTeam Repository. <\/i><\/p>\n 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.<\/p>\n<\/div><\/div>\n <\/p>\n<\/div><\/div>\n NOTE: <\/strong>The Connector will display <\/strong>warnings and error messages when there is a mismatch between the selected field types or when a WIT field is getting reused.<\/p>\n<\/div><\/div>\n NOTE: <\/font><\/strong>Check Do not show this dialog<\/strong><\/i> box to stop the dialog from displaying for every field mapping.<\/font><\/p>\n<\/div><\/div>\n For more details, refer to the article Create custom Work Item Type and Work Item Type fields using TopTeam VSTS Connector<\/a>. Microsoft Visual Studio Team Services<\/i> (Cloud) does not support the API call required to create custom Work Item Types (WITs)<\/i>. Therefore, you have to manually create WITs corresponding to TopTeam<\/i> artifact types (record types that you want to synchronize) on VSTS Cloud and then synchronize corresponding TopTeam<\/i> artifact types (record types) with VSTS Cloud.<\/p>\n To create custom Work Item Types<\/i> on Team Services,<\/i> refer to the Microsoft Visual Studio Team Services<\/a> article.<\/p>\n<\/div><\/div>\n Exported permalinks will be added as Work Item Hyperlinks<\/i> to all work items.<\/font> <\/p>\n<\/div><\/div>\n <\/p>\n<\/div><\/div>\n Any Traceability Link with a Test Case record type will be exported as a Tested By – Tests<\/strong><\/i> Link Type to Team Foundation Server.<\/i><\/p>\n NOTE:<\/strong> Disabled gray cells will be automatically enabled when a VSTS Work Item Link Type is selected.<\/font><\/p>\n<\/div><\/div>\n NOTE: The steps from 19 to 22 illustrated below cannot be performed when you are connected to Team Services<\/i>.<\/strong><\/p>\n<\/div><\/div>\n If new fields have been created in WITs, you can update their form layout so that those fields are visible in VSTS.<\/font> For new WITs, these actions are performed by default.<\/font><\/p>\n<\/div><\/div>\n 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<\/i> field values.<\/font><\/p>\n<\/div><\/div>\n Click Save definition to xml<\/strong><\/i> <\/strong>for manual update only when you want to upload WIT Definition (.xml) files. <\/p>\n<\/div><\/div>\n <\/p>\n<\/div><\/div>\n <\/p>\n<\/div><\/div>\n 1. Create an execution profile for this Synchronization Scheme. 2. Synchronize data between TopTeam Project<\/i> and Team System Project<\/i> for this Synchronization Scheme. Creating a Synchronization Parameter File<\/a> Revised: April 27th, 2018<\/p>\n<\/div><\/div>\n<\/p><\/div>\n <\/p>\n","protected":false},"excerpt":{"rendered":" Overview This article describes the procedure for defining a Synchronization Scheme in TopTeam Visual Studio Team System Connector (VSTS). Who should read this? TopTeam Users Who can define a Synchronization Scheme? 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). What is a Synchronization Scheme? A Synchronization Scheme is a set of <\/p>\n","protected":false},"author":6,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[58],"tags":[254,48],"class_list":["post-6316","post","type-post","status-publish","format-standard","hentry","category-connectors","tag-tfs","tag-vsts"],"jetpack_featured_media_url":"","jetpack_shortlink":"https:\/\/wp.me\/paoaNA-1DS","_links":{"self":[{"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/posts\/6316","targetHints":{"allow":["GET"]}}],"collection":[{"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/users\/6"}],"replies":[{"embeddable":true,"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/comments?post=6316"}],"version-history":[{"count":27,"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/posts\/6316\/revisions"}],"predecessor-version":[{"id":41174,"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/posts\/6316\/revisions\/41174"}],"wp:attachment":[{"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/media?parent=6316"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/categories?post=6316"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/tags?post=6316"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}Who should read this?<\/h3>\n
\n
Who can define a Synchronization Scheme?<\/h3>\n
What is a Synchronization Scheme?<\/h3>\n
\n
IMPORTANT<\/h3>\n
Step 1. Run TopTeam VSTS Connector<\/h3>\n
Step 2. Choose the option for defining the synchronization scheme<\/h3>\n
\n<\/div>\n
Step 3. Choose Define Synchronization Scheme<\/h3>\n
\n<\/div>\n
Step 4. Read the Synchronization Scheme information and click Next<\/h3>\n
\n<\/div>\n
Step 5. Select a TopTeam Project and a Team System Project<\/h3>\n
\n<\/div>\n
Step 6. Select the TopTeam Record Types that you want to synchronize<\/h3>\n
\n<\/div>\n
Step 7. Define mapping between Record Types and WITs<\/h3>\n
\n<\/div>\n
Step 8. Create a new WIT that does not exist in the Team System Project<\/h3>\n
\n<\/div>\n
Step 9. Define mapping between WITs and Record Types while importing into TopTeam<\/h3>\n
\n<\/div>\n
Step 10. Select the TopTeam Record Type fields that you want to synchronize<\/h3>\n
\n<\/div>\n
Step 11. Define mapping between Record Type fields and WIT fields<\/h3>\n
\n<\/div>\n
Step 12. Apply similar field mapping to all other Record Types<\/h3>\n
\n<\/div>\n
Step 13. Create a new WIT field<\/h3>\n
\n<\/div>\n
Step 14. Select the option to export permalinks of the TopTeam records to Team Foundation as work item hyperlinks<\/h3>\n
\n<\/div>\n
\nYou can view these hyperlinks under the Links<\/strong><\/i> tab of each work item in Team Explorer.<\/font><\/p>\n<\/div><\/div>\nStep 15. Choose an option for synchronizing Record Type links<\/h3>\n
\n<\/div>\n
Step 16. Choose an option to synchronize the Parent-Child links hierarchy – recommended<\/h3>\n
\n<\/div>\n
Step 17. Define mapping of TopTeam Link Types with Work Item Link Types<\/h3>\n
\n<\/div>\n
Step 18. Define mapping of TopTeam Link Types with Work Item Link Types<\/h3>\n
\n<\/div>\n
Step 19. Select the operations that you want to perform on modified WITs in TFS <\/h3>\n
\n<\/div>\n
\nIf the State field is mapped for some WITs, you can update their workflow so that the mapped TopTeam <\/i>Record Type’s States are available on the WIT.<\/font><\/p>\nStep 20. Select WIT fields for which you want to update list of values<\/h3>\n
\n<\/div>\n
Step 21. Specify how you want to update WIT Definitions on TFS<\/h3>\n
\n<\/div>\n
\nThis is an expert option and is not recommended for basic users.<\/font><\/p>\n<\/div><\/div>\nStep 22. Uploading WIT Definitions (XML) to Team System Project<\/h3>\n
\n<\/div>\n
Step 23. Save the Synchronization Scheme<\/h3>\n
\n<\/div>\n
Step 24. The Synchronization Scheme is saved<\/h3>\n
\n<\/div>\n
What to do next?<\/h3>\n
\n For more details, refer to the article Creating Execution Profile for TopTeam VSTS Connector.<\/a><\/p>\n
\n For more details, refer to the article Synchronizing records between TopTeam and TFS repositories using TopTeam VSTS Connector.<\/a><\/p>\n<\/div><\/div>\nSee Also<\/h3>\n
\nCreating custom Work Item Types or Work Item Type fields using TopTeam VSTS Connector<\/a><\/p>\n<\/div><\/div>\n