On this page:


Summary: The final step is to generate your Snapshot, which enables you to create data that can be exploited in the Health and Engineering Dashboards. This is achieved using the CAST Management Studio and the Application editor.

Generate the snapshot

To generate a snapshot, you need to use the Execute tab in the Application editor:


A wizard will then be displayed enabling you to set the various date and naming options if required:

Click to enlarge

  • If you are generating a first snapshot during an application on-boarding, CAST recommends that you deactivate the Upload Snapshots to Measurement Service (if configured) option. This will avoid unwanted or incorrect information being uploaded to the Health Dashboard.
  • If this initial snapshot generation is successful you can manually upload the results to the Measurement Service without needing to re-generate the snapshot: see the section below entitled Upload snapshot data to the Measurement Service.

Please note that CAST supports concurrent snapshot generation on the same workstation (whether through GUI/CLI) with the following conditions:

  • only one active execution for a given application/triplet should be run at any one time
  • you should ensure that you configure application/triplet specific values for the following CAST locations:
    • TEMP (User's temporary path)
    • LTSA
    • LISA
    • LOG

This can be achieved by:

  • defining an application/triplet specific Windows environment variable (for example %APPLICATION%)
  • using this Windows variable in the CastGlobalSettings.ini file (ensuring you uncomment the variable in the CastGlobalSettings.ini file)
  • changing the Windows variable path each time you generate a snapshot for a specific application/triplet

For example, set the following in the CastGlobalSettings.ini file:

; Set current user's temporary path
CAST_CURRENT_USER_TEMP_PATH=%APPLICATION%\CAST_TMP

; Set root path of all CAST logs
CAST_LOG_ROOT_PATH=%APPLICATION%\CAST_LOG
 
; Set the default LISA location
CAST_DEFAULT_LISA_DIR=%APPLICATION%\CAST_STORAGE
 
; Set the default LTSA location
CAST_DEFAULT_LTSA_DIR=%APPLICATION%\CAST_STORAGE



Snapshot currently in progress

When a snapshot fails, or when it is cancelled by clicking on the Cancel button when the snapshot is running, this means that the Dashboard Service schema will be left in an inconsistent state. When the Take a snapshot option is next used, a pop-up will be displayed, asking whether you want to continue or delete the snapshot in progress:

You should proceed as follows:

Snapshot warnings

"Application X" needs to be analyzed before taking the snapshot

If you receive the warning displayed above when attempting to generate a snapshot there are two possibilities:

Performance issues when using an Oracle Server host for the CAST AIP schemas

If you encounter performance issues when generating a snapshot using CAST AIP schemas hosted on an Oracle Server, CAST recommends that you consider making the following changes to force the use of the ALL_ROWS optimizer mode instead of the default RULE mode:

globallysharedsettings.ini

Add the following to the globallysharedsettings.ini file: (located here: %PROGRAMDATA%\CAST\CAST\<version>):

ForceOptimizerAllRows=1

CAST-MS.l4j.ini

Add the following to the CAST-MS.l4j.ini file (this file does not exist by default therefore you must create it in the root CAST AIP installation folder):

-Doptimizer_mode=ALL_ROWS

Restart the CAST Management Studio

Restart the CAST Management Studio before you attempt to generate the snapshot again.

Check the snapshot results

The easiest and quickest way to check the results of a snapshot generation is to open the Engineering Dashboard and view your results. If you don't have one set up yet (or your licensing agreement does not allow you to install one), you can invoke the "on the fly" Engineering Dashboard by clicking the Open Engineering Dashboard option in the CAST Dashboard Service editor:

When using the option you will be prompted for credentials to access the dashboard: admin/cast (case-sensitive). Note that this user has the ADMIN role only - see ED - Configuring user authentication.

Tips for checking the results

Detect any third party libraries, generated code or code that is not maintained by the project

Check module weight

Check dead code / Unreferenced functions or methods

Check naming convention (if configured)

Click to enlarge:

Check file volumes

Click to enlarge:

Delete snapshot

If the initial snapshot is not satisfactory, delete it - this will delete it from the Dashboard Service and the Measurement Service (if you chose to upload the results to the Measurement Service):

Upload snapshot data to the Measurement Service for viewing in the CAST Health Dashboard

If the snapshot now contains the information you expect, then you can upload it to the Measurement Service:

Note that the Health Dashboard can officially support the upload of a maximum of 200 applications. CAST recommends that you choose only the most critical applications from the business view point - i.e the applications that need to be monitored with high visibility by CIOs and managers.

Manual upload

You can perform a manual upload of the snapshot you have just generated to the Measurement Service for display in the Health Dashboard:

Automatic upload

When you are generating a snapshot for a subsequent version of the Application (i.e. one that you have already on-boarded), and you are confident that the results of the snapshot generation will be correct (i.e. the new source code changes are relatively minor) then you can upload the snapshot data to the Measurement Service automatically during the snapshot generation using the Upload Snapshots to Measurement Service (if configured) option in the snapshot generation wizard:

Check results in the Health Dashboard

Once the snapshot data has been uploaded to the Measurement Service, CAST recommends that you check the results in the Health Dashboard. However, you may first need to reload the Health Dashboard cache so that results are displayed correctly:

Reload the Health Dashboard cache

The Health Dashboard features a data cache to improve the speed at which data is displayed in the dashboard. This means that when requesting data, the Health Dashboard may return data direct from the cache rather than fetching it from the Measurement Service. This means that data displayed in the dashboard may not be up-to-date - particularly if you have very recently generated a snapshot and uploaded data to the Measurement Service and were expecting to see this new data.

To reload the cache, see HD-ED - Reload the cache

Check the results

Browse to your Health Dashboard, login and check the results:

http://server[:port]/CAST-Health/


See Health Dashboard for more information about using the dashboard