About the Check Analysis Tool

This topic provides you with more information about the check analysis command used to check if some features are in error.

This page discusses:

Check Analysis Tool
Using the Check Analysis Tool

Check Analysis Tool

Using the Check Analysis Tool

The Check Analysis command enables you to find out if features are in error.

Check Analysis Behavior

There are two ways to access this command:

From the Solve command in the Quality Rules Reuse Section

If the check analysis was closed, a check analysis tab is opened with a rule base associated with a rule set.
If the check analysis is open, and if the volatile rule base associated to the rule set was already in the check analysis (verification with the rule base name), the line associated with the rule base is updated.
If the check analysis is open, and if the volatile rule base associated to rule set was not already in the check analysis (verification with the rule base name), a new line associated with the rule base is added.

From the Check Analysis Command in the Tools Section

If the check analysis was closed, a new check analysis tab opens showing all the rule bases found in the current tab of the loaded representation.

Note: If there is no check in the rule base (or if a volatile rule base is associated with a rule set), the Check Analysis tab does not open.

Check Analysis Icon

The color of the Check Analysis icon differs depending on the rule base status.


Icon	Status
	Not accessible, there is no rule base or Check Analysis is already open.
	No rule base is solved.
	There is at least one failed check.
	All the checks have succeeded.

Check Analysis Reports Window

This section provides you with the description of the check analysis Reports window.

The first column of the table presents a hierarchy of the knowledge objects: profiles, rule bases, linked rule bases or volatile rule bases, rule sets, checks, tuples and objects. It displays an icon showing the assessment quality result, the quality for each object and the object name.

Different parameters have an impact on the icon displayed:

The severity you selected when you created the check. Each object or group of objects located under this check will have the same severity.

Table 1. Default Severity
ID	Weight	Name
0	2	Fatal
1	1	Warning
Note: This can be customized by the administrator.

The assessment ranges allows displaying an icon depending on an assessment quality result range. The default assessment ranges are the following:

Table 2. Default Severity
Range	Description	Associated Color
Corresponds to the range weight.	Helps you recognize the error category.	Helps you make out the error categories.
2 - infinite	Fatal	Red
1-2	Warning	Orange

The Range, Description and Associated Color can be customized by the administrator.

The second column shows the percentage of succeeded objects (for tuples and objects there is no percentage).
The third column contains a description. For profiles, rule bases, rule sets and checks, the description contains the comments you added when creating the check or the URLs and comments you added in Engineering Rules Capture (for TuplesandObject, you can add a comment using AddtupleFailedWithComment and AddTupleSucceededWithComment).

Check Analysis Contextual Menu

This section provides you with the description of the Check Analysis Contextual Menu.

For Rule Bases or Profiles


Contextual Menu	Explanation
Solve	Enables you to solve a rule base.
Report	Enables you to launch an html report.
XML Report	Enables you to launch an XML report.
Save Assessment Result	Enables you to save the result.

Check Analysis Reports Justification

You can enter a justification for a failed check or tuple and change its status to Not failed. This function might prove useful if you know why the check has failed and you do not want to take this reason into account.

To justify a check, click on Justification, enter the justification text into the editor and click the . The icons associated with this check turn green.

Contextual Menu


Menu	Explanation
Create Justification	Enables you to add a justification to the check. All objects under this check receive the same justification. If a justification is defined in a tuple, this justification is replaced by a check justification. The justification is defined in the Justification tab.
Edit Justification	Enables you to edit a justification in the Justification window.
Remove Justification	Enables you to delete a justification when a justification is defined.

Customization

The severity and the assessment ranges can be customized by the administrator. To know more, see the following topics:

Social and Collaborative: Quality and Certification: Quality Rules Configuration.
Installation and Setup: Customize: 3DEXPERIENCE Platform: 3DSpace: Behavior: Data Setup: List of Resource Set IDs: 3D Modeling: Knowledge Default Resources.


Severity	The administrator can modify the default severities customizing the weight and the name. He can add a severity or delete existing ones.
Assessment ranges	The administrator can modify the default ranges customizing the range, the description and the associated color. He can add ranges or delete the existing ones. The associated colors can be the following:
	DARK_RED RED RED_ORANGE ORANGE YELLOW BLUE	GREEN DARK_BLUE PINK WHITE BLACK GRAY
Name of tuples\ objects	The name displayed for tuples and objects can be customized in the check body. let tuple(KWETuple) Typle = ThisCheck.AddNewTuple(False, Object) Tuple.Name = "NewName"
Description of tuples\ objects	The description displayed for tuples and objects can be customized in the check body using the `Description` attribute on the `KWETuple` type. let tuple(KWETuple) Typle = ThisCheck.AddNewTuple(False, Object) Tuple.Description = "Comment"