Page tree

Versions Compared

Key

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

...

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 Health Dashboard.

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

...

Global parameters

Please see CAST-AAD HD - 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):

...

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, LINES_OF_CODE, PERFORMANCE, PROGRAMMING_PRACTICE, ROBUSTNESS, SEI_MAINTAINABILITY, SECURITY, TQI, TRANSFERABILITY
  • it is possible to use the ID of any CAST AIP metric in place of the worded indicator IDs listed above. For example the LINES_OF_CODE indicator can be replaced with 10151 (the equivalent ID).
  • 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 AADHealth Dashboard.

PortfolioListing

Info

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

...

  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. id can also be a numerical ID corresponding to any CAST AIP metric
    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. 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.
    5. 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 or riskGauge)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
    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.
  4. icon: boolean to display (true) an icon next to the tile title, false by default.
    1. .
    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)
  5. icon: boolean to display (true) an icon next to the tile title, false by default.
  6. 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.
Info

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.

...

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

...