CAST AIP Technologies
Page tree
Skip to end of metadata
Go to start of metadata

Summary: Documentation for the MIPS Reduction Index extension.

Extension ID

com.castsoftware.mips-redux-index

Description

This extension will compute the MIPS (Million Instructions Per Second) Reduction Index as a Business Criterion with dedicated supporting Technical Criteria. All CAST rules that are tagged with a MIPS related tag will contribute to these MIPS specific Business and Technical Criteria, thereby allowing specific grades and rule violations to be reported.

Compatibility

ProductReleaseSupported
AIP Core≥ 8.3.24(tick)

CAST Engineering Dashboard

≥ 1.5(tick)
CAST Health Dashboard≥ 1.17(tick)
CAST Security Dashboard-(error)

Technology compatibility

This extension supports only Mainframe related technologies (Cobol, JCL, CICS, IMS/DB) and SQL related technologies analyzed using CAST AIP .

Download and installation instructions

The MIPS Reduction Index extension will NOT be installed automatically in any situations, therefore, if you want to use it, you must download and install it "manually":

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)

 Click here to expand...

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 MIPS Reduction - focus on algorithmic costs tile:

{
  "id": 1234,
  "plugin": "IndustryStandards",
  "color": "black",
  "parameters": {
	"type": "MIPS",
    "title": "MIPS Reduction",
    "widget": "gauge",
    "industryStandard": {
		"id": "1062201",
		"indexID": "1062200",
		"mode": "grade",
		"format": "0.00",
		"description": "MIPS Reduction - focus on algorithmic costs, in grade format"
    }
  }
}

Example for app.json

Configuration to create a "number of violations" tile at application level (single app level) to show a MIPS Reduction - focus on algorithmic costs tile:

{
  "id": 1236,
  "plugin": "IndustryStandard",
  "color": "orange",
  "parameters": {
	"type": "MIPS",    
	"title": "MIPS Reduction",
    "industryStandard": {
		"id": "1062201",
		"indexID": "1062200",
		"mode": "violations",
		"format": "0,000",
		"description": "MIPS Reduction - focus on algorithmic costs, in number of violations format" 
    }
  }
}

What results can you expect?

Assessment Model

Business Criterion

One single Business Criterion will be added by the extension:

1062200MIPS Reduction

Click to enlarge

Technical Criteria

The MIPS Reduction Index Business Criterion is based on the following Technical Criteria that will be added by the extension:

1062201

MIPS Reduction - focus on algorithmic costs
1062202MIPS Reduction - focus on data access efficiency
1062203MIPS Reduction - focus on avoiding transaction failure

These Technical Criteria have been populated with rules with an aggregate weight greater or equal to 5 from the following existing Technical Criteria:

  • Efficiency - Expensive Calls in Loops
  • Efficiency - SQL and Data Handling Performance
  • Programming Practices - Error and Exception Handling
  • Programming Practices - Unexpected Behavior

Click to enlarge

Engineering Dashboard

≥ 1.18.0

In v. 1.18.0, results are displayed in a specific interface - click the MIPS-Reduction Assessment Model option to view the results:

Click to enlarge

In v. 1.17.0 only

 Click here to expand...

In ≤ 1.17.0, out of the box, one MIPS Reduction Index Business Criterion will be available (provided the filterHealthFactor option is set to false in the ed.json file):

Click to enlarge

A set of contributing MIPS Reduction Index Technical Criteria will be available:

Click to enlarge

Health Dashboard

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

RestAPI

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

  • No labels