|Quality Rule Model|
|Use this to search for a specific model. Search will be performed on the file name and/or the ID of the model. The list of models will be filtered based on the search term entered.|
This option is used to select a context when running a Check a model on a specific model using the check icon:
The drop down list will display a Global context option by default (when set to Global, the check icon will not be available) and then a list of all Applications that are being managed in Console. Selecting a specific Application will enable the check icon and allow you to perform a check against the selected Application using the selected model.
The context selected here will be replicated in the Model editor (although this can be changed in the editor):
Technically, selecting an application will load the appropriate metamodel and use this in the check process. The Global context is therefore simply to allow the creation of a model for no particular application.
Only available when working with Architecture Models.
This option filters Architecture Models that are set as critical via their properties - see AIP Console - Architecture Studio - Model editor.
|Metric ID||A unique identifier for your model. This ID is used to identify the Model throughout the CAST dashboards.|
Name of the existing Model that can then be attached to a specific Application/version for inclusion in the next analysis - see Application - Config - Architecture for Architecture Models. Rolling your mouse pointer over the name of the model will reveal the Description assigned to the model:
Name of the .castarchitect/.castrule file name assigned to the model. Files are stored in the following location:
≥ 2.x \\share\Public\aip-node-data\common-data\upload\architecture\models 1.x %PROGRAMDATA%\CAST\AipConsole\AipConsole\upload\architecture\models
|Last Modified||Displays the date the model was last modified. For imported Models that have not been subsequently modified in Console, the date the model was imported will be displayed.|
Only available when working with Architecture Models.
Displays the Weight applied to the corresponding rule. This value defines how "important" the rule is in the parent Technical Criterion "Architecture Models Automated Checks". See AIP Console - Architecture Studio - Model editor for more information.
Displays the date the model was last published as an extension. See AIP Console - Architecture Studio - Publishing models.
This icon indicates that the model has been modified since the last time it was published. You can re-publish it to generate a new extension containing the changes to the model.
Create a Model from scratch in Console
This option enables you to create a brand new Model/Library Component using the interface available in Console. Choose the configuration settings for the new model, then click OK to start the editing process - see AIP Console - Architecture Studio - Model editor for more information: Choose the type of model you would like to create: Authorized model type Forbidden model type Note that you can also create a model using a Product or user-defined template as a starting point. Use the following icon in the Templates section. See also Create an Architecture Model from a template
Authorized / Forbidden Name Enter a name for the model/Library Component.
Choose the type of model you would like to create:
Authorized model type
Forbidden model type
Note that you can also create a model using a Product or user-defined template as a starting point. Use the following icon in the Templates section. See also Create an Architecture Model from a template
Check a Model
The Console can run a check of your Model against the current Application (ensure you choose an application in the drop down context list) so that you can see any violations of the current Model. A snapshot is required, but the Model does not need to have been "attached" to a specific Application/version or published as an extension for the results to show:
Results of the check will be shown as below - each violation of the rule is shown in one row of information (the example below is for a model that forbids a dependency from Java client code to SQL database code):
Click to enlarge
Information about the results:
|Caller layer||The name of the Layer in the model the caller object belongs to.|
|Caller name||The name of the caller object|
|Caller type||The caller object type.|
|Caller path||Full path to the caller object.|
|Callee layer||The name of the Layer in the model the callee object belongs to.|
|Callee name||The name of the callee object|
|Callee type||The callee object type.|
|Callee path||Full path to the callee object.|
|Link type||Type of link between the two objects.|
A tick in this column indicates that the link is a Dynamic Link (see Validate Dynamic Links).
|Specific piece of code on the caller side in which the link to the callee object is defined. To view the code, select the link in the list.|
Note that ≥ 2.0.0-funcrel includes the ability to cancel the check action if the action takes too long to complete: after 30 seconds have elapsed, the close editor icon will be enabled, allow you to cancel the action:
Run a check on part of the model
It is possible to run a check on part of the model (e.g. specific Layers or Sets) rather than the entire model. To do so, select the Layers/Sets you want to check using the CTRL key and the mouse - a green dashed border indicates the selected items:
Click the Check Model button to start the check:
Results are displayed directly in the viewer with the number of matched items updated and any violations are also displayed:
Note that the yellow dashed border indicates that these layers (that were selected for the partial check) involve dependent sets.