Configuring the Log and Audit Trail

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

Info

Summary: this page explains where the dashboard/RestAPI log files are located, how to change their storage location if required and how to enable the Audit Trail facility.

Default log file location

By default the dashboard/RestAPI will place all relevant log files (i.e. logs relative to the functioning of the dashboard) in the following location:

WAR 1.x
CATALINA_HOME\webapps\<dashboard>\logs

WAR ≥ 2.x
CATALINA_HOME\webapps\<dashboard>\WEB-INF\classes\logs

ZIP ≥ 2.x
<unpacked_zip>\configurations\logs

Logs are provided in two different formats:

Dashboard localization

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

On this page:

Info

Summary: this page describes how to configure the Health Dashboard and Engineering Dashboard to display text in a language other than the default English, i.e. how to localize the dashboards.

Note

The following locales are supported (a green tick indicates a supported locale). All other locales that are added will not be displayed.

Locale	8.3.3	≥ 8.3.4	Notes
English (en_US)	✅	✅	Default locale.
Chinese (zh_CN)	✅	✅	This locale has been fully translated already and is delivered in the WAR from v. 1.10.0.
French (fr_FR)	❌	✅	These locales have note been translated and therefore require manual translation before the dashboard locale can be set to one of them.
German (de_DE)	❌	✅
Japanese (ja_JP)	❌	✅
Korean (ko_KR)	❌	✅
Portuguese (pt_PT)	❌	✅
Spanish (es_ES)	❌	✅
Turkish (tr_TR)	❌	✅

Introduction

By default, the Health and Engineering Dashboards are delivered with language display set to English: all messages and text displayed in the dashboard is only displayed in English. However, it is now possible to set a specific locale and provided that a translation of the default English text and messages has been configured, the dashboards will then display text and messages in the chosen language.

Encrypt login and password for database and LDAP

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

Info

Summary: this page describes how to encrypt logins and passwords for the CAST Dashboards/RestAPI:

when connecting to PostgreSQL (for connections to the Measurement/Dashboard schemas and to the user role/authorization database)
when configuring LDAP authentication

Introduction

When configuring CAST Dashboard / RestAPI connections to PostgreSQL (i.e. Measurement/Dashboard schemas, or user roles/authorizations database) or to an LDAP server for corporate login mode, logins and passwords are defined in the relevant configuration files in clear text. This therefore represents a potential security risk. If your organization requires these logins and passwords to be encrypted, you can use the following instructions to do so.

Error Messages

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

Info

Summary: This page provides an explanation of all the error messages that end-users may encounter when using the CAST dashboards.

Introduction

When using the dashboards, end-users may encounter error messages. This page is designed to provide an explanation about why the error occurred and what can be done to prevent it occurring again. The page is divided into three separate sections:

Error messages for the standalone Health Dashboard deployment
Error messages for the standalone Engineering Dashboard deployment
Error messages for the combined Health Dashboard / Engineering Dashboard deployment

Error messages for the standalone Health Dashboard deployment

Number	Message	Possible solutions
1	You application failed to start due to a "DBMS connections have failed or all domains loading have been aborted" Please contact your administrator for resolution General timeout setting Mon, 01 Jan 0001 00:00:00 +0000 The Dashboard/RestAPI has a general timeout setting, which can be configured when long processes are being run (for example report generation using Report Generator). By default the timeout is set to 15 minutes - i.e. after 15 minutes of inactivity, connections are reset. To edit this timeout, edit following file with a text editor: `WAR 1.x CATALINA_HOME\webapps\<dashboard>\WEB-INF\web.xml WAR ≥ 2.x CATALINA_HOME\webapps\<dashboard>\WEB-INF\classes\application.properties ZIP ≥ 2.x <unpacked_zip>\application.properties` Find the following options and modify as required: Injecting custom tags Mon, 01 Jan 0001 00:00:00 +0000 Info Summary: this page explains how to inject custom tags into the Health or Engineering dashboards. These custom tags can then be used in custom tiles. Injecting custom tags is available in the CAST Dashboard Package ≥ 1.11.0. Introduction CAST automatically applies tags to certain structural rules via the Quality Standards Mapping extension, however, it is also possible to manually inject custom tags, apply them to specific structural rules and then exploit these custom tags in either the Engineering or Health Dashboard via a Custom Tile. Lost password and request access configuration Mon, 01 Jan 0001 00:00:00 +0000 Info Summary: this page describes how to change the template email that is created when a user uses one of the “Can’t access” options on the login screen of the dashboard. If for any reason a user cannot access the dashboard(they do not have a login or they have forgotten their password), it is possible to configure a “Can’t access” link to be displayed on the dashboard login page (by default this link is not enabled - see Health Dashboard json configuration options and Engineering Dashboard json configuration options for more information about enabling this link). Modifying default dashboard text Mon, 01 Jan 0001 00:00:00 +0000 Info Summary: This page explains how to modify default text in the dashboards. Introduction The CAST dashboards use a .json file to define the default text that is used within the dashboards. For example: Click to enlarge: The above text is defined in the .json file: "Total Quality index": "Total Quality index", "Total Quality index measures the global quality level of the application based on all existing technical criteria that are based on our 5 health factors. Sometimes quality rules are linked to multiple technical criteria so that sum of critical violations of TQI is not the same than the sum of critical violations for all health factor.": "Total Quality index measures the global quality level of the application based on all existing technical criteria that are based on our 5 health factors. Sometimes quality rules are linked to multiple technical criteria so that sum of critical violations of TQI is not the same than the sum of critical violations for all health factor.", Modifying the default text Locate the .json files The .json files used to define the dashboard texts are located as follows. Use a text editor to edit the files: Modifying login error messages Mon, 01 Jan 0001 00:00:00 +0000 On this page: Info Summary: This page explains how to modify error messages displayed on login to the Health and Engineering Dashboards. Introduction It is possible to modify the messages displayed in red described below. When a user logs in and the user is not authorized to view any data in the dashboard (for example a new user with no role and no data authorization assigned to it) a message is displayed as follows and further use of the dashboard is prevented. Multiple CAST dashboard installation scenario Mon, 01 Jan 0001 00:00:00 +0000 Info Summary: It is possible to install multiple instances of the CAST dashboards on one unique application server should you require. Note: This section assumes you are using an Apache Tomcat application server. Please also note that the documentation provided in this chapter is provided by CAST with no guarantees. It is not intended to replace any official Apache Tomcat documentation. Please make sure that multiple portals on the same application server are from the same version of the CAST Dashboard Package - it is not recommended to mix CAST dashboards from different versions of the CAST Dashboard Package. Note This documentation is not valid for CAST Dashboard ≥ 2.x where you are using ZIP file deployment. Reload the cache Mon, 01 Jan 0001 00:00:00 +0000 Info Summary: this page explains how to reload the dashboard cache to display the most up-to-date snapshot data. Introduction The CAST dashboards feature a data cache to improve the speed at which data is displayed. This means that when requesting data, the dashboard may return data direct from the cache rather than fetching it from the Measurement or Dashboard Service. In turn, this means that data displayed in the dashboard may not be up-to-date. This is particularly true in the following situations: Removing snapshot data Mon, 01 Jan 0001 00:00:00 +0000 Info Summary: This page explains how to remove snapshot data so that it is no longer available for display. If you need to remove snapshot data, there are two methods you can use: via the CAST Management Studio (GUI mode) via the CAST Management Studio command line (CLI mode) GUI mode To remove snapshot data using the CAST Management Studio GUI, open the Application editor and move to the Execute tab (you can also open the Dashboard Service editor and move to the Snapshots tab): RestAPI authentication using an API key Mon, 01 Jan 0001 00:00:00 +0000 Info Summary: an explanation of how to authenticate with the RestAPI using an API key - primarily to enable the Report Generator to authenticate when SAML mode is active. Introduction If you have enabled SAML authentication mode for your CAST Dashboard/RestAPI deployment, certain CAST features and services will not be able to authenticate to access data, for example: Report Generator Automated actions using CURL (for example cache reload) This is because SAML is designed as a single sign-on mode for browsers and therefore non-browser clients (like Report Generator and CURL) cannot use the protocol. In order to resolve this issue, CAST provides the ability to define an API Key in the CAST dashboards/RestAPI that can be used to bypass SAML authentication.

Advanced configuration options for all Dashboards on Documentation - V2

Configuring the Log and Audit Trail

Default log file location

Dashboard localization

Introduction

Encrypt login and password for database and LDAP

Introduction

Error Messages

Introduction

Error messages for the standalone Health Dashboard deployment

General timeout setting

Injecting custom tags

Introduction

Lost password and request access configuration

Modifying default dashboard text

Introduction

Modifying the default text

Locate the .json files

Modifying login error messages

Introduction

Multiple CAST dashboard installation scenario

Reload the cache

Introduction

Removing snapshot data

GUI mode

RestAPI authentication using an API key

Introduction