Page tree

Versions Compared

Key

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

...

Info
Summary: This page explains how to configure the Health Dashboard tile interface

Introduction

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

Image RemovedImage Added

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

...

The default tile presentation is defined in the following files:files listed below. 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
File nameUsage

WAR 1.x

  • CATALINA_HOME\webapps\CAST-Health\portal\resources\cmp.json

WAR ≥ 2.x

  • CATALINA_HOME\webapps\CAST-Health\WEB-INF\classes\config\hd\cmp.json

ZIP ≥ 2.x

  • <unpacked_zip>\configurations\config\hd\cmp.json
This file governs the display of tiles when your Measurement Service contains multiple Applications - i.e the Multi-application landing page. For more information about the Multi-application and Application landing pages, see Health Dashboard - GUI.

WAR 1.x

  • CATALINA_HOME\webapps\CAST-Health\portal\resources\app.json

WAR ≥ 2.x

  • CATALINA_HOME\webapps\CAST-Health\WEB-INF\classes\config\hd\app.json

ZIP ≥ 2.x

  • <unpacked_zip>\configurations\config\hd\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 Health Dashboard - GUI.

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

...


Info

Starting from ≥ 1.27 and ≥ 2.1, two additional json files have been added that are used to display tiles for the ISO-5055 view that uses data generated by the ISO-5055 Index extension:

WAR 1.x

  • CATALINA_HOME\webapps\CAST-Health\portal\resources\app-ISO.json
  • CATALINA_HOME\webapps\CAST-Health\portal\resources\cmp-ISO.json

WAR ≥ 2.x

  • CATALINA_HOME\webapps\CAST-Health\WEB-INF\classes\config\hd\app-ISO.json
  • CATALINA_HOME\webapps\CAST-Health\WEB-INF\classes\config\hd\cmp-ISO.json

ZIP ≥ 2.x

  • <unpacked_zip>\configurations\config\hd\app-ISO.json
  • <unpacked_zip>\configurations\config\hd\cmp-ISO.json

See Manual configuration of Dashboard tiles using ISO-5055 data for more information.

Image Added

Library files

CAST provides "library" files containing examples of all the tiles that can be created and used in the Health 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 here:

WAR 1.x

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

WAR ≥ 2.x

  • CATALINA_HOME\webapps\CAST-Health\static\portal\resources\cmp_tiles_library.json
  • CATALINA_HOME\webapps\CAST-Health\static\portal\resources\app_tiles_library.json

ZIP ≥ 2.x - The file is located in a compiled JAR file located at the root of the unpacked ZIP. This JAR file will need to be unpacked to find the .json files:

  • <unpacked_jar>\BOOT-INF\classes\static\portal\resources\cmp_tiles_library.json

  • <unpacked_jar>\BOOT-INF\classes\static\portal\resources\cmp_tiles_library.json

Viewing the changes in your browser

...

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 Health Dashboard in terms of rendering (i.e. those returning non numerical values such as booleans).

...