This documentation page is part of a legacy method of installing CAST AIP. This documentation is no longer maintained and may contain obsolete information. You should instead refer to Installation and Configuration with AIP Console.


On this page:

Target Audience:

CAST AI Administrators


Summary:

  • This section describes how to run the CAST AIP installer, i.e. the installation of a dedicated workstation (known as the CAST Administration workstation) with all CAST AIP end-user applications. Also see Overview of CAST Application Intelligence Platform for more information.
  • Existing releases of CAST AIP can co-exist with the current release of CAST AIP on the same machine, provided that the installation locations are different.
  • When running the CAST AIP setup and a previous release of CAST AIP is already present on the target workstation in the chosen installation path, this will be handled as a Service Pack installation.

Introduction

CAST AIP is shipped as an installer (setup). This contains the following:

Note that in previous releases, one installer was provided combining both CAST AIP and the CAST Storage Service.

CAST Storage Service and order of installation

This document describes the installation of CAST AIP on one dedicated workstation. If you are intending to use the CAST Storage Service for your CAST AIP storage requirements (see the DBMS section in Supported Platforms), AND you intend to run the CAST Storage Service on the same workstation as used for CAST AIP, then CAST highly recommends that you install the CAST Storage Service to the workstation BEFORE you run the CAST AIP installer. This is so that a connection profile to the CAST Storage Service (for use in CAST Server Manager for installing the Storage components (see Install CAST AIP schemas)) can be generated automatically by the CAST AIP installer - easing the onboarding and configuration process.

If you are installing the CAST Storage Service to a dedicated workstation, it does not matter which order you perform the installation of the CAST Storage Service and CAST AIP: no connection profile will be created since the CAST Storage Service will be located on a separate workstation to CAST AIP.

If the CAST AIP setup detects the presence of a CAST Storage Service on the workstation (whether installed through the standalone installer or from a previous release of CAST AIP), then a connection profile to that CAST Storage Service instance will be created automatically and will be available for use in  CAST Server Manager.

Installation requirements

Please see Appendix - CAST Administration workstation installation and hardware requirements for more information about hardware and installation requirements.

Before beginning the installation process, please ensure that you have carried out all of the following tasks and that the following requirements have been met:

(tick)

Ensure you have read all Release Notes accompanying CAST products for any last-minute information. In particular, please read: Supported Platforms, Supported Character Sets

(tick)

Ensure that the target workstation meets all hardware and operating system requirements (see Appendix - CAST Administration workstation installation and hardware requirements)

(tick)

Ensure that your Windows user login on the target workstation has sufficient user privileges to install applications (see Appendix - CAST Administration workstation installation and hardware requirements)

(tick)

Make sure that you can access any necessary network resources from the target workstation (such as a workstation hosting the Storage component)

(tick)

CAST AIP is delivered in a ZIP file. Make sure you have the required ZIP file ready and unzipped to a folder on the CAST Administration workstation (it cannot be run from a network location). 

(tick)

Make sure that you disable your anti-virus software prior to launching the CAST AIP installer.

(tick)

Installation paths:

  • The CAST AIP setup can only be installed to a local or mapped drive
  • Paths starting with \\ will be refused by the setup and are not permitted.

Data storage paths / global settings:

  • All paths are accepted and are never checked by the CAST AIP setup. E.g. local full path, mapped drive, remote location starting with \\ are all accepted. Please ensure that the current user has access to these data storage locations.


Run the setup

Right click the setup.bat file located in the folder created during the unzip process:

Choose Run as Administrator in the contextual menu (elevated privileges are required even if your Windows user login is part of an "Administrators" group). Click Next and then read and accept the License Agreement and then choose a location for CAST AIP - the setup will suggest: %PROGRAMFILES%\CAST\<version>:

Please note that – generally speaking – the installation path must only contain ASCII characters or characters of the language (or language group) of your Windows operating system. For more details, see Characters allowed in the installation path in Appendix - CAST Administration workstation installation and hardware requirements for more information.

Now choose locations for various CAST AIP log, temporary and miscellaneous files. These locations will be valid for all CAST AIP applications. There is no requirement to change these path locations unless you need to - the paths suggested in each screen are the default locations used by all applications in CAST AIP.  These screens are visible only when installing CAST AIP in a non-upgrade scenario (i.e. CAST AIP from the same major/minor release track does not already exist on the machine). The locations can be overriden once the setup has completed by modifying the CastGlobalSettings.ini file.

  • CAST strongly recommends using EMPTY folders for all paths that are required. The setup must check all folders/subfolders in each path and grant access recursively, therefore if the folders contain data (for example from a previous installation) this process can take a significant amount of time. If you wish to use paths that contain existing data, CAST recommends using temporary EMPTY folders during the installation and then modifying the paths post installation using the CastGlobalSettings.ini file.
  • It is not possible to define a new path using a Windows environment variable. Only a full path (C:\CAST\...) or a network location (\\HOST\SHARE) can be used.


  • Click Next. A screen will then be displayed summarizing your choices:

  • The installation process will then start on clicking Next.
  • On completion, CAST AIP will be ready for use. The setup will then offer to launch CAST Server Manager so that you can install your CAST AIP schemas to the CAST Storage Service (in an AIP Console deployment scenario, please untick "Launch Server Manager" since this is not required).

Which third-party items are installed with AIP Core?

When you complete an installation using the CAST AIP setup, if they are not already installed, the following third-party items will be installed to the target server:

  • Visual C++ 64-bit Redistributable Packages for Visual Studio 2017
  • Visual C++ 64-bit Redistributable Packages for Visual Studio 2013
  • Visual C++ 32-bit Redistributable Packages for Visual Studio 2013
  • Visual C++ 64-bit Redistributable Packages for Visual Studio 2010
  • Microsoft Build Tools 2015 (BuildTools_Full.exe)
  • .NET framework (when required - if a more recent version is already present, then nothing is installed)

    • AIP 8.3.0 - AIP 8.3.13: 4.5.2 

    • AIP ≥ 8.3.14: 4.7.1
    • AIP ≥ 8.3.29: 4.7.2

When running the CAST AIP setup and a previous release of CAST AIP is already present on the target workstation (i.e. "Service Pack installation"), the CAST AIP setup will NOT install the .NET Framework even if it (or a more recent version of the framework) is not present on the target server. In this scenario, it is the responsibility of the end-user to install the required .NET Framework.

Automated installation procedure

If you need to install CAST AIP on a number of servers in exactly the same way, you may consider the possibility of automating this process using the command-line parameters of the setup installer. This will launch the setup installer unattended. This method requires you to perform the installation you require on one target server and then output the selected options to an answer file (setup.iss) which is then reused in subsequent automated installations.

First choose a server and open the Command Prompt (cmd). Change the folder and/or directory and/or drive to that containing the CAST AIP setup.exe file (this is located in the "data" folder that is created from the CAST AIP zip file):

Then use the option -r as follows - change the example path given below to a folder in which you would like to store the answer file (setup.iss) - for example a network share. Note that this folder must already exist before running the command:

setup.exe /r /f1"n:\temp\setup.iss"

This will launch the InstallShield® as normal. Define the installation you require.

Please ensure that you do NOT use the "back" button during the setup process to return to a previous screen - this will invalidate the "answer" file created at the end of the setup process.

Once the initial setup process has completed, an "answer" file named setup.iss will be created at the location specified in the command line (in this example, this is n:\temp\setup.iss, which is a network location). This file contains all the parameters necessary to install CAST AIP in exactly the same way as you have just done.

Now move onto the next server. Open the Command Prompt, move to the required location (where the CAST AIP installer has been stored) and enter:

setup.exe /s /f1"n:\temp\setup.iss"

InstallShield® will now open and run the installation unattended using the parameters saved to the  setup.iss file on the network - you will not need to intervene to move on through the various steps. The setup parameters will be identical to those defined in the first setup carried out on the first server and saved in the setup.iss file.

You will notice the setup install process running on the server's task bar for the duration of the operation. When completed, InstallShield® will close automatically and CAST AIP will be ready to use.

Post installation actions (for upgrade scenarios only)

If you have installed CAST AIP in preparation for an upgrade from a previous release of CAST AIP, then the following actions are required if you want to maintain equivalence between the previous release of CAST AIP and the current.

Connection profile transfer

CAST AIP end-user applications use "connection profiles" to store information about the CAST AIP schemas they need to connect to. These connection profiles are files stored in a release specific location on the workstation. When upgrading to a new major or minor version of CAST AIP (excluding between Service Packs), these connection profile files therefore need to be copied from the old location to the new:

File name

Location

Usage

CWProfileConnection.INI%PROGRAMDATA%\CAST\CAST\<version>Provides connection details for end-user applications such as CAST Enlighten, CAST Report Center.
CWSIProfileConnection.ini%PROGRAMDATA%\CAST\CAST\<version>

Provides connection details for the administration application CAST Server Manager.

Note that this file may already exist in the new location if the CAST AIP installer was able to detect a CAST Storage Service present on the same workstation.


cast-ms.connectionProfiles.pmx%APPDATA%\CAST\CAST\<version>

Provides connection details for end-user applications such as CAST Management Studio, CAST Transaction Configuration Center, CAST Architecture Checker.

Note that if a previous release of CAST AIP is already installed on the workstation, then the CAST AIP installer will have copied the cast-ms.connectionProfiles.pmx file from this previous release into the new release specific location.



Configuration file transfer

When upgrading to a new major or minor version of CAST AIP (excluding between Service Packs), configuration files that are used by various CAST AIP 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 copied to the corresponding configuration file in the new version of CAST AIP. This task must be completed before you generate a new snapshot with the new release of CAST AIP 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 equivalent file in the new release of CAST AIP:

File name

Location

Usage

Frequency

*.ini files

%APPDATA%\CAST\CAST\<version>

  • enlighten.ini
  • rcenter.ini
  • servman.ini

%PROGRAMDATA%\CAST\CAST\<version>

  • GloballySharedSettings.ini
Provide configuration options for end user applications.
Default CAST AIP Environment Profiles from legacy releases of CAST AIP

%CommonProgramFiles%\CAST\CAST\EnvProf\*.*

or

%CommonProgramFiles(x86)%\CAST\CAST\EnvProf\*.*

Installed with previous versions of CAST AIP for default CAST AIP Environment Profiles.

These files are no longer used by CAST AIP 8.2.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. See also Technical Information.

cast-tag.extensions.xml

<CAST_install>\configuration\J2EE\web-inf

Specify tag libraries that need to be taken into account during an analysis.



*.tagsextensionCAST Management Studio (GUI) > Application > Platform Setting > CAST Tags Extensions Folder-
<CAST_install>\EnvProf\J2EE\-
*.blackbox.xml
  • <CAST_install>\configuration\BlackBoxes\DotNet
  • <CAST_install>\configuration\BlackBoxes\J2EE
User Input Security feature: custom black box methods

The location for these files has changed in CAST AIP 8.3.x and above. The files (for all technologies) should now be located in:

%PROGRAMDATA%\CAST\CAST\[major_ver.minor_ver]\blackboxes

This folder should already exist following an installation, however, if it does not, please create it.

Note that the path to these files is defined by a CAST AIP Global Settings variables: CAST_ALL_USERS_PATH (defined in the CastGlobalSettings.ini file).


ExternalLinksRules.xml<CAST_install>\configuration\parametrizationLegacy Dynamic Link Manager link parametrizationThis file is no longer used in CAST AIP 8.2.2 and above - it has been replaced by the CustomExternalLinksRules.xml file. Therefore if you have previously modified this file to provide your own parametrization and after an upgrade to CAST AIP 8.2.2 or above, you must ensure that you copy your custom rules from this file into the CustomExternalLinksRules.xml file (located in the same folder). If the CustomExternalLinksRules.xml file does not exist (specifically when you have installed CAST AIP 8.2.2 in standalone mode and neither AIP 8.2.0 and 8.2.1 exist on the workstation), you may need to create it yourself.
CustomExternalLinksRules.xml<CAST_install>\configuration\parametrizationLegacy Dynamic Link Manager link parametrization
Parametrization_Cobol.xml<CAST_install>\configuration\parametrization\cobolParametrization of Mainframe Analyzer for Cobol
AdvancedJCL.xml<CAST_install>\

Parametrization of Mainframe Analyzer for JCL


*.xml

<CAST_install>\configuration\AMT

Management of the AMT (task, memory, etc.)


CastMetrics.xml<CAST_install>\Metric Assistant V1This 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.

*.xml

<CAST-install>\configuration\Metrics

Metric Assistant V2


*.xml<CAST-install>\configuration\MetricAssistantMetric 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
*.castscriptCAST Management Studio (GUI) > Application > Platform Setting > CAST Script Library DirectoryCAST ScriptCAST 7.2.x and above.

Cast.aex

<CAST-install>\configuration\EnvProf

Environment profiles are stored in the KB but you may have changed the file to apply it to new installation.


JAR, XQuery, CASTScriptReferenced by custom Environment ProfilesCustom Environment Profiles


Deploying CAST AIP in other environments

Citrix XenApp

See Setting up XenApp 7.6 for CAST AIP for more information.

Terminal Server

Installing applications on a terminal server must be carried in a specific way to ensure they are usable by all users of the terminal server.

There are two modes in terminal server, Execute and Install. By default, all users are logged on in Execute mode, which means they can run programs etc. When you want to install an application so that it can be used by everyone, the Administrator should change to Install mode. The best way to install software is to use the Add/Remove programs control panel applet as this will automatically set the mode to Install during the installation and then back to Execute at the end. Alternatively you can manually change your mode to install by typing:

C:\> change user /install

To change back to execute use:

C:\> change user /execute

And to check your current mode use:

C:\> change user /query


Notes

  • Please also note that CAST AIP needs to write DATA to files located in the CAST AIP installation folder. Thus, all users must have write privileges for the folder containing CAST AIP.
  • Please ensure you also add the CAST_CURRENT_USER_PERSONAL_PATH key to the CastGlobalSettings.ini file (see the documentation here). You should set this key to a location that is specific to the current user, for example %UserProfile%\Documents\.

Installing a Service Pack (i.e. CAST AIP 8.3.1)

CAST ships updates to CAST AIP 8.3.0 in the form of Service Packs. These Service Packs are numbered starting 8.3.1. A Service Pack is best described as a collection of updates, fixes, or enhancements to the "baseline" CAST AIP 8.3.0 delivered in the form of a single installable package.

Things you should know about Service Packs

Pre-installation check list

Before beginning the installation process, please ensure that you have carried out all of the following tasks and that the following requirements have been met:

(tick)

Ensure you have read all Release Notes accompanying CAST products for any last-minute information

(tick)

Ensure that you have read Things you should know about Service Packs (see above) prior to starting the installation

(tick)

CAST AIP is delivered in a ZIP file (containing the CAST setup.bat). Make sure you have the required ZIP file ready

(tick)

Unzip the ZIP file to a convenient location on the workstation

(tick)

Make sure that you disable your anti-virus software prior to launching the CAST setup.bat

Service Pack installation procedure