Health Dashboard HD on Documentation - V2

Health Dashboard - FAQ

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

What happens in HD for the global Technical Debt if the applications gathered in HD are not configured with the same currency ?

When you consolidate the applications on HD all of them must be of the same currency type. Then that particular uniform currency type could be managed on the tile.

Does HD support Consolidation method of grades (such as based on LoC or Background Facts)?

We only have a simple average of applications and the result would be a simple average on the system level. The results that you see on the HD Dashboard’s homepage is the system level result. For the results based on size - LoC and Total Quality Index, the tile “Application Map” is to be opened so that it can show the results for different applications.

Health Dashboard - Information - Automating the process of reloading server memory cache using Rest API

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

Purpose

It is observed that the results displayed on HD are the ones prior to the latest analysis when snapshot is generated through CLI. To see the latest results the user has to manually refresh them using the “reload server memory cache”.

This page explains how the manual refresh using the “reload server memory cache” can be automated by using Rest-API

Applicable in CAST Version

Release	Yes/No
8.3.x	✅

Applicable RDBMS

Health Dashboard - Information - How to activate SQL traces on AAD and RestAPI logs

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

Purpose

This page contains steps to activate SQL traces on HD and RestAPI logs.

Applicable in CAST Version

Release	Yes/No
8.3.x	✅
8.2.x	✅
8.1.x	✅
8.0.x	✅
7.3.x	✅
7.2.x	✅
7.0.x	❌

Applicable RDBMS

RDBMS	Yes/No
Oracle Server	✅
Microsoft SQL Server	✅
CSS2	✅
CSS1	❌

Details

To activate SQL traces on HD and RestAPI logs in both 7.3.x and versions > 8.0.x, please follow the below steps as per the version of CAST AIP:

Health Dashboard - Information - How to activate the Debug trace on AAD logs

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

Purpose

This page contains steps to activate the debug trace on HD logs.

Applicable in CAST Version

Release	Yes/No
8.3.x	✅
8.2.x	✅
8.1.x	✅
8.0.x	✅
7.3.x	✅

Applicable RDBMS

RDBMS	Yes/No
Oracle Server	✅
Microsoft SQL Server	✅
CSS2	✅
CSS1	✅

Details

To turn on the debug tracing you need to uncomment the following line in the log4.properties file located at <Tomcat_Installation_dir>\webapps<HD/RestAPI Application>\WEB-INF\log4.properties with the following changes:

Health Dashboard - Information - How to add tags and categories from one measurement base to another

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

Purpose

This page provides information about how to add tags and categories into one measurement base from another measurement base within the same postgres server so that the same tags/categories are available in the new HD portal.

This information will be helpful if there is some corruption in the measurement base and it is not opening the HD or if there is another fresh measurement base created and this schema needs the same tags/categories as that of another HD.

Health Dashboard - Information - How to identify SQL query of a specific tile using logs with SQL activated

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

Purpose

This page describes the methodology to identify the SQL query of a specific tile on CAST Application Analytics Dashboard (CAST HD) using logs with SQL activated.

Applicable in CAST Version

Release	Yes/No
8.3.x	✅

Applicable RDBMS

RDBM	Yes/No
Oracle Server	✅
Microsoft SQL Server	✅
CSS2	✅

Details

0 - Specifications related to ADD log with SQL traces activated

In ADD log, some of SQL queries are incomplete. For example in the following query we don’t have the value of “tc.metric_parent_id” and “tc.snapshot_id”

Health Dashboard - Information - How to identify URI request of Simple REST Client related to a specific tile

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

Purpose

This page provides the methodology to identify the URI request of “Simple REST Client” related to a specific tile on CAST Application Analytics Dashboard (CAST HD) using F12 developer tools.

Applicable in CAST Version

Release	Yes/No
8.3.x	✅
8.2.x	✅

Applicable RDBMS

RDBM	Yes/No
Oracle Server	✅
Microsoft SQL Server	✅
CSS	✅

Action Plan

F12 developer tools is a suite of tools to help you build and debug your webpage. The view you see through F12 tools is how the actual way, the Browser Document Object Model (DOM) interprets the page.

Health Dashboard - Information - How to reproduce HD issues

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

Purpose

This page lists the steps involved in reproducing HD Issues.

Applicable in CAST Version

Release	Yes/No
8.3.x	✅
8.2.x	✅
8.1.x	✅
8.0.x	✅

Applicable RDBMS

RDBMS	Yes/No
Oracle Server	❌
Microsoft SQL Server	❌
CSS2	✅

Action plan

Always use a CAST AIP setup installation. For reproducing issues, flat installation is not recommended because the analysis/snapshot may fail. This can be due to files that are missing in the flat installation.
Import the measurement database from the relevant input.
Deploy the HD war provided by the customer. If there is an issue with the customer providing this, you can try to reproduce with the HD war for the associated CAST version, though if the issue is not reproducible it may be due to customized files used by the customer.
Modify the META-INF\context.xml in your deployed tomcat area for the database server and the measurement database name Configuring the CAST Application Analytics Dashboard
Add a user to access the HD dashboard with the role ROLE_ADMIN if one is not configured or if the customer is using active directory (unless the issue is related to specific roles, then you may need to do further configuration as per the issue that is being investigated):Configuring user authentication
Activate SQL traces on HD logs using the steps in the page Health Dashboard - Information - How to activate SQL traces on AAD and RestAPI logs
Reload the application from Tomcat.
Navigate to the page where the issue exists.

In some cases where the issue is during consolidation of a central database, you may have to do the consolidation yourself to observe the issue. To do this, proceed as follows:

Health Dashboard - Information - LDAP connection - Debug free log

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

Purpose

This page gives you a sample of the Debug output from a successful LDAP connection, authentication, and authorization. It has been sanitized to remove some of the LDAP details. This log was generated after activating the Debug mode: Application Analytics Dashboard - HD - Information - How to activate the Debug trace on HD logs

Applicable in CAST Version

Release	Yes/No
8.3.x	✅
8.2.x	✅
8.1.x	✅
8.0.x	✅
7.3.x	✅

Applicable RDBMS

Health Dashboard - Information - LDAP connection - How to get the Distinguished name

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

Purpose

This page provides a definition of the Distinguished name.

Applicable in CAST Version

Release	Yes/No
8.3.x	✅
8.2.x	✅
8.1.x	✅
8.0.x	✅

Applicable RDBMS

RDBMS	Yes/No
Oracle Server	N/A
Microsoft SQL Server	N/A
CSS2	N/A

Details

The distinguished name is the concatenation of the names of the Entry with all the parent entries of the LDAP tree view:

Figure 1

In the above example the user “UserWithGroup1” is part of “ou Users”, the “ou Users” is part of “dc=example,dc=com”, so the DN is the concatenation of “uid=UserWithGroup1” and “ou=users” and “dc=example,dc=com”

Health Dashboard - Information - LDAP connection - How to Import or export a Directory in Apache Directory Studio

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

Purpose

This page provide steps to import or export a Directory in Apache Directory Studio

Applicable in CAST Version

Release	Yes/No
8.3.x	✅
8.2.x	✅
8.1.x	✅
8.0.x	✅

Applicable RDBMS

RDBMS	Yes/No
Oracle Server	N/A
Microsoft SQL Server	N/A
CSS2	N/A

Details

How to Import a Directory in Apache Directory Studio?

Right click on Root DSE, then click on Import > LDIF Import…
Figure 1
Browse to the LDIF file > check the option “Update existing entries” > “Click on Finish”
Figure 2

How to Export a Directory in Apache Directory Studio?

Right click on Root DSE, then click on Import > LDIF Export…
Figure 4

Health Dashboard - Information - LDAP connection - How to Install Apache Directory Studio for Windows

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

Purpose

This page provide steps to install Apache Directory Studio for Windows.

Apache Directory Studio is a complete directory tooling platform intended to be used with any LDAP server however it is particularly designed for use with Apache Directory Server

Applicable in CAST Version

Release	Yes/No
8.3.x	✅
8.2.x	✅
8.1.x	✅
8.0.x	✅

Applicable RDBMS

RDBMS	Yes/No
Oracle Server	N/A
Microsoft SQL Server	N/A
CSS2	N/A

Details

In order to install Apache Directory Studio you need to perform the following steps:

Health Dashboard - Information - Snapshot selection and period start date in AAD

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

Purpose

This page describes one of the behaviors of the HD with respect to evolution(period selected) and snapshot selection

Applicable in CAST Version

Release	Yes/No
8.3.x	✅
8.2.x	✅
8.1.x	✅
8.0.x	✅
7.3.x	✅
7.2.x	✅
7.0.x	❌

Applicable RDBMS

RDBMS	Yes/No
Oracle Server	❌
Microsoft SQL Server	❌
CSS2	✅
CSS1	❌

Details

If you select any other version of the snapshot other than the latest one then you will see that the period start date is incorrect on the tiles as shown below :