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

On this page:

Target audience:

CAST AI Administrators

Summary: This document explains how to use the CAST Update Tool (CUT) in GUI mode to bulk upgrade multiple CAST databases in one go. The tool is to be used exclusively in an upgrade context (i.e. when upgrading CAST schemas from one CAST AIP release to another. The CAST Update Tool can also be used in CLI (Command Line Interface) mode (via CUT-CLI.exe): you can find out more about this in Automating CAST Update Tool tasks.


The CAST Update Tool (CUT) is designed to bulk upgrade CAST schemas. It allows the upgrade of one or multiple Management Services and their corresponding Analysis and Dashboard Services from a given version to the latest installed version. This process will upgrade all the associated schemas simultaneously.

Note that the CAST Update Tool does NOT allow you to upgrade a Measurement Service schema. You must instead use CAST Server Manager to do this - see Upgrading to CAST AIP 8.2.x (for the GUI) and Automating CAST Server Manager installation tasks (for the CLI).

Upgrading databases using the Graphical User Interface (CUT.exe)

  • The GUI mode of the CAST Update Tool can be launched from the short cuts present in the Windows Start menu. For example:
    • Start > All Programs > CAST > <version> > CAST Update Tool (CUT)
  • Once the GUI is launched, CUT will attempt to connect to all RDBMS/CSS that are defined in CAST Management Studio Connection Profiles stored on the local hard drive:

  • The CAST Update Tool lists all Management Services and corresponding Analysis and Dashboard Services (multiple Analysis and Dashboard Services attached to the same Management Service are supported) whose version numbers are equivalent to or lower than the version number of CUT.
  • The tool will inspect the cast-ms.connectionProfiles.pmx file (located in %APPDATA%\CAST\CAST\<version>) that describes connections to Management Services and will therefore only list the Analysis/Dashboard Services whose corresponding Management Services are registered in the .pmx file. The tool will list all the services irrespective of their status and version of CAST AIP (same or lower than the version being used) that are declared in the .pmx file.
  • Determine the status of the Services that are listed and select those you would like to upgrade (i.e. those marked not up-to-date) using the check box. The status of a Service can be any of those listed below:
Up to dateSchemas that are up to date with the current version of CAST AIP (i.e. the version of CUT being run)
Not up to dateSchemas that are running in an older version of CAST AIP (i.e. the version of CUT being run) and can be upgraded.
InvalidSchemas that are either running an unsupported version or are incorrectly installed.
UnreachableSchemas that cannot be accessed (due to host RDBMS issues or other network issues)
Invalid ConnectionWhen CUT is not compatible with the way the schemas is configured i.e. the Analysis/Dashboard Service names are different from the Oracle user name used to connect to them (only for Oracle).
LockedThis indicates that the schemas are locked - to unlock them, use CAST Server Manager and right click the locked schemas and then select Troubleshooting > Remove Locks. Once this has been done, click the Update button in CUT and validate the status of the schema.
Note that it is not possible to select an Analysis Service or a Dashboard Service independently. You can only select a Management Service with its corresponding Analysis and Dashboard Services.
  • You will now be asked to choose an option with regard to the handling of the Assessment Model during the update - note that no option will be pre-selected so you MUST choose an option that meets your needs (see explanation in Upgrading to CAST AIP 8.2.x):

  • Click the Update button in the lower right hand corner of the GUI to start the upgrade process. Upon clicking Update a confirmation window appears with details of the Services selected for upgrade:

  • Choose Update if you wish to proceed.
It is highly recommended that you take a backup of all the Services before performing the upgrade since it can help restore to the original state in case the upgrade fails or you choose to abort the process.
  • Upon selecting Yes the below screen appears and the upgrade process starts. If you select No you will remain on the same page enabling you to make a new selection.

Process SummaryShows a summary of the number of updated Services along with the success and failed count.
Updates in progressDisplays the Services currently being updated.
Lower section
Displays the Services currently in the queue waiting to be updated.
The number of updates in progress depends on the number of CPUs of the machine running the process. If, for example, you have a two core/CPU, only two updates can be triggered at the same time and the rest will be queued up next in the stack.
  • Wait until upgrade process has fully completed.
  •  Once the upgrade is complete refer to the Report Status for more details about the upgrade and the status of the Services from the Summary Log:

Options available in the tool

While upgrading, the following features can be used:

AbortUsing this button will stop the current update of the selected Services only after 'Yes' is selected from the confirmation window.
Cancel QueueUsing this button will cancel any pending update jobs.
Safety PeriodUsing this option you can set a time delay between the execution of two updates. This feature is found under the Edit > Options menu where we can set the period to a value in milliseconds. The minimum value for the safety period is 30000ms which is displayed by default and the maximum value can be given to any extent.

Consulting the report, configuration and log files

The configuration files and logs files are stored in the CUT directory (%TEMP%\CAST\CAST\<version>\CUT). The following files are of interest:

  • The complete upgrade report: Report-DD_MM_YYYY-HH_MM_SSS.xml (Errors and upgrade status of the reports)
  • The CAST Server Manager report log-database-descriptor-<SCHEMA>-DD_MM_YYYY-HH_MM_SSS.castlog (same as the CAST Server Manager standard log).
  • The Configuration file database-descriptor-<SCHEMA>-DD_MM_YYYY-HH_MM_SSS.xml (the configuration file is used by CAST Server Manager. One configuration file will exist for each upgraded schema).


  • No labels