Thank you for trying Sonar Watch. We prepared this walkthrough to cover the most common usage scenarios. Feel free to use our Contact Form for any additional questions.

Connecting to Sonar

When the splash screen clears, you will see the start screen. Tap the orange button Connect to Sonar to begin. The login box appears.

Sonar Watch requires some information in order to connect to your Sonar Server. Contact your server administrator for details. You will need at least the Server URL, and likely a User name and Password as well. This is the same information you use to access the server's web interface.

Tap the Server URL field to enter the URL of your Sonar server. In most cases you do not have to type the full URL. Sonar Watch will fill in the default http:// protocol prefix and assume a connection to the standard port 80. Some examples are:

sonar.mycompany.com Just the server name
sonar.mycompany.com/sonar The server requires a path component
sonar.mycompany.com:8080 The server uses at a custom port
http://sonar.mycompany.com:8080/sonar Complete URL with port and path

If you intend to use Sonar Watch from outside your company network, we strongly suggest you use the secure HTTPS protocol instead. Your Sonar server must be configured accordingly. Enter the full URL including protocol prefix, such as:

https://sonar.mycompany.com/sonar

If your Sonar server requires login credentials, tap the User field to enter your user name, and the Password field for your password. Leave these fields blank when your server does not require credentials, or when when connecting to a public server, such as https://sonarqube.com/ .

Finally, tap the Login button to continue. If there is any connection or authentication problem, you will see a pop-up with an error message that will hopefully help you to fix the issue. Once you successfully connect to the server, Sonar Watch will remember your settings for future sessions.

Using the Projects Overview

The project overview lists all your Sonar projects, line by line. On the left side are the project name, its current current version, and last build date. On the right side are the two most important project metrics: The size measured in Lines of Code, and the degree of Rules Compliance in percent.

The title bar contains an additional sort button, the first one on the right side. Tap this button to show a list of sorting criteria. The current selection is highlighted in blue. Tap another criterion, and Sonar Watch will sort the project overview accordingly. If you are content with the current order, just tap outside the pop-up to dismiss it.

To inspect a given project, scroll the list until you find it, then tap its line to continue.

Inspecting Rule Violations

The rule categories screen shows the name of your selected project in the title bar, along with the total number of its coding rule violations.

The list below shows the distribution of the rule violations according to severity, in descending order. To inspect any of these categories, tap the respective line to continue.

The rule detail screen shows the selected category in the title bar, along with the total violation count.

The list below shows the distribution of violations according to the actual coding rules.

General Navigation

On each screen of Sonar Watch, use the title bar for general navigation.

Tap the button on the top left to return to the previous screen. Your last selection there will be highlighted in blue, so you can quickly find it again in case you change your mind.

Tap the button on the top right to refresh the current screen with the latest Sonar server state.

You may leave the Sonar Watch application any time by pressing the Home button on your iPad. When you launch the application at a later date, it will usually return right to the screen where you left off. If your last session was some time ago, consider tapping the refresh button.