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 (see below), click either:
- FINISH, any subsequent steps will be skipped and:
- if the Generate a snapshot option is disabled, the version will be added and will appear in the Application - Versions screen.
- if the Generate a snapshot option is enabled, the analysis/snapshot will be actioned immediately.
- NEXT, see Manage Exclusions.
|Version Name||Enter a name for the Version. Default name will be set to: Version-YYYY-MM-DDTHH-MM-SS.|
|Version Date||Enter a date for the Version. Default date will be set to YYYY-MM-DD HH:MM.|
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:
|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.|
|Generate a snapshot|
Choose whether you want to generate a snapshot immediately after the source code is delivered:
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
- 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
- Upload the snapshot to the Measurement schema - results can be viewed in a Health Dashboard
If you do not select this option, you will need to perform all the above actions manually. This is explained more in 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.
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.
Modules in the Engineering Dashboard:
CAST offers these options when creating a new version:
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, a Full Content module will be created containing all your Application source code.
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.