Engineering Dashboard User Guide on Documentation - V2

Engineering Dashboard - Connection - login - logout

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

Info

Summary: This page provides instructions for connecting to the Engineering Dashboard and the login and logout options.

Connecting to the Engineering Dashboard

To connect to the Engineering Dashboard, browse to the URL provided to you by your CAST Administrator. This will usually be in the following format:

http://<server>:[<port>]/CAST-Engineering

The login page will then be displayed:

Access from the AIP Console

Accessing the Engineering Dashboard from the AIP Console is simple - click the appropriate icon:

Engineering Dashboard - GUI

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

Info

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

Multiple Applications or single Application?

On login, depending on the number of Applications available, behavior will differ:

Number of Applications	Behavior
Single Application	You are taken direct to the Application landing page since there are no other Applications available: Click to enlarge
Multiple Applications	You are offered a choice of which Application to access since there are multiple Applications available: When the Application is selected, you will be taken direct to the selected Application’s landing page. If you are not authorized to access the selected Application due to a data authorization rule, a " You are not authorized to access any applications" message will be displayed. If you would like to choose different Application, you can do so using the dropdown list box located on the menu bar: Click to enlarge If you cannot locate the Application you require, you can use the search field to search for the Application - the search is instant - entering a single character will start the search mechanism:

Number of Applications

Behavior

Single Application

You are taken direct to the Application landing page since there are no other Applications available: Click to enlarge

Multiple Applications

You are offered a choice of which Application to access since there are multiple Applications available: When the Application is selected, you will be taken direct to the selected Application’s landing page. If you are not authorized to access the selected Application due to a data authorization rule, a " You are not authorized to access any applications" message will be displayed. If you would like to choose different Application, you can do so using the dropdown list box located on the menu bar: Click to enlarge If you cannot locate the Application you require, you can use the search field to search for the Application - the search is instant - entering a single character will start the search mechanism:

Info

Whenever relevant, loading icons will display when data could take some time to fetch/process and/or display.

Engineering Dashboard - Risk Investigation

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

Info

Summary: This page provides instructions for using the Risk Investigation view in the Engineering Dashboard.

Introduction

Accessible from the sidebar menu or by clicking the**Risk Model tile**, this view enables investigation of the application risk from the Assessment Model perspective - moving through Health Measures/Business Criteria, Technical Criteria, Rules/Measures/Distributions right down to the objects in violation.

By default, only Business Criteria that are categorised as Health Measures will be displayed in the dashboard. All other Business Criteria that are NOT Health Measures will not be displayed. You can override this behaviour, to display ALL top-level Business Criteria if required - see Engineering Dashboard json configuration options.

Engineering Dashboard - Application Investigation

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

Info

Summary: This page provides instructions for using the Application Investigation view in the Engineering Dashboard.

Introduction

Info

Note that the Application Investigation view is not available when viewing data from a previous snapshot.

Accessible from the sidebar menu or by clicking theApplication Components tile, this view enables investigation of the objects in the Application. Data is presented in a series of tables on the left and right hand side of the page enabling you to drill down from an Application right down to an individual object within that Application, and view the Rules that those objects have violated.

Engineering Dashboard - Transaction Investigation

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

Info

Summary: This page provides instructions for using the Transaction Investigation view in the Engineering Dashboard.

Introduction

Accessible from the sidebar menu or by clicking an object in the Top Riskiest Transactions tile, this view enables investigation of the transactions in the Application. Data is presented in a series of tables on the left and right hand side of the page enabling you to drill down from aTransaction with a high level of risk (i.e. objects) right down to the Violations themselves.

Engineering Dashboard - Exclusions

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

Info

Summary: This page provides instructions for managing Exclusions in the Engineering Dashboard.

Introduction

The Engineering Dashboard features the ability to Exclude objects from a future snapshot - this can be useful when the object is violating an AIP rule, but is irrelevant:

Info

Note that:

when an object is excluded, it will be excluded in the next snapshot and in all future snapshots.
using the Exclude feature will affect grades when a new snapshot is generated or when a snapshot is consolidated. This is because the violations that are excluded will not be included in the new results. This impact will be seen in the Health Dashboard.
Exclusions are available when viewing data from a previous snapshot, however, the ability to edit Exclusions is only available from the most recent snapshot.

Permissions required to manage Exclusions

Feature	Permission required
To edit Exclusions - i.e. add/remove objects.	Your user login must have the EXCLUSION_MANAGER role.

Info

Notes:

Engineering Dashboard - Education

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

Info

Summary: This page provides instructions for managing the Education list in the Engineering Dashboard.

Introduction

The Engineering Dashboard features the ability to add rules to an “Education list” to highlight specific issues that may not be corrected, but require tracking, monitoring. In essence the Education list:

enables an Architect or Technical Lead to identify the main issues in an Application and add related rules to the list to “educate” his team
the violations associated with the rule in the list may not necessarily be corrected because they may be too costly, however, the Architect or Technical Lead can use the list to explain to his development team the issues that exist (i.e. the violations can be shown) and how to avoid the issues in the future (i.e. by highlighting the associated rule documentation)
Rules in the Education list can be configured so that all NEW violations to the rule are automatically added to the Action Plan when the next snapshot is generated.
links to the Education list can be sent to development team members directly to “share and promote” best practices or how to adhere to specific rules.

Engineering Dashboard - Continuous Improvement

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

Info

Summary: This page provides about the Continuous Improvement feature in the Engineering Dashboard.

Introduction

The Continuous Improvement feature allows you to view details/violations/statistics about the rules that have been selected for Education.

Accessing the feature

To access the feature:

From the Side Menu bar, click the following icon:

The focus will be set to the Education tab when using this icon and you will need to switch to the Improvement tab.

Engineering Dashboard - Report Generation

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

Info

Summary: This page provides instructions for configuring and using the Report Generation feature.

Introduction

The Report Generation feature allows you to generate reports on the fly direct from the CAST Engineering Dashboard interface. Various reports can be generated, however, some require some configuration before they will work.

Info

Changing the language in reports

From ≥ 2.8, reports can be generated in the following languages:

German
Italian
Spanish
French
Chinese

To ensure that reports are generated in one of these languages, ensure that the Dashboard is localized to the chosen language using the User > Change Language menu, then generate a report. Some of the items in the generated reports will then be in the chosen language:

Engineering Dashboard - Search options

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

Info

Summary: This page provides instructions for using the search options in the Engineering Dashboard.

Introduction

The CAST Engineering Dashboard has two search options available for use:

Basic search, providing search on items in the Assessment Model (i.e. rules) and on object names. Results are dependent on the location the search is made.
Advanced search, providing search for objects based on a list of violations. Results are not location dependent.

Each is explained below.

Engineering Dashboard - Exporting data

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

Info

Summary: This page provides instructions for exporting data from the Engineering Dashboard.

Exporting data to Microsoft Excel file format

You can export data to an Excel file format at the following levels:

Risk Investigation
- Health Measures
- Business Criteria
- Technical Criteria
- Rules, Distributions and Measures
- Violations
Application Investigation, Transaction Investigation
- Violations
Action Plan
- Violations
Scheduled and Active Exclusions
- Violations
Education
- Rules
Improvement
- Rules

Info

If there is no data in the table, then the download icon will be disabled.