Extension ID

com.castsoftware.omg-ascqm-index

Description

ASCQM, Automated Source Code Quality Measures, is an OMG standard that is published by the CISQ Consortium.

This extension will compute Quality Software Characteristic Measures as Business Criteria and Quality Measure Elements as Technical Criteria. All CAST rules that are tagged with a OMG-ASCQM related tag will contribute to the various Quality Measure Elements / Quality Software Characteristic Measures thereby allowing specific grades and rule violations to be reported.

Compatibility

Product	Release	Supported
CAST AIP	≥ 8.3.24
CAST Engineering Dashboard	≥ 1.5
CAST Health Dashboard	≥ 1.17
CAST Security Dashboard	≥ 1.18

OMG-ASCQM version

1.0 (January 2020)

Download and installation instructions

• Download an extension
• Install an extension

Configuration requirements

Generate a snapshot

A new snapshot must be generated (after the extension is installed) before results can be viewed. If you do not immediately see changes in the dashboard, please consider restarting Apache Tomcat and/or emptying your browser cache.

Engineering Dashboard

Tiles

Out of the box, no tiles will be provided to display data for this extension, however it is possible to create tiles manually to display Violation data directly from this extension using the Industry Standard/s tile plugin in v. ≥ 1.18 of the Engineering Dashboard. See Engineering Dashboard tile management for more information

Clicking on the tile navigates to Risk investigation view and the specified Industry Standard will be selected in the Health Factor table. 

Set filterHealthFactor option to false (only required in Engineering Dashboard ≤ 1.17)

CATALINA_HOME\webapps\CAST-Engineering\engineering\resources\ced.json
For v.≥ 1.18: CATALINA_HOME\webapps\CAST-Engineering\engineering\resources\ed.json

"filterHealthFactor": true,

"filterHealthFactor": false,

Health Dashboard

Out of the box, no tiles will be provided to display data for this extension, however it is possible to create tiles manually to display Grade, Compliance, and Violation data directly from this extension using the Industry Standard/s tile plugin in v. ≥ 1.17 of the Health Dashboard. See Health Dashboard tile management for more information. 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".

Example for cmp.json

Configuration to create a "gauge" tile at portfolio level (multi-app level) to show a OMG-ASCQM-Index Business Criterion tile:

{
  "id": 1234,
  "plugin": "IndustryStandards",
  "color": "black",
  "parameters": {
	"type": "OMG-ASCQM",
    "title": "OMG-ASCQM-Index",
    "widget": "gauge",
    "industryStandard": {
		"id": "1061000",
		"mode": "grade",
		"format": "0.00",
		"description": "OMG-ASCQM-Index in grade format"
    }
  }
}

Example for app.json

Configuration to create a "number of violations" tile at application level (single app level) to show a OMG-ASCQM-Maintainability Business Criterion tile:

{
  "id": 1236,
  "plugin": "IndustryStandard",
  "color": "orange",
  "parameters": {
	"type": "OMG-ASCQM",    
	"title": "OMG-ASCQM-Maintainability",
    "industryStandard": {
		"id": "1061001",
		"mode": "violations",
		"format": "0,000",
		"description": "OMG-ASCQM-Maintainability in number of violations format" 
    }
  }
}

Security Dashboard

Out of the box, no tiles will be provided to display data for this extension, however it is possible to create tiles manually to display Violation data using the Industry Standard/s tile plugin in v. ≥ 1.18 of the Security Dashboard. The tile configuration is identical to that described for the Engineering Dashboard, see Engineering Dashboard tile management for more information:

Clicking on the tile navigates to Security Dashboard - Risk Investigation and the specified Industry Standard will be selected in the Health Factor table.

What results can you expect?

Once the analysis/snapshot generation has completed, you can view the results in the dashboards:

Assessment Model

Various Business and Technical Criteria will be added by the extension:

OMG-ASCQM-Index

OMG-ASCQM-Maintainability

OMG-ASCQM-Performance-Efficiency

OMG-ASCQM-Reliability

OMG-ASCQM-Security

Click to enlarge

Engineering Dashboard

≥ 1.18.0

In ≥ 1.18.0 out of the box, results are displayed in a specific interface - click the OMG ASCQM Assessment Model option to view the results:

Click to enlarge

≤ 1.17.0

Health Dashboard

Out of the box, no results are provided. Tiles can be configured manually as described above.

Security Dashboard

Out of the box, results are displayed in a specific interface - click the OMG ASCQM Assessment Model option (after clicking the Risk Investigation tile in the Application home page) to view the results:

Only the OMG-ASCQM-Security Business Criterion will be available (due to the default filtering implemented in the Security Dashboard):

Click to enlarge

RestAPI

The RestAPI can be used to query both the Dashboard (AED) and Measurement (AAD) schemas for results, for example: