{"id":23925,"date":"2023-09-14T04:34:07","date_gmt":"2023-09-13T19:34:07","guid":{"rendered":"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/?page_id=23925"},"modified":"2023-09-20T18:38:56","modified_gmt":"2023-09-20T09:38:56","slug":"azure-devops","status":"publish","type":"page","link":"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/integration-guide\/requirements-and-defects-integrations\/available-integrations\/azure-devops\/","title":{"rendered":"Integrate with Azure DevOps"},"content":{"rendered":"<div class=\"callout callout--info\">\n<p>This article refers to integrating with<span>\u00a0<\/span><strong>Azure DevOps Boards and Work Items<\/strong>. If you&#8217;re looking for information about CI\/CD integrations, please see the documentation on<span>\u00a0<\/span><a href=\"https:\/\/support.testrail.com\/hc\/en-us\/articles\/17473107292052-Integrating-with-Azure-Pipelines\" target=\"_self\" rel=\"undefined noopener\">Integrating with Azure Pipelines<\/a>.<\/p>\n<\/div>\n<p>TestRail integrates with Azure DevOps so your team can link, view, add, and push issues between TestRail and Azure DevOps as<span>\u00a0<\/span><a href=\"\/integration-guide\/requirements-and-defects-integrations\/configuring-defect\/\" target=\"_blank\" rel=\"noopener\">bugs\/defects<\/a>,<span>\u00a0<\/span><a href=\"\/integration-guide\/requirements-and-defects-integrations\/configuring-reference\/\" target=\"_blank\" rel=\"noopener\">requirements\/references<\/a>, or both. The TestRail integration with Azure DevOps supports the following use cases:<\/p>\n<ul>\n<li style=\"list-style-type: none;\">\n<ul class=\"list-bullet\">\n<li><a href=\"\/integration-guide\/requirements-and-defects-integrations\/available-integrations\/azure-devops#Link_test_cases_to_requirements\">Link test cases to requirements<\/a><\/li>\n<li><a href=\"\/integration-guide\/requirements-and-defects-integrations\/available-integrations\/azure-devops#Start_creating_requirements_from_TestRail\">Start creating requirements from TestRail<\/a><\/li>\n<li><a href=\"\/integration-guide\/requirements-and-defects-integrations\/available-integrations\/azure-devops#View_requirements_in_TestRail\">View requirements in TestRail<\/a><\/li>\n<li><a href=\"https:\/\/support.testrail.com\/hc\/en-us\/articles\/18690064687380#h_01H8Y9P5D373TQK3VQY9YGFW5H\">Link defects to test results<\/a><\/li>\n<li><a href=\"\/integration-guide\/requirements-and-defects-integrations\/available-integrations\/azure-devops#Submit_new_defects_in_Azure_DevOps\">Submit new defects in Azure DevOps<\/a><\/li>\n<li><a href=\"\/integration-guide\/requirements-and-defects-integrations\/available-integrations\/azure-devops#Submit_new_defects_from_TestRail\">Submit new defects from TestRail<\/a><\/li>\n<li><a href=\"\/integration-guide\/requirements-and-defects-integrations\/available-integrations\/azure-devops#View_defects_in_TestRail\" rel=\"sponsored \">View defects in TestRail<\/a><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<p>You don\u2019t have to use all the listed integration options; you can mix and match the integration with other tools. Configuring the integration usually only takes a few minutes. This guide explains how to configure the integration and how it works.<\/p>\n<p><iframe loading=\"lazy\" width=\"560\" height=\"315\" src=\"https:\/\/www.youtube.com\/embed\/bLQs_r8C3Eo?si=kIgKIIvSWD_JOQzx\" title=\"YouTube video player\" frameborder=\"0\" allow=\"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share\" allowfullscreen=\"allowfullscreen\"><\/iframe><\/p>\n<h2 id=\"h_01H8Y9P5D2C922AHJXJ90HCQGN\">Link test cases to requirements<\/h2>\n<p>To set up test coverage, when you are creating or editing test cases, simply add one or more work item IDs (separated by commas) to the<span>\u00a0<\/span><strong>References<\/strong><span>\u00a0<\/span>field.<\/p>\n<p><a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_01.png\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_01.png\" alt=\"\" width=\"689\" height=\"474\" class=\"aligncenter size-full wp-image-23952\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_01.png 689w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_01-480x330.png 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) 689px, 100vw\" \/><\/a><\/p>\n<p>The<span>\u00a0<\/span><strong>References<\/strong><span>\u00a0<\/span>you set in your test cases will be converted to a direct link to Azure DevOps\u00a0 work items.<\/p>\n<p><a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_02.png\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_02.png\" alt=\"\" width=\"904\" height=\"509\" class=\"aligncenter size-full wp-image-23953\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_02.png 904w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_02-480x270.png 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) 904px, 100vw\" \/><\/a><\/p>\n<h3 id=\"h_01H8Y9P5D255WV3X8AQN4TZEGW\">Configuring the Reference View Url<\/h3>\n<p>To link test cases to requirements, you should configure the Azure DevOps<span>\u00a0<\/span><strong>Reference View Url<\/strong><span>\u00a0<\/span>in TestRail by following the steps below.<\/p>\n<ol>\n<li style=\"list-style-type: none;\">\n<ol class=\"list-colored\">\n<li>Go to the\u00a0<strong>Administration<\/strong><span>\u00a0<\/span>page, select<span>\u00a0<\/span><strong>Integration<span>\u00a0<\/span><\/strong>to configure globally or\u00a0<strong>Projects<\/strong><span>\u00a0<\/span>for a single project, and open the\u00a0<strong>References<\/strong><span>\u00a0<\/span>tab<\/li>\n<li>Insert your<span>\u00a0<\/span><strong>Reference View Url<span>\u00a0<\/span><\/strong>using the following pattern\n<ul class=\"list-bullet\">\n<li><code class=\"inline-code\">https:\/\/&lt;Azure_DevOps_URL&gt;\/&lt;Project&gt;\/_workitems\/edit\/%id%\/<\/code><\/li>\n<\/ul>\n<\/li>\n<li>Click\u00a0<strong>Save Settings\u00a0<\/strong><\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<div class=\"callout callout--info\">\n<p>[et_pb_text admin_label=&#8221;Note&#8221; _builder_version=&#8221;4.4.2&#8243; background_color=&#8221;#F0F8FF&#8221; hover_enabled=&#8221;0&#8243; border_width_all=&#8221;1px&#8221; border_color_all=&#8221;#b0c4de&#8221;]<\/p>\n<p><span>Please make sure to replace\u00a0<\/span><code class=\"inline-code\">&lt;Azure_DevOps_URL&gt;<\/code><span>\u00a0and\u00a0<\/span><code class=\"inline-code\">&lt;Project&gt;<\/code><span>\u00a0with the actual URL of the instance and the Project name in Azure DevOps you want to integrate with.<\/span><\/p>\n<p>[\/et_pb_text]<\/p>\n<p id=\"h_01H8Y7NN1RY1NW2EAB7Y569W2N\" class=\"callout__title callout__icon\"><em class=\"fas fa-info-circle\">\u00a0<\/em><\/p>\n<h4 class=\"callout__title callout__icon\"><a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_03.png\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_03.png\" alt=\"\" width=\"1461\" height=\"642\" class=\"aligncenter size-full wp-image-23954\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_03.png 1461w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_03-1280x562.png 1280w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_03-980x431.png 980w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_03-480x211.png 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) and (max-width: 980px) 980px, (min-width: 981px) and (max-width: 1280px) 1280px, (min-width: 1281px) 1461px, 100vw\" \/><\/a><\/h4>\n<\/div>\n<h2 id=\"h_01H8Y9QJKG0MQ87NWJZ8QFE9BV\">Start creating requirements from TestRail<\/h2>\n<p>TestRail provides an\u00a0<strong>Add<\/strong><span>\u00a0<\/span>link in the test case editor view to quickly navigate to the Azure DevOps work item creation screen. This allows you to quickly create new requirements you want to trace in your test cases. Note that after creating your new work item, you need to copy and paste its ID to the\u00a0<strong>References<\/strong><span>\u00a0<\/span>field.<\/p>\n<p><a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_04.png\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_04.png\" alt=\"\" width=\"881\" height=\"628\" class=\"aligncenter size-full wp-image-23955\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_04.png 881w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_04-480x342.png 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) 881px, 100vw\" \/><\/a><\/p>\n<h3 id=\"h_01H8YA2F29NKSMMGVWQ211PWWQ\">Configuring the Reference Add Url<\/h3>\n<p>To start creating new requirements from TestRail, you should configure the Azure DevOps<span>\u00a0<\/span><strong>Reference Add Url<\/strong><span>\u00a0<\/span>in TestRail by following the steps below.<\/p>\n<ol>\n<li style=\"list-style-type: none;\">\n<ol class=\"list-colored\">\n<li>Go to the\u00a0<strong>Administration<\/strong><span>\u00a0<\/span>page, select<span>\u00a0<\/span><strong>Integration<span>\u00a0<\/span><\/strong>to configure globally or\u00a0<strong>Projects<\/strong><span>\u00a0<\/span>for a single project, and open the\u00a0<strong>References<\/strong><span>\u00a0<\/span>tab<\/li>\n<li>Insert your the<span>\u00a0<\/span><strong>Reference Add Url<span>\u00a0<\/span><\/strong>using the following pattern\n<ul class=\"list-bullet\">\n<li><code class=\"inline-code\">https:\/\/&lt;Azure_DevOps_URL&gt;\/&lt;Project&gt;\/_workitems\/create\/issue<\/code><\/li>\n<\/ul>\n<\/li>\n<li>Click\u00a0<strong>Save Settings\u00a0<\/strong><\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<p><a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_05.png\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_05.png\" alt=\"\" width=\"1461\" height=\"642\" class=\"aligncenter size-full wp-image-23956\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_05.png 1461w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_05-1280x562.png 1280w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_05-980x431.png 980w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_05-480x211.png 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) and (max-width: 980px) 980px, (min-width: 981px) and (max-width: 1280px) 1280px, (min-width: 1281px) 1461px, 100vw\" \/><\/a><\/p>\n<h2 id=\"h_01H8Y9P5D3GSS9HKGVDX54GMK7\">View requirements in TestRail<\/h2>\n<p>TestRail can retrieve additional information from IDs entered into the<span>\u00a0<\/span><strong>References<\/strong><span>\u00a0<\/span>field of TestRail entities, such as test cases, test runs, and milestones. Simply hover over the links and a dialog will show you all the latest information without having to navigate to Azure DevOps.<\/p>\n<p><a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_06.png\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_06.png\" alt=\"\" width=\"1061\" height=\"696\" class=\"aligncenter size-full wp-image-23957\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_06.png 1061w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_06-980x643.png 980w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_06-480x315.png 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) and (max-width: 980px) 980px, (min-width: 981px) 1061px, 100vw\" \/><\/a><\/p>\n<h3 id=\"h_01H667RFA9G3SZ877KXKVPQM6F\">Configuring the Reference Plugin<\/h3>\n<p>To view requirements directly in TestRail, you should configure the Azure DevOps<span>\u00a0<\/span><strong>Reference Plugin<\/strong><span>\u00a0<\/span>in TestRail by following the steps below.<\/p>\n<ol>\n<li style=\"list-style-type: none;\">\n<ol class=\"list-colored\">\n<li>Go to the\u00a0<strong>Administration<\/strong><span>\u00a0<\/span>page, select<span>\u00a0<\/span><strong>Integration<span>\u00a0<\/span><\/strong>to configure globally or\u00a0<strong>Projects<\/strong><span>\u00a0<\/span>for a single project, and open the\u00a0<strong>References<\/strong><span>\u00a0<\/span>tab<\/li>\n<li>Select your<span>\u00a0<\/span><em>Azure_DevOps_<\/em>\u00a0variant in the<span>\u00a0<\/span><strong>Reference Plugin<\/strong><span>\u00a0<\/span>drop-down list (CLOUD if your team uses Azure DevOps Services, SERVER if your team uses Azure DevOps Server)<\/li>\n<li>Configure the connection settings in the<span>\u00a0<\/span><strong><em>[connection]<\/em><\/strong><span>\u00a0<\/span>section\n<ul class=\"list-bullet\">\n<li><strong><em>address<\/em><\/strong>:<span>\u00a0<\/span><code class=\"inline-code\">https:\/\/&lt;Azure_DevOps_URL&gt;<\/code><\/li>\n<li><strong><em>project<\/em><\/strong>: name of your project<\/li>\n<li><strong><em>user<\/em><\/strong>: your username<\/li>\n<li><strong><em>password<\/em><\/strong>: \u00a0your Azure DevOps password or Personal Access Token (PAT)<\/li>\n<\/ul>\n<\/li>\n<li>Click\u00a0<strong>Save Settings<br \/>\n<\/strong><\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<p><a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_07.png\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_07.png\" alt=\"\" width=\"1255\" height=\"645\" class=\"aligncenter size-full wp-image-23958\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_07.png 1255w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_07-980x504.png 980w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_07-480x247.png 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) and (max-width: 980px) 980px, (min-width: 981px) 1255px, 100vw\" \/><\/a><\/p>\n<p>It is also possible to customize the fields which appear via link hovering. You can see more information on how to do it on the<span>\u00a0<\/span><a href=\"\/server-guide\/customizations-and-extensions\/building-custom-plugin\/\" target=\"_blank\" rel=\"noopener\">Customizing the Requirement\/Defect Plugins<\/a><span>\u00a0<\/span>section.<\/p>\n<p>The Defect Plugin utilizes Azure DevOps API, so valid credentials are needed to connect to the API. You&#8217;ll have to<span>\u00a0<\/span><a href=\"https:\/\/learn.microsoft.com\/en-us\/azure\/devops\/organizations\/accounts\/use-personal-access-tokens-to-authenticate?view=azure-devops&amp;amp;tabs=Windows#create-a-pat\" target=\"_blank\" rel=\"noopener noreferrer\">generate an Azure Personal Access Token<\/a><span>\u00a0<\/span>with<span>\u00a0<\/span><strong>Full Access<span>\u00a0<\/span><\/strong>or<span>\u00a0<\/span><strong>Custom Defined with all permissions to Work Items<\/strong>.<\/p>\n<h2 id=\"h_01H8Y9P5D373TQK3VQY9YGFW5H\">Link defects to test results<\/h2>\n<p>The\u00a0<strong>Defect View URL<\/strong>\u00a0is used to build a link to Azure DevOps based on the Defect ID, so you can simply click on an ID to open the issue directly in Azure DevOps.<\/p>\n<p>When you set up the Defect View URL integration with Azure DevOps Issues, you can paste the ID of an Azure DevOps issue in the Defects field of a test result and TestRail will automatically convert that ID into a clickable link to view the issue in Azure DevOps. This allows your team to link tests with Azure DevOps issues and create defect and traceability reports in TestRail.<\/p>\n<p><a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_08.png\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_08.png\" alt=\"\" width=\"600\" height=\"430\" class=\"aligncenter size-full wp-image-23959\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_08.png 600w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_08-480x344.png 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) 600px, 100vw\" \/><\/a><\/p>\n<h3 id=\"h_01H8YAN33BPEM8FT289XJZEPFX\">Configuring the Defect View Url<\/h3>\n<p>To link defects to test results in TestRail, you should configure the Azure DevOps<span>\u00a0<\/span><strong>Defect View Url<\/strong><span>\u00a0<\/span>in TestRail by following the steps below.<\/p>\n<ol>\n<li style=\"list-style-type: none;\">\n<ol class=\"list-colored\">\n<li>Go to the\u00a0<strong>Administration<\/strong><span>\u00a0<\/span>page, select<span>\u00a0<\/span><strong>Integration<span>\u00a0<\/span><\/strong>to configure globally or\u00a0<strong>Projects<\/strong><span>\u00a0<\/span>for a single project, and open the<span>\u00a0<\/span><strong>Defects<span>\u00a0<\/span><\/strong>tab<\/li>\n<li>Insert your<span>\u00a0<\/span><strong>Defect View Url<span>\u00a0<\/span><\/strong>using the following pattern\n<ul class=\"list-bullet\">\n<li><code class=\"inline-code\">https:\/\/&lt;Azure_DevOps_URL&gt;\/&lt;Project&gt;\/_workitems\/edit\/%id%\/<\/code><\/li>\n<\/ul>\n<\/li>\n<li>Click\u00a0<strong>Save Settings\u00a0<\/strong><\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<div class=\"callout callout--info\">\n<p>[et_pb_text admin_label=&#8221;Note&#8221; _builder_version=&#8221;4.4.2&#8243; background_color=&#8221;#F0F8FF&#8221; hover_enabled=&#8221;0&#8243; border_width_all=&#8221;1px&#8221; border_color_all=&#8221;#b0c4de&#8221;]<\/p>\n<p><em class=\"fas fa-info-circle\">\u00a0<\/em>Please make sure to replace<span>\u00a0<\/span><code class=\"inline-code\">&lt;Azure_DevOps_URL&gt;<\/code><span>\u00a0<\/span>and<span>\u00a0<\/span><code class=\"inline-code\">&lt;Project&gt;<\/code><span>\u00a0<\/span>with the actual URL of the instance and the Project name in Azure DevOps you want to integrate with.<\/p>\n<p>[\/et_pb_text]<\/p>\n<\/div>\n<p><a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_09.png\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_09.png\" alt=\"\" width=\"1458\" height=\"624\" class=\"aligncenter size-full wp-image-23960\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_09.png 1458w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_09-1280x548.png 1280w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_09-980x419.png 980w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_09-480x205.png 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) and (max-width: 980px) 980px, (min-width: 981px) and (max-width: 1280px) 1280px, (min-width: 1281px) 1458px, 100vw\" \/><\/a><\/p>\n<h2 id=\"h_01H8Y9P5D3X834R96YQZAXZHS3\">Submit new defects in Azure DevOps<\/h2>\n<p>TestRail provides quick navigation to report defects using the Azure DevOps interface. You can do it from two different places &#8211; the<span>\u00a0<\/span><strong>Defects menu\u00a0<\/strong>and the<span>\u00a0<\/span><strong>Add Test Result dialog<\/strong>.<\/p>\n<p>The<span>\u00a0<\/span><strong>Defects menu<\/strong>, also know as TestRail\u2019s<span>\u00a0<\/span><a href=\"\/integration-guide\/requirements-and-defects-integrations\/configuring-defect\/#i-9\" target=\"_blank\" rel=\"noopener\">Defect From Anywhere<\/a><span>\u00a0<\/span>feature, is displayed on top of most pages for quick access.<\/p>\n<p><a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_10.png\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_10.png\" alt=\"\" width=\"1062\" height=\"561\" class=\"aligncenter size-full wp-image-23961\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_10.png 1062w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_10-980x518.png 980w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_10-480x254.png 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) and (max-width: 980px) 980px, (min-width: 981px) 1062px, 100vw\" \/><\/a><\/p>\n<p>The<span>\u00a0<\/span><strong>Add Test Result dialog<span>\u00a0<\/span><\/strong>displays\u00a0the\u00a0<strong>Add link<\/strong><span>\u00a0<\/span>next to the<span>\u00a0<\/span><strong>Defects field\u00a0<\/strong>for quickly and conveniently navigate to DevOps in order to submit a defects when your test is failing.<\/p>\n<p><a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_11.png\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_11.png\" alt=\"\" width=\"810\" height=\"624\" class=\"aligncenter size-full wp-image-23962\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_11.png 810w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_11-480x370.png 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) 810px, 100vw\" \/><\/a><\/p>\n<p>Note that after you create the defect in Azure DevOps, you should copy and paste the work item ID into the<span>\u00a0<\/span><strong>Defects<\/strong><span>\u00a0<\/span>input field to create traceability from your test result back to Azure DevOps.<\/p>\n<h3 id=\"configuring_defect_urls\">Configuring the Defect Add Url<\/h3>\n<p>To quickly navigate to Azure DevOps to create a new defect, you should configure Azure DevOps<span>\u00a0<\/span><strong>Defect Url<\/strong><span>\u00a0<\/span>in TestRail by following the steps below.<\/p>\n<ol>\n<li style=\"list-style-type: none;\">\n<ol class=\"list-colored\">\n<li>Go to the\u00a0<strong>Administration<\/strong><span>\u00a0<\/span>page, select<span>\u00a0<\/span><strong>Integration<span>\u00a0<\/span><\/strong>to configure globally or\u00a0<strong>Projects<\/strong><span>\u00a0<\/span>for a single project, and open the<span>\u00a0<\/span><strong>Defects<span>\u00a0<\/span><\/strong>tab<\/li>\n<li>Insert your<span>\u00a0<\/span><strong>Defect Add Url<span>\u00a0<\/span><\/strong>using the following pattern\n<ul class=\"list-bullet\">\n<li><code class=\"inline-code\">https:\/\/&lt;Azure_DevOps_URL&gt;\/&lt;Project&gt;\/_workitems\/create\/issue<\/code><\/li>\n<\/ul>\n<\/li>\n<li>Click\u00a0<strong>Save Settings\u00a0<\/strong><\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<div class=\"callout callout--info\">\n<p class=\"callout__title callout__icon\"><em class=\"fas fa-info-circle\">\u00a0<\/em>[et_pb_text admin_label=&#8221;Note&#8221; _builder_version=&#8221;4.4.2&#8243; background_color=&#8221;#F0F8FF&#8221; hover_enabled=&#8221;0&#8243; border_width_all=&#8221;1px&#8221; border_color_all=&#8221;#b0c4de&#8221;]<\/p>\n<p>Please make sure to replace<span>\u00a0<\/span><code class=\"inline-code\">&lt;Azure_DevOps_URL&gt;<\/code><span>\u00a0<\/span>and<span>\u00a0<\/span><code class=\"inline-code\">&lt;Project&gt;<\/code><span>\u00a0<\/span>with the actual URL of the instance and the Project name in Azure DevOps you want to integrate with.<br \/>\nBy default, we suggest using<span>\u00a0<\/span><code class=\"inline-code\">\/issue<\/code><span>\u00a0<\/span>on the<span>\u00a0<\/span><strong>Defect Add Url<\/strong>. The Azure Basic Process does not contain the<span>\u00a0<\/span><strong>Bug Work Item type<\/strong>, but in case you are using an Agile\/SCRUM\/CMMI Process, you can replace<span>\u00a0<\/span><code class=\"inline-code\">\/issue<\/code><span>\u00a0<\/span>with<span>\u00a0<\/span><code class=\"inline-code\">\/bug<\/code>, or any other type you may prefer.<\/p>\n<p>[\/et_pb_text]<\/p>\n<\/div>\n<p><a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_12.png\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_12.png\" alt=\"\" width=\"1458\" height=\"624\" class=\"aligncenter size-full wp-image-23963\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_12.png 1458w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_12-1280x548.png 1280w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_12-980x419.png 980w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_12-480x205.png 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) and (max-width: 980px) 980px, (min-width: 981px) and (max-width: 1280px) 1280px, (min-width: 1281px) 1458px, 100vw\" \/><\/a><\/p>\n<h2 id=\"h_01H8YASWM2D0FPQC970BJNZCA6\">Submit new defects from TestRail<\/h2>\n<p>For a deeper integration when it comes to reporting defects, TestRail comes with a ready-to-use Azure DevOps defect plugin. This plugin allows you to push new issues to Azure DevOps without leaving TestRail.<\/p>\n<p>Using the built-in<span>\u00a0<\/span><strong>Push Defect dialog<\/strong>, you can quickly create a new defect with a title, description, and any other fields supported by Azure DevOps.<\/p>\n<p><a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_13.png\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_13.png\" alt=\"\" width=\"745\" height=\"793\" class=\"aligncenter size-full wp-image-23945\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_13.png 745w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_13-480x511.png 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) 745px, 100vw\" \/><\/a><\/p>\n<p>You can open the defect submission dialog from two places &#8211; the<span>\u00a0<\/span><strong>Defects menu\u00a0<\/strong>and the<span>\u00a0<\/span><strong>Add Test Result dialog<\/strong>.<\/p>\n<p>The<span>\u00a0<\/span><strong>Defects menu<\/strong>, also know as TestRail\u2019s<span>\u00a0<\/span><a href=\"\/integration-guide\/requirements-and-defects-integrations\/configuring-defect\/#i-9\" target=\"_blank\" rel=\"noopener\">Defect From Anywhere<\/a><span>\u00a0<\/span>feature, is displayed on top of most pages for quick access.<\/p>\n<p><a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_14.png\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_14.png\" alt=\"\" width=\"1061\" height=\"563\" class=\"aligncenter size-full wp-image-23946\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_14.png 1061w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_14-980x520.png 980w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_14-480x255.png 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) and (max-width: 980px) 980px, (min-width: 981px) 1061px, 100vw\" \/><\/a><\/p>\n<p>The<span>\u00a0<\/span><strong>Add Test Result dialog<span>\u00a0<\/span><\/strong>displays\u00a0the\u00a0<strong>Push link<\/strong><span>\u00a0<\/span>next to the<span>\u00a0<\/span><strong>Defects field\u00a0<\/strong>to efficiently report a defect while you&#8217;re submitting your test results.<\/p>\n<p><a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_15.png\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_15.png\" alt=\"\" width=\"811\" height=\"624\" class=\"aligncenter size-full wp-image-23947\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_15.png 811w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_15-480x369.png 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) 811px, 100vw\" \/><\/a><\/p>\n<h3 id=\"configuring_defect_plugin\">Configuring the Defect Plugin<\/h3>\n<p>To submit new defects straight from TestRail, you should configure the Azure DevOps<span>\u00a0<\/span><strong>Defect Plugin<\/strong><span>\u00a0<\/span>in TestRail by following the steps below.<\/p>\n<ol>\n<li style=\"list-style-type: none;\">\n<ol class=\"list-colored\">\n<li>Go to the\u00a0<strong>Administration<\/strong><span>\u00a0<\/span>page, select<span>\u00a0<\/span><strong>Integration<span>\u00a0<\/span><\/strong>to configure globally or\u00a0<strong>Projects<\/strong><span>\u00a0<\/span>for a single project, and open the<span>\u00a0<\/span><strong>Defects<span>\u00a0<\/span><\/strong>tab<\/li>\n<li>Select your<span>\u00a0<\/span><em>Azure_DevOps_<\/em>\u00a0variant in the<span>\u00a0<\/span><strong>Defect Plugin<\/strong><span>\u00a0<\/span>drop-down list\u00a0(CLOUD if your team uses Azure DevOps Services, SERVER if your team uses Azure DevOps Server)<\/li>\n<li>Configure the connection settings in the<span>\u00a0<\/span><strong><em>[connection]<\/em><\/strong><span>\u00a0<\/span>section\n<ul class=\"list-bullet\">\n<li><strong><em>address<\/em><\/strong>:<span>\u00a0<\/span><code class=\"inline-code\">https:\/\/&lt;Azure_DevOps_URL&gt;<\/code><\/li>\n<li><strong><em>project<\/em><\/strong>: name of your project<\/li>\n<li><strong><em>user<\/em><\/strong>: your username<\/li>\n<li><strong><em>password<\/em><\/strong>: \u00a0your Azure DevOps password or Personal Access Token (PAT)<\/li>\n<\/ul>\n<\/li>\n<li>Click\u00a0<strong>Save Settings\u00a0<\/strong><\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<p><a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_16.png\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_16.png\" alt=\"\" width=\"1289\" height=\"643\" class=\"aligncenter size-full wp-image-23948\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_16.png 1289w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_16-1280x639.png 1280w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_16-980x489.png 980w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_16-480x239.png 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) and (max-width: 980px) 980px, (min-width: 981px) and (max-width: 1280px) 1280px, (min-width: 1281px) 1289px, 100vw\" \/><\/a><\/p>\n<p>It is also possible to customize the fields which appear via link hovering. You can see more information on how to do it on the<span>\u00a0<\/span><a href=\"\/integration-guide\/requirements-and-defects-integrations\/configuring-defect\/\" target=\"_blank\" rel=\"noopener\">Customizing the Requirement\/Defect Plugins<\/a><span>\u00a0<\/span>section.<\/p>\n<p>The Defect Plugin utilizes Azure DevOps API, so valid credentials are needed to connect to the API. You&#8217;ll have to<span>\u00a0<\/span><a href=\"https:\/\/learn.microsoft.com\/en-us\/azure\/devops\/organizations\/accounts\/use-personal-access-tokens-to-authenticate?view=azure-devops&amp;amp;tabs=Windows#create-a-pat\" target=\"_blank\" rel=\"noopener\">generate an Azure Personal Access Token<\/a><span>\u00a0<\/span>with<span>\u00a0<\/span><strong>Full Access<span>\u00a0<\/span><\/strong>or<span>\u00a0<\/span><strong>Custom Defined with all permissions to Work Items<\/strong>.<\/p>\n<h2 id=\"h_01H8Y9P5D3Q1NNAHHTYR8GH95Z\">View defects in TestRail<\/h2>\n<p>Simply hover over defect links and a dialog will show you all the latest information without having to navigate to Azure DevOps. These links are available in the test results directly, as well as the Defects section on test runs, test plans and milestones.<\/p>\n<p><a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_17.png\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_17.png\" alt=\"\" width=\"681\" height=\"587\" class=\"aligncenter size-full wp-image-23949\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_17.png 681w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_17-480x414.png 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) 681px, 100vw\" \/><\/a><\/p>\n<h3 id=\"01H8YBN7MD0EBJ1RC9MB11AFHG\">Configuring the Defect Plugin<\/h3>\n<p>To view defects information directly in TestRail, you should configure the Azure DevOps<span>\u00a0<\/span><strong>Defect Plugin<\/strong><span>\u00a0<\/span>in TestRail. If you already configured the\u00a0<strong>Defect Plugin<\/strong><span>\u00a0<\/span>to push defects to TestRail, you should be all set up. If not, please follow the steps below.<\/p>\n<ol>\n<li style=\"list-style-type: none;\">\n<ol class=\"list-colored\">\n<li>Go to the\u00a0<strong>Administration<\/strong><span>\u00a0<\/span>page, select<span>\u00a0<\/span><strong>Integration<span>\u00a0<\/span><\/strong>to configure globally or\u00a0<strong>Projects<\/strong><span>\u00a0<\/span>for a single project, and open the<span>\u00a0<\/span><strong>Defects<span>\u00a0<\/span><\/strong>tab<\/li>\n<li>Select your<span>\u00a0<\/span><em>Azure_DevOps_<\/em>\u00a0variant in the<span>\u00a0<\/span><strong>Defect Plugin<\/strong><span>\u00a0<\/span>drop-down list\u00a0(CLOUD if your team uses Azure DevOps Services, SERVER if your team uses Azure DevOps Server)<\/li>\n<li>Configure the connection settings in the<span>\u00a0<\/span><strong><em>[connection]<\/em><\/strong><span>\u00a0<\/span>section\n<ul class=\"list-bullet\">\n<li><strong><em>address<\/em><\/strong>:<span>\u00a0<\/span><code class=\"inline-code\">https:\/\/&lt;Azure_DevOps_URL&gt;<\/code><\/li>\n<li><strong><em>project<\/em><\/strong>: name of your project<\/li>\n<li><strong><em>user<\/em><\/strong>: your username<\/li>\n<li><strong><em>password<\/em><\/strong>: \u00a0your Azure DevOps password or Personal Access Token (PAT)<\/li>\n<\/ul>\n<\/li>\n<li>Click\u00a0<strong>Save Settings\u00a0<\/strong><\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<p><a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_18.png\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_18.png\" alt=\"\" width=\"1289\" height=\"643\" class=\"aligncenter size-full wp-image-23950\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_18.png 1289w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_18-1280x639.png 1280w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_18-980x489.png 980w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_18-480x239.png 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) and (max-width: 980px) 980px, (min-width: 981px) and (max-width: 1280px) 1280px, (min-width: 1281px) 1289px, 100vw\" \/><\/a><\/p>\n<p>It is also possible to customize the fields which appear via link hovering. You can see more information on how to do it on the<span>\u00a0<\/span><a href=\"\/integration-guide\/requirements-and-defects-integrations\/configuring-defect\/\" target=\"_blank\" rel=\"noopener\">Customizing the Requirement\/Defect Plugins<\/a><span>\u00a0<\/span>section.<\/p>\n<p>The Defect Plugin utilizes Azure DevOps API, so valid credentials are needed to connect to the API. You&#8217;ll have to<span>\u00a0<\/span><a href=\"https:\/\/learn.microsoft.com\/en-us\/azure\/devops\/organizations\/accounts\/use-personal-access-tokens-to-authenticate?view=azure-devops&amp;amp;tabs=Windows#create-a-pat\" target=\"_blank\" rel=\"noopener noreferrer\">generate an Azure Personal Access Token<\/a><span>\u00a0<\/span>with<span>\u00a0<\/span><strong>Full Access<span>\u00a0<\/span><\/strong>or<span>\u00a0<\/span><strong>Custom Defined with all permissions to Work Items<\/strong>.<\/p>\n<h2 id=\"h_01H8Y9P5D39WNYGJWSEFBN925Z\">Advanced customizations<\/h2>\n<h3 id=\"h_01H8YC0HD6K9KGTYG9D7JJ69QH\">User variables<\/h3>\n<p>We recommend using<span>\u00a0<\/span><a href=\"\/integration-guide\/requirements-and-defects-integrations\/user-variables\/\" target=\"_blank\" rel=\"noopener\">User Variables<\/a><span>\u00a0<\/span>when configuring any integration credentials. This allows you to provide generic credentials without disclosing them, and also lets users define their own credentials in their personal settings, for better access control. Below you can see an example of how to set variables in your configuration.<\/p>\n<pre><code class=\"shell\">user=%azure_username%\npassword=%azure_password%<\/code><\/pre>\n<p><a href=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_19.png\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_19.png\" alt=\"\" width=\"869\" height=\"419\" class=\"aligncenter size-full wp-image-23951\" srcset=\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_19.png 869w, https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-content\/uploads\/azure-devops_19-480x231.png 480w\" sizes=\"auto, (min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) 869px, 100vw\" \/><\/a><\/p>\n<h3 id=\"customizing_defect_plugins\" class=\"sectionedit3\">Customizing the Requirement\/Defect Plugins<\/h3>\n<p>The Azure DevOps plugin was built to work with a standard Azure DevOps configuration. TestRail allows you to customize the fields which appear in the Push dialog as well as when hovering over work item IDs, both for requirements and defects. Preconfigured push fields and hover fields can be set to<span>\u00a0<\/span><code class=\"inline-code\">on<\/code><span>\u00a0<\/span>or<span>\u00a0<\/span><code class=\"inline-code\">off<\/code><span>\u00a0<\/span>in their respective<span>\u00a0<\/span><code class=\"inline-code\">[push.fields]<\/code><span>\u00a0<\/span>and<span>\u00a0<\/span><code class=\"inline-code\">[hover.fields]<\/code><span>\u00a0<\/span>sections, and you can also change their order, which will be reflected in the UI.<\/p>\n<p>[et_pb_text admin_label=&#8221;Note&#8221; _builder_version=&#8221;4.4.2&#8243; background_color=&#8221;#F0F8FF&#8221; hover_enabled=&#8221;0&#8243; border_width_all=&#8221;1px&#8221; border_color_all=&#8221;#b0c4de&#8221;]<\/p>\n<p>Some fields (such as the title) are always enabled and may not appear in these sections due to always being required by either TestRail or Azure DevOps.<\/p>\n<p>[\/et_pb_text]<\/p>\n<p>[et_pb_text admin_label=&#8221;Note&#8221; _builder_version=&#8221;4.4.2&#8243; background_color=&#8221;#ffffdd&#8221; hover_enabled=&#8221;0&#8243; border_width_all=&#8221;1px&#8221; border_color_all=&#8221;#E1E163&#8243;]<\/p>\n<p>The plugin is available for both Azure DevOps Cloud, and Azure DevOps Server and it has the same functionality, with the exception of 1 field. <strong>The Azure DevOps Server plugin does not support the assignee field<\/strong>, due to API limitations.<\/p>\n<p>[\/et_pb_text]<\/p>\n<p>The Azure DevOps Defect Plugin also supports modifying field properties as well as custom fields.<\/p>\n<pre><code class=\"config\">[push.types]\nBug=on\nEpic=off\nIssue=on\nTask=on\nUserStory=off<\/code><\/pre>\n<p>By default, the plugin supports the item types defined above, with only Bug, Issue, and Task being enabled initially. Within Azure DevOps, different item types have different description-type fields. For example, a Bug in Azure DevOps has Reproduction Steps and System Info Fields, while an Issue item type uses a Description field. These three field types can be enabled and disabled on a per-item type basis using the<span>\u00a0<\/span><code class=\"inline-code\">[type.settings.&lt;item_type&gt;]<\/code><span>\u00a0<\/span>section. The<span>\u00a0<\/span><code class=\"inline-code\">default<\/code><span>\u00a0<\/span>value is used to specify where the configured TestRail bug description will be populated.<\/p>\n<pre><code class=\"config\">[type.settings.Bug]\ndescription=off\nrepro_steps=default\nsystem_info=on<\/code><\/pre>\n<p>In addition to enabling, disabling, or re-organizing fields as described above, it\u2019s also possible to change additional options per field. To do this, you would define a section for the field, such as<span>\u00a0<\/span><code class=\"inline-code\">[push.field.description]<\/code><span>\u00a0<\/span>and specify additional options within this section.<\/p>\n<pre><code class=\"config\">[push.field.description]\nlabel=Detailed Description\nrequired=true<\/code><\/pre>\n<p>Please see below for full list and explanation of the available field options:<\/p>\n<table class=\"table table--hover\">\n<thead>\n<tr>\n<th><strong>Option<\/strong><\/th>\n<th><strong>Description<\/strong><\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code class=\"inline-code\">api_field<\/code><\/td>\n<td><span data-sheets-formula-bar-text-style=\"font-size:13px;color:#000000;font-weight:normal;text-decoration:none;font-family:'Arial';font-style:normal;text-decoration-skip-ink:none;\">The key for the field in an API response. Examples are\u00a0<code class=\"inline-code\">api_field=System.Description<\/code>\u00a0and\u00a0<code class=\"inline-code\">api_field=Microsoft.VSTS.Common.AcceptanceCriteria<\/code>\u00a0<em>(Required for custom fields)<\/em><\/span><\/td>\n<\/tr>\n<tr>\n<td><code class=\"inline-code\">api_list_id<\/code><\/td>\n<td>The ID value of a list field, such as<span>\u00a0<\/span><em>661eb38e-6f0b-484a-bc53-27a57c2e2d50<\/em>. The value is obtained from the Azure DevOps API.<span>\u00a0<\/span><em>(Required for custom fields which have<span>\u00a0<\/span><\/em><code class=\"inline-code\">type=dropdown<\/code><em>)<\/em><\/td>\n<\/tr>\n<tr>\n<td><code class=\"inline-code\">label<\/code><\/td>\n<td>Specifies the display name of the field in the Push Defect dialogue\u00a0<em>(Required for custom fields)<\/em><\/td>\n<\/tr>\n<tr>\n<td><code class=\"inline-code\">size<\/code><\/td>\n<td>Specifies whether the field is displayed as a compact field<span>\u00a0<\/span><code class=\"inline-code\">(compact)<\/code><span>\u00a0<\/span>or uses the full width of the dialogue<span>\u00a0<\/span><code class=\"inline-code\">(full)<\/code><\/td>\n<\/tr>\n<tr>\n<td><code class=\"inline-code\">remember<\/code><\/td>\n<td>Specifies if previously selected values for this field should be remembered and restored the next time the Push Defect dialogue is opened<\/td>\n<\/tr>\n<tr>\n<td><code class=\"inline-code\">required<\/code><\/td>\n<td>Specifies if this field is mandatory or optional and whether users are required to enter a value for this field in the Push Defect dialogue<\/td>\n<\/tr>\n<tr>\n<td><code class=\"inline-code\">type<\/code><\/td>\n<td>Specifies the type of this field, please see section Custom fields below for a list of supported field types.\u00a0\u00a0<em>(Required for custom fields &#8211; If<span>\u00a0<\/span><\/em><code class=\"inline-code\">type=dropdown<\/code><em><span>\u00a0<\/span>for a custom field, then<span>\u00a0<\/span><\/em><code class=\"inline-code\">api_list_id<\/code><em><span>\u00a0<\/span>is also required)<\/em><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h4 id=\"h_01H8YHPXTESJPBC7NWP95TMEG7\">Custom fields<\/h4>\n<p>You can also use the above-mentioned approach to add custom fields to TestRail\u2019s Push Defect dialogue. To do this, simply add a line with your custom field to the<span>\u00a0<\/span><code class=\"inline-code\">[push.fields]<\/code><span>\u00a0<\/span>section to add a field.<\/p>\n<pre><code class=\"config\">[push.fields]\n# ...\ndescription=on\ncustomfield_customer=on<\/code><\/pre>\n<p>Then, add a<span>\u00a0<\/span><code class=\"inline-code\">[field.settings.customfield_&lt;field_name&gt;]<\/code><span>\u00a0<\/span>section. This section is required so the plugin can push and\/or retrieve data from your tool.<span>\u00a0<\/span><code class=\"inline-code\">&lt;field_name&gt;<\/code><span>\u00a0<\/span>can be any value, as the field\u2019s properties will be defined inside the corresponding section. The following is an example.<\/p>\n<pre><code class=\"config\">[field.settings.customfield_customer]\napi_field=System.Customer\nlabel=Customer\nsize=compact\ntype=dropdown\nrequired=true<\/code><\/pre>\n<p>The following field types are supported:<\/p>\n<table class=\"table table--hover\">\n<thead>\n<tr>\n<th>Field Type<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code class=\"inline-code\">bool<\/code><\/td>\n<td>A Yes\/No dropdown menu for True\/False, Yes\/No, or similar binary values<\/td>\n<\/tr>\n<tr>\n<td><code class=\"inline-code\">date<\/code><\/td>\n<td>A string field which accepts a YYYY-MM-DD or similarly structured date value. Formatting may depend on the integrated tool\u2019s requirements.<\/td>\n<\/tr>\n<tr>\n<td><code class=\"inline-code\">datetime<\/code><\/td>\n<td>A string field which accepts a YYYY-MM-DD HH:MM or similarly structured date and time value. Formatting may depend on the integrated tool\u2019s requirements.<\/td>\n<\/tr>\n<tr>\n<td><code class=\"inline-code\">dropdown<\/code><\/td>\n<td>A dropdown list that allows users to select one of the multiple options<\/td>\n<\/tr>\n<tr>\n<td><code class=\"inline-code\">string<\/code><\/td>\n<td>A small free-text field for up to 250 characters.<\/td>\n<\/tr>\n<tr>\n<td><code class=\"inline-code\">text<\/code><\/td>\n<td>A large free-text field without practical size limitations.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h4 id=\"reference_urls\" class=\"sectionedit5\">Attachments<\/h4>\n<p>The Azure DevOps Defect Plugin supports submitting attachments to Azure DevOps as well. This field can be turned on and off, but cannot be customized. To submit one or more attachments to Azure DevOps, simply drag the attachment to the attachments or description areas of the push dialog or click on the area to choose an attachment from your file system.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>This article refers to integrating with\u00a0Azure DevOps Boards and Work Items. If you&#8217;re looking for inform [&hellip;]<\/p>\n","protected":false},"author":5,"featured_media":0,"parent":6734,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_et_pb_use_builder":"","_et_pb_old_content":"","_et_gb_content_width":"","footnotes":""},"class_list":["post-23925","page","type-page","status-publish","hentry"],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-json\/wp\/v2\/pages\/23925","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-json\/wp\/v2\/users\/5"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-json\/wp\/v2\/comments?post=23925"}],"version-history":[{"count":42,"href":"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-json\/wp\/v2\/pages\/23925\/revisions"}],"predecessor-version":[{"id":24002,"href":"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-json\/wp\/v2\/pages\/23925\/revisions\/24002"}],"up":[{"embeddable":true,"href":"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-json\/wp\/v2\/pages\/6734"}],"wp:attachment":[{"href":"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/wp-json\/wp\/v2\/media?parent=23925"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}