Page tree

Versions Compared

Key

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

...

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

...

No Format
            {
                "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"
                }
            },

...

Technical Size Measures

Info
Only available in app.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):

No Format
.

Technical Size Measures govern the configurable display of Technical Size indicators (Number of Critical Violations, Number of Code Lines, Number of Files etc.) for the drill down page available at Application level for the Technical Size tile (click to enlarge):

Image Added

Each of these indicators can be configured via the app.json file under the TechnicalSizeMeasures section:

No Format
"TechnicalSizeMeasures": {
    "titlevalues": "Application Analytics Dashboard",[
      {
  "language": "dev",     "horizontalScrollid": false67011,
      "confirmLogout": true, 	"persistNavigationFilterslabel":true, 	"filtering":{Number of Critical Violations"
   "filterTags":false     },
    "period":  {
        "shiftid": true10151,
        "periodslabel": [ "Number of Lines of Code"
      },
      {
"diff": 30, "units": "days" },    "id": 10154,
       { "difflabel": 3, "units": "months""Number of Files"
      },
      {
     { "diff": 6, "unitsid": "months" }10155,
        "label": "Number of Classes"
{ "diff": 12, "units": "months", "selected": true },
      {
     { "diff": 2, "unitsid": "years" }10156,
            { "diff"label": 0, "units": "alltime"Number of Programs"
}         ]
    }

Tile parameters

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

...

Parameter

...

Description

...

  • blue
  • black
  • dark grey
  • orange
  • green
  • purple
  • light grey
  • yellow

...

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

Image Removed

...

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.

...

},
.....

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):

No Format
    "title": "Application Analytics Dashboard",
    "language": "dev",
    "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):

Image Added

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.

Technical Size Measures parameters

Info
Only available in app.json.

Technical Size Measures govern the configurable display of Technical Size indicators (Number of Critical Violations, Number of Code Lines, Number of Files etc.) for the drill down page available at Application level for the Technical Size tile (click to enlarge):

Image Added

Each of these indicators can be configured via the app.json file under the TechnicalSizeMeasures section:

Parameter
Description
idRepresents the ID of the Technical Size indicator as defined in the CAST Assessment Model.
label

A text field used to display the name of the Technical Size indicator in the drill down page (click to enlarge):

Image Added

for example:

No Format
"TechnicalSizeMeasures": {
    "values": [
      {
        "id": 67011,
        "label": "Number of Critical Violations"
      },
      {
        "id": 10151,
        "label": "Number of Lines of Code"
      },
      {
        "id": 10154,
        "label": "Number of Files"
      },
      {
        "id": 10155,
        "label": "Number of Classes"
      },
      {
        "id": 10156,
        "label": "Number of Programs"
      },
.....

Plugin parameters

A plugin also has various different parameters as follows:

...

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:

...

Functions

...

 

...

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).

...