A model is a collection of several Bundle.xml files where your entire model is described. A model folder normally contains the following bundles:

More information about each type of bundle is available in this manual. Note that a Bundle.xml file normally includes external files located elsewhere in the standard Squore configuration. This allows reusing modules between models.

The following is an (incomplete) example of a Bundle.xml file that includes other files from the Squore configuration. Note that the xmlns:xi declaration in the Bundle element is mandatory if you want to include external files.

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<Bundle xmlns:xi="http://www.w3.org/2001/XInclude" >
    <!-- Aliases -->
    <ArtefactType id="CODE" heirs="PACKAGES;FILES;CLASSES;MODULES" />
    <ArtefactType id="PACKAGES" heirs="APPLICATION;SOURCE_CODE;FOLDER" />
    <ArtefactType id="FILES" heirs="FILE" />
	<ArtefactType id="CLASSES" heirs="CLASS" />

	<xi:include href="../../Shared/Analysis/SQuORE_BasicScales.xml" />	   
	
		<!-- SQuORE Base Measures -->
	<xi:include 
	  href="../../Shared/Analysis/product_quality/code/line_counting/line_counting.xml" />
	<xi:include 
	  href="../../Shared/Analysis/Code/ObjectOrientation/squore_java_oo_basemeasures.xml" />
	<xi:include 
	  href="../../Shared/Analysis/Code/ObjectOrientation/SQuORE_Inheritance.xml" />

		<!-- Rule Checking -->
	<xi:include 
	  href="../../Shared/Analysis/Code/RuleSet/SQuORE_Java_RuleSet.xml" />

		<!-- SQALE Analysis Model -->
	<xi:include 
	  href="../../Shared/Analysis/Code/SQALE/SQALE_Characteristics.xml" />
	<xi:include href="SQALE_Requirement.xml" />

	<RootIndicator indicatorId="SQALE_INDEX_DENSITY" artefactTypes="APPLICATION;FOLDER;SOURCE_CODE" />
	<RootIndicator indicatorId="SQALE_INDEX" artefactTypes="FUNCTION;CLASS;FILE" />
	<Measure measureId="COST" targetArtefactTypes="APPLICATION" defaultValue="0" />
</Bundle>

In order to provide a simple way to display dashboards in multiple languages in the Squore web interface, all strings have been externalised to .properties files . A .properties file contains translations for all the metrics, rules, action items, charts and other objects described in your model. A model contains a Bundle.xml that lists all the .properties files that need to be loaded for this model.

In your description bundle, inlude a .properties file by adding a Properties element. Squore will select the appropriate display language for this model according to the language options defined in the available and default attributes, as shown below:

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<Bundle available="fr,en" default="en">
	<Properties src="../../Shared/data_provider/squan_sources/descriptions" />
</Bundle>

In the example above, it is assumed that two files exist with the names Shared/data_provider/squan_sources/descriptions_en.properties and Shared/data_provider/squan_sources/descriptions_fr.properties, since you declared both languages in the available attribute. Users are free to switch between the English and French languages using the flag icons in the Squore web interface. By default, Squore will display the descriptions from descriptions_en.properties, since you set the default language to "en" using the default attribute.

Properties files are simple text files containing key-value pairs to associate text to a property of an element of your model.

For example, the metric SLOC is translated using this line in a .properties file:

SLOC.DESCRIPTION=The number of source line of codes

If we need the desctiption of SLOC to be different for artefact of type CPP_FUNCTION and APPLICATION, we can use a more advanced definition:

M.SLOC.DESCRIPTION.APPLICATION=The number of source line of codes in the application
M.SLOC.DESCRIPTION.CPP_FUNCTION=The number of source line of codes in the function

The convention for this syntax is as follows:

[PREFIX.]IDENTIFIER.PROPERTY[.ARTEFACT_TYPE]=My localised text

where:

Examples

Here are the locations of the default types, permissions, roles and profiles, and statuses:

You are free to override or extend these defaults in your own .properties file in your model.