Summary: Documentation for the OMG-ASCQM Index extension.


This extension has been superseded by the ISO-5055 Index extension, which uses the same ID: com.castsoftware.omg-ascqm-index. This documentation is no longer maintained.

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

ProductReleaseSupported
CAST AIP≥ 8.3.24(tick)

CAST Engineering Dashboard

≥ 1.5(tick)
CAST Health Dashboard≥ 1.17(tick)
CAST Security Dashboard≥ 1.18(tick)

OMG-ASCQM version

1.0 (January 2020)(tick)

Download and installation instructions

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)

Before results can be viewed, you must ensure that the "filterHealthFactor": option is set to false. To do so, locate the following file:

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

Find the following line (near the start of the file):

"filterHealthFactor": true,

If the option is set to true (default position) please change it false. If it is false already, there is nothing further to do:

"filterHealthFactor": false,

Following any changes you make, save the ced.json/ed.json file and then restart your application server so that the changes are taken into account.

You can find out more about the options available in the ced.json/ed.json file in Engineering Dashboard json configuration options.


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

1061000OMG-ASCQM-IndexBusiness Criterion


Note that the OMG-ASCQM-Index Business Criterion has all Technical Criteria listed below as contributors.

OMG-ASCQM-Maintainability

1061001OMG-ASCQM-Maintainability
1061046CWE-407
1061056CWE-478
1061057CWE-480
1061058CWE-484
1061061CWE-561
1061065CWE-570
1061066CWE-571
1061088CWE-783
1061105CWE-1041
1061108CWE-1045
1061110CWE-1047
1061111CWE-1048
1061114CWE-1051
1061115CWE-1052
1061116CWE-1054
1061117CWE-1055
1061121CWE-1062
1061122CWE-1064
1061128CWE-1074
1061129CWE-1075
1061131CWE-1079
1061132CWE-1080
1061135CWE-1084
1061136CWE-1085
1061137CWE-1086
1061138CWE-1087
1061141CWE-1090
1061143CWE-1093
1061145CWE-1095

OMG-ASCQM-Performance-Efficiency

1061002OMG-ASCQM-Performance-Efficiency
1061044CWE-401
1061045CWE-404
1061049CWE-424
1061085CWE-772
1061086CWE-775
1061106CWE-1042
1061107CWE-1043
1061109CWE-1046
1061112CWE-1049
1061113CWE-1050
1061118CWE-1057
1061120CWE-1060
1061124CWE-1067
1061126CWE-1072
1061127CWE-1073
1061140CWE-1089
1061142CWE-1091
1061144CWE-1094

OMG-ASCQM-Reliability

1061003OMG-ASCQM-Reliability
1061021CWE-119
1061022CWE-120
1061023CWE-123
1061024CWE-125
1061026CWE-130
1061027CWE-131
1061029CWE-170
1061030CWE-194
1061031CWE-195
1061032CWE-196
1061033CWE-197
1061034CWE-248
1061035CWE-252
1061038CWE-366
1061039CWE-369
1061040CWE-390
1061041CWE-391
1061042CWE-392
1061043CWE-394
1061044CWE-401
1061045CWE-404
1061047CWE-415
1061048CWE-416
1061049CWE-424
1061051CWE-456
1061053CWE-459
1061054CWE-476
1061057CWE-480
1061058CWE-484
1061060CWE-543
1061062CWE-562
1061064CWE-567
1061067CWE-595
1061068CWE-597
1061074CWE-662
1061076CWE-667
1061077CWE-672
1061078CWE-681
1061079CWE-682
1061080CWE-703
1061081CWE-704
1061083CWE-758
1061084CWE-764
1061085CWE-772
1061086CWE-775
1061089CWE-786
1061090CWE-787
1061091CWE-788
1061094CWE-805
1061095CWE-820
1061096CWE-821
1061097CWE-822
1061098CWE-823
1061099CWE-824
1061100CWE-825
1061101CWE-833
1061102CWE-835
1061103CWE-908
1061108CWE-1045
1061114CWE-1051
1061119CWE-1058
1061123CWE-1066
1061125CWE-1070
1061130CWE-1077
1061131CWE-1079
1061133CWE-1082
1061134CWE-1083
1061138CWE-1087
1061139CWE-1088
1061146CWE-1096
1061147CWE-1097
1061148CWE-1098

OMG-ASCQM-Security

1061004OMG-ASCQM-Security
1061010CWE-22
1061011CWE-23
1061012CWE-36
1061013CWE-77
1061014CWE-78
1061015CWE-79
1061016CWE-88
1061017CWE-89
1061018CWE-90
1061019CWE-91
1061020CWE-99
1061021CWE-119
1061022CWE-120
1061023CWE-123
1061024CWE-125
1061025CWE-129
1061026CWE-130
1061027CWE-131
1061028CWE-134
1061030CWE-194
1061031CWE-195
1061032CWE-196
1061033CWE-197
1061035CWE-252
1061036CWE-259
1061037CWE-321
1061038CWE-366
1061039CWE-369
1061044CWE-401
1061045CWE-404
1061049CWE-424
1061050CWE-434
1061051CWE-456
1061052CWE-457
1061055CWE-477
1061057CWE-480
1061059CWE-502
1061060CWE-543
1061063CWE-564
1061064CWE-567
1061065CWE-570
1061066CWE-571
1061069CWE-606
1061070CWE-611
1061071CWE-624
1061072CWE-643
1061073CWE-652
1061074CWE-662
1061075CWE-665
1061076CWE-667
1061077CWE-672
1061078CWE-681
1061079CWE-682
1061082CWE-732
1061085CWE-772
1061086CWE-775
1061087CWE-778
1061088CWE-783
1061089CWE-786
1061090CWE-787
1061091CWE-788
1061092CWE-789
1061093CWE-798
1061094CWE-805
1061095CWE-820
1061096CWE-821
1061097CWE-822
1061098CWE-823
1061099CWE-824
1061100CWE-825
1061102CWE-835
1061104CWE-917

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

In ≤ 1.17.0, out of the box a set of Quality Software Characteristic Measures as Business Criteria will be displayed (provided the filterHealthFactor option is set to false in the ed.json file):

Click to enlarge

Each Quality Software Characteristic Measures as Business Criteria will have a set of Measure Elements as Technical Criteria:

Click to enlarge

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: