Summary: this page provides an explanation about how to install an official or custom CAST AIP extension that you have downloaded.

Introduction

Some extensions (whether custom or official) need to be installed in a variety of locations:

The installation is handled either

The following section is therefore split in to the following chapters:

Note that some extensions (such as those sharing a configuration file for a specific part of CAST AIP) do not require any installation. Please follow the instructions provided with the extension in all cases!

Prerequisites to an installation

Backup

Before installing an extension to an existing triplet of CAST AIP schemas that contains analysis results/snapshots, CAST recommends that this data 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 extension install process:

Item to backup
How to back it up
CAST AIP schemas: Management / Analysis / Dashboard / Measurement (where applicable) Services

Use the CAST Storage Service backup tools (CSSBackup) to backup each CAST AIP schema you intend to install an extension on - please refer to the documentation for the version of CAST AIP you are working with for more information.

CAST Delivery folder

Please ensure that you make a copy of your CAST Delivery folder - simply by copying the folder to another location on disk (unrelated to CAST AIP).

Custom Environment Profiles

If any custom Environment Profiles are in use (not Environment Profiles provided by CAST) please back them up so that you can restore them after the extension is installed. To export your custom Environment Profiles, you need to:

  • Open CAST Management Studio
  • Right click the Analysis Service (to which you will install the extension) in the Services view and select Environment Profile > Export
  • When prompted, select Yes to choose a folder for the export location, or No to choose a single file for export. CAST recommends choosing No.
  • A standard Windows Save As dialog box will be displayed
  • Choose a name and location for the file
  • Click Save to finish
  • All user-defined custom Environment Profiles will then be exported to one single file (with an .aex extension).

Download extension

You must already have the extension available on the machine on which you will perform the installation. See Download an extension.

Installing with CAST AIP Console

Installing with CAST Server Manager

Installing from scratch

Step 1: Install with CAST Server Manager

The first step is to use CAST Server Manager to install the extensions in your CAST AIP schemas. This can be done:

This section deals with both situations.

Note that installing an extension in a group (Management/Analysis/Dashboard Services) of CAST AIP schemas will allow you to use that extension with ALL Applications that are managed by these CAST AIP schemas. Therefore, you will need to repeat this step for each "group" of CAST AIP schemas with which you want to use the extension. For example, you have:

  • Schemas 1 used by Application A
  • Schemas 2 used by Application B and Application C

You will need to install the extension in Schemas 1 and 2 for all the Applications to be able to use it.

Installing an extension with new CAST AIP schemas

Installing an extension with existing CAST AIP schemas

Step 2: Import the Assessment Model

This step does not apply in the following situations:

  • installation of extensions SPECIFICALLY and ONLY for the Delivery Manager Tool which do not include an Assessment Model "fragment"
  • when installing the extension with ≥ CAST AIP 8.3.x in which this step is done automatically

In this case there is no need to action this step.

An additional installation action that cannot be handled by CAST Server Manager in all releases prior to CAST AIP 8.2.x must now be actioned. This action is the import of the Assessment Model:

Step 3: Import custom Environment Profiles - optional

If:

...you will need to import these custom Environment Profiles from file (they should already have been backed up - see Backup above). To import the custom Environment Profiles:

Step 4: Package your source code with the CAST Delivery Manager Tool when you have an existing Version

This section discusses the Force Extraction and Force Scan options in the CAST Delivery Manager Tool.

If...

...you can deliver source code as normal and ignore the contents of this step.

If...

...you need to proceed as follows.

Note that:

  • Please check the specific documentation for your extension to find out if it includes a "discoverer" or "extractor" for the CAST Delivery Manager Tool.
  • CAST highly recommends that this process is actioned by the CAST administrator using the CAST Delivery Manager Tool accessed direct from the CAST Management Studio.

Installing a new version of an existing extension

If you have acquired a new version of an extension you are actively using, you can install the new version as follows:

Please note that the new version of an extension must be higher than the existing version.

Step 1: Install with CAST Server Manager

The first step is to use CAST Server Manager to install the new version of the extension in your existing CAST AIP schemas.

Step 2: Import the Assessment Model

This step does not apply in the following situation:

  • installation of extensions SPECIFICALLY and ONLY for the Delivery Manager Tool which do not include an Assessment Model "fragment"
  • when installing the extension with ≥ CAST AIP 8.3.x in which this step is done automatically

In this case there is no need to action this step.

An additional installation action that cannot be handled by CAST Server Manager in all releases prior to CAST AIP 8.2.x must now be actioned. This action is the import of the Assessment Model. Please follow Step 3: Import the Assessment Model above.

Step 3: Import custom Environment Profiles - optional

If:

...you will need to import these custom Environment Profiles from file (they should already have been backed up - see Backup above). To import the custom Environment Profiles:

Step 4: Re-package your source code with the CAST Delivery Manager Tool when you have an existing Version

This section discusses the Force Extraction and Force Scan options in the CAST Delivery Manager Tool.

If...

...you can deliver source code as normal and ignore the contents of this step.

If...

...you need to proceed as described in Step 4: Package your source code with the CAST Delivery Manager Tool when you have an existing Version above.

Tip: how to find out if your extension has been successfully installed

For users of CAST AIP 8.x.x it is relatively straightforward to see whether the extension has been installed: