Page tree
Skip to end of metadata
Go to start of metadata

Page frame name:

FRAME_PORTAL_FAQ_VIEW

This view is, in fact, a series of different views. They are designed to provide visibility about violations detected in an application from multiple different perspectives.

These views require access to at least one Application.

Layout

Interactive table

This pages uses an interactive table to display data. Interactive tables allow you to sort the data in a more comprehensive manner than simply in ascending/descending order. See the section Interactive tables in Using the CAST Engineering Dashboard.

Usage

To access a list of all available FAQueries views, please navigate to the Easy Access page (FRAME_PORTAL_EASYACCESS_ADG). The available views are as follows:

Project Degradation

  • Reports - New Violations

  • Reports - Count of New Violations

  • Reports - Added Violations Since Baseline

  • Reports - Remaining Violations in updated source code

  • Reports - Count of Remaining Violations in updated source code
  • Reports - 50 Rules with Largest Increase in the Number of Violations

  • Reports - 50 Rules with Largest Increase in the Percentage of Violations

  • Results - 50 Rules with Largest Grade Degradation

Project Improvement

  • Results - Corrected Violations
  • Results - Count of Corrected Violations

  • Results - 50 Rules with Largest Decrease in the Number of Violations

  • Reports - 50 Rules with Largest Decrease in the Percentage of Violations

  • Results - 50 Rules with Largest Grade Improvement

  • Results - 50 Rules with Highest Improvement Opportunity

Note that the column entitled Improvement Gap in the above FAQuery is calculated using the following formula:

Improvement Gap = (Quality_rule_weight * technical_criteria_weight) * (4 - Grade)

Further Information

  • Reports - List of Objects Excluded from Quality Rule Computations

  • Reports - List of Assessment Exceptions
  • Reports - Top Cyclomatic Complexity x High Fan-Out

  • Reports - Top Cyclomatic Complexity x Low Documentation

  • Reports - List of Violated Rules by Technologies

All of the above views can also be accessed from the Easy Access page (FRAME_PORTAL_EASYACCESS_ADG). See Using the CAST Engineering Dashboard for more information about this page.

Usage - Views returning Quality Rules

For the views that return Quality Rules and not Violations ("50 Rules with ..." and "Count of ..."), you can:

  • Click the name of the Quality Rule - this will take you to the Investigation - Quality Model Drilldown where you can view more details about the Quality Rule
  • Select a Quality Rule for Action or Exclusion in the Improvement - Action Plan and Reset the Quality Rule. See below (Miscellaneous section) for more information about this.

Usage - Views returning Violations

For the views that return Violations, you can:

  • Select a Violation for Action or Exclusion in the Improvement - Action Plan and Reset the Quality Rule. See below (Miscellaneous section) for more information about this.
  • Select a Violation and view more detailed information about it (including the source code) using the Violation Viewer.

Miscellaneous

Views returning Quality Rules

The "50 Rules with ..." and "Count of ..." FAQueries return Quality Rules and not Violations. Quality Rules can be present multiple times in the list, depending on the functional purpose of the query.

In this case, the selection for action or exclusion does not process one single violation at a time but all the violations of the Quality Rule involved (for the selected context (i.e., the Application on which the FAQuery is run)). There is therefore no selection status icon displayed. Indeed, the selection relates to many different violations and individual handling of single violations allows having a different selection status for some singled-out violations. An overall status does not make sense.

Note also that when multiple Quality Rules are listed, they can sometimes have different values in the Aggregate Weight column. This is because a Quality Rule that has multiple parents (i.e. Technical Criteria) can have different Aggregate Weights for each Technical Criterion. A non exhaustive list of Quality Rules that have different Aggregate Weights for each parent Technical Criterion is listed below:

  • 630;"Avoid data members that are not private"
  • 652;"Avoid Classes with a High Public Data Ratio (C++)"
  • 2230;"Use of style sheets"
  • 2242;"Avoid direct definition of JavaScript Functions in a Web page"
  • 2592;"Encapsulation compliance"
  • 2642;"Avoid Classes with a High Public Data Ratio (Visual Basic)"
  • 3576;"Avoid declaring public Fields"
  • 3650;"Avoid Classes with a High Public Data Ratio (C# .Net)"
  • 4566;"Avoid declaring Instance Variables without defined access type"
  • 4570;"Avoid declaring Non Final Class Variables with Public or Package access type"
  • 4572;"Avoid declaring Final Instance Variables that are not dynamically initialized"
  • 4602;"Avoid using Fields (non static final) from other Classes"
  • 4612;"Avoid using native Methods (JNI)"
  • 4768;"Avoid Classes with a High Public Data Ratio (JEE)"
  • 6174;"Avoid Classes with a High Public Data Ratio (PowerBuilder)"
  • 7306;"Avoid declaring Inner Classes"
  • 7308;"Avoid using Inner Classes"
  • 7794;"Avoid Classes with a High Public Data Ratio"
  • 8010;"Do not overload the ampersand, comma, logical AND or logical OR operators"

Views returning Violations

In the case of FAQueries views that return Violations, remember that the Violations can be present multiple times in the list, depending on the functional purpose of the query - i.e. the object involved is displayed as many times as the number of Quality Rules it violates - and the Quality Rule can be present multiple times if the parent Business Criterion is different.

In this case, the selection for action or exclusion icon will be displayed for all the Quality Rules that the object in question violates:

Drop down list

Violation and Rule related FAQueries pages now include a drop down box enabling you to select the Business Criterion and view the report from that particular perspective (i.e. this is akin to a filter). The default Business Criterion is the Total Quality Index (TQI).

  • No labels