Created by James Hurrell, last modified on Mar 11, 2021

Summary: This page explains how to modify default text in the dashboards.

Introduction

The CAST dashboards use a .json file to define the default text that is used within the dashboards. For example:

Click to enlarge:

The above text is defined in the .json file:

"Total Quality index": "Total Quality index",
"Total Quality index measures the global quality level of the application based on all existing technical criteria that are based on our 5 health factors. Sometimes quality rules are linked to multiple technical criteria so that sum of critical violations of TQI is not the same than the sum of critical violations for all health factor.": "Total Quality index measures the global quality level of the application based on all existing technical criteria that are based on our 5 health factors. Sometimes quality rules are linked to multiple technical criteria so that sum of critical violations of TQI is not the same than the sum of critical violations for all health factor.",

Modifying the default text

Locate the .json files

The .json files used to define the dashboard texts are located as follows. Use a text editor to edit the files:

WAR 1.x
Health Dashboard: portal\locales\<locale>\translation.json
Engineering Dashboard: engineering\locales\<locale>\translation.json
 
WAR ≥ 2.x
Health Dashboard: static\portal\locales\<locale>\translation.json
Engineering Dashboard: static\engineering\locales\<locale>\translation.json
 
ZIP ≥ 2.x - The files are 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 files and repacked when the locales files have been populated
Health Dashboard: <unpacked_jar>\BOOT-INF\classes\static\portal\locales\<locale>\translation.json
Engineering Dashboard: <unpacked_jar>\BOOT-INF\classes\static\engineering\locales\<locale>\translation.json

Editing the text

Text is defined with a key:value pair, for example:

"Total Quality index": "Total Quality index",

To edit text, change the value, not the initial key:

"Total Quality index": "Total Quality Index for company",

Removing text

To remove text, delete the value leaving behind space separated quote marks:

"Total Quality index": " ",

Viewing the changes

To view your changes:

  • Restart the web application server
  • Clear your browser cache
  • Reload the dashboard