Each model that is used during a snapshot (whether an Architecture Model or a Quality Rule model) will be visible in the results as a distinct Quality Rule. A Quality Rule has various accompanying values/properties that determine how its results are viewed in the CAST dashboards. These values/properties should be configured for the rules that result from your models.
The properties differ depending on the type of model you are working on:
- ID, name, model type and short description to identify the rule
- Documentation to help end users understand what the rule is checking for
- Weight of the rule in the parent technical criterion
- Whether the rule is critical or not
These properties should be populated as follows:
A unique identifier for your model must be defined for all models. This ID is used to identify the Model throughout the CAST dashboards.
Model ID validation
The Model's ID will be validated whenever the model is edited. Therefore, any errors in the ID (such as using an odd number) will be immediately flagged in the GUI:
Updating the Model ID
The Model's ID can be changed directly in the Architecture Studio interface (in v. ≥ 1.18) - previously this was not possible at all. Note that you must ensure that the new ID you choose is not already being used by another Application since this is not validated by Architecture Studio:
|Model type||Indicates the type of model that was chosen when the model was created (authorized or forbidden). This cannot be modified.|
|Name||The name of the corresponding rule as it will appear in the CAST dashboards|
A description of the model/rule (not displayed in the CAST dashboards). This description is displayed in the main list of models when rolling your mouse pointer over the model name (see AIP Console - Architecture Studio - Existing Models:
Documentation fields for the rule resulting from the model:
This option enables you to change the Weight applied to the corresponding rule. This value defines how "important" the rule is in the parent Technical Criterion "Architecture Models Automated Checks". You can select a value between 0 and 9 (both included); a value equal to 0 has the same effect as ignoring the corresponding rule; the default value is 1.
|Consider the rule as critical when computing the grade||This option enables you to choose whether the corresponding rule is set as critical or not, i.e. it allows you to threshold the grade of the parent metric using the grade of the child metric. The default value is "not Critical".|
Quality Rule model
|Model||Metric ID||See table above.|
|Model type||Indicates that the model is a QualityRule model. This cannot be modified.|
|Name||The name of the corresponding rule as it will appear in the CAST dashboards and the name of the extension when published.|
See table above.
See table above.
This section governs which Technical Criteria your new rule will contribute to. You can choose any existing Technical Criteria in the current Assessment Model and then define how the rule contributes:
This option allows you to select a target Technology for your rule. This choice dictates when the rule is triggered during an analysis:
This option allows you to set specific Grade thresholds (grades are visible in the Health Dashboard) to generate compliance percentages for the corresponding rule:
The thresholds should be descending (from grade 4 to 1) - errors will be displayed if these configurations are attempted: