Copy Page

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account. You can also Sign Up for a new account.

<table class="wysiwyg-macro" data-macro-name="unmigrated-inline-wiki-markup" data-macro-parameters="atlassian-macro-output-type=BLOCK" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e3VubWlncmF0ZWQtaW5saW5lLXdpa2ktbWFya3VwOmF0bGFzc2lhbi1tYWNyby1vdXRwdXQtdHlwZT1CTE9DS30&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>{iframe:src=http://update.sonarsource.org/plugins/jira.html|width=700|height=250|frameborder=0}
Your browser does not support iframes.
{iframe}</pre></td></tr></table><h1>Compatibility Matrix</h1><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><p>Plugin</p></th><th class="confluenceTh"><p>0.1</p></th><th class="confluenceTh"><p>0.2</p></th><th class="confluenceTh"><p>0.2.1</p></th><th class="confluenceTh"><p>0.3</p></th><th colspan="1" class="confluenceTh"><span style="color: rgb(0,51,102);">1.0</span></th><th colspan="1" class="confluenceTh"><span style="color: rgb(0,51,102);">1.1</span></th></tr><tr><th class="confluenceTh"><p>Jira 3.x</p></th><td class="confluenceTd"><p><img class="emoticon emoticon-tick" data-emoticon-name="tick" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/check.png" alt="(tick)" title="(tick)" /></p></td><td class="confluenceTd"><p>only 3.13 <img class="emoticon emoticon-tick" data-emoticon-name="tick" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/check.png" alt="(tick)" title="(tick)" /></p></td><td class="confluenceTd"><p><img class="emoticon emoticon-tick" data-emoticon-name="tick" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/check.png" alt="(tick)" title="(tick)" /></p></td><td class="confluenceTd"><p><img class="emoticon emoticon-tick" data-emoticon-name="tick" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/check.png" alt="(tick)" title="(tick)" /></p></td><td colspan="1" class="confluenceTd"><p><img class="emoticon emoticon-tick" data-emoticon-name="tick" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/check.png" alt="(tick)" title="(tick)" /></p></td><td colspan="1" class="confluenceTd"><img class="emoticon emoticon-tick" data-emoticon-name="tick" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/check.png" alt="(tick)" title="(tick)" /></td></tr><tr><th class="confluenceTh"><p>Jira 4.x</p></th><td class="confluenceTd"><p><img class="emoticon emoticon-minus" data-emoticon-name="minus" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/forbidden.png" alt="(minus)" title="(minus)" /></p></td><td class="confluenceTd"><p><img class="emoticon emoticon-plus" data-emoticon-name="plus" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/add.png" alt="(plus)" title="(plus)" /></p></td><td class="confluenceTd"><p><img class="emoticon emoticon-tick" data-emoticon-name="tick" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/check.png" alt="(tick)" title="(tick)" /></p></td><td class="confluenceTd"><p><img class="emoticon emoticon-tick" data-emoticon-name="tick" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/check.png" alt="(tick)" title="(tick)" /></p></td><td colspan="1" class="confluenceTd"><p><img class="emoticon emoticon-tick" data-emoticon-name="tick" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/check.png" alt="(tick)" title="(tick)" /></p></td><td colspan="1" class="confluenceTd"><img class="emoticon emoticon-tick" data-emoticon-name="tick" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/check.png" alt="(tick)" title="(tick)" /></td></tr><tr><th class="confluenceTh"><p>Jira 5.x</p></th><td class="confluenceTd"><p><img class="emoticon emoticon-question" data-emoticon-name="question" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/help_16.png" alt="(question)" title="(question)" /></p></td><td class="confluenceTd"><p><img class="emoticon emoticon-question" data-emoticon-name="question" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/help_16.png" alt="(question)" title="(question)" /></p></td><td class="confluenceTd"><p><img class="emoticon emoticon-question" data-emoticon-name="question" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/help_16.png" alt="(question)" title="(question)" /></p></td><td class="confluenceTd"><p><img class="emoticon emoticon-tick" data-emoticon-name="tick" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/check.png" alt="(tick)" title="(tick)" /></p></td><td colspan="1" class="confluenceTd"><p><img class="emoticon emoticon-tick" data-emoticon-name="tick" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/check.png" alt="(tick)" title="(tick)" /></p></td><td colspan="1" class="confluenceTd"><img class="emoticon emoticon-tick" data-emoticon-name="tick" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/check.png" alt="(tick)" title="(tick)" /></td></tr></tbody></table><h1>Description / Features</h1><p>This plugin connects Sonar to Altassian JIRA in various ways.</p><h4>Widget &quot;JIRA Issues&quot;</h4><p>Sonar retrieves the number of issues associated to a project from <a href="http://www.atlassian.com/software/jira/">JIRA</a>. It then reports on the total number of issues and distribution by priority.</p><p><img class="confluence-embedded-image" confluence-query-params="effects=border-simple,shadow-kn" src="/download/attachments/230400687/jira_widget.png?version=1&amp;modificationDate=1368952146118&amp;effects=border-simple,shadow-kn" data-image-src="/download/attachments/230400687/jira_widget.png?version=1&amp;modificationDate=1368952146118&amp;effects=border-simple,shadow-kn" data-linked-resource-id="230565131" data-linked-resource-type="attachment" data-linked-resource-default-alias="jira_widget.png" data-base-url="http://docs.codehaus.org" data-linked-resource-container-id="230400687" title="null > jira_widget.png"></p><h4>Link a Sonar review to a JIRA ticket</h4><p>This feature allows you to create a review (on a violation) that will generate a JIRA ticket on your configured JIRA instance.</p><p>When logged in, you should find the &quot;Link to JIRA&quot; action available on any violation:</p><p><img class="confluence-embedded-image" confluence-query-params="effects=border-simple,shadow-kn" src="/download/attachments/230400687/LinkToJiraAction.jpg?version=1&amp;modificationDate=1368952146095&amp;effects=border-simple,shadow-kn" data-image-src="/download/attachments/230400687/LinkToJiraAction.jpg?version=1&amp;modificationDate=1368952146095&amp;effects=border-simple,shadow-kn" data-linked-resource-id="230565130" data-linked-resource-type="attachment" data-linked-resource-default-alias="LinkToJiraAction.jpg" data-base-url="http://docs.codehaus.org" data-linked-resource-container-id="230400687" title="null > LinkToJiraAction.jpg"></p><p>You can enter any comment and after you press &quot;Link to JIRA&quot;, a new review comment is added on the violation: you can see the link to the newly-created JIRA ticket.</p><p><img class="confluence-embedded-image" confluence-query-params="effects=border-simple,shadow-kn" src="/download/attachments/230400687/CommentWithJiraLink.jpg?version=1&amp;modificationDate=1368952146069&amp;effects=border-simple,shadow-kn" data-image-src="/download/attachments/230400687/CommentWithJiraLink.jpg?version=1&amp;modificationDate=1368952146069&amp;effects=border-simple,shadow-kn" data-linked-resource-id="230565129" data-linked-resource-type="attachment" data-linked-resource-default-alias="CommentWithJiraLink.jpg" data-base-url="http://docs.codehaus.org" data-linked-resource-container-id="230400687" title="null > CommentWithJiraLink.jpg"></p><p>And the corresponding JIRA look like:</p><p><img class="confluence-embedded-image" confluence-query-params="effects=border-simple,shadow-kn" src="/download/attachments/230400687/NewlyCreatedJiraIssue.jpg?version=1&amp;modificationDate=1368952146041&amp;effects=border-simple,shadow-kn" data-image-src="/download/attachments/230400687/NewlyCreatedJiraIssue.jpg?version=1&amp;modificationDate=1368952146041&amp;effects=border-simple,shadow-kn" data-linked-resource-id="230565128" data-linked-resource-type="attachment" data-linked-resource-default-alias="NewlyCreatedJiraIssue.jpg" data-base-url="http://docs.codehaus.org" data-linked-resource-container-id="230400687" title="null > NewlyCreatedJiraIssue.jpg"></p><h1>Installation</h1><ol><li>Install the JIRA plugin through the <a href="http://docs.codehaus.org/display/SONAR/Update+Center">Update Center</a> or download it into the SONAR_HOME/extensions/plugins directory</li><li>Restart the Sonar server</li></ol><h1>Usage</h1><h3>Mandatory Properties</h3><p>At project or global level go to Settings &gt; JIRA and set the <strong>sonar.jira.url</strong>, <strong>sonar.jira.login.secured</strong> and <strong>sonar.jira.password.secured</strong> properties.</p><h3>To Display Data on the JIRA Issues Widget</h3><ol><li><p>Log in to your JIRA instance and create a filter. Mark it as favorite. You can also share this filter with your team in order to allow usage of URL for issues in Sonar.</p></li><li><p>And finally specify the <strong>sonar.jira.url.param</strong> property for project or module: this is the name of an issue filter that you have previously created on JIRA (check <a href="https://confluence.atlassian.com/pages/viewpage.action?pageId=284367607">JIRA documentation to know more about issue filters</a>).</p></li></ol><h3>To Create JIRA Issues</h3><p>Set the <strong>sonar.jira.project.key</strong> property that is the key of the JIRA project on which this Sonar plugin will generate tickets</p><p>Note that you can also configure the issue type, the component, the priorities. Browse the JIRA setting page on the web interface for a complete list.</p><table class="wysiwyg-macro" data-macro-name="note" data-macro-parameters="title=Connecting to JIRA through HTTPS" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e25vdGU6dGl0bGU9Q29ubmVjdGluZyB0byBKSVJBIHRocm91Z2ggSFRUUFN9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body"><p>If you must connect to your JIRA instance through HTTPS, and if a certificate is required for this connection, then you must <span style="color: rgb(34,34,34);">import the certificate into the CA store of the</span><span style="color: rgb(34,34,34);"> JRE that runs Sonar.</span></p></td></tr></table><h1>FAQ</h1><ul><li><p>Q: I see the following warning in Sonar logs when using the JIRA plugin:</p><pre>[WARN] [18:32:24.426] Unable to find required classes (javax.activation.DataHandler and javax.mail.internet.MimeMultipart). Attachment support is disabled.</pre></li><li><p>A: This is a message from the Axis SOAP client we are using to talk to your JIRA. You can safely ignore this message. Attachment support is not used anyway.</p></li></ul><p> </p><ul><li>Q: I have configured my JIRA instance so that some fields are mandatory. Because Sonar does not populate these fields then issue creation fails. How can I make it work?</li><li>A: The <strong>sonar.jira.issue.component.id</strong> can be defined at project level. For other fields the suggested workaround is to create a new issue type in JIRA (for exemple &quot;Quality issue&quot;) and set the <strong>sonar.jira.issue.type.id</strong> property accordingly.</li></ul><h1>Change Log</h1><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9UmVsZWFzZSAxLjF8aGVpZ2h0PTcwfHJlbmRlck1vZGU9c3RhdGljfHdpZHRoPTkwMHxjb2x1bW5zPXR5cGU7a2V5O3N1bW1hcnk7cHJpb3JpdHl8dXJsPWh0dHA6Ly9qaXJhLmNvZGVoYXVzLm9yZy9zci9qaXJhLmlzc3Vldmlld3M6c2VhcmNocmVxdWVzdC14bWwvdGVtcC9TZWFyY2hSZXF1ZXN0LnhtbD9maXhmb3I9MTg2MTImcGlkPTExOTExJnNvcnRlci9maWVsZD1wcmlvcml0eSZzb3J0ZXIvb3JkZXI9REVTQyZ0ZW1wTWF4PTEwMDB9&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority|height=70|renderMode=static|title=Release 1.1|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=18612&amp;pid\=11911&amp;sorter/field\=priority&amp;sorter/order\=DESC&amp;tempMax\=1000|width=900"></p><p> </p><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9UmVsZWFzZSAxLjB8aGVpZ2h0PTcwfHJlbmRlck1vZGU9c3RhdGljfHdpZHRoPTkwMHxjb2x1bW5zPXR5cGU7a2V5O3N1bW1hcnk7cHJpb3JpdHl8dXJsPWh0dHA6Ly9qaXJhLmNvZGVoYXVzLm9yZy9zci9qaXJhLmlzc3Vldmlld3M6c2VhcmNocmVxdWVzdC14bWwvdGVtcC9TZWFyY2hSZXF1ZXN0LnhtbD9qcWxRdWVyeT1wcm9qZWN0KyUzRCtTT05BUlBMVUdJTlMrQU5EK2ZpeFZlcnNpb24rJTNEKyUyMkpJUkEtMS4wJTIyK0FORCtzdGF0dXMrJTNEK0Nsb3NlZCtPUkRFUitCWStwcmlvcml0eStERVNDJnRlbXBNYXg9MTAwMH0&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority|height=70|renderMode=static|title=Release 1.0|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?jqlQuery\=project+%3D+SONARPLUGINS+AND+fixVersion+%3D+%22JIRA-1.0%22+AND+status+%3D+Closed+ORDER+BY+priority+DESC&amp;tempMax\=1000|width=900"></p><p> </p><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9UmVsZWFzZSAwLjN8aGVpZ2h0PTcwfHJlbmRlck1vZGU9c3RhdGljfHdpZHRoPTkwMHxjb2x1bW5zPXR5cGU7a2V5O3N1bW1hcnk7cHJpb3JpdHl8dXJsPWh0dHA6Ly9qaXJhLmNvZGVoYXVzLm9yZy9zci9qaXJhLmlzc3Vldmlld3M6c2VhcmNocmVxdWVzdC14bWwvdGVtcC9TZWFyY2hSZXF1ZXN0LnhtbD9maXhmb3I9MTY5MTQmcGlkPTExOTExJnNvcnRlci9maWVsZD1pc3N1ZWtleSZzb3J0ZXIvb3JkZXI9REVTQyZ0ZW1wTWF4PTEwMDB9&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority|height=70|renderMode=static|title=Release 0.3|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=16914&amp;pid\=11911&amp;sorter/field\=issuekey&amp;sorter/order\=DESC&amp;tempMax\=1000|width=900"></p><p> </p><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9UmVsZWFzZSAwLjIuMXxoZWlnaHQ9MTUwfHJlbmRlck1vZGU9c3RhdGljfHdpZHRoPTkwMHxjb2x1bW5zPXR5cGU7a2V5O3N1bW1hcnk7cHJpb3JpdHl8dXJsPWh0dHA6Ly9qaXJhLmNvZGVoYXVzLm9yZy9zci9qaXJhLmlzc3Vldmlld3M6c2VhcmNocmVxdWVzdC14bWwvdGVtcC9TZWFyY2hSZXF1ZXN0LnhtbD9maXhmb3I9MTY1MTQmcGlkPTExOTExJnNvcnRlci9maWVsZD1pc3N1ZWtleSZzb3J0ZXIvb3JkZXI9REVTQyZ0ZW1wTWF4PTEwMDB9&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority|height=150|renderMode=static|title=Release 0.2.1|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=16514&amp;pid\=11911&amp;sorter/field\=issuekey&amp;sorter/order\=DESC&amp;tempMax\=1000|width=900"></p><p> </p><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9UmVsZWFzZSAwLjJ8aGVpZ2h0PTE1MHxyZW5kZXJNb2RlPXN0YXRpY3x3aWR0aD05MDB8Y29sdW1ucz10eXBlO2tleTtzdW1tYXJ5O3ByaW9yaXR5fHVybD1odHRwOi8vamlyYS5jb2RlaGF1cy5vcmcvc3IvamlyYS5pc3N1ZXZpZXdzOnNlYXJjaHJlcXVlc3QteG1sL3RlbXAvU2VhcmNoUmVxdWVzdC54bWw_Zml4Zm9yPTE1NjEzJnBpZD0xMTkxMSZzb3J0ZXIvZmllbGQ9aXNzdWVrZXkmc29ydGVyL29yZGVyPURFU0MmdGVtcE1heD0xMDAwfQ&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority|height=150|renderMode=static|title=Release 0.2|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=15613&amp;pid\=11911&amp;sorter/field\=issuekey&amp;sorter/order\=DESC&amp;tempMax\=1000|width=900"></p><p> </p><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9UmVsZWFzZSAwLjF8aGVpZ2h0PTE1MHxyZW5kZXJNb2RlPXN0YXRpY3x3aWR0aD05MDB8Y29sdW1ucz10eXBlO2tleTtzdW1tYXJ5O3ByaW9yaXR5fHVybD1odHRwOi8vamlyYS5jb2RlaGF1cy5vcmcvc3IvamlyYS5pc3N1ZXZpZXdzOnNlYXJjaHJlcXVlc3QteG1sL3RlbXAvU2VhcmNoUmVxdWVzdC54bWw_Zml4Zm9yPTE1NDM2JnBpZD0xMTkxMSZzb3J0ZXIvZmllbGQ9aXNzdWVrZXkmc29ydGVyL29yZGVyPURFU0MmdGVtcE1heD0xMDAwfQ&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority|height=150|renderMode=static|title=Release 0.1|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=15436&amp;pid\=11911&amp;sorter/field\=issuekey&amp;sorter/order\=DESC&amp;tempMax\=1000|width=900"></p>