{"id":51341,"date":"2023-04-28T03:37:44","date_gmt":"2023-04-28T10:37:44","guid":{"rendered":"http:\/\/www.technosolutions.com\/kb\/?p=51341"},"modified":"2024-03-13T05:59:50","modified_gmt":"2024-03-13T12:59:50","slug":"defining-a-topteam-jira-synchronization-scheme","status":"publish","type":"post","link":"http:\/\/www.technosolutions.com\/kb\/51341\/defining-a-topteam-jira-synchronization-scheme\/","title":{"rendered":"Defining a TopTeam-Jira Synchronization Scheme"},"content":{"rendered":"\n<p><\/p>\n\n\n<h3>Overview<\/h3>\n<p>A <strong>Synchronization Scheme<\/strong> is a set of rules defined for synchronizing artifacts between <em>TopTeam<\/em> repository and <em>Jira<\/em> repository.<\/p>\n<p>The scheme contains rules such as:<\/p>\n<ul>\n<li>Mapping between record types and issue types.<\/li>\n<li>Mapping between record type fields and issue type fields.<\/li>\n<li>Mapping between TopTeam link types and Jira link types.<\/li>\n<\/ul>\n<p>In this topic, you will learn how to define <em>TopTeam-Jira Synchronization Scheme<\/em> to synchronize data between <em>TopTeam<\/em> and <em>Jira <\/em>repositories<em>.<\/em><\/p>\n<h3><strong>Prerequisites<\/strong><\/h3>\n<p>You must be a <strong>System Administrator<\/strong> or have <strong>Manage Jira Synchronization Schemes <\/strong>permission to define a<em> Synchronization Scheme<\/em>. For more information, see <a href=\"https:\/\/www.technosolutions.com\/kb\/51484\/topteam-jira-connector-configuration-required-permissions\/#post-51484-_topteam__jira\" target=\"_blank\" rel=\"noopener\">TopTeam Jira Connector Configuration Required Permissions<\/a>.<\/p>\n<h3>Step 1. Go to the Administration area<\/h3>\n<p><img decoding=\"async\" class=\"wp-image-51367\" src=\"data:image\/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\" data-layzr=\"http:\/\/www.technosolutions.com\/kb\/wp-content\/uploads\/2023\/04\/word-image-51341-1-1.png\" \/><\/p>\n<h3>Step 2. Click Configure Integrations<\/h3>\n<p><img decoding=\"async\" class=\"wp-image-51368\" src=\"data:image\/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\" data-layzr=\"http:\/\/www.technosolutions.com\/kb\/wp-content\/uploads\/2023\/04\/word-image-51341-2-1.png\" \/><\/p>\n<h3>Step 3. Click TopTeam Connector for Jira<\/h3>\n<p><img decoding=\"async\" class=\"wp-image-51370\" src=\"data:image\/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\" data-layzr=\"http:\/\/www.technosolutions.com\/kb\/wp-content\/uploads\/2023\/04\/word-image-51341-3-1.png\" \/><\/p>\n<h3>Step 4. Click Define Synchronization Schemes<\/h3>\n<p><img decoding=\"async\" class=\"wp-image-51373\" src=\"data:image\/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\" data-layzr=\"http:\/\/www.technosolutions.com\/kb\/wp-content\/uploads\/2023\/04\/word-image-51341-4-1.png\" \/><\/p>\n<h3>Define Synchronization Schemes screen opens<\/h3>\n<p>Let\u2019s understand the user interface.<\/p>\n<p><img decoding=\"async\" class=\"wp-image-51374\" src=\"data:image\/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\" data-layzr=\"http:\/\/www.technosolutions.com\/kb\/wp-content\/uploads\/2023\/04\/c-users-admin-appdata-local-temp-snaghtml259ac500-1.png\" alt=\"C:\\Users\\admin\\AppData\\Local\\Temp\\SNAGHTML259ac500.PNG\" \/><\/p>\n<p>The Gear icon actions of a <em>Synchronization Scheme<\/em> are explained below:<\/p>\n<ul>\n<li><strong>Configure Scheme<\/strong>: This action lets you <em>Configure<\/em> a <em>Synchronization Scheme<\/em> between <em>TopTeam<\/em> and <em>Jira<\/em>.<\/li>\n<li><strong>Download<\/strong>: This action lets you <em>Download<\/em> the XML file for the selected <em>Synchronization Scheme.<\/em><\/li>\n<li><strong>Upload:<\/strong> This action lets you <em>Upload<\/em> a new XML file for the already-defined <em>Synchronization Scheme.<\/em><\/li>\n<li><strong>Delete: <\/strong>This action lets you <em>Delete <\/em>the <em>Synchronization Scheme<\/em>.<\/li>\n<\/ul>\n<h3>Step 5. Define a new Synchronization Scheme<\/h3>\n<p><img decoding=\"async\" class=\"wp-image-51375\" src=\"data:image\/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\" data-layzr=\"http:\/\/www.technosolutions.com\/kb\/wp-content\/uploads\/2023\/04\/word-image-51341-6-1.png\" \/><\/p>\n<h3>Step 6. Jira Connection Wizard starts. Enter Jira Connection Details<\/h3>\n<p><img decoding=\"async\" class=\"wp-image-51376\" src=\"data:image\/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\" data-layzr=\"http:\/\/www.technosolutions.com\/kb\/wp-content\/uploads\/2023\/04\/c-users-admin-appdata-local-temp-snaghtml201565e2-1.png\" alt=\"C:\\Users\\admin\\AppData\\Local\\Temp\\SNAGHTML201565e2.PNG\" \/><\/p>\n<ul>\n<li><strong>REST URL<\/strong>: Append \u201drest\/api\/latest\u201d to the URL used on the browser for Jira.<\/li>\n<li><strong>Password\/Token<\/strong>: Specify Password if Jira Server is on-premise. Specify Token if Jira server is on cloud.<\/li>\n<\/ul>\n<p><strong>How to generate Jira API token:<\/strong><\/p>\n<ul>\n<li>Log in to <a href=\"https:\/\/id.atlassian.com\/manage\/api-tokens\" target=\"_blank\" rel=\"noopener\">https:\/\/id.atlassian.com\/manage\/api-tokens<\/a>.<\/li>\n<li>Click <strong>Create API token<\/strong>.<\/li>\n<li>From the pop-up screen that appears, enter a memorable and concise <strong>Label<\/strong> for your token and click <strong>Create<\/strong>.<\/li>\n<li>Use <strong>Copy to clipboard<\/strong> and <strong>paste the token<\/strong> into the <strong>Password\/Token<\/strong> field.<\/li>\n<li>Keep the token so that you can use it multiple times.<\/li>\n<\/ul>\n<p>This connection information is not stored, instead, it is utilized for fetching issue types, fields, and link types to assist in mapping.<\/p>\n<h3>Step 7. Select a Jira Project that you want to use for synchronizing<\/h3>\n<p><img decoding=\"async\" class=\"wp-image-51377\" src=\"data:image\/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\" data-layzr=\"http:\/\/www.technosolutions.com\/kb\/wp-content\/uploads\/2023\/04\/word-image-51341-8-1.png\" \/><\/p>\n<h3>Step 8. Define Mapping between TopTeam record type and Jira issue type<\/h3>\n<p><img decoding=\"async\" class=\"wp-image-51378\" src=\"data:image\/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\" data-layzr=\"http:\/\/www.technosolutions.com\/kb\/wp-content\/uploads\/2023\/04\/word-image-51341-9-1.png\" \/><\/p>\n<p><img decoding=\"async\" class=\"wp-image-51379\" src=\"data:image\/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\" data-layzr=\"http:\/\/www.technosolutions.com\/kb\/wp-content\/uploads\/2023\/04\/word-image-51341-10-1.png\" \/><\/p>\n<h3>Step 9. Add Field Mapping<\/h3>\n<p>On clicking <em>Save<\/em> in the previous step, the <em>Configure Field Mapping<\/em> screen appears.<\/p>\n<p><img decoding=\"async\" class=\"wp-image-51380\" src=\"data:image\/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\" data-layzr=\"http:\/\/www.technosolutions.com\/kb\/wp-content\/uploads\/2023\/04\/word-image-51341-11-1.png\" \/><\/p>\n<p>You can map:<\/p>\n<ul>\n<li>Single TopTeam field to single Jira field<\/li>\n<li>Multiple TopTeam fields to a single Jira field<\/li>\n<\/ul>\n<h4><a id=\"post-51341-_Step_9_.1.\"><\/a>Step 9 .1. Mapping a Single TopTeam field to a Jira field<\/h4>\n<p><img decoding=\"async\" class=\"wp-image-51381\" src=\"data:image\/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\" data-layzr=\"http:\/\/www.technosolutions.com\/kb\/wp-content\/uploads\/2023\/04\/word-image-51341-12-1.png\" \/><\/p>\n<p><img decoding=\"async\" class=\"wp-image-51382\" src=\"data:image\/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\" data-layzr=\"http:\/\/www.technosolutions.com\/kb\/wp-content\/uploads\/2023\/04\/word-image-51341-13-1.png\" \/><\/p>\n<p><strong>Add Field as Attachment<\/strong> option is generally used for <em>Diagram<\/em> fields.<\/p>\n<p>You can add another field using <a href=\"#post-51341-_Step_9_.1.\">steps 9.1<\/a> and <a href=\"#post-51341-_Step_9.2._Mapping\">9.2<\/a>.<\/p>\n<h4><a id=\"post-51341-_Step_9.2._Mapping\"><\/a>Step 9.2. Mapping Multiple TopTeam fields to a single Jira field<\/h4>\n<p><img decoding=\"async\" class=\"wp-image-51383\" src=\"data:image\/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\" data-layzr=\"http:\/\/www.technosolutions.com\/kb\/wp-content\/uploads\/2023\/04\/word-image-51341-14-1.png\" \/><\/p>\n<p><img decoding=\"async\" class=\"wp-image-51384\" src=\"data:image\/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\" data-layzr=\"http:\/\/www.technosolutions.com\/kb\/wp-content\/uploads\/2023\/04\/word-image-51341-15-1.png\" \/><\/p>\n<p><img decoding=\"async\" class=\"wp-image-51385\" src=\"data:image\/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\" data-layzr=\"http:\/\/www.technosolutions.com\/kb\/wp-content\/uploads\/2023\/04\/word-image-51341-16-1.png\" \/><\/p>\n<p><img decoding=\"async\" class=\"wp-image-51386\" src=\"data:image\/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\" data-layzr=\"http:\/\/www.technosolutions.com\/kb\/wp-content\/uploads\/2023\/04\/word-image-51341-17-1.png\" \/><\/p>\n<h4>Step 9.3. View added Field Mappings and save<\/h4>\n<p><img decoding=\"async\" class=\"wp-image-51387\" src=\"data:image\/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\" data-layzr=\"http:\/\/www.technosolutions.com\/kb\/wp-content\/uploads\/2023\/04\/word-image-51341-18-1.png\" \/><\/p>\n<p>Use <em>Add Field Mapping<\/em> to add the desired number of field mappings.<\/p>\n<h3>Step 10. View all Record Type Mappings for the specified synchronization<\/h3>\n<p><img decoding=\"async\" class=\"wp-image-51389\" src=\"data:image\/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\" data-layzr=\"http:\/\/www.technosolutions.com\/kb\/wp-content\/uploads\/2023\/04\/word-image-51341-19-1.png\" \/><\/p>\n<h3>Step 11. Add Link Type Mapping (optional step)<\/h3>\n<p><img decoding=\"async\" class=\"wp-image-51391\" src=\"data:image\/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\" data-layzr=\"http:\/\/www.technosolutions.com\/kb\/wp-content\/uploads\/2023\/04\/word-image-51341-20-1.png\" \/><\/p>\n<p><img decoding=\"async\" class=\"wp-image-51393\" src=\"data:image\/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\" data-layzr=\"http:\/\/www.technosolutions.com\/kb\/wp-content\/uploads\/2023\/04\/word-image-51341-21-1.png\" \/><\/p>\n<p>Similarly, add other link type mappings.<\/p>\n<p><img decoding=\"async\" class=\"wp-image-51395\" src=\"data:image\/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\" data-layzr=\"http:\/\/www.technosolutions.com\/kb\/wp-content\/uploads\/2023\/04\/word-image-51341-22-1.png\" \/><\/p>\n<h3>Step 12. Name the new Synchronization Scheme<\/h3>\n<p><img decoding=\"async\" class=\"wp-image-51396\" src=\"data:image\/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\" data-layzr=\"http:\/\/www.technosolutions.com\/kb\/wp-content\/uploads\/2023\/04\/word-image-51341-23-1.png\" \/><\/p>\n<h3>New Synchronization Scheme displays<\/h3>\n<p><img decoding=\"async\" class=\"wp-image-51398\" src=\"data:image\/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\" data-layzr=\"http:\/\/www.technosolutions.com\/kb\/wp-content\/uploads\/2023\/04\/c-users-admin-appdata-local-temp-snaghtml25df5d5d-1.png\" alt=\"C:\\Users\\admin\\AppData\\Local\\Temp\\SNAGHTML25df5d5d.PNG\" \/><\/p>\n<h3>Next<\/h3>\n<p><a href=\"http:\/\/www.technosolutions.com\/kb\/51372\/defining-a-topteam-jira-synchronization-profile\/\" target=\"_blank\" rel=\"noopener\">Defining a TopTeam-Jira Synchronization Profile<\/a><\/p>\n<h3>Related Articles<\/h3>\n<p><a href=\"http:\/\/www.technosolutions.com\/kb\/51406\/configuring-a-topteam-jira-project-mapping-for-synchronization\/\" target=\"_blank\" rel=\"noopener\">Configuring Project Mapping for Synchronization<\/a><\/p>\n<p>Revised: March 13th, 2024<\/p>","protected":false},"excerpt":{"rendered":"<p>Overview A Synchronization Scheme is a set of rules defined for synchronizing artifacts between TopTeam repository and Jira repository. The scheme contains rules such as: Mapping between record types and issue types. Mapping between record type fields and issue type fields. Mapping between TopTeam link types and Jira link types. In this topic, you will learn how to define TopTeam-Jira Synchronization Scheme to synchronize data between TopTeam and Jira repositories. Prerequisites You must be a System Administrator or have Manage Jira Synchronization Schemes permission to define a Synchronization Scheme. For more information, see TopTeam Jira Connector Configuration Required Permissions. Step <\/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":[364,275],"class_list":["post-51341","post","type-post","status-publish","format-standard","hentry","category-connectors","tag-connectors","tag-jira"],"jetpack_featured_media_url":"","jetpack_shortlink":"https:\/\/wp.me\/paoaNA-dm5","_links":{"self":[{"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/posts\/51341","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=51341"}],"version-history":[{"count":7,"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/posts\/51341\/revisions"}],"predecessor-version":[{"id":51626,"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/posts\/51341\/revisions\/51626"}],"wp:attachment":[{"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/media?parent=51341"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/categories?post=51341"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/www.technosolutions.com\/kb\/wp-json\/wp\/v2\/tags?post=51341"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}