Introduction
The Versions section provides a mechanism to manage successive Versions for the current Application. Among the options available are:
- Edit
- Mark as complete
- Accept
- Set as current version
- Reject
- Purge
- Delete
- A Version specifies the source code of an Application at a given moment in time. New Versions are created when the Application's source code changes and you want to measure these changes.
- If you are using the rapid delivery mode without version history (see AIP Console - Delivery Modes) then only one single version will be listed in this screen. In this mode, versions are not retained. The Add Version button is therefore replaced with the Process button
Access the option
Move to the Console screen if you are not already there:
Click the Versions icon in the left panel to access the Application - Versions page:
Version management screen
| Depending on the delivery mode in use (see AIP Console - Delivery Modes), either the Add version or the Process button will be displayed:
| ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Name | Name of the version. The default name will be set to: Version-YYYY-MM-DDTHH-MM-SS unless changed manually when creating the version. The version that will be used for analysis and snapshot actions (i.e. the "current version") is also flagged with a green icon:
Clicking the version name will show the version details screen. | ||||||||||||||||||||
| Status | Displays the current status of the Version:
| ||||||||||||||||||||
| Date | Date the version was created. | ||||||||||||||||||||
| Based On | Indicates whether the version is based on the previous version - i.e. whether the option Same configuration as previous version was ticked when creating the version meaning that identical settings (options, extensions, modules, etc) were used for the current and previous versions: Click to enlarge
| ||||||||||||||||||||
| Enables you to edit the version. This will take you back to the Add version wizard, where you can run through all options and make any changes you require: Click to enlarge
This option does NOT perform a source code rescan of either the uploaded ZIP or the source code stored in the source folder location (see Administration Center - Settings - Source Folder Location). Therefore changes to source code will not be detected. If you need to change the source code, you should consider performing a rescan, i.e. the following process:
| ||||||||||||||||||||
| Enables you to mark the version as complete - in other words all analyses/snapshots using this version are now fully completed and a new version is being used for analyses/snapshots. This action is only available when at least one snapshot has been run for the version and will make the version read-only. The action cannot be reversed! | ||||||||||||||||||||
| Provides various menu options:
|
Version details screen
Clicking a version in the Version management screen, or clicking the 
icon will display the Version details screen - this screen provides information about the version, primarily enabling the version to be validated and then "accepted" or "set as current version":
Version Report
Click to enlarge
The version report is generated when the source code ZIP file is uploaded during the creation of the version and its aim is to help you validate the version. You can download the results displayed in this section in XML format:
There are two distinct sections:
Alerts
The Alerts section lists any alerts that occurred during the creation of the version and the upload of the source code ZIP - i.e the contents of the ZIP file are scanned and any issues are reported:
Click the + icon to expand the alert message:
Alerts come in various different types (non-exhaustive list):
| Undefined variable | A variable has been discovered in the source code in the source package. Console cannot detect a value for this variable and therefore an alert has been created. |
| Missing project | A reference to a project, library file, folder or resource has been discovered in the source code package. Console cannot detect this specific item anywhere in the source code package and therefore an alert has been created. |
| Missing library file | |
| Missing folder | |
| Missing resource | |
| Please note that if you exclude a folder and subsequently Console finds a reference to the excluded folder, then an Alert will be generated. If you absolutely need to exclude the folder and want to avoid an alert, you can exclude the folder contents only using a specific Regular Expression: For example, you have a subfolder entitled "unittests" that you must exclude, however, other code references this folder and as such an Alert will be generated during the source code scan when the version is created. Use forward slashes around the folder name in your Regular Expression to force Console to ignore the contents of the folder but keep the folder itself: /unittests/ | |
Handling alerts
Alerts generally indicate that the source code is incomplete, that there is a configuration issue or simply that there is something wrong in the source code. If these alerts are not dealt with and the Version is accepted, then there is a risk that the source code analysis will be erroneous or may not even complete. It is up to you to manage these alerts:
- some can be easily fixed by:
- altering the source code package configuration (for example the root folder may be incorrect)
- by including the missing items in the source code ZIP file
- some may be more difficult to fix and you may need to alter your original source code
File Extensions
This section displays a list of files that have been discovered during the creation of the version when the source code ZIP file is scanned. These are the files that will included for analysis:
| File extension | Displays the file extensions discovered by Console. |
| Added files | The number of files with the specific extension that are "new" in the current version in comparison to a previous version (this will always be 0 for new versions). |
Unchanged files | These columns display the number of files with the specific extension that have either been modified or are unchanged in the current version in comparison to a previous version (this will always be 0 for new versions). Console compares the sizes (not the checksum) of files in the current version with those in the previous version - a file is therefore only marked as Modified when its size has changed between the two versions. In some rare cases when a file has actually changed in the current version, but its size is identical to the size in the previous version, it will be marked as Unchanged. |
| Modified files | |
| Removed files | The number of files with the specific extension that are no longer present in the current version in comparison to a previous version. |
| Total files | Displays the total number of files with the specific extension that have been discovered in the current version. |
| Total size(bytes) | The total size (in bytes) of all the files with the specific extension that have been discovered, in the current version. |
Technical information about version delivery failures
Sometimes a source code delivery fails (or is cancelled manually). When this occurs, and depending on the reason for the failure, the version itself may be deleted. Below is a list of events that may cause a version delivery and information explaining whether the version is deleted or not:
| Event | Version deleted | Version retained |
|---|---|---|
If anything fails in the "Prepare new version" step or the delivery is stopped manually |  |  |
| If anything fails in the "Create/attach package" steps or the delivery is stopped manually | | |
| If anything fails in the "Delivering version" step or the delivery is stopped manually | | |
| Delivery strategy configuration | (if the condition is satisfied) | |
