Install AIP Core

Summary: step-by-step instructions for installing AIP Core.

Installation requirements

(tick)

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

(tick)AIP Core needs to be installed on all AIP Nodes (i.e. dedicated servers) that will be managed by AIP Console. The installation process consists of running a setup installer on the target server.
(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.
(tick)

You need local "Administrator" privileges to install AIP Core on all Windows versions. In addition, the installer requires elevated permissions and therefore needs to be run using the "Run as Administrator" option.

In some rare circumstances, the installer may appear to have completed, but a message will also be displayed as follows:

"The system has not been modified. To install this program at a later time, run the installation again."

This message indicates that the setup has failed. This can occur even when your user login has "Administrator" privileges. In order to workaround this, you need to assign your user login a specific Windows privilege entitled Impersonate a client after authentication.

(tick)

The Windows login used to run the AIP Core installer cannot contain any special characters - for example:

  • !
  • %
  • |

If the Windows login contains a special character, the installation will fail. Note that the above list of special characters is not exhaustive.

(tick)

Generally speaking, the installation path must only contain ASCII characters or characters of the language (or language group) of your Windows operating system. More precisely, all characters in the installation path must be present in the system Windows code page of the AIP Node. The system Windows code page is determined by the system locale. The system locale is defined in:

  • Control Panel > Clock and Region > Region > Administrative tab > Language for non-Unicode programs.

This language defaults to the language of the Windows operating system and can be changed, if needed.

As an example, on any western European Windows installation, the system code page is Win-1252; on central European Windows installations, the code page is Win-1250, and on a Turkish Windows installation, the code page is Win-1254. The exact value of the code page is stored in the Windows registry at the following location:

HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Nls\CodePage

The value in the key 'ACP' indicates the current system Windows code page (also called ANSI Code Page, hence 'ACP'). If your installation path contains any character not present in the system Windows code page (e.g. a Cyrillic character on a French Windows installation), all CAST Java based executables will fail to load due to a limitation of the Java runtime environment.

(tick)If you are facing issues installing AIP Core, you may consider temporarily disabling any anti-virus running on the host server. In some situations, anti-virus can interfere with the installation process and cause it not to complete.

Interactive installation process

Right click the setup.bat file located in the folder created when unzipping the installation media:

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 AIP Core - the setup will suggest: %PROGRAMFILES%\CAST\<version>:

The setup will now offer you the opportunity to configure locations for various log, temporary and miscellaneous files. CAST highly recommends leaving these paths at their default: the locations can then be configured once the setup has completed.

  • 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.
  • 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. When complete, the setup will offer to launch CAST Server Manager - please untick "Launch Server Manager" since this is component is not required:

Silent installation process

If you need to install AIP Core on a number of servers (i.e. AIP Nodes) 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 an AIP Node and open the Command Prompt (cmd). Change the folder and/or directory and/or drive to that containing the AIP Core setup.exe file (this is located in the "data" folder that is created from the AIP Core zip file):

Then run the setup.exe using 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 setup as normal. Run through the installation that 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 AIP Core in exactly the same way as you have just done.

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

setup.exe /s /f1"n:\temp\setup.iss" /f2"c:\path\to\log.txt"

The setup will 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 AIP Node and saved in the setup.iss file. A log file will be created with the name and location of your choice to help debug errors that may occur.

You will notice the setup install process running on the server's task bar for the duration of the operation. When completed, the setup will close automatically.

Log message codes

  • 0 Success
  • -1 General error
  • -2 Invalid mode
  • -3 Required data not found in the Setup.iss file
  • -4 Not enough memory available
  • -5 File does not exist
  • -6 Cannot write to the response file
  • -7 Unable to write to the log file
  • -8 Invalid path to the InstallShield Silent response file
  • -9 Not a valid list type (string or number)
  • -10 Data type is invalid
  • -11 Unknown error during setup
  • -12 Dialogs are out of order
  • -51 Cannot create the specified folder
  • -52 Cannot access the specified file or folder
  • -53 Invalid option selected

What is installed?

Files

On completion of the installation, all files related to AIP Core are stored in:

%PROGRAMFILES%\CAST\<version>
%PROGRAMDATA%\CAST\CAST\<version>
%APPDATA%\CAST\CAST\<version>

Installed third-party software

Visual C++ Redistributable Packages

If the corresponding item is already installed, then the AIP Core installer will detect it and will skip the installation.

≥ 8.3.53

  • Visual C++ 64-bit Redistributable Packages for Visual Studio 2015-2022
  • Visual C++ 32-bit Redistributable Packages for Visual Studio 2015-2022
  • Visual C++ 64-bit Redistributable Packages for Visual Studio 2013
  • Visual C++ 32-bit Redistributable Packages for Visual Studio 2013
  • Microsoft Build Tools 2015 (BuildTools_Full.exe)

8.3.0 - 8.3.52

  • 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 running the AIP Core setup on a fresh server where a previous release of AIP Core does not exist, if a more recent release of the .NET Framework is detected then the AIP Core installer will detect it and will skip the installation.
  • When running the AIP Core setup and a previous release of AIP Core is already present on the server, the installer will NOT install the .NET Framework even if it is not present on the target server. In this scenario, it is the responsibility of the end-user to install the required .NET Framework.

≥ 8.3.29:

  • 4.7.2

8.3.14 - 8.3.28

  • 4.7.1

8.3.0 - 8.3.13

  • 4.5.2