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

Click to enlarge

To deliver 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.

In a rescan scenario, CAST highly recommends setting the following options as follows:

OptionOption positionDescription
Backup ApplicationENABLED or DISABLED

Unticked by default. Selecting the option will cause the Application to be backed up as part of the actions you choose. This may cause some additional processing time 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%\CAST\AipConsole\AipNode\backup\<application_name>\YYYYMMDDHHMM.zip
Same configuration as previous versionENABLED

This will ensure that your configuration (Modules, Exclusion Rules and Objectives) are identical to the settings used in the previous version, therefore retaining result continuity, although you are free to make changes to Exclusion Rules and Optimizations if you require by clicking the Next button as highlighted below - note that changing other settings in the wizard may impact the stability of your results. In addition, the option Enable Automatic discovery (see below) will be available (and will be enabled).

Click to enlarge

When disabled, AIP Console will create a version ignoring any previous Version settings and options - i.e. as if it was a brand new Version.

Enable Automatic discoveryENABLED
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.
  • When enabled (default position), AIP Console will perform the "code discovery" step and as a consequence, for any new source code added in the new version, new extensions may be downloaded i.e. discovered and force_install extensions (unless a specific Extension Strategy is in place), new packages may be detected and new Analysis Units may be created. Note that new releases of extensions that were used in the previous version will NOT be automatically downloaded, installed and used.
  • When disabled, AIP Console will not perform the "code discovery" step and as a consequence this ensures that the configuration of the new version is identical to the configuration used in the previous version even if new source code has been added in the new version. No new extensions will be downloaded and installed and no existing extensions will be updated.
Run AnalysisENABLED or DISABLED

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 rescan

For a Standard rescan 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
  • Import the Version -"set as current version"

Enabling the option will also automatically expose the following options:

Advanced rescan

For an Advanced rescan 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.

Take a snapshotENABLED or DISABLED
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 rescan

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

  • Validate the Version - i.e. the delivered source code
  • Accept the Version
  • Import the Version -"set as current version"
  • Run an analysis - source code analysis results are stored in the Analysis schema
  • Generate 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 rescan

For an Advanced rescan 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 DashboardENABLED or DISABLED
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 rescan

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

Advanced rescan

For an Advanced rescan 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 ImagingENABLED or DISABLED
  • 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 rescan

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

Advanced rescan

For an Advanced rescan 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