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/pdfreport.html|width=700|height=250|frameborder=0}
Your browser does not support iframes.
{iframe}</pre></td></tr></table>If you are happy with PDF Plugin then you could <a href="http://www.linkedin.com/company/klicap---ingenier-a-del-puzle/sonar-pdf-report-plugin-179289/product">recomend it</a>.There is also <a href="http://klicap.es/sonarpdfplugin">Commercial edition supported by klicap</a>.<h2>Description / Features</h2>Sonar PDF plugin allows to generate a report in PDF format that contains the most relevant information showed by Sonar web interface. The report aims to be a deliverable as part of project documentation. <img class="confluence-embedded-image image-center" src="/download/attachments/231080188/sonar-pdf-plugin-2.png?version=1&amp;modificationDate=1369471562254" data-image-src="/download/attachments/231080188/sonar-pdf-plugin-2.png?version=1&amp;modificationDate=1369471562254" data-linked-resource-id="231376007" data-linked-resource-type="attachment" data-linked-resource-default-alias="sonar-pdf-plugin-2.png" data-base-url="http://docs.codehaus.org" data-linked-resource-container-id="231080188" title="null > sonar-pdf-plugin-2.png" data-element-title="sonar-pdf-plugin-2.png"> Actually the report contains:<ul><li>Global dashboard (similar to Sonar web interface dashboard)</li><li>Violations by categories</li><li>Hotspots:<ul><li>Most violated rules</li><li>Most violated files</li><li>Most complex classes</li><li>Most duplicated files</li></ul></li><li>Dashboard, violations and hotspots for all child modules (if they exists)</li></ul>You can download an example of report <a class="confluence-link unresolved" data-filename="pdf-report-1.1.pdf" title="report example" data-linked-resource-default-alias="pdf-report-1.1.pdf" href="#">here</a>.<h2>Usage</h2><h2>Maven Plugin</h2>First <a class="confluence-link" href="/display/SONAR/Analyzing+Source+Code" data-linked-resource-id="113541695" data-linked-resource-type="page" data-linked-resource-default-alias="Analyzing Source Code" data-base-url="http://docs.codehaus.org">analyze</a> your project in sonar. Then run the generate goal (report will be created in the target directory):<table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre> mvn org.codehaus.sonar-plugins.pdf-report:maven-pdfreport-plugin:1.3:generate
</pre></td></tr></table>Available properties (-Dproperty=value)<ul><li>sonar.host.url: sonar server URL (i.e <a href="http://my-host:9000/sonar">http://my-host:9000/sonar</a>)</li><li>sonar.branch (-Dbranch is also supported): report on a project branch</li><li>report.type: select a report type. Values:<ul><li>-Dreport.type=executive</li><li>-Dreport.type=workbook (default)</li></ul></li><li>sonar.pdf.username: username for access WS API</li><li>sonar.pdf.password: password for the user</li></ul>If your Sonar server URL is <a href="http://localhost:9000">http://localhost:9000</a> you don't need to specify sonar.host.url.<h2>Sonar Plugin (post-job)</h2>  Sonar PDF can be used as a plugin of sonar modeling a post-job work. In this way, a PDF report is generated after each analysis in Sonar (mvn sonar:sonar includes the generation of report).   How to install Sonar PDF in SonarUse update center, or alternatively:<ul><li>Dowload sonar-pdfreport-plugin-1.3.jar</li><li>Copy to [sonar-dir]/extensions/plugins</li><li>Restart Sonar</li></ul>ConfigurationYou can skip report generation or select report type (executive or workbook) at top level or project level. Also you can provide an username/password if your project are secured by Sonar user management:<img class="confluence-embedded-image image-center" src="/download/attachments/231080188/pdf-report-config.png?version=1&amp;modificationDate=1369471562028" data-image-src="/download/attachments/231080188/pdf-report-config.png?version=1&amp;modificationDate=1369471562028" data-linked-resource-id="231375999" data-linked-resource-type="attachment" data-linked-resource-default-alias="pdf-report-config.png" data-base-url="http://docs.codehaus.org" data-linked-resource-container-id="231080188" title="null > pdf-report-config.png" data-element-title="pdf-report-config.png [Report settings page]">Download the reportPDF report can be downloaded from Sonar GUI: <img class="confluence-embedded-image image-center" src="/download/attachments/231080188/download-report.png?version=1&amp;modificationDate=1369471562102" data-image-src="/download/attachments/231080188/download-report.png?version=1&amp;modificationDate=1369471562102" data-linked-resource-id="231376001" data-linked-resource-type="attachment" data-linked-resource-default-alias="download-report.png" data-base-url="http://docs.codehaus.org" data-linked-resource-container-id="231080188" title="null > download-report.png" data-element-title="download-report.png"><h2>Changelog</h2><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9UmVsZWFzZSAgMS4zfGhlaWdodD03MHx3aWR0aD05MDB8Y29sdW1ucz10eXBlO2tleTtzdW1tYXJ5O3ByaW9yaXR5O3N0YXR1cztyZXNvbHV0aW9ufHVybD1odHRwOi8vamlyYS5jb2RlaGF1cy5vcmcvc3IvamlyYS5pc3N1ZXZpZXdzOnNlYXJjaHJlcXVlc3QteG1sL3RlbXAvU2VhcmNoUmVxdWVzdC54bWw_Zml4Zm9yPTE2OTM1JnBpZD0xMTkxMSZzb3J0ZXIvZmllbGQ9aXNzdWVrZXkmc29ydGVyL29yZGVyPURFU0MmdGVtcE1heD0xMDAwfQ&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority;status;resolution|height=70|title=Release 1.3|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=16935&amp;pid\=11911&amp;sorter/field\=issuekey&amp;sorter/order\=DESC&amp;tempMax\=1000|width=900"> <img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9UmVsZWFzZSAgMS4yLjF8aGVpZ2h0PTcwfHdpZHRoPTkwMHxjb2x1bW5zPXR5cGU7a2V5O3N1bW1hcnk7cHJpb3JpdHk7c3RhdHVzO3Jlc29sdXRpb258dXJsPWh0dHA6Ly9qaXJhLmNvZGVoYXVzLm9yZy9zci9qaXJhLmlzc3Vldmlld3M6c2VhcmNocmVxdWVzdC14bWwvdGVtcC9TZWFyY2hSZXF1ZXN0LnhtbD9maXhmb3I9MTc2NTAmcGlkPTExOTExJnNvcnRlci9maWVsZD1pc3N1ZWtleSZzb3J0ZXIvb3JkZXI9REVTQyZ0ZW1wTWF4PTEwMDB9&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority;status;resolution|height=70|title=Release 1.2.1|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=17650&amp;pid\=11911&amp;sorter/field\=issuekey&amp;sorter/order\=DESC&amp;tempMax\=1000|width=900"> <img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9UmVsZWFzZSAxLjJ8aGVpZ2h0PTcwfHdpZHRoPTkwMHxjb2x1bW5zPXR5cGU7a2V5O3N1bW1hcnk7cHJpb3JpdHk7c3RhdHVzO3Jlc29sdXRpb258dXJsPWh0dHA6Ly9qaXJhLmNvZGVoYXVzLm9yZy9zci9qaXJhLmlzc3Vldmlld3M6c2VhcmNocmVxdWVzdC14bWwvdGVtcC9TZWFyY2hSZXF1ZXN0LnhtbD9maXhmb3I9MTYzMDgmcGlkPTExOTExJnNvcnRlci9maWVsZD1pc3N1ZWtleSZzb3J0ZXIvb3JkZXI9REVTQyZ0ZW1wTWF4PTEwMDB9&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority;status;resolution|height=70|title=Release 1.2|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=16308&amp;pid\=11911&amp;sorter/field\=issuekey&amp;sorter/order\=DESC&amp;tempMax\=1000|width=900"> <img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9UmVsZWFzZSAxLjF8aGVpZ2h0PTcwfHdpZHRoPTkwMHxjb2x1bW5zPXR5cGU7a2V5O3N1bW1hcnk7cHJpb3JpdHk7c3RhdHVzO3Jlc29sdXRpb258dXJsPWh0dHA6Ly9qaXJhLmNvZGVoYXVzLm9yZy9zci9qaXJhLmlzc3Vldmlld3M6c2VhcmNocmVxdWVzdC14bWwvdGVtcC9TZWFyY2hSZXF1ZXN0LnhtbD9maXhmb3I9MTYzMDcmcGlkPTExOTExJnNvcnRlci9maWVsZD1pc3N1ZWtleSZzb3J0ZXIvb3JkZXI9REVTQyZ0ZW1wTWF4PTEwMDB9&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority;status;resolution|height=70|title=Release 1.1|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=16307&amp;pid\=11911&amp;sorter/field\=issuekey&amp;sorter/order\=DESC&amp;tempMax\=1000|width=900"> <img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9UmVsZWFzZSAxLjB8aGVpZ2h0PTcwfHdpZHRoPTkwMHxjb2x1bW5zPXR5cGU7a2V5O3N1bW1hcnk7cHJpb3JpdHk7c3RhdHVzO3Jlc29sdXRpb258dXJsPWh0dHA6Ly9qaXJhLmNvZGVoYXVzLm9yZy9zci9qaXJhLmlzc3Vldmlld3M6c2VhcmNocmVxdWVzdC14bWwvdGVtcC9TZWFyY2hSZXF1ZXN0LnhtbD9maXhmb3I9MTYwMDcmcGlkPTExOTExJnNvcnRlci9maWVsZD1pc3N1ZWtleSZzb3J0ZXIvb3JkZXI9REVTQyZ0ZW1wTWF4PTEwMDB9&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority;status;resolution|height=70|title=Release 1.0|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=16007&amp;pid\=11911&amp;sorter/field\=issuekey&amp;sorter/order\=DESC&amp;tempMax\=1000|width=900"> <img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9UmVsZWFzZSAwLjN8aGVpZ2h0PTcwfHdpZHRoPTkwMHxjb2x1bW5zPXR5cGU7a2V5O3N1bW1hcnk7cHJpb3JpdHk7c3RhdHVzO3Jlc29sdXRpb258dXJsPWh0dHA6Ly9qaXJhLmNvZGVoYXVzLm9yZy9zci9qaXJhLmlzc3Vldmlld3M6c2VhcmNocmVxdWVzdC14bWwvdGVtcC9TZWFyY2hSZXF1ZXN0LnhtbD9maXhmb3I9MTUzMjcmcGlkPTExOTExJnNvcnRlci9maWVsZD1pc3N1ZWtleSZzb3J0ZXIvb3JkZXI9REVTQyZ0ZW1wTWF4PTEwMDB9&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority;status;resolution|height=70|title=Release 0.3|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=15327&amp;pid\=11911&amp;sorter/field\=issuekey&amp;sorter/order\=DESC&amp;tempMax\=1000|width=900"> <img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9UmVsZWFzZSAwLjJ8aGVpZ2h0PTcwfHdpZHRoPTkwMHxjb2x1bW5zPXR5cGU7a2V5O3N1bW1hcnk7cHJpb3JpdHk7c3RhdHVzO3Jlc29sdXRpb258dXJsPWh0dHA6Ly9qaXJhLmNvZGVoYXVzLm9yZy9zci9qaXJhLmlzc3Vldmlld3M6c2VhcmNocmVxdWVzdC14bWwvdGVtcC9TZWFyY2hSZXF1ZXN0LnhtbD9maXhmb3I9MTUyNTMmcGlkPTExOTExJnNvcnRlci9maWVsZD1pc3N1ZWtleSZzb3J0ZXIvb3JkZXI9REVTQyZ0ZW1wTWF4PTEwMDB9&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority;status;resolution|height=70|title=Release 0.2|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=15253&amp;pid\=11911&amp;sorter/field\=issuekey&amp;sorter/order\=DESC&amp;tempMax\=1000|width=900"> <img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9UmVsZWFzZSAwLjF8aGVpZ2h0PTcwfHdpZHRoPTkwMHxjb2x1bW5zPXR5cGU7a2V5O3N1bW1hcnk7cHJpb3JpdHk7c3RhdHVzO3Jlc29sdXRpb258dXJsPWh0dHA6Ly9qaXJhLmNvZGVoYXVzLm9yZy9zci9qaXJhLmlzc3Vldmlld3M6c2VhcmNocmVxdWVzdC14bWwvdGVtcC9TZWFyY2hSZXF1ZXN0LnhtbD9maXhmb3I9MTUyMzImcGlkPTExOTExJnNvcnRlci9maWVsZD1pc3N1ZWtleSZzb3J0ZXIvb3JkZXI9REVTQyZ0ZW1wTWF4PTEwMDB9&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority;status;resolution|height=70|title=Release 0.1|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=15232&amp;pid\=11911&amp;sorter/field\=issuekey&amp;sorter/order\=DESC&amp;tempMax\=1000|width=900"> <h2>Known limitations</h2>Ant task and Maven 3 Sonar plugin is not supported.