Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 16 Next »

Summary: information about AIP Console Architecture Studio.

What is it?

The Architecture Studio is feature in the AIP Console that provides a means to manage Architecture Checker/Quality Rule models, templates and libraries for specific Applications or all Applications managed in AIP Console. Models are divided in to two categories:

  • an Architecture Model that allows you to:
    • Define the contents of Layers/Sets in terms of objects resulting from a CAST AIP analysis / snapshot generation
    • Define authorizations (forbidden or allowed depending on the choice made when creating the Model) between layers
    • Check your model in "live" mode against the results of a snapshot that has already been generated to get an idea of the "violations" of the Architecture Model that may exist
    • Re-use the Model: when your application or set of applications is then analyzed, the Architecture Model will be taken into account
    • Re-view the results and information in the CAST Engineering Dashboard as a default Architecture Checker "rule". Violations of the Architecture Model are reported as violations to this default rule. The rule will contribute to the Architecture Models Automated Checks Technical Criterion, which in turn contributes to the Security Health Factor/Business Criterion:

  • a Quality Rule Model that allows you to: 
    • Define two default Sets:
      • Scope (the scope of objects that will be tested)
      • Violations (the objects that appear in results as violations)
    • Define the contents of these Sets using additional sets and dependencies between them
    • Check the model in "live" mode against the results of a snapshot that is already generated to get an idea of the "violations" of the Quality Rule Model that may exist
    • Publish the Quality Rule Model as a CAST AIP extension - you can then include this extension in the next analysis/snapshot
    • Review the results and violations in the CAST Engineering Dashboard

Models can be:

  • created from scratch in the AIP Console
  • applied from a set of predefined templates available in the AIP Console
  • saved as custom templates for re-use
  • imported as files that have been created in the end-user application CAST Architecture Checker.
  • attached to Applications for inclusion in an analysis (see Application - Config - Architecture) if they are Architecture Models
  • exported as extensions if they are Quality Rule Models

The library is used to store layers and sets for re-use in custom models/templates.

Accessing the Architecture Studio

Login with a user account that already has the Admin or Application Owner role and switch to the Architecture Studio:

Alternatively, you can browse to the following URL - modify the URL for your own environment:

http://<server>:<port>/ui/index.html#/ac-studio

Available options

The Architecture Studio is divided into specific sections, each explained below:

Click to enlarge

Section 1 - Choose a Model type

This section enables you to switch between managing the different types of Model supported in the Architecture Studio:

  • Architecture Models (default selection) > to manage models that check for violations of architecture
  • Quality Rule Models > to manage models that can be exported as installable extensions to contain custom rules 

Section 2 - Misc

Create

This option enables you to create a brand new Model using the interface available in AIP 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:


Authorized / Forbidden
Only applicable when creating an Architecture Model.

Choose the type of model you would like to create:

  • a model defining Authorized links between layers - i.e. links between objects that are authorized
  • a model defining Forbidden links between layers - i.e. links between objects that are forbidden

Authorized model type

  • When two layers have no links between them in the model and in reality there are links, then a violation will be reported.
  • If a link between two layers is created in the model, then no violations will ever be raised regardless of whether in reality links exist or not.

Forbidden model type

  • When two layers have no link between them in the model, whatever the reality is, no violations will be reported.
  • Violations will be reported only when a link between two layers is created in the model and in reality the link exists.
NameEnter a name for the model.

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

Upload

Use this button to import a Model created with the end-user application CAST Architecture Checker (i.e. a .castarchitect file or a .castrule file). The model will  be displayed in the list. Imported models are stored in the following location:

%PROGRAMDATA%\CAST\AipConsole\AipConsole\upload\architecture\models


  • If you receive the following errors when uploading a .castarchitect/.castrule file, it is likely that the selected model is invalid in some way. This needs to be corrected before the model can be imported.

  • If an existing model already exists with the same file name as the model being imported, a warning will be displayed, which also provides options to choose whether to overwrite the existing file or provide a new file name:
    • If Overwrite is selected, then the existing model will get overwritten with the imported model.
    • If Rename is selected, a new file name must be entered and the model will be imported with this new file name

Update Library

This option will force AIP Console to check with CAST Extend to see if a more recent release of the Architecture Library extension is available and if it is, to download it immediately. This extension provides model templates and predefined layers and sets. By default, AIP Console will be shipped with a specific release of this extension, however, the extension has its own lifecyle and there may be a newer release available than the release shipped with AIP Console. This Update Library button therefore allows you to check if a more recent release is available for use.

If AIP Console is already using the most recent release:

If a more recent release if available:

Hide/show templates

This option toggles the display of Section 2 - Templates. By default the section is hidden.

Click to expand

 

Section 2 - Templates

See AIP Console - Architecture Studio - Templates. Note that by default this section is hidden:

Section 3 - Existing Models

See AIP Console - Architecture Studio - Existing Models.

  • No labels