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

Summary: this section provides an explanation of the Snapshots section for a given Application.

Introduction

The Snapshots section provides a mechanism to manage Snapshots for the current Application. Once a snapshot has been generated (see Standard onboarding - add a new Version - deliver code - generate snapshot and Advanced onboarding - snapshot generation and validation) it will be listed in this section.

Management options available include:

  • Publish All
  • Rename
  • Consolidate
  • Delete

A Snapshot is a "capture" at a specific moment in time of the status of an Application's source code using a set of measures and rules.

Access the option

Move to the AIP Console screen if you are not already there:

Locate the Application, and select it as highlighted below

Click the Snapshots option in the left hand menu to display a list of snapshots:

Snapshot management screen

This option will loop through all snapshots listed in the screen and any that do not already exist in the Measurement schema will be uploaded. This means that they will be available for consultation in the Health Dashboard.
NameName of the snapshot. This is determined when the snapshot is generated - see Standard onboarding - add a new Version - deliver code - generate snapshot and Advanced onboarding - snapshot generation and validation.
Capture DateCapture date. This is determined when the snapshot is generated - see Standard onboarding - add a new Version - deliver code - generate snapshot and Advanced onboarding - snapshot generation and validation.

Analyzed Version

Name of the source code Version that has been used for the snapshot.

This option allows you to rename an existing snapshot. The snapshot will also be renamed in the Dashboards:

This option will recalculate rule/measure/distribution grades and numbers, and also delta measures for the selected snapshot, and then upload the snapshot to the Measurement schema after having deleted the previous one (if it exists). This can take some time if the Snapshot contains a large amount of data.

This operation can sometimes cause data discrepancies with results computed when the quality model was different. To minimise this, the following items are taken into account when using the Consolidate option:

  • changes in aggregation weights
  • changes in the tree structure (new contributions between a rule and a Technical Criteria, new aggregations, new Technical Criteria etc.)
  • changes in the module weight
  • changes in the thresholds used to compute grades based on rule compliance ratios and distributions
  • changes in critical contributions

Computations executed on the Analysis schema are not taken into account by the Consolidate option:

  • it does not re-analyze the source code
  • it does not re-compute metrics
  • it does not re-run procedures associated with metrics

If you consolidate an older (i.e. not the most recent) snapshot, then the next most recent snapshot will be updated:

  • delta and AEP/EFP metrics are recalculated, and the post process procedures that update schema tables required for dashboards are relaunched.
  • new data is also pushed to the associated Measurement schema

Use this option to completely remove the selected Snapshot from the Dashboard schema and from the Measurement schema (if the snapshot has been uploaded there). This will start the deletion process and can take some time if the Snapshot contains a large amount of data.

If you remove an older snapshot (i.e. not the most recent) then the next most recent snapshot will be updated:

  • delta and AEP/EFP metrics are recalculated, and the post process procedures that update schema tables required for dashboards are relaunched.
  • new data is also pushed to the associated Measurement schema

This option allows you to run an analysis/generate a snapshot. See Advanced onboarding - snapshot generation and validation.
  • No labels