On this page:
- Consumers of the information (i.e. those that will be using the Engineering Dashboard)
- CAST AI Administrators
Summary: This page provides instructions for managing Exclusions in the Engineering Dashboard.
The Engineering Dashboard features the ability to Exclude objects from a future snapshot - this can be useful when the object is violating an AIP Quality Rule, but is irrelevant:
- 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
To edit Exclusions - i.e. add/remove objects.
Your user login must have the EXCLUSION_MANAGER role.
- Roles can be assigned at user level (when using Default Authentication mode) or via user or group (when using Standard LDAP authentication). Please see ED - Configuring user authentication for more information.
- You can view Exclusions in read-only mode if your user login has not been assigned the required role.
Accessing the feature
To access the feature, there are two methods:
|From the "home" or landing page, click the default Exclusion tile.|
|From the Side Menu bar, click the following icon:|
The focus will be set to the Actions tab when using this icon - click into the Exclusions tab:
|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 Health Dashboard.|
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.
You can swap between the two sub-pages using the drop down menu:
Example of Scheduled exclusion sub-page:
Note that when violations are listed in the Active Exclusions sub page, the total number of exclusions is displayed in blue:
This check box allows you to manage the violation. A Manage button will appear when a violation is ticked:
|Active Exclusions||Scheduled 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 remove).
- Add the related violations to the Action Plan (scheduled Exclusion list only)
- 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 - without this role the option will not be available.
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 remove).
|Note that this column is only visible in the Scheduled Exclusions list.|
|Comment||Displays 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.|
|Rule||The 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 Location||The name of, and information about the violation that has been added to the Exclusion list.|
The date the violation was last updated - i.e. any of the following:
- added to the Exclusion list
- comment edited
This icon, when clicked, will take you direct to the Source Code page for the violation in question.
|Note that this column is only visible in the Scheduled Exclusions list.|
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.
|Note that all columns are sortable (in ascending/descending alphabetical/numerical order) by clicking the column header.|
Adding violations (objects) to the Exclusion list
- 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:
- 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:
- Now click the Add button and select the Schedule Exclusion of the violations option:
Note that you can add multiple violations to the Exclusion list in one go:
Note also that if there are many violations, a Show More button will be displayed (this is to improve the performance of the display). If there are many violations in the Exclusion list, 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 ED - Dashboard wide configuration options in json).
Removing violations (objects) from the Exclusion list
If you would like to remove a violation that has already been added to the Exclusion list, you can do so as follows:
- Access the Exclusion list from the side menu bar, or from the Exclusion tile on the "home" page
- Choose either the Active or Scheduled list
- Select the violation or use the multi checkbox to select all violations you want to remove:
- Then click the Manage button (as shown above) and select the Remove From Active Exclusions or Remove from Scheduled List option, depending on which list of exclusions you are working in.
- You will then be prompted to confirm your choice:
- Depending on which list of exclusions you are working in, the following will then occur:
- Active Exclusions > The selected violations will be greyed out in the Active Exclusions list and will also appear in the Scheduled Exclusions as scheduled to remove - 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.
- Scheduled Exclusions > The selected violations will be removed from the Scheduled Exclusions list and will be available for re-selection in the future.
Updating comments for violations (objects) that are already present in the Exclusion list
If you have added specific violations to the Exclusion with a specific comment, you can alter the comments directly, without having to remove the violation from the Exclusion and then re-add it. You can do this from the Exclusion list itself - note though that it is only possible to update comments from the Scheduled Exclusion list.
- Locate the violation in the Scheduled Exclusion list
- 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 Scheduled Exclusions option:
- A dialog box will be displayed enabling you to edit the comment where necessary:
- All selected violations will now be updated.
|Note that if you select multiple violations for comment update and these violations have different existing comments, then the new comment you enter will apply to all the selected violations, replacing the existing comment.|