health dashboard - gui - cast

18
Health Dashboard - GUI Landing page Single Application Multiple Applications Left hand navigation options Username menu Scope selection Snapshot selector Assessment Model selector Additional Industry Standards Assessment Models Module and Technology selector Time period selection Filters Note about tags and categories as tile scopes Combining filters Resetting a filter Violation filters Grouping by critical rules Engineering Dashboard drill down What happens when you click the microscope? Dashboard Release Version Landing page When you first log in, you will be presented with the "landing page". The contents of this page depend on the that are present in number of Applications the Measurement schema. The behavior of the Dashboard differs depending on whether you are looking at a Single Application or Multi Applications. The drop-down option lets you select two different Default View views in the landing page: Standard tile layout using AIP related data Tiles using (new in ISO-5055 data generated by the extension ISO-5055 Index 1.27 / 2.1.0) - see Manual configuration of Dashboard tiles for more information using ISO-5055 data . Single Application If snapshot data is available for only one Application, you will be presented with the - the Application name is displayed Single Application landing page at the top as highlighted below. Following screen is displayed when is selected from the drop-down. Click to enlarge Default View Summary: This page provides a description of the Health Dashboard GUI.

Upload: others

Post on 21-Oct-2021

1 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Health Dashboard - GUI - CAST

Health Dashboard - GUI

Landing pageSingle ApplicationMultiple Applications

Left hand navigation optionsUsername menuScope selection

Snapshot selectorAssessment Model selector

Additional Industry Standards Assessment ModelsModule and Technology selectorTime period selectionFilters

Note about tags and categories as tile scopesCombining filtersResetting a filter

Violation filtersGrouping by critical rules

Engineering Dashboard drill downWhat happens when you click the microscope?

Dashboard Release Version

Landing pageWhen you first log in, you will be presented with the "landing page". The contents of this page depend on the that are present in number of Applicationsthe Measurement schema. The behavior of the Dashboard differs depending on whether you are looking at a Single Application or Multi Applications. 

The drop-down option lets you select two different Default View views in the landing page:

Standard tile layout using AIP related dataTiles using  (new inISO-5055 data generated by the  extensionISO-5055 Index 1.27 / 2.1.0) - see   Manual configuration of Dashboard tiles

for more informationusing ISO-5055 data

.

Single Application

If snapshot data is available for only one Application, you will be presented with the - the Application name is displayed Single Application landing pageat the top as highlighted below.

Following screen is displayed when is selected from the drop-down. Click to enlargeDefault View

Summary: This page provides a description of the Health Dashboard GUI.

Page 2: Health Dashboard - GUI - CAST

Following screen is displayed when is selected from the drop-down. Click to enlarge: ISO-555 View

Multiple Applications

If snapshot data for Multiple Applications is available, you will be presented with the : Multi Application landing page

Following screen is displayed when is selected from the drop-down. Click to enlarge:Default View

Page 3: Health Dashboard - GUI - CAST

Following screen is displayed when is selected from the drop-down. Click to enlarge: ISO-555 View

In either view, the number of applications is highlighted:

Page 4: Health Dashboard - GUI - CAST

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   page.Health Dashboard - Available information - Trends section

This icon will take you to the page. Health Dashboard User Guide

Page 5: Health Dashboard - GUI - CAST

This icon will take you to the  page.What's new in the Health Dashboard

Username menu

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 granted to the username (see ):role User roles

Role granted to the username

Available options

Page 6: Health Dashboard - GUI - CAST

User Configuration

option in the user profile drop down is available only for users with the  It can be accessed by clicking the in the user menu.User Configuration Admin role.  User Configuration option 

Clicking the displays the following screen. The Authorization and Role Management screen has two tabs  and (by default tab is displayed).  option User Configuration Profiles   Users  Profiles Profilelets you to add New Profiles. After adding the Profile, you can assign: Roles, Applications by Name, Applications by technologies, Applications by tags to the selected Profile/s.

Clicking the Users tab displays the following screen. It lets you to  assign profiles  to Users/Groups. 

Page 7: Health Dashboard - GUI - CAST

Tag Administration

option in the user profile drop down is available only for users with the  It can be accessed by clicking the option in the user menu. Tag Administration  Admin role.  Tag Administration  

For details refer: Health Dashboard tag and category management

Change Language

By default, the Health Dashboard is delivered with language display set to  : all messages and text displayed in the dashboard is only displayed in English. However, it is possible to choose a Englishspecific language locale and provided that a translation of the default English text and messages has been configured (see  ), the dashboard will then display text and messages Dashboard localizationin the chosen language. To do so, click the user menu drop down and select the the   option:Change Language

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.

Note that:

changes are browser specific and are stored in the cache. Therefore if the cache is emptied, the language will reset to the default. See .Dashboard localizationonly those languages that are defined for use will be available in the drop down.

Page 8: Health Dashboard - GUI - CAST

Check for update (Only for Admin User)

Check for update option in the user profile drop down is available for users with the It performs a check to see whether the current Dashboard is up-to-date or if a new release is available.Admin role.

Clicking the option will display a dialog box showing the current Dashboard version information, and whether a new version is available:Check for update

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

Scope selectionThere are various options that enable you to choose what data is displayed in the Health Dashboard:

Snapshot selector

Page 9: Health Dashboard - GUI - CAST

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 , the values you see are an of the data from the for multiple Applications aggregation most recent snapshot all ApplicationsWhen you only have , the values you see are taken from the of the Applicationone Application most recent snapshot

However, when working at Application level (i.e. you have drilled down from the or you only have ) you Multi-application landing page one Applicationcan 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 , showing the default AIP Assessment Model Health Measure Technical when drilling down at single application level:Criterial

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 for a particular Application and generated a new Industry Standards index extensionssnapshot, then additional Assessment Models will be available in the drop down:

CISQMIPS ReductionOMG-ASCQMOWASP

Page 10: Health Dashboard - GUI - CAST

For example:

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 , and sections:Health Measures Technical Debt (OMG)

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 for tiles 12 months SizingMeasureEvolution(based on ) in the section and for all tiles in the section - i.e tiles will display the evolution of the data over the period of time evolution Overview Trendsselected:

Page 11: Health Dashboard - GUI - CAST

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:

Filters

By default, CAST will automatically assign the Category " " and the technology " " to your Applications. In other words (and for example), Technologies TagsApplications containing Cobol source code will be tagged with "Cobol" in the "Technologies" Category. You can see this in action at multi application

(click the "+" button to view the filtering categories):level only 

When using the filtering capabilities, results are displayed on an . So, for example, if you select "ABAP" in the Technologies category, Application basisthe Health Dashboard will automatically update and display only those Applications that contain that particular Technology:

Your CAST Administrator can manually add additional categories to enhance the filtering possibilities. Please see Health Dashboard tag and for more information.category management

Page 12: Health Dashboard - GUI - CAST

You can also filter within specific measure information drill down pages at based on (auto and manually defined). For multi application level Categoriesexample!

Note that if your administrator has created a Category and have been assigned a Tag within that category, when filtering on that no ApplicationsCategory, 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 on a specific tile (see under in   for tag / category Scope Common plugin parameters Health Dashboard tile managementmore 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:

Page 13: Health Dashboard - GUI - CAST

Combining filters

You can filter on one or more tags in the same category:

Or on one or more tags from multiple categories:

When applying a scope to a tile, the global filter still applies (except that Applications outside the initial scope are not considered, i.e. if we select to display scores for a specific Vendor, only applications from that Vendor will be displayed after the filter applies).

Page 14: Health Dashboard - GUI - CAST

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 button as highlighted below:X

using the button:Unselect All

Page 15: Health Dashboard - GUI - CAST

Violation filters

At single application level, all drill down details pages that list Rule violations include a check box ( ) that enables you to filter out Only rules with violationsany Rules that . This allows you to focus on the information you need:do not have any violations

Grouping by critical rules

At single application level, all drill down details pages that list Rule violations include a check box ( ) that enables you to group together Only critical rulesall Quality Rules that are designated as "critical":

Zoom feature for multi column displayAt multi application level, when you click specific tiles in the Health Dashboard (for example the default " " tile (a   type Robustness QualityIndicatorResultstile)), the drill down details will display  :one column per Application

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 setting is reset.Only rules with violations

Page 16: Health Dashboard - GUI - CAST

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:

Page 17: Health Dashboard - GUI - CAST

Engineering Dashboard drill downIf you are licensed to do so and your CAST Administrator has configured access (see Configure access to the Engineering Dashboard and from the

 in ), you can drill down into the  to obtain more detailed Health Dashboard Standalone Health Dashboard deployment  Engineering Dashboardinformation about a specific Application or Quality indicator. There are two ways to do so:

Method 1

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:

Method 2

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 section, and then roll your mouse over a Quality Rule and a Risk Profile expand a Technical Criteriamicroscope icon will be displayed ( ):click to enlarge

the Zoom function is available for the following tiles (see ):Health Dashboard tile managementBackgroundFactsResults / BackgroundFactsResultQualityIndicatorResults / QualityIndicatorResultSizingMeasureResults / SizingMeasureResult

a button is visible (highlighted above) to enable you to return to the default view.Reset zoom

Note that:

if you only have one Application, the microscope icon will be visible immediately on drill down from the single Application Overview page.the feature works as long as your CAST Administrator has configured access (see Configure access to the Engineering

 in  ) and regardless of whether Dashboard and from the Health Dashboard Standalone Health Dashboard deploymentyou are working with a combined Health Dashboard/Engineering Dashboard war file or separate Health Dashboard and Engineering Dashboard war files.

Note that the feature works as long as your CAST Administrator has configured access (see Configure access to  in  ) and the Engineering Dashboard and from the Health Dashboard Standalone Health Dashboard deployment

regardless of whether you are working with a combined Health Dashboard/Engineering Dashboard war file or separate Health war files.Dashboard and Engineering Dashboard

Page 18: Health Dashboard - GUI - CAST

What happens when you click the microscope?

A warning will then be displayed, click to continue:Leaving to ED

The for the will now be displayed in a new tab.login screen Engineering Dashboard (ED) 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.

Dashboard Release VersionThe 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.

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: