Page tree
Skip to end of metadata
Go to start of metadata

Summary: This page explains how to configure the Engineering Dashboard tile interface

Introduction

The Engineering Dashboard has a "tile" or "panel" based interface that provides access to the data:

These tiles have default presentation settings, but this can be modified and tailored to your requirements. For example:

  • Tile colours can be changed
  • Tile positions can be changed
  • Tile contents can be changed
  • Tile size can be changed
  • New tiles can be added
  • A white separator tile can be added to help organise tiles

Editing your tiles presentation

The default tile presentation is defined in the following file:

WAR 1.x
CATALINA_HOME\webapps\<dashboard>\engineering\resources\ed.json

WAR ≥ 2.x
CATALINA_HOME\webapps\<dashboard>\WEB-INF\classes\config\ed\ed.json

ZIP ≥ 2.x
<unpacked_zip>\configurations\config\ed\ed.json

To modify the presentation, edit the .json file with a text editor (Notepad or other similar application). CAST recommends:

  • creating a copy of the default .json files that can be used as a replacement if an error occurs during editing
  • first changing existing parameters such as color and title and also moving Tiles around before you begin making large scale and more complex changes

Viewing the changes in your browser

There is no need to restart the application server or application itself if you edit and save the .json file: changes are immediate on saving the file. However, you may find that the changes are not immediately visible in the Engineering Dashboard. This is because the .json file is loaded into the browser's cache, therefore CAST recommends that you empty your browser cache to force the changes to become visible.

If you are using Google Chrome the following tip can be used to automatically empty the browser cache:

  • Tap F12 to open the Developer Tools window at the bottom of the page.
  • Click the Settings icon (a cog) to the right of the Developer Tools window
  • Tick the Disable cache (while DevTools is open) option and close the Settings window.
  • In this state, when you then tap F12 followed by F5 to refresh the page, the browser cache will be automatically emptied.

Changing the positions of tiles

Tiles are displayed in the Engineering Dashboard using a column and row configuration defined within each individual tile configuration. Therefore to move a Tile, you need to change its configuration in the .json file. More information about the column and row configuration is provided in Tile Sizing and Positioning.

Configuring a white separator tile

It is possible to add a single or multiple white separator tiles so that you can more easily organise tiles into groups. It acts as a separator and can be resized and moved along both horizontal and vertical axes. An example is shown below. Note that the white tile cannot be configured to be clicked to other data:

Configuration

  • type: tile type "MockTile"

  • color : tile color i.e. white or "".

  • title: title of tile, configurable ("Additional Information")

  • other parameters for sizing and positioning of the tile - see Tile Sizing and Positioning

Example

{
    "type": "MockTile",
    "color": "",
    "parameters": {},
    "col": 1,
    "row": 5,
    "sizex": 6,
    "sizey": 1,
    "max-sizex": 8,
    "max-sizey": 6,
    "title": "Additional Information",
    "id": "c928"
}

Structure of the .json

The .json file is divided into various different sections, each corresponding to a tile in the Engineering Dashboard. Various Tiles (or Panels) are defined, for example, the "out-of-the-box" tile Rules, Measures, Distributions tile:

{
    "type": "QualityModelOverview",
    "color": "pink",
    "parameters": {},
    "col": 1,
    "row": 1,
    "sizex": 2,
    "sizey": 2,
    "max-sizex": 2,
    "max-sizey": 2
},

Available parameters in the .json

Top Riskiest Components

This 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 (see Engineering Dashboard for more information).

Configuration

  • type: tile type has to be RiskiestComponents
  • parameters
    • business the health factor ID
    • indicator the health factor name
    • nbRows (optional) the number of items to fetch (default set to 10)
  • color: tile color
  • other parameters for sizing and positioning of the tile - see Tile Sizing and Positioning

Example

{
  "type": "RiskiestComponents",
  "parameters": {
    "business": "60011",
    "indicator": "Transferability",
    "nbRows":10
  },
  "color": "grey",
  "col": 5,
  "row": 2,
  "sizex": 2,
  "sizey": 1,
  "min-sizex": 2,
  "min-sizey": 1,
  "max-sizey": 5,
  "max-sizex": 5
}

Top Riskiest Transactions

This tile provide 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.

Clicking a transaction name in the tile will take you directly to the transaction in the Transaction Investigation view (see Engineering Dashboard for more information).

Configuration

  • type: tile type, has to be TopRiskiestTransactions
  • parameters
    • business the default health factor ID
    • nbRows (optional) the number of items to fetch (default to 30)
  • color : tile color
  • other parameters for sizing and positioning of the tile - see Tile Sizing and Positioning

Example

{
  "type": "TopRiskiestTransactions", 
  "parameters": {
    "business": "60013",
    "nbRows":30
  },
  "color": "orange",
  "col": 7,
  "row": 3,
  "sizex": 2,
  "sizey": 2,
  "min-sizex": 2,
  "min-sizey": 1,
  "max-sizey": 5,
  "max-sizex": 5
}

Top Modules with Violations or Critical Violations

This 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).

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.

Configuration

  • type: tile type has to be TopCriticalModules
  • parameters
    • business the health factor ID
  • color : tile color
  • other parameters for sizing and positioning of the tile - see Tile Sizing and Positioning

Example

{
  "type": "TopCriticalModules",
  "parameters": {
    "business": 60017
  },
  "color": "violet",
  "col": 7,
  "row": 1,
  "sizex": 2,
  "sizey": 2,
  "min-sizex": 2,
  "min-sizey": 1,
  "max-sizex": 4,
  "max-sizey": 5
}

Health Factor weakness/strength tiles

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 a summary of the strengths and weaknesses (in terms of Technical Criteria) for a given Health Factor. 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

  • type: tile type has to be BusinessCriteria
  • parameters
    • business the health factor ID
    • indicator the health factor name
    • orderBy strength or weakness
  • color: tile color
  • other parameters for sizing and positioning of the tile - see Tile Sizing and Positioning

Example

{
  "type": "BusinessCriteria",
  "parameters": {
    "business": "60012",
    "indicator": "Changeability",
    "orderBy":"strength"
  },
  "color": "green",
  "col": 3,
  "row": 3,
  "sizex": 2,
  "sizey": 1,
  "min-sizex": 2,
  "min-sizey": 1,
  "max-sizex": 3,
  "max-sizey": 5
}

Top Rules with increasing / decreasing violations

This tile displays 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.

Violation count difference is displayed on the right of a rule and a red dot is added when the rule is critical. Rules are clickable and will take you direct to the Quality Rule in the Quality Investigation view (see Engineering Dashboard for more information).

Note that the default behaviour in the dashboard is to display ONLY Critical Violations (see Data Filtering on Critical Violations) - therefore the display in this tile will reflect this and only Critical Violations (with a red dot) will be displayed. If the default filter is disabled to show ALL violations, then the tile will display Critical and non-Critical Violations

Configuration

  • type: tile type has to be NewViolationsForQualityRules
  • parameters
    • business the health factor ID
    • variation decide value to be considered
      • ratio (default value), show the variation of violations between current and previous snapshot
      • added show the variation focusing on added violations only
      • removed show the variation focussing on removed violations only
  • color : tile color
  • other parameters for sizing and positioning of the tile - see Tile Sizing and Positioning
{
  "type": "NewViolationsForQualityRules",
  "parameters": {
    "business": 60017,
	"variation":"added"
  },
  "color": "dark-grey-red",
  "col": 7,
  "row": 2,
  "sizex": 2,
  "sizey": 2,
  "min-sizex": 2,
  "min-sizey": 1,
  "max-sizex": 4,
  "max-sizey": 5
}

Risk Introduced

By default, this 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:

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.

Behaviour when the tile is clicked

Clicking the tile will take you directly to the Health Factor in the Quality Investigation view (see Engineering Dashboard for more information), however, the Quality Investigation view will only show added and removed violation information. Any Health Factor, Technical Criterion or Quality Rule where the number of Added and/or Removed violations is 0, will not be visible. A message will reflect this (click to enlarge):


Configuration

  • type: tile type has to be AddedViolations
  • parameters
    • business : the health factor ID
  • color : tile color
  • other parameters for sizing and positioning of the tile - see Tile Sizing and Positioning

Example

{
    "type": "AddedViolations",
    "parameters": {
      "business": "60017"
    },
    "color": "orange",
    "col": 3,
    "row": 1,
    "sizex": 2,
    "sizey": 1,
    "min-sizex": 1,
    "min-sizey": 1,
    "max-sizey": 1,
    "max-sizex": 2
}

Action Plan

A default Action Plan tile is displayed showing, 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

A default Exclusions tile is displayed showing:

  • 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.

Clicking the tile will take you to the relevant Exclusion page, see Engineering Dashboard - Exclusions for more information.

Configuration

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

Example

{
	"type": "ExclusionSummary",
	"parameters": {},
	"color": "grey-light",
	"col": 5,
	"row": 8,
	"sizex": 2,
	"sizey": 1,
	"min-sizex": 1,
	"min-sizey": 1,
	"max-sizex": 2,
	"max-sizey": 1,
	"id": "c9344"
}

This 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

Note that Background Facts tiles are available in version ≥ 1.11.0.

A tile (not available by default) that enables you to display 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 metric that 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:



    • title the title to display in the tile (long titles will be set to a fixed length)
  • color: tile color
  • other parameters for sizing and positioning of the tile - see Tile Sizing and Positioning

Example

{
	"type": "BackgroundFactOverView",
	"parameters": {
		"backgroundFactId":66006,
		"title":"Business Value"
	},
	"color": "eco-green",
	"col": 3,
	"row":11,
	"sizex":1,
	"sizey":1
}

Custom tiles

  • Custom tiles are available 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.

A tile (not available by default) that enables you to display the number of violations (critical/non-critical violations according to the filter enabled) for rules tagged with a specific Quality Standards tag or manually injected custom tag.

Configuration

  • type: tile type has to be QualityStandards
  • 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

This example will display a tile showing the number of violations tagged with the CISQ-RELIABILITY tag:

{
	"type": "QualityStandards",
	"parameters": {
		"title": "CISQ Reliability",
        "id": "CISQ-RELIABILITY",
        "description": "violations"
	},
	"color": "blue",
	"col": 1,
	"row": 12,
	"sizex": 1,
	"sizey": 1,
	"max-sizex": 2,
	"max-sizey": 1
}

Drill down behaviour

Clicking on any of these tiles navigates to the Risk investigation view with the specific tag selected in a drop-down at the top of the table - therefore filtering and displaying only rules that have this tag. "All Rules" will be selected in the Technical Criteria table by default and the list of rules displayed in the right hand panel are those that correspond to the selected tag:

Click to enlarge

Industry Standard tiles

These tiles needs to be configured manually.

This tile is designed to display violation count data generated by the following CAST extensions that provide data about industry standards. These are:

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

This example will display a tile showing the number of violations for the CISQ Index Business Criterion (1062100):

{
	"type": "IndustryStandards",
	"parameters": {
		"title": "CISQ",
		"id": "1062100"
	},
	"color": "green",
	"col": 4,
	"row": 2,
	"sizex": 1,
	"sizey": 1,
	"max-sizex": 2,
	"max-sizey": 1
},

Clicking on the tile navigates to Risk investigation view and the specified Industry Standard will be selected in the Health Factor table. This tile displays N/A if the application does not have data for industry standards and the clicking option is disabled in this case.

Architecture Model violation tile

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.

Configuration

  • type: tile type has to be ArchitectureModel
  • parameters:
    • business: must be set to 60017
    • criticalsRulesOnly: set to true or false depending on requirements - Architecture Models can be set to either Critical or Non-Critical - therefore all violations of the model will either be Critical or Non-Critical:
      • true: the tile will display only Critical Violations
      • false: the tile will display Non-Critical Violations
  • color: tile color
  • other parameters for sizing and positioning of the tile - see Tile Sizing and Positioning.

Example

{
	"type":"ArchitectureModel",
	"parameters":{
 		"business":60017,
 		"criticalsRulesOnly":false
	},
 	"color":"blue-dark",
  	"col":7,
  	"row":1,
  	"sizex":2,
  	"sizey":1,
  	"min-sizex":2,
  	"min-sizey":1,
  	"max-sizex":4,
  	"max-sizey":4
}

OMG Technical Debt tile

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

This 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:

Configuration

  • type: tile type has to be OMGTechnicalDebt
  • parameters:
    • business: can be set to:
      • 1061000 (based on ISO-5055 index, installed by default in AIP Console) only for version ≥ 2.x of the extension
      • 60017 (based on TQI from AIP Core) only for version ≥ 2.x of the extension
      • 1062100 (based on CISQ Index) for any release of the extension (requires that the CISQ Index is installed)
  • color: tile color
  • other parameters for sizing and positioning of the tile - see Tile Sizing and Positioning.

Example

For v. ≥ 2.x based on ISO-5055 Index (default configuration):

{
	"type":"OMGTechnicalDebt",
	"parameters":{
		"business":"1061000" },
	"color":"blue-dark",
	"col":1,
	"row":4,
	"sizex":2,
	"sizey":1,
	"min-sizex":1,
	"min-sizey":1,
	"max-sizey":1,
	"max-sizex":2
},

For v. ≥ 2.x based on AIP Core TQI:

{
	"type":"OMGTechnicalDebt",
	"parameters":{
		"business":"60017" },
	"color":"blue-dark",
	"col":1,
	"row":4,
	"sizex":2,
	"sizey":1,
	"min-sizex":1,
	"min-sizey":1,
	"max-sizey":1,
	"max-sizex":2
},

For v. ≥ 2.x based on CISQ Index data:

{
	"type":"OMGTechnicalDebt",
	"parameters":{
		"business":"1062100" },
	"color":"blue-dark",
	"col":1,
	"row":4,
	"sizex":2,
	"sizey":1,
	"min-sizex":1,
	"min-sizey":1,
	"max-sizey":1,
	"max-sizex":2
},


For v. 1.x:

{
	"type":"OMGTechnicalDebt",
    "parameters":{
        "business":"1062100"
	 },
     "color":"orange",
     "col":7,
     "row":1,
     "sizex":2,
     "sizey":1,
     "min-sizex":1,
     "min-sizey":1,
     "max-sizey":1,
     "max-sizex":2,
},

Drill down behaviour

Clicking this tile will drill down to the Risk investigation view with Technical Debt (OMG) with the ISO-5055 Assessment Model selected. If the tile has been manually edited and re-configured to show either TQI (AIP Core) or CISQ Index data, the drill down will also change as shown below:

Click to enlarge

ISO-5055 data (default)

TQI data (AIP Core)

CISQ Index data

You can also switch to showing Violations instead of Technical Debt (OMG) values from the drop-down list:

 

In the rule details section, there is a dedicated section called "Technical Debt (OMG)", which will show the details (Total, Added, Removed, and No. of occurrences):

Click to enlarge

In the source code view, a Technical Debt (OMG) section is displayed, showing object level details on the Adjustment Factor, Unadjusted Effort (in mins) and Adjusted Efforts (in mins):

Click to enlarge

Tile Sizing and Positioning

All tiles (custom and default) are sized and positioned using a set of options in the tile configuration settings. These options govern how large the tile can be expanded to, how small it can be reduced to, the default size and the default position of the tile on the landing/home page. End users are free to move and resize tiles themselves using drag and drop options - using the Reset homepage option (see Engineering Dashboard) will bring the tiles back to the size and position configured in the tile itself.

The Sizing and Positioning settings are provided via these options in each tile, an explanation of each follows:

  "col": 7,
  "row": 2,
  "sizex": 2,
  "sizey": 2,
  "min-sizex": 2,
  "min-sizey": 1,
  "max-sizex": 4,
  "max-sizey": 5

The landing/homepage is divided into a grid of columns and rows of fixed size. This grid is used to position and size the tiles as follows:

Example optionDescription
"col": 7The upper left corner of the tile is located in column 7.
"row": 2The upper left corner of the tile is located in row 2.
"sizex": 2Defines the size of the tile on the X axis (horizontally) - i.e. the number of columns used by the tile.
"sizey": 2Defines the size of the tile on the Y axis (vertically) - i.e. the number of row used by the tile.
"min-sizex": 2Defines the minimum size of the tile on the X axis (horizontally) - i.e. the minimum number of columns the column can use.
"min-sizey": 1Defines the minimum size of the tile on the Y axis (vertically) - i.e. the minimum number of rows the column can use.
"max-sizex": 4Defines the maximum size of the tile on the X axis (horizontally) - i.e. the maximum number of columns the column can use.
"max-sizey": 5Defines the maximum size of the tile on the Y axis (vertically) - i.e. the maximum number of rows the column can use.
  • No labels