Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.

Executes a sonar scan. This operation takes inputs for both a Sonar project properties path and an analysis properties file. If both are provided, the plugin will use the analysis properties and do nothing with the path. This operation only returns its task Id and browsable url on the specified SonarQube instance.

titleAnalysis Properties

There are a significant amount of analysis parameters available to augment a Sonar scan. It is recommended to research which parameters are necessary for your projects and sonar scans.

Analysis Tool Instance Properties

Property NameProperty CodeRequiredDescription
SonarQube instance URL


SonarQube Server Instance URL (example: https://localhost:9000)

SonarQube Token


SonarQube Server Token provides credentials to run code scans or to invoke web services as a replacement of the user login. Provide a token or username and password.

SonarQube Username
NoThe username for your SonarQube Server Instance. Provide a token or username and password.
SonarQube Password
NoThe password for your SonarQube Server Instance. Provide a token or username and password.
SonarQube Clinet path
NoSonarQube Client path in the server (e.g. /u01/sonarClinet/sonar-scanner-

Project Properties

Property NameProperty CodeRequiredDescription


Input NameInput CodeRequiredDescription
YesThe SonarQube account with all the required properties like Sonar Scanner Home, Instance Url, Token for running SonarQube Instance.
Sonar Project Properties Path
NoAbsolute file path of the file.
Analysis Properties
NoDefine the sonar project properties manually. This will override all other fields. Required property: sonar.projectKey


Output NameDescription
Id of the task or Sonar scan started.
FDSQ_OUT_DASHBOARD_URLSonarQube instance dashboard url. Note that you will be able to access the updated dashboard once the server has processed the submitted analysis report.


This operation doesn’t consume or produce any artifacts.

Endpoint Selection

This operation delegates the selection to the workflow developer to determine.

Endpoint Execution

This operations delegates the execution to the workflow developer to decide.

Special Considerations

  • SonarQube instance required

    titleGet started with a SonarQube Instance in two minutes
    1. Download the SonarQube Community Edition.

    2. As a non-root user, unzip it, let's say in C:\sonarqube or /opt/sonarqube.

    3. As a non-root user, start the SonarQube Server: 

      Code Block
      # On Windows, execute:
      # On other operating systems, as a non-root user execute:
      /opt/sonarqube/bin/[OS]/ console


      If you're having trouble starting your server for the first time (or any subsequent time!) the first thing to do is check your server logs. You'll find them in $SONARQUBE_HOME/logs:

      • sonar.log - Log for the main process. Holds general information about startup and shutdown. You'll get overall status here but not details. Look to the other logs for that.
      • web.log - Information about initial connection to the database, database migration and reindexing, and the processing of HTTP requests. This includes database and search engine logs related to those requests.
      • ce.log - Information about background task processing and the database and search engine logs related to those tasks.
      • es.log - Ops information from the search engine, such as Elasticsearch startup, health status changes, cluster-, node- and index-level operations, etc.

    4. Log in to http://localhost:9000 with System Administrator credentials (login=admin, password=admin).

    5. Click the Create new project button to analyze your first project.

  • Sonar Scanner installed on target environment