Configuration of Squale

For this part you will need a set of configuration files. You can :

• Use our set of configuration files. You can found it in the directory 04-config-files in the distrib archive.
• Create your own set of configuration files. We advise you to use our files as a base for create yours.

The first configuration of Squale should be done in this order :

1. Insert the messages
   1. Go through the horizontal menu to : Administration / Messages.
   2. Select the xml file of messages to insert into Squale.
   3. Then click on Confirm.

   Now the new messages are insert.

2. Grid quality
   1. Insert a new grid quality
      1. Go through the horizontal menu to : Administration / Quality grids.
      2. Click on create on the left menu. Then select the quality grid you want to add.
      3. Click on Confirm.
      4. Warning A new message appear but the quality grid is not download for the moment. For that, you should click again on Confirm.

      Note When you download a quality grid into Squale, you absolutely need to insert the associate squalix-config.

      Now the new quality grid is download.

   2. Suppress a grid quality

      The grid you want to suppress shouldn't be used by an audit.

      1. Go through the horizontal menu to : Administration / Quality grids.
      2. Check among the list of grids those you want to suppress.
      3. Click on Purge.

      Now the grid(s) is(are) suppressed from Squale.

3. Insert a new squale-config file

   For load a squale-config file, the related grids should be load before.

   1. Squale configuration information

      Some Squale configuration informations are defined in the squale-config file

      1. The mail configuration

         You will find all the mail configuration parameter in the tag : <mail>

         <admin-params>
             <mail>
                 <admin-mailing-list></admin-mailing-list><!--mandatory-->
                 <smtp-server></smtp-server>
                 <sender-address></sender-address>
                 <smtp-authent-needed></smtp-authent-needed><!-- true or false -->
                 <smtp-username></smtp-username>
                 <smtp-password></smtp-password>
             </mail>
         </admin-params>
         

         There is 6 parameters :

         • <admin-mailing-list> : It's the mail address for contact the Squale administrators. It's the mail address which will be used when you click on Contact on the bottom left menu. This tag is mandatory
         • <smtp-server> : It's the SMTP server address.
         • <sender-address> : Mail address used as sender when Squale send a mail.
         • <smtp-authent-needed> : Does the SMTP server need an authentication address ? If yes then put "true", else put "false". Note : By default Squale consider that the SMTP server doesn't need an authentication.
         • <smtp-username> : username for smtp authentication.
         • <smtp-password> : password for smtp authentication.

         Note : If a tag is present, it can't be null (database constraint).

   2. Insert a squale-config file

      For insert a squale-config file :

      1. Go through the the horizontal menu to : Administration / Tools configuration / Squalix batch.
      2. Select the squale_config xml file you want to insert and click on Confirm.

      Now the new squalix-config file is insert into Squale.

4. Insert a PMD file
   1. Insert a PMD file

      For insert a PMD file :

      1. Go through the the horizontal menu to : Administration / Tools configuration / PMD.
      2. Select the pmd xml file you want to insert.
      3. Click on Confirm.

      Now the PMD file is insert into Squale.

   2. Suppress a PMD file

      The PMD file you want to suppress shouldn't be used by an audit.

      1. Go through the the horizontal menu to : Administration / Tools configuration / PMD.
      2. Check among the list of PMD files those you want to suppress.
      3. Click on Delete.

      Now the PMD file(s) is(are) suppressed from Squale.

5. Checkstyle file
   1. Insert a checkstyle file

      For insert a checkstyle file :

      1. Go through the horizontal menu to : Administration / Tools configuration / checkstyle.
      2. Select the checkstyle xml file you want to insert.
      3. Click on Confirm.

      Now the checkstyle file is insert into Squale.

   2. Suppress a checkstyle file

      The checkstyle file you want suppressed shouldn't be used by an audit.

      1. Go through the horizontal menu to : Administration / Tools configuration / checkstyle.
      2. Check among the list of checkstyle files those you want to suppress.
      3. Click on Delete.

      Now the checkstyle file(s) is(are) suppressed from Squale.