Engineering Dashboard tile management on Documentation - V2

Application Components tile

Mon, 01 Jan 0001 00:00:00 +0000

This tile displays two pieces of information:

the total number of modules in the application
the total number of lines of code (LOC) in the analyzed results.

Clicking the tile will take you directly to the Application Investigation view.

Configuration

type: tile type has to be ComponentInvestigationOverview
parameters
- metric the LOC metric ID
color : tile color
other parameters for sizing and positioning of the tile - see**Tile Sizing and Positioning**

Example

Top Modules with Violations or Critical Violations tile

Mon, 01 Jan 0001 00:00:00 +0000

Top Modules with Violations or Critical Violations tile provides a listing of the modules sorted by the number of critical violations present in each module. Tile can be resized to display more or less modules. Clicking a module in the tile will take you directly to the module in the Application Investigation view (see Engineering Dashboard for more information). In the Application Investigation view, violated Quality Rules are listed by their number of violations, with critical rules first (by default: ordered by number of violations).

Health Factor weakness or strength tile

Mon, 01 Jan 0001 00:00:00 +0000

Health Factor weakness/strength tiles provide a summary of the strengths and weaknesses (in terms of Technical Criteria) for a given Health Factor.

Info

Note that depending on whether Critical Violations or ALL Violations are being displayed (see Data Filtering on Critical Violations), the content will reflect the filter that is currently active, displaying only Critical Violations or ALL Violations accordingly.

These tiles provide:

Weaknesses: Items displayed are the Technical Criteria considered to have at least one critical violation. The Technical Criteria are sorted from worst (top) to least bad (bottom).
Strengths: Items displayed at the Technical Criteria that do not have any critical violations (this includes Technical Criteria that have no critical Quality Rules or Technical Criteria that have critical rules with no violations).

Configuration

Risk Introduced tile

Mon, 01 Jan 0001 00:00:00 +0000

By default, Risk Introduced tile shows two values for the Total Quality Index (TQI) Health Factor:

Added Critical Violations or Violations > The number of critical violations or violations (i.e. “risk”) introduced in the current snapshot
Removed Critical Violations or Violations > The number of critical violations or violations removed from the current snapshot

Values are a comparison between the previous and current snapshot, therefore if this is the first snapshot then there will be Added Critical Violations or Violations but no Removed Critical Violations or Violations. It is also possible to change the Health Factor by clicking the drop down arrow next to the Health Factor name. If no added or removed Critical Violations or Violations are present in the snapshot, then the tile will display no data and will not be clickable:

Top Rules with increasing or decreasing violations tile

Mon, 01 Jan 0001 00:00:00 +0000

Top Rules with increasing/decreasing violations tiles display a list of Quality Rules and a value for each. The value represents the difference in the number of violations for the Quality Rule between the most recent and the previous snapshot. The higher the value, the larger the difference.

It is possible to choose between three values (as shown in the examples above):

ratio - shows a percentage difference (increase)
added - shows the exact number of added violations
removed - shows the exact number of removed violations)

Note that the value displayed in the tile when using the “ratio” option may be different from the value for the number of added or removed violations for a given Quality Rule, since the value is a difference between the number of violations since the previous snapshot and takes added and removed violations into account.

Action Plan tile

Mon, 01 Jan 0001 00:00:00 +0000

By default, Action Plan tile displays, initially, the total number of objects that have been added to the Action Plan list since the last snapshot was generated. Clicking the tile will take you directly to the Action Plan).

Configuration

type: tile type has to be ActionPlanSummary
parameters: none
color : tile color
other parameters for sizing and positioning of the tile - see Tile Sizing and Positioning

Example

{
	"type": "ActionPlanSummary",
	"parameters": {},
	"color": "blue",
	"col": 5,
	"row": 8,
	"sizex": 2,
	"sizey": 1,
	"min-sizex": 1,
	"min-sizey": 1,
	"max-sizex": 2,
	"max-sizey": 2,
	"id": "c934"
}

Exclusions tile

Mon, 01 Jan 0001 00:00:00 +0000

By default, Exclusions tile displays:

Active Exclusions: Shows the number of violations that have been added to the Exclusion list and a subsequent snapshot has been generated (therefore the violations are not part of the results of the current snapshot) - i.e. they are actively excluded.
Scheduled Exclusions: Shows the number violations that have been added to the Exclusion list and no snapshot has yet been generated (therefore the violations still form part of the results of the current snapshot). When a snapshot is generated, exclusions in this list will move to the Active Exclusions list.

External Links tile

Mon, 01 Jan 0001 00:00:00 +0000

External Links tile (not available by default) provides the ability to define external URLs ( to e.g. other data dashboards) in a tile:

Configuration

type: tile type, has to be ExternalLink
parameters
- title the short message to display in tile
- url the hyperlink to follow
color : tile color
other parameters for sizing and positioning of the tile - see Tile Sizing and Positioning

Example

{
 "type": "ExternalLink",
 "parameters": {
 "title": "Know more about CAST",
 "url":"http://www.castsoftware.com"
 },
 "color": "magenta",
 "col": 5,
 "row": 3,
 "sizex": 1,
 "sizey": 1,
 "min-sizex": 1,
 "min-sizey": 1,
 "max-sizex": 2,
 "max-sizey": 1
}

Background Facts tile

Mon, 01 Jan 0001 00:00:00 +0000

Info

The Background Facts tiles are available only in version ≥ 1.11.0.

Background Facts tile (not available by default) displays Background Facts that you have manually configured and uploaded during the snapshot generation (see Background Facts and Business Value Metric upload). The tile can display information about one metricthat you have defined in the uploaded Background Facts file.

Configuration

type: tile type, has to be BackgroundFactOverView
parameters
- backgroundFactId refers to the Background Fact numerical ID as displayed in the Assessment Model in the CAST Management Studio:

Custom tile

Mon, 01 Jan 0001 00:00:00 +0000

Info

Custom tiles are available only in version ≥ 1.11.0.
For Quality Standards tags, the extension Quality Standards Mapping must be installed prior to generating the snapshot, otherwise no tag data is available and no results will be returned.
Custom tags can be manually injected at any time - results will be available immediately.

Custom tile (not available by default) displays the number of violations (critical/non-critical violations according to the filter enabled) for rules tagged with a specific Quality Standards tagor manually injected custom tag.

Industry Standard tiles

Mon, 01 Jan 0001 00:00:00 +0000

Info

These tiles needs to be configured manually.

Industry Standard tiles are designed to display violation count data generated by the following CAST extensions that provide data about industry standards. These are:

CISQ
MIPS Reduction
ISO-5055
OWASP

Configuration

type: tile type has to be IndustryStandards
parameters:
- title: Title of the tile
- id: the Quality Standards or custom tag you wish to view
- description: a free text field to describe what the tile shows (not shown in the dashboard)
color: tile color
other parameters for sizing and positioning of the tile - see Tile Sizing and Positioning

Example

OMG Technical Debt tile

Mon, 01 Jan 0001 00:00:00 +0000

Info

This tile:

needs to be configured manually in CAST Engineering Dashboard ≤ 2.3.1 (in later releases it is available out of the box)
requires the OMG Technical Debt extension to be installed - if the extension is not installed, the tile will display N/A for values

OMG Technical Debt tile is available out of the box (in ≥ 2.3.1) displaying the Total Technical Debt (OMG) in days for the current Application, as well as Added and Removed OMG Technical Debt in days for the current snapshot:

Architecture Model violation tile

Mon, 01 Jan 0001 00:00:00 +0000

The Architecture Model tile (not available out of the box) displays all Architecture Models that have been assigned to the Application and checked during the snapshot. The tile displays the number of violations/critical violations (depending on the configuration of the criticalsRulesOnly parameter in the tile configuration) per Architecture Model. Clicking an Architecture Model will drill down and display the details of the selected rule in the Risk Investigation page.

Top Riskiest Components tile

Mon, 01 Jan 0001 00:00:00 +0000

Top Riskiest tile provides a clickable “cloud” of object names - the larger and bolder the font used to display the name, the higher the Risk (previously known as PRI: Propagated Risk Index) value the object has within the specified Health Factor (i.e. Security or Efficiency for example). See Engineering Dashboard for more information about how Risk is calculated.

Clicking an object name in the tile will take you directly to the object in the Application Investigation view.

Top Riskiest Transactions tile

Mon, 01 Jan 0001 00:00:00 +0000

Top Riskiest tile provides a clickable “cloud” of transaction names - the larger and bolder the font used to display the transaction name, the higher the TRI value (TRI or Transaction Risk Index is an indicator of the risk for transaction) has within the specified Health Factor (i.e. Robustness, Efficiency and Security for example). Robustness is set as the default Health Factor but can be changed in the tile itself using the drop down arrow.