Page tree
Skip to end of metadata
Go to start of metadata

On this page:

Target audience:

CAST AI Administrators

Summary: This page explains how to configure the CAST Application Analytics Dashboard tile interface

The CAST Application Analytics Dashboard has a "tile" or "panel" based interface that provides access to the data:

These tiles have default presentation settings, but this can be modified and tailored to your requirements. For example:

  • Tile colours can be changed
  • Tile positions can be changed
  • Tile contents can be changed
  • Tile size can be changed
  • New tiles can be added

Editing your tiles presentation

The default tile presentation is defined in the following files:

File nameUsage

%CATALINA_HOME%\webapps\CAST-AAD\portal\resources\cmp.json

This file governs the display of tiles when your Measurement Service contains multiple Applications - i.e the Multi-application landing page.

%CATALINA_HOME%\webapps\CAST-AAD\portal\resources\app.json

This file governs the display of tiles for a single Application - i.e the Application landing page. This page is displayed in two situations:

  • When the Measurement Service contains information about only one Application
  • When you have drilled down from the Multi-application landing page into a single Application.
For more information about the Multi-application and Application landing pages, see CAST Application Analytics Dashboard - CAST AAD.

To modify the presentation, edit the .json file with a text editor (Notepad or other similar application). CAST recommends:

  • creating a copy of the default .json files that can be used as a replacement if an error occurs during editing
  • first changing existing parameters such as color and title and also moving Tiles around before you begin making large scale and more complex changes

Note that CAST provides "library" files containing examples of all the tiles that can be created and used in the CAST Application Analytics Dashboard. You can use these files as well as the examples in this documentation page to build your own tiles. These library tiles can be found along side the live cmp.json and app.json files:

  • %CATALINA_HOME%\webapps\CAST-AAD\portal\resources\cmp_tiles_library.json
  • %CATALINA_HOME%\webapps\CAST-AAD\portal\resources\app_tiles_library.json

Viewing the changes in your browser

There is no need to restart the application server or application itself if you edit and save the cmp.json or app.json files: changes are immediate on saving the file. However, you may find that the changes are not immediately visible in the CAST Application Analytics Dashboard. This is because the .json files are loaded into the browser's cache, therefore CAST recommends that you empty your browser cache to force the changes to become visible.

If you are using Google Chrome the following tip can be used to automatically empty the browser cache:

  • Tap F12 to open the Developer Tools window at the bottom of the page.
  • Click the Settings icon (a cog) to the right of the Developer Tools window
  • Tick the Disable cache (while DevTools is open) option and close the Settings window.
  • In this state, when you then tap F12 followed by F5 to refresh the page, the browser cache will be automatically emptied.

Changing the positions of tiles

Tiles are displayed in the CAST Application Analytics Dashboard in a left to right and top to bottom format within each "Area" (see below). In the .json file, Tiles are listed one after the other, therefore to move a Tile, you need to change its position in the .json file using copy/paste: the higher up the list within the "Area" you place the tile code, the higher up it will be displayed in the dashboard itself.

Structure of the .json

The .json file is divided into various different sections, each corresponding to an area or tile in the Application Analytics Dashboard:

Areas

There are three areas, each corresponding to the Overview, Evolution and Software Enhancement Function Points (since Previous Version) (app.json only) sections you can see by default:

These are represented in the .json file as follows:

"id": 1,
"title": "Overview",

and:

"id": 3,
"title": "Evolution",

and:

"id": 2,
"title": "Software Enhancement Function Points (since Previous Version)",

Tiles

Within each Area, various Tiles (or Panels) are defined, for example:

            {
                "id": 5,
                "plugin": "QualityIndicatorResults",
                "color": "yellow",
                "parameters": {
                    "title": "Robustness",
                    "qualityIndicator": {"id": "ROBUSTNESS", "format": "0.00"},
                    "details":{
                        "ranges":[1.6,2.8,3.0,3.4]
                    },
                    "widget": "gauge"
                }
            },

Available parameters in .json

Global parameters

Please see CAST-AAD - Dashboard wide configuration options in json for more information about the following parameters that can be defined in the cmp.json (and in the app.json) to provide dashboard wide parameterization (i.e, they are valid regardless of whether your dashboard contains one or multiple Applications):

    "title": "Application Analytics Dashboard",
    "language": "en",
    "horizontalScroll": false,
    "confirmLogout": true,
	"persistNavigationFilters":true,
	"filtering":{
      "filterTags":false
    },
    "period": {
        "shift": true,
        "periods": [
            { "diff": 30, "units": "days" },
            { "diff": 3, "units": "months" },
            { "diff": 6, "units": "months" },
            { "diff": 12, "units": "months", "selected": true },
            { "diff": 2, "units": "years" },
            { "diff": 0, "units": "alltime" }
        ]
    }

Tile parameters

A tile or panel represents the equivalent of a "plugin". Each tile is composed of the following properties:

Parameter
Description
idRepresents the tile's unique id. This is a technical id used to identify the panels and MUST be unique throughout the .json file.
pluginRepresents the type of indicators to be displayed in the tile. The plugins that are available are listed below under Plugin parameters.
colorOptional parameter that describes the tile color theme to be used. A light grey color is used if none is defined. Colors are currently limited to:
  • blue
  • black
  • dark grey
  • orange
  • green
  • purple
  • light grey
  • yellow
size

Optional parameter provides the ability to expand tiles in size (large and small):


autoFit

Optional parameter that (when set to true - the default position) will truncate a plugin's title text if it is longer than the size of the tile (whether a large or small tile). Using this parameter may lead to visually less consistent dashboards.

The default value is true, where the font size used for a plugin's title text will be reduced so that the title text fits the tile size. To deactivate the autoFit option, you need to specifically add the parameter to your plugin and set it to false.

parameters This section contains plugin specific parameters. Please refer to each of the following plugin definitions under Plugin parameters for more information about this.

Plugin parameters

A plugin also has various different parameters as follows:

Note that:

  • some plugins are named specifically for use in a specific .json file. In otherwords, a plugin will have two unique names, one for the cmp.json and one for the app.json. Plugins that function like this are documented as such below.
  • plugins that function in the cmp.json file may not necessarily function in the app.json file (and vice-versa)

Common plugin parameters

ParameterDescription
titleA title used to identify the tile.
mode

Determines how much detail will be presented in a tile. Not all tiles support the attribute.

  • terse
  • verbose
qualityIndicator or sizingMeasureRepresent the measurement data properties (typically the indicator identifier, some high level description and the value formatting).
  • quality indicator ids include i.e. ARCHITECTURAL_DESIGN, CHANGEABILITY, DOCUMENTATION, PERFORMANCE, PROGRAMMING_PRACTICE, ROBUSTNESS, SEI_MAINTAINABILITY, SECURITY, TQI, TRANSFERABILITY
  • the format in which the value has to be displayed, it uses the the format defined in numeral.js (see http://numeraljs.com/ for available Numbers formats.

scope

Enables a specific filter to be added to a tile (and related detail) to focus on Applications assigned to a defined tag and related category. Both sub-parameters are mandatory:

  • category the category name

  • tag the tag name in the category

The parameter is global to tile configuration but only applies to the following plugins:

  • PortolioListing

  • QualityIndicatorResults and QualityIndicatorEvolution

  • SizingMeasureResults

  • SizingMeasureEvolution

  • BackgroundFactsResults

  • BackgroundFactsEvolution

  • CustomExpressions

  • CustomExpressionsEvolution

See Note about tags and categories as tile scopes in CAST Application Analytics Dashboard - CAST AAD.

PortfolioListing

This tile is only available for use in the cmp.json file - in other words at multi-app/portfolio level.

Without scope:

{
    "id":20150818,
    "plugin": "PortfolioListing",
    "color": "grey-dark",
    "parameters":{
    	"title":"Number of applications"
    }
},

With scope on Tag and Category:


{				   
	"id":20160405,
	"plugin": "PortfolioListing",
	"color": "grey-dark",
	"parameters":{
		"title":"Number of applications",
		"scope":{
			"category":"Vendors",
			"tag":"Vendor 1"
		}
	}
},

Notification

An array whose first five items are shown in the area. Each item describes a notification:

  1. type: Describe the type of notifications. 
    1. analysisSince - count the number of applications not analyzed in the selected period of time
    2. addedCount - count the number of applications added in the selected period of time
    3. sizingMeasureEvolution - count the number of applications with an evolution larger than the given threshold
    4. qualityIndicatorEvolution - count the number of applications with an evolution larger than the given threshold
  2. threshold used by sizingMeasure/qualityIndicator evolutions to filter application with small evolutions
  3. trend used by qualityIndicator evolutions to focus on improvement/degradations or sizingMeasure evolutions to focus on increase/decrease
  4. qualityIndicatorEvolution comes with qualityIndicator information:
    1. id is either: ARCHITECTURAL_DESIGN, CHANGEABILITY, DOCUMENTATION, PERFORMANCE, PROGRAMMING_PRACTICE, ROBUSTNESS, SEI_MAINTAINABILITY, SECURITY, TQI, TRANSFERABILITY
    2. description is whatever is required
    3. format is the format in which the value has to be displayed, it uses the the format defined in numeral.js (see http://numeraljs.com/ for available Numbers formats)
  5. sizingMeasureEvolution comes with a sizingMeasure information
    1. id is either: TECHNICAL_DEBT, LINES_OF_CODE, NUMBER_OF_ARTIFACTS, NUMBER_OF_COMMENT_LINES, NUMBER_OF_DECISION_POINTS, NUMBER_OF_FILES, AUTOMATED_IFPUG_FUNCTION_POINTS_ESTIMATION,BACKFIRED_IFPUG_FUNCTION_POINTS and CRITICAL_VIOLATIONS
    2. format is the format in which the value has to be displayed, it uses the the format defined in numeral.js (see http://numeraljs.com/ for available Numbers formats)
    3. description is whatever is required

Note that:

  • ONLY five items will be shown in the tile itself, however, you can configure more than 5 items if you wish - the extra items will be displayed when you click the tile to drill down
  • Any items with a value of 0 in the tile itself will not be displayed when you click the tile to drill down

Example (for cmp.json)

            {
                "id": 1000,
                "plugin": "Notification",
                "color": "orange",
                "size":"large",
                "parameters": {
                    "title": "Applications Fast Facts",
                    "notifications":[
                        {"type":"analysisSince"},
                        {"type":"addedCount"},
                        {"type":"sizingMeasureEvolution", "threshold":0.01, "trend":"increase", "sizingMeasure":{"id": "CRITICAL_VIOLATIONS", "format": "0", "description":"critical violations"}},
                        {"type":"sizingMeasureEvolution", "threshold":0.05, "trend":"increase", "sizingMeasure":{"id": "LINES_OF_CODE", "format": "0", "description":"lines of code"}},
                        {"type":"qualityIndicatorEvolution", "threshold":0.02, "trend":"degradation", "qualityIndicator":{"id": "PERFORMANCE", "format": "0", "description":"performance"}}
                    ]
                }
            }

BackgroundFactsResults / BackgroundFactsResult

Note that:

  • when using this tile in the cmp.json file, please use BackgroundFactsResults
  • when using this tile in the app.json file, please use BackgroundFactsResult

A tile that enables you to display Background Facts that you have manually configured and uploaded during the snapshot generation. The tile can display information about one metric that you have defined in the uploaded Background Facts file.

  • backgroundFact: information about the indicator to display : its id, format and an optional description
    • id refers to the Background Fact numerical ID as displayed in the Assessment Model in the CAST Management Studio (in recent versions, the IDs with a "metric_group" value of 6):

    • format is the format in which the value has to be displayed, it uses the the format defined in numeral.js (see http://numeraljs.com/ for available Numbers formats)
    • description is whatever is required
  • url: the url field provides a simple means to link the drill down at detail level to some other web based information. Since the metrics comes from non-CAST sources, the external page containing information on the details of the metric, can be linked to here. If no url is provided, drill down cannot be achieved and a message will be displayed in tooltips on tile or charts whenever applicable:

  • zoom: true or false to enable zooming in detail charts. Default value is true. The zoom feature works best when you have multiple Applications consolidated into your CAST Application Analytics Dashboard - in this situation it can be difficult to read the score details of each column (a column represents one Application). You can therefore use the zoom option to select (using the mouse) the Applications you want to zoom into.
  • aggregation: (sum or average), tile will aggregate the application background fact values using sum or average - default value is sum. For example: if you have two Applications visible in the CAST Application Analytics Dashboard and have configured a Background Fact (a Cost of 400 for example) for only one of the Applications, results will be displayed as follows:
    • AVERAGE: A value of 200 will be displayed in the tile at Multi-application level (400 divided by 2) and in the tiles at Application level.
    • SUM: A value of 400 will be displayed in the tile at Multi-application level and at Application level, 400 will be displayed for the Application for which the Background Fact has been uploaded and 0 for the Application for which no Background Fact has been uploaded.

Example (for cmp.json)

        {
            "id": 66002,
            "plugin": "BackgroundFactsResults",
            "color": "green",
            "parameters": {
                "url":"http://www.castsoftware.com",
                "aggregation":"sum",
                "title": "Cost",
                "backgroundFact": {
                	"id": "66002",
                	"format": "0.0",
                	"description": "Total cost value"
                }
            }
         },

Example (for app.json)

				{
                    "id": 39,
                    "plugin": "BackgroundFactsResult",
                    "color": "black",
                    "parameters": {
                        "title": "Number of incidents",
                        "url":"http://www.castsoftware.com",
                        "aggregation":"sum",
                        "backgroundFact": {
                            "id": "66061",
                			"format": "0,000a",
                            "description":""
                         }
                     }
                }

Example Background Facts configuration

In this example, there are two Applications present in the CAST Application Analytics Dashboard. Background Facts have been configured and uploaded (see Background Facts and Business Value Metric upload for more information) for one of the Applications as shown below. The tile has been designed to show information about the Cost (66002) metric (see example plugin for cmp.json).

<?xml version="1.0" encoding="iso-8859-1" ?>
<DATA model="Central Model" version="1.0.0.17" scope="Productivity">

<!-- Module Definition -->
<DSS_IN_OBJECTS>
      <OBJECT_NAME>SEVRES full content</OBJECT_NAME>
      <OBJECT_TYPE_ID>20000</OBJECT_TYPE_ID>
      <OBJECT_ID>10</OBJECT_ID>
</DSS_IN_OBJECTS>

<!-- RESULTS : 66061 : Business Value for Module -->
<DSS_IN_METRIC_RESULTS>
    <METRIC_ID>66061</METRIC_ID>
    <METRIC_NUM_VALUE>4</METRIC_NUM_VALUE>
    <OBJECT_ID>10</OBJECT_ID>
</DSS_IN_METRIC_RESULTS>

<!-- RESULTS : 66001 : Effort for Module -->
<DSS_IN_METRIC_RESULTS>
    <METRIC_ID>66001</METRIC_ID>
    <METRIC_NUM_VALUE>10.5</METRIC_NUM_VALUE>
    <OBJECT_ID>10</OBJECT_ID>
</DSS_IN_METRIC_RESULTS>

<!-- RESULTS : 66002 : Cost for Module -->
<DSS_IN_METRIC_RESULTS>
    <METRIC_ID>66002</METRIC_ID>
    <METRIC_NUM_VALUE>400</METRIC_NUM_VALUE>
    <OBJECT_ID>10</OBJECT_ID>
</DSS_IN_METRIC_RESULTS>

</DATA>

BackgroundFactsEvolution

Note that this tile can be used at multi (cmp.json) and single (app.json) Application level.

A tile that enables you to display the evolution of Background Facts that you have manually configured and uploaded during the snapshot generation. The tile can display information about one metric that you have defined in the uploaded Background Facts file.

  1. backgroundFact: see the BackgroundFactsResult/BackgroundFactsResults tile above for more info.
  2. aggregation; see the BackgroundFactsResult/BackgroundFactsResults tile above for more info.
  3. widget: provides the rendering type (number for number variation, line or spline for trend chart representation: line uses with straight lines whereas spline provides smooth transitions between points)
  4. selectedApplicationCount defines the number of applications selected by default in the drill down at detail level page when the tile is defined at multi-application level (cmp.json).

Clicking the tile

When defined at multi-application level (cmp.json), clicking a tile will display the following Background Fact detail for the Applications in scope:

When defined at single application level (app.json), clicking a tile will by default display the evolution of TQI. If you need to view the details of the evolution of your Background Facts at single application level, you need to make some further configuration changes as follows:

  • Edit the following file with a text editor:
%CATALINA_HOME%\webapps\CAST-AAD\portal\resources\internal\app-navigation.json
  • Search for the "id": "evolution", section in the file and then add a new "group" containing the Background Facts you want to display in the drill down detail page at application level. For example, the following group contains all possible Background Facts:

{
"id": "backgroundFacts",
"description":"Background Facts",
"indicators": [
    {
    "description": "Effort",
    "id": "66001",
    "format":"0,000",
    "selected": true
    },
    {
    "description": "Cost",
    "id": "66002",
    "format":"0,000",
    "selected": false
    },
    {
    "description": "Enhancement Function Points",
    "id": "66003",
    "format":"0,000",
    "selected": false
    },
    {
    "description": "Delivery Feature Requests",
    "id": "66004",
    "format":"0,000",
    "selected": false
    },
    {
    "description": "Pending Feature Requests",
    "id": "66005",
    "format":"0,000",
    "selected": false
    },
    {
    "description": "Pending Fixes",
    "id": "66007",
    "format":"$0,000",
    "selected": false
    },
    {
    "description": "Business Value",
    "id": "66061",
    "format":"$0,000",
    "selected": false
    }
]
}
  • Save the file when you have added the Background Facts you require.
  • To view the changes, you may need to empty your browser cache as described at the beginning of this document. The screenshot below shows the evolution detail page for a BackgroundFactsEvolution tile at single application level with the list of Background Facts highlighted:

Example (for cmp.json or app.json):

 

{
                "id": 660011,
                "plugin": "BackgroundFactsEvolution",
                "color": "purple",
                "parameters": {
                    "widget":"number",
                    "aggregation":"average",
                    "title": "Effort",
                    "backgroundFact": {"id": "EFFORT","format": "0,000"}
                }
            },
            {
                "id": 660012,
                "plugin": "BackgroundFactsEvolution",
                "color": "purple",
                "parameters": {
                    "widget":"spline",
                    "aggregation":"sum",
                    "title": "Effort",
                    "backgroundFact": {"id": 66001,"format": "0,000"}
                }
            }

BackgroundFactAndQualityIndicatoryBySizingMeasureResults

Please note that by default this plugin (tile) does not appear in any default .json files. If you need to use it, it will only function at Multi-application level (cmp.json). An example of the tile is given below.

  1. qualityIndicator: information about the indicator to display (as x axis) : its id, format and an eventual description
    1. id is either: ARCHITECTURAL_DESIGNCHANGEABILITYDOCUMENTATIONPERFORMANCEPROGRAMMING_PRACTICEROBUSTNESS, SEI_MAINTAINABILITYSECURITYTQITRANSFERABILITY
    2. format is the format in which the value has to be displayed, it uses the the format defined in numeral.js (see http://numeraljs.com/ for available Numbers formats)
    3. description is whatever is required
  2. sizingMeasure: information about the indicator to display (as bubble size): its id, format and an eventual description
    1. id is either: TECHNICAL_DEBT, LINES_OF_CODE, NUMBER_OF_ARTIFACTS, NUMBER_OF_COMMENT_LINES, NUMBER_OF_DECISION_POINTS, NUMBER_OF_FILES, AUTOMATED_IFPUG_FUNCTION_POINTS_ESTIMATION, BACKFIRED_IFPUG_FUNCTION_POINTS and CRITICAL_VIOLATIONS
    2. format is the format in which the value has to be displayed, it uses the the format defined in numeral.js (see http://numeraljs.com/ for available Numbers formats)
    3. description is whatever is required
  3. backgroundFact:  information about the indicator to display (as y axis) : its id, format and an eventual description
    1. id is either: BUSINESS_VALUE, COST, DELIVERY_FEATURE_REQUESTS, EFFORT, ENHANCEMENT_FUNCTION_POINTS, PENDING_FEATURE_REQUESTS,  and PENDING_FIXES
    2. format is the format in which the value has to be displayed, it uses the the format defined in numeral.js (see http://numeraljs.com/ for available Numbers formats)
    3. description is whatever is required
  4. chartSettings: information about the displayed graph. It is described by the highcharts library (cf. http://api.highcharts.com/highcharts for available description)
    1. xAxis and yAxis refers to the chart axis
    2. plotLines: An array of lines streching across the plot area, marking a specific value on one of the axes:
      1. value: the position of the line in axis units.
      2. color: the color of the plot band.
      3. label: text labels for the plot bands
        1. align: horizontal alignment ("left", "center" or "right")
        2. text: The string text itself. A subset of HTML is supported.
        3. textAlign: The text alignment for the label determines how the text is aligned against its anchor point. Possible values are "left", "center" and "right". 
        4. verticalAlign: Vertical alignment of the label relative to the plot band. Can be one of "top", "middle" or "bottom". Defaults to top.
    3. plotBands: An array of colored bands stretching across the plot area marking an interval on the axis:
      1. from: the start position of the plot band in axis units.
      2. to: the end position of the plot band in axis units.
      3. color: the color of the plot band.
      4. label: text labels for the plot bands
        1. align: horizontal alignment ("left", "center" or "right")
        2. text: The string text itself. A subset of HTML is supported.
        3. textAlign: The text alignment for the label determines how the text is aligned against its anchor point. Possible values are "left", "center" and "right". 
        4. verticalAlign: Vertical alignment of the label relative to the plot band. Can be one of "top", "middle" or "bottom". Defaults to top.

Example:

			{
                "id": 10203,
                "plugin": "BackgroundFactAndQualityIndicatoryBySizingMeasureResults",
                "color": "purple",
                "parameters": {
                    "title": "Lines of Code - Effort",
                    "order": "descending",
                    "qualityIndicator": {"id": "TQI", "format": "0.00", "description": "TQI"},
                    "sizingMeasure": {"id": "LINES_OF_CODE", "format": "0,000a", "description": "Lines of Code"},
                    "backgroundFact": {"id": "EFFORT", "format": "0.00", "description": "Effort"},
                    "chartSettings": {
                        "xAxis": {
                            "plotLines": [
                                { "value": 3, "label":{"text":"TQI=3"} }
                            ]
                        },
                        "yAxis": {
                            "plotLines": [
                                { "value": 3.0, "label":{"text":"Risk=3"} }
                            ]
                        }
                    }
                }
            }

CriticalQualityRulesRatios / CriticalQualityRuleRatio

Note that:

  • when using this tile in the cmp.json file, please use CriticalQualityRulesRatios
  • when using this tile in the app.json file, please use CriticalQualityRuleRatio

This tile shows the top 5 critical rules at Application or multi-Application level, together with:

  • Checked column: the number of times the rule has been checked - i.e. the number of objects checked by the Quality Rule
  • Failed (%) or Failed (#) column: the percentage or number of checks that have failed - i.e. percentage or number of objects checked by the Quality Rule that violate the Quality Rule

Configuration:

  1. type: Describe the type of notifications - set to topRules
  2. count: the number of lines displayed. 5 is the optimized size for the height of the tile
  3. order: the ordering of the Quality Rules represented in the tile. This can be descending or ascending, and is based on the number of failed checks
  4. format: the format of the compliance value: it uses the the format defined in numeral.js  (see http://numeraljs.com/ for available Numbers formats)
  5. mode: two options are possible:

    1. "ratio": a Failed (%) column will display a percentage of the checks that have failed - i.e. percentage of objects checked by the Quality Rule that violate the Quality Rule.
    2. "number": a Failed (#) column will display the number of the checks that have failed - i.e. the number of objects checked by the Quality Rule that violate the Quality Rule.
  6. loadLimit: Compared to other tiles, this tile tends to involve large amount of data when the application scope increases, hence can quickly prove to be performance inefficient; the loadLimit option defines a limit for the number of applications: when there are less Applications than the loadLimit value, then the contents of the tile will be loaded. When there are more Applications than the loadLimit value, then the contents of the tile will not be loaded and a message will state this.

Example (for cmp.json):

            {
                "id": 14,
                "plugin": "CriticalQualityRulesRatios",
                "size":"large",
                "color": "grey-dark",
                "parameters": {
                    "loadLimit": 60,
                    "title": "Top 5 critical rules",
                    "count": 5,
                    "order": "descending",
                    "format": "0,000",
                    "mode": "ratio"
                }
            }

Example (for app.json):

                {
                    "id": 107,
                    "plugin": "CriticalQualityRuleRatio",
                    "color": "grey-dark",
                    "size":"large",
                    "parameters": {
                        "type":"topRules",
                        "title": "Top Critical Rules",
                        "count": 5,
                        "format":"0,000",
                        "order": "descending",
                        "mode": "ratio"
                    }
                }

CriticalViolationsPerHealthFactor


The critical violations per health factor module provides a critical violations count for a given business criterion:

  1. count: the number of lines displayed. 5 is the optimized size for the height of the tile. This parameter is only taken into account for topRiskiest tile types. 
  2. order: the ordering of the data represented in the tile. This can be descending or ascending, and is based on the sizing measure
  3. qualityIndicator: this is identical to the indicator of the singleQualityIndicator tile :
    1. id is either:ARCHITECTURAL_DESIGNCHANGEABILITYDOCUMENTATIONPERFORMANCEPROGRAMMING_PRACTICEROBUSTNESS, SEI_MAINTAINABILITYSECURITYTQITRANSFERABILITY
    2. description is whatever is required
    3. format is the format in which the value has to be displayed, it uses the the format defined in numeral.js (see http://numeraljs.com/ for available Numbers formats)

Example (for cmp.json)

			{
                "id": 10,
                "plugin": "CriticalViolationsPerHealthFactor",
                "color": "green",
                "size":"large",
                "parameters": {
                    "type":"topRiskiest",
                    "title": "Top 5 riskiest Applications",
                    "count": 5,
                    "order": "descending",
                    "qualityIndicator": {"id": "PERFORMANCE", "format": "0.00", "description": "Performance"},
                    "sizingMeasure": {"id": "CRITICAL_VIOLATIONS", "format": "0,000a", "description": "Critical Violations"}
                }
            },

Example (for app.json)

                {
                    "id": 106,
                    "plugin": "CriticalViolationsPerHealthFactor",
                    "color": "green",
                    "size":"large",
                    "parameters": {
                        "type":"topRiskiest",
                        "title": "Top riskiest modules",
                        "count": 5,
                        "order": "descending",
                        "qualityIndicator": {"id": "PERFORMANCE", "format": "0.00", "description": "Performance"}
                    }
                }

FunctionalWeightMeasureResult / FunctionalWeightMeasureResults

Note that:

  • when using this tile in the cmp.json file, please use FunctionalWeightMeasureResults
  • when using this tile in the app.json file, please use FunctionalWeightMeasureResult

This tile displays the sum of the number of Automated Function Points for all Applications in the scope. The only configurable items for this tile are the title, the format of the figure and description, and the colors for the detail treemap (when drilling down).

Example (for cmp.json):

{
	"id": 10201,
	"plugin": "FunctionalWeightMeasureResults",
	"color": "blue",
	"parameters": {
		"title": "Functional Size",
		"functionalWeightMeasure": {
			"format": "0,000",
			"description":"OMG-Compliant Automated FPs"
		}
	}
}
Note that when drilling down, a table is displayed listing the applications.

Example (for app.json):

{
	"id": 1999,
	"plugin": "FunctionalWeightMeasureResult",
	"color": "blue",
	"parameters": {
		"title": "Functional Size",
		"functionalWeightMeasure": {
			"id": "AUTOMATED_IFPUG_FUNCTION_POINTS_ESTIMATION",
			"format": "0,000",
			"description": "OMG-Compliant Automated FPs"
		}
	}
}

Note that when drilling down, a table lists all those Applications that are not included in the AFP measure (essentially all those Applications not using a CAST EFP license:

QualityIndicatorBySizingMeasureResult / QualityIndicatorBySizingMeasureResults

Note that:

  • when using this tile in the cmp.json file, please use QualityIndicatorBySizingMeasureResults
  • when using this tile in the app.json file, please use QualityIndicatorBySizingMeasureResult

  1. type: topRiskiest for a table representation of the top N riskiest with regard to quality and sizing indicators/ treemap for a global view of the selected applications.
  2. count: the number of lines displayed. 5 is the optimized size for the height of the tile. This parameter is only taken into account for topRiskiest tile types. 
  3. order: the ordering of the data represented in the tile. This can be descending or ascending, and is based on the sizing measure
  4. qualityIndicator: this is identical to the indicator in the singleQualityIndicator tile:
    1. id is either: ARCHITECTURAL_DESIGN, CHANGEABILITY, DOCUMENTATION, PERFORMANCE, PROGRAMMING_PRACTICE, ROBUSTNESS, SEI_MAINTAINABILITY, SECURITY, TQI, TRANSFERABILITY
    2. description is whatever is required
    3. format is the format in which the value has to be displayed, it uses the the format defined in numeral.js (see http://numeraljs.com/ for available Numbers formats)
  5. sizingMeasure: this is identical of the indicator of the size and criticalViolations tiles :
    1. id is either:TECHNICAL_DEBT, LINES_OF_CODE, NUMBER_OF_ARTIFACTS, NUMBER_OF_COMMENT_LINES, NUMBER_OF_DECISION_POINTS, NUMBER_OF_FILES, NUMBER_OF_FUNCTION_POINTS, NUMBER_OF_BACKFIRED_FUNCTION_POINTS and CRITICAL_VIOLATIONS.
    2. description is whatever is required
    3. format is the format in which the value has to be displayed, it uses the the format defined in numeral.js (see http://numeraljs.com/ for available Numbers formats)
  6. treemapColors: defines the colours displayed in the tile (for example for TQI qualityIndicator)
    1. "ranges":[1,2,3,4] defines the number of colour ranges
    2. "colors":["#ff3600","#ff0242","#fbbb6e","#3dc680"] defines the colour for each range (must have the same number of colours as ranges)

sizingMeasure

Note that at multi Application level (i.e. configuration in the cmp.json file), the following are also available for use with the sizingMeasure item: AUTOMATED_IFPUG_FUNCTION_POINTS_ESTIMATION, UNADJUSTED_DATA_FUNCTION_POINTS, UNADJUSTED_TRANSACTIONAL_FUNCTION_POINTS, ADDED_FUNCTION_POINTS, ADDED_DATA_FUNCTION_POINTS, ADDED_TRANSACTIONAL_FUNCTION_POINTS, MODIFIED_FUNCTION_POINTS, MODIFIED_DATA_FUNCTION_POINTS, MODIFIED_TRANSACTIONAL_FUNCTION_POINTS, DELETED_FUNCTION_POINTS, DELETED_DATA_FUNCTION_POINTS, DELETED_TRANSACTIONAL_FUNCTION_POINTS, UNCHANGED_FUNCTION_POINTS, UNCHANGED_DATA_FUNCTION_POINTS, UNCHANGED_TRANSACTIONAL_FUNCTION_POINTS

Be extra careful with these metrics as they have values only if you have the EFP license key, and if all Applications do not have function points, the tile can exhibit display issues (squares can be very small in an empty space). The tile will only display Applications that have results for configured indicators.

Example (for cmp.json)

            {
                "id": 3,
                "plugin": "QualityIndicatorBySizingMeasureResults",
                "size":"large",
                "color": "purple",
                "parameters": {
                    "type":"treemap",
                    "title": "Applications Map",
                    "order": "descending",
                    "qualityIndicator": {"id": "TQI", "format": "0.00", "tooltipFormat":"0.00", "description": "Total Quality Index"},
                    "sizingMeasure": {"id": "LINES_OF_CODE", "format": "0,000.0a", "tooltipFormat":"'0,000", "description": "Lines of Code"},
                    "treemapColors": {
                        "ranges":[1,2,3,4],
                        "colors":["#ff3600","#ff0242","#fbbb6e","#3dc680"]
                    }
                }
            },

Example (for app.json)

                {
                    "id": 101,
                    "plugin": "QualityIndicatorBySizingMeasureResult",
                    "size":"large",
                    "color": "purple",
                    "parameters": {
                        "type":"treemap",
                        "title": "Security Mapping",
                        "order": "descending",
                        "qualityIndicator": {"id": "SECURITY", "format": "0.00", "tooltipFormat":"0.00", "description": "Security"},
                        "sizingMeasure": {"id": "LINES_OF_CODE", "format": "0,000.0a", "tooltipFormat":"'0,000", "description": "Lines of Code"},
                        "treemapColors": {
                            "ranges":[1,2,3,4],
                            "colors":["#ff0242","#FF5B2B","#fbbb6e","#3dc680"]
                        }
                    }
                },

QualityIndicatorResult / QualityIndicatorResults

Note that:

  • when using this tile in the cmp.json file, please use QualityIndicatorResults
  • when using this tile in the app.json file, please use QualityIndicatorResult

  1. qualityIndicator: information about the indicator to display : its id, format and an optional description
    1. id is either: ARCHITECTURAL_DESIGN, CHANGEABILITY, DOCUMENTATION, PERFORMANCE, PROGRAMMING_PRACTICE, ROBUSTNESS, SEI_MAINTAINABILITY, SECURITY, TQI, TRANSFERABILITY
    2. format is the format in which the value has to be displayed, it uses the the format defined in numeral.js (see http://numeraljs.com/ for available Numbers formats)
    3. technicalId is the ID of the Technical Criteria you want to display, for example "61003" would display "Programming Practices - OO Inheritance and Polymorphism" in the tile. Functions at Portfolio and Application level.
    4. description is whatever is required
  2. details provide parameters dedicated towards drill down page views
    1. ranges: range used to separate indicator groups displayed in detail view. Default is [2,3] to produce : [indicator < 2, 2 <= indicator < 3, 3<= indicator]
    2. colorsfrom hex code color to hex code color. from provides the grade 1 white to provide the grade 4 color values. Default values are #CE2029 for grade 1 and #28AC1B for grade 4. The choice of a gradient or plain colors can be made through the useGradient parameter. Default value is false.
  3. widget provides graphical representations of the indicator (e.g. gaugedonut, riskGauge)
    1. If widget is set to riskGauge, then the gauge will display color based on the indicator score with regard to riskGauge configuration (thresholds and colors). The tile color theme is restricted to grey-light and grey-dark when using this widget. Default color is grey-dark.
    2. riskGauge: can be set globally in the top level QualityIndicatorResults global configuration and can be overridden in the tile parameters. Parameters are used if the widget parameter is set to riskGauge
      1. thresholds: define the thresholds used to qualify the score risk; default values are: [2, 3, 3.99] meaning high-risk:1 to 2, risk:2 to 3, low risk:3 to 3.99, and very low risk over
      2. colors: define the colors using hexidecimal color numbers according to the number of thresholds (remember that 3 thresholds means 4 areas, hence 4 colors are required)
  4. icon: boolean to display (true) an icon next to the tile title, false by default.
  5. zoom: true or false to enable zooming in detail charts. Default value is true. The zoom feature works best when you have multiple Applications consolidated into your CAST Application Analytics Dashboard - in this situation it can be difficult to read the score details of each column (a column represents one Application). You can therefore use the zoom option to select (using the mouse) the Applications you want to zoom into.

Parameters are available panel per panel. Some general parameters can be set on the top most level of the json structure through the "QualityIndicatorResults" field. The parameters set there involve the details fields such as rangescolor or riskGauge.

Example (for cmp.json)

{
    "id": 211,
    "plugin": "QualityIndicatorResults",
    "color": "grey-dark",
    "parameters": {
    "title": "Programming Practices - OO Inheritance and Polymorphism",
    "widget": "gauge",
    "qualityIndicator": {
        "id": "ROBUSTNESS",
        "technicalId": "61003",
        "format": "0.00",
        "description": ""
    }
    }
},

Example (for app.json)

{
    "id": 104,
    "plugin": "QualityIndicatorResult",
    "color": "yellow",
    "parameters": {
    "title": "Robustness",
    "widget": "gauge",
    "qualityIndicator": {
        "id": "ROBUSTNESS",
        "format": "0.00"
    }
    }
},

Example for a riskGuage at top level in app.json or cmp.json

"QualityIndicatorResults" :
{
"ranges":[1.6,2.8,3.0,3.4],
"riskGauge":
	{
	"colors":["#02eff4", "#ff4b02", "#02eff4", "#7fc4b2"]
	}
},

QualityIndicatorEvolution

  1. qualityIndicator: information about the indicator to display: its id, format and an optional description
    1. id is either: ARCHITECTURAL_DESIGN, CHANGEABILITY, DOCUMENTATION, PERFORMANCE, PROGRAMMING_PRACTICE, ROBUSTNESS, SEI_MAINTAINABILITY, SECURITY, TQI, TRANSFERABILITY
    2. description is whatever is required
    3. format is the format in which the value has to be displayed, it uses the the format defined in numeral.js (see http://numeraljs.com/ for available Numbers formats)
    4. widget provides the rendering type (number for number variation, line or spline for trend chart representation - line uses straight lines whereas spline provides smooth transitions between points)

Example (for cmp.json)

            {
                "id": 103,
                "plugin": "QualityIndicatorEvolution",
                "color": "green",
                "parameters": {
                    "widget":"spline",
                    "title": "Security",
                    "qualityIndicator": {
						"id": "SECURITY",
						"format": "0.00"
					}
                }
            },

Example (for app.json)

                {
                    "id": 201,
                    "plugin": "QualityIndicatorEvolution",
                    "color": "blue",
                    "parameters": {
                        "widget":"number",
                        "title": "TQI",
                        "qualityIndicator": {
							"id": "TQI",
							"format": "0.00"
						}
                    }
                },

SizingMeasureEvolution

  1. sizingMeasure: information about the indicator to display : its id, format and an optional description
    1. id is either: TECHNICAL_DEBT, LINES_OF_CODE, NUMBER_OF_ARTIFACTS, NUMBER_OF_COMMENT_LINES, NUMBER_OF_DECISION_POINTS, NUMBER_OF_FILES, NUMBER_OF_FUNCTION_POINTS, NUMBER_OF_BACKFIRED_FUNCTION_POINTS and CRITICAL_VIOLATIONS
    2. description is whatever is required
    3. format is the format in which the value has to be displayed, it uses the the format defined in numeral.js (see http://numeraljs.com/ for available Numbers formats)
    4. widget provides the rendering type (number for number variation, line or spline for trend chart representation - line uses straight lines whereas spline provides smooth transitions between points)

Example (for cmp.json)

            {
                "id": 100,
                "plugin": "SizingMeasureEvolution",
                "color": "grey-dark",
                "parameters": {
                    "title": "Technical Debt",
                    "sizingMeasure": {"id": "TECHNICAL_DEBT", "format": "$0,000.0a"}
                }
            },

Example (for app.json)

                {
                    "id": 202,
                    "plugin": "SizingMeasureEvolution",
                    "color": "orange",
                    "parameters": {
                        "widget":"number",
                        "title": "Technical Debt",
                        "sizingMeasure": {"id": "TECHNICAL_DEBT", "format": "$0,000.0a"}
                    }
                },

SizingMeasureResult / SizingMeasureResults

Note that:

  • when using this tile in the cmp.json file, please use SizingMeasureResults
  • when using this tile in the app.json file, please use SizingMeasureResult

  1. sizingMeasure: information about the indicator to display : its id, format and an optional description
    1. id is either: TECHNICAL_DEBT, LINES_OF_CODE, NUMBER_OF_ARTIFACTS, NUMBER_OF_COMMENT_LINES, NUMBER_OF_DECISION_POINTS, NUMBER_OF_FILES, NUMBER_OF_FUNCTION_POINTS, NUMBER_OF_BACKFIRED_FUNCTION_POINTS and CRITICAL_VIOLATIONS
    2. description is whatever is required
    3. format is the format in which the value has to be displayed, it uses the the format defined in numeral.js (see http://numeraljs.com/ for available Numbers formats)
  2. zoom: true or false to enable zooming in detail charts. Default value is true. The zoom feature works best when you have multiple Applications consolidated into your CAST Application Analytics Dashboard - in this situation it can be difficult to read the score details of each column (a column represents one Application). You can therefore use the zoom option to select (using the mouse) the Applications you want to zoom into.

Example (for cmp.json)

            {
                "id": 12,
                "plugin": "SizingMeasureResults",
                "color": "orange",
                "parameters": {
                    "title": "Critical violations",
                    "mode":"terse",
                    "sizingMeasure": {"id": "CRITICAL_VIOLATIONS", "format": "0,000"}
                }
            },

Example (for app.json)

                {
                    "id": 102,
                    "plugin": "SizingMeasureResult",
                    "color": "green",
                    "parameters": {
                        "title": "Size",
                        "sizingMeasure": {
                            "id": "LINES_OF_CODE",
                            "format": "0,000",
                            "description": "Lines of Code"
                        }
                    }
                },

This tile (not available by default) provides the ability to define external URLs (e.g. to other data dashboards) in a tile:

  • color: tile color
  • parameters:
    • title the short message to display in tile
    • url the hyperlink to follow

Example (for cmp.json and app.json)

{
    "id": 100,
    "plugin": "ExternalLink",
    "color": "red",
    "parameters": {
        "title": "Tackle your Technical Debt",
        "url":"http://www.castsoftware.com"
    }
},

Custom expression tiles

At portfolio (cmp.json) and application level (app.json), it is possible to define tiles with custom expressions. A custom expression is defined through a mathematical subset representation involving operations on criteria values (e.g. the ratio of number of lines of codes per critical violations or the count of applications with more than n files).

The tile can represent averaged values (excluding the application not having one of the values such as a background fact or some sizing measure, or those whose function calculation result is infinite) or a total value. For comparison, business criteria scores are average while sizing is usually a total on the portfolio. 

Custom expression tiles can be defined for the current snapshot state (most recent snapshot for all applications at portfolio level or selected snapshots at application level), or via evolutions. 

The mathematical formula available involve the following expression patterns:

Operators

Operator
Name
Syntax
Associativity
Example
Result
()
Parentheses
(x)
None
2 * (3 + 4)
14
,
Parameter separator
x, y
Left to right
max(2, 1, 5)
5
+
Add
x + y
Left to right
4 + 5
9
-
Subtract
x - y
Left to right
7 - 3
4
*
Multiply
x * y
Left to right
2 * 3
6
/
Divide
x / y
Left to right
6 / 2
3
%mod
Modulus
x % y
Left to right
8 % 3
2
^
Power
x ^ y
Right to left
2 ^ 3
8
!
Factorial
y!
Left to right
5!
120
? :
Conditional expression
x ? y : z
Right to left
15 > 100 ? 1 : -1
-1

Functions

Function
Name
Syntax
Associativity
Example
Result
abs
Absolute
abs(x)
None
abs(-2)
2
round
Round
round(x,n)
None
round(3.142265,3)
3.142
sqrt
Square root
sqrt(x)
None
sqrt(4)
2
log
Logarithmic
log(x,base)
None
log(1024,2)
log(1024)
10
3.01
 
Other classic patterns are available but may not be supported by the CAST Application Analytics Dashboard in terms of rendering (i.e. those returning non numerical values such as booleans).

CustomExpressionsEvolution

The custom expression tile enables operations on various multiple indicators in a single tile through snapshots. Lots of different operations can be performed on the tile, from scaling to combinations using mathematical formula (as listed above). As it could involve multiple results and extra operations to get the results, the CustomExpressionsEvolution tiles could hinder the performances of the dashboard at some point (depending on number of tiles, number of variables, number of snapshots).

Standard parameters

  • title please note that exceptionally, the title is used to identify different types of custom expression tiles, from result to evolution, portfolio to application level. if you want to avoid duplicates at application level detail, please make sure tiles with the same formula have the same title field.
  • description
  • format

Tile specific parameters

  1. documentation a documentation information to explain about the custom indicator. The field value is a string (that can include html tags) that will be displayed on page details at portfolio level.
  2. aggregator the aggregation type: "average" or "sum", default to average.
  3. expression the mathematical operation to perform for each application (some examples: "sqrt((tqi-1)/3)", "tqi/loc", "log(x)*y^2", etc.)
  4. variables each variable defined in the mathematical operation has to be defined for results to be caclulated. The variable name is defined through its key and have a type and an id. (some examples: "variables":{"tqi":{"type":"qualityIndicator", "id":"TQI"},"loc":{"type":"sizingMeasure", "id":"LINES_OF_CODE"},"effort":{"type":"backgroundFact", "id":"EFFORT"}}

CustomExpression/CustomExpressions

The custom expression tile enables operations on various multiple indicators in a single tile. Lots of different operations can be performed on the tile, from scaling to combinations using mathematical formula (as listed above).

Standard parameters

  1. title please note that exceptionally, the title is used to identify different types of custom expression tiles, from result to evolution, portfolio to application level. if you want to avoid duplicates at application level detail, please make sure tiles with the same formula have the same title field.
  2. description
  3. format

Tile specific parameters

  1. documentation a documentation information to explain about the custom indicator. The field value is a string (that can include html tags) that will be displayed on page details at portfolio level.
  2. aggregator the aggregation type: "average" (default), "sum", or (from CAST AIP 8.2.2 onwards) "AvgSum" (see below)
  3. expression the mathematical operation to perform for each application (some examples: "sqrt((tqi-1)/3)", "tqi/loc", "log(x)*y^2", etc.)
  4. variables each variable defined in the mathematical operation has to be defined for results to be caclulated. The variable name is defined through its key and have a type and an id. (some examples: "variables":{"tqi":{"type":"qualityIndicator", "id":"TQI"},"loc":{"type":"sizingMeasure", "id":"LINES_OF_CODE"},"effort":{"type":"backgroundFact", "id":"EFFORT"}}

Notes about the aggregator type "AvgSum" (available from CAST AIP 8.2.2 onwards)

When using this aggregator type, a new property "aggregator" can also be provided for each key under "variables" to specify the aggregation type as "sum" or "average" for each variable respectively. The default is set to "sum" when "AvgSum" is defined under "aggregator". For example the following lines under "variables" would take both factors produce a sum and then divide them. As such it is now possible to specify the addition of all the violations first, then add up all the function points, THEN do the division (the SUM(Violations) / SUM(Function points) ):

{
    "id":987654321529,
    "plugin": "CustomExpressions",
    "color": "green",
    "parameters": {
    "title": "TQI - Critical violations ratio",
    "aggregator": "AvgSum",
    "description":"",
    "format":"0.00",
    "expression":"crit / tqi",
    "variables":{
        "tqi": {"type":"qualityIndicator", "id":"TQI", "aggregator": "sum"},
        "crit":{"type":"sizingMeasure", "id":"CRITICAL_VIOLATIONS", "aggregator": "sum"}
    }
    }
},

Example (for cmp.json) - CustomExpressions

{
    "id": 987654321529,
    "plugin": "CustomExpressions",
    "color": "blue",
    "parameters": {
    "title": "TQI - Critical violations ratio",
    "description":"",
    "format":"0.00",
    "expression":"crit / tqi",
    "variables":{
        "tqi": {"type":"qualityIndicator", "id":"TQI"},
        "crit":{"type":"sizingMeasure", "id":"CRITICAL_VIOLATIONS"}
    }
    }
},

Example (for app.json) - CustomExpression

{
    "id": 987654321529,
    "plugin": "CustomExpression",
    "color": "blue",
    "parameters": {
    "title": "TQI - Critical violations ratio",
    "description":"",
    "format":"0.00",
    "expression":"crit / tqi",
    "variables":{
        "tqi": {"type":"qualityIndicator", "id":"TQI"},
        "crit":{"type":"sizingMeasure", "id":"CRITICAL_VIOLATIONS"}
    }
    }
},
  • No labels