On this page:
Summary: how to update a Model's properties.
Introduction
Each model (whether Architecture or Quality Rule) that is created in the CAST Architecture Checker will be visible in the results as a distinct Quality Rule. A Quality Rule has various accompanying values that determine how its results are viewed in the CAST dashboards. These values can be configured for the rules that result from your models created in the CAST Architecture Checker as follows:
- For Architecture Models the following can be configured:
- ID, name and short description to identify the rule
- Documentation to help end users understand what the rule is checking for
- Weight of the rule
- Whether the rule is critical or not
- For Quality Rule Models the following can be configured:
- ID, name and short description to identify the rule
- Weight of the rule
- Whether the rule is critical or not
- Which Technical Criteria the rule is a member of
- Technology scope for which the rule will be triggered
- Grade thresholds to generate compliance percentages
Note that for Architecture Models the corresponding rule will always be visible in the "Security" Health Factor and "Architecture Models Automated Checks" Technical Criterion:
Configuring model properties
To configure the current model's properties:
A dialog box containing various tabs will then be displayed enabling you to configure the properties:
Click to enlarge
General | ID | MANDATORY A unique identifier for your model must be defined in the CAST Architecture Checker GUI for all models. This ID is used to identify the Architecture Model throughout the CAST Management Studio and the CAST dashboards (the ID will be saved to a table in the CAST Management Service schema).
| ||||||||
---|---|---|---|---|---|---|---|---|---|---|
Name | The name of the corresponding rule as it will appear in the CAST dashboards | |||||||||
Description | MANDATORY A description of the model/rule - only displayed in CAST Architecture Checker. | |||||||||
Documentation | MANDATORY Documentation fields for the rule resulting from the model must be filled in:
| |||||||||
Technical Criteria | For Architecture Models | For Architecture Models the following can be configured:
| ||||||||
For Quality Rule Models | MANDATORY For Quality Rule Models the following can be configured:
| |||||||||
Technologies | Only available when working with a Quality Rule Model. This option allows you to select a target Technology for your rule. This choice dictates when the rule is triggered during an analysis:
| |||||||||
Grade Thresholds | Only available when working with a Quality Rule Model. This option allows you to set specific Grade thresholds (grades are visible in the Health Dashboard) to generate compliance percentages for the corresponding rule: Note that thresholds should be descending (from grade 4 to 1) and cannot be set to negative values. Errors will be displayed if these configurations are attempted: |
Saving updated properties
When you have completed the properties updates, ensure you save the model (see Toolbar).
When can I see the updated properties in the CAST dashboard?
Results will be available in the CAST dashboards when a snapshot is generated that contains the rules that correspond to the models you have creatd, for example for an Architecture Model rule:
Click to enlarge
What happens if I open an Architecture Model that was created with a previous release of CAST AIP?
If you open an Architecture Model created and saved with a previous release of CAST AIP (≤ 8.3.0), then you may be warned as follows:
This means that the Architecture Model was created with an older release of CAST AIP that did not include the ability to set Properties on the model. As such, the CAST Architecture Checker has initialized these Properties in the Architecture Model with default values. These default values may not correspond to the values you may have set in the CAST Management Studio and therefore may impact results when the Architecture Model is used in an analysis.