AIPCONSOLECONTENT
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 10 Next »

Add code

Click to enlarge

To add source code:

  • Drag and drop one .zip or .tar.gz  file containing your source code - or click the upload cloud icon to add a file using a traditional "open file" method
  • If you have configured a source code folder (see Administration Center - Settings - Source Folder Location) you can click the yellow folder to add code directly from this folder - only one folder in the designated path can be selected:

If you want to deliver source code containing:

  • .NET source code: you should ensure that you define the location of the .NET Assemblies which is required for a successful analysis. See Configuring source code delivery for .NET.
  • Maven based source code: you should ensure that you define the location of the Maven repositories so that any associated JAR files can be automatically discovered and that POM dependencies can also be located - which is required for a successful analysis. See Configuring source code delivery for Maven.

When you have made your option choices, click either:

  • FINISH, any subsequent steps will be skipped and:
    • if the Run Analysis option is disabled, the version will be added and will appear in the Application - Versions screen.
    • if the Run Analysis AND the Take a snapshot option is enabled, the analysis/snapshot will be actioned immediately.
  • NEXT, see Manage Exclusions.

Options available

OptionDescription
Version NameEnter a name for the Version. Default name will be set to: Version-YYYY-MM-DDTHH-MM-SS.
Version DateEnter a date for the Version. Default date will be set to YYYY-MM-DD HH:MM.
Backup application
Unticked by default. Selecting the option will cause the Application to be backed up as part of the actions you choose. When adding a new version for a new Application, enabling this option is not necessary since there is nothing to back up. When the option is enabled, some additional processing time is required while the backup completes. Backups are stored in the following location on the relevant AIP Node and can be managed in Administration Center - Applications - Application Details:
%PROGRAMDATA%\AipConsole\AipNode\backup\<application_name>\YYYYMMDDHHMM.zip
Same configuration as previous version
Only available when adding a new version when a version already exists - i.e. a "rescan" scenario. See Application rescan for more information.
Enable Automatic discovery
Only available when adding a new version when a version already exists and when the option Same configuration as previous version (see above) is enabled - i.e. a "rescan" scenario. See Application rescan for more information.
Run analysis

Choose whether you want to run an analysis immediately after the source code is delivered. Technically the Run analysis option also includes an internal step called "Prepare analysis data" step, which allows:

  • Source code to be viewed when validating Dynamic Links
  • Architecture Models results to be checked before generating a snapshot

Standard onboarding

For a Standard onboarding scenario, you should enable this option. Enabling this option includes the following steps that would otherwise need to be manually actioned:

  • Validate the Version - i.e. the delivered source code
  • Accept the Version
  • Set as current version - i.e. the version to be analyzed

Enabling the option will also automatically expose the following options:

Advanced onboarding

For an Advanced onboarding scenario, you should disable this option. This will allow you to work through the process of validating/accepting the version, running an analysis and generating a snapshot as separate steps.

Add modules

This option allows you to choose the Module strategy for your results. Modules are used extensively in the CAST dashboards as a means to configure analysis results into meaningful groups or sets for display purposes - indeed objects cannot be seen in the CAST dashboards if they are not part of a Module. The content of a module is based on source code.

  • Disabling the Run analysis option will hide this option.
  • When you are delivering a new Version of your Application source code (i.e. a Version already exists), and you decide to tick Same configuration as previous version, the option to choose a module strategy is hidden. In other words, the module strategy chosen in the previous version will be retained and used.
  • You can change the selected Module strategy and create user define modules once an initial analysis has run: see Application - Config - Modules.

Modules in the Engineering Dashboard:

CAST offers these options when creating a new version:

Add modules

When selected, you have the choice to create one Module per Technology or one Module per Analysis Unit (see below). However, if you untick the option, one single Full Content module will be created containing all your Application source code.

Per technology

If you select this option, one Module is created per Technology in your Application - these Modules are created as User Defined Modules and can therefore be edited/removed. This option is the default, therefore unless you specifically choose a different strategy, this one will be used. This option causes the Auto generate strategy in Application - Config - Modules to be set to None (Manual Creation). For example:

Per analysis unit

If you select this option, one Module is created per Analysis Unit in your Application - these Modules are created as User Defined Modules and can therefore be edited/removed. This option causes the Auto generate strategy in Application - Config - Modules to be set to None (Manual Creation).  For example:

An Analysis Unit can best be described as a set of configuration settings that govern how a perimeter of source code is consistently analyzed. Analysis Units are automatically created - as such they more often than not correspond to Projects discovered by AIP Console.

Take a snapshot
If you do not see this option, you must enable the Run analysis option.

Choose whether you want to generate a snapshot immediately after the source code is delivered:

Standard onboarding

For a Standard onboarding scenario, you should enable this option - you can also choose a custom name for your snapshot if you do not want to use the default Snapshot-YYY-MM-DDTHH-MM-SS:

Choosing the option includes the following steps that would otherwise need to be manually actioned:

  • Validate the Version - i.e. the delivered source code
  • Accept the Version
  • Set as current version - i.e. the version to be analyzed
  • Run an analysis - source code analysis results are stored in the Analysis schema
  • Take a snapshot - metrics and structural rule data is consolidated in the Dashboard schema - results can be viewed in an Engineering Dashboard
  • Optionally Publish to Health Dashboard - results can be viewed in a Health Dashboard instance
  • Optionally Publish to CAST Imaging - results can be viewed in a CAST Imaging instance

Advanced onboarding

For an Advanced onboarding scenario, you should disable this option. This will allow you to work through the process of validating/accepting the version, running an analysis and generating a snapshot as separate steps.

Publish to Health Dashboard
If you do not see this option, you must enable the Run analysis option.

Choose whether you want to publish the snapshot in the Health Dashboard immediately after the source code is delivered. This option is enabled by default:

Standard onboarding

For a Standard onboarding scenario, you should enable this option.

Advanced onboarding

For an Advanced onboarding scenario, you should disable this option. This will allow you to work through the process of validating/accepting the version, running an analysis and generating a snapshot as separate steps.

Publish to CAST Imaging
  • If you do not see this option, you must enable the Run analysis option.
  • If this option is visible, but is unavailable for selection, this means that a corresponding CAST Imaging instance has not been configured. See Administration Center - Settings - Imaging Settings for more information.

Choose whether you want to publish the snapshot in your CAST Imaging instance immediately after the source code is delivered. This option is enabled by default:

Standard onboarding

For a Standard onboarding scenario, you should enable this option.

Advanced onboarding

For an Advanced onboarding scenario, you should disable this option. This will allow you to work through the process of validating/accepting the version, running an analysis and generating a snapshot as separate steps.

  • No labels