Supported upgrade paths described in this document
To upgrade to CAST AIP 8.1.x (i.e. baseline + Service Pack) please verify that your upgrade path is supported by this document:
|CAST AIP 8.1.x|
|CAST AIP 8.0.x|
|CAST AIP 7.3.x|
CAST AIP 7.2.x
Direct upgrades are not supported. Please upgrade as follows:
|CAST AIP 7.1.0||Please contact CAST Professional Services for assistance in the upgrade process.|
|CAST AIP 7.0.x|
Direct upgrades are not supported. Please upgrade as follows:
|CAST AIP 6.4.x|
Direct upgrades are not supported. Please upgrade as follows:
64-bit Operating System compatibility
CAST AIP 8.1.x is a 64-bit compliant application, therefore you must only use a supported 64-bit Operating System. Please also take into account the following information:
- The Visual Basic analyzer is delivered (in this release) as a 32-bit "application". Please read the section Visual Basic analyzer and 64-bit compatibility in Supported Technologies > Visual Basic.
- If you intend to use a commercial RDMBS to host the CAST schemas, you must take note of the section 64-bit client layer compatibility in Supported Platforms: all end users applications (CAST Enlighten, the CAST Management Studio, CAST Report Center, the CAST Update Tool (CUT) etc.) will require a 64bit client layer or ODBC entry. Therefore, before starting the upgrade to CAST AIP 8.1.x you must do the following:
- Oracle - install a 64-bit Oracle client layer for your target server
- Microsoft SQL Server - create a 64-bit ODBC entry for your target server
- If you have been using the online DB2 UDB analyzer in CAST AIP 7.3.x, then you will need to install a 64-bit client connection layer and configure it as discussed in Validate and configure RDBMS connection for DB2 UDB Analysis Units
Technology specific notes
Upgrades from CAST AIP 7.3.x only
In CAST AIP 8.0.x, CAST introduced a brand new .NET analyzer. Please therefore take note of the following important information regarding the upgrade of Applications containing .NET technologies to CAST AIP 8.1.x from 7.3.x.
In other words, all VB.NET analyses will need to be reconfigured (new packages created and delivered using the CAST Delivery Manager Tool) and run from scratch in CAST AIP 8.1.x. This MUST be done during Phase 3: Generate a new post upgrade snapshot on the latest version - it is mandatory.
If you are actively analyzing T-SQL 7 or 2000 with a previous release of CAST AIP, you cannot upgrade to CAST AIP 8.1.x at this time: the analysis of T-SQL 7 or 2000 is not supported in CAST AIP 8.1.x. Analysis support for T-SQL 7 or 2000 may be provided in a future release of CAST AIP.
CAST Transaction Configuration Center
In CAST AIP 8.1.x, when creating sets in the CAST Transaction Configuration Center, DET and, RET values must be defined for Data Entity sets and Contribute values must be defined for End Point sets. These values replace the single "Default FP value" that was required previously. During the upgrade, the following will therefore occur:
- the "Default FP value" will be renamed to DET
- A RET value will be added to Datafunction sets and will use its default value of 1
- A Contribute value will be added to Transaction end point sets and will use its default value of 1
As a direct result of this, .TCCSetup files that have been created with previous releases of CAST AIP 7.3.x will be reconfigured to include the required DET, RET and Contribute values, as follows:
- If a "Default FP value" has been set in the .TCCSetup file, then this value will be converted into a DET value for both Datafunction sets and Transaction end points sets
- If no "Default FP value" have been set in the .TCCSetup file, then the default DET values will be set instead: 3 for Datafunction sets and 1 for Transaction end points sets
- A RET value will be added and set to its default value (1) for Datafunction sets
- A Contribute value will be added and set to its default value (1) for Transaction end points set
Note that if the file required reconfiguration, it will be saved with a new name: "V8.1" will be added as follows:
- Input file MySETUP737.TCCSetup will be converted and saved to MySETUP737V8.1.TCCSetup in the same folder (if a file with this new name already exists, it will be overwritten with the reconfigured file).
Upgrades from 7.3.x and 8.0.x
Oracle Server 8i
Please note that the extraction/analysis of Oracle 8i is not supported in CAST AIP 8.1.x. If you are actively analyzing Oracle 8i with a previous release of CAST AIP, and you would like to upgrade to CAST AIP 8.1.x there are two possibilities open to you, both of which MUST be done prior to starting the upgrade to CAST AIP 8.1.x:
- You move the corresponding schemas to a supported Oracle Server, then:
- using the CAST Delivery Manager Tool in the previous release of CAST AIP, clone the Version containing the Oracle 8i package
- edit the package referring to the Oracle Schemas and set the package to use the CAST extractor for Oracle option
- repackage the Version
- analyze the Application and generate a new snapshot
- If it is not possible to move the corresponding schemas to a supported Oracle Server, then you need to remove the Oracle Server schemas from the Application:
- using the CAST Delivery Manager Tool in the previous release of CAST AIP, clone the Version containing the Oracle 8i package
- remove the package referring to the Oracle Schemas
- repackage the Version
- analyze the Application and generate a new snapshot
Oracle Server extractions in the CAST Delivery Manager Tool
In CAST AIP 8.1.0 a check box called "ALL Access Mode" has been added to the CAST Delivery Manager Tool, specifically for Oracle Server extractions:
This option is only relevant for those that run extractions with a user that does not have access to the DBA_* Oracle views, and instead can only access the ALL_* Oracle views. In CAST AIP 8.1.0, if the user is accessing the ALL_* views, then this ALL access mode check box must also be ticked otherwise the extraction will fail (please see Required RDBMS rights for packaging a database for more information).
This option was introduced in CAST AIP 7.3.9 and in CAST AIP 8.0.1, and you must explicity tick this check box in the following situation:
- if you are upgrading from CAST AIP 7.3.0 - 7.3.8, or from CAST AIP 8.0.0
- and you use a user that only has access to the ALL_* Oracle views for your extraction in the CAST Delivery Manager Tool
- and you are delivering a new version of your source code following an upgrade to CAST AIP 8.1.x
Failure to tick the check box will cause the extraction process to fail.
Impact of upgrading on analysis results
Please also consult:
- Changes in results post upgrade - 8.1.0
- Case Study - Measurement changes after upgrade for selected customer applications
...which contain information about changes made between previous releases of CAST AIP and CAST AIP 8.1.x, which may impact the results of your post-upgrade snapshot.
The basic workflow for a migration is similar (but not identical) to the workflow used when(i.e. a "greenfield" installation):
Step 1: Prepare the upgrade
Backup existing data
Before starting the upgrade to CAST AIP 8.1.x, CAST strongly recommends that any existing analysis and result data from previous releases of CAST AIP is backed up. You should backup the following items as a basic minimum so that the existing AIP environment can be restored in case an error occurs during the upgrade process.
|Item to backup||How to back it up|
|CAST schemas (Management / Analysis / Dashboard / Measurement (where applicable) Services|
CAST Storage Service 2
Commercial RDBMS (Oracle Server or Microsoft SQL Server)
|CAST Delivery folder|
Please ensure that you make a copy of your Delivery folder - simply by copying the folder to another location on disk (unrelated to CAST).
Check to ensure that you are not using the Oracle system user to connect in the CAST Management Studio
When working with an Oracle Server as the host for the CAST schemas, you must ensure that you are NOT connecting to the Management, Analysis, Dashboard or Measurement Services using the Oracle "system" user. The upgrade process using the CUT tool (see Update process)
- Launch the CAST Management Studio
- In the CAST-MS Database connections manager dialog box (displayed during the launch), change the user used to connect the Management Service (MNGT) from SYSTEM to the MNGT schema user:
- Once connected, update all Analysis and Dashboard Services to change the respective Analysis Service/Dashboard Service schemas user - you will need to enable the Credentials option in the respective Analysis /Dashboard Service editors to override the connection defined automatically that will use the "SYSTEM" user. The example below is for a Dashboard Service:
CAST Transaction Configuration Center - Impact Factor configuration (upgrades from CAST AIP 8.0.x ONLY)
In CAST AIP 8.1.x the stored procedures used to configure Impact Factor (see the CAST Transaction Configuration product help for more information) for Transactional Functions have been renamed as follows
- TCC_EFP_USR_IF_DELETED_RULE --> EFP_USR_IF_DEL_TF_RULE
- TCC_EFP_USR_IF_MODIFIED_RULE --> EFP_USR_IF_MOD_TF_RULE
- TCC_EFP_USR_IF_ADDED_RULE --> EFP_USR_IF_ADD_TF_RULE
This is so that their names are in-line with the stored procedures added in CAST AIP 8.1.x for configuring Impact Factor for Data Functions. By default and to avoid a situation where configurations from CAST AIP 8.0.x are not used following an upgrade to CAST AIP 8.1.s, CAST has included a call to the legacy 8.0.x stored procedures in the new 8.1.x stored procedures, for example:
- EFP_USR_IF_DEL_TF_RULE will call in its code the existing stored procedure from CAST 8.0.x: TCC_EFP_USR_IF_DELETED_RULE
However CAST highly recommends that you take a copy of the scripts in the legacy stored procedures so that you can start using them in CAST AIP 8.1.x in the new stored procedures.
Step 2: Install CAST AIP components
This step corresponds to running the CAST AIP 8.1.0 (baseline) and/or CAST AIP 8.1.x Service Pack setup.exe to create a CAST Administration workstation that will host all CAST end-user applications that you need to setup and/or run the CAST Application Platform. This step is identical to the step described for a greenfield installation.
CAST AIP setup
See Install CAST AIP components. Please take note of the following actions for the various starting points:
CAST AIP 8.0.x
|CAST AIP 7.3.x|
Please pay attention to the following notes before proceeding with this step:
- If the current machine already has a CAST Storage Service 2 installed on it from a previous version of CAST AIP, the CAST AIP 8.1.0 (baseline) installer will detect this and the installation options will be limited. Please use the All Application Intelligence Platform Applications option to install CAST (this does not include the CAST Storage Service 2).
- CAST AIP (baseline and Service Pack) is delivered in a ZIP file that needs to be unzipped to a folder on the CAST Administration workstation. Once unzipped, the setup.exe file can be run to start the installation.
Step 3: Update process
Pre-update check list
Before beginning the update process, please ensure that you have carried out all of the following tasks:
|CAST schema backup|
Before beginning, please ensure that you action a backup of the all CAST schemas that will be upgraded as described in the Prepare the upgrade step.
When updating the CAST schemas on a CAST Storage Service 2, the update process will drop any custom objects you may have created that directly or indirectly use any default Analysis/Dashboard Service objects. As such, if you need to retain these custom objects, please ensure that you have a current backup before applying the upgrade (see above).
|Database access exclusivity|
Ensure that you have exclusive access to the schemas you want to update - i.e. that the schema is not being used by any other user, application (such as CMS) or web portal (such as the CAST Engineering Dashboard/Discovery Portal).
|Check free RAM memory|
Before starting this step, please ensure that you have at least 1GB of free RAM memory on your workstation. If you do not have sufficient free RAM memory, there is a risk that some of the actions described in this step may fail.
|Ensure folder write access for existing PL/SQL extraction data||If your previous version of CAST AIP contains PL/SQL analyses based on offline data extraction, CAST will attempt to upgrade the extraction data so that it is compatible with the current version of CAST AIP and can then be re-analyzed in the new version of CAST AIP. As such, the Windows user that is being used to run the CAST Update Tool (CUT) must have write access rights on the folder containing the offline extraction data.|
|Stop the CAST AIC Portal on the application server|
Please ensure that you STOP the existing deployment of the CAST AIC Portal (using the built in application server management system) before starting the update process.
|Ensure your custom and CAST extensions are compatible (optional)||If you have chosen to install your custom or CAST extensions at the same time as performing the update, you must ensure they are compatible. Please see Prepare the upgrade for more information.|
CAST AIP extension management procedure - optional
CAST AIP extensions installed on CAST AIP 8.0.x
- Windows 2003: %ALLUSERSPROFILE%\Application Data\CAST\CAST\8.1\
- All other Windows versions: %ALLUSERSPROFILE%\CAST\CAST\8.1\
The installed Universal Analyzer extension (language pack) files will be taken into account during the CAST schema update with the CUT tool (described below) and applied to the "triplet" of CAST schemas that you are upgrading.
Beta extensions installed to the CustomPlugins folder on CAST AIP 7.3.x only
If you have installed any CAST AIP "SDK" extensions in beta to the CustomPlugins folder located in the CAST installation folder in CAST AIP 7.3.x, then you will need to do as follows:
- Locate the <CAST installation folder>\CustomPlugins folder in your installation of CAST AIP 7.3.x
- Copy the CustomPlugins folder to the <CAST installation folder> in your installation of CAST AIP 8.1.x (so that you end up with <CAST installation folder>\CustomPlugins in your installation of CAST AIP 8.1.x)
The extension files will be taken into account during the CAST schema update with the CUT tool (described below) and applied to the "triplet" of CAST schemas that you are upgrading.
Please note that in addition, the extensions in the CustomPlugins folder will be moved automatically by the CUT tool to the new default location for extensions:
If "%ALLUSERSPROFILE%\CAST\CAST\Extensions" already contains an extension with the same ID and version as one contained in <CAST installation folder>\CustomPlugins in your installation of CAST AIP 8.1.x, the extension in the "%ALLUSERSPROFILE%\CAST\CAST\Extensions" will be applied by CUT.
Applications hosted by an AIC Portal (CAST Update Tool)
The update process is carried out with the end user application CAST Update Tool (please see Appendix: Using the CAST Update Tool to bulk upgrade CAST databases for more detailed information about this tool).
Accessing the CAST Update Tool (CUT)
- Run the CAST Update Tool (CUT) from your new installation of CAST AIP 8.1.x in the Windows Start menu (you can also find it in the CAST installation folder - called CUT.exe):
- The CAST Update Tool will attempt to locate a CAST Management Studio connection profile (a cast-ms.connectionProfiles.pmx file) on your local machine (located in the %APPDATA%\CAST\CAST\8.1 folder) to connect to all CAST Management Services declared in the PMX file.
If you are upgrading from CAST AIP 8.1.0 (baseline) to CAST AIP 8.1.x (Service Pack) or between Service Packs, a CAST Management Studio connection profile (a cast-ms.connectionProfiles.pmx file) will already exist in the %APPDATA%\CAST\CAST\8.1 folder - as such, CUT will connect to all the CAST Management Services declared in the PMX file. In this situation, please move to the Select what to update section below.
- If you are upgrading from CAST AIP 7.3.x/8.0.x, no CAST Management Studio connection profile (a cast-ms.connectionProfiles.pmx file) file will exist in the %APPDATA%\CAST\CAST\8.1 folder - as such, CUT will display an error message stating that no connection profile can be found (click OK to close it) and will then open with a blank window:
- You therefore need to proceed as follows:
- copy the 7.3.x/8.0.x cast-ms.connectionProfiles.pmx file located in the %APPDATA%\CAST\CAST\7.3 or %APPDATA%\CAST\CAST\8.0 folder
If the current machine does NOT have an existing version of CAST AIP 7.3.x/8.0.x installed on it (for example you are using a new "clean" machine for CAST AIP 8.1.x), you will need to copy the cast-ms.connectionProfiles.pmx file from a machine on which CAST AIP 7.3.x/8.0.x has been installed and paste it over to the machine designated for CAST AIP 8.1.x.
- paste the file into the %APPDATA%\CAST\CAST\8.1 folder (this folder may not yet exist - if it does not, please create it manually)
- in CUT, click File > Open and navigate to the %APPDATA%\CAST\CAST\8.1 folder and select the cast-ms.connectionProfiles.pmx file you copied from the %APPDATA%\CAST\CAST\7.3 or %APPDATA%\CAST\CAST\8.0 folder
- CUT will now connect to all the CAST Management Services declared in the PMX file.
- You therefore need to proceed as follows:
Select what to update
- You should now see all the CAST Management Services declared in the PMX file together with the declared Analysis and Dashboard Services - in the image below we can see one Management Service and an accompanying Dashboard and Analysis Service:
- Now you need to select the Management Service(s) that you want to update - this will automatically select the Analysis and Dashboard Services as well:
Because the Delivery folder is "locked" to a specific version of CAST AIP, when it is updated to the new version of CAST AIP, all Management Services that refer to the same Delivery Folder should be selected together.
However, if you have chosen to update only some of the Management Services that use your configured Delivery folder, the following message will be displayed indicating the Management Services that CUT has detected within the configured Delivery folder:
- If you select OK, CUT will continue with the update of ONLY those Management Services that you selected, and therefore any unselected Management Services will not be updated.
- If you click Cancel, CUT will do nothing and will return you to the list of servers/Management Services.
Note that this scenario is only applicable to those that have MULTIPLE Management Services using one single Delivery folder.
What to do if you do not want to update all applications / CAST Management Services hosted in a given AIC Portal at the same time
As described above, because the Delivery folder is "locked" to a specific version of CAST AIP, when it is updated to the new version of CAST AIP, any Management Services (and Applications managed in them) that have not themselves been selected for update in CUT will no longer be permitted to use the Delivery folder and you will receive the following error in the CAST Management Studio when trying to work with the Applications that have not been updated:
If you do not want to update ALL your Management Services to the newer version of CAST AIP, you have two options:
- You can proceed with the update anyway and ensure that you follow the instructions at the very end of this documentation to comment out any non-upgraded Applications from the index.xml file in the data folder at the root of the Delivery folder (see Deploy the CAST web applications)
- You can create two CAST AIC Portal and two Delivery folders, each containing the Applications you require depending on whether they need to be updated to the new version of CAST or not. Instructions for this are displayed below:
Create two CAST AIC Portal and two Delivery folders
In this scenario, we are migrating from CAST AIP 7.3.x to CAST AIP 8.1.x as an example (but the same applies when updating between CAST AIP 8.0.x Service Packs):
- Ensure that the existing 7.3.x CAST AIC Portal is not running (as specified in the Pre-update check list).
- Deploy a new CAST AIC Portal for CAST AIP 8.1.x (see Installing and configuring the CAST AIC Portal) alongside the existing 7.3.x CAST AIC Portal - ensure you use the CAST-AICP.war file from the new version of CAST AIP.
- Configure a new empty Delivery folder for CAST AIP 8.1.x in the web.xml file of the CAST AIC Portal for CAST AIP 8.1.x
- Stop the new CAST AIC Portal for CAST AIP 8.1.x
- Copy the "plugins" folder from the existing 7.3.x Delivery folder and place it in the new 8.1.x Delivery folder - overwriting the "plugins" folder.
- Copy the "data\index.xml" file from the existing 7.3.x Delivery folder and place it in the "data" folder in the new 8.1.x Delivery folder - there should be no files present in the "data" folder in the new Delivery folder
- Edit the "data\index.xml" file (with a text editor) from the existing 7.3.x Delivery folder to remove references to any Applications you WISH to update to the new version of CAST AIP - this is a fairly simple process whereby you need to remove any entry starting <entry key="<GUID-of-your-Application. There will be around 10 entries for each Application. Save any changes.
- Edit the "data\index.xml" file (with a text editor) from the new 8.1.x Delivery folder to remove references to any Applications you DO NOT WISH to update to the new version of CAST AIP - this is a fairly simple process whereby you need to remove any entry starting <entry key="<GUID-of-your-Application. There will be around 10 entries for each Application. Save any changes.
- Cut and paste any Applications in the "data" folder from the existing 7.3.x Delivery folder to the "data" folder in the new 8.1.x Delivery folder that you WISH to update to the new version of CAST AIP. An Application consists of a folder named <GUID> and a file named <GUID>.entity.xml - where GUID corresponds to the Application:
- Copy the "localpswds.dat" file in the "data" folder from the existing 7.3.x Delivery folder to the "data" folder in the new 8.1.x Delivery folder
- Open a copy of the CAST Management Studio from the existing 7.3.x CAST AIP and connect to ALL Management Services that you intend to update to CAST AIP 8.1.x. Change the location of the "Source Code Delivery Folder" in Window > Preferences so that it corresponds to the location of the new Delivery folder in CAST AIP 8.1.x. Ensure that you UNTICK the Move sources option.
- Finally you will end up with:
- one 7.3.x Delivery folder containing only the Applications you want to retain on CAST AIP 7.3.x
- one 8.1.x Delivery folder containing only the Applications you want to update to CAST AIP 8.1.x
- Now run CUT from your new installation of CAST AIP 8.1.x
- Select only the Management Services that you want to update to CAST AIP 8.1.x.
Strategy for Assessment Model
Before beginning the update process, you must first configure options in the CAST Update Tool using the Edit > Options menu:
|Source Delivery folder||N/A||No action required. CUT will use the locations of the Delivery and Deployment folders that are stored in the selected Management Services.|
|Source Deployment folder|
|Migrate Existing Assessment Model|
This option enables you to choose whether you want to migrate the existing Assessment Model. The migration is performed on the Assessment Model that is stored in the CAST Dashboard Service. There are two choice:
If you have chosen this option, the following Assessment Model values will be retained:
However, even when you choose to preserve your existing Assessment Model, the migration process will necessarily modify some values to make them compatible with CAST AIP 8.1.x, for example:
If you have chosen this option, the new Assessment Model from CAST AIP 8.1.x is used instead and no migration takes place.
|Multi-threading||N/A||Please leave this option at its default unless instructed otherwise by CAST Support.|
When you have made your choices, click OK to return to the CUT main window.
Run the update
Now you need to execute the upgrade on the Management Services that you have selected:
- Click the Update button to start the process
- A summary of the propose update will be displayed:
- Click OK to begin the update process:
- When the process is complete, CUT will indicate this:
- You must:
- ensure that the status is "Successful update" for all CAST schemas, in the GUI as shown in the above example
- also check the log file at the location indicated in the report to ensure that that the update has completed successfully
- The update of a Management Service will be cancelled if one of the Analysis or Dashboard Services associated with the respective Management Service is invalid, unreachable or already updated. In this situation CAST recommends restoring your backup database/schemas and starting again.
- the above process will also transfer your existing CAST license key to the new installation.
Validate the CAST Upgrade Tool execution
Check log files
Please ensure that you thoroughly check the log files in the following location to make sure that the upgrade has indeed completed successfully:
All .CASTLOG files
- Browse to the installation folder for CAST AIP and execute the LogViewer.exe file
- Choose File > Open in LogViewer
- Browse to the location shown above on the machine on which you have run CUT
- Select, in turn, all of the .CASTLOG files located in the folder. These log files correspond to the upgrade process for the Management, Analysis and Dashboard Services.
All .CASTLOG2 files
- Open a Windows command prompt and change directory to the location of the CASTLog2Viewer.exe (this is located in the CAST_install_folder\DeliveryManagerTool folder)
- Use the following syntax to view all the .CASTLOG2 files generated during the upgrade with CUT (you will need to run the command line for each .CASTLOG2 file you want to view.
Query the DSS_HISTORY table to view upgrade results on existing snapshots
You can query the DSS_HISTORY table in the CAST Dashboard Service to view the status of each existing snapshot after the upgrade process has been completed by the CAST Update Tool. Messages will be entered into the table as follows for each snapshot that is handled as part of the upgrade:
- During migration, the CAST AIP version has been updated to <CAST VERSION> for the snapshot <SNAPSHOT_ID>
- During migration, the consolidation mode has been updated to <CONSOLIDATION_MODE> for the snapshot <SNAPSHOT_ID>
Update process for CAST Measurement Service (CAST Server Manager)
The update process for the CAST Measurement Service used by the CAST Application Analytics Dashboard, is (exceptionally) carried out with the end user application CAST Server Manager.
As mentioned already:
- when migrating from CAST AIP 8.1.0 (baseline) to a Service Pack or between CAST AIP 8.1.x Service Packs, this CAST schema does NOT require an update and you can SKIP this section.
- CAST Server Manager must not be used for updating Management/Analysis and Dashboard Services in CAST AIP 8.1.x.
Accessing CAST Server Manager
- Run the CAST Server Manager Tool from your new installation of CAST AIP 8.1.x in the Windows Start menu (you can also find it in the CAST installation folder - called servman.exe):
- No connection profiles will be available. Please create a new connection profile to the CAST Storage Service 2 on which your CAST Measurement Service is installed.
- Select this profile and click Open:
- CAST Server Manager will then display all the CAST schemas located on the host CAST Storage Service 2. In the image below, the Management, Analysis and Dashboard Service are already up-to-date (i.e. CUT has been run), but the highlighted Measurement Service has "Upgrades Available":
- Select the Measurement Service and then click Schema Installation > Component Update:
- Accept the warning and summary dialog boxes and let the update proceed.
- On completion, the Measurement Service is now displayed as up-to-date:
Step 4: Validate migrated configuration
This step has three phases:
- Validate the configuration in the CAST Management Studio from the new CAST AIP 8.1.x installation to check you should expect after running the upgrade with the CAST Update Tool (CUT) / CAST Server Manager
- Process any post upgrade action items
- Generate a new post upgrade snapshot
Phase 1: What you should expect after running the upgrade with the CAST Update Tool (CUT) / CAST Server Manager
To validate the migration actioned in the CAST Upgrade Tool:
- Run the CAST Management Studio from your new installation of CAST AIP 8.1.x
- Connect to the upgraded Management Service on the server that hosts your upgraded CAST schemas: you may need to create a new connection profile to do so (see the CAST Management Studio help for more information about this). You will not need to enter a license key, or specify Delivery/Deployment folders (as is necessary in a "greenfield" installation).
This is what you can expect:
- Delivery and Deployment folders will remain as they were prior to the update in the preferences
- Applications will remain as they were prior to the update:
- Any existing Deliveries will be preserved as they were prior to the update
- The Current Version will remain as it was prior to the update
- Any existing Analysis Units will remain as it was prior to the update
- Any existing Modules will remain as they were prior to the update
Depending on the scenario you chose (see Prepare the upgrade) the Assessment Model view will contain the following:
Snapshots – specific to upgrades from 8.1.0 (baseline) ONLY
You should check your snapshots for errors that may have occurred during the upgrade of the Measurement Service schema with CAST Server Manager. To do so:
- connect and login to the CAST Application Analytics Dashboard from the previous release of CAST AIP (this should still be available).
- navigate through all the Applications that have been upgraded to the new release of CAST AIP and check the list of snapshots in the snapshot selector for each Application:
- any snapshot Version name that contains the string “MIGR_ERROR_ALG_xxx_x_x” (for example “MIGRERROR_ALG_1106776204_3_4”) was subject to an error that occurred during the upgrade of the Measurement Service schema with CAST Server Manager. It has not been possible to automatically repair this error and therefore the snapshot may produce erroneous data in the CAST Application Analytics Dashboard or in the CAST Report Generator.
- If any existing snapshots are marked as containing an error, you need to perform a specific set of actions to remove and re-consolidate the snapshot (containing the error) in the Measurement Service schema. See (below) for more information about these actions).
Phase 2: Post upgrade action items
CAST AIP extensions - import the Assessment Model (optional)
If you have upgraded WITH CAST AIP extensions (beta "SDK" or Universal Analyzer) then you will need to import the Assessment Model to ensure that the Quality Rules provided by the CAST AIP extension(s) are assigned to the Dashboard Service. This action is to be executed regardless of whether you have chosen to Preserve the existing Assessment Model or to Use the new Assessment Model from CAST AIP 8.1.x:
- In the CAST Management Studio, open the CAST Dashboard Service editor for the Dashboard Service you have upgraded to CAST AIP 8.1.x and select the Assessment Models tab.
- The Assessment Model from the previous release of CAST AIP or from CAST AIP 8.1.x will be assigned to the Dashboard Service already.
- Click the Import Assessment Model option as highlighted below:
- The Assessment Model will now be imported and will appear in the Assessment Models view AND will be automatically assigned to your Dashboard Service (meaning that it will be used for all future analyses/snapshot generations).
Assessment Models - action items for comparison
CAST highly recommends that this comparison process is completed so that you can identify the differences between the OLD and NEW Assessment Models, however, it is not a mandatory part of the upgrade process and you can skip the step if you prefer not to do this.
- Run the comparison tool to compare the OLD and NEW Assessment Models -
Customized configuration files
Please be aware that when upgrading to a new version of CAST AIP (excluding between Service Packs), configuration files that are used by various CAST features and tools are not automatically upgraded. In other words, you need to ensure that any customization that has been applied to configuration files in the existing version of CAST AIP is manually transferred to the corresponding configuration file in the new version of CAST AIP. This task must be completed before you generate a new snapshot (see below) otherwise the default configuration file will be used and your analysis results may be impacted.
A non-exhaustive list of modifiable configuration files is shown below. Please check them for any customizations that you have made and ensure they are transferred to the new version of CAST AIP:
|Default CAST AIP Environment Profiles from legacy releases of CAST AIP|
Installed with previous versions of CAST AIP for default CAST AIP Environment Profiles. These files are no longer used by CAST AIP 8.1.x and above.
If you have altered any files in this location then you must transfer those changes to the equivalent location in <CAST_install>\EnvProf.
|All previous releases of CAST AIP.|
|Specify tag libraries that need to be taken into account during an analysis.|
|*.tagsextension||CAST Management Studio (GUI) > Application > Platform Setting > CAST Tags Extensions Folder||-|
|*.blackbox.xml||User Input Security feature: black box methods|
|ExternalLinksRules.xml||<CAST_install>\configuration\parametrization||Legacy Dynamic Link Manager link parametrization|
|Parametrization_Cobol.xml||<CAST_install>\configuration\parametrization\cobol||Parametrization of Mainframe Analyzer for Cobol|
Parametrization of Mainframe Analyzer for JCL
Management of the AMT (task, memory, etc.)
|CastMetrics.xml||<CAST_install>\||Metric Assistant V1||This file is no longer used in CAST AIP 7.2.x and above - it has been replaced by the XXXCastMetrics.xml file. Therefore you should transfer your customization into one or several XXXCastMetrics.xml files. It is highly recommended to have one file per custom language or one file for custom metrics for a standard language. See Using the XXXCastMetrics.xml file for more information.|
|Metric Assistant V2|
|*.xml||<CAST-install>\configuration\MetricAssistant||Metric Assistant V3|
Background Facts upload file
Upload of Background Facts such as Effort and Cost data
|XXXCastMetrics.xml||%ALLUSERSPROFILE%\CAST\CAST\<version>\Configuration\Languages\<language>||Custom metric configuration for standard CAST AIP technologies|
|CAST AIP 7.0.x only.|
|*.castscript||CAST Management Studio (GUI) > Application > Platform Setting > CAST Script Library Directory||CAST Script||CAST 7.2.x and above.|
Environment profiles are stored in the KB but you may have changed the file to apply it to new installation.
|JAR, XQuery, CASTScript||Referenced by custom Environment Profiles||Custom Environment Profiles|
Note also that if the new version of CAST AIP has been installed on a new machine, any files such as JAR, XQuery, CASTScript that are referenced by any custom Environment Profiles will need to be manually copied to the new machine.
Customized configuration files for Visual Basic analyses
The current release of CAST AIP is 64bit compliant and therefore requires a 64bit compatible machine for installation purposes. However, the CAST Visual Basic analyzer contains components that cannot be re-factored to 64bit and therefore CAST has had to deliver these components as 32bit modules. This has been achieved by placing the required components in the Vb6 folder located at the root of the CAST installation location.
If you have upgraded from a previous release of CAST AIP (i.e. CAST AIP 7.3.x) that was not 64bit compliant, you MUST ensure that you manually transfer these changes from the relevant files in the <CAST_install_folder>\configuration folder in the previous install, to the relevant files in the <CAST_install_folder>Vb6\configuration folder in the new install of CAST AIP.
Universal Analyzer specifics
If you have migrated Universal Analyzer jobs from a previous version of CAST:
- You may find that the Validation view in the CAST Management Studio displays "Type used in the filter not found". This indicates that a Universal Analyzer object no longer exists or cannot be found in a Module. To workaround this issue, you should:
- Ensure the Universal Analyzer language package is correctly installed
- Or, remove the object type from the Module filter
Universal Importer specifics
If you have migrated Universal Importer jobs from a previous version of CAST, you must ensure that:
- Your .UAX files are compatible with CAST AIP 8.1.x:
If your .UAX files reference the CAST metamodel object types CAST_SQL_Instance and CAST_SQL_Schema, you must update them: CAST_SQL_Instance must be changed to CAST_Oracle_Instance and CAST_SQL_Schema must be changed to CAST_Oracle_Schema.
Your .UAX files must be saved in Unicode (UTF-8) format and a UTF-8 encoding declaration must be present in each file as follows: <?xml version="1.0" encoding="UTF-8"?>
- That .UAXDIRECTORY and xxx_project.UAX files are present in the same folder as your .UAX files (i.e. in the Deployment folder).
- In CAST AIP 8.0.x, a .UAXDIRECTORY file must be present in the same folder as your .UAX files. Please see Configuring UAX - UAXDIRECTORY - project files for more information.
- In CAST AIP 8.0.x, a xxx_project.UAX file must be present in the same folder as your .UAX files. Please see Configuring UAX - UAXDIRECTORY - project files for more information.
- Note that for subsequent deliveries, the .UAXDIRECTORY and xxx_project.UAX files can be generated with your .UAX files.
Note that you may find that the Validation view in the CAST Management Studio displays "Missing Object Filter" in Modules or "Missing Target" in Dependencies when have migrated Universal Importer jobs with dependencies, or Reference Finder/Module that use the Universal Importer job results. To workaround this issue, you should:
- For Modules: add an Object Filter and set the Technology to "Universal" and optionally filter on the correct object types
- For Dependencies: set the target to "Universal" technology and optionally remove duplicated dependencies
.NET analyzer specifics when (upgrading from CAST AIP 7.3.x)
In CAST AIP 8.1.x, the type names used by CAST AIP to define all VB.NET objects have been modified and have been given new values, therefore, any configuration that uses VB.NET type names will need to be reviewed and modified as described below before you re-run the post-upgrade analysis and snapshot. You can find a list of the new type name values in Metamodel type changes for VB.NET types in .NET.
For example, the following configurations/features can use type names and may therefore need to be reviewed (other configurations may also exist):
- CAST Transaction Configuration Center
- CAST Management Studio: Dependencies - Refined Target
CAST Transation Configuration Center
If you actively used the CAST Transaction Configuration Center with a previous release of CAST AIP 7.3.x specifically to work with Function Point counting in legacy VB.NET analyses you will need to check your configuration settings before you run the post-upgrade snapshot (see below). It is possible to configure VB.NET objects as transaction entry/end points/excluded items based on their type name and these will need to be reviewed as described below.
Using the GUI
When using the GUI, CAST highly recommends that you create NEW configurations for each set that involves a VB.NET type. Then, once the new configurations are in place, you need to DELETE the existing configuration. This is because changing the type in an existing set does not apply the new name correctly.
Using .TCCSetup files
If you use .TCCSetup files to define your configuration, you will need to modify the .TCCSetup file and then re-apply it. This will overwrite the existing set with the correct information. For example if your .TCCSetup file contained a configuration for a VB.NET Class as follows:
You will need to replace the <value> with the new type name for the object in question:
CAST Management Studio: Dependencies - Refined Target
When you have a Refined Target rule based on type names you will need to modify the configuration to remove the existing type names and then add the corresponding new type names:
- In the Application editor, select the Dependencies tab
- Then select the Refined Target tab and you will see a list of all Refined Target configurations:
- Ensure you check all Refined Target configurations and then edit each one if necessary:
If you made use of any .ini or properties files (such as enlighten.ini, rcenter.ini etc.) to enable or disable features in the previous version of CAST AIP, you may need to transfer the preferences in these files to the relevant files in the CAST AIP 8.1.x file structure. The migration process will not handle this transfer for you.
Additionally, any preferences you may have set in the CAST Management Studio (i.e. window locations and sizes) will not be transferred. You will need to set these again manually.
The following is a non exhaustive list of preference files that you may need to investigate:
Snapshots containing errors as described in Phase 1 - specific to upgrades from 8.1.0 (baseline) ONLY
As outlined in Phase 1, if any of your snapshot Version names contain the string “MIGR_ERROR_ALG_xxx_x_x” (for example “MIGRERROR_ALG_1106776204_3_4”) and these snapshots have been consolidated into the Measurement Service schema in the previous release of CAST AIP, then you need to first remove and then re-consolidate the snapshots (containing the error) in the Measurement Service schema. To do so:
Remove the snapshots from the Measurement Service schema
- In the GUI, tick the Reset option as shown above
- Fill in the fields in the AAD Connection tab (as highlighted above) to connect to the Measurement Service schema in which the snapshots with errors have been consolidated. See AAD GUI common fields for more information.
- Move to the Reset tab and fill in the three fields as follows, according to the Version name given to the snapshot that contains an error, for example: "MIGRERROR_ALG_1106776204_3_4"
- the first figure, (here 1106776204) represents the site_id
- the second one, (here 3), the application_id
- the third one (here 4) the snapshot_id
- Finally click the Run Application button to start the removal process:
- Repeat this process for ALL snapshots in your upgraded Application that have an error in the name.
Re-consolidate the snapshots in the Measurement Service schema
- Open the CAST Management Studio Application editor and move to the Execute tab
- Click the Upload Snapshots to Measurement Service option to re-consolidate all snapshots for the current Application. Repeat for each Application as necessary.
Phase 3: Generate a new post upgrade snapshot on the latest version
This step is:
- mandatory when your Application contains .NET (VB.NET or C#) source code AND you are upgrading from CAST AIP 7.3.x to ensure that results for this technology are generated.
- not mandatory in all other circumstances, however, CAST highly recommends that it is actioned because it provides a way to compare the analysis results of the same source code in two distinct releases of CAST AIP. If you don't want to generate a snapshot at this time, you can skip this paragraph and move on to the Deploy the CAST web applications. Following an upgrade to the current version of CAST AIP, you will need to use the CAST Delivery Manager Tool if you want to deliver new versions of your Application source code for analysis. This process is described in 1.4. Deliver the application source code version.
Update the delivery for the current version
Copy the delivery
- First ensure that the current version is set to the version used to generate the most recent snapshot (i.e. the last snapshot generated before the upgrade).
- Now select the current version and click Add Version:
- The following screen will now be displayed. Please ensure that you do as follows:
- 1) Enter a name for this copied version
- 2) Ensure the Copy source code option is selected (this is crucial)
- Click Finish to continue.
Re-package the source code and deliver
- The CAST Delivery Manager Tool will open:
- You now need to open each "package" (double click it) and check that all the configuration settings are as they should be.
- For .NET when upgrading from CAST AIP ≤ 7.3.x:
- Create brand new packages for any VB.NET source code that you need to analyze (please refer to What you should package? in .NET)
- Ensure that the existing packages for C# source code point to the correct source code location
- Click Package at Version level and ensure that:
- Force extraction option is UNTICKED - this will limit the result comparison to the source code that was delivered with the last snapshot generated prior to the upgrade
- Force scan option is TICKED
- Click Finish to run the Package action
- Check the status of the packaging action in the Package Content tab for each Package.
- Click Deliver to close the Version
- Quit the CAST Delivery Manager Tool
Accept and set as current version
- Back in CAST Management Studio, the Version will now be displayed in the Delivery done section:
- Accept the Version and set it as current:
- Deploy the source code as normal:
- You are now ready to generate a snapshot - see below.
Generate a new snapshot
For each Application involved in the migration, generate a snapshot. The rational of doing so now is so that you can compare the pre and post migration snapshots. To generate a snapshot:
- First ensure that the correct Assessment Model is assigned to your Dashboard Service (use the Expert audience mode):
- Now check your Analysis Units to make sure, in particular, that any live databases (DB2 UDB) used for analysis purposes are correctly configured and any file based source code is available. Use the Current Version tab in the Application editor:
- Next right click the migrated Application and select Execute > Take a snapshot of the application. This will run all the analyses, synchronize modules and execute a new snapshot:
Please ensure that you:
- do not skip the analysis when running the snapshot.
- do not upload the results to a Measurement Service. This will fail if you have not yet installed the Measurement Service for the CAST Application Analytics Dashboard Service nor configured it to function (see Standalone installation in Install CAST schemas and Installing and configuring the CAST Application Analytics Dashboard for more information).
Check the results of the snapshot
When the snapshot has completed, you can check the contents by launching the temporary CAST Engineering Dashboard:
- Open your Dashboard Service in the CAST Management Studio
- Ensure no URL is present in the URL field in the General tab
- Click the Open CAST Portal option and compare the pre and post migration snapshots:
Step 5: Deploy the CAST web applications
This step corresponds to deploying the CAST web applications that are required for using CAST AIP 8.1.x:
- the CAST AIC Portal to manage the delivery and packaging of source code for analysis via the CAST Delivery Manager Tool (DMT)
- the CAST Application Analytics Dashboard for high level data consumption
- the CAST Application Engineering Dashboard for detailed data investigation
- the CAST Engineering Dashboard and the CAST Discovery Portal for detailed data investigation (optional based on your license agreement)
CAST strongly recommends deploying the CAST web applications in "side-by-side" alongside any existing deployed web applications from previous releases of CAST AIP (including any deployed WARs from Alpha and Beta previews) to take advantage of new features and to comply with compatibility limitations. See Deploy the CAST web applications for information about deployment of the CAST web applications from the new release.
In a "side-by-side" deployment, you will need to transfer the details of your environment (stored in the configuration files such as web.xml/context.xml/other .properties/.xml files) from the old web application to the new. Please be aware that the structure and content of configuration files may have changed between releases of CAST AIP, so you should not perform a merge or overwrite configuration files (unless specifically requested to do so in the instructions below) - instead you must manually update the new configuration files with the details from the old configuration files. Specific details are listed below for each web application.
CAST AIC Portal - required actions
When redeploying the CAST AIC Portal, ensure the following is always done:
- You must configure the portal to point to your EXISTING Delivery folder - DO NOT create a new empty Delivery folder.
- The CAST AIC Portal uses a file format database to store various persistent information. Two files from this database must be copied from the existing CAST AIC Portal deployment, over to the same folder in the new CAST AIC Portal deployment - when prompted, you should OVERWRITE the existing files. The files that must be copied are as follows:
- You must comment out any references to Applications that have not been updated to the current release of CAST AIP in the index.xml file located in the "data" folder at the root of the Delivery folder (i.e. you have deliberately chosen not to update certain Applications at this time). This is to prevent these Applications from appearing in the CAST AIC Portal and them being inadvertently worked on via the CAST Delivery Manager Tool. For example, in the following index.xml there are two Applications: MEUDON has been updated, SEVRES has not. The comments have been placed around the SEVRES Application:
CAST Application Analytics Dashboard and the CAST Application Engineering Dashboard - required actions
When redeploying the CAST Application / Engineering Dashboards, please note the following:
- If you have made configuration changes to tiles via .JSON files and you want to retain those changes in the new version of the dashboards, you can re-use old .JSON files with the new deployment of the dashboards, however please note that doing so will mean that you will not benefit from any improvements or features added to the current release of the CAST Application Analytics Dashboard/CAST Application Engineering Dashboard