Summary: step-by-step instructions for upgrading to the new release of CAST AIP. Unless otherwise specified, CAST Server Manager must be run from the new release of CAST AIP.
Step 1 - Run the CAST Server Manager tool
Run the CAST Server Manager tool from the new release of CAST AIP in the Windows Start menu (you can also find it in the CAST AIP installation folder - called servman.exe):
The Open Server Connection Profile dialog will then be displayed allowing you to connect to the RDBMS server hosting the CAST AIP schemas you wish to upgrade. A connection profile to a CAST Storage Service will be available in the dialog box if, during the installation of the new release of CAST AIP, a CAST Storage Service was detected on the current workstation:
If no connection profiles are available a message will be displayed as shown below. Please create a new connection profile to the CAST Storage Service on which the CAST AIP schemas you wish to upgrade are installed:
Select the profile you require and click Open
Step 2 - Upgrade combined installation
This step describes the upgrade process for upgrading:
- The Management Service schema
- All associated Analysis and Dashboard Service schemas
- All associated Applications
- All associated Assessment Models
- Associated Delivery folder
- Optionally upgrading existing and/or installing new Extensions
Note that this step must be repeated for each Management Service schema and associated items that you would like to upgrade.
Open CAST Server Manager as detailed in Step 1. CAST Server Manager displays all the upgradable Combined Installations located on the host RDBMS under the Combined Installations (Out-of-date) node. In the image below, the highlighted set of CAST AIP schemas (installed as part of a Combined Installation) has "Upgrades Available", indicating that they can be upgraded:
- Select (in the left hand panel) the root item of a set of schemas (installed as part of a Combined Installation) that you would like to upgrade and then click Schema Installation > Upgrade Installation:
- The wizard "Select Extensions to install" is then displayed:
- You now need to choose the Version of the Extension you would like to upgrade/install. To do so use the drop down list in the Version column:
- extensions shipped with CAST AIP and not already installed will be pre-selected for installation and it will not be possible to change this
- any previously installed extensions will not be automatically selected for upgrade, even if a more recent version of an extension is shipped with the new release of AIP or has been downloaded to the workstation manually. To benefit from latest improvements and bug fixing in the most recent extension version, you need to explicitly select the new release of the extension for upgrade
- if you see the <all users dir> option this indicates that custom legacy Universal Analyzer language packs exist in <CAST_ALL_USERS_PATH> and will be installed as part of the upgrade process (see also related note in Preparing for upgrade).
- Any additional extensions that your selected extension requires (i.e. Dependencies) will also be selected for upgrade/installation automatically:
- Once all required extensions have been selected for installation/upgrade, click the Next button to continue.
- The wizard Assessment Model Upgrade Options is then displayed. You will be asked to choose an option with regard to the handling of the Assessment Model during the upgrade - note that no option will be pre-selected so you MUST choose an option that meets your needs (see Preparing for upgrade for an explanation of the available options):
- Accept the warning and summary dialog boxes and let the upgrade proceed:
- On completion, the Combined Installation is now displayed as up-to-date:
- The update of a Management Service schema will be cancelled if one of the Analysis or Dashboard Service schemas associated with the respective Management Service schemas is invalid, unreachable or already updated. In this situation CAST recommends restoring your backup database/schemas and starting again.
- The above upgrade process will retain your existing CAST AIP global license key for use with the new release of CAST AIP.
Logs and error numbers
All logs associated with the combined schema installation upgrade are stored in the following location by default:
The following section lists the error numbers that may be returned when attempting to run the upgrade:
|3001||An attempt was made to upgrade Application schemas that were installed with a version of AIP Core ≤ 7.3.x. This is not supported.||Ensure that all Application schemas involved in the upgrade are installed with AIP Core ≥ 8.3.x.|
|3002||An attempt was made to upgrade Application schemas in which no snapshot exists.||Ensure that at least one Snapshot exists in the Application schemas you want to upgrade.|
|3003||An attempt was made to upgrade Application schemas where not all schemas are installed with the same release of AIP Core.||Ensure that all Application schemas involved in the upgrade are installed with the same release of AIP Core.|
|3004||The Application schemas you want to upgrade have no Delivery folder defined.||Only occurs when attempting to upgrade from AIP Core 7.0.x, which is not supported.|
The Delivery folder associated to the Application schemas you want to upgrade cannot be found on disk or is not accessible.
|Ensure that the Delivery folder associated to the Application schemas you want to upgrade exists and can be accessed from the server you are running the upgrade on.|
|3006||The Delivery folder associated to the Application schemas you want to upgrade is more recent than the current release of CAST Server Manager you are using.||Ensure that you are using the correct release of CAST Server Manager to perform the upgrade and that you are not attempting to perform an upgrade on a Delivery folder that is assigned to a more recent release of AIP Core|
|3007||An error exists in the AIP Core metamodel that is preventing the upgrade from proceeding.||Please contact CAST Support for help with this error.|
|3008||An SQL error has occurred during the upgrade process.||Please contact CAST Support for help with this error.|
CAST provides a dedicated batch file that can automate the upgrade of a combined installation including AIP core and extensions. You can find out more about this in Automating the CAST AIP Upgrade process. Ensure you have read Preparing for upgrade and completed any required actions before using the batch file.
Step 3 - Upgrade the CAST AIP Measurement Service schema
This step describes the upgrade process for upgrading the Measurement Service schema used with the Health Dashboard.
Note that a CAST AIP Measurement Service schema can be identified by the value "Measurement Base for General purpose" in the column "Installed Product". If the Measurement Service schema was installed as part of a Combined Installation (with other CAST AIP schemas), the schema name will end with "_measure".
- Run CAST Server Manager as detailed in Step 1
- CAST Server Manager displays all the CAST AIP Measurement Service schemas located on the host CAST Storage Service under the Measurement Services node. In the image below, the highlighted Measurement Service has "Upgrades Available", indicating that it can be upgraded:
- Select the Measurement Service and then click Schema/Database Installation > Upgrade Installation:
- Accept the warning and summary dialog boxes and let the upgrade proceed.
- On completion, the Measurement Service is now displayed as "Up To Date":
- Run the following command line for CAST Server Manager (servman.exe):
- Where C:\some_file.xml contains the following, adapted to your environment (change all items surrounded by [ ... ]):
- A connection profile is required to use the CLI, therefore you may need to run CAST Server Manager in GUI mode and create one if none is available.
- You can find out more information about the CAST Server Manager CLI in Automating CAST Server Manager installation tasks.
Please see Post upgrade action items for information about what to do next.