...
- qualityIndicator: information about the indicator to display : its id, format and an optional description
- id is either: ARCHITECTURAL_DESIGN, CHANGEABILITY, DOCUMENTATION, PERFORMANCE, PROGRAMMING_PRACTICE, ROBUSTNESS, SEI_MAINTAINABILITY, SECURITY, TQI, TRANSFERABILITY
- id can also be a numerical ID corresponding to any CAST AIP metric
- 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)
- 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.
- description is whatever is required
- details provide parameters dedicated towards drill down page views
- ranges: range used to separate indicator groups displayed in detail view. Default is [2,3] to produce : [indicator < 2, 2 <= indicator < 3, 3<= indicator]
- colors: from 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.
- widget provides graphical representations of the indicator (e.g. gauge, donut or donut riskGauge)
- 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.
- icon: boolean to display (true) an icon next to the tile title, false by default.
- 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.
- riskGauge: can be set globally in the top level level QualityIndicatorResults global global configuration and can be overridden in the tile parameters. Parameters are used if the widget parameter is set to to riskGauge
- 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
- colors: define define the colors accordingly using hexidecimal color numbers according to the number of thresholds (keep in mind remember that 3 thresholds means 4 areas, hence 4 colors are required)
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 ranges, color or riskGauge. |
...
No Format |
---|
{ "id": 104, "plugin": "QualityIndicatorResult", "color": "yellow", "parameters": { "title": "Robustness", "widget": "gauge", "qualityIndicator": { "id": "ROBUSTNESS", "format": "0.00" } } }, |
Example for a riskGuage at top level in app.json or cmp.json
No Format |
---|
"QualityIndicatorResults" : { "ranges":[1.6,2.8,3.0,3.4], "riskGauge": { "colors":["#02eff4", "#ff4b02", "#02eff4", "#7fc4b2"] } }, |
QualityIndicatorEvolution
...
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
...
...
...