When you first log in, you will be presented with the "landing page". The contents of this page depend on the number of Applications that are present in the Measurement schema. The behavior of the Dashboard differs depending on whether you are looking at a Single Application or Multi Applications.
The Default View drop-down option lets you select two different views in the landing page:
- Standard tile layout using AIP related data
- Tiles using ISO-5055 data generated by the ISO-5055 Index extension (new in ≥ 1.27 / 2.1.0) - see Manual configuration of Dashboard tiles using ISO-5055 data for more information
If snapshot data is available for only one Application, you will be presented with the Single Application landing page - the Application name is displayed at the top as highlighted below.
Following screen is displayed when Default View is selected from the drop-down. Click to enlarge
Following screen is displayed when ISO-555 View is selected from the drop-down. Click to enlarge:
If snapshot data for Multiple Applications is available, you will be presented with the Multi Application landing page:
Following screen is displayed when Default View is selected from the drop-down. Click to enlarge:
Following screen is displayed when ISO-555 View is selected from the drop-down. Click to enlarge:
In either view, the number of applications is highlighted:
To view data for an individual Application, click the "+" button underneath the Health Dashboard and select the one you require. You will then be taken to the Application landing page:
Click to enlarge
Left hand navigation options
|Multi-application level||Single-application level|
In every screen in the dashboard, the icons shown above are displayed. When clicked they will behave as follows:
|This icon will take you back to the "home" page.|
|This icon will take you to the Health Dashboard User Guide page.|
|This icon will take you to the What's new in the Health Dashboard page.|
In every screen in the Dashboard, a username button will be visible displaying the user's username. Clicking the button will display a drop down menu whose contents depends on the role granted to the username (see User roles):
|Role granted to the username||Available options|
If the username has been granted the ADMIN role, then a link to the Tags Administration page will be displayed. See Health Dashboard tag and category management for more information.
By default, the Health Dashboard is delivered with language display set to English: all messages and text displayed in the dashboard is only displayed in English. However, it is possible to choose a specific language locale and provided that a translation of the default English text and messages has been configured (see Dashboard localization), the dashboard will then display text and messages in the chosen language. To do so, click the user menu drop down and select the the Change Language option:
A popup window will then enable you to select the required language - choose the language and click Change:
The dashboard will then reset and text items will be displayed in the chosen language.
By default, when clicking the option, a confirmation message will be displayed prompting the user whether they really want to log out. This confirmation message can be deactivated by the administrator - see Health Dashboard json configuration options.
Note that if SAML authentication is in operation, but no Single Logout service is provided in the IdP, the dashboard can be forced to handle this situation gracefully and display a message explaining what to do:
|Check for update (Only for Admin User)|
Check for update option in the user profile drop down is available for users with the Admin role. It performs a check to see whether the current Dashboard is up-to-date or if a new release is available.
Clicking the Check for update option will display a dialog box showing the current Dashboard version information, and whether a new version is available:
There are various options that enable you to choose what data is displayed in the Health Dashboard:
By default, the CAST Health Dashboard will always display data from the most recent snapshot available for all Applications. In other words:
- When you have multiple Applications, the values you see are an aggregation of the data from the most recent snapshot for all Applications
- When you only have one Application, the values you see are taken from the most recent snapshot of the Application
However, when working at Application level (i.e. you have drilled down from the Multi-application landing page or you only have one Application) you can choose the snapshot data you would like to see by using the dropdown list:
As soon as you select the snapshot, the data in the page will update accordingly.
Assessment Model selector
By default, the CAST Health Dashboard will display data from the default AIP Assessment Model, showing the default Health Measure Technical Criterial when drilling down at single application level:
An additional Assessment Model view is available out of the box, displaying the legacy Best Practices Technical Criteria:
Additional Industry Standards Assessment Models
If your CAST Administrator has installed any of the following Industry Standards index extensions for a particular Application and generated a new snapshot, then additional Assessment Models will be available in the drop down:
Click to enlarge
Module and Technology selector
By default, data from all Modules and Technologies are displayed, i.e there is no module scope selection in place. Module and technology sector is available at single Application level when drilling down into the Health Measures, and Technical Debt (OMG) sections:
If there are many modules, you can search using the search field by entering the required characters - matching is performed on the characters entered, for example, entering "j" will match the following in this example:
Time period selection
By default, at both multi and single application level, the Health Dashboard will display data for the last 12 months for SizingMeasureEvolution tiles (based on evolution) in the Overview section and for all tiles in the Trends section - i.e tiles will display the evolution of the data over the period of time selected:
When selecting a time period, the tiles that will be affected will be shown active, those unaffected by the time period selection will be greyed out:
By default, CAST will automatically assign the Category "Technologies" and the technology "Tags" to your Applications. In other words (and for example), Applications containing Cobol source code will be tagged with "Cobol" in the "Technologies" Category. You can see this in action at multi application level only (click the "+" button to view the filtering categories):
When using the filtering capabilities, results are displayed on an Application basis. So, for example, if you select "ABAP" in the Technologies category, the Health Dashboard will automatically update and display only those Applications that contain that particular Technology:
You can also filter within specific measure information drill down pages at multi application level based on Categories (auto and manually defined). For example!
Note that if your administrator has created a Category and no Applications have been assigned a Tag within that category, when filtering on that Category, the Health Dashboard will display "No values to display" as follows:
Note about tags and categories as tile scopes
It is possible to set a specific tag / category on a specific tile (see Scope under Common plugin parameters in Health Dashboard tile management for more information) as a scope. When a tile has a tag / category defined as a scope, the tile will be displayed regardless of the filter applied. The tag will also be mentioned in the tile itself:
You can filter on one or more tags in the same category:
Or on one or more tags from multiple categories:
Resetting a filter
If you have configured a filter, the easiest way to reset it is to remove the tags one by one by:
- clicking the X button as highlighted below:
- using the Unselect All button:
At single application level, all drill down details pages that list Rule violations include a check box (Only rules with violations) that enables you to filter out any Rules that do not have any violations. This allows you to focus on the information you need:
When the check box is enabled, then, during navigation around the dashboard, the filtering will remain active. Navigating to other pages that show a new list of violations will use the most recent setting applied, even though you might change the Application you are looking at. On logout or page reload, the Only rules with violations setting is reset.
Grouping by critical rules
At single application level, all drill down details pages that list Rule violations include a check box (Only critical rules) that enables you to group together all Quality Rules that are designated as "critical":
Zoom feature for multi column display
At multi application level, when you click specific tiles in the Health Dashboard (for example the default "Robustness" tile (a QualityIndicatorResults type tile)), the drill down details will display one column per Application:
This display can make reading the details of each column very difficult particularly if you have many applications. If this is the case you can select (i.e. hold the left mouse button down and select the Applications you require) a certain number of Applications and the dashboard will zoom into them. In the example below, just two Applications have been selected, resulting in a zoom into six applications:
- the Zoom function is available for the following tiles (see Health Dashboard tile management):
BackgroundFactsResults / BackgroundFactsResult
QualityIndicatorResults / QualityIndicatorResult
SizingMeasureResults / SizingMeasureResult
- a Reset zoom button is visible (highlighted above) to enable you to return to the default view.
Engineering Dashboard drill down
If you are licensed to do so and your CAST Administrator has configured access (see Configure access to the Engineering Dashboard and from the Health Dashboard in Standalone Health Dashboard deployment), you can drill down into the Engineering Dashboard to obtain more detailed information about a specific Application or Quality indicator. There are two ways to do so:
At single application level click any tile to drill down. This will bring you to an Application specific details page. Click the microscope icon as highlighted on the toolbar:
At single application level drill down into any page that contains Quality Rule details, for example click a Health Measure tile such as Robustness. Scroll down to the Risk Profile section, expand a Technical Criteria and then roll your mouse over a Quality Rule and a microscope icon will be displayed (click to enlarge):
Note that the feature works as long as your CAST Administrator has configured access (see Configure access to the Engineering Dashboard and from the Health Dashboard in Standalone Health Dashboard deployment) and regardless of whether you are working with a combined Health Dashboard/Engineering Dashboard war file or separate Health Dashboard and Engineering Dashboard war files.
What happens when you click the microscope?
- A warning will then be displayed, click Leaving to ED to continue:
- The login screen for the Engineering Dashboard (ED) will now be displayed in a new tab.
- Login with the credentials supplied by your CAST AI Administrator if required.
- You will now be taken to the appropriate location in the target dashboard, for example the Rule or the Health Measure, depending on the item that was in focus when you clicked on the microscope icon.
If access to ED has not been configured, or you do not have appropriate licensing to access ED, then a different warning will be displayed:
Dashboard Release Version
The Dashboard release version (in the place of build number) is provided in the bottom right corner of each page in the Health Dashboard. This number can be provided to CAST Support to help troubleshoot any issues you may have.