ISO-5055 Index

Extension ID

com.castsoftware.omg-ascqm-index

Description

ISO-5055 is a standard that is published by ISO: https://www.iso.org/standard/80623.html .

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 ISO-50555 related tag will contribute to the various Quality Measure Elements / Quality Software Characteristic Measures thereby allowing specific compliance ratios, grades and rule violations to be reported.

Compatibility

ISO-5055 version

Download and installation instructions

The extension will not be automatically downloaded and installed in CAST Imaging Console. If you need to use it, should manually install the 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/the web application and/or emptying your browser cache.

Optional Health Dashboard configuration options

It is possible to modify some of the default tiles provided out of the box and also add additional tiles in the CAST Health Dashboard for use with ISO-5055 data. See Manual configuration of Dashboard tiles using ISO-5055 data for more information.

These customizations can be used in the following Health Dashboard releases:

• ≥ 1.27.0-funcrel
• ≥ 2.1.0-funcrel

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:

ISO-5055-Index

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

ISO-5055-Maintainability

ISO-5055-Performance-Efficiency

ISO-5055-Reliability

ISO-5055-Security

Health Dashboard

v. ≥ 1.27 / ≥ 2.1.0

A dedicated ISO-5055 view is available allowing you to swap between tiles showing ISO-5055 data and tiles showing standard data. The ISO-5055 view is accessed using the drop down available at single or multi-application level as shown in the screenshots below. By default, the tiles in this view use the root ISO-5055 Business Criterion (ISO-5055), and show either of the following data by default:

Release	Data displayed by default	Description
≥ 2.5.x	Compliance ratio
2.1.x - 2.4.x and ≥ 1.27.x	Grades

The tiles can be modified as follows (see Manual configuration of Dashboard tiles using ISO-5055 data) for more information:: \extensions\content\en\technologies\multi\com.castsoftware.omg-ascqm-index\manual-config

• to use any of the ISO-5055 business/technical criterion for the “qualityIndicator” parameter:
  • ISO-5055
  • ISO-5055-SECURITY
  • ISO-5055-RELIABILITY
  • ISO-5055-PERFORMANCE-EFFICIENCY
  • ISO-5055-MAINTAINABILITY
• the “mode” can be changed manually to show any of the following, instead of the default:
  • Grade
  • Compliance ratio
  • Number of violations

v. 1.26 / 2.0 only

Five ISO-5055 specific tiles will be available at both single and multi-application level - one for the Business Criteria ISO-5055 Index and the rest for the four Technical Criteria. In these releases, grade information is displayed by default.

v. ≤ 1.25

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 available in v. ≥ 1.17. 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”.

Examples for cmp.json and app.json:

cmp.json

Configuration to create a “gauge” tile at portfolio level (multi-app level) to show a ISO-5055-Index Business Criterion tile:

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

app.json

Configuration to create a “number of violations” tile at application level (single app level) to show a ISO-5055-Maintainability Business Criterion tile:

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

Engineering/Security Dashboard

v. ≥ 1.26

An ISO-5055 tile is displayed by default taking data from the Business Criterion ISO-5055 Index for the Engineering Dashboard and the Technical Criterion ISO-5055 Security for the Security Dashboard. The number of violations is shown in both cases:

Drilling down through this tile will take you to the Risk Investigation view, where the focus will be set to the ISO-5055 Assessment Model (1) showing only the ISO-5055 metrics (2):

v. ≤ 1.25

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.

In addition, as above, the ISO-5055 Assessment Model will be made available in the Risk Investigation view.

RestAPI

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