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="info" data-macro-parameters="icon=false|title=Table of Contents" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2luZm86aWNvbj1mYWxzZXx0aXRsZT1UYWJsZSBvZiBDb250ZW50c30&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body"><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e3RvYzptYXhMZXZlbD0zfQ&amp;locale=en_GB&amp;version=2" data-macro-name="toc" data-macro-parameters="maxLevel=3"></p></td></tr></table><p>The web interface has been designed to help you quickly find what you are looking for.</p><p>It can be displayed in various <a class="confluence-link" href="#Localization" data-anchor="Localization" data-linked-resource-default-alias="Localization" data-base-url="http://docs.codehaus.org">languages</a>.</p><h1>Interface Layout</h1><p>The web interface is divided in three areas:</p><ul><li>Top bar</li><li>Left menu</li><li>Dashboard</li></ul><p><img class="confluence-embedded-image" confluence-query-params="effects=drop-shadow" src="/download/attachments/231082380/browsing_sonar_layout.png?version=1&amp;modificationDate=1371696777840&amp;effects=drop-shadow" data-image-src="/download/attachments/231082380/browsing_sonar_layout.png?version=1&amp;modificationDate=1371696777840&amp;effects=drop-shadow" data-linked-resource-id="231377187" data-linked-resource-type="attachment" data-linked-resource-default-alias="browsing_sonar_layout.png" data-base-url="http://docs.codehaus.org" data-linked-resource-container-id="231082380" title="null > browsing_sonar_layout.png"></p><h3>Top Bar</h3><p>Wherever you are, you can access the top bar:</p><p><img class="confluence-embedded-image" confluence-query-params="effects=drop-shadow" src="/download/attachments/231082380/browsing_sonar_top_bar.png?version=1&amp;modificationDate=1371696777834&amp;effects=drop-shadow" data-image-src="/download/attachments/231082380/browsing_sonar_top_bar.png?version=1&amp;modificationDate=1371696777834&amp;effects=drop-shadow" data-linked-resource-id="231377186" data-linked-resource-type="attachment" data-linked-resource-default-alias="browsing_sonar_top_bar.png" data-base-url="http://docs.codehaus.org" data-linked-resource-container-id="231082380" title="null > browsing_sonar_top_bar.png"></p><ul><li><strong>Dashboards</strong> to go back to the Home page</li><li><strong>Projects</strong> to access the complete list of Projects, Views, Developers, etc. or to access previously browsed projects:<br /><img class="confluence-embedded-image" confluence-query-params="effects=drop-shadow" src="/download/attachments/231082380/browsing_sonar_projects.png?version=1&amp;modificationDate=1371696777805&amp;effects=drop-shadow" data-image-src="/download/attachments/231082380/browsing_sonar_projects.png?version=1&amp;modificationDate=1371696777805&amp;effects=drop-shadow" data-linked-resource-id="231377185" data-linked-resource-type="attachment" data-linked-resource-default-alias="browsing_sonar_projects.png" data-base-url="http://docs.codehaus.org" data-linked-resource-container-id="231082380" title="null > browsing_sonar_projects.png"><br />  </li><li><strong>Measures</strong> to access the <a class="confluence-link" href="/pages/viewpage.action?pageId=230395194" data-linked-resource-id="230395194" data-linked-resource-type="page" data-linked-resource-default-alias="Measures Service / Filters" data-base-url="http://docs.codehaus.org">Measures service</a></li><li><strong>Issues </strong>to access the <a class="confluence-link" href="/display/SONAR/Issues" data-linked-resource-id="231080383" data-linked-resource-type="page" data-linked-resource-default-alias="Issues" data-base-url="http://docs.codehaus.org">Issues service</a></li><li><strong>Settings</strong> to access the <a class="confluence-link" href="/display/SONAR/Administration+Guide" data-linked-resource-id="113541700" data-linked-resource-type="page" data-linked-resource-default-alias="Administration Guide" data-base-url="http://docs.codehaus.org">system settings</a> (mainly for system administrators)</li><li><strong>Log in / &lt;Name&gt; </strong>to<strong> </strong>log in. Depending on your user rights, you will have access to different dashboards and services. Logging in also allows you to have access to your own customized web interface. From there, you can modify your profile and log out.</li><li><strong>Search</strong> for a <a class="confluence-link" href="/display/SONAR/Concepts#Concepts-resource" data-anchor="resource" data-linked-resource-id="111706489" data-linked-resource-type="page" data-linked-resource-default-alias="Concepts#resource" data-base-url="http://docs.codehaus.org">resource</a>: project, file, view, developer, etc. to quickly access it.<br /><img class="confluence-embedded-image" confluence-query-params="effects=drop-shadow" src="/download/attachments/231082380/search.png?version=1&amp;modificationDate=1371696777868&amp;effects=drop-shadow" data-image-src="/download/attachments/231082380/search.png?version=1&amp;modificationDate=1371696777868&amp;effects=drop-shadow" data-linked-resource-id="231377188" data-linked-resource-type="attachment" data-linked-resource-default-alias="search.png" data-base-url="http://docs.codehaus.org" data-linked-resource-container-id="231082380" title="null > search.png"> </li><li>Keep track of where you are thanks to the <strong>breadcrumb trail</strong>. This breadcrumb trail is clickable, so you can quickly reach an upper level dashboard.</li><li><strong>&lt;Star&gt;</strong> to flag the current <a class="confluence-link" href="/display/SONAR/Flag+a+Resource+as+Favourite" data-linked-resource-id="229737905" data-linked-resource-type="page" data-linked-resource-default-alias="Flag a Resource as Favourite" data-base-url="http://docs.codehaus.org">project as favourite</a></li><li><strong>Configuration</strong> to access the current project's configuration pages</li></ul><h3>Left Menu</h3><p>The left menu is a contextual menu that depends on the area you areand on your user rights. It provides access to different dashboards and services.</p><h3>Dashboard</h3><p>It is where the data are displayed.</p><p>The main kinds of dashboards:</p><ul><li><a class="confluence-link" href="/display/SONAR/Dashboards#Dashboards-globaldashboard" data-anchor="globaldashboard" data-linked-resource-id="163872785" data-linked-resource-type="page" data-linked-resource-default-alias="Dashboards#globaldashboard" data-base-url="http://docs.codehaus.org">Global dashboard</a> displays high level (instance level) data</li><li><a class="confluence-link" href="/display/SONAR/Dashboards#Dashboards-projectdashboard" data-anchor="projectdashboard" data-linked-resource-id="163872785" data-linked-resource-type="page" data-linked-resource-default-alias="Dashboards#projectdashboard" data-base-url="http://docs.codehaus.org">Project dashboard</a> displays project data</li><li><a class="confluence-link" href="/display/SONAR/Resource+Viewer" data-linked-resource-id="111706389" data-linked-resource-type="page" data-linked-resource-default-alias="Resource Viewer" data-base-url="http://docs.codehaus.org">Resource viewer</a> displays detailed data on resource</li><li>System configuration for the sytem administrators to configure the SonarQube instance</li><li>Project configuration for the project administrators to configure their project settings (setting analysis properties, creating action plans, etc.)<img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2FuY2hvcjpkcmlsbERvd259&amp;locale=en_GB&amp;version=2" data-macro-name="anchor" data-macro-default-parameter="drillDown"></li></ul><h1>Drilling Down</h1><p>The motto is that you will need three clicks maximum to go from a quality indicator to a corrective action in the source code.</p><h3>Example #1: Issues Drilldown</h3><p><img class="confluence-embedded-image" width="900" src="/download/attachments/231082380/drilldown-violation.png?version=1&amp;modificationDate=1371696777902" data-image-src="/download/attachments/231082380/drilldown-violation.png?version=1&amp;modificationDate=1371696777902" data-linked-resource-id="231377190" data-linked-resource-type="attachment" data-linked-resource-default-alias="drilldown-violation.png" data-base-url="http://docs.codehaus.org" data-linked-resource-container-id="231082380" title="null > drilldown-violation.png"></p><h3>Example #2: Duplication Drilldown</h3><p><img class="confluence-embedded-image" width="900" src="/download/attachments/231082380/drilldown-duplication.png?version=1&amp;modificationDate=1371696777882" data-image-src="/download/attachments/231082380/drilldown-duplication.png?version=1&amp;modificationDate=1371696777882" data-linked-resource-id="231377189" data-linked-resource-type="attachment" data-linked-resource-default-alias="drilldown-duplication.png" data-base-url="http://docs.codehaus.org" data-linked-resource-container-id="231082380" title="null > drilldown-duplication.png"></p><h1>Quickly Accessing your Favourites</h1><p>The web interface provides the ability to <a class="confluence-link" href="/display/SONAR/Flag+a+Resource+as+Favourite" data-linked-resource-id="229737905" data-linked-resource-type="page" data-linked-resource-default-alias="Flag a Resource as Favourite" data-base-url="http://docs.codehaus.org">flag resources as favourite</a>. You can then quickly access your favourites by displaying them on <a class="confluence-link" href="/display/SONAR/Dashboards" data-linked-resource-id="163872785" data-linked-resource-type="page" data-linked-resource-default-alias="Dashboards" data-base-url="http://docs.codehaus.org">dashboards</a> through <a href="http://docs.codehaus.org/pages/viewpage.action?pageId=230395194#MeasuresFiltersService-Filters">filters</a>.</p><h1>Localization</h1><p>The web interface is displayed in the preferred language that you set in your browser settings.</p><p>If it is not, just ask your administrator to add the corresponding language pack. Have a look at the <a class="confluence-link" href="/display/SONAR/Localization" data-linked-resource-id="220659719" data-linked-resource-type="page" data-linked-resource-default-alias="Localization" data-base-url="http://docs.codehaus.org">available bundles</a>.</p><p> </p><p> </p>