Summary: This page explains how to configure the Health Dashboard tile interface |
The Health 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:
The default tile presentation is defined in the files listed below. To modify the presentation, edit the .json file with a text editor (Notepad or other similar application). CAST recommends:
File name | Usage |
---|---|
WAR 1.x
WAR ≥ 2.x
ZIP ≥ 2.x
| 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
WAR ≥ 2.x
ZIP ≥ 2.x
| This file governs the display of tiles for a single Application - i.e the Application landing page. This page is displayed in two situations:
For more information about the Multi-application and Application landing pages, see Health Dashboard - GUI. |
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
WAR ≥ 2.x
ZIP ≥ 2.x
See Manual configuration of Dashboard tiles using ISO-5055 data for more information. |
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
WAR ≥ 2.x
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
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 Health 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:
Tiles are displayed in the Health 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.
The .json file is divided into various different sections, each corresponding to an item, area or tile in the Health Dashboard:
There are three areas, each corresponding to the Overview, Trends and Automated Enhancement Point (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": "Trends", |
and:
"id": 2, "title": "Automated Enhancement Point", |
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" } }, |
Please see Health Dashboard json configuration options 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": "Health 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" } ] } |
A tile or panel represents the equivalent of a "plugin". Each tile is composed of the following properties:
Parameter | Description |
---|---|
id | Represents the tile's unique id. This is a technical id used to identify the panels and MUST be unique throughout the .json file. |
plugin | Represents the type of indicators to be displayed in the tile. The plugins that are available are listed below under Plugin parameters. |
color | Optional 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:
|
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. |
Only available in app.json and only valid for ≤ 1.21 releases. This configuration has been removed in more recent releases. |
Technical Size Measures govern the configurable display of 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):
The list of indicators can be configured via the app.json file under the TechnicalSizeMeasures section:
Parameter | Description |
---|---|
id | Represents 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): |
In this example we have added two additional indicators for Technical Debt of Added Violations (68901) and Technical Debt of Removed Violations (68902):
"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" }, { "id": 10157, "label": "Number of Forms" }, { "id": 10158, "label": "Number of SQL Artifacts" }, { "id": 10163, "label": "Number of Tables" }, { "id": 10152, "label": "Number of Artifacts" }, { "id": 10107, "label": "Number of Comment Lines" }, { "id": 10109, "label": "Number of Commented Out Code Lines" }, { "id": 67901, "label": "Number of Critical Violations Added" }, { "id": 67902, "label": "Number of Critical Violations Removed" }, { "id": 67216, "label": "Number of Pending Violations" }, { "id": 67217, "label": "Number of Solved Violations" }, { "id": 67218, "label": "Number of Excluded Violations" }, { "id": 68001, "label": "Technical Debt" }, { "id": 68901, "label": "Technical Debt of added Violations" }, { "id": 68902, "label": "Technical Debt of removed Violations" } ] }, |
E.g:
A plugin also has various different parameters as follows:
Note that:
|
Parameter | Description |
---|---|
title | A title used to identify the tile. |
mode | Determines how much detail will be presented in a tile. Not all tiles support the attribute.
|
qualityIndicator or sizingMeasure | Represent the measurement data properties (typically the indicator identifier, some high level description and the value formatting).
|
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:
The parameter is global to tile configuration but only applies to the following plugins:
See Note about tags and categories as tile scopes in Health Dashboard - GUI. |
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" } } }, |
An array whose first five items are shown in the area. Each item describes a notification:
Note that:
|
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"}} ] } } |
Note that:
|
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.
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 Health 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> |
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.
Clicking the tile
When defined at single application level (app.json), clicking a tile will by default display the evolution of TQI. When defined at multi-application level (cmp.json), clicking a tile will display the following Background Fact detail for the Applications in scope:
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"} } } |
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. |
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"} } ] } } } } |
Note that:
|
This tile shows the top 5 critical rules at Application or multi-Application level, together with:
Configuration:
mode: two options are possible:
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" } } |
The critical violations per health factor module provides a critical violations count for a given business criterion:
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)
From, v. ≥ 2.5.0-funcrel the mode option is available. |
mode: the mode in which the value needs to be displayed:
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"} } } |
Note that:
|
Example (for cmp.json):
{ "id": 10201, "plugin": "FunctionalWeightMeasureResults", "color": "blue", "parameters": { "title": "Functional & Enhancement Size", "functionalWeightMeasure": { "id": "AUTOMATED_IFPUG_FUNCTION_POINTS_ESTIMATION", "format": "0,000", "description": "OMG-Compliant Automated FPs" } } } |
Note that when drilling down, a table is displayed listing the applications. |
Example (for app.json):
Note that when drilling down, a table lists all the Applications that are not included in the AFP measure (essentially all the Applications not using a CAST EFP license): |
Note that:
|
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"] } } }, |
Note that:
|
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 ranges, color or riskGauge. |
Example (for cmp.json)
{ "id": 999, "plugin": "QualityIndicatorResults", "color": "grey-dark", "parameters": { "title": "Programming Practices", "widget": "gauge", "qualityIndicator": { "id": "66031", "format": "0.00", "description": "" } } }, |
Example (for app.json)
{ "id": 999, "plugin": "QualityIndicatorResult", "color": "yellow", "parameters": { "title": "Programming Practices", "widget": "gauge", "qualityIndicator": { "id": "66031", "format": "0.00" "description": "" } } }, |
Example for a riskGauge at the start of the file in app.json or cmp.json
"QualityIndicatorResults" : { "ranges": [2.5, 2.9, 3.2], "riskGauge": { "thresholds":[1,2,2.7,3.2], "colors":["#02eff4","#ff4b02","#025af4","#7fc4b2","#eff402"] } }, |
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)
From, v. ≥ 2.5.0-funcrel the mode option is available. |
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" } } }, |
When using ≤ 1.22 AND when defined at single application level (app.json) AND when a custom ID has been used for the "id" value, then you will need to make some further configuration changes as follows to correctly display data when the tile is clicked. Edit the following file with a text editor:
≥ 1.22 Search for the "id": "sizeIndicators", section in the file and then locate the "indicators": [ section:
Add a new section to match the custom ID that you are working with. Don't forget to add a comma at the end of the previous section. For example:
Save the file when you have completed the update. You may need to restart Apache Tomcat before the drill down data is displayed. ≤ 1.21 Search for the "id": "evolution", section in the file and then locate the "id": "sizeIndicators", section:
Immediately after the "Technical debt" section, add a new section to match the custom ID that you are working with. Don't forget to add a comma at the end of the "Technical debt" section. For example:
Save the file when you have completed the update. You may need to restart Apache Tomcat before the drill down data is displayed. |
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"} } }, |
Note that:
|
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 requires that the following extensions are installed BEFORE a snapshot is generated - otherwise no results will be generated: |
From 2.7.0 onwards, this tile is not provided out of the box it has to be manually configured. |
This tile is available at Portfolio and Application level and displays the number of violations for rules that have the tag AIP-TOP-PRIORITY. Typically, rules with this tag are provided in the extension System Level Rules, but other rules may also have this tag.
Drill down behaviour
Clicking on the tile will bring you to the System Level Violations list:
Click to enlarge
Example (for cmp.json)
{ "id": 213, "plugin": "QualityStandards", "color": "light-red", "parameters": { "title": "Top Priority", "qualityStandards": { "id": "AIP-TOP-PRIORITY", "format": "0,000", "description": "Violations" } } }, |
Example (for app.json)
{ "id": 108, "plugin": "QualityStandards", "color": "light-red", "parameters": { "title": "Top Priority", "qualityStandards": { "id": "AIP-TOP-PRIORITY", "format": "0,000", "description": "Violations" } } }, |
|
A tile (not available by default) that enables you to display the number of violations (critical/non-critical violations according to the filter enabled) for rules tagged with a specific Quality Standards tag or manually injected custom tag. Valid for both Portfolio and Application levels with the same configuration.
Example
This example will display a tile showing the number of violations from rules tagged with the custom CUSTOM-TOP-PRIORITY-RULES tag:
{ "id": 2103, "plugin": "QualityStandards", "color": "green", "parameters": { "title": "My Top Priority", "qualityStandards": { "id": "CUSTOM-TOP-PRIORITY-RULES", "format": "0,000", "description": "Violations" } } }, |
Drill down behaviour
Clicking on any of these tiles will display a list of the rules that have been tagged with the specified tag:
Click to enlarge
|
This tile is designed to display data generated by the following CAST extensions that provide data about industry standards. These are:
You can display results in grade format or in number of violations format:
Example for cmp.json
{ "id": 1234, "plugin": "IndustryStandards", "color": "black", "parameters": { "type": "CISQ", "title": "CISQ-Security Index", "widget": "gauge", "industryStandard": { "id": "1062166", "indexID": "1062100", "mode": "grade", "format": "0.00", "description": "CISQ-Security in grade format" } } } |
Example for app.json
{ "id": 1236, "plugin": "IndustryStandard", "color": "orange", "parameters": { "type": "OWASP-2013", "title": "OWASP-2013 Index", "industryStandard": { "id": "1062300", "indexID": "1062300", "mode": "violations", "format": "0,000", "description": "OWASP-2013 in violation format" } } } |
Drill down behaviour
Clicking on any of these tiles will display a list of the rules that have been tagged with the specified standard as provided by the extension. Compliance percentage is also displayed in a "bubble":
Click to enlarge
Compliance percentage at single Application level | |
---|---|
Compliance percentage at multi Application level |
This tile (not available by default) provides the ability to define external URLs (e.g. to other data dashboards) in a tile:
Example (for cmp.json and app.json)
{ "id": 100, "plugin": "ExternalLink", "color": "red", "parameters": { "title": "Tackle your Technical Debt", "url":"http://www.castsoftware.com" } }, |
This tile (not provided "out-of-the box") shows a custom external URL (for example a link to a different dashboard) and a custom background image (rather than a plain colour). The tile configuration is as follows:
Example (for cmp.json and app.json)
{ "id": 1002015, "plugin": "ExternalLinkWithImage", "color": "red", "parameters": { "title": "Tackle your Technical Debt", "url":"http://www.castsoftware.com", "imageUrl": "https://some_url.com/bg.jpg" } }, |
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:
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 |
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 Health Dashboard in terms of rendering (i.e. those returning non numerical values such as booleans). |
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).
variables":{ "tqi":{"type":"qualityIndicator", "id":"TQI"}, "loc":{"type":"sizingMeasure", "id":"LINES_OF_CODE"}, "effort":{"type":"backgroundFact", "id":"EFFORT"} } |
Notes about the aggregator type "AvgSum" 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": "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"} } } }, |
{ "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"} } } }, |