Page History

...

Library files

...

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

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

Viewing the changes in your browser

...

• 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 Health Dashboard - in this situation it can be difficult to read the score grade 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.
• aggregation: (sum or average), tile will aggregate the application background fact values using sum or average - default value is sum. For example: if you have two Applications visible in the Health Dashboard and have configured a Background Fact (a Cost of 400 for example) for only one of the Applications, results will be displayed as follows:
  • AVERAGE: A value of 200 will be displayed in the tile at Multi-application level (400 divided by 2) and in the tiles at Application level.
  • SUM: A value of 400 will be displayed in the tile at Multi-application level and at Application level, 400 will be displayed for the Application for which the Background Fact has been uploaded and 0 for the Application for which no Background Fact has been uploaded.

...

1. count: the number of lines displayed. 5 is the optimized size for the height of the tile. This parameter is only taken into account for topRiskiest tile types. 
2. order: the ordering of the data represented in the tile. This can be descending or ascending, and is based on the sizing measure
3. qualityIndicator: this is identical to the indicator of the singleQualityIndicator tile :
   
   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. description is whatever is required

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

      Info
      From, v. ≥ 2.5.0-funcrel the mode option is available.

      
      

   5. mode: the mode in which the value needs to be displayed:

      • grade: this will provide a value from 1 - 4
      • violations: this will provide the total number of violations
      • compliance: this will provide the percentage value of compliance to the chosen metric

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"}
                }
            },

...

...

1. qualityIndicator: information about the indicator to display : its id, format and an optional description
   
   • id is
   either
   • one of the following: ARCHITECTURAL_DESIGN, CHANGEABILITY, DOCUMENTATION, PERFORMANCE, PROGRAMMING_PRACTICE, ROBUSTNESS, SEI_MAINTAINABILITY, SECURITY, TQI, TRANSFERABILITY
   id can
   • - can also be a numerical ID
   corresponding to any CAST AIP metric
   • such as 66031 (Programming Practices)
   • 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 parent 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
   •  free text of whatever is required
2. 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.
3. widget provides graphical representations of the indicator (e.g. gauge, donut or riskGauge)
   • If widget is set to riskGauge, then the gauge will display color based on the indicator
   score
   • grade 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.
   • 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
     • thresholds: define the thresholds used to qualify the
   score
   • • grade 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 the colors using hexidecimal color numbers according to the number of thresholds (remember that one more color is always required than the number of thresholds defined, for example: defining 3 thresholds will result in 4 areas, hence 4 colors are required)
4. icon: boolean to display (true) an icon next to the tile title, false by default.
5. 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 Health Dashboard - in this situation it can be difficult to read the score grade 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.

Example (for cmp.json)

{
    "id": 211999,
    "plugin": "QualityIndicatorResults",
    "color": "grey-dark",
    "parameters": {
    	"title": "Programming Practices - OO Inheritance and Polymorphism",
    	"widget": "gauge",
    	"qualityIndicator": {
        	"id": "ROBUSTNESS66031",
        	"technicalIdformat": "610030.00",
        "format": "0.00",
        "	"description": ""
    	}
    }
},

Example (for app.json)

{
    "id": 104999,
    "plugin": "QualityIndicatorResult",
    "color": "yellow",
    "parameters": {
    	"title": "RobustnessProgramming Practices",
    	"widget": "gauge",
    	"qualityIndicator": {
        	"id": "ROBUSTNESS66031",
        	"format": "0.00"
			"description": ""
    	}
    }
},

Example for a riskGauge at top level 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"]
	}
},

...

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. description is whatever is required
   4. 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)

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

      Info
      From, v. ≥ 2.5.0-funcrel the mode option is available.

      
      

   6. mode: the mode in which the value needs to be displayed:
      • grade: this will provide a value from 1 - 4
      • violations: this will provide the total number of violations
      • compliance: this will provide the percentage value of compliance to the chosen metric

Example (for cmp.json)

            {
                "id": 103,
                "plugin": "QualityIndicatorEvolution",
                "color": "green",
                "parameters": {
                    "widget":"spline",
                    "title": "Security",
                    "qualityIndicator": {
						"id": "SECURITY",
						"format": "0.00"
					}
                }
            },

...

1. sizingMeasure: information about the indicator to display : its id, format and an optional description
   
   1. id is either: TECHNICAL_DEBT, LINES_OF_CODE, NUMBER_OF_ARTIFACTS, NUMBER_OF_COMMENT_LINES, NUMBER_OF_DECISION_POINTS, NUMBER_OF_FILES, NUMBER_OF_FUNCTION_POINTS, NUMBER_OF_BACKFIRED_FUNCTION_POINTS and CRITICAL_VIOLATIONS, CRITICAL_VIOLATIONS, OMG_TECHNICAL_DEBT_ISO, OMG_TECHNICAL_DEBT_CISQ and OMG_TECHNICAL_DEBT
   2. id can also be a numerical ID corresponding to any CAST AIP metric
   3. description is whatever is required
   4. 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)
   5. 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)

...

1. sizingMeasure: information about the indicator to display : its id, format and an optional description
   
   1. id is either: TECHNICAL_DEBT, LINES_OF_CODE, NUMBER_OF_ARTIFACTS, NUMBER_OF_COMMENT_LINES, NUMBER_OF_DECISION_POINTS, NUMBER_OF_FILES, NUMBER_OF_FUNCTION_POINTS, NUMBER_OF_BACKFIRED_FUNCTION_POINTS and , CRITICAL_VIOLATIONS, OMG_TECHNICAL_DEBT_ISO, OMG_TECHNICAL_DEBT_CISQ and OMG_TECHNICAL_DEBT
   2. id can also be a numerical ID corresponding to any CAST AIP metric
   3. description is whatever is required
   4. 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)
2. 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 Health Dashboard - in this situation it can be difficult to read the score grade 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.
   

...

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.

...

• id: each custom tile must have its own unique ID within cmp.json / app.json
• plugin: must be IndustryStandards (cmp.json) / IndustryStandard (app.json)
• color: tile color
• parameters:
  • type: One of the following depending on the industry standard you are measuring:
    • CISQ
    • MIPS
    • ISO-5055
    • OWASP-2013
    • OWASP-2017
  • title: Title of the tile - free text
  • widget: (only when you require grade format results) - gauge or donut
  • industryStandard:
    • id: the IndustryStandard industryStandard ID defined by the extension (see the extension documentation for more information).
    • indexID: this ID should be the industryStandard parent Business Criterion index. This ensures that drill down from the tile functions correctly. For example, if you have configured the tile to show CISQ-Performance-Efficiency (1062102), you should configure the indexID to 1062100 (the parent Business Criterion index)
    • mode: the mode in which the value needs to be displayed:
      • grade: this will provide a value from 1 - 4
      • violations: this will provide the total number of violations
      • compliance: this will provide the percentage value of compliance to the chosen IndustryStandard
    • format: the format in which the value has to be displayed, this uses the the format defined in numeral.js (see http://numeraljs.com/ for available Numbers formats):
      • 0.00 for grade format
      • 0,000 for violations format
      • 0.0% for compliance format
    • description: an optional free text field to describe what the tile shows (not shown in the dashboard)

...

{
  "id": 1234,
  "plugin": "IndustryStandards",
  "color": "black",
  "parameters": {
	"type": "CISQ",
    "title": "CISQ-Security Index",
    "widget": "gauge",
    "industryStandard": {
		"id": "10621041062166",
		"indexID": "1062100",
		"mode": "grade",
		"format": "0.00",
		"description": "CISQ-Security in grade format"
    }
  }
}

...

{
  "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" 
    }
  }
}

...

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 grades 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

...

...

...