Introduction

In what releases is this supported?

What actions does CAST Console perform during an upgrade?

The following actions are performed when you run an upgrade using CAST Console:

• An automatic backup of the Application's Management, Analysis and Dashboard schemas is performed automatically - see Administration Center - Applications - Application Details for details of this backup.
• An automatic backup of the Application's Delivery folder is performed automatically - see Administration Center - Applications - Application Details for details of this backup.
• An upgrade of the schemas and the Delivery folder to the new AIP Core release (technically the -MODIFY_COMBINED command line is used to do this).
• Resync CAST Console to ensure that it is aware that the Application has been upgraded.

%TEMP%\CAST\CAST\$CAST_MAJOR_VERSION$.$CAST_MINOR_VERSION$\

What about extensions?

When an upgrade is actioned with AIP Console, the following behaviour is applied to extensions:

• extensions shipped with the new release of AIP Core and not already installed will be automatically installed
• any previously installed extensions will not be automatically upgraded, even if a more recent version of an extension is shipped with the new release of AIP Core, or is available on CAST Extend. You should upgrade any extensions post upgrade if required.

What happens if the upgrade fails?

If the upgrade fails for any reason, an automatic roll back of the Application (schemas and delivery folder) will be performed using the backup taken automatically at the start of the upgrade process.

What about AIP Core and extension Assessment Models

The setting chosen in Administration Center - Settings - Assessment Model Strategy under Upgrade Strategy will be used.

Step 1 - Determine applications to upgrade

Browse to your AIP Console URL http://<server>:8081/ui/index.html, login to AIP Console with a user that has the ADMIN role and switch to the Admin Center:

Now move to the Applications panel:

Any application that is eligible for upgrade will be flagged as follows:

Step 2 - Determine whether the upgrade path is supported

You should now check whether the upgrade path for the eligible applications is supported. You can check this path is supported using the matrix available here: AIP Core - Application - schema upgrade on each AIP Node, and consult the release notes for the target AIP Core release:

Step 3 - Determine the Assessment Model Strategy

Before starting the upgrade, you must choose an option with regard to the handling of the Assessment Model during the upgrade - note by default the Preserve Assessment Model but enable new rules option is selected. See Administration Center - Settings - Assessment Model Strategy for an explanation of the available options.

Browse to the Administration Center - Global Configurations and expand the Administration Center - Settings - Assessment Model Strategy panel to make your choice:

Step 4 - Perform the upgrade

To perform the Application and schema upgrade, use the following option in the Admin Center:

When you click the option to upgrade, a warning is displayed (see image below) before the upgrade action is started. In ≥ 2.x, you can also choose the target AIP Core release - this drop down box will list all the AIP Core releases available on AIP Nodes managed by AIP Console that are NEWER than the AIP Core release used for the current Application.

The upgrade will then proceed:

Step 5 - Check new AIP Core release is registered in AIP Console

In Application - Overview check that your Applications are showing the correct release of AIP Core - i.e. which release of AIP Core the schemas are set at - this release number should show the new AIP Core release number you have upgraded to:

Step 6 - Run analysis and generate a new post upgrade snapshot

Although not mandatory, CAST highly recommends that a new analysis is run and a new snapshot is generated because it provides a way to compare the analysis results of the same source code in two distinct releases of AIP Core. If you don't want to generate a snapshot at this time, you can skip this step.

Pre-snapshot actions for specific technologies

Customers using the Siebel extension

Customers upgrading with legacy BusinessObjects Analyzer results

Customers upgrading from CAST AIP 8.1.0 (baseline) - snapshot validation

Generate a new snapshot

To generate a new snapshot, move to the AIP Console screen if you are not already there:

Locate the Application and click it:

The Application - Overview page will be displayed. Scroll down to the bottom of the page and click the config icon:

Now choose the following options (untick those are not required) and click Run Analysis:

You can check the results using the Engineering Dashboard - this is a quick and easy way to view the results. If you are using "embedded" dashboards, then you can click the Dashboard icons and instantly view the results - otherwise, you will need to log in to your standalone dashboards:

Step 7 - Run analysis and Upload to CAST Imaging

Just as with an analysis/snapshot, you can optionally run a new analysis and upload to CAST Imaging, or simply upload to CAST Imaging (without running a new analysis). To do so move to the AIP Console screen if you are not already there:

Locate the Application and click it:

The Application - Overview page will be displayed. Scroll down to the bottom of the page and click the config icon:

Now choose the following options (untick those are not required) and click Run Analysis:

Post upgrade

What happens to Assessment Models?

During the upgrade process, the following actions will have been performed:

• Regardless of the Assessment Model Strategy you chose, the existing Assessment Model assigned to the Dashboard schema at the point of upgrade will have been upgraded and two copies of this Assessment Model will have been created:
  
  • one with the new CAST AIP Quality Rules merged in and enabled (Preserve Assessment Model customizations, activate new rules)
  • one with the new CAST AIP Quality Rules merged in and either disabled (Preserve Assessment Model customizations, leave new rules disabled) or enabled and set to zero weight (Preserve Assessment Model and get new rules for information)
  • Note that when there are no new rules available, a duplicate copy of the existing Assessment Model is NOT made.
• If the Use default Assessment Model from CAST AIP 8.3.x option was chosen, a new default Assessment Model will have been created and any Assessment Model fragments from CAST AIP Extensions that were present in the Assessment Model assigned to the Dashboard schema at upgrade time will have been merged into this new Assessment Model
  
• One of the above mentioned Assessment Models will have been assigned to the upgraded Dashboard schema, dependent on the Assessment Model Strategy option you chose
  

Assessment Model labels in CAST Management Studio

Validation message

Warning : There are more than 3 Assessment Models declared in the current management base, 
this can degrade the performances of CAST Management Studio. You should consider removing those which are no longer needed.

Custom tablespace

If you have configured any of the AIP schemas to use custom tablespace (i.e. tablespace other than pg_default which is automatically used when schemas are installed with AIP Console), following the schema upgrade you may find that some tables will now be using the default tablespace (pg_default) and some will still using the custom tablespace. If you wish to ensure that all your tables are using the same custom tablespace, you can run the following query to generate the required execution statements that will need to be run to do this. Ensure you update the following first:

• <schema_name> = replace with the name of the schema
• <tablespace_name> = replace with the name of the custom tablespace you want to use

SELECT 
  query 
FROM 
  (
    SELECT 
      1 as id, 
      'Set statement_timeout=0 ; ' as query 
    UNION 
    SELECT 
      2, 
      ' ALTER TABLE ' || schemaname || '.' || tablename || ' SET TABLESPACE <tablespace_name>;' 
    FROM 
      pg_tables 
    WHERE 
      schemaname ilike '<schema_name>' 
      and tablespace is null 
    UNION 
    SELECT 
      2, 
      ' ALTER INDEX ' || schemaname || '.' || indexname || ' SET TABLESPACE <tablespace_name>;' 
    FROM 
      pg_indexes 
    where 
      schemaname = '<schema_name>' 
      and tablespace is null
  ) a 
ORDER BY 
  a.id;