Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note

Note that:

  • 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 CAST Application Analytics Dashboard - CAST AAD.
  • 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

...

FeaturePermission required

To edit Exclusions - i.e. add/remove objects.

Your user login must have the EXCLUSION_MANAGER role.

...

To access the feature, there are two methods:

Removing violations (objects) from the Action Plan

If you would like to remove an violation that has already been added to the Action Plan, you can do so as follows:

  • Access the Action Plan from the side menu bar, or from the Action Plan tile on the "home" page
  • Select the violation or use the multi checkbox to select all objects under the Quality Rule/Distribution/Measure:

Image Removed

  • Then click the Manage button and select the Remove From Action list option as shown above.
  • All selected violations will now be reset and will no longer be part of the Action Plan.

Updating comments/priority for violations (objects) that are already present in the Action Plan

If you have added specific violations to the Action Plan with a specific priority and comment, you can alter the priority and comments directly, without having to remove the violation from the Action Plan and then re-add it. You can do this from the Action Plan itself:

  • Locate the violation in the Action Plan
  • Select the violation or use the multi checkbox to select all violations you want to update
  • Then click the Manage button and select the Update Actions option:

Image Removed

  • A dialog box will be displayed enabling you to choose a new Priority you want to assign to the violation and edit the comment where necessary:

Image Removed

  • All selected violations will now be updated.

Exploiting the Action Plan via the legacy CED and beta APO

The Action Plan available in the CAST Application Engineering Dashboard is fully compatible (in other words, adding/removing violations in AED will be updated in CED and APO and vice-versa) with the existing Action Plan features available in:

...

From the "home" or landing page, click the default Exclusion tile.


From the Side Menu bar, click the following icon:

Info

The focus will be set to the Actions tab when using this icon - click into the Exclusions tab:


...

Click to enlarge:

Image Removed

Column key

...

Image Removed

...

Image Removed

...

Image Removed

...

Image Removed

...

This check box allows you to manage the object (violation). A Manage button will appear when an object is ticked:

Image Removed

This button allows you to:

  • Update the Comment and Priority given to an object (violation) when it was added to the Action Plan
  • Remove the object (violation) from the Action Plan if the issue has been resolved or you no longer need to remediate the issue
Info

Note that the check box is only visible if your login has the QUALITY_MANAGER role.

...

Priority

...

Displays the priority given to the object (violation) when it was added to the action plan, ranging from:

  • Low
  • Moderate
  • High
  • Extreme

This priority can be modified using the check box and Manage button.

Info
Note that it is possible to modify the name of this column. See CAST-AED - Dashboard wide configuration options in json using the tagType parameter.

...

Displays the status of the object (violation) in the Action Plan:

  • Added
  • Pending
  • Corrected

See the sections in the rows above which explain these statuses in full.

...

The date the object (violation) was last updated - i.e. any of the following:

  • added to the Action Plan
  • comment edited
  • priority/tag edited

...

Image Removed

...

Image Removed

...

Info
Note that all columns are sortable (in ascending/descending alphabetical/numerical order) by clicking the column header.

Adding violations (objects) to the Action Plan

  • Drill down to Violations level in any of the the Quality, Application or Transaction Investigation views
  • A checkbox will be visible in each object description row (highlighted in the image below in red) - if you do not see this checkbox, then your login does not have the correct role:

Image Removed

  • Place a check mark in the checkbox alongside the object that you want to add to the Action Plan - the Add button will then become visible as shown below:

Image Removed

  • Now click the Add button and select the Add the violations to the Action Plan option:

Image Removed

  • Now enter a comment (not mandatory) to annotate the violations (this comment will appear in the Action Plan) and choose a priority (Extreme, High, Moderate, Low) - mandatory - from the drop down list. Click Add to add the violations to the Action Plan:

Image Removed

Info
Note that it is possible to modify the names used for the priorities and the placeholder text used in this dialog box. See CAST-AED - Dashboard wide configuration options in json using the tag parameters.
  •   The violations will then be added to the Action Plan, In this example, we have selected the Extreme priority entered a comment:

Image Removed 

...

  • You can add multiple objects to the Action Plan in one go in two ways:

...

Select the violations you require - the SHIFT key will function if you need to select a range of violations

Image Removed

...

Use the heading row check box to select all the violations to the selected Quality Rule:

Image Removed

  • If there are many violations in the Action Plan, a Show More button will be displayed (this is to improve the performance of the display). You can choose to display more using the various options (+10, +100 etc.). By default an upper maximum of 5000 violations is set when the "All" option is clicked. You can change the upper maximum if required (see the violationsCount option in CAST-AED - Dashboard wide configuration options in json).

Image Removed

  • You can add violations from the Schedule Exclusion List using the Add the related violations to the Action Plan option:

Image Removed



Anchor
exclusions
exclusions
Exclusions

...

Two sub-pages are available in the Exclusion tab:

  • Active Exclusions > Shows violations that have been added to the Exclusion list and a subsequent full snapshot or consolidation action has been processed (therefore the violations are not part of the results of the current snapshot) - i.e. they are actively excluded.
  • Scheduled Exclusions > Shows violations that have been added to the Exclusion list and no full snapshot or consolidation action has been processed yet (therefore the violations still form part of the results of the current snapshot). When a  full snapshot or consolidation action is processed, exclusions in this list will move to the Active Exclusions page.

...

Info

Note that when violations are listed in the Active Exclusions sub page, the total number of exclusions is displayed in blue:

Column key

The following columns are available for both sub-pages:

Image Modified

This check box allows you to manage the violation. A Manage button will appear when a violation is ticked:

Active ExclusionsScheduled Exclusions

This Manage button allows you to:

  • Update the Comment and Priority given to a violation when it was added to the scheduled Exclusion list
  • Remove the violation from the active or scheduled Exclusion list (see CAST-AED - Exclusion management).
  • Add the related violations to the Action Plan (scheduled Exclusion list only)
Info

Note that:

  • the check box is only visible if your login has the EXCLUSION_MANAGER role
  • the Add the related violations to the Action Plan option requires the QUALITY_MANAGER role
Status

Displays the status of the violation in the Exclusion list:

  • To add > the violations has been added to the Exclusion list since the last full snapshot or consolidation action was processed - it will be excluded in the next full snapshot or consolidation action
  • To remove > the violation was previously in the Active Exclusion list and has been manually removed. The violation will be taken into account once again in the next full snapshot or consolidation action and will then move out of the Exclusion list entirely (see CAST-AED - Exclusion management).
Info
Note that this column is only visible in the Scheduled Exclusions list.
CommentDisplays the free text comment assigned to the violation when it was added to the Exclusion list. This comment can be modified using the check box and Manage button.
Quality RuleThe name of the Quality Rule for which the violation has been added to the Exclusion list (violations can appear multiple times in the Exclusion list).
Object Name LocationThe name of, and information about the violation that has been added to the Exclusion list.
Last Update

The date the violation was last updated - i.e. any of the following:

  • added to the Exclusion list
  • comment edited

Image Modified

This icon, when clicked, will take you direct to the Source Code page for the violation in question.

Info
Note that this column is only visible in the Scheduled Exclusions list.

Image Modified

Use this option to export the contents of the Scheduled or Active Exclusion list to an Excel file. See Exporting data to Microsoft Excel file format for more information.

...

  • Drill down to Violations level in any of the the Quality, Application or Transaction Investigation views
  • A checkbox will be visible in each violation description row (highlighted in the image below in red) - if you do not see this checkbox, then your login does not have the correct role:

Image Modified

  • Place a check mark in the checkbox alongside the violation that you want to add to the Exclusion list - the Add button will then become visible as shown below:

Image Modified

  • Now click the Add button and select the Schedule exclusion of the violations option:

...