Configuration Overview

The picture below shows the different components involved in the Squore process.

CFG processOverview
Figure 1. Squore process overview

The main building blocks of the Squore configuration are:

  • SQuORE parser and other Data Providers are the inputs for the process, providing base measures for the analysis model.

  • Analysis Models define the transformation between base measures , which are retrieved from Data Providers and derived measures .

  • Decision models define how to process raw data (i.e. base measures) and analysis data (i.e. derived measures) to raise action items .

  • Dashboards present the overall results in a convenient way. They are deeply customisable and can show all the information needed in day-to-day usage of Squore.

  • Reports extract information and present it in a document (PDF, PowerPoint or spreadsheet). They can be used for external reporting, e.g. when there is no access to the Squore interface.

Default models

Models define how Squore computes metrics (analysis model), how action items are created (decision model), and how data is displayed (dashboards and reports).

All models are located in the <SQUORE_HOME>/configuration/models directory.

Each folder in <SQUORE_HOME>/configuration/models is a separate model. Each model has a wizard, i.e. a series of screens where users configure the options available for the model before launching an analysis, as described in Wizards.

Shared folder

The Shared folder is different, since it is not a self-contained model, but rather a collection of components that are meant to be imported by other models in the configuration. This avoids creating redundancy, and redefining the same metrics or indicators every time.

To understand common measures and rules used across Squore you can take a look at the common definitions available in <SQUORE_HOME>/configuration/models/Shared/Analysis/product_quality/code, especially:

  • artefact_rating

  • call_relation

  • cloning

  • complexity

  • control_flow_analysis

  • line_counting

  • rule_checking

  • stability

Creating a New Model

Creating a new model is as simple as creating a folder in your Customising Squore Configuration, custom configuration folder>> and creating the various definition files needed for the Analysis Model, the Decision Model, the dashboard and reports you want to enable:

  1. Create a new directory MyModel in the MyConfiguration/configuration/models directory.

  2. In the MyModel folder, create the following sub-folders:

    • Analysis

    • Dashboards

    • Decision

    • Description

    • Exports

    • Highlights

    • Properties

    • Reports

    • Wizards

  3. Log into Squore as administrator, reload the configuration and click Models > Validator. Your new model should be visible in the list of available models.

The Building Your Own Model section of this manual will cover how to use existing packages from the Shared folder and how to display text in the web infterface.